NSX-T Data Center REST API

Return the list of all bare metal servers

Returns information about all bare metal servers.
Tags will be populated only if the tags are added on the bare metal server.
Tags will not be listed in case tags are removed or are not added.

Request:

Method:
GET
URI Path(s):
/api/v1/fabric/baremetal-servers
Request Headers:
n/a
Query Parameters:
BareMetalServerListRequestParameters+
Request Body:
n/a

Example Request:

GET https://<nsx-mgr>/api/v1/fabric/baremetal-servers

Successful Response:

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

Example Response:

## For /fabric/baremetal-servers ## { "result_count" : 1, "cursor": "003653b55e00-e5c1-11e5-a549-005056b18ef8", "results" : [ { "external_id" : "74730a28-e52d-11e5-936e-6f061d405a22”, // uuid "display_name" : "BM-1", "resource_type" : "BareMetalServer", "source_id”: "74730a28-e52d-11e5-936e-6f061d405a11”, // ID of BMC "cpu_cores" : 4, "os_info" : { "os_name": "Ubuntu Linux (64-bit)", "os_version" : "20.0", }, "tags": [ { "scope": "os1", "tag": "linux86" } ], "_last_sync_time" : 1493291539130 } ] } ## For fabric/baremetal-servers?external_id=74730a28-e52d-11e5-936e-6f061d405a22 ## { "result_count": 1, "results": [ { "external_id" : "74730a28-e52d-11e5-936e-6f061d405a22”, // uuid "display_name" : "BM-1", "resource_type" : "BareMetalServer", "source_id”: "74730a28-e52d-11e5-936e-6f061d405a11”, // ID of BMC "cpu_cores" : 4, "os_info" : { "os_name": "Ubuntu Linux (64-bit)", "os_version" : "20.0", }, "tags": [ { "scope": "os1", "tag": "linux86" } ], "_last_sync_time" : 1493291539130 } ] }

Required Permissions:

read

Feature:

bare_metal_server_inventory

Additional Errors: