Associated URIs:

API Description	API Path
Return the List of Discovered Nodes Returns information about all discovered nodes.	GET /api/v1/fabric/discovered-nodes
Return Discovered Node Information Returns information about a specific discovered node.	GET /api/v1/fabric/discovered-nodes/<node-ext-id>
Apply cluster level config on Discovered Node When transport node profile (TNP) is applied to a cluster, if any validation fails (e.g. VMs running on host) then transport node (TN) is not created. In that case after the required action is taken (e.g. VMs powered off), you can call this API to try to create TN for that discovered node. Do not call this API if Transport Node already exists for the discovered node. In that case use API on transport node. /transport-nodes/?action=restore_cluster_config	POST /api/v1/fabric/discovered-nodes/<node-ext-id>?action=reapply_cluster_config
(Deprecated) Prepares discovered Node for NSX Prepares(hostprep) discovered node for NSX. NSX LCP bundles are installed on this discovered node. This API is deprecated. Use /fabric/discovered-nodes/?action=create_transport_node	POST /api/v1/fabric/discovered-nodes/<node-ext-id>?action=hostprep (Deprecated)
Created Transport Node for Discovered Node NSX components are installaed on host and transport node is created with given configurations.	POST /api/v1/fabric/discovered-nodes/<node-ext-id>?action=create_transport_node
Return the List of Nodes Returns information about all fabric nodes (hosts and edges). This api is deprecated as part of FN+TN unification. Please use Transport Node API GET /transport-nodes to list all fabric nodes.	GET /api/v1/fabric/nodes (Deprecated)
Register and Install NSX Components on a Node Creates a host node (hypervisor) or edge node (router) in the transport network. When you run this command for a host, NSX Manager attempts to install the NSX kernel modules, which are packaged as VIB, RPM, or DEB files. For the installation to succeed, you must provide the host login credentials and the host thumbprint. To get the ESXi host thumbprint, SSH to the host and run the openssl x509 -in /etc/vmware/ssl/rui.crt -fingerprint -sha256 -noout command. To generate host key thumbprint using SHA-256 algorithm please follow the steps below. Log into the host, making sure that the connection is not vulnerable to a man in the middle attack. Check whether a public key already exists. Host public key is generally located at '/etc/ssh/ssh_host_rsa_key.pub'. If the key is not present then generate a new key by running the following command and follow the instructions. ssh-keygen -t rsa Now generate a SHA256 hash of the key using the following command. Please make sure to pass the appropriate file name if the public key is stored with a different file name other than the default 'id_rsa.pub'. *awk '{print $2}' id_rsa.pub \| base64 -d \| sha256sum -b \| sed 's/ .$//' \| xxd -r -p \| base64** This api is deprecated as part of FN+TN unification. Please use Transport Node API POST /transport-nodes to install NSX components on a node.	POST /api/v1/fabric/nodes (Deprecated)
Delete a Node Removes a specified fabric node (host or edge). A fabric node may only be deleted when it is no longer referenced by a Transport Node. If unprepare_host option is set to false, the host will be deleted without uninstalling the NSX components from the host. This api is deprecated, use Transport Node API DELETE /transport-nodes/<transport-node-id> to delete FN. DELETE /transport-nodes/ to delete FN.	DELETE /api/v1/fabric/nodes/<node-id> (Deprecated)
Return Node Information Returns information about a specific fabric node (host or edge). This api is deprecated, use Transport Node API GET /transport-nodes/<transport-node-id> to get fabric node information.	GET /api/v1/fabric/nodes/<node-id> (Deprecated)
Perform an Action on Fabric Node The supported fabric node actions are enter_maintenance_mode, exit_maintenance_mode for EdgeNode. This API is deprecated, please call TransportNode maintenance mode API to update maintenance mode, refer to "Update transport node maintenance mode".	POST /api/v1/fabric/nodes/<node-id> (Deprecated)
Perform a service deployment upgrade on a host node	POST /api/v1/fabric/nodes/<node-id>?action=upgrade_infra
Restart the inventory sync for the node if it is paused currently. Restart the inventory sync for the node if it is currently internally paused. After this action the next inventory sync coming from the node is processed. This api is deprecated as part of FN+TN unification. Please use Transport Node API POST /transport-nodes/<transport-node-id>?action=restart_inventory_sync to restart inventory sync of node.	POST /api/v1/fabric/nodes/<node-id>?action=restart_inventory_sync (Deprecated)
Update a Node Modifies attributes of a fabric node (host or edge). This api is deprecated as part of FN+TN unification. Please use Transport Node API PUT /transport-nodes/<transport-node-id> to update fabric node details. API PUT /transport-nodes/ to update fabric node details.	PUT /api/v1/fabric/nodes/<node-id> (Deprecated)
Return the List of Capabilities of a Single Node Returns information about capabilities of a single fabric host node. Edge nodes do not have capabilities. This api is deprecated, use GET /transport-nodes/<transportnode-id>/capabilities if FN is converted to TN.	GET /api/v1/fabric/nodes/<node-id>/capabilities (Deprecated)
Get the module details of a Fabric Node This api is deprecated, use Transport Node API GET /transport-nodes/<transportnode-id>/modules to get fabric node modules.	GET /api/v1/fabric/nodes/<node-id>/modules (Deprecated)
List the specified node's Network Interfaces Returns the number of interfaces on the 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). This api is deprecated. Please use Transport Node API GET /transport-nodes//network/interfaces to list node network interfaces for the corresponding TN.	GET /api/v1/fabric/nodes/<node-id>/network/interfaces (Deprecated)
Read the node's Network Interface Returns detailed information about the specified 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). This api is deprecated as part of FN+TN unification. Please use Transport Node API GET /transport-nodes//network/interfaces/ to get interface details of a node.	GET /api/v1/fabric/nodes/<node-id>/network/interfaces/<interface-id> (Deprecated)
Get the Realized State of a Fabric Node. For edge nodes, returns the current install state when deployment is in progress, NODE_READY when deployment is complete and the failure state when deployment has failed. This api is deprecated. Please use /transport-nodes/<transportnode-id>/state to get realized state of a Fabric Node.	GET /api/v1/fabric/nodes/<node-id>/state (Deprecated)
Return Runtime Status Information for a Node Returns connectivity, heartbeat, and version information about a fabric node (host or edge). Note that the LCP connectivity status remains down until after the fabric node has been added as a transpot node and the NSX host switch has been successfully installed. See POST /api/v1/transport-nodes. This api is deprecated, use GET /api/v1/transport-nodes/<node-id>/status to get status information of a node with constraint FN is converted to TN.	GET /api/v1/fabric/nodes/<node-id>/status (Deprecated)
Invoke DELETE request on target fabric node Invoke DELETE request on target fabric node. This api is deprecated as part of FN+TN unification. Please use Transport Node API DELETE /transport-nodes/<transport-node-id>/<target-node-id>/<target-uri>	DELETE /api/v1/fabric/nodes/<target-node-id>/<target-uri> (Deprecated)
Invoke GET request on target fabric node Invoke GET request on target fabric node. This api is deprecated as part of FN+TN unification. Please use Transport Node API GET /transport-nodes/<transport-node-id>/<target-node-id>/<target-uri>	GET /api/v1/fabric/nodes/<target-node-id>/<target-uri> (Deprecated)
Invoke POST request on target fabric node Invoke POST request on target fabric node. This api is deprecated as part of FN+TN unification. Please use Transport Node API POST /transport-nodes/<transport-node-id>/<target-node-id>/<target-uri>	POST /api/v1/fabric/nodes/<target-node-id>/<target-uri> (Deprecated)
Invoke PUT request on target fabric node Invoke PUT request on target fabric node. This api is deprecated as part of FN+TN unification. Please use Transport Node API PUT /transport-nodes/<transport-node-id>/<target-node-id>/<target-uri>	PUT /api/v1/fabric/nodes/<target-node-id>/<target-uri> (Deprecated)
Return Runtime Status Information for given Nodes Returns connectivity, heartbeat, and version information about all fabric nodes (host or edge). This api is deprecated as part of FN+TN unification. Please use Transport Node Status API /transport-nodes/<node-id>/status to get status information of a node and to get all transport nodes ids use GET /transport-nodes.	GET /api/v1/fabric/nodes/status (Deprecated)
Return list of supported host OS types Returns names of all supported host OS.	GET /api/v1/fabric/ostypes
Return the list of physical servers Returns information of all physical/bare metal servers registered as TN.	GET /api/v1/fabric/physical-servers
Return a specific physical server Returns information about physical/bare metal server based on given transport node id.	GET /api/v1/fabric/physical-servers/<physical-server-id>
List LLDP Neighbor Properties of Fabric Node List LLDP Neighbor Properties for all interfaces of Fabric Node	GET /api/v1/lldp/fabric-nodes/<fabric-node-id>/interfaces
Read LLDP Neighbor Properties of Fabric Node by Interface Name Read LLDP Neighbor Properties for a specific interface of Fabric Node	GET /api/v1/lldp/fabric-nodes/<fabric-node-id>/interfaces/<interface-name>
List LLDP Neighbor Properties of Transport Node List LLDP Neighbor Properties for all interfaces of Transport Node	GET /api/v1/lldp/transport-nodes/<node-id>/interfaces
Read LLDP Neighbor Properties of Transport Node by Interface Name Read LLDP Neighbor Properties for a specific interface of Transport Node	GET /api/v1/lldp/transport-nodes/<node-id>/interfaces/<interface-name>
List Transport Node collections Returns all Transport Node collections	GET /api/v1/transport-node-collections
Create transport node collection by attaching Transport Node Profile to cluster. When transport node collection is created the hosts which are part of compute collection will be prepared automatically i.e. NSX Manager attempts to install the NSX components on hosts. Transport nodes for these hosts are created using the configuration specified in transport node profile.	POST /api/v1/transport-node-collections
Detach transport node profile from compute collection. By deleting transport node collection, we are detaching the transport node profile(TNP) from the compute collection. It has no effect on existing transport nodes. However, new hosts added to the compute collection will no longer be automatically converted to NSX transport node. Detaching TNP from compute collection does not delete TNP.	DELETE /api/v1/transport-node-collections/<transport-node-collection-id>
Get Transport Node collection by id Returns transport node collection by id	GET /api/v1/transport-node-collections/<transport-node-collection-id>
Update Transport Node collection Attach different transport node profile to compute collection by updating transport node collection.	PUT /api/v1/transport-node-collections/<transport-node-collection-id>
Get Transport Node collection application state Returns the state of transport node collection based on the states of transport nodes of the hosts which are part of compute collection.	GET /api/v1/transport-node-collections/<transport-node-collection-id>/state
List Transport Nodes Returns information about all transport nodes along with underlying host or edge details. A transport node is a host or edge that contains hostswitches. A hostswitch can have virtual machines connected to them. Because each transport node has hostswitches, transport nodes can also have virtual tunnel endpoints, which means that they can be part of the overlay.	GET /api/v1/transport-nodes
Create a Transport Node Transport nodes are hypervisor hosts and NSX Edges that will participate in an NSX-T overlay. For a hypervisor host, this means that it hosts VMs that will communicate over NSX-T logical switches. For NSX Edges, this means that it will have logical router uplinks and downlinks. This API creates transport node for a host node (hypervisor) or edge node (router) in the transport network. When you run this command for a host, NSX Manager attempts to install the NSX kernel modules, which are packaged as VIB, RPM, or DEB files. For the installation to succeed, you must provide the host login credentials and the host thumbprint. To get the ESXi host thumbprint, SSH to the host and run the openssl x509 -in /etc/vmware/ssl/rui.crt -fingerprint -sha256 -noout command. To generate host key thumbprint using SHA-256 algorithm please follow the steps below. Log into the host, making sure that the connection is not vulnerable to a man in the middle attack. Check whether a public key already exists. Host public key is generally located at '/etc/ssh/ssh_host_rsa_key.pub'. If the key is not present then generate a new key by running the following command and follow the instructions. ssh-keygen -t rsa Now generate a SHA256 hash of the key using the following command. Please make sure to pass the appropriate file name if the public key is stored with a different file name other than the default 'id_rsa.pub'. *awk '{print $2}' id_rsa.pub \| base64 -d \| sha256sum -b \| sed 's/ .$//' \| xxd -r -p \| base64** This api is deprecated as part of FN+TN unification. Please use Transport Node API to install NSX components on a node. 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 host_switch_spec property must be specified. Host switches (called bridges in OVS on KVM hypervisors) are the individual switches within the host virtual switch. Virtual machines are connected to the host switches. When creating a transport node, you need to specify if the host switches are already manually preconfigured on the node, or if NSX should create and manage the host switches. You specify this choice by the type of host switches you pass in the host_switch_spec property of the TransportNode request payload. For a KVM host, you can preconfigure the host switch, or you can have NSX Manager perform the configuration. For an ESXi host or NSX Edge node, NSX Manager always configures the host switch. To preconfigure the host switches on a KVM host, pass an array of PreconfiguredHostSwitchSpec objects that describes those host switches. In the current NSX-T release, only one prefonfigured host switch can be specified. See the PreconfiguredHostSwitchSpec schema definition for documentation on the properties that must be provided. Preconfigured host switches are only supported on KVM hosts, not on ESXi hosts or NSX Edge nodes. To allow NSX to manage the host switch configuration on KVM hosts, ESXi hosts, or NSX Edge nodes, pass an array of StandardHostSwitchSpec objects in the host_switch_spec property, and NSX will automatically create host switches with the properties you provide. In the current NSX-T release, up to 16 host switches can be automatically managed. See the StandardHostSwitchSpec schema definition for documentation on the properties that must be provided. Note: Previous versions of NSX-T also used a property named transport_zone_endpoints at TransportNode level. This property is deprecated which creates some combinations of new client along with old client payloads. Examples [1] & [2] show old/existing client request and response by populating transport_zone_endpoints property at TransportNode level. Example [3] shows TransportNode creation request/response by populating transport_zone_endpoints property at StandardHostSwitch level and other new properties. The request should either provide node_deployement_info or node_id. If the host node (hypervisor) or edge node (router) is already added in system then it can be converted to transport node by providing node_id in request. If host node (hypervisor) or edge node (router) is not already present in system then information should be provided under node_deployment_info.	POST /api/v1/transport-nodes
Get the module details of a transport node	GET /api/v1/transport-nodes/<node-id>/modules
Get high-level summary of a transport node	GET /api/v1/transport-nodes/<node-id>/pnic-bond-status
Read status of all transport nodes with tunnel connections to transport node	GET /api/v1/transport-nodes/<node-id>/remote-transport-node-status
Read status of a transport node	GET /api/v1/transport-nodes/<node-id>/status
List of tunnels	GET /api/v1/transport-nodes/<node-id>/tunnels
Tunnel properties	GET /api/v1/transport-nodes/<node-id>/tunnels/<tunnel-name>
Invoke DELETE request on target transport node	DELETE /api/v1/transport-nodes/<target-node-id>/<target-uri>
Invoke GET request on target transport node	GET /api/v1/transport-nodes/<target-node-id>/<target-uri>
Invoke POST request on target transport node	POST /api/v1/transport-nodes/<target-node-id>/<target-uri>
Invoke PUT request on target transport node	PUT /api/v1/transport-nodes/<target-node-id>/<target-uri>
Delete a Transport Node Deletes the specified transport node. Query param force can be used to force delete the host nodes. Force deletion of edge and public cloud gateway nodes is not supported. It also removes the specified node (host or edge) from system. If unprepare_host option is set to false, then host will be deleted without uninstalling the NSX components from the host.	DELETE /api/v1/transport-nodes/<transport-node-id>
Get a Transport Node Returns information about a specified transport node.	GET /api/v1/transport-nodes/<transport-node-id>
Apply cluster level Transport Node Profile on overridden host A host can be overridden to have different configuration than Transport Node Profile(TNP) on cluster. This action will restore such overridden host back to cluster level TNP. This API can be used in other case. When TNP is applied to a cluster, if any validation fails (e.g. VMs running on host) then existing transport node (TN) is not updated. In that case after the issue is resolved manually (e.g. VMs powered off), you can call this API to update TN as per cluster level TNP.	POST /api/v1/transport-nodes/<transport-node-id>?action=restore_cluster_config
Refresh the node configuration for the Edge node. The API is applicable for Edge transport nodes. If you update the VM configuration and find a discrepancy in VM configuration at NSX Manager, then use this API to refresh configuration at NSX Manager. It refreshes the VM configuration from sources external to MP. Sources include vSphere Server and the edge node. After this action, the API GET api/v1/transport-nodes will show refreshed data.	POST /api/v1/transport-nodes/<transport-node-id>?action=refresh_node_configuration&resource_type=EdgeNode
Restart the inventory sync for the node if it is paused currently. Restart the inventory sync for the node if it is currently internally paused. After this action the next inventory sync coming from the node is processed.	POST /api/v1/transport-nodes/<transport-node-id>?action=restart_inventory_sync
Enable flow cache for an edge transport node Enable flow cache for edge transport node. Caution: This involves restart of the edge dataplane and hence may lead to network disruption.	POST /api/v1/transport-nodes/<transport-node-id>?action=enable_flow_cache
Disable flow cache for an edge transport node Disable flow cache for edge transport node. Caution: This involves restart of the edge dataplane and hence may lead to network disruption.	POST /api/v1/transport-nodes/<transport-node-id>?action=disable_flow_cache
Update a Transport Node Modifies the transport node information. The host_switch_name field must match the host_switch_name value specified in the transport zone (API: transport-zones). You must create the associated uplink profile (API: host-switch-profiles) before you can specify an uplink_name here. If the host is an ESX and has only one physical NIC being used by a vSphere standard switch, TransportNodeUpdateParameters should be used to migrate the management interface and the physical NIC into a logical switch that is in a transport zone this transport node will join or has already joined. If the migration is already done, TransportNodeUpdateParameters can also be used to migrate the management interface and the physical NIC back to a vSphere standard switch. In other cases, the TransportNodeUpdateParameters should NOT be used. When updating transport node you should follow pattern where you should fetch the existing transport node and then only modify the required properties keeping other properties as is. It also modifies attributes of node (host or edge). Note: Previous versions of NSX-T also used a property named transport_zone_endpoints at TransportNode level. This property is deprecated which creates some combinations of new client along with old client payloads. Examples [1] shows old/existing client request and response by populating transport_zone_endpoints property at TransportNode level. Example [2] shows TransportNode updating TransportNode from exmaple [1] request/response by adding a new StandardHostSwitch by populating transport_zone_endpoints at StandardHostSwitch level. TransportNode level transport_zone_endpoints will ONLY have TransportZoneEndpoints that were originally specified here during create/update operation and does not include TransportZoneEndpoints that were directly specified at StandardHostSwitch level.	PUT /api/v1/transport-nodes/<transport-node-id>
Return the list of capabilities of transport node Returns information about capabilities of transport host node. Edge nodes do not have capabilities.	GET /api/v1/transport-nodes/<transport-node-id>/capabilities
List the specified transport node's network interfaces Returns the number of interfaces on the 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 /api/v1/transport-nodes/<transport-node-id>/network/interfaces
Read the transport node's network interface Returns detailed information about the specified 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 /api/v1/transport-nodes/<transport-node-id>/network/interfaces/<interface-id>
Read the NSX Manager's Network Interface Statistics On the specified interface, returns the number of received (rx), transmitted (tx), and dropped packets; the number of bytes and errors received and transmitted on the interface; and the number of detected collisions.	GET /api/v1/transport-nodes/<transport-node-id>/network/interfaces/<interface-id>/stats
Get a Transport Node's State Returns information about the current state of the transport node configuration and information about the associated hostswitch.	GET /api/v1/transport-nodes/<transport-node-id>/state
Resync a Transport Node Resync the TransportNode configuration on a host. It is similar to updating the TransportNode with existing configuration, but force synce these configurations to the host (no backend optimizations).	POST /api/v1/transport-nodes/<transportnode-id>?action=resync_host_config
Update transport node maintenance mode Put transport node into maintenance mode or exit from maintenance mode.	POST /api/v1/transport-nodes/<transportnode-id>
List transport nodes by realized state Returns a list of transport node states that have realized state as provided as query parameter	GET /api/v1/transport-nodes/state
Get high-level summary of all transport nodes. The service layer does not support source = realtime or cached.	GET /api/v1/transport-nodes/status
Read status of transport nodes in a transport zone	GET /api/v1/transport-zones/<zone-id>/transport-node-status
Creates a status report of transport nodes in a transport zone You must provide the request header "Accept:application/octet-stream" when calling this API.	GET /api/v1/transport-zones/<zone-id>/transport-node-status-report
Read status of all the transport nodes	GET /api/v1/transport-zones/transport-node-status
Creates a status report of transport nodes of all the transport zones You must provide the request header "Accept:application/octet-stream" when calling this API.	GET /api/v1/transport-zones/transport-node-status-report

System Administration > Configuration > Fabric > Nodes

Associated URIs:

Return the List of Discovered Nodes

Return Discovered Node Information

Apply cluster level config on Discovered Node

(Deprecated) Prepares discovered Node for NSX

Created Transport Node for Discovered Node

Return the List of Nodes

Register and Install NSX Components on a Node

Delete a Node

Return Node Information

Perform an Action on Fabric Node

Perform a service deployment upgrade on a host node

Restart the inventory sync for the node if it is paused currently.

Update a Node

Return the List of Capabilities of a Single Node

Get the module details of a Fabric Node This api is deprecated, use Transport Node API GET /transport-nodes/<transportnode-id>/modules to get fabric node modules.

List the specified node's Network Interfaces

Read the node's Network Interface

Get the Realized State of a Fabric Node.

Return Runtime Status Information for a Node

Invoke DELETE request on target fabric node

Invoke GET request on target fabric node

Invoke POST request on target fabric node

Invoke PUT request on target fabric node

Return Runtime Status Information for given Nodes

Return list of supported host OS types

Return the list of physical servers

Return a specific physical server

List LLDP Neighbor Properties of Fabric Node

Read LLDP Neighbor Properties of Fabric Node by Interface Name

List LLDP Neighbor Properties of Transport Node

Read LLDP Neighbor Properties of Transport Node by Interface Name

List Transport Node collections

Create transport node collection by attaching Transport Node Profile to cluster.

Detach transport node profile from compute collection.

Get Transport Node collection by id

Update Transport Node collection

Get Transport Node collection application state

List Transport Nodes

Create a Transport Node

Get the module details of a transport node

Get high-level summary of a transport node

Read status of all transport nodes with tunnel connections to transport node

Read status of a transport node

List of tunnels

Tunnel properties

Invoke DELETE request on target transport node

Invoke GET request on target transport node

Invoke POST request on target transport node

Invoke PUT request on target transport node

Delete a Transport Node

Get a Transport Node

Apply cluster level Transport Node Profile on overridden host

Refresh the node configuration for the Edge node.

Restart the inventory sync for the node if it is paused currently.

Enable flow cache for an edge transport node

Disable flow cache for an edge transport node

Update a Transport Node

Return the list of capabilities of transport node

List the specified transport node's network interfaces

Read the transport node's network interface

Read the NSX Manager's Network Interface Statistics

Get a Transport Node's State

Resync a Transport Node

Update transport node maintenance mode

List transport nodes by realized state

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

Read status of transport nodes in a transport zone

Creates a status report of transport nodes in a transport zone

Read status of all the transport nodes

Creates a status report of transport nodes of all the transport zones