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

Automation Status

Overview

The Public API provides the automationStatus endpoint to let you see whether each MongoDB process is up-to-date with the current automation configuration. The endpoint returns the goalVersion field to report the current version of the automation configuration and the lastGoalVersionAchieved fields to report the versions of the configuration running on each server.

Endpoint

Get Status

Retrieve the status of each MongoDB process in the deployment.

GET /api/public/v1.0/groups/GROUP-ID/automationStatus

Sample Entity

"goalVersion": 29,
"processes": [
    {
        "hostname": "AGENT_HOST_0",
        "name": "BLUE_0",
        "lastGoalVersionAchieved": 28,
        "plan": ["Download", "Start", "WaitRsInit"]
    },
    {
        "hostname": "AGENT_HOST_1",
        "name": "BLUE_1",
        "lastGoalVersionAchieved": 29,
        "plan": []
    }
]

Entity Fields

Name Type Description
goalVersion number The version of the most recently submitted automation configuration. If there is a conflict in submissions of automation configurations, this field lists the winning configuration.
processes array The group’s deployed MongoDB instances.
processes.hostname string The fully qualified domain name (retrieved by issuing hostname -f) of the server on which the MongoDB process and Automation Agent are hosted.
processes.name string The process name as specified in the automation configuration.
processes.lastGoalVersionAchieved number The last version of the automation configuration with which this process had deployed as configured. If the processes.lastGoalVersionAchieved number is not equal to the goalVersion number, the process has not yet deployed according to the current configuration.
processes.plan array Describes how a process that is not yet up-to-date with the configuration will achieve the goal state.

Example

Get Status

Request

curl -u "username:apiKey" --digest -i "https://<ops-manager-host>/api/public/v1.0/groups/533c5895b91030606f21033a/automationStatus"

Response

{
  "processes": [
    {
      "plan": [],
      "lastGoalVersionAchieved": 2,
      "name": "shardedCluster_myShard_0_0",
      "hostname": "testDeploy-0"
    },
    {
      "plan": [],
      "lastGoalVersionAchieved": 2,
      "name": "shardedCluster_myShard_0_1",
      "hostname": "testDeploy-1"
    },
    {
      "plan": [],
      "lastGoalVersionAchieved": 2,
      "name": "shardedCluster_myShard_0_2",
      "hostname": "testDeploy-2"
    },
    {
      "plan": [],
      "lastGoalVersionAchieved": 2,
      "name": "shardedCluster_myShard_1_3",
      "hostname": "testDeploy-3"
    },
    {
      "plan": [],
      "lastGoalVersionAchieved": 2,
      "name": "shardedCluster_myShard_1_4",
      "hostname": "testDeploy-4"
    },
    {
      "plan": [],
      "lastGoalVersionAchieved": 2,
      "name": "shardedCluster_myShard_1_5",
      "hostname": "testDeploy-5"
    },
    {
      "plan": [],
      "lastGoalVersionAchieved": 2,
      "name": "shardedCluster_config_6",
      "hostname": "testDeploy-6"
    },
    {
      "plan": [],
      "lastGoalVersionAchieved": 2,
      "name": "shardedCluster_config_7",
      "hostname": "testDeploy-7"
    },
    {
      "plan": [],
      "lastGoalVersionAchieved": 2,
      "name": "shardedCluster_config_8",
      "hostname": "testDeploy-8"
    },
    {
      "plan": [],
      "lastGoalVersionAchieved": 2,
      "name": "shardedCluster_mongos_9",
      "hostname": "testDeploy-9"
    }
  ],
  "goalVersion": 2
}