NSX-T Data Center REST API

Associated URIs:

API Description	API Path
Sync the edge node configuration This API synchronizes the Edge Transport Node intent with the latest configuration from external sources, including vCenter Server and the Edge Node Command Line Interface (CLI). The API supports an optional operation_type request parameter to control the synchronization scope. Request Parameters: operation_type (optional): Specifies the type of synchronization operation to perform. Valid values: SYNC_VC_CONFIG: Synchronize with vCenter Server configuration only SYNC_ALL: Synchronize with both vCenter Server and Edge Node CLI configuration Default behavior (no operation_type specified): When the Edge Transport Node intent differs from the VM configuration in vCenter, the API retrieves the latest VM details from vCenter (including compute cluster ID, storage ID, reservation information, and other VM properties) and updates the Edge Transport Node intent accordingly. Behavior when operation_type = SYNC_VC_CONFIG: Behaves same as default case, synchronizing only with the vCenter Server configuration. Behavior when operation_type = SYNC_ALL: When the Edge Transport Node intent differs from either the Edge Node CLI configuration or the VM configuration in vCenter, the API retrieves configuration from both sources: - CLI settings: Hostname, search domains, NTP servers, DNS servers, syslog servers, and other CLI-configured parameters - VM details from vCenter: Compute cluster ID, storage ID, reservation information, and other VM properties The Edge Transport Node intent is then updated with all retrieved values from both sources. To view the updated data in Edge Transport Node intent, send a GET request to the following URL: https://<nsx-mgr>/policy/api/v1/infra/sites/<>/enforcement-points/<>/edge-transport-nodes/<>	POST /policy/api/v1/infra/sites/{site-id}/enforcement-points/{enforcement-point-id}/edge-transport-nodes/{edge-transport-node-id}/action/sync-edge-configuration
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)
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}
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 This API is used to delete the edge transport node. When "force" is used as a query parameter, the system will attempt to delete the edge from vCenter. This "best effort" approach ensures the edge is not left in a stale state, even if failures occur during the deletion process. However, an edge node 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 edge virtual machine has been removed from the vCenter Server.	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. Transport nodes are hypervisor NSX Edges that will participate in an NSX-T overlay.this means that it will have Tier0/TIer1 uplinks and downlinks. This API creates/updates the edge node (router) in the transport network. Additional documentation on creating a transport node can be found in the NSX-T Installation Guide. In order for the transport node to forward packets, the switch_spec property must be specified. When creating a edge transport node, you need to specify if the edge TN switches are already manually preconfigured on the node, or if NSX should create and manage the edge TN switches. You specify this choice by the type of host switches you pass in the switch_spec property of the Edge Transport Node request payload. For a NSX edge node, NSX Manager always configures the edge TN switch. To allow NSX to manage the Edge TN switch configuration on NSX Edge nodes, pass an array of switches objects in the switch_spec property, and NSX will automatically create edge TN switches with the properties you provide. In the current NSX-T release, up to 16 host switches can be automatically managed. See the switch_spec schema definition for documentation on the properties that must be provided. If the edge node (router) is already added in system then it can be converted to transport node by providing node_id in request. If edge transport node (router) is not already present in system then new edge transport node can be created using this API.	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
Current configuration for this node	GET /api/v1/transport-nodes/{transport-node-id}/node/configuration
Read NSX Nestdb service properties	GET /api/v1/transport-nodes/{transport-node-id}/node/services/nestdb
Restart, start or stop the NSX Nestdb service	POST /api/v1/transport-nodes/{transport-node-id}/node/services/nestdb?action=restart POST /api/v1/transport-nodes/{transport-node-id}/node/services/nestdb?action=start POST /api/v1/transport-nodes/{transport-node-id}/node/services/nestdb?action=stop
Read NSX Nestdb service status	GET /api/v1/transport-nodes/{transport-node-id}/node/services/nestdb/status
Read NSX EdgeMSR service properties	GET /api/v1/transport-nodes/{transport-node-id}/node/services/router
Read NSX EdgeMSRConfig service properties	GET /api/v1/transport-nodes/{transport-node-id}/node/services/router-config
Read NSX EdgeMSRConfig service status	GET /api/v1/transport-nodes/{transport-node-id}/node/services/router-config/status
Read NSX EdgeMSR service status	GET /api/v1/transport-nodes/{transport-node-id}/node/services/router/status