NSX-T Data Center REST API

Associated URIs:

API Description	API Path
List VirtualNetworkAppliance Clusters under an Enforcement Point Paginated list of all VirtualNetworkAppliance Clusters under an Enforcement Point	GET /policy/api/v1/infra/sites/{site-id}/enforcement-points/{enforcementpoint-id}/virtual-network-appliance-clusters
Delete a VirtualNetworkAppliance Cluster under an Enforcement Point Delete an VirtualNetworkAppliance Cluster under an enforcement point	DELETE /policy/api/v1/infra/sites/{site-id}/enforcement-points/{enforcementpoint-id}/virtual-network-appliance-clusters/{virtual-network-appliance-cluster-id}
Read a VirtualNetworkAppliance Cluster under an Enforcement Point Read an VirtualNetworkAppliance Cluster under an enforcement point	GET /policy/api/v1/infra/sites/{site-id}/enforcement-points/{enforcementpoint-id}/virtual-network-appliance-clusters/{virtual-network-appliance-cluster-id}
Patch a Policy VirtualNetworkAppliance Cluster If the passed VirtualNetworkAppliance Cluster does not already exist, create a new VirtualNetworkAppliance Cluster. If it already exists, patch it.	PATCH /policy/api/v1/infra/sites/{site-id}/enforcement-points/{enforcementpoint-id}/virtual-network-appliance-clusters/{virtual-network-appliance-cluster-id}
Create Or Update a Policy VirtualNetworkAppliance Cluster If the passed VirtualNetworkAppliance Cluster does not already exist, create a new VirtualNetworkAppliance Cluster. If it already exists, update it.	PUT /policy/api/v1/infra/sites/{site-id}/enforcement-points/{enforcementpoint-id}/virtual-network-appliance-clusters/{virtual-network-appliance-cluster-id}
Get a virtual network appliance cluster allocation status under an Enforcement Point Returns the allocation details of cluster and its members. Lists the service 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 virtual network appliance, to balance the utilization of virtual network appliance(VNA) resources.	GET /policy/api/v1/infra/sites/{site-id}/enforcement-points/{enforcementpoint-id}/virtual-network-appliance-clusters/{virtual-network-appliance-cluster-id}/allocation/status
Get a Policy VirtualNetworkAppliance Cluster State info under an Enforcement Point Returns information about the current state of the VirtualNetworkAppliance Cluster.	GET /policy/api/v1/infra/sites/{site-id}/enforcement-points/{enforcementpoint-id}/virtual-network-appliance-clusters/{virtual-network-appliance-cluster-id}/state
Get a virtual network appliance Cluster real time status under an Enforcement Point Returns the aggregated realtime status for the VNA Cluster along with status of all virtual network appliance(VNA) in the cluster.	GET /policy/api/v1/infra/sites/{site-id}/enforcement-points/{enforcementpoint-id}/virtual-network-appliance-clusters/{virtual-network-appliance-cluster-id}/status
List Virtual Network Appliance(VNA) List virtual network appliance(VNA) under an Enforcement Point.	GET /policy/api/v1/infra/sites/{site-id}/enforcement-points/{enforcementpoint-id}/virtual-network-appliance-clusters/{virtual-network-appliance-cluster-id}/virtual-network-appliances
Delete virtual network appliance(VNA) This API is used to delete the virtual network appliance (VNA). When "force" is used as a query parameter, the system will attempt to delete the VNA from vCenter. This "best effort" approach ensures the VNA is not left in a stale state, even if failures occur during the deletion process. However, VNA cannot be deleted if it hosts any logical networking entities, even when using "force". After a successful force delete API execution, user must confirm that the VNA virtual machine has been removed from the vCenter Server.	DELETE /policy/api/v1/infra/sites/{site-id}/enforcement-points/{enforcementpoint-id}/virtual-network-appliance-clusters/{virtual-network-appliance-cluster-id}/virtual-network-appliances/{virtual-network-appliance-id}
Read a virtual network appliance(VNA) Read a virtual network appliance(VNA) under an Enforcement Point	GET /policy/api/v1/infra/sites/{site-id}/enforcement-points/{enforcementpoint-id}/virtual-network-appliance-clusters/{virtual-network-appliance-cluster-id}/virtual-network-appliances/{virtual-network-appliance-id}
Patch a new virtual network appliance(VNA) If the passed VirtualNetworkAppliance(VNA) does not already exist, create a new VirtualNetworkAppliance. If it already exists, patch it.	PATCH /policy/api/v1/infra/sites/{site-id}/enforcement-points/{enforcementpoint-id}/virtual-network-appliance-clusters/{virtual-network-appliance-cluster-id}/virtual-network-appliances/{virtual-network-appliance-id}
Create or update virtual network appliance(VNA) If the passed virtual network appliance(VNA) does not already exist, create a new virtual network appliance(VNA). If it already exists, patch it.	PUT /policy/api/v1/infra/sites/{site-id}/enforcement-points/{enforcementpoint-id}/virtual-network-appliance-clusters/{virtual-network-appliance-cluster-id}/virtual-network-appliances/{virtual-network-appliance-id}
Virtual Network Appliance(VNA) Enter Maintenance Mode Action API Put virtual network appliance(VNA) into maintenance mode if there is no VIFs attached. When virtual network appliance(VNA) is in maintenance mode, no configuration changes are allowed.	POST /policy/api/v1/infra/sites/{site-id}/enforcement-points/{enforcementpoint-id}/virtual-network-appliance-clusters/{virtual-network-appliance-cluster-id}/virtual-network-appliances/{virtual-network-appliance-id}/action/enter-maintenance-mode
Evacuate the service contexts from virtual network appliance(VNA) This API is designed to evacuate service contexts from a specified virtual network appliance(VNA). To successfully evacuate the service contexts from the virtual network appliance(VNA) with the given ID, it is crucial that this node only contains auto-allocated service contexts. If there are any manually allocated service contexts present on the virtual network cluster member, the evacuation task will not be executed. To ensure high availability during the evacuation process, the virtual network cluster should have at least two virtual network appliances(VNA).	POST /policy/api/v1/infra/sites/{site-id}/enforcement-points/{enforcementpoint-id}/virtual-network-appliance-clusters/{virtual-network-appliance-cluster-id}/virtual-network-appliances/{virtual-network-appliance-id}/action/evacuate
Virtual network appliance(VNA) Exit Maintenance Mode Action API This APi will perform the exit maintenance mode operation on virtual network appliance(VNA).	POST /policy/api/v1/infra/sites/{site-id}/enforcement-points/{enforcementpoint-id}/virtual-network-appliance-clusters/{virtual-network-appliance-cluster-id}/virtual-network-appliances/{virtual-network-appliance-id}/action/exit-maintenance-mode
Redeploy virtual network appliance(VNA) Redeploys a virtual network appliance(VNA) at NSX Manager that replaces the virtual network appliance(VNA) with identifier <id>. If NSX Manager can access the specified virtual network appliance(VNA), then the appliance is put into maintenance mode and then the associated VM is deleted. This is a means to reset all configuration on the virtual network appliance(VNA). The communication channel between NSX Manager and service is established after this operation.	POST /policy/api/v1/infra/sites/{site-id}/enforcement-points/{enforcementpoint-id}/virtual-network-appliance-clusters/{virtual-network-appliance-cluster-id}/virtual-network-appliances/{virtual-network-appliance-id}/action/redeploy
Get a Virtual Network Appliance(VNA) State Returns information about the current state of the virtual network appliance(VNA) configuration.	GET /policy/api/v1/infra/sites/{site-id}/enforcement-points/{enforcementpoint-id}/virtual-network-appliance-clusters/{virtual-network-appliance-cluster-id}/virtual-network-appliances/{virtual-network-appliance-id}/state