NetworkManager::Device Class

This class represents a common device interface. More...

• Header: #include <NetworkManagerQt/Device>
• CMake: find_package(KF6 REQUIRED COMPONENTS NetworkManagerQt)
target_link_libraries(mytarget PRIVATE KF6::NetworkManagerQt)
• Inherits: QObject
• Inherited By: NetworkManager::AdslDevice, NetworkManager::BondDevice, NetworkManager::BridgeDevice, NetworkManager::GenericDevice, NetworkManager::GreDevice, NetworkManager::InfinibandDevice, NetworkManager::IpTunnelDevice, NetworkManager::MacVlanDevice, NetworkManager::ModemDevice, NetworkManager::OlpcMeshDevice, NetworkManager::TeamDevice, NetworkManager::TunDevice, NetworkManager::VethDevice, NetworkManager::VlanDevice, NetworkManager::WifiP2PDevice, NetworkManager::WimaxDevice, NetworkManager::WiredDevice, NetworkManager::WireGuardDevice, and NetworkManager::WirelessDevice

List of all members, including inherited members
Deprecated members

#Public Types

• enum Device::Capability
• enum Device::Interfaceflag
• Device::List
• enum Device::MeteredStatus
• Device::Ptr
• enum Device::State
• enum Device::StateChangeReason
• enum Device::Type

#Properties

• [read-only] InterfaceFlags : Interfaceflags
• autoconnect : bool
• [read-only] deviceStatistics : NetworkManager::DeviceStatistics::Ptr
• [read-only] driver : QString
• [read-only] driverVersion : QString
• [read-only] firmwareMissing : bool
• [read-only] firmwareVersion : QString
• [read-only] genericCapabilities : QVariant
• [read-only] interfaceName : QString
• [read-only] ipInterfaceName : QString
• [read-only] ipV4Address : QHostAddress
• managed : bool
• [read-only] metered : MeteredStatus
• [read-only] mtu : uint
• [read-only] nmPluginMissing : bool
• [read-only] state : State
• [read-only] stateReason : DeviceStateReason
• [read-only] udi : QString
• [read-only] uni : QString

#Public Functions

• Device(const QString &path, QObject *parent = nullptr)
• ~Device()
• NetworkManager::ActiveConnection::Ptr activeConnection() const
• template <typename DevIface> DevIface *as()
• template <typename DevIface> const DevIface *as() const
• bool autoconnect() const
• Connection::List availableConnections()
• NetworkManager::Device::Capabilities capabilities() const
• QVariant capabilitiesV() const
• QDBusPendingReply<> deleteInterface()
• int designSpeed() const
• DeviceStatistics::Ptr deviceStatistics() const
• Dhcp4Config::Ptr dhcp4Config() const
• Dhcp6Config::Ptr dhcp6Config() const
• QDBusPendingReply<> disconnectInterface()
• QString driver() const
• QString driverVersion() const
• bool firmwareMissing() const
• QString firmwareVersion() const
• NetworkManager::Device::Interfaceflags interfaceFlags() const
• QString interfaceName() const
• QString ipInterfaceName() const
• NetworkManager::IpConfig ipV4Config() const
• NetworkManager::IpConfig ipV6Config() const
• bool isActive() const
• bool isValid() const
• bool managed() const
• NetworkManager::Device::MeteredStatus metered() const
• uint mtu() const
• bool nmPluginMissing() const
• QString physicalPortId() const
• QDBusPendingReply<> reapplyConnection(const NMVariantMapMap &connection, qulonglong version_id, uint flags)
• void setAutoconnect(bool autoconnect)
• void setManaged(bool managed) (since 6.18.0)
• NetworkManager::Device::State state() const
• NetworkManager::DeviceStateReason stateReason() const
• NetworkManager::Device::Type type() const
• QString udi() const
• QString uni() const

#Signals

• void activeConnectionChanged()
• void autoconnectChanged()
• void availableConnectionAppeared(const QString &connection)
• void availableConnectionChanged()
• void availableConnectionDisappeared(const QString &connection)
• void capabilitiesChanged()
• void connectionStateChanged()
• void dhcp4ConfigChanged()
• void dhcp6ConfigChanged()
• void driverChanged()
• void driverVersionChanged()
• void firmwareMissingChanged()
• void firmwareVersionChanged()
• void interfaceFlagsChanged()
• void interfaceNameChanged()
• void ipInterfaceChanged()
• void ipV4AddressChanged()
• void ipV4ConfigChanged()
• void ipV6ConfigChanged()
• void managedChanged()
• void meteredChanged(NetworkManager::Device::MeteredStatus metered)
• void mtuChanged()
• void nmPluginMissingChanged(bool nmPluginMissing)
• void physicalPortIdChanged()
• void stateChanged(NetworkManager::Device::State newstate, NetworkManager::Device::State oldstate, NetworkManager::Device::StateChangeReason reason)
• void stateReasonChanged()
• void udiChanged()

#Detailed Description

#Member Type Documentation

#enum Device::Capability

flags Device::Capabilities

Possible device capabilities

The Capabilities type is a typedef for QFlags<Capability>. It stores an OR combination of Capability values.

#enum Device::Interfaceflag

flags Device::Interfaceflags

Possible device interfaceflags

The Interfaceflags type is a typedef for QFlags<Interfaceflag>. It stores an OR combination of Interfaceflag values.

#Device::List

#enum Device::MeteredStatus

#Device::Ptr

#enum Device::State

Device connection states describe the possible states of a network connection from the user's point of view. For simplicity, states from several different layers are present - this is a high level view

#enum Device::StateChangeReason

Enums describing the reason for a connection state change

Note: StateChangeReasons NewActivation, ParentChanged, ParentManagedChanged are available in runtime NM >= 1.0.4

#enum Device::Type

flags Device::Types

Device type

The Types type is a typedef for QFlags<Type>. It stores an OR combination of Type values.

#Property Documentation

#[read-only] InterfaceFlags : Interfaceflags

Access functions:

• NetworkManager::Device::Interfaceflags interfaceFlags() const

#autoconnect : bool

Access functions:

• bool autoconnect() const
• void setAutoconnect(bool autoconnect)

#[read-only] deviceStatistics : NetworkManager::DeviceStatistics::Ptr

Access functions:

• DeviceStatistics::Ptr deviceStatistics() const

#[read-only] driver : QString

Access functions:

• QString driver() const

#[read-only] driverVersion : QString

Access functions:

• QString driverVersion() const

#[read-only] firmwareMissing : bool

Access functions:

• bool firmwareMissing() const

#[read-only] firmwareVersion : QString

Access functions:

• QString firmwareVersion() const

#[read-only] genericCapabilities : QVariant

Access functions:

• QVariant capabilitiesV() const

#[read-only] interfaceName : QString

Access functions:

• QString interfaceName() const

#[read-only] ipInterfaceName : QString

Access functions:

• QString ipInterfaceName() const

#[read-only] ipV4Address : QHostAddress

#managed : bool

Access functions:

• bool managed() const
• void setManaged(bool managed)

#[read-only] metered : MeteredStatus

Access functions:

• NetworkManager::Device::MeteredStatus metered() const

#[read-only] mtu : uint

Access functions:

• uint mtu() const

#[read-only] nmPluginMissing : bool

Access functions:

• bool nmPluginMissing() const

#[read-only] state : State

Access functions:

• NetworkManager::Device::State state() const

#[read-only] stateReason : DeviceStateReason

Access functions:

• NetworkManager::DeviceStateReason stateReason() const

#[read-only] udi : QString

Access functions:

• QString udi() const

#[read-only] uni : QString

Access functions:

• QString uni() const

#Member Function Documentation

#[explicit] Device::Device(const QString &path, QObject *parent = nullptr)

Creates a new device object.

path UNI of the device

#[override virtual noexcept] Device::~Device()

Destroys a device object.

#NetworkManager::ActiveConnection::Ptr Device::activeConnection() const

The current active connection for this device

Returns A valid ActiveConnection object or NULL if no active connection was found

#[signal] void Device::activeConnectionChanged()

Emitted when the autoconnect of this network has changed.

#template <typename DevIface> DevIface *Device::as()

Retrieves a specialized interface to interact with the device corresponding to a given device interface.

Returns a pointer to the device interface if it exists, 0 otherwise

#template <typename DevIface> const DevIface *Device::as() const

Retrieves a specialized interface to interact with the device corresponding to a given device interface.

Returns a pointer to the device interface if it exists, 0 otherwise

#bool Device::autoconnect() const

If the device is allowed to autoconnect.

Note: Getter function for property autoconnect.

See also setAutoconnect()

#[signal] void Device::autoconnectChanged()

Emitted when the autoconnect of this network has changed.

#[signal] void Device::availableConnectionAppeared(const QString &connection)

Emitted when a new connection is available

#[signal] void Device::availableConnectionChanged()

Emitted when the list of avaiable connections of this network has changed.

#[signal] void Device::availableConnectionDisappeared(const QString &connection)

Emitted when the connection is no longer available

#Connection::List Device::availableConnections()

Returns available connections for this device

Returns List of availables connection

#NetworkManager::Device::Capabilities Device::capabilities() const

Retrieves the capabilities supported by this device.

Returns the capabilities of the device

#[signal] void Device::capabilitiesChanged()

Emitted when the capabilities of this network has changed.

#QVariant Device::capabilitiesV() const

Note: Getter function for property genericCapabilities.

#[signal] void Device::connectionStateChanged()

Emitted when the connection state of this network has changed.

#QDBusPendingReply<> Device::deleteInterface()

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

#int Device::designSpeed() const

Retrieves the maximum speed as reported by the device. Note that this is only a design related piece of information, and that the device might not reach this maximum.

Returns the device's maximum speed

#DeviceStatistics::Ptr Device::deviceStatistics() const

Returns Device Statistics interface

Note: Getter function for property deviceStatistics.

#Dhcp4Config::Ptr Device::dhcp4Config() const

Get the DHCP options returned by the DHCP server or a null pointer if the device is not Activated or does not use DHCP configuration.

#[signal] void Device::dhcp4ConfigChanged()

Emitted when the DHCP configuration for IPv4 of this network has changed.

#Dhcp6Config::Ptr Device::dhcp6Config() const

Get the DHCP options returned by the DHCP server or a null pointer if the device is not Activated or does not use DHCP configuration.

#[signal] void Device::dhcp6ConfigChanged()

Emitted when the DHCP configuration for IPv6 of this network has changed.

#QDBusPendingReply<> Device::disconnectInterface()

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

#QString Device::driver() const

Handle for the system driver controlling this network interface

Note: Getter function for property driver.

#[signal] void Device::driverChanged()

Emitted when the driver of this network has changed.

#QString Device::driverVersion() const

The driver version.

Note: Getter function for property driverVersion.

#[signal] void Device::driverVersionChanged()

Emitted when the driver version of this network has changed.

#bool Device::firmwareMissing() const

Is the firmware needed by the device missing?

Note: Getter function for property firmwareMissing.

#[signal] void Device::firmwareMissingChanged()

Emitted when the firmware missing state of this network has changed.

#QString Device::firmwareVersion() const

The firmware version.

Note: Getter function for property firmwareVersion.

#[signal] void Device::firmwareVersionChanged()

Emitted when the firmware version of this network has changed.

#NetworkManager::Device::Interfaceflags Device::interfaceFlags() const

The up or down flag for the device

Note: Getter function for property InterfaceFlags.

#[signal] void Device::interfaceFlagsChanged()

Emitted when the up or down state of the device

Note: will always return NM_DEVICE_INTERFACE_FLAG_NONE when runtime NM < 1.22

#QString Device::interfaceName() const

The system name for the network device

Note: Getter function for property interfaceName.

#[signal] void Device::interfaceNameChanged()

Emitted when the interface name of this network has changed.

#[signal] void Device::ipInterfaceChanged()

Emitted when the ip interface name of this network has changed.

#QString Device::ipInterfaceName() const

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: Getter function for property ipInterfaceName.

#[signal] void Device::ipV4AddressChanged()

Emitted when the IPv4 address of this network has changed.

#NetworkManager::IpConfig Device::ipV4Config() const

Get the current IPv4 configuration of this device. Only valid when device is Activated.

#[signal] void Device::ipV4ConfigChanged()

Emitted when the IPv4 configuration of this network has changed.

#NetworkManager::IpConfig Device::ipV6Config() const

Get the current IPv6 configuration of this device. Only valid when device is Activated.

#[signal] void Device::ipV6ConfigChanged()

Emitted when the IPv6 configuration of this network has changed.

#bool Device::isActive() const

Retrieves the activation status of this network interface.

Returns true if this network interface is active, false otherwise

#bool Device::isValid() const

Retrieves the device is valid.

Returns true if this device interface is valid, false otherwise

#bool Device::managed() const

Is the device currently being managed by NetworkManager?

Note: Getter function for property managed.

See also setManaged()

#[signal] void Device::managedChanged()

Emitted when the managed state of this network has changed.

#NetworkManager::Device::MeteredStatus Device::metered() const

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

Note: Getter function for property metered.

#[signal] void Device::meteredChanged(NetworkManager::Device::MeteredStatus metered)

Emitted when metered property has changed

See also metered

#uint Device::mtu() const

The device MTU (maximum transmission unit)

Note: Getter function for property mtu.

#[signal] void Device::mtuChanged()

Emitted when the maximum transmission unit has changed

#bool Device::nmPluginMissing() const

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

Note: Getter function for property nmPluginMissing.

#[signal] void Device::nmPluginMissingChanged(bool nmPluginMissing)

Emitted when NmPluginMissing property has changed

See also nmPluginMissing

#QString Device::physicalPortId() const

Returns 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.

#[signal] void Device::physicalPortIdChanged()

Emitted when the physical port ID changes.

See also physicalPortId()

#QDBusPendingReply<> Device::reapplyConnection(const NMVariantMapMap &connection, qulonglong version_id, uint flags)

Reapplies connection settings on the interface.

#void Device::setAutoconnect(bool autoconnect)

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.

Note: Setter function for property autoconnect.

See also autoconnect()

#[since 6.18.0] void Device::setManaged(bool managed)

Sets the managed flag for the device

Note: Setter function for property managed.

This function was introduced in Qt 6.18.0.

See also managed()

#NetworkManager::Device::State Device::state() const

Retrieves the current state of the device. This is a high level view of the device. It is user oriented, so actually it provides state coming from different layers.

Returns the current connection state

Note: Getter function for property state.

See also Device::State

#[signal] void Device::stateChanged(NetworkManager::Device::State newstate, NetworkManager::Device::State oldstate, NetworkManager::Device::StateChangeReason reason)

This signal is emitted when the device's link status changed.

newstate the new state of the connection

oldstate the previous state of the connection

reason the reason for the state change, if any. ReasonNone where the backend provides no reason.

See also Device::State, Device::StateChangeReason

#NetworkManager::DeviceStateReason Device::stateReason() const

The current state and reason for changing to that state.

Note: Getter function for property stateReason.

#[signal] void Device::stateReasonChanged()

Emitted when the state reason of this network has changed.

#[virtual] NetworkManager::Device::Type Device::type() const

Retrieves the interface type. This is a virtual function that will return the proper type of all sub-classes.

Returns the NetworkManager::Device::Type that corresponds to this device.

#QString Device::udi() const

Retrieves the Unique Device Identifier (UDI) of the device. This identifier is unique for each device in the system.

Note: Getter function for property udi.

#[signal] void Device::udiChanged()

Emitted when the Unique Device Identifier of this device has changed.

#QString Device::uni() const

Retrieves the Unique Network Identifier (UNI) of the device. This identifier is unique for each network and network interface in the system.

Returns the Unique Network Identifier of the current device

Note: Getter function for property uni.