List Nodes | NSX-T Data Center REST API

List Nodes

Returns information about all fabric nodes (hosts and edges).

Request

URI

GET

https://nsxmanager.your.domain/api/v1/fabric/nodes

COPY

Query Parameters

string

cursor

Optional

Opaque cursor to be used for getting next page of records (supplied by current result page)

string

discovered_node_id

Optional

Id of the discovered node which was converted to create this node

string

display_name

Optional

HostNode display name

string

external_id

Optional

HostNode external id

string

hardware_id

Optional

Hardware Id of the host

string

hypervisor_os_type

Optional

HostNode's Hypervisor type, for example ESXi, RHEL KVM or UBUNTU KVM.

Possible values are : ESXI, RHELKVM, UBUNTUKVM, HYPERV, RHELCONTAINER, RHELSERVER, UBUNTUSERVER, CENTOSSERVER, CENTOSKVM,

string

included_fields

Optional

Comma separated list of fields that should be included in query result

string

ip_address

Optional

Management IP address of the node

integer

page_size

Optional

Maximum number of results to return in this page (server may return fewer)

string

resource_type

Optional

Node type from 'HostNode', 'EdgeNode', 'PublicCloudGatewayNode'

Possible values are : HostNode, EdgeNode, PublicCloudGatewayNode,

boolean

sort_ascending

Optional

sort_ascending

string

sort_by

Optional

Field by which records are sorted

Authentication

This operation uses the following authentication methods.

BasicAuth

Responses

200

Returns NodeListResult of type(s) application/json

This response body class contains all of the following: ListResult , InlineNodeListResult1

{
    "_self": {
        "action": "string",
        "href": "string",
        "rel": "string"
    },
    "_links": [
        {
            "action": "string",
            "href": "string",
            "rel": "string"
        }
    ],
    "_schema": "string",
    "cursor": "string",
    "sort_ascending": false,
    "sort_by": "string",
    "result_count": 0,
    "results": [
        {
            "_self": {
                "action": "string",
                "href": "string",
                "rel": "string"
            },
            "_links": [
                {
                    "action": "string",
                    "href": "string",
                    "rel": "string"
                }
            ],
            "_schema": "string",
            "_revision": 0,
            "_system_owned": false,
            "display_name": "string",
            "description": "string",
            "tags": [
                {
                    "scope": "string",
                    "tag": "string"
                }
            ],
            "_create_user": "string",
            "_protection": "string",
            "_create_time": 0,
            "_last_modified_time": 0,
            "_last_modified_user": "string",
            "id": "string",
            "resource_type": "string",
            "discovered_ip_addresses": [
                "string"
            ],
            "ip_addresses": [
                "string"
            ],
            "external_id": "string",
            "fqdn": "string"
        }
    ]
}

400

Returns BadRequest of type(s) application/json