Read the transport 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/transport-nodes/{transport-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/transport-nodes/<node-id>/network/interfaces/vmk2

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
dpu_backed	Flag to indicate DPU backed interface If interface is backed by data processing unit (DPU) and state of DPU is MANAGED, then this property is true.	boolean	Readonly
dpu_id	Data processing unit ID Data processing unit ID if the interface is backed by a DPU.	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
speed	Speed Interface speed in Mbps.	number	Readonly
state	Virtual tunnel end point state This property shows the current state of virtual tunnel end point (VTEP). If not in NORMAL state, then overlay workloads using this TEP will face network outage. In those cases, check if TEP has valid IP or any other underlay connectivity issues, and enable TEP HA to failover workloads to other healthy TEPs. Note that MAINTENANCE state is triggered by user and TEP will be disabled.	string	Enum: INVALID_STATE, INIT, NORMAL, IP_WAITING, BFD_DOWN, MAINTENANCE

Example Response:

{ "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" }

Read the transport node's network interface

Request:

DataSourceParameters (schema)

Example Request:

Successful Response:

NodeInterfaceProperties (schema)

Example Response:

Required Permissions:

Feature:

Additional Errors: