NSX-T Data Center REST API

Associated URIs:

API Description API Path

List Policy Edge Cluster High Availability Profiles


List edge cluster high availability profiles.
GET /policy/api/v1/infra/sites/{site-id}/enforcement-points/{enforcementpoint-id}/edge-cluster-high-availability-profiles

Delete a Policy Edge Cluster High Availability Profile


Delete a policy edge cluster high availability profile.
DELETE /policy/api/v1/infra/sites/{site-id}/enforcement-points/{enforcementpoint-id}/edge-cluster-high-availability-profiles/{edge-cluster-high-availability-profile-id}

Get a Policy Edge Cluster High Availability Profile


Get a policy edge cluster high availability profile.
GET /policy/api/v1/infra/sites/{site-id}/enforcement-points/{enforcementpoint-id}/edge-cluster-high-availability-profiles/{edge-cluster-high-availability-profile-id}

Patch a Policy EdgeCluster High Availability Profile


Patch a policy edge cluster high availability profile.
PATCH /policy/api/v1/infra/sites/{site-id}/enforcement-points/{enforcementpoint-id}/edge-cluster-high-availability-profiles/{edge-cluster-high-availability-profile-id}

Create or Update a Policy Edge Cluster High Availability Profile


Create or Update a policy edge cluster high availability profile.
PUT /policy/api/v1/infra/sites/{site-id}/enforcement-points/{enforcementpoint-id}/edge-cluster-high-availability-profiles/{edge-cluster-high-availability-profile-id}

Delete the specified edge cluster.


Delete the specified edge cluster.
DELETE /policy/api/v1/infra/sites/{site-id}/enforcement-points/{enforcementpoint-id}/edge-clusters/{edge-cluster-id}

Patch a Policy Edge Cluster


Patch a policy edge cluster.
It only supports homogeneous members.
The Edge Transport Nodes are only allowed in cluster members.
DeploymentType (VIRTUAL_MACHINE|PHYSICAL_MACHINE) of these Edge Nodes is
recommended to be the same.
Any update operation on members of edge cluster is not permitted,
To replace the edge transport node for an existing member, refer
/policy/api/v1/infra/sites/default/enforcement-points/default/edge-clusters/
/action/replace-policy-edge-node
api.
PATCH /policy/api/v1/infra/sites/{site-id}/enforcement-points/{enforcementpoint-id}/edge-clusters/{edge-cluster-id}

Create Or Update a Policy Edge Cluster


Edge Cluster only supports homogeneous members. The Edge Transport Nodes are
only allowed in cluster members. DeploymentType of these edge nodes can be VIRTUAL_MACHINE or PHYSICAL_MACHINE.
Any update operation on members of edge cluster is not permitted,
To replace the edge transport node for an existing member, refer
/policy/api/v1/infra/sites/default/enforcement-points/default/edge-clusters/
/action/replace-policy-edge-node
API.
PUT /policy/api/v1/infra/sites/{site-id}/enforcement-points/{enforcementpoint-id}/edge-clusters/{edge-cluster-id}

Relocate service contexts from policy edge node and remove policy edge node from the edge-cluster


Relocate auto allocated service contexts from policy edge node at given id.
For API to perform relocate and remove action the edge node at given id must only have auto allocated service contexts.
If any manually allocated service context is present on the edge cluster member, then the task will not be performed.
Also, it is recommended to move the edge node for which relocate and remove action is being performed into maintenance mode,before executing the API.
If edge is not moved into maintenance mode, then API will move edge node into maintenance
mode before performing the actual relocate and remove task.To maintain high availability, Edge cluster should have at
least two healthy edge nodes for relocation and removal.
Once relocate action is performed successfully, the policy edge node will be removed from the edge cluster.
POST /policy/api/v1/infra/sites/{site-id}/enforcement-points/{enforcementpoint-id}/edge-clusters/{edge-cluster-id}/action/relocate-and-remove-edge-transport-node

Replace the policy edge node at the specified member-index in the edge-cluster


Replace the Policy Edge Node present at the specified member-index in the edge-cluster.
This is a disruptive action. This will move all the Interfaces(uplink and routerLink)
hosted on the old Policy Edge Node to the new Policy Edge Node. The same Policy Edge Node cannot be
present as a member of any edge cluster.
POST /policy/api/v1/infra/sites/{site-id}/enforcement-points/{enforcementpoint-id}/edge-clusters/{edge-cluster-id}/action/replace-edge-transport-node

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 /policy/api/v1/infra/sites/{site-id}/enforcement-points/{enforcementpoint-id}/edge-clusters/{edge-cluster-id}/allocation/status
GET /policy/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 /policy/api/v1/infra/sites/{site-id}/enforcement-points/{enforcementpoint-id}/edge-clusters/{edge-cluster-id}/edge-nodes
GET /policy/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 /policy/api/v1/infra/sites/{site-id}/enforcement-points/{enforcementpoint-id}/edge-clusters/{edge-cluster-id}/edge-nodes/{edge-node-id}
GET /policy/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 State info under an Enforcement Point


Returns information about the current state of the edge cluster.
GET /policy/api/v1/infra/sites/{site-id}/enforcement-points/{enforcementpoint-id}/edge-clusters/{edge-cluster-id}/state

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 /policy/api/v1/infra/sites/{site-id}/enforcement-points/{enforcementpoint-id}/edge-clusters/{edge-cluster-id}/status
GET /policy/api/v1/global-infra/sites/{site-id}/enforcement-points/{enforcementpoint-id}/edge-clusters/{edge-cluster-id}/status