Read the node's Network Interface

Returns detailed information about the specified 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/nodes/<node-id>/network/interfaces/<interface-id>

Request Headers:

n/a

Query Parameters:

DataSourceParameters+

Name	Description	Type	Notes
source	The data source, either realtime or cached. If not provided, cached data is returned.	DataSourceType

Request Body:

n/a

Example Request:

GET https://<nsx-mgr>/api/v1/cluster/nodes/<node-id>/network/interfaces/eth0

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

NodeInterfaceProperties+

NodeInterfaceProperties (schema)

Name	Description	Type	Notes
admin_status	Interface administration status	string	Enum: UP, DOWN
backing_nsx_managed	Indicates whether backing of VIRTUAL network interface is managed by NSX	boolean
connected_switch	Connected switch	string
connected_switch_type	Type of switch Type of switch associated with the interface.	string	Readonly Enum: VSS, DVS, N-VDS
device	Device name Device name.	string	Readonly
driver	Driver name Driver name.	string	Readonly
ens_capable	Interface capability for Enhanced Networking Stack	boolean
ens_enabled	Indicates whether interface is enabled for Enhanced Networking Stack	boolean
ens_interrupt_capable	Interface capability for Enhanced Networking Stack interrupt This boolean property describes if network interface is capable for Enhanced Networking Stack interrupt	boolean
ens_interrupt_enabled	Indicates whether interface is enabled for Enhanced Networking Stack interrupt This boolean property describes if network interface is enabled for Enhanced Networking Stack interrupt	boolean
host_managed	Indicates whether interface is managed by the host	boolean
interface_alias	IP Alias	array of NodeInterfaceAlias
interface_id	Interface ID	string
interface_type	Interface Type	string	Enum: PHYSICAL, VIRTUAL, BOND, TEAMING
interface_uuid	UUID of the interface	string	Readonly
key	Device key Device key.	string	Readonly
link_status	Interface administration status	string	Enum: UP, DOWN
lport_attachment_id	LPort Attachment Id assigned to VIRTUAL network interface of a node	string
mtu	Interface MTU	integer
pci	PCI device PCI device.	string	Readonly
source	Source of status data	DataSourceType

Example Response:

{ "interface_alias": [ { "physical_address": "00:50:56:b1:d5:e0", "netmask": "255.255.255.0", "ip_address": "192.168.110.31", "ip_configuration": "STATIC", "broadcast_address": "192.168.110.255" } ], "interface_id": "eth0", "admin_status": "UP", "link_status": "UP", "source": "cached", "mtu": 1500 }

Read the node's Network Interface

Request:

DataSourceParameters (schema)

Example Request:

Successful Response:

NodeInterfaceProperties (schema)

Example Response:

Required Permissions:

Feature:

Additional Errors: