Get list of nodes across all types

Get list of nodes. If request parameter component type is specified, then
all nodes for that component will be returned. If request parameter component
version is specified, then all nodes at that version will be returned.

Request:

Method:

GET

URI Path(s):

/api/v1/upgrade/nodes

Request Headers:

n/a

Query Parameters:

NodeInfoListRequestParameters+

Name	Description	Type	Notes
component_type	Component type based on which nodes will be filtered	string
component_version	Component version based on which nodes will be filtered	string
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string
included_fields	Comma separated list of fields that should be included in query result	string
page_size	Maximum number of results to return in this page (server may return fewer)	integer	Minimum: 0 Maximum: 1000 Default: "1000"
sort_ascending		boolean
sort_by	Field by which records are sorted	string

Request Body:

n/a

Example Request:

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

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

NodeInfoListResult+

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	Paged Collection of Nodes	array of NodeInfo	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:

{ "cursor" : "00017", "sort_ascending" : true, "result_count" : 7, "results" : [ { "id" : "15a71126-189c-11e7-9c28-9bba9532666d", "display_name" : "sc-rdops-vm05-dhcp-145-9.eng.vmware.com", "type" : "HOST", "component_version" : "1.1.0.0.0.5292922" }, { "id" : "07cd4582-189c-11e7-b77f-7f1dfdccba5e", "display_name" : "sc-rdops-vm05-dhcp-158-121.eng.vmware.com", "type" : "HOST", "component_version" : "1.1.0.0.0.5292922" }, { "id" : "25c9fd3e-189c-11e7-baa0-02001ae66268", "display_name" : "utu1604template.eng.vmware.com", "type" : "HOST", "component_version" : "1.1.0.0.0.5292922" }, { "id" : "2fcfc200-189c-11e7-b5da-02001a173d3f", "display_name" : "utu1604template.eng.vmware.com", "type" : "HOST", "component_version" : "1.1.0.0.0.5292922" }, { "id" : "4321711e-189c-11e7-8b13-000c29bbd840", "display_name" : "jane-nsxedge-ob-5292886-1-DK-Edge", "type" : "EDGE", "component_version" : "1.1.0.0.0.5292904" }, { "id" : "cae0232d-f99e-4bfa-acc7-805ed62e8701", "display_name" : "jane-nsxcontroller-ob-5292886-1-DK-Edge", "type" : "CCP", "component_version" : "1.1.0.0.0.5292902" }, { "id" : "421B38AA-E390-64B9-3FFF-7AD6EBF59C40", "display_name" : "jane-nsxmanager-ob-5292886-1-DK-Edge", "type" : "MP", "component_version" : "1.1.0.0.0.5292903" } ] }

Get list of nodes across all types

Request:

NodeInfoListRequestParameters (schema)

Example Request:

Successful Response:

NodeInfoListResult (schema)

Example Response:

Required Permissions:

Feature:

Additional Errors: