NSX-T Data Center REST API

Return Discovered Node Information

Returns information about a specific discovered node.

Request:

Method:

GET

URI Path(s):

/api/v1/fabric/discovered-nodes/<node-ext-id>

Request Headers:

n/a

Query Parameters:

n/a

Request Body:

n/a

Example Request:

GET https://<nsx-mgr>/api/v1/fabric/discovered-nodes/74730a28-e52d-11e5-936e-6f061d405a28:host-91

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

DiscoveredNode+

DiscoveredNode (schema)

Name	Description	Type	Notes
_last_sync_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_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
certificate	Certificate of the discovered node	string
cm_local_id	Local Id of the discovered node in the Compute Manager	string	Required Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
external_id	External id of the discovered node, ex. a mo-ref from VC	string	Required Readonly
hardware_id	Hardware Id of the discovered node Hardware Id is generated using system hardware info. It is used to retrieve fabric node of the esx.	string	Readonly
ip_addresses	IP Addresses of the the discovered node.	array of IPAddress	Required Readonly
node_type	Discovered Node type like Host	string	Required Readonly
origin_id	Id of the compute manager from where this node was discovered	string	Required Readonly
origin_properties	Key-Value map of additional specific properties of discovered node in the Compute Manager	array of KeyValuePair	Readonly
os_type	OS type of the discovered node	string	Readonly
os_version	OS version of the discovered node	string	Readonly
parent_compute_collection	External id of the compute collection to which this node belongs	string	Readonly
resource_type	Must be set to the value DiscoveredNode	string	Required
scope	List of scopes for discovered resource Specifies list of scope of discovered resource. e.g. if VHC path is associated with principal identity, who owns the discovered resource, then scope id will be VHC path and scope type will be VHC.	array of DiscoveredResourceScope
stateless	Specifies whether host is stateless The stateless property describes whether host persists its state across reboot or not. If state persists, value is set as false otherwise true.	boolean	Readonly
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

Example Response:

{ "display_name": "192.168.210.53", "ip_addresses": ["192.168.210.53"], "external_id": "b0ba10c8-d193-11e6-bf26-cec0c932ce01:host-91", "origin_id": "b0ba10c8-d193-11e6-bf26-cec0c932ce01", "cm_local_id": "host-91", "node_type": "HostNode", "parent_compute_collection": "b0ba10c8-d193-11e6-bf26-cec0c932ce01:domain-c32", "origin_properties": [] }

Required Permissions:

read

Feature:

compute_managers_inventory

Additional Errors:

• 404 Not Found
• 301 Moved Permanently
• 307 Temporary Redirect
• 400 Bad Request
• 403 Forbidden
• 409 Conflict
• 412 Precondition Failed
• 500 Internal Server Error
• 503 Service Unavailable