NSX-T Data Center Global Manager REST API

Associated URIs:

API Description API Path

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.
GET /global-manager/api/v1/gm-operational-state

List Global Managers


List Global Managers under Infra.
GET /global-manager/api/v1/global-infra/global-managers

Delete a Global Manager under Infra


Delete a particular global manager under Infra.
Global Manager id 'self' is reserved and can be used for referring to local
logged in Global Manager.
Example - /infra/global-managers/self
DELETE /global-manager/api/v1/global-infra/global-managers/{global-manager-id}

Read a Global Manager


Retrieve information about a particular configured global manager.
Global Manager id 'self' is reserved and can be used for referring to local
logged in Global Manager.
Example - /infra/global-managers/self
GET /global-manager/api/v1/global-infra/global-managers/{global-manager-id}

Create or patch a Global Manager


Create or patch a Global Manager under Infra.
Global Manager id 'self' is reserved and can be used for referring to local
logged in Global Manager.
Example - /infra/global-managers/self
PATCH /global-manager/api/v1/global-infra/global-managers/{global-manager-id}

Create or fully replace a Global Manager under infra


Create or fully replace Global Manager under Infra.
Revision is optional for creation and required for update.
Global Manager id 'self' is reserved and can be used for referring to local
logged in Global Manager.
Example - /infra/global-managers/self
PUT /global-manager/api/v1/global-infra/global-managers/{global-manager-id}

List resources pending to be cleaned from set of sites.


Paginated list of resources pending to be cleaned.
GET /global-manager/api/v1/global-infra/site-cleanup-pending

Get Upgrade summary


API will return high level summary of Upgrade across various sites.
GET /global-manager/api/v1/global-infra/upgrade-summary