NSX-T Data Center Global Manager REST API

Get Global Managed operational state

Global Manager operation state includes the current status, switchover status
of global manager nodes if any, errors if any and consolidated status of the
operation.

Request:

Method:

GET

URI Path(s):

/global-manager/api/v1/gm-operational-state

Request Headers:

n/a

Query Parameters:

n/a

Request Body:

n/a

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

GmOperationalState+

GmOperationalState (schema)

Name	Description	Type	Notes
consolidated_progress	Consolidated status of the current operation	string	Enum: IN_PROGRESS, COMPLETED, FAILED
end_time	End time of the switchover operation	integer
errors	Errors if any	array of string
node_statuses	Switchover status from each NSX Global Manager appliance node	array of GmNodeStatus
site_manager_ref	Timestamp reference for the change provided by SiteManager	integer
start_time	Start time of the switchover operation	integer
status	The current switchover operation requested.	string	Required Enum: NONE, ACTIVE, STANDBY, SWITCHING_TO_ACTIVE, SWITCHING_TO_STANDBY, DECOMMISSIONED
warnings	Errors if any	array of string

Example Response:

{ "status": "SWITCHING_TO_ACTIVE", "start_time": 2374925435, "end_time": 32342234, "consolidated_progress": "IN_PROGRESS", "nodes" :[ { "node-id": "23fae-332d-34243d-2342aa", "status": "COMPLETED", "start_time": 2374925435, "end_time": 32342234, }, { "node-id": "55fae-332d-34243d-2342fr", "status": "IN_PROGRESS", "start_time": 2374925435, "end_time": 32342234, } ] }

Required Permissions:

read

Feature:

site_admin

Additional Errors:

• 301 Moved Permanently
• 307 Temporary Redirect
• 400 Bad Request
• 403 Forbidden
• 409 Conflict
• 412 Precondition Failed
• 500 Internal Server Error
• 503 Service Unavailable