System Administration > Configuration > Fabric > Nodes > Fabric Nodes

Associated URIs:

API Description API Path

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)

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