NSX-T Data Center REST API

Associated URIs:

API Description API Path

Get datapath troubleshoot config of edge transport nodes


This API is used to fetch the control packet drop log config
at enforcement Point level.
GET /policy/api/v1/infra/sites/{site-id}/enforcement-points/{enforcement-point-id}/edge-transport-nodes/troubleshoot/datapath (Experimental)

Enable or Disable the datapath troubleshoot config on edge transport nodes


This API is used to enable/disable the control packet drop log config in all edge transport nodes
at the enforcement Point level.
PATCH /policy/api/v1/infra/sites/{site-id}/enforcement-points/{enforcement-point-id}/edge-transport-nodes/troubleshoot/datapath (Experimental)

List Edge Transport Node under an Enforcement Point


List Edge Transport Nodes under an Enforcement Point
GET /policy/api/v1/infra/sites/{site-id}/enforcement-points/{enforcementpoint-id}/edge-transport-nodes

Delete Edge Transport Node


Delete Edge Transport Node.
DELETE /policy/api/v1/infra/sites/{site-id}/enforcement-points/{enforcementpoint-id}/edge-transport-nodes/{edge-transport-node-id}

Read an Edge Transport Node under an Enforcement Point


Read an Edge Transport Node under an Enforcement Point
GET /policy/api/v1/infra/sites/{site-id}/enforcement-points/{enforcementpoint-id}/edge-transport-nodes/{edge-transport-node-id}

Patch a new LCM Edge Transport Node under Enforcement Point


If the passed Edge Transport Node does not already exist, create a new Edge Transport Node.
If it already exists, patch it.
PATCH /policy/api/v1/infra/sites/{site-id}/enforcement-points/{enforcementpoint-id}/edge-transport-nodes/{edge-transport-node-id}

Create or update a LCM Edge Transport Node under Enforcement Point


If the passed Edge Transport Node does not already exist, create a new Edge Transport Node.
If it already exists, update it.
PUT /policy/api/v1/infra/sites/{site-id}/enforcement-points/{enforcementpoint-id}/edge-transport-nodes/{edge-transport-node-id}

Policy Edge Transport Node Enter Maintenance Mode Action API


Put edge transport node into maintenance mode if there is no VIFs attached.
When EdgeTransportNode is in maintenance mode, no configuration changes are allowed.
POST /policy/api/v1/infra/sites/{site-id}/enforcement-points/{enforcementpoint-id}/edge-transport-nodes/{edge-transport-node-id}/action/enter-maintenance-mode

Policy Edge Transport Node Exit Maintenance Mode Action API


This APi will exit from maintenance mode
POST /policy/api/v1/infra/sites/{site-id}/enforcement-points/{enforcementpoint-id}/edge-transport-nodes/{edge-transport-node-id}/action/exit-maintenance-mode

Redeploy Edge Transport Node


Redeploys an edge transport node at NSX Manager that replaces the edge transport node with
identifier <node-id>. If NSX Manager can access the specified edge node,
then the node is put into maintenance mode and then the associated VM is
deleted. This is a means to reset all configuration on the edge node.
The communication channel between NSX Manager and edge is established after
this operation.
POST /policy/api/v1/infra/sites/{site-id}/enforcement-points/{enforcementpoint-id}/edge-transport-nodes/{edge-transport-node-id}/action/redeploy

List the specified edge transport node's network interfaces.


Returns the number of interfaces on the edge transport node and detailed
information about each interface. Interface information includes MTU,
broadcast and host IP addresses, link and admin status, MAC address, network
mask, and the IP configuration method (static or DHCP).
GET /policy/api/v1/infra/sites/{site-id}/enforcement-points/{enforcementpoint-id}/edge-transport-nodes/{edge-transport-node-id}/network/interfaces

Read counters for edge transport node interfaces.


This API returns the counters of the specified interface. The counters reset on reboot or redeploy
of the appliance or restart of the data plane. NSX Manager polls the edge-transport-node every minute
(by default) to update the data returned on this API. If you need near realtime values, use the query
parameter \"?source=realtime\" to the API and it will make NSX Manager collect the statistics from
the edge transport node and returns the updated counters.
GET /policy/api/v1/infra/sites/{site-id}/enforcement-points/{enforcementpoint-id}/edge-transport-nodes/{edge-transport-node-id}/network/interfaces/{interface-id}/statistics

Get a Policy EdgeTransport Node's State info under an Enforcement Point


Returns information about the current state of the edge transport node
configuration and information about the associated edge tn switches.
GET /policy/api/v1/infra/sites/{site-id}/enforcement-points/{enforcementpoint-id}/edge-transport-nodes/{edge-transport-node-id}/state

Get a Policy EdgeTransport Node's status info under an Enforcement Point


Returns information about the current status of the edge transport node.
GET /policy/api/v1/infra/sites/{site-id}/enforcement-points/{enforcementpoint-id}/edge-transport-nodes/{edge-transport-node-id}/status

Get a Policy EdgeTransport Node's State info under an Enforcement Point


Returns information about the current state of the edge transport node
configuration and information about the associated edge tn switches.
GET /policy/api/v1/infra/sites/{site-id}/enforcement-points/{enforcementpoint-id}/edge-transport-nodes/state

Get high-level summary of all edge transport nodes. The service layer does not support source = realtime or cached.


GET /policy/api/v1/infra/sites/{site-id}/enforcement-points/{enforcementpoint-id}/edge-transport-nodes/status