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>
Read node properties Returns information about the NSX appliance. Information includes release number, time zone, system time, kernel version, message of the day (motd), and host name.	GET /api/v1/node GET /api/v1/transport-nodes/<transport-node-id>/node GET /api/v1/cluster/<cluster-node-id>/node
Restart or shutdown node Restarts or shuts down the NSX appliance.	POST /api/v1/node?action=restart\|shutdown POST /api/v1/transport-nodes/<transport-node-id>/node?action=restart\|shutdown POST /api/v1/cluster/<cluster-node-id>/node?action=restart\|shutdown
Set the node system time Set the node system time to the given time in UTC in the RFC3339 format 'yyyy-mm-ddThh:mm:ssZ'.	POST /api/v1/node?action=set_system_time POST /api/v1/transport-nodes/<transport-node-id>/node?action=set_system_time POST /api/v1/cluster/<cluster-node-id>/node?action=set_system_time
Update node properties Modifies NSX appliance properties. Modifiable properties include the timezone, message of the day (motd), and hostname. The NSX appliance node_version, system_time, and kernel_version are read only and cannot be modified with this method.	PUT /api/v1/node PUT /api/v1/transport-nodes/<transport-node-id>/node PUT /api/v1/cluster/<cluster-node-id>/node
Read node authentication policy configuration Returns information about the currently configured authentication policies on the node.	GET /api/v1/node/aaa/auth-policy GET /api/v1/transport-nodes/<transport-node-id>/node/aaa/auth-policy GET /api/v1/cluster/<cluster-node-id>/node/aaa/auth-policy
Update node authentication policy configuration Update the currently configured authentication policy on the node. If any of api_max_auth_failures, api_failed_auth_reset_period, or api_failed_auth_lockout_period are modified, the http service is automatically restarted.	PUT /api/v1/node/aaa/auth-policy PUT /api/v1/transport-nodes/<transport-node-id>/node/aaa/auth-policy PUT /api/v1/cluster/<cluster-node-id>/node/aaa/auth-policy
Read node certificate properties	GET /api/v1/node/certificate GET /api/v1/transport-nodes/<transport-node-id>/node/certificate GET /api/v1/cluster/<cluster-node-id>/node/certificate
Read edge config diagnosis	GET /api/v1/node/diagnosis GET /api/v1/transport-nodes/<transport-node-id>/node/diagnosis GET /api/v1/cluster/<cluster-node-id>/node/diagnosis
List node files	GET /api/v1/node/file-store GET /api/v1/transport-nodes/<transport-node-id>/node/file-store GET /api/v1/cluster/<cluster-node-id>/node/file-store
Create directory in remote file server Create a directory on the remote remote server. Supports only SFTP. You must provide the remote server's SSH fingerprint. See the NSX Administration Guide for information and instructions about finding the SSH fingerprint.	POST /api/v1/node/file-store?action=create_remote_directory POST /api/v1/transport-nodes/<transport-node-id>/node/file-store?action=create_remote_directory POST /api/v1/cluster/<cluster-node-id>/node/file-store?action=create_remote_directory
Delete file	DELETE /api/v1/node/file-store/<file-name> DELETE /api/v1/transport-nodes/<transport-node-id>/node/file-store/<file-name> DELETE /api/v1/cluster/<cluster-node-id>/node/file-store/<file-name>
Read file properties	GET /api/v1/node/file-store/<file-name> GET /api/v1/transport-nodes/<transport-node-id>/node/file-store/<file-name> GET /api/v1/cluster/<cluster-node-id>/node/file-store/<file-name>
Copy a remote file to the file store Copy a remote file to the file store. If you use scp or sftp, you must provide the remote server's SSH fingerprint. See the NSX-T Administration Guide for information and instructions about finding the SSH fingerprint.	POST /api/v1/node/file-store/<file-name>?action=copy_from_remote_file POST /api/v1/transport-nodes/<transport-node-id>/node/file-store/<file-name>?action=copy_from_remote_file POST /api/v1/cluster/<cluster-node-id>/node/file-store/<file-name>?action=copy_from_remote_file
Upload a file to the file store When you issue this API, the client must specify: - HTTP header Content-Type:application/octet-stream. - Request body with the contents of the file in the filestore. In the CLI, you can view the filestore with the get files command.	POST /api/v1/node/file-store/<file-name> POST /api/v1/transport-nodes/<transport-node-id>/node/file-store/<file-name> POST /api/v1/cluster/<cluster-node-id>/node/file-store/<file-name>
Copy file in the file store to a remote file store Copy a file in the file store to a remote server. If you use scp or sftp, you must provide the remote server's SSH fingerprint. See the NSX-T Administration Guide for information and instructions about finding the SSH fingerprint.	POST /api/v1/node/file-store/<file-name>?action=copy_to_remote_file POST /api/v1/transport-nodes/<transport-node-id>/node/file-store/<file-name>?action=copy_to_remote_file POST /api/v1/cluster/<cluster-node-id>/node/file-store/<file-name>?action=copy_to_remote_file
Read file contents	GET /api/v1/node/file-store/<file-name>/data GET /api/v1/transport-nodes/<transport-node-id>/node/file-store/<file-name>/data GET /api/v1/cluster/<cluster-node-id>/node/file-store/<file-name>/data
Replace file contents	PUT /api/v1/node/file-store/<file-name>/data PUT /api/v1/transport-nodes/<transport-node-id>/node/file-store/<file-name>/data PUT /api/v1/cluster/<cluster-node-id>/node/file-store/<file-name>/data
Read file thumbprint	GET /api/v1/node/file-store/<file-name>/thumbprint GET /api/v1/transport-nodes/<transport-node-id>/node/file-store/<file-name>/thumbprint GET /api/v1/cluster/<cluster-node-id>/node/file-store/<file-name>/thumbprint
Get NSX Edge stateful flows	GET /api/v1/node/flows GET /api/v1/transport-nodes/<transport-node-id>/node/flows GET /api/v1/cluster/<cluster-node-id>/node/flows
Get NSX Edge stateful flows by interface	GET /api/v1/node/flows/interfaces/<iface-uuid> GET /api/v1/transport-nodes/<transport-node-id>/node/flows/interfaces/<iface-uuid> GET /api/v1/cluster/<cluster-node-id>/node/flows/interfaces/<iface-uuid>
Get NSX Edge stateful flows by router	GET /api/v1/node/flows/logical-routers/<uuid> GET /api/v1/transport-nodes/<transport-node-id>/node/flows/logical-routers/<uuid> GET /api/v1/cluster/<cluster-node-id>/node/flows/logical-routers/<uuid>
Logical-router diagnosis Returns information of specified logical-router configured on edge.	GET /api/v1/node/logical-routers/<logical-router-id>/diagnosis GET /api/v1/transport-nodes/<transport-node-id>/node/logical-routers/<logical-router-id>/diagnosis GET /api/v1/cluster/<cluster-node-id>/node/logical-routers/<logical-router-id>/diagnosis
Logical-routers diagnosis Returns information of all logical-routers or specified type of logical-routers configured on edge.	GET /api/v1/node/logical-routers/diagnosis GET /api/v1/transport-nodes/<transport-node-id>/node/logical-routers/diagnosis GET /api/v1/cluster/<cluster-node-id>/node/logical-routers/diagnosis
List available node logs Returns the number of log files and lists the log files that reside on the NSX virtual appliance. The list includes the filename, file size, and last-modified time in milliseconds since epoch (1 January 1970) for each log file. Knowing the last-modified time with millisecond accuracy since epoch is helpful when you are comparing two times, such as the time of a POST request and the end time on a server.	GET /api/v1/node/logs GET /api/v1/transport-nodes/<transport-node-id>/node/logs GET /api/v1/cluster/<cluster-node-id>/node/logs
Read node log properties For a single specified log file, lists the filename, file size, and last-modified time.	GET /api/v1/node/logs/<log-name> GET /api/v1/transport-nodes/<transport-node-id>/node/logs/<log-name> GET /api/v1/cluster/<cluster-node-id>/node/logs/<log-name>
Read node log contents For a single specified log file, returns the content of the log file. This method supports byte-range requests. To request just a portion of a log file, supply an HTTP Range header, e.g. "Range: bytes=-". is optional, and, if omitted, the file contents from start to the end of the file are returned.'	GET /api/v1/node/logs/<log-name>/data GET /api/v1/transport-nodes/<transport-node-id>/node/logs/<log-name>/data GET /api/v1/cluster/<cluster-node-id>/node/logs/<log-name>/data
Get Edge maintenance mode	GET /api/v1/node/maintenance-mode GET /api/v1/transport-nodes/<transport-node-id>/node/maintenance-mode GET /api/v1/cluster/<cluster-node-id>/node/maintenance-mode
Set Edge maintenance mode	PUT /api/v1/node/maintenance-mode PUT /api/v1/transport-nodes/<transport-node-id>/node/maintenance-mode PUT /api/v1/cluster/<cluster-node-id>/node/maintenance-mode
Read network configuration properties	GET /api/v1/node/network GET /api/v1/transport-nodes/<transport-node-id>/node/network GET /api/v1/cluster/<cluster-node-id>/node/network
List the Node's Network Interfaces Returns the number of interfaces on the node appliance 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/node/network/interfaces GET /api/v1/transport-nodes/<transport-node-id>/node/network/interfaces GET /api/v1/cluster/<cluster-node-id>/node/network/interfaces
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.	GET /api/v1/node/network/interfaces/<interface-id> GET /api/v1/transport-nodes/<transport-node-id>/node/network/interfaces/<interface-id> GET /api/v1/cluster/<cluster-node-id>/node/network/interfaces/<interface-id>
Update the Node's Network Interface Updates the specified interface properties. You cannot change the properties `ip_configuration`, `ip_addresses`, or `plane`. NSX Manager must have a static IP address. You must use NSX CLI to configure a controller or an edge node.	PUT /api/v1/node/network/interfaces/<interface-id> PUT /api/v1/transport-nodes/<transport-node-id>/node/network/interfaces/<interface-id> PUT /api/v1/cluster/<cluster-node-id>/node/network/interfaces/<interface-id>
Read the Node'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/node/network/interfaces/<interface-id>/stats GET /api/v1/transport-nodes/<transport-node-id>/node/network/interfaces/<interface-id>/stats GET /api/v1/cluster/<cluster-node-id>/node/network/interfaces/<interface-id>/stats
Read the Node's Name Servers Returns the list of servers that the node uses to look up IP addresses associated with given domain names.	GET /api/v1/node/network/name-servers GET /api/v1/transport-nodes/<transport-node-id>/node/network/name-servers GET /api/v1/cluster/<cluster-node-id>/node/network/name-servers
Update the Node's Name Servers Modifies the list of servers that the node uses to look up IP addresses associated with given domain names. If DHCP is configured, this method returns a 409 CONFLICT error, because DHCP manages the list of name servers.	PUT /api/v1/node/network/name-servers PUT /api/v1/transport-nodes/<transport-node-id>/node/network/name-servers PUT /api/v1/cluster/<cluster-node-id>/node/network/name-servers
List node network routes Returns detailed information about each route in the node routing table. Route information includes the route type (default, static, and so on), a unique route identifier, the route metric, the protocol from which the route was learned, the route source (which is the preferred egress interface), the route destination, and the route scope. The route scope refers to the distance to the destination network: The "host" scope leads to a destination address on the node, such as a loopback address; the "link" scope leads to a destination on the local network; and the "global" scope leads to addresses that are more than one hop away.	GET /api/v1/node/network/routes GET /api/v1/transport-nodes/<transport-node-id>/node/network/routes GET /api/v1/cluster/<cluster-node-id>/node/network/routes
Create node network route Add a route to the node routing table. For static routes, the route_type, interface_id, netmask, and destination are required parameters. For default routes, the route_type, gateway address, and interface_id are required. For blackhole routes, the route_type and destination are required. All other parameters are optional. When you add a static route, the scope and route_id are created automatically. When you add a default or blackhole route, the route_id is created automatically. The route_id is read-only, meaning that it cannot be modified. All other properties can be modified by deleting and readding the route.	POST /api/v1/node/network/routes POST /api/v1/transport-nodes/<transport-node-id>/node/network/routes POST /api/v1/cluster/<cluster-node-id>/node/network/routes
Delete node network route Delete a route from the node routing table. You can modify an existing route by deleting it and then posting the modified version of the route. To verify, remove the route ID from the URI, issue a GET request, and note the absense of the deleted route.	DELETE /api/v1/node/network/routes/<route-id> DELETE /api/v1/transport-nodes/<transport-node-id>/node/network/routes/<route-id> DELETE /api/v1/cluster/<cluster-node-id>/node/network/routes/<route-id>
Read node network route Returns detailed information about a specified route in the node routing table.	GET /api/v1/node/network/routes/<route-id> GET /api/v1/transport-nodes/<transport-node-id>/node/network/routes/<route-id> GET /api/v1/cluster/<cluster-node-id>/node/network/routes/<route-id>
Read the Node's Search Domains Returns the domain list that the node uses to complete unqualified host names. When a host name does not include a fully qualified domain name (FQDN), the NSX Management node appends the first-listed domain name to the host name before the host name is looked up. The NSX Management node continues this for each entry in the domain list until it finds a match.	GET /api/v1/node/network/search-domains GET /api/v1/transport-nodes/<transport-node-id>/node/network/search-domains GET /api/v1/cluster/<cluster-node-id>/node/network/search-domains
Update the Node's Search Domains Modifies the list of domain names that the node uses to complete unqualified host names. If DHCP is configured, this method returns a 409 CONFLICT error, because DHCP manages the list of name servers.	PUT /api/v1/node/network/search-domains PUT /api/v1/transport-nodes/<transport-node-id>/node/network/search-domains PUT /api/v1/cluster/<cluster-node-id>/node/network/search-domains
List node processes Returns the number of processes and information about each process. Process information includes 1) mem_resident, which is roughly equivalent to the amount of RAM, in bytes, currently used by the process, 2) parent process ID (ppid), 3) process name, 4) process up time in milliseconds, 5) mem_used, wich is the amount of virtual memory used by the process, in bytes, 6) process start time, in milliseconds since epoch, 7) process ID (pid), 8) CPU time, both user and the system, consumed by the process in milliseconds.	GET /api/v1/node/processes GET /api/v1/transport-nodes/<transport-node-id>/node/processes GET /api/v1/cluster/<cluster-node-id>/node/processes
Read node process Returns information for a specified process ID (pid).	GET /api/v1/node/processes/<process-id> GET /api/v1/transport-nodes/<transport-node-id>/node/processes/<process-id> GET /api/v1/cluster/<cluster-node-id>/node/processes/<process-id>
List node services Returns a list of all services available on the node applicance.	GET /api/v1/node/services GET /api/v1/transport-nodes/<transport-node-id>/node/services GET /api/v1/cluster/<cluster-node-id>/node/services
Read NSX EdgeDatapath service properties	GET /api/v1/node/services/dataplane GET /api/v1/transport-nodes/<transport-node-id>/node/services/dataplane GET /api/v1/cluster/<cluster-node-id>/node/services/dataplane
Restart, start or stop the NSX EdgeDatapath service	POST /api/v1/node/services/dataplane?action=restart\|start\|stop POST /api/v1/transport-nodes/<transport-node-id>/node/services/dataplane?action=restart\|start\|stop POST /api/v1/cluster/<cluster-node-id>/node/services/dataplane?action=restart\|start\|stop
Get NSX Edge dataplane cpu stats	GET /api/v1/node/services/dataplane/cpu-stats GET /api/v1/transport-nodes/<transport-node-id>/node/services/dataplane/cpu-stats GET /api/v1/cluster/<cluster-node-id>/node/services/dataplane/cpu-stats
Update NSX Edge dataplane control packets prioritization setting Enable or disable NSX Edge dataplane control packets prioritization. Dataplane service must be restarted for the change to take effect.	PUT /api/v1/node/services/dataplane/ctrl-prio PUT /api/v1/transport-nodes/<transport-node-id>/node/services/dataplane/ctrl-prio PUT /api/v1/cluster/<cluster-node-id>/node/services/dataplane/ctrl-prio
Get NSX Edge dataplane flow cache setting	GET /api/v1/node/services/dataplane/flow-cache GET /api/v1/transport-nodes/<transport-node-id>/node/services/dataplane/flow-cache GET /api/v1/cluster/<cluster-node-id>/node/services/dataplane/flow-cache
Update NSX Edge dataplane flow cache setting Enable or disable NSX Edge dataplane flow cache. Dataplane service must be restarted for the change to take effect.	PUT /api/v1/node/services/dataplane/flow-cache PUT /api/v1/transport-nodes/<transport-node-id>/node/services/dataplane/flow-cache PUT /api/v1/cluster/<cluster-node-id>/node/services/dataplane/flow-cache
Return top 10 flows information Run flow monitor for timeout seconds for all or certain CPU core(s) and return top 10 flows.	GET /api/v1/node/services/dataplane/flow-mon GET /api/v1/transport-nodes/<transport-node-id>/node/services/dataplane/flow-mon GET /api/v1/cluster/<cluster-node-id>/node/services/dataplane/flow-mon
Start NSX Edge dataplane flow monitor Starts NSX Edge dataplane flow monitor on all or certain CPU core(s) with a timeout. Stops flow monitor after timeout and dumps the flow file on local file store on edge. If top_10 argument is set to true top 10 flows are collected, else all flows are collected.	PUT /api/v1/node/services/dataplane/flow-mon PUT /api/v1/transport-nodes/<transport-node-id>/node/services/dataplane/flow-mon PUT /api/v1/cluster/<cluster-node-id>/node/services/dataplane/flow-mon
Get NSX Edge dataplane firewall connections	GET /api/v1/node/services/dataplane/fw-conns GET /api/v1/transport-nodes/<transport-node-id>/node/services/dataplane/fw-conns GET /api/v1/cluster/<cluster-node-id>/node/services/dataplane/fw-conns
Get NSX Edge dataplane firewall stats	GET /api/v1/node/services/dataplane/fw-stats GET /api/v1/transport-nodes/<transport-node-id>/node/services/dataplane/fw-stats GET /api/v1/cluster/<cluster-node-id>/node/services/dataplane/fw-stats
Update NSX Edge dataplane interrupt mode setting Enable or disable NSX Edge dataplane interrupt mode. Dataplane service must be restarted for the change to take effect.	PUT /api/v1/node/services/dataplane/intr-mode PUT /api/v1/transport-nodes/<transport-node-id>/node/services/dataplane/intr-mode PUT /api/v1/cluster/<cluster-node-id>/node/services/dataplane/intr-mode
Get NSX Edge dataplane l2vpn pmtu setting	GET /api/v1/node/services/dataplane/l2vpn-pmtu GET /api/v1/transport-nodes/<transport-node-id>/node/services/dataplane/l2vpn-pmtu GET /api/v1/cluster/<cluster-node-id>/node/services/dataplane/l2vpn-pmtu
Update NSX Edge dataplane l2vpn pmtu setting Enable or disable NSX Edge dataplane pmtu cache in l2vpn.	PUT /api/v1/node/services/dataplane/l2vpn-pmtu PUT /api/v1/transport-nodes/<transport-node-id>/node/services/dataplane/l2vpn-pmtu PUT /api/v1/cluster/<cluster-node-id>/node/services/dataplane/l2vpn-pmtu
Get NSX Edge dataplane l3vpn pmtu setting	GET /api/v1/node/services/dataplane/l3vpn-pmtu GET /api/v1/transport-nodes/<transport-node-id>/node/services/dataplane/l3vpn-pmtu GET /api/v1/cluster/<cluster-node-id>/node/services/dataplane/l3vpn-pmtu
Update NSX Edge dataplane l3vpn pmtu setting Enable or disable NSX Edge dataplane pmtu cache in l3vpn.	PUT /api/v1/node/services/dataplane/l3vpn-pmtu PUT /api/v1/transport-nodes/<transport-node-id>/node/services/dataplane/l3vpn-pmtu PUT /api/v1/cluster/<cluster-node-id>/node/services/dataplane/l3vpn-pmtu
Update NSX Edge dataplane QAT feature enabled status Enable or disable NSX Edge dataplane QAT feature. Dataplane service must be restarted for the change to take effect.	PUT /api/v1/node/services/dataplane/qat-enable PUT /api/v1/transport-nodes/<transport-node-id>/node/services/dataplane/qat-enable PUT /api/v1/cluster/<cluster-node-id>/node/services/dataplane/qat-enable
Get NSX Edge dataplane QAT setting	GET /api/v1/node/services/dataplane/qat-status GET /api/v1/transport-nodes/<transport-node-id>/node/services/dataplane/qat-status GET /api/v1/cluster/<cluster-node-id>/node/services/dataplane/qat-status
Return rx/tx ring size information	GET /api/v1/node/services/dataplane/ring-size GET /api/v1/transport-nodes/<transport-node-id>/node/services/dataplane/ring-size GET /api/v1/cluster/<cluster-node-id>/node/services/dataplane/ring-size
Set NSX Edge rx ring size for physical ports Set NSX Edge rx ring size for physical ports. Dataplane service must be restarted for the change to take effect.	PUT /api/v1/node/services/dataplane/rx-ring-size PUT /api/v1/transport-nodes/<transport-node-id>/node/services/dataplane/rx-ring-size PUT /api/v1/cluster/<cluster-node-id>/node/services/dataplane/rx-ring-size
Read NSX EdgeDatapath service status	GET /api/v1/node/services/dataplane/status GET /api/v1/transport-nodes/<transport-node-id>/node/services/dataplane/status GET /api/v1/cluster/<cluster-node-id>/node/services/dataplane/status
Set NSX Edge tx ring size for physical ports Set NSX Edge tx ring size for physical ports. Dataplane service must be restarted for the change to take effect.	PUT /api/v1/node/services/dataplane/tx-ring-size PUT /api/v1/transport-nodes/<transport-node-id>/node/services/dataplane/tx-ring-size PUT /api/v1/cluster/<cluster-node-id>/node/services/dataplane/tx-ring-size
Read NSX Edge DHCP service properties	GET /api/v1/node/services/dhcp GET /api/v1/transport-nodes/<transport-node-id>/node/services/dhcp GET /api/v1/cluster/<cluster-node-id>/node/services/dhcp
Read NSX Edge DHCP service status	GET /api/v1/node/services/dhcp/status GET /api/v1/transport-nodes/<transport-node-id>/node/services/dhcp/status GET /api/v1/cluster/<cluster-node-id>/node/services/dhcp/status
Read NSX Edge Ipsec VPN service properties Read the IPsec VPN service process properties from Edge.	GET /api/v1/node/services/ipsecvpn GET /api/v1/transport-nodes/<transport-node-id>/node/services/ipsecvpn GET /api/v1/cluster/<cluster-node-id>/node/services/ipsecvpn
Read NSX Edge Ipsec VPN service status Checks the status of iked process on the Edge. If iked process is running, returns "running", returns "stopped" otherwise.	GET /api/v1/node/services/ipsecvpn/status GET /api/v1/transport-nodes/<transport-node-id>/node/services/ipsecvpn/status GET /api/v1/cluster/<cluster-node-id>/node/services/ipsecvpn/status
Read liagent service properties	GET /api/v1/node/services/liagent GET /api/v1/transport-nodes/<transport-node-id>/node/services/liagent GET /api/v1/cluster/<cluster-node-id>/node/services/liagent
Restart, start or stop the liagent service	POST /api/v1/node/services/liagent?action=restart\|start\|stop POST /api/v1/transport-nodes/<transport-node-id>/node/services/liagent?action=restart\|start\|stop POST /api/v1/cluster/<cluster-node-id>/node/services/liagent?action=restart\|start\|stop
Read liagent service status	GET /api/v1/node/services/liagent/status GET /api/v1/transport-nodes/<transport-node-id>/node/services/liagent/status GET /api/v1/cluster/<cluster-node-id>/node/services/liagent/status
Read NSX Edge NSXA service properties	GET /api/v1/node/services/local-controller GET /api/v1/transport-nodes/<transport-node-id>/node/services/local-controller GET /api/v1/cluster/<cluster-node-id>/node/services/local-controller
Restart, start or stop the NSX EdgeNSXA service	POST /api/v1/node/services/local-controller?action=restart\|start\|stop POST /api/v1/transport-nodes/<transport-node-id>/node/services/local-controller?action=restart\|start\|stop POST /api/v1/cluster/<cluster-node-id>/node/services/local-controller?action=restart\|start\|stop
Read NSX EdgeNSXA service status	GET /api/v1/node/services/local-controller/status GET /api/v1/transport-nodes/<transport-node-id>/node/services/local-controller/status GET /api/v1/cluster/<cluster-node-id>/node/services/local-controller/status
Read NSX Nestdb service properties	GET /api/v1/node/services/nestdb GET /api/v1/transport-nodes/<transport-node-id>/node/services/nestdb GET /api/v1/cluster/<cluster-node-id>/node/services/nestdb
Restart, start or stop the NSX Nestdb service	POST /api/v1/node/services/nestdb?action=restart\|start\|stop POST /api/v1/transport-nodes/<transport-node-id>/node/services/nestdb?action=restart\|start\|stop POST /api/v1/cluster/<cluster-node-id>/node/services/nestdb?action=restart\|start\|stop
Read NSX Nestdb service status	GET /api/v1/node/services/nestdb/status GET /api/v1/transport-nodes/<transport-node-id>/node/services/nestdb/status GET /api/v1/cluster/<cluster-node-id>/node/services/nestdb/status
Read appliance management service properties	GET /api/v1/node/services/node-mgmt GET /api/v1/transport-nodes/<transport-node-id>/node/services/node-mgmt GET /api/v1/cluster/<cluster-node-id>/node/services/node-mgmt
Restart the node management service	POST /api/v1/node/services/node-mgmt?action=restart POST /api/v1/transport-nodes/<transport-node-id>/node/services/node-mgmt?action=restart POST /api/v1/cluster/<cluster-node-id>/node/services/node-mgmt?action=restart
Read appliance management service status	GET /api/v1/node/services/node-mgmt/status GET /api/v1/transport-nodes/<transport-node-id>/node/services/node-mgmt/status GET /api/v1/cluster/<cluster-node-id>/node/services/node-mgmt/status
Read NSX Platform Client service properties	GET /api/v1/node/services/nsx-platform-client GET /api/v1/transport-nodes/<transport-node-id>/node/services/nsx-platform-client GET /api/v1/cluster/<cluster-node-id>/node/services/nsx-platform-client
Restart, start or stop the NSX Platform Client service	POST /api/v1/node/services/nsx-platform-client?action=restart\|start\|stop POST /api/v1/transport-nodes/<transport-node-id>/node/services/nsx-platform-client?action=restart\|start\|stop POST /api/v1/cluster/<cluster-node-id>/node/services/nsx-platform-client?action=restart\|start\|stop
Read NSX Platform Client service status	GET /api/v1/node/services/nsx-platform-client/status GET /api/v1/transport-nodes/<transport-node-id>/node/services/nsx-platform-client/status GET /api/v1/cluster/<cluster-node-id>/node/services/nsx-platform-client/status
Read NSX upgrade Agent service properties	GET /api/v1/node/services/nsx-upgrade-agent GET /api/v1/transport-nodes/<transport-node-id>/node/services/nsx-upgrade-agent GET /api/v1/cluster/<cluster-node-id>/node/services/nsx-upgrade-agent
Restart, start or stop the NSX upgrade agent service	POST /api/v1/node/services/nsx-upgrade-agent?action=restart\|start\|stop POST /api/v1/transport-nodes/<transport-node-id>/node/services/nsx-upgrade-agent?action=restart\|start\|stop POST /api/v1/cluster/<cluster-node-id>/node/services/nsx-upgrade-agent?action=restart\|start\|stop
Read Nsx upgrade agent service status	GET /api/v1/node/services/nsx-upgrade-agent/status GET /api/v1/transport-nodes/<transport-node-id>/node/services/nsx-upgrade-agent/status GET /api/v1/cluster/<cluster-node-id>/node/services/nsx-upgrade-agent/status
Read NTP service properties	GET /api/v1/node/services/ntp GET /api/v1/transport-nodes/<transport-node-id>/node/services/ntp GET /api/v1/cluster/<cluster-node-id>/node/services/ntp
Restart, start or stop the NTP service	POST /api/v1/node/services/ntp?action=restart\|start\|stop POST /api/v1/transport-nodes/<transport-node-id>/node/services/ntp?action=restart\|start\|stop POST /api/v1/cluster/<cluster-node-id>/node/services/ntp?action=restart\|start\|stop
Update NTP service properties	PUT /api/v1/node/services/ntp PUT /api/v1/transport-nodes/<transport-node-id>/node/services/ntp PUT /api/v1/cluster/<cluster-node-id>/node/services/ntp
Read NTP service status	GET /api/v1/node/services/ntp/status GET /api/v1/transport-nodes/<transport-node-id>/node/services/ntp/status GET /api/v1/cluster/<cluster-node-id>/node/services/ntp/status
Read NSX EdgeMSR service properties	GET /api/v1/node/services/router GET /api/v1/transport-nodes/<transport-node-id>/node/services/router GET /api/v1/cluster/<cluster-node-id>/node/services/router
Read NSX EdgeMSRConfig service properties	GET /api/v1/node/services/router-config GET /api/v1/transport-nodes/<transport-node-id>/node/services/router-config GET /api/v1/cluster/<cluster-node-id>/node/services/router-config
Read NSX EdgeMSRConfig service status	GET /api/v1/node/services/router-config/status GET /api/v1/transport-nodes/<transport-node-id>/node/services/router-config/status GET /api/v1/cluster/<cluster-node-id>/node/services/router-config/status
Read NSX EdgeMSR service status	GET /api/v1/node/services/router/status GET /api/v1/transport-nodes/<transport-node-id>/node/services/router/status GET /api/v1/cluster/<cluster-node-id>/node/services/router/status
Read SNMP service properties Read SNMP service properties.	GET /api/v1/node/services/snmp GET /api/v1/transport-nodes/<transport-node-id>/node/services/snmp GET /api/v1/cluster/<cluster-node-id>/node/services/snmp
Restart, start or stop the SNMP service	POST /api/v1/node/services/snmp?action=restart\|start\|stop POST /api/v1/transport-nodes/<transport-node-id>/node/services/snmp?action=restart\|start\|stop POST /api/v1/cluster/<cluster-node-id>/node/services/snmp?action=restart\|start\|stop
Update SNMP service properties Update SNMP service properties.	PUT /api/v1/node/services/snmp PUT /api/v1/transport-nodes/<transport-node-id>/node/services/snmp PUT /api/v1/cluster/<cluster-node-id>/node/services/snmp
Read SNMP service status	GET /api/v1/node/services/snmp/status GET /api/v1/transport-nodes/<transport-node-id>/node/services/snmp/status GET /api/v1/cluster/<cluster-node-id>/node/services/snmp/status
Read SNMP V3 Engine ID	GET /api/v1/node/services/snmp/v3-engine-id GET /api/v1/transport-nodes/<transport-node-id>/node/services/snmp/v3-engine-id GET /api/v1/cluster/<cluster-node-id>/node/services/snmp/v3-engine-id
Update SNMP V3 Engine ID	PUT /api/v1/node/services/snmp/v3-engine-id PUT /api/v1/transport-nodes/<transport-node-id>/node/services/snmp/v3-engine-id PUT /api/v1/cluster/<cluster-node-id>/node/services/snmp/v3-engine-id
Read ssh service properties	GET /api/v1/node/services/ssh GET /api/v1/transport-nodes/<transport-node-id>/node/services/ssh GET /api/v1/cluster/<cluster-node-id>/node/services/ssh
Restart, start or stop the ssh service	POST /api/v1/node/services/ssh?action=start\|stop\|restart POST /api/v1/transport-nodes/<transport-node-id>/node/services/ssh?action=start\|stop\|restart POST /api/v1/cluster/<cluster-node-id>/node/services/ssh?action=start\|stop\|restart
Remove a host's fingerprint from known hosts file	POST /api/v1/node/services/ssh?action=remove_host_fingerprint POST /api/v1/transport-nodes/<transport-node-id>/node/services/ssh?action=remove_host_fingerprint POST /api/v1/cluster/<cluster-node-id>/node/services/ssh?action=remove_host_fingerprint
Update ssh service properties Update ssh service properties. If the start_on_boot property is updated to true, existing ssh sessions if any are stopped and the ssh service is restarted.	PUT /api/v1/node/services/ssh PUT /api/v1/transport-nodes/<transport-node-id>/node/services/ssh PUT /api/v1/cluster/<cluster-node-id>/node/services/ssh
Restart, start or stop the ssh service	POST /api/v1/node/services/ssh/notify_mpa?action=start\|stop\|restart POST /api/v1/transport-nodes/<transport-node-id>/node/services/ssh/notify_mpa?action=start\|stop\|restart POST /api/v1/cluster/<cluster-node-id>/node/services/ssh/notify_mpa?action=start\|stop\|restart
Read ssh service status	GET /api/v1/node/services/ssh/status GET /api/v1/transport-nodes/<transport-node-id>/node/services/ssh/status GET /api/v1/cluster/<cluster-node-id>/node/services/ssh/status
Read syslog service properties	GET /api/v1/node/services/syslog GET /api/v1/transport-nodes/<transport-node-id>/node/services/syslog GET /api/v1/cluster/<cluster-node-id>/node/services/syslog
Restart, start or stop the syslog service	POST /api/v1/node/services/syslog?action=restart\|start\|stop POST /api/v1/transport-nodes/<transport-node-id>/node/services/syslog?action=restart\|start\|stop POST /api/v1/cluster/<cluster-node-id>/node/services/syslog?action=restart\|start\|stop
Delete all node syslog exporters Removes all syslog exporter rules.	DELETE /api/v1/node/services/syslog/exporters DELETE /api/v1/transport-nodes/<transport-node-id>/node/services/syslog/exporters DELETE /api/v1/cluster/<cluster-node-id>/node/services/syslog/exporters
List node syslog exporters Returns the collection of registered syslog exporter rules, if any. The rules specify the collector IP address and port, and the protocol to use.	GET /api/v1/node/services/syslog/exporters GET /api/v1/transport-nodes/<transport-node-id>/node/services/syslog/exporters GET /api/v1/cluster/<cluster-node-id>/node/services/syslog/exporters
Verify node syslog exporter Collect iptables rules needed for all existing syslog exporters and verify if the existing iptables rules are the same. If not, remove the stale rules and add the new rules to make sure all exporters work properly.	POST /api/v1/node/services/syslog/exporters?action=verify POST /api/v1/transport-nodes/<transport-node-id>/node/services/syslog/exporters?action=verify POST /api/v1/cluster/<cluster-node-id>/node/services/syslog/exporters?action=verify
Add node syslog exporter Adds a rule for exporting syslog information to a specified server. The required parameters are the rule name (exporter_name); severity level (emerg, alert, crit, and so on); transmission protocol (TCP or UDP); and server IP address or hostname. The optional parameters are the syslog port number, which can be 1 through 65,535 (514, by default); facility level to use when logging messages to syslog (kern, user, mail, and so on); and message IDs (msgids), which identify the types of messages to export.	POST /api/v1/node/services/syslog/exporters POST /api/v1/transport-nodes/<transport-node-id>/node/services/syslog/exporters POST /api/v1/cluster/<cluster-node-id>/node/services/syslog/exporters
Delete node syslog exporter Removes a specified rule from the collection of syslog exporter rules.	DELETE /api/v1/node/services/syslog/exporters/<exporter-name> DELETE /api/v1/transport-nodes/<transport-node-id>/node/services/syslog/exporters/<exporter-name> DELETE /api/v1/cluster/<cluster-node-id>/node/services/syslog/exporters/<exporter-name>
Read node syslog exporter Returns information about a specific syslog collection point.	GET /api/v1/node/services/syslog/exporters/<exporter-name> GET /api/v1/transport-nodes/<transport-node-id>/node/services/syslog/exporters/<exporter-name> GET /api/v1/cluster/<cluster-node-id>/node/services/syslog/exporters/<exporter-name>
Read syslog service status	GET /api/v1/node/services/syslog/status GET /api/v1/transport-nodes/<transport-node-id>/node/services/syslog/status GET /api/v1/cluster/<cluster-node-id>/node/services/syslog/status
Read node status Returns information about the node appliance's file system, CPU, memory, disk usage, and uptime.	GET /api/v1/node/status GET /api/v1/transport-nodes/<transport-node-id>/node/status GET /api/v1/cluster/<cluster-node-id>/node/status
Update node status Clear node bootup status	POST /api/v1/node/status?action=clear_bootup_error POST /api/v1/transport-nodes/<transport-node-id>/node/status?action=clear_bootup_error POST /api/v1/cluster/<cluster-node-id>/node/status?action=clear_bootup_error
Read node support bundle	GET /api/v1/node/support-bundle GET /api/v1/transport-nodes/<transport-node-id>/node/support-bundle GET /api/v1/cluster/<cluster-node-id>/node/support-bundle
List appliance management tasks	GET /api/v1/node/tasks GET /api/v1/transport-nodes/<transport-node-id>/node/tasks GET /api/v1/cluster/<cluster-node-id>/node/tasks
Delete task	DELETE /api/v1/node/tasks/<task-id> DELETE /api/v1/transport-nodes/<transport-node-id>/node/tasks/<task-id> DELETE /api/v1/cluster/<cluster-node-id>/node/tasks/<task-id>
Read task properties	GET /api/v1/node/tasks/<task-id> GET /api/v1/transport-nodes/<transport-node-id>/node/tasks/<task-id> GET /api/v1/cluster/<cluster-node-id>/node/tasks/<task-id>
Cancel specified task	POST /api/v1/node/tasks/<task-id>?action=cancel POST /api/v1/transport-nodes/<transport-node-id>/node/tasks/<task-id>?action=cancel POST /api/v1/cluster/<cluster-node-id>/node/tasks/<task-id>?action=cancel
Read asynchronous task response	GET /api/v1/node/tasks/<task-id>/response GET /api/v1/transport-nodes/<transport-node-id>/node/tasks/<task-id>/response GET /api/v1/cluster/<cluster-node-id>/node/tasks/<task-id>/response
List node users Returns the list of users configued to log in to the NSX appliance.	GET /api/v1/node/users GET /api/v1/transport-nodes/<transport-node-id>/node/users GET /api/v1/cluster/<cluster-node-id>/node/users
Reset a user's own password. Requires current password Enables a user to reset their own password.	POST /api/v1/node/users?action=reset_own_password POST /api/v1/transport-nodes/<transport-node-id>/node/users?action=reset_own_password POST /api/v1/cluster/<cluster-node-id>/node/users?action=reset_own_password
Read node user Returns information about a specified user who is configued to log in to the NSX appliance. The valid user IDs are: 0, 10000, 10002.	GET /api/v1/node/users/<userid> GET /api/v1/transport-nodes/<transport-node-id>/node/users/<userid> GET /api/v1/cluster/<cluster-node-id>/node/users/<userid>
Reset a user's password without requiring their current password Unlike the PUT version of this call (PUT /node/users/), this API does not require that the current password for the user be provided. The account of the target user must be "ACTIVE" for the call to succeed. This API only supports user ID 10002.	POST /api/v1/node/users/<userid>?action=reset_password POST /api/v1/transport-nodes/<transport-node-id>/node/users/<userid>?action=reset_password POST /api/v1/cluster/<cluster-node-id>/node/users/<userid>?action=reset_password
Update node user Updates attributes of an existing NSX appliance user. This method cannot be used to add a new user. Modifiable attributes include the username, full name of the user, and password. If you specify a password in a PUT request, it is not returned in the response. Nor is it returned in a GET request. The specified password does not meet the following complexity requirements: - minimum 12 characters in length - minimum 1 uppercase character - minimum 1 lowercase character - minimum 1 numeric character - minimum 1 special character - minimum 5 unique characters - default password complexity rules as enforced by the Linux PAM module The valid user IDs are: 0, 10000, 10002. Note that invoking this API does not update any user-related properties of existing objects in the system and does not modify the username field in existing audit log entries.	PUT /api/v1/node/users/<userid> PUT /api/v1/transport-nodes/<transport-node-id>/node/users/<userid> PUT /api/v1/cluster/<cluster-node-id>/node/users/<userid>
List SSH keys from authorized_keys file for node user Returns a list of all SSH keys from authorized_keys file for node user	GET /api/v1/node/users/<userid>/ssh-keys GET /api/v1/transport-nodes/<transport-node-id>/node/users/<userid>/ssh-keys GET /api/v1/cluster/<cluster-node-id>/node/users/<userid>/ssh-keys
Remove SSH public key from authorized_keys file for node user	POST /api/v1/node/users/<userid>/ssh-keys?action=remove_ssh_key POST /api/v1/transport-nodes/<transport-node-id>/node/users/<userid>/ssh-keys?action=remove_ssh_key POST /api/v1/cluster/<cluster-node-id>/node/users/<userid>/ssh-keys?action=remove_ssh_key
Add SSH public key to authorized_keys file for node user	POST /api/v1/node/users/<userid>/ssh-keys?action=add_ssh_key POST /api/v1/transport-nodes/<transport-node-id>/node/users/<userid>/ssh-keys?action=add_ssh_key POST /api/v1/cluster/<cluster-node-id>/node/users/<userid>/ssh-keys?action=add_ssh_key
Read node version	GET /api/v1/node/version GET /api/v1/transport-nodes/<transport-node-id>/node/version GET /api/v1/cluster/<cluster-node-id>/node/version
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>
Retry the process on applying transport node profile This API is relevant for compute collection on which vLCM is enabled. This API shpuld be invoked to retry the realization of transport node profile on the compute collection. This is useful when profile realization had failed because of error in vLCM. This API has no effect if vLCM is not enabled on the computer collection.	POST /api/v1/transport-node-collections/<transport-node-collection-id>?action=retry_profile_realization
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
Redeploys a new node that replaces the specified edge node. Redeploys an edge node at NSX Manager that replaces the edge node with identifier . 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 /api/v1/transport-nodes/<node-id>?action=redeploy
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
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
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
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
Reset IPSec VPN session statistics Reset IPSec VPN session statistics	POST /api/v1/vpn/ipsec/sessions/<sessionid>/statistics?action=reset

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

Read node properties

Restart or shutdown node

Set the node system time

Update node properties

Read node authentication policy configuration

Update node authentication policy configuration

Read node certificate properties

Read edge config diagnosis

List node files

Create directory in remote file server

Delete file

Read file properties

Copy a remote file to the file store

Upload a file to the file store

Copy file in the file store to a remote file store

Read file contents

Replace file contents

Read file thumbprint

Get NSX Edge stateful flows

Get NSX Edge stateful flows by interface

Get NSX Edge stateful flows by router

Logical-router diagnosis

Logical-routers diagnosis

List available node logs

Read node log properties

Read node log contents

Get Edge maintenance mode

Set Edge maintenance mode

Read network configuration properties

List the Node's Network Interfaces

Read the Node's Network Interface

Update the Node's Network Interface

Read the Node's Network Interface Statistics

Read the Node's Name Servers

Update the Node's Name Servers

List node network routes

Create node network route

Delete node network route

Read node network route

Read the Node's Search Domains

Update the Node's Search Domains

List node processes

Read node process

List node services

Read NSX EdgeDatapath service properties

Restart, start or stop the NSX EdgeDatapath service

Get NSX Edge dataplane cpu stats