Interface EthernetDeviceProperties

Hierarchy

  • DeviceProperties
    • EthernetDeviceProperties

Properties

ActiveConnection: string

Object path of an ActiveConnection object that "owns" this device during activation. The ActiveConnection object tracks the life-cycle of a connection to a specific network and implements the org.freedesktop.NetworkManager.Connection.Active D-Bus interface.

Autoconnect: boolean

If TRUE, indicates the device is allowed to autoconnect. If FALSE, manual intervention is required before the device will automatically connect to a known network, such as activating a connection using the device, or setting this property to TRUE. This property cannot be set to TRUE for default-unmanaged devices, since they never autoconnect.

AvailableConnections: string[]

An array of object paths of every configured connection that is currently 'available' through this device.

Capabilities: number

Flags describing the capabilities of the device.

Carrier: boolean

Indicates whether the physical carrier is found (e.g. whether a cable is plugged in or not).

DeviceType: DeviceType

The general type of the network device; ie Ethernet, Wi-Fi, etc.

Dhcp4Config: string

Object path of the Dhcp4Config object describing the DHCP options returned by the DHCP server. Only valid when the device is in the NM_DEVICE_STATE_ACTIVATED state.

Dhcp6Config: string

Object path of the Dhcp6Config object describing the DHCP options returned by the DHCP server. Only valid when the device is in the NM_DEVICE_STATE_ACTIVATED state.

Driver: string

The driver handling the device. Non-UTF-8 sequences are backslash escaped. Use g_strcompress() to revert.

DriverVersion: string

The version of the driver handling the device. Non-UTF-8 sequences are backslash escaped. Use g_strcompress() to revert.

FirmwareMissing: boolean

If TRUE, indicates the device is likely missing firmware necessary for its operation.

FirmwareVersion: string

The firmware version for the device. Non-UTF-8 sequences are backslash escaped. Use g_strcompress() to revert.

HwAddress: string

Active hardware address of the device.

Interface: string

The name of the device's control (and often data) interface. Note that non UTF-8 characters are backslash escaped, so the resulting name may be longer then 15 characters. Use g_strcompress() to revert the escaping.

InterfaceFlags: number

The flags of the network interface. See NMDeviceInterfaceFlags for the currently defined flags.

Ip4Address: null | string

IPv4 address of the device

Ip4Config: string

Object path of the Ip4Config object describing the configuration of the device. Only valid when the device is in the NM_DEVICE_STATE_ACTIVATED state.

Ip4Connectivity: ConnectivityState

The result of the last IPv4 connectivity check.

Ip6Config: string

Object path of the Ip6Config object describing the configuration of the device. Only valid when the device is in the NM_DEVICE_STATE_ACTIVATED state.

Ip6Connectivity: ConnectivityState

The result of the last IPv6 connectivity check.

IpInterface: string

The name of the device's data interface when available. This property may not refer to the actual data interface until the device has successfully established a data connection, indicated by the device's State becoming ACTIVATED. Note that non UTF-8 characters are backslash escaped, so the resulting name may be longer then 15 characters. Use g_strcompress() to revert the escaping.

LldpNeighbors: any[]

Array of LLDP neighborstring; each element is a dictionary mapping LLDP TLV names to variant boxed values.

Managed: boolean

Whether or not this device is managed by NetworkManager. Setting this property has a similar effect to configuring the device as unmanaged via the keyfile.unmanaged-devices setting in NetworkManager.conf. Changes to this value are not persistent and lost after NetworkManager restart.

Metered: Metered

Whether the amount of traffic flowing through the device is subject to limitations, for example set by service providers.

Mtu: number

The device MTU (maximum transmission unit).

NmPluginMissing: boolean

If TRUE, indicates the NetworkManager plugin for the device is likely missing or misconfigured.

Path: string

The path of the device as exposed by the udev property ID_PATH. Note that non-UTF-8 characters are backslash escaped. Use g_strcompress() to obtain the true (non-UTF-8) string.

PermHwAddress: string

Permanent hardware address of the device.

PhysicalPortId: string

If non-empty, an (opaque) indicator of the physical network port associated with the device. This can be used to recognize when two seemingly-separate hardware devices are actually just different virtual interfaces to the same physical port.

Real: boolean

True if the device exists, or False for placeholder devices that do not yet exist but could be automatically created by NetworkManager if one of their AvailableConnections was activated.

S390Subchannels: any[]

Array of S/390 subchannels for S/390 or z/Architecture devices.

Speed: number

Design speed of the device, in megabits/second (Mb/s).

The current state of the device.

StateReason: {
    [key: string]: DeviceStateReason;
}

The current state and reason for changing to that state. Keys are state numbers in string format; values are DeviceStateReasons

Type declaration

Udi: string

Operating-system specific transient device hardware identifier. This is an opaque string representing the underlying hardware for the device, and shouldn't be used to keep track of individual devices. For some device types (Bluetooth, Modems) it is an identifier used by the hardware service (ie bluez or ModemManager) to refer to that device, and client programs use it get additional information from those services which NM does not provide. The Udi is not guaranteed to be consistent across reboots or hotplugs of the hardware. If you're looking for a way to uniquely track each device in your application, use the object path. If you're looking for a way to track a specific piece of hardware across reboot or hotplug, use a MAC address or USB serial number. Note that non-UTF-8 characters are backslash escaped. Use g_strcompress() to obtain the true (non-UTF-8) string.

Generated using TypeDoc