NSX-T Data Center Global Manager REST API

Associated URIs:

API Description API Path

List enforcementpoints under Site


Paginated list of all enforcementpoints under Site.
GET /global-manager/api/v1/global-infra/sites/{site-id}/enforcement-points

Full sync EnforcementPoint from Site


Full sync EnforcementPoint from Site
POST /global-manager/api/v1/global-infra/sites/{site-id}/enforcement-points/{enforcement-point-id}?action=full-sync

Delete EnforcementPoint from Site


Delete EnforcementPoint from Site
DELETE /global-manager/api/v1/global-infra/sites/{site-id}/enforcement-points/{enforcementpoint-id}

Read an Enforcement Point under Infra/Site


Read an Enforcement Point under Infra/Site
GET /global-manager/api/v1/global-infra/sites/{site-id}/enforcement-points/{enforcementpoint-id}

Patch a new Enforcement Point under Site


If the passed Enforcement Point does not already exist, create a new Enforcement Point.
If it already exists, patch it.
PATCH /global-manager/api/v1/global-infra/sites/{site-id}/enforcement-points/{enforcementpoint-id}

Reload an Enforcement Point under Site


Reload an Enforcement Point under Site. This will read and update
fabric configs from enforcement point.
POST /global-manager/api/v1/global-infra/sites/{site-id}/enforcement-points/{enforcementpoint-id}?action=reload

Create/update a new Enforcement Point under Site


If the passed Enforcement Point does not already exist, create a new Enforcement Point.
If it already exists, replace it.
PUT /global-manager/api/v1/global-infra/sites/{site-id}/enforcement-points/{enforcementpoint-id}

List Edge Clusters under an Enforcement Point


Paginated list of all Edge Clusters under an Enforcement Point
GET /global-manager/api/v1/global-infra/sites/{site-id}/enforcement-points/{enforcementpoint-id}/edge-clusters

Read an Edge Cluster under an Enforcement Point


Read an Edge Cluster under an Enforcement Point
GET /global-manager/api/v1/global-infra/sites/{site-id}/enforcement-points/{enforcementpoint-id}/edge-clusters/{edge-cluster-id}

Get a Policy Edge Cluster allocation status under an Enforcement Point


Returns the allocation details of cluster and its members. Lists the edge
node members, active and standby services of each node, utilization details
of configured sub-pools. These allocation details can be monitored by
customers to trigger migration of certain service contexts to different
edge nodes, to balance the utilization of edge node resources.
GET /global-manager/api/v1/global-infra/sites/{site-id}/enforcement-points/{enforcementpoint-id}/edge-clusters/{edge-cluster-id}/allocation/status

List Edge Nodes under an Enforcement Point, Edge Cluster


Paginated list of all Edge Nodes under an Enforcement Point, Edge Cluster
GET /global-manager/api/v1/global-infra/sites/{site-id}/enforcement-points/{enforcementpoint-id}/edge-clusters/{edge-cluster-id}/edge-nodes

Read an Edge Node under an Enforcement Point, Edge Cluster


Read an Edge Node under an Enforcement Point, Edge Cluster
GET /global-manager/api/v1/global-infra/sites/{site-id}/enforcement-points/{enforcementpoint-id}/edge-clusters/{edge-cluster-id}/edge-nodes/{edge-node-id}

Get a Policy Edge Cluster real time status under an Enforcement Point


Returns the aggregated status for the Edge cluster along with status of
all edge nodes in the cluster.
Query parameter "source=realtime" is the only supported source.
GET /global-manager/api/v1/global-infra/sites/{site-id}/enforcement-points/{enforcementpoint-id}/edge-clusters/{edge-cluster-id}/status