NetworkAdapterReportedProperties interface
Reported properties of a network adapter.
Properties
| adapter |
Adapter name. |
| component |
Component ID of NIC. |
| default |
Default gateway. |
| default |
Default isolation of management NIC. |
| dns |
List of DNS servers. |
| driver |
Driver version of NIC. |
| interface |
Interface description of NIC. |
| interface |
Interface speed in Mbps. |
| interface |
Current state of the interface. |
| interface |
Type of network interface. |
| ip4Address | IP address. |
| ip |
IP configuration type. |
| mac |
MAC address. |
| management |
Indicates if this is a management interface. |
| network |
The observed state of network adapter. |
| nic |
The status of NIC (up, disconnected). |
| nic |
The type of NIC (physical, virtual, management). |
| rdma |
RDMA capability of the network adapter. |
| slot | The slot attached to the NIC. |
| subnet |
Subnet mask. |
| switch |
The switch attached to the NIC, if any. |
| vlan |
VLAN identifier (0-4096). |
| wifi |
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