[DOCS-7151] API: monitoringAgentConfig and backupAgentConfig endpoints Created: 12/Feb/16  Updated: 24/Jun/16  Resolved: 10/Jun/16

Status: Closed
Project: Documentation
Component/s: Cloud Manager, Ops Manager
Affects Version/s: None
Fix Version/s: v20160531

Type: Task Priority: Major - P3
Reporter: Bob Grabar Assignee: Bob Grabar
Resolution: Done Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
Documented
Related
Participants:
Days since reply: 8 years, 5 days ago
Epic Link: C/OM Update API

 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


Generated at Thu Feb 08 07:53:41 UTC 2024 using Jira 9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66.