org.freedesktop.NetworkManager.Device: NetworkManager Reference Manual

org.freedesktop.NetworkManager.Device

Methods

Reapply              (IN  a{sa{sv}} connection,
                      IN  t         version_id,
                      IN  u         flags);
GetAppliedConnection (IN  u         flags,
                      OUT a{sa{sv}} connection,
                      OUT t         version_id);
Disconnect           ();
Delete               ();

Signals

StateChanged (u new_state,
              u old_state,
              u reason);

Properties

Udi                   readable   s
Interface             readable   s
IpInterface           readable   s
Driver                readable   s
DriverVersion         readable   s
FirmwareVersion       readable   s
Capabilities          readable   u
Ip4Address            readable   u
State                 readable   u
StateReason           readable   (uu)
ActiveConnection      readable   o
Ip4Config             readable   o
Dhcp4Config           readable   o
Ip6Config             readable   o
Dhcp6Config           readable   o
Managed               readwrite  b
Autoconnect           readwrite  b
FirmwareMissing       readable   b
NmPluginMissing       readable   b
DeviceType            readable   u
AvailableConnections  readable   ao
PhysicalPortId        readable   s
Mtu                   readable   u
Metered               readable   u
LldpNeighbors         readable   aa{sv}
Real                  readable   b

Description

Method Details

The Reapply() method

Reapply (IN  a{sa{sv}} connection,
         IN  t         version_id,
         IN  u         flags);

Attempts to update the configuration of a device without deactivating it. NetworkManager has the concept of connections, which are profiles that contain the configuration for a networking device. Those connections are exposed via D-Bus as individual objects that can be created, modified and deleted. When activating such a settings-connection on a device, the settings-connection is cloned to become an applied-connection and used to configure the device (see GetAppliedConnection). Subsequent modification of the settings-connection don't propagate automatically to the device's applied-connection (with exception of the firewall-zone and the metered property). For the changes to take effect, you can either re-activate the settings-connection, or call Reapply. The Reapply call allows you to directly update the applied-connection and reconfigure the device. Reapply can also be useful if the currently applied-connection is equal to the connection that is about to be reapplied. This allows to reconfigure the device and revert external changes like removing or adding an IP address (which NetworkManager doesn't revert automatically because it is assumed that the user made these changes intentionally outside of NetworkManager). Reapply can make the applied-connection different from the settings-connection, just like updating the settings-connection can make them different.

`IN a{sa{sv}} connection`:	The optional connection settings that will be reapplied on the device. If empty, the currently active settings-connection will be used. The connection cannot arbitrarly differ from the current applied-connection otherwise the call will fail. Only certain changes are supported, like adding or removing IP addresses.
`IN t version_id`:	If non-zero, the current version id of the applied-connection must match. The current version id can be retrieved via GetAppliedConnection. This optional argument allows to catch concurrent modifications between the GetAppliedConnection call and Reapply.
`IN u flags`:	Flags which would modify the behavior of the Reapply call. There are no flags defined currently and the users should use the value of 0.

The GetAppliedConnection() method

GetAppliedConnection (IN  u         flags,
                      OUT a{sa{sv}} connection,
                      OUT t         version_id);

Get the currently applied connection on the device. This is a snapshot of the last activated connection on the device, that is the configuration that is currently applied on the device. Usually this is the same as GetSettings of the referenced settings connection. However, it can differ if the settings connection was subsequently modified or the applied connection was modified by Reapply. The applied connection is set when activating a device or when calling Reapply.

`IN u flags`:	Flags which would modify the behavior of the GetAppliedConnection call. There are no flags defined currently and the users should use the value of 0.
`OUT a{sa{sv}} connection`:	The effective connection settings that the connection has currently applied.
`OUT t version_id`:	The version-id of the currently applied connection. This can be specified during Reapply to avoid races where you first fetch the applied connection, modify it and try to reapply it. If the applied connection is modified in the meantime, the version_id gets incremented and Reapply will fail.

The Disconnect() method

Disconnect ();

Disconnects a device and prevents the device from automatically activating further connections without user intervention.

The Delete() method

Delete ();

Deletes a software device from NetworkManager and removes the interface from the system. The method returns an error when called for a hardware device.

Signal Details

The "StateChanged" signal

StateChanged (u new_state,
              u old_state,
              u reason);

`u new_state`:	(NMDeviceState) The new state of the device.
`u old_state`:	(NMDeviceState) The previous state of the device.
`u reason`:	(NMDeviceStateReason) A reason for the state transition.

Property Details

The "Udi" property

Udi  readable   s

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.

The "Interface" property

Interface  readable   s

The name of the device's control (and often data) interface.

The "IpInterface" property

IpInterface  readable   s

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.

The "Driver" property

Driver  readable   s

The driver handling the device.

The "DriverVersion" property

DriverVersion  readable   s

The version of the driver handling the device.

The "FirmwareVersion" property

FirmwareVersion  readable   s

The firmware version for the device.

The "Capabilities" property

Capabilities  readable   u

Flags describing the capabilities of the device.

Returns: NMDeviceCapabilities

The "Ip4Address" property

Ip4Address  readable   u

DEPRECATED; use the 'Addresses' property of the 'Ip4Config' object instead.

The "State" property

State  readable   u

The current state of the device.

Returns: NMDeviceState

The "StateReason" property

StateReason  readable   (uu)

The current state and reason for changing to that state.

Returns: A tuple of NMDeviceState and NMDeviceStateReason.

The "ActiveConnection" property

ActiveConnection  readable   o

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.

The "Ip4Config" property

Ip4Config  readable   o

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.

The "Dhcp4Config" property

Dhcp4Config  readable   o

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.

The "Ip6Config" property

Ip6Config  readable   o

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.

The "Dhcp6Config" property

Dhcp6Config  readable   o

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.

The "Managed" property

Managed  readwrite  b

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.

The "Autoconnect" property

Autoconnect  readwrite  b

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.

The "FirmwareMissing" property

FirmwareMissing  readable   b

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

The "NmPluginMissing" property

NmPluginMissing  readable   b

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

The "DeviceType" property

DeviceType  readable   u

The general type of the network device; ie Ethernet, WiFi, etc.

Returns: NMDeviceType

The "AvailableConnections" property

AvailableConnections  readable   ao

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

The "PhysicalPortId" property

PhysicalPortId  readable   s

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.

The "Mtu" property

Mtu  readable   u

The device MTU (maximum transmission unit).

The "Metered" property

Metered  readable   u

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

Returns: NMMetered

The "LldpNeighbors" property

LldpNeighbors  readable   aa{sv}

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

The "Real" property

Real  readable   b

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.