NSX-T Data Center REST API

Return the List of interfaces for all bare metal servers.

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

Request:

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

Example Request:

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

Successful Response:

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

Example Response:

{ "result_count": 1, "results": [ { "external_id": "5006d98a-352f-134f-df6b-33e7f8d5de65", "resource_type": "BareMetalServerInterface", "bms_external_id": "5006d98a-352f-134f-df6b-33e7f8d54444", "display_name": "Interface1", "ip_addresses": [ "172.16.20.10", "fe80::250:56ff:fe86:f2b2" ], "mac_address": "00:50:56:86:f2:b2", "source_id": "74730a28-e52d-11e5-936e-6f061d405a28" "is_mgmt_interface": "true", "state": "UP", "tags": [ { "scope": "os1", "tag": "networkInterface" } ] "_last_sync_time" : 1493291539130 } ] } # GET https://<nsx-mgr>/api/v1/fabric/baremetal-server-interfaces?external_id=5006d98a-352f-134f-df6b-33e7f8d5de65 { "result_count": 1, "results": [ { "external_id": "5006d98a-352f-134f-df6b-33e7f8d5de65", "resource_type": "BareMetalServerInterface", "bms_external_id": "5006d98a-352f-134f-df6b-33e7f8d54444", "display_name": "Interface1", "ip_addresses": [ "172.16.20.10", "fe80::250:56ff:fe86:f2b2" ], "mac_address": "00:50:56:86:f2:b2", "source_id": "74730a28-e52d-11e5-936e-6f061d405a28" "is_mgmt_interface": "true", "state": "UP", "tags": [ { "scope": "os1", "tag": "networkInterface" } ] "_last_sync_time" : 1493291539130 } ] }

Required Permissions:

read

Feature:

bare_metal_server_inventory

Additional Errors: