List Discovered Nodes

List Discovered Nodes

Returns information about all discovered nodes.

Request
URI
GET
https://nsxmanager.your.domain/api/v1/fabric/discovered-nodes
COPY
Query Parameters
string
cm_local_id
Optional

Local Id of the discovered node in the Compute Manager

string
cursor
Optional

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

string
display_name
Optional

Display name of discovered node

string
external_id
Optional

External id of the discovered node, ex. a mo-ref from VC

string
has_parent
Optional

Discovered node has a parent compute collection or is a standalone host

Possible values are : true, false,
string
included_fields
Optional

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

string
ip_address
Optional

IP address of the discovered node

string
node_id
Optional

Id of the fabric node created from the discovered node

string
node_type
Optional

Discovered Node type like HostNode

string
origin_id
Optional

Id of the compute manager from where this node was discovered

integer
page_size
Optional

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

string
parent_compute_collection
Optional

External id of the compute collection to which this node belongs

boolean
sort_ascending
Optional

sort_ascending

string
sort_by
Optional

Field by which records are sorted


Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns DiscoveredNodeListResult of type(s) application/json
This response body class contains all of the following: ListResult , InlineDiscoveredNodeListResult1
{
    "_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",
            "_last_sync_time": 0,
            "display_name": "string",
            "description": "string",
            "resource_type": "string",
            "tags": [
                {
                    "scope": "string",
                    "tag": "string"
                }
            ],
            "stateless": false,
            "certificate": "string",
            "origin_id": "string",
            "ip_addresses": [
                "string"
            ],
            "hardware_id": "string",
            "os_version": "string",
            "node_type": "string",
            "parent_compute_collection": "string",
            "os_type": "string",
            "origin_properties": [
                {
                    "value": "string",
                    "key": "string"
                }
            ],
            "external_id": "string",
            "cm_local_id": "string"
        }
    ]
}

400
Returns BadRequest of type(s) application/json
This response body class contains all of the following: RelatedApiError , InlineApiError1
{
    "module_name": "string",
    "error_message": "string",
    "error_code": 0,
    "details": "string",
    "related_errors": [
        {
            "module_name": "string",
            "error_message": "string",
            "error_code": 0,
            "details": "string"
        }
    ]
}

403
Returns Forbidden of type(s) application/json
This response body class contains all of the following: RelatedApiError , InlineApiError1
{
    "module_name": "string",
    "error_message": "string",
    "error_code": 0,
    "details": "string",
    "related_errors": [
        {
            "module_name": "string",
            "error_message": "string",
            "error_code": 0,
            "details": "string"
        }
    ]
}

404
Returns NotFound of type(s) application/json
This response body class contains all of the following: RelatedApiError , InlineApiError1
{
    "module_name": "string",
    "error_message": "string",
    "error_code": 0,
    "details": "string",
    "related_errors": [
        {
            "module_name": "string",
            "error_message": "string",
            "error_code": 0,
            "details": "string"
        }
    ]
}

412
Returns PreconditionFailed of type(s) application/json
This response body class contains all of the following: RelatedApiError , InlineApiError1
{
    "module_name": "string",
    "error_message": "string",
    "error_code": 0,
    "details": "string",
    "related_errors": [
        {
            "module_name": "string",
            "error_message": "string",
            "error_code": 0,
            "details": "string"
        }
    ]
}

500
Returns InternalServerError of type(s) application/json
This response body class contains all of the following: RelatedApiError , InlineApiError1
{
    "module_name": "string",
    "error_message": "string",
    "error_code": 0,
    "details": "string",
    "related_errors": [
        {
            "module_name": "string",
            "error_message": "string",
            "error_code": 0,
            "details": "string"
        }
    ]
}

503
Returns ServiceUnavailable of type(s) application/json
This response body class contains all of the following: RelatedApiError , InlineApiError1
{
    "module_name": "string",
    "error_message": "string",
    "error_code": 0,
    "details": "string",
    "related_errors": [
        {
            "module_name": "string",
            "error_message": "string",
            "error_code": 0,
            "details": "string"
        }
    ]
}