NSX-T Data Center REST API

List the specified transport node's network interfaces

Returns the number of interfaces on the node and detailed
information about each interface. Interface information includes MTU,
broadcast and host IP addresses, link and admin status, MAC address, network
mask, and the IP configuration method (static or DHCP).

Request:

Method:
GET
URI Path(s):
/api/v1/transport-nodes/{transport-node-id}/network/interfaces
Request Headers:
n/a
Query Parameters:
NetworkInterfaceRequestParameters+
Request Body:
n/a

Successful Response:

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

Example Response:

{ "result_count": 6, "results": [ { "interface_id": "vmnic0", "admin_status": "UP", "link_status": "UP", "source": "cached", "mtu": 1500, "interface_alias": [ { "physical_address": "02:00:06:3e:44:bf" } ], "interface_type": "PHYSICAL", "connected_switch": "vSwitch0" }, { "interface_id": "vmnic1", "admin_status": "UP", "link_status": "UP", "source": "cached", "mtu": 1600, "interface_alias": [ { "physical_address": "02:00:06:8c:49:0a" } ], "interface_type": "PHYSICAL", "connected_switch": "nsxvswitch" }, { "interface_id": "vmnic2", "admin_status": "UP", "link_status": "DOWN", "source": "cached", "mtu": 1500, "interface_alias": [ { "physical_address": "02:00:06:89:28:d0" } ], "interface_type": "PHYSICAL", "connected_switch": "" }, { "interface_alias": [ { "physical_address": "54:9f:35:0b:d0:84", "netmask": "255.255.255.0", "ip_address": "192.168.210.53", "ip_configuration": "STATIC", "broadcast_address": "192.168.210.255" } ], "interface_id": "vmk0", "admin_status": "UP", "link_status": "UP", "source": "cached", "mtu": 1500 }, { "interface_alias": [ { "physical_address": "00:50:56:68:91:ad", "netmask": "255.255.255.0", "ip_address": "10.20.20.53", "ip_configuration": "STATIC", "broadcast_address": "10.20.20.255" } ], "interface_id": "vmk1", "admin_status": "UP", "link_status": "UP", "source": "cached", "mtu": 1500, "host_managed": true, "interface_type": "VIRTUAL", "lport_attachment_id": "" }, { "interface_alias": [ { "physical_address": "00:50:56:65:f5:fc", "netmask": "255.255.255.0", "ip_address": "192.168.250.102", "ip_configuration": "STATIC", "broadcast_address": "192.168.250.255" } ], "interface_id": "vmk2", "admin_status": "UP", "link_status": "UP", "source": "cached", "mtu": 1600, "host_managed": true, "backing_nsx_managed": true, "interface_type": "VIRTUAL", "lport_attachment_id": "1ea55bbd-0a06-42ac-9ffc-fea15a28cd7e" } ] }

Required Permissions:

read

Feature:

aggregation_service_health_monitoring

Additional Errors: