Return the List of Nodes (Deprecated)

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.

Request:

Method:

GET

URI Path(s):

/api/v1/fabric/nodes

Request Headers:

n/a

Query Parameters:

NodeListRequestParameters+

NodeListRequestParameters (schema)

Name	Description	Type	Notes
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string
discovered_node_id	Id of the discovered node which was converted to create this node	string
display_name	HostNode display name	string
external_id	HostNode external id	string
hardware_id	Hardware Id of the host HardwareId of the host is used to get fabric node on reboot.	string
hypervisor_os_type	HostNode's Hypervisor type, for example ESXi, RHEL KVM or UBUNTU KVM.	string	Enum: ESXI, RHELKVM, UBUNTUKVM, HYPERV, RHELCONTAINER, CENTOSCONTAINER, RHELSERVER, WINDOWSSERVER, UBUNTUSERVER, CENTOSSERVER, CENTOSKVM, SLESKVM, SLESSERVER
included_fields	Comma separated list of fields that should be included in query result	string
ip_address	Management IP address of the node	string
page_size	Maximum number of results to return in this page (server may return fewer)	integer	Minimum: 0 Maximum: 1000 Default: "1000"
resource_type	Node type from 'HostNode', 'EdgeNode', 'PublicCloudGatewayNode'	string	Enum: HostNode, EdgeNode, PublicCloudGatewayNode
sort_ascending		boolean
sort_by	Field by which records are sorted	string

Request Body:

n/a

Example Request:

GET https://<nsx-mgr>/api/v1/fabric/nodes

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

NodeListResult+

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	Node list results	array of Node (Abstract type: pass one of the following concrete types) EdgeNode HostNode Node PublicCloudGatewayNode	Required
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

Example Response:

{ "result_count": 2, "results": [ { "resource_type": "HostNode", "id": "74730a28-e52d-11e5-936e-6f061d405a28", "display_name": "comp-01b", "fqdn": "comp-01b.eng.abc.com", "ip_addresses": [ "192.168.210.53" ], "discovered_ip_addresses": [ "192.168.210.53" ], "external_id": "74730a28-e52d-11e5-936e-6f061d405a28", "os_type": "ESXI", "os_version": "6.0.0", "managed_by_server": "192.168.110.24", "_last_modified_time": 1457470683936, "_create_time": 1457470683936, "_last_modified_user": "admin", "_create_user": "admin", "_revision": 0 }, { "resource_type": "EdgeNode", "id": "53b55e00-e5c1-11e5-a549-005056b18ef8", "display_name": "nsx-edge2", "fqdn": "nsx-edge2.eng.abc.com", "ip_addresses": [ "192.168.110.37" ], "discovered_ip_addresses": [ "192.168.110.37" ], "external_id": "53b55e00-e5c1-11e5-a549-005056b18ef8", "deployment_type": "VIRTUAL_MACHINE", "_last_modified_time": 1457505420494, "_create_time": 1457505420494, "_last_modified_user": "admin", "_system_owned": false, "_create_user": "admin", "_revision": 0 } ] }

Return the List of Nodes (Deprecated)

Request:

NodeListRequestParameters (schema)

Example Request:

Successful Response:

NodeListResult (schema)

Example Response:

Required Permissions:

Feature:

Additional Errors: