Network Manager objects

All objects avaiable in NetworkManager.

Only the implemented interfaces for each object are documented. Click on interface link to see which properties and methods does the interface implements.

Network Manager main object

class sdbus_async.networkmanager.NetworkManager(bus=None)

Network Manager main object

Implements NetworkManagerInterfaceAsync

Service name 'org.freedesktop.NetworkManager' and object path /org/freedesktop/NetworkManager is predetermined.

Parameters:

bus (Optional[SdBus]) – You probably want to set default bus to system bus or pass system bus directly.

Network Manager settings

class sdbus_async.networkmanager.NetworkManagerSettings(bus=None)

NetworkManager settings

Implements NetworkManagerSettingsInterfaceAsync.

Service name 'org.freedesktop.NetworkManager' and object path /org/freedesktop/NetworkManager/DnsManager is predetermined.

Parameters:

bus (Optional[SdBus]) – You probably want to set default bus to system bus or pass system bus directly.

async get_connections_by_id(connection_id)

Helper method to get a list of connection profile paths which use the given connection identifier.

Parameters:

connection_id (str) – The connection identifier of the connections, e.g. “Wired connection 1”

Returns:

List of connection profile paths using the given identifier.

Return type:

List[str]

async get_settings_by_uuid(connection_uuid)

Helper to get a nested settings dict of a connection profile by uuid.

Parameters:

connection_uuid (str) – The connection uuid of the connection profile

Returns:

Nested dictionary of all settings of the given connection profile

Return type:

Dict[str, Dict[str, Tuple[str, Any]]]

async delete_connection_by_uuid(connection_uuid)

Helper to delete a connection profile identified by the connection uuid.

Parameters:

connection_uuid (str) – The connection uuid of the connection profile

Return type:

None

class sdbus_async.networkmanager.NetworkManagerDnsManager(bus=None)

NetworkManager DNS manager

Implements NetworkManagerDnsManagerInterfaceAsync.

Service name 'org.freedesktop.NetworkManager' and object path /org/freedesktop/NetworkManager/DnsManager is predetermined.

Parameters:

bus (Optional[SdBus]) – You probably want to set default bus to system bus or pass system bus directly.

class sdbus_async.networkmanager.NetworkManagerAgentManager(bus=None)

NetworkManager secrets manager

Implements NetworkManagerSecretAgentManagerInterfaceAsync.

Service name 'org.freedesktop.NetworkManager' and object path /org/freedesktop/NetworkManager/AgentManager is predetermined.

Parameters:

bus (Optional[SdBus]) – You probably want to set default bus to system bus or pass system bus directly.

class sdbus_async.networkmanager.NetworkConnectionSettings(settings_path, bus=None)

Setting of specific connection

Implements NetworkManagerSettingsConnectionInterfaceAsync

Parameters:

Device objects

class sdbus_async.networkmanager.NetworkDeviceGeneric(device_path, bus=None)

Generic device

Implements NetworkManagerDeviceInterfaceAsync, NetworkManagerDeviceStatisticsInterfaceAsync and NetworkManagerDeviceGenericInterfaceAsync

Parameters:

  • device_path (str) – D-Bus path to device object. Obtained from NetworkManagerInterface.get_devices() or NetworkManagerInterface.get_device_by_ip_iface().

  • bus (Optional[SdBus]) – You probably want to set default bus to system bus or pass system bus directly.

class sdbus_async.networkmanager.NetworkDeviceWired(device_path, bus=None)

Ethernet device

Implements NetworkManagerDeviceInterfaceAsync, NetworkManagerDeviceStatisticsInterfaceAsync and NetworkManagerDeviceWiredInterfaceAsync

Parameters:

  • device_path (str) – D-Bus path to device object. Obtained from NetworkManagerInterface.get_devices() or NetworkManagerInterface.get_device_by_ip_iface().

  • bus (Optional[SdBus]) – You probably want to set default bus to system bus or pass system bus directly.

class sdbus_async.networkmanager.NetworkDeviceWireless(device_path, bus=None)

WiFi device

Implements NetworkManagerDeviceInterfaceAsync, NetworkManagerDeviceStatisticsInterfaceAsync and NetworkManagerDeviceWirelessInterfaceAsync

Parameters:

  • device_path (str) – D-Bus path to device object. Obtained from NetworkManagerInterface.get_devices() or NetworkManagerInterface.get_device_by_ip_iface().

  • bus (Optional[SdBus]) – You probably want to set default bus to system bus or pass system bus directly.

class sdbus_async.networkmanager.NetworkDeviceBluetooth(device_path, bus=None)

Bluetooth device

Implements NetworkManagerDeviceInterfaceAsync, NetworkManagerDeviceStatisticsInterfaceAsync and NetworkManagerDeviceBluetoothInterfaceAsync

Parameters:

  • device_path (str) – D-Bus path to device object. Obtained from NetworkManagerInterface.get_devices() or NetworkManagerInterface.get_device_by_ip_iface().

  • bus (Optional[SdBus]) – You probably want to set default bus to system bus or pass system bus directly.

class sdbus_async.networkmanager.NetworkDeviceBond(device_path, bus=None)

Bond device

Implements NetworkManagerDeviceInterfaceAsync, NetworkManagerDeviceStatisticsInterfaceAsync and NetworkManagerDeviceBondInterfaceAsync

Parameters:

  • device_path (str) – D-Bus path to device object. Obtained from NetworkManagerInterface.get_devices() or NetworkManagerInterface.get_device_by_ip_iface().

  • bus (Optional[SdBus]) – You probably want to set default bus to system bus or pass system bus directly.

class sdbus_async.networkmanager.NetworkDeviceBridge(device_path, bus=None)

Bridge device

Implements NetworkManagerDeviceInterfaceAsync, NetworkManagerDeviceStatisticsInterfaceAsync and NetworkManagerDeviceBridgeInterfaceAsync

Parameters:

  • device_path (str) – D-Bus path to device object. Obtained from NetworkManagerInterface.get_devices() or NetworkManagerInterface.get_device_by_ip_iface().

  • bus (Optional[SdBus]) – You probably want to set default bus to system bus or pass system bus directly.

class sdbus_async.networkmanager.NetworkDeviceIpTunnel(device_path, bus=None)

Generic device

Implements NetworkManagerDeviceInterfaceAsync, NetworkManagerDeviceStatisticsInterfaceAsync and NetworkManagerDeviceIPTunnelInterfaceAsync

Parameters:

  • device_path (str) – D-Bus path to device object. Obtained from NetworkManagerInterface.get_devices() or NetworkManagerInterface.get_device_by_ip_iface().

  • bus (Optional[SdBus]) – You probably want to set default bus to system bus or pass system bus directly.

class sdbus_async.networkmanager.NetworkDeviceMacsec(device_path, bus=None)

Macsec device

Implements NetworkManagerDeviceInterfaceAsync, NetworkManagerDeviceStatisticsInterfaceAsync and NetworkManagerDeviceMacsecInterfaceAsync

Parameters:

  • device_path (str) – D-Bus path to device object. Obtained from NetworkManagerInterface.get_devices() or NetworkManagerInterface.get_device_by_ip_iface().

  • bus (Optional[SdBus]) – You probably want to set default bus to system bus or pass system bus directly.

class sdbus_async.networkmanager.NetworkDeviceMacvlan(device_path, bus=None)

Macvlan device

Implements NetworkManagerDeviceInterfaceAsync, NetworkManagerDeviceStatisticsInterfaceAsync and NetworkManagerDeviceMacvlanInterfaceAsync

Parameters:

  • device_path (str) – D-Bus path to device object. Obtained from NetworkManagerInterface.get_devices() or NetworkManagerInterface.get_device_by_ip_iface().

  • bus (Optional[SdBus]) – You probably want to set default bus to system bus or pass system bus directly.

class sdbus_async.networkmanager.NetworkDeviceModem(device_path, bus=None)

Generic device

Implements NetworkManagerDeviceInterfaceAsync, NetworkManagerDeviceStatisticsInterfaceAsync and NetworkManagerDeviceModemInterfaceAsync

Parameters:

  • device_path (str) – D-Bus path to device object. Obtained from NetworkManagerInterface.get_devices() or NetworkManagerInterface.get_device_by_ip_iface().

  • bus (Optional[SdBus]) – You probably want to set default bus to system bus or pass system bus directly.

class sdbus_async.networkmanager.NetworkDeviceOlpcMesh(device_path, bus=None)

OLPC wireless mesh device

Implements NetworkManagerDeviceInterfaceAsync, NetworkManagerDeviceStatisticsInterfaceAsync and NetworkManagerDeviceOlpcMeshInterfaceAsync

Parameters:

  • device_path (str) – D-Bus path to device object. Obtained from NetworkManagerInterface.get_devices() or NetworkManagerInterface.get_device_by_ip_iface().

  • bus (Optional[SdBus]) – You probably want to set default bus to system bus or pass system bus directly.

class sdbus_async.networkmanager.NetworkDeviceOpenVSwitchBridge(device_path, bus=None)

Open vSwitch bridge device

Implements NetworkManagerDeviceInterfaceAsync, NetworkManagerDeviceStatisticsInterfaceAsync and NetworkManagerDeviceOvsBridgeInterfaceAsync

Parameters:

  • device_path (str) – D-Bus path to device object. Obtained from NetworkManagerInterface.get_devices() or NetworkManagerInterface.get_device_by_ip_iface().

  • bus (Optional[SdBus]) – You probably want to set default bus to system bus or pass system bus directly.

class sdbus_async.networkmanager.NetworkDeviceOpenVSwitchPort(device_path, bus=None)

Open vSwitch port device

Implements NetworkManagerDeviceInterfaceAsync, NetworkManagerDeviceStatisticsInterfaceAsync and NetworkManagerDeviceOvsPortInterfaceAsync

Parameters:

  • device_path (str) – D-Bus path to device object. Obtained from NetworkManagerInterface.get_devices() or NetworkManagerInterface.get_device_by_ip_iface().

  • bus (Optional[SdBus]) – You probably want to set default bus to system bus or pass system bus directly.

class sdbus_async.networkmanager.NetworkDeviceTeam(device_path, bus=None)

Team device (special Bond device for NetworkManager)

Implements NetworkManagerDeviceInterfaceAsync, NetworkManagerDeviceStatisticsInterfaceAsync and NetworkManagerDeviceTeamInterfaceAsync

Parameters:

  • device_path (str) – D-Bus path to device object. Obtained from NetworkManagerInterface.get_devices() or NetworkManagerInterface.get_device_by_ip_iface().

  • bus (Optional[SdBus]) – You probably want to set default bus to system bus or pass system bus directly.

class sdbus_async.networkmanager.NetworkDeviceTun(device_path, bus=None)

TUN device

Implements NetworkManagerDeviceInterfaceAsync, NetworkManagerDeviceStatisticsInterfaceAsync and NetworkManagerDeviceTunInterfaceAsync

Parameters:

  • device_path (str) – D-Bus path to device object. Obtained from NetworkManagerInterface.get_devices() or NetworkManagerInterface.get_device_by_ip_iface().

  • bus (Optional[SdBus]) – You probably want to set default bus to system bus or pass system bus directly.

class sdbus_async.networkmanager.NetworkDeviceVeth(device_path, bus=None)

Virtual Ethernet device

Implements NetworkManagerDeviceInterfaceAsync, NetworkManagerDeviceStatisticsInterfaceAsync and NetworkManagerDeviceVethInterfaceAsync

Parameters:

  • device_path (str) – D-Bus path to device object. Obtained from NetworkManagerInterface.get_devices() or NetworkManagerInterface.get_device_by_ip_iface().

  • bus (Optional[SdBus]) – You probably want to set default bus to system bus or pass system bus directly.

class sdbus_async.networkmanager.NetworkDeviceVlan(device_path, bus=None)

VLAN device

Implements NetworkManagerDeviceInterfaceAsync, NetworkManagerDeviceStatisticsInterfaceAsync and NetworkManagerDeviceVlanInterfaceAsync

Parameters:

  • device_path (str) – D-Bus path to device object. Obtained from NetworkManagerInterface.get_devices() or NetworkManagerInterface.get_device_by_ip_iface().

  • bus (Optional[SdBus]) – You probably want to set default bus to system bus or pass system bus directly.

class sdbus_async.networkmanager.NetworkDeviceVrf(device_path, bus=None)

VRF (virtual routing) device

Implements NetworkManagerDeviceInterfaceAsync, NetworkManagerDeviceStatisticsInterfaceAsync and NetworkManagerDeviceVrfInterfaceAsync

Parameters:

  • device_path (str) – D-Bus path to device object. Obtained from NetworkManagerInterface.get_devices() or NetworkManagerInterface.get_device_by_ip_iface().

  • bus (Optional[SdBus]) – You probably want to set default bus to system bus or pass system bus directly.

class sdbus_async.networkmanager.NetworkDeviceVxlan(device_path, bus=None)

VXLAN device

Implements NetworkManagerDeviceInterfaceAsync, NetworkManagerDeviceStatisticsInterfaceAsync and NetworkManagerDeviceVxlanInterfaceAsync

Parameters:

  • device_path (str) – D-Bus path to device object. Obtained from NetworkManagerInterface.get_devices() or NetworkManagerInterface.get_device_by_ip_iface().

  • bus (Optional[SdBus]) – You probably want to set default bus to system bus or pass system bus directly.

class sdbus_async.networkmanager.NetworkDeviceWifiP2P(device_path, bus=None)

Wifi Peer-to-Peer (P2P) device

Implements NetworkManagerDeviceInterfaceAsync, NetworkManagerDeviceStatisticsInterfaceAsync and NetworkManagerDeviceWifiP2PInterfaceAsync

Parameters:

  • device_path (str) – D-Bus path to device object. Obtained from NetworkManagerInterface.get_devices() or NetworkManagerInterface.get_device_by_ip_iface().

  • bus (Optional[SdBus]) – You probably want to set default bus to system bus or pass system bus directly.

class sdbus_async.networkmanager.NetworkDeviceWireGuard(device_path, bus=None)

Generic device

Implements NetworkManagerDeviceInterfaceAsync, NetworkManagerDeviceStatisticsInterfaceAsync and NetworkManagerDeviceWireGuardInterfaceAsync

Parameters:

  • device_path (str) – D-Bus path to device object. Obtained from NetworkManagerInterface.get_devices() or NetworkManagerInterface.get_device_by_ip_iface().

  • bus (Optional[SdBus]) – You probably want to set default bus to system bus or pass system bus directly.

class sdbus_async.networkmanager.NetworkDevicePPP(device_path, bus=None)

PPP device

Implements NetworkManagerDeviceInterfaceAsync, NetworkManagerDeviceStatisticsInterfaceAsync and NetworkManagerPPPInterfaceAsync

Parameters:

  • device_path (str) – D-Bus path to device object. Obtained from NetworkManagerInterface.get_devices() or NetworkManagerInterface.get_device_by_ip_iface().

  • bus (Optional[SdBus]) – You probably want to set default bus to system bus or pass system bus directly.

class sdbus_async.networkmanager.NetworkDeviceLoopback(device_path, bus=None)

Loopback device

Implements NetworkManagerDeviceInterfaceAsync, NetworkManagerDeviceStatisticsInterfaceAsync and NetworkManagerLoopbackInterfaceAsync

Parameters:

  • device_path (str) – D-Bus path to device object. Obtained from NetworkManagerInterface.get_devices() or NetworkManagerInterface.get_device_by_ip_iface().

  • bus (Optional[SdBus]) – You probably want to set default bus to system bus or pass system bus directly.

Connection configuration objects

class sdbus_async.networkmanager.ActiveConnection(connection_path, bus=None)

Active connection object

Implements NetworkManagerConnectionActiveInterfaceAsync

Parameters:
class sdbus_async.networkmanager.ActiveVPNConnection(connection_path, bus=None)

Active VPN connection object

Implements NetworkManagerConnectionActiveInterfaceAsync and NetworkManagerVPNConnectionInterfaceAsync

Parameters:
class sdbus_async.networkmanager.IPv4Config(ip4_path, bus=None)

IPv4 configuration interface

Implements NetworkManagerIP4ConfigInterfaceAsync

Parameters:
class sdbus_async.networkmanager.IPv6Config(ip6_path, bus=None)

IPv6 configuration interface

Implements NetworkManagerIP6ConfigInterfaceAsync

Parameters:
class sdbus_async.networkmanager.DHCPv4Config(dhcp4_path, bus=None)

DHCPv4 configuration interface

Implements NetworkManagerDHCP4ConfigInterfaceAsync

Parameters:
class sdbus_async.networkmanager.DHCPv6Config(dhcpv6_path, bus=None)

DHCPv6 configuration interface

Implements NetworkManagerDHCP6ConfigInterfaceAsync

Parameters:

Other objects

class sdbus_async.networkmanager.AccessPoint(point_path, bus=None)

Access Point (WiFi point) object

Implements NetworkManagerAccessPointInterfaceAsync

Parameters:
class sdbus_async.networkmanager.WiFiP2PPeer(peer_path, bus=None)

WiFi peer object

Implements NetworkManagerWifiP2PPeerInterfaceAsync

Parameters:
class sdbus_async.networkmanager.ConfigCheckpoint(checkpoint_path, bus=None)

Configuration checkpoint interface

Implements NetworkManagerCheckpointInterfaceAsync

Parameters:

  • checkpoint_path (str) – D-Bus path to access point object. Obtained from NetworkManagerDeviceWifiP2PInterfaceAsync.checkpoint_create.

  • bus (Optional[SdBus]) – You probably want to set default bus to system bus or pass system bus directly.