List the Node's Network Interfaces

Returns the number of interfaces on the node appliance 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/cluster/<cluster-node-id>/node/network/interfaces
/api/v1/transport-nodes/<transport-node-id>/node/network/interfaces
/api/v1/node/network/interfaces

Request Headers:

n/a

Query Parameters:

n/a

Request Body:

n/a

Example Request:

GET https://<nsx-mgr>/api/v1/node/network/interfaces

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

NodeNetworkInterfacePropertiesListResult+

Name	Description	Type	Notes
_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
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	Node network interface property results	array of NodeNetworkInterfaceProperties	Required
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

Example Response:

{ "result_count": 2, "results": [ { "admin_status": "up", "interface_id": "lo", "ip_addresses": [ { "ip_address": "127.0.0.1", "netmask": "255.0.0.0" } ], "link_status": "up", "mtu": 65536, }, { "admin_status": "up", "broadcast_address": "10.160.31.255", "default_gateway": "10.160.31.253", "interface_id": "eth0", "ip_addresses": [ { "ip_address": "10.160.30.117", "netmask": "255.255.224.0" } ], "ip_configuration": "static", "link_status": "up", "mtu": 1500, "physical_address": "02:00:16:60:c7:8f" } ] }

List the Node's Network Interfaces

Request:

Example Request:

Successful Response:

NodeNetworkInterfacePropertiesListResult (schema)

Example Response:

Required Permissions:

Feature:

Additional Errors: