NetworkAdapterReportedProperties interface

Reported properties of a network adapter.

Properties

adapterName

Adapter name.

componentId

Component ID of NIC.

defaultGateway

Default gateway.

defaultIsolationId

Default isolation of management NIC.

dnsServers

List of DNS servers.

driverVersion

Driver version of NIC.

interfaceDescription

Interface description of NIC.

interfaceSpeed

Interface speed in Mbps.

interfaceState

Current state of the interface.

interfaceType

Type of network interface.

ip4Address

IP address.

ipInterfaceType

IP configuration type.

macAddress

MAC address.

managementInterface

Indicates if this is a management interface.

networkAdapterStatus

The observed state of network adapter.

nicStatus

The status of NIC (up, disconnected).

nicType

The type of NIC (physical, virtual, management).

rdmaCapability

RDMA capability of the network adapter.

slot

The slot attached to the NIC.

subnetMask

Subnet mask.

switchName

The switch attached to the NIC, if any.

vlanId

VLAN identifier (0-4096).

wifiConfiguration

WiFi configuration reported properties.

Property Details

adapterName

Adapter name.

adapterName?: string

Property Value

string

componentId

Component ID of NIC.

componentId?: string

Property Value

string

defaultGateway

Default gateway.

defaultGateway?: string

Property Value

string

defaultIsolationId

Default isolation of management NIC.

defaultIsolationId?: string

Property Value

string

dnsServers

List of DNS servers.

dnsServers?: string[]

Property Value

string[]

driverVersion

Driver version of NIC.

driverVersion?: string

Property Value

string

interfaceDescription

Interface description of NIC.

interfaceDescription?: string

Property Value

string

interfaceSpeed

Interface speed in Mbps.

interfaceSpeed?: number

Property Value

number

interfaceState

Current state of the interface.

interfaceState?: string

Property Value

string

interfaceType

Type of network interface.

interfaceType?: string

Property Value

string

ip4Address

IP address.

ip4Address?: string

Property Value

string

ipInterfaceType

IP configuration type.

ipInterfaceType?: string

Property Value

string

macAddress

MAC address.

macAddress?: string

Property Value

string

managementInterface

Indicates if this is a management interface.

managementInterface?: boolean

Property Value

boolean

networkAdapterStatus

The observed state of network adapter.

networkAdapterStatus?: NetworkAdapterStatus

Property Value

nicStatus

The status of NIC (up, disconnected).

nicStatus?: string

Property Value

string

nicType

The type of NIC (physical, virtual, management).

nicType?: string

Property Value

string

rdmaCapability

RDMA capability of the network adapter.

rdmaCapability?: string

Property Value

string

slot

The slot attached to the NIC.

slot?: string

Property Value

string

subnetMask

Subnet mask.

subnetMask?: string

Property Value

string

switchName

The switch attached to the NIC, if any.

switchName?: string

Property Value

string

vlanId

VLAN identifier (0-4096).

vlanId?: number

Property Value

number

wifiConfiguration

WiFi configuration reported properties.

wifiConfiguration?: WifiConfigurationReportedProperties

Property Value