Navigation
You were redirected from a different version of the documentation. Click here to go back.

Update the Automation Configuration

Overview

A group’s automation configuration determines the goal state of its MongoDB processes and agents. The Automation Agents build the deployment according to the goals specified.

To update the configuration, retrieve the current configuration and make changes as needed, changing only those items you want modified. Then replace the entire configuration using PUT with the automationConfig endpoint. You must use PUT. Do not use PATCH.

Note

Some attributes of the backupVersions and monitoringVersions objects cannot be updated through the automationConfig endpoint. For details, see Update the Monitoring Agent or Backup Agent.

Prerequisites

You must have access to the Public API. For more information, see Configure Public API Access.

Procedure

1

Retrieve the automation configuration from Ops Manager.

Use the automationConfig resource to retrieve the configuration. Issue the following command, replacing <username> and <apiKey> with your API credentials, <url> with the URL of Ops Manager, and <group_id> with the group ID from your Group Settings:

curl -u "<username>:<apiKey>" "http://<url>/api/public/v1.0/groups/<group_id>/automationConfig" --digest -i

Confirm that the version field of the retrieved automation configuration matches the version field in the mms-cluster-config-backup.json file, which is found on any server running the Automation Agent.

2

Edit the automation configuration.

Refer to Automation Configuration for detailed descriptions of settings. If you are updating the Monitoring Agent or Backup Agent, please see Update the Monitoring Agent or Backup Agent before continuing with this procedure.

3

Send the updated automation configuration.

Use the automationConfig resource to send the updated automation configuration.

Issue the following command, replacing <configuration> with path to the updated configuration document. Replace the username, API key, URL, and group ID as in previous steps.

curl -u "<username>:<apiKey>" -H "Content-Type: application/json" "http://<url>/api/public/v1.0/groups/<group_id>/automationConfig" --digest -i -X PUT --data @<configuration>

Upon successful update of the configuration, the API returns the HTTP 200 OK status code to indicate the request has succeeded.

4

Confirm successful update of the automation configuration.

Retrieve the automation configuration from Ops Manager and confirm it contains the changes. To retrieve the configuration, issue the following command, replacing username, API key, URL, and group ID as in previous steps.

curl -u "<username>:<apiKey>" "http://<url>/api/public/v1.0/groups/<group_id>/automationConfig" --digest -i
5

Check the deployment status to ensure goal state is reached.

Use the automationStatus resource to retrieve the deployment status. Issue the following command, replacing username, API key, URL, and group ID as in previous steps.

curl -u "<username>:<apiKey>" "http://<url>/api/public/v1.0/groups/<group_id>/automationStatus" --digest -i

Confirm that the values of all the lastGoalVersionAchieved fields in the processes array match the goalVersion field. For more information on deployment status, see Automation Status.