NetworkAdapter interface
Represents the networkAdapter on a device.
Properties
| adapter |
Instance ID of network adapter. NOTE: This property will not be serialized. It can only be populated by the server. |
| adapter |
Hardware position of network adapter. NOTE: This property will not be serialized. It can only be populated by the server. |
| dhcp |
Value indicating whether this adapter has DHCP enabled. |
| dns |
The list of DNS Servers of the device. NOTE: This property will not be serialized. It can only be populated by the server. |
| index | Logical index of the adapter. NOTE: This property will not be serialized. It can only be populated by the server. |
| ipv4Configuration | The IPv4 configuration of the network adapter. NOTE: This property will not be serialized. It can only be populated by the server. |
| ipv6Configuration | The IPv6 configuration of the network adapter. NOTE: This property will not be serialized. It can only be populated by the server. |
| ipv6Link |
The IPv6 local address. NOTE: This property will not be serialized. It can only be populated by the server. |
| label | Hardware label for the adapter. NOTE: This property will not be serialized. It can only be populated by the server. |
| link |
Link speed. NOTE: This property will not be serialized. It can only be populated by the server. |
| mac |
MAC address. NOTE: This property will not be serialized. It can only be populated by the server. |
| network |
Network adapter name. NOTE: This property will not be serialized. It can only be populated by the server. |
| node |
Node ID of the network adapter. NOTE: This property will not be serialized. It can only be populated by the server. |
| rdma |
Value indicating whether this adapter is RDMA capable. |
| status | Value indicating whether this adapter is valid. NOTE: This property will not be serialized. It can only be populated by the server. |
Property Details
adapterId
Instance ID of network adapter. NOTE: This property will not be serialized. It can only be populated by the server.
adapterId?: string
Property Value
string
adapterPosition
Hardware position of network adapter. NOTE: This property will not be serialized. It can only be populated by the server.
adapterPosition?: NetworkAdapterPosition
Property Value
dhcpStatus
Value indicating whether this adapter has DHCP enabled.
dhcpStatus?: string
Property Value
string
dnsServers
The list of DNS Servers of the device. NOTE: This property will not be serialized. It can only be populated by the server.
dnsServers?: string[]
Property Value
string[]
index
Logical index of the adapter. NOTE: This property will not be serialized. It can only be populated by the server.
index?: number
Property Value
number
ipv4Configuration
The IPv4 configuration of the network adapter. NOTE: This property will not be serialized. It can only be populated by the server.
ipv4Configuration?: Ipv4Config
Property Value
ipv6Configuration
The IPv6 configuration of the network adapter. NOTE: This property will not be serialized. It can only be populated by the server.
ipv6Configuration?: Ipv6Config
Property Value
ipv6LinkLocalAddress
The IPv6 local address. NOTE: This property will not be serialized. It can only be populated by the server.
ipv6LinkLocalAddress?: string
Property Value
string
label
Hardware label for the adapter. NOTE: This property will not be serialized. It can only be populated by the server.
label?: string
Property Value
string
linkSpeed
Link speed. NOTE: This property will not be serialized. It can only be populated by the server.
linkSpeed?: number
Property Value
number
macAddress
MAC address. NOTE: This property will not be serialized. It can only be populated by the server.
macAddress?: string
Property Value
string
networkAdapterName
Network adapter name. NOTE: This property will not be serialized. It can only be populated by the server.
networkAdapterName?: string
Property Value
string
nodeId
Node ID of the network adapter. NOTE: This property will not be serialized. It can only be populated by the server.
nodeId?: string
Property Value
string
rdmaStatus
Value indicating whether this adapter is RDMA capable.
rdmaStatus?: string
Property Value
string
status
Value indicating whether this adapter is valid. NOTE: This property will not be serialized. It can only be populated by the server.
status?: string
Property Value
string