NodeInterfaceProperties

NodeInterfaceProperties
NodeInterfaceProperties

Node network interface properties

JSON Example
{
    "admin_status": "string",
    "backing_nsx_managed": false,
    "connected_switch": "string",
    "connected_switch_type": "string",
    "device": "string",
    "dpu_alias": "string",
    "dpu_backed": false,
    "dpu_id": "string",
    "driver": "string",
    "ens_capable": false,
    "ens_enabled": false,
    "ens_interrupt_capable": false,
    "ens_interrupt_enabled": false,
    "host_managed": false,
    "interface_alias": [
        {
            "broadcast_address": "string",
            "ip6_address": [
                "string"
            ],
            "ip_address": "string",
            "ip_configuration": "string",
            "netmask": "string",
            "physical_address": "string"
        }
    ],
    "interface_id": "string",
    "interface_type": "string",
    "interface_uuid": "string",
    "key": "string",
    "link_status": "string",
    "lport_attachment_id": "string",
    "mtu": 0,
    "pci": "string",
    "source": "string",
    "speed": "number",
    "state": "string"
}
string
admin_status
Optional

Interface administration status

Possible values are : UP, DOWN,
boolean
backing_nsx_managed
Optional

Indicates whether backing of VIRTUAL network interface is managed by NSX

string
connected_switch
Optional

Connected switch

string
connected_switch_type
Optional

Type of switch associated with the interface.

Possible values are : VSS, DVS, N-VDS,
string
device
Optional

Device name.

string
dpu_alias
Optional

Specifies the Data processing unit dpu alias(device alias) if the interface is backed by a DPU.

boolean
dpu_backed
Optional

If interface is backed by data processing unit (DPU) and state of DPU is MANAGED, then this property is true.

string
dpu_id
Optional

Data processing unit ID if the interface is backed by a DPU.

string
driver
Optional

Driver name.

boolean
ens_capable
Optional

Interface capability for Enhanced Networking Stack

boolean
ens_enabled
Optional

Indicates whether interface is enabled for Enhanced Networking Stack

boolean
ens_interrupt_capable
Optional

This boolean property describes if network interface is capable for Enhanced Networking Stack interrupt

boolean
ens_interrupt_enabled
Optional

This boolean property describes if network interface is enabled for Enhanced Networking Stack interrupt

boolean
host_managed
Optional

Indicates whether interface is managed by the host

array of NodeInterfaceAlias
interface_alias
Optional

IP Alias

string
interface_id
Optional

Interface ID

string
interface_type
Optional

Interface Type

Possible values are : PHYSICAL, VIRTUAL, BOND, TEAMING,
string
interface_uuid
Optional

UUID of the interface

string
key
Optional

Device key.

string
link_status
Optional

Interface administration status

Possible values are : UP, DOWN,
string
lport_attachment_id
Optional

LPort Attachment Id assigned to VIRTUAL network interface of a node

integer As int64 As int64
mtu
Optional

Interface MTU

string
pci
Optional

PCI device.

string
source
Optional

Source of status data

Possible values are : realtime, cached,
number
speed
Optional

Interface speed in Mbps.

string
state
Optional

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.

Possible values are : INVALID_STATE, INIT, NORMAL, IP_WAITING, BFD_DOWN, MAINTENANCE,
Property Of
Returned By