Uploaded image for project: 'Documentation'
  1. Documentation
  2. DOCS-7151

API: monitoringAgentConfig and backupAgentConfig endpoints

    XMLWordPrintableJSON

Details

    Description

      The documentation for monitoringversions and backupVersions in our API documentation is no longer up to date.

      The following should be configured via the PUT /api/public/v1.0/groups/GROUP-ID/automationConfig endpoint

      • monitoringVersions.hostname
      • backupVersions.hostname

      All other properties should be configured via PUT /api/public/v1.0/groups/GROUP-ID/automationConfig/monitoringAgentConfig and PUT /api/public/v1.0/groups/GROUP-ID/automationConfig/backupAgentConfig . These properties are

      • logPath
      • logPathWindows only required if deployment contains Windows processes
      • logRotate
        • sizeThresholdMB
        • timeThresholdHrs
        • numUncompressed
        • percentOfDiskspace
      • username
      • password
      • kerberosPrincipal
      • kerberosKeytab
      • sslPEMKeyFile
      • sslPEMKeyFileWindows only required if deployment contains Windows processes
      • sslPEMKeyPwd

      For example, the PUT body for automationConfig/monitoringAgentConfig might look like:

      {
        "logPath": "/var/log/mongodb-mms-automation/monitoring-agent.log",
        "logRotate": {
          "sizeThresholdMB": 1000,
          "timeThresholdHrs": 24
        }
      }
      

      And the main PUT for /automationConfig, you specify only the hostname, as follows:

      {
          "options": {
              "downloadBase": "/var/lib/mongodb-mms-automation",
              "downloadBaseWindows": "C:\\mongodb-mms-automation"
          },
          "mongoDbVersions": [
              {"name": "3.0.1"},
              {"name": "3.0.2"}
          ],
          "monitoringVersions": [
              {
                  "hostname": "a.example.com"
              }
          ],
          "backupVersions": [
              {
                  "hostname": "b.example.com"
              }
          ],
          "processes": [],
          "replicaSets": [],
          "sharding": []
      }
      

      Please note that there are example usages of these endpoints here: https://github.com/mongodb-labs/mms-api-examples/blob/master/automation/api_usage_example/test_enterprise_advanced.py

      Attachments

        Activity

          People

            bgrabar Bob Grabar
            bgrabar Bob Grabar
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved:
              8 years, 5 days ago