NSX-T Data Center REST API

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+
Request Body:
n/a

Successful Response:

Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
NodeInfoListResult+

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" } ] }

Required Permissions:

read

Feature:

utilities_upgrade

Additional Errors: