Enums

Details

class NM.ActiveConnectionState(value)

Bases: GObject.GEnum

NM.ActiveConnectionState values indicate the state of a connection to a specific network while it is starting, connected, or disconnecting from that network.

UNKNOWN = 0

the state of the connection is unknown

ACTIVATING = 1

a network connection is being prepared

ACTIVATED = 2

there is a connection to the network

DEACTIVATING = 3

the network connection is being torn down and cleaned up

DEACTIVATED = 4

the network connection is disconnected and will be removed

class NM.ActiveConnectionStateReason(value)

Bases: GObject.GEnum

Active connection state reasons.

New in version 1.8.

UNKNOWN = 0

The reason for the active connection state change is unknown.

NONE = 1

No reason was given for the active connection state change.

LOGIN_FAILED = 10

Authentication to the server failed.

CONNECTION_REMOVED = 11

The connection was deleted from settings.

DEPENDENCY_FAILED = 12

Master connection of this connection failed to activate.

DEVICE_REALIZE_FAILED = 13

Could not create the software device link.

DEVICE_REMOVED = 14

The device this connection depended on disappeared.

USER_DISCONNECTED = 2

The active connection changed state because the user disconnected it.

DEVICE_DISCONNECTED = 3

The active connection changed state because the device it was using was disconnected.

SERVICE_STOPPED = 4

The service providing the VPN connection was stopped.

IP_CONFIG_INVALID = 5

The IP config of the active connection was invalid.

CONNECT_TIMEOUT = 6

The connection attempt to the VPN service timed out.

SERVICE_START_TIMEOUT = 7

A timeout occurred while starting the service providing the VPN connection.

SERVICE_START_FAILED = 8

Starting the service providing the VPN connection failed.

NO_SECRETS = 9

Necessary secrets for the connection were not provided.

class NM.AgentManagerError(value)

Bases: GObject.GEnum

Errors returned from the secret-agent manager.

These errors may be returned from operations that could cause secrets to be requested (such as nm_client_activate_connection()), and correspond to D-Bus errors in the “org.freedesktop.NetworkManager.AgentManager” namespace.

classmethod quark()
Return type:int
FAILED = 0

unknown or unspecified error

PERMISSIONDENIED = 1

The caller does not have permission to register a secret agent, or is trying to register the same secret agent twice.

INVALIDIDENTIFIER = 2

The identifier is not a valid secret agent identifier.

NOTREGISTERED = 3

The caller tried to unregister an agent that was not registered.

NOSECRETS = 4

No secret agent returned secrets for this request

USERCANCELED = 5

The user canceled the secrets request.

class NM.Capability(value)

Bases: GObject.GEnum

NM.Capability names the numbers in the Capabilities property. Capabilities are positive numbers. They are part of stable API and a certain capability number is guaranteed not to change.

The range 0x7000 - 0x7FFF of capabilities is guaranteed not to be used by upstream NetworkManager. It could thus be used for downstream extensions.

TEAM = 1

Teams can be managed. This means the team device plugin is loaded.

OVS = 2

OpenVSwitch can be managed. This means the OVS device plugin is loaded.

New in version 1.24.

class NM.ClientError(value)

Bases: GObject.GEnum

Describes errors that may result from operations involving a NM.Client.

D-Bus operations may also return errors from other domains, including NM.ManagerError, NM.SettingsError, NM.AgentManagerError, and NM.ConnectionError.

classmethod quark()
Returns:the error quark used for NM.Client errors.
Return type:int

Registers an error quark for NM.Client if necessary.

FAILED = 0

unknown or unclassified error

MANAGER_NOT_RUNNING = 1

an operation that requires NetworkManager failed because NetworkManager is not running

OBJECT_CREATION_FAILED = 2

NetworkManager claimed that an operation succeeded, but the object that was allegedly created (eg, NM.RemoteConnection, NM.ActiveConnection) was apparently destroyed before NM.Client could create a representation of it.

class NM.ClientPermission(value)

Bases: GObject.GEnum

NM.ClientPermission values indicate various permissions that NetworkManager clients can obtain to perform certain tasks on behalf of the current user.

NONE = 0

unknown or no permission

ENABLE_DISABLE_NETWORK = 1

controls whether networking can be globally enabled or disabled

SETTINGS_MODIFY_OWN = 10

controls whether connections owned by the current user can be modified

SETTINGS_MODIFY_HOSTNAME = 11

controls whether the persistent hostname can be changed

SETTINGS_MODIFY_GLOBAL_DNS = 12

modify persistent global DNS configuration

RELOAD = 13

controls access to Reload.

CHECKPOINT_ROLLBACK = 14

permission to create checkpoints.

ENABLE_DISABLE_STATISTICS = 15

controls whether device statistics can be globally enabled or disabled

ENABLE_DISABLE_CONNECTIVITY_CHECK = 16

controls whether connectivity check can be enabled or disabled

LAST = 17

a reserved boundary value

WIFI_SCAN = 17

controls whether wifi scans can be performed

ENABLE_DISABLE_WIFI = 2

controls whether Wi-Fi can be globally enabled or disabled

ENABLE_DISABLE_WWAN = 3

controls whether WWAN (3G) can be globally enabled or disabled

ENABLE_DISABLE_WIMAX = 4

controls whether WiMAX can be globally enabled or disabled

SLEEP_WAKE = 5

controls whether the client can ask NetworkManager to sleep and wake

NETWORK_CONTROL = 6

controls whether networking connections can be started, stopped, and changed

WIFI_SHARE_PROTECTED = 7

controls whether a password protected Wi-Fi hotspot can be created

WIFI_SHARE_OPEN = 8

controls whether an open Wi-Fi hotspot can be created

SETTINGS_MODIFY_SYSTEM = 9

controls whether connections that are available to all users can be modified

class NM.ClientPermissionResult(value)

Bases: GObject.GEnum

NM.ClientPermissionResult values indicate what authorizations and permissions the user requires to obtain a given NM.ClientPermission

UNKNOWN = 0

unknown or no authorization

YES = 1

the permission is available

AUTH = 2

authorization is necessary before the permission is available

NO = 3

permission to perform the operation is denied by system policy

class NM.ConnectionError(value)

Bases: GObject.GEnum

Describes errors that may result from operations involving a NM.Connection or its NM.Settings.

These errors may be returned directly from NM.Connection and NM.Setting methods, or may be returned from D-Bus operations (eg on NM.Client or NM.Device), where they correspond to errors in the “org.freedesktop.NetworkManager.Settings.Connection” namespace.

classmethod quark()
Return type:int
FAILED = 0

unknown or unclassified error

SETTINGNOTFOUND = 1

the NM.Connection object did not contain the specified NM.Setting object

PROPERTYNOTFOUND = 2

the NM.Connection did not contain the requested NM.Setting property

PROPERTYNOTSECRET = 3

an operation which requires a secret was attempted on a non-secret property

MISSINGSETTING = 4

the NM.Connection object is missing an NM.Setting which is required for its configuration. The error message will always be prefixed with “<setting-name>: “, where “<setting-name>” is the name of the setting that is missing.

INVALIDSETTING = 5

the NM.Connection object contains an invalid or inappropriate NM.Setting. The error message will always be prefixed with “<setting-name>: “, where “<setting-name>” is the name of the setting that is invalid.

MISSINGPROPERTY = 6

the NM.Connection object is invalid because it is missing a required property. The error message will always be prefixed with “<setting-name>.<property-name>: “, where “<setting-name>” is the name of the setting with the missing property, and “<property-name>” is the property that is missing.

INVALIDPROPERTY = 7

the NM.Connection object is invalid because a property has an invalid value. The error message will always be prefixed with “<setting-name>.<property-name>: “, where “<setting-name>” is the name of the setting with the invalid property, and “<property-name>” is the property that is invalid.

class NM.ConnectionMultiConnect(value)

Bases: GObject.GEnum

New in version 1.14.

DEFAULT = 0

indicates that the per-connection setting is unspecified. In this case, it will fallback to the default value, which is NM.ConnectionMultiConnect.SINGLE.

SINGLE = 1

the connection profile can only be active once at each moment. Activating a profile that is already active, will first deactivate it.

MANUAL_MULTIPLE = 2

the profile can be manually activated multiple times on different devices. However, regarding autoconnect, the profile will autoconnect only if it is currently not connected otherwise.

MULTIPLE = 3

the profile can autoactivate and be manually activated multiple times together.

class NM.ConnectivityState(value)

Bases: GObject.GEnum

UNKNOWN = 0

Network connectivity is unknown. This means the connectivity checks are disabled (e.g. on server installations) or has not run yet. The graphical shell should assume the Internet connection might be available and not present a captive portal window.

NONE = 1

The host is not connected to any network. There’s no active connection that contains a default route to the internet and thus it makes no sense to even attempt a connectivity check. The graphical shell should use this state to indicate the network connection is unavailable.

PORTAL = 2

The Internet connection is hijacked by a captive portal gateway. The graphical shell may open a sandboxed web browser window (because the captive portals typically attempt a man-in-the-middle attacks against the https connections) for the purpose of authenticating to a gateway and retrigger the connectivity check with CheckConnectivity() when the browser window is dismissed.

LIMITED = 3

The host is connected to a network, does not appear to be able to reach the full Internet, but a captive portal has not been detected.

FULL = 4

The host is connected to a network, and appears to be able to reach the full Internet.

class NM.CryptoError(value)

Bases: GObject.GEnum

Cryptography-related errors that can be returned from some nm-utils methods, and some NM.Setting8021x operations.

classmethod quark()
Return type:int
FAILED = 0

generic failure

INVALID_DATA = 1

the certificate or key data provided was invalid

INVALID_PASSWORD = 2

the password was invalid

UNKNOWN_CIPHER = 3

the data uses an unknown cipher

DECRYPTION_FAILED = 4

decryption failed

ENCRYPTION_FAILED = 5

encryption failed

class NM.DeviceError(value)

Bases: GObject.GEnum

Device-related errors.

These errors may be returned directly from NM.Device methods, or may be returned from D-Bus operations (where they correspond to errors in the “org.freedesktop.NetworkManager.Device” namespace).

classmethod quark()
Return type:int
FAILED = 0

unknown or unclassified error

CREATIONFAILED = 1

NetworkManager failed to create the device

INVALIDARGUMENT = 10

invalid argument.

New in version 1.16.

INVALIDCONNECTION = 2

the specified connection is not valid

INCOMPATIBLECONNECTION = 3

the specified connection is not compatible with this device.

NOTACTIVE = 4

the device does not have an active connection

NOTSOFTWARE = 5

the requested operation is only valid on software devices.

NOTALLOWED = 6

the requested operation is not allowed at this time.

SPECIFICOBJECTNOTFOUND = 7

the “specific object” in the activation request (eg, the NM.AccessPoint or NM.WimaxNsp) was not found.

VERSIONIDMISMATCH = 8

the version id did not match.

MISSINGDEPENDENCIES = 9

the requested operation could not be completed due to missing dependencies.

class NM.DeviceState(value)

Bases: GObject.GEnum

UNKNOWN = 0

the device’s state is unknown

UNMANAGED = 10

the device is recognized, but not managed by NetworkManager

ACTIVATED = 100

the device has a network connection, either local or global.

DEACTIVATING = 110

a disconnection from the current network connection was requested, and the device is cleaning up resources used for that connection. The network connection may still be valid.

FAILED = 120

the device failed to connect to the requested network and is cleaning up the connection request

UNAVAILABLE = 20

the device is managed by NetworkManager, but is not available for use. Reasons may include the wireless switched off, missing firmware, no ethernet carrier, missing supplicant or modem manager, etc.

DISCONNECTED = 30

the device can be activated, but is currently idle and not connected to a network.

PREPARE = 40

the device is preparing the connection to the network. This may include operations like changing the MAC address, setting physical link properties, and anything else required to connect to the requested network.

CONFIG = 50

the device is connecting to the requested network. This may include operations like associating with the Wi-Fi AP, dialing the modem, connecting to the remote Bluetooth device, etc.

NEED_AUTH = 60

the device requires more information to continue connecting to the requested network. This includes secrets like WiFi passphrases, login passwords, PIN codes, etc.

IP_CONFIG = 70

the device is requesting IPv4 and/or IPv6 addresses and routing information from the network.

IP_CHECK = 80

the device is checking whether further action is required for the requested network connection. This may include checking whether only local network access is available, whether a captive portal is blocking access to the Internet, etc.

SECONDARIES = 90

the device is waiting for a secondary connection (like a VPN) which must activated before the device can be activated

class NM.DeviceStateReason(value)

Bases: GObject.GEnum

Device state change reason codes

NONE = 0

No reason given

UNKNOWN = 1

Unknown error

SUPPLICANT_FAILED = 10

802.1x supplicant failed

SUPPLICANT_TIMEOUT = 11

802.1x supplicant took too long to authenticate

PPP_START_FAILED = 12

PPP service failed to start

PPP_DISCONNECT = 13

PPP service disconnected

PPP_FAILED = 14

PPP failed

DHCP_START_FAILED = 15

DHCP client failed to start

DHCP_ERROR = 16

DHCP client error

DHCP_FAILED = 17

DHCP client failed

SHARED_START_FAILED = 18

Shared connection service failed to start

SHARED_FAILED = 19

Shared connection service failed

NOW_MANAGED = 2

Device is now managed

AUTOIP_START_FAILED = 20

AutoIP service failed to start

AUTOIP_ERROR = 21

AutoIP service error

AUTOIP_FAILED = 22

AutoIP service failed

MODEM_BUSY = 23

The line is busy

MODEM_NO_DIAL_TONE = 24

No dial tone

MODEM_NO_CARRIER = 25

No carrier could be established

MODEM_DIAL_TIMEOUT = 26

The dialing request timed out

MODEM_DIAL_FAILED = 27

The dialing attempt failed

MODEM_INIT_FAILED = 28

Modem initialization failed

GSM_APN_FAILED = 29

Failed to select the specified APN

NOW_UNMANAGED = 3

Device is now unmanaged

GSM_REGISTRATION_NOT_SEARCHING = 30

Not searching for networks

GSM_REGISTRATION_DENIED = 31

Network registration denied

GSM_REGISTRATION_TIMEOUT = 32

Network registration timed out

GSM_REGISTRATION_FAILED = 33

Failed to register with the requested network

GSM_PIN_CHECK_FAILED = 34

PIN check failed

FIRMWARE_MISSING = 35

Necessary firmware for the device may be missing

REMOVED = 36

The device was removed

SLEEPING = 37

NetworkManager went to sleep

CONNECTION_REMOVED = 38

The device’s active connection disappeared

USER_REQUESTED = 39

Device disconnected by user or client

CONFIG_FAILED = 4

The device could not be readied for configuration

CARRIER = 40

Carrier/link changed

CONNECTION_ASSUMED = 41

The device’s existing connection was assumed

SUPPLICANT_AVAILABLE = 42

The supplicant is now available

MODEM_NOT_FOUND = 43

The modem could not be found

BT_FAILED = 44

The Bluetooth connection failed or timed out

GSM_SIM_NOT_INSERTED = 45

GSM Modem’s SIM Card not inserted

GSM_SIM_PIN_REQUIRED = 46

GSM Modem’s SIM Pin required

GSM_SIM_PUK_REQUIRED = 47

GSM Modem’s SIM Puk required

GSM_SIM_WRONG = 48

GSM Modem’s SIM wrong

INFINIBAND_MODE = 49

InfiniBand device does not support connected mode

IP_CONFIG_UNAVAILABLE = 5

IP configuration could not be reserved (no available address, timeout, etc)

DEPENDENCY_FAILED = 50

A dependency of the connection failed

BR2684_FAILED = 51

Problem with the RFC 2684 Ethernet over ADSL bridge

MODEM_MANAGER_UNAVAILABLE = 52

ModemManager not running

SSID_NOT_FOUND = 53

The Wi-Fi network could not be found

SECONDARY_CONNECTION_FAILED = 54

A secondary connection of the base connection failed

DCB_FCOE_FAILED = 55

DCB or FCoE setup failed

TEAMD_CONTROL_FAILED = 56

teamd control failed

MODEM_FAILED = 57

Modem failed or no longer available

MODEM_AVAILABLE = 58

Modem now ready and available

SIM_PIN_INCORRECT = 59

SIM PIN was incorrect

IP_CONFIG_EXPIRED = 6

The IP config is no longer valid

NEW_ACTIVATION = 60

New connection activation was enqueued

PARENT_CHANGED = 61

the device’s parent changed

PARENT_MANAGED_CHANGED = 62

the device parent’s management changed

OVSDB_FAILED = 63

problem communicating with Open vSwitch database

IP_ADDRESS_DUPLICATE = 64

a duplicate IP address was detected

IP_METHOD_UNSUPPORTED = 65

The selected IP method is not supported

SRIOV_CONFIGURATION_FAILED = 66

configuration of SR-IOV parameters failed

PEER_NOT_FOUND = 67

The Wi-Fi P2P peer could not be found

NO_SECRETS = 7

Secrets were required, but not provided

SUPPLICANT_DISCONNECT = 8

802.1x supplicant disconnected

SUPPLICANT_CONFIG_FAILED = 9

802.1x supplicant configuration failed

class NM.DeviceType(value)

Bases: GObject.GEnum

NM.DeviceType values indicate the type of hardware represented by a device object.

UNKNOWN = 0

unknown device

ETHERNET = 1

a wired ethernet device

BOND = 10

a bond master interface

VLAN = 11

an 802.1Q VLAN interface

ADSL = 12

ADSL modem

BRIDGE = 13

a bridge master interface

GENERIC = 14

generic support for unrecognized device types

TEAM = 15

a team master interface

TUN = 16

a TUN or TAP interface

IP_TUNNEL = 17

a IP tunnel interface

MACVLAN = 18

a MACVLAN interface

VXLAN = 19

a VXLAN interface

WIFI = 2

an 802.11 Wi-Fi device

VETH = 20

a VETH interface

MACSEC = 21

a MACsec interface

DUMMY = 22

a dummy interface

PPP = 23

a PPP interface

OVS_INTERFACE = 24

a Open vSwitch interface

OVS_PORT = 25

a Open vSwitch port

OVS_BRIDGE = 26

a Open vSwitch bridge

WPAN = 27

a IEEE 802.15.4 (WPAN) MAC Layer Device

6LOWPAN = 28
_6LOWPAN = 28

6LoWPAN interface

WIREGUARD = 29

a WireGuard interface

UNUSED1 = 3

not used

WIFI_P2P = 30

an 802.11 Wi-Fi P2P device

New in version 1.16.

VRF = 31

A VRF (Virtual Routing and Forwarding) interface

New in version 1.24.

UNUSED2 = 4

not used

BT = 5

a Bluetooth device supporting PAN or DUN access protocols

OLPC_MESH = 6

an OLPC XO mesh networking device

WIMAX = 7

an 802.16e Mobile WiMAX broadband device

MODEM = 8

a modem supporting analog telephone, CDMA/EVDO, GSM/UMTS, or LTE network access protocols

INFINIBAND = 9

an IP-over-InfiniBand device

class NM.IPTunnelMode(value)

Bases: GObject.GEnum

The tunneling mode.

New in version 1.2.

UNKNOWN = 0

Unknown/unset tunnel mode

IPIP = 1

IP in IP tunnel

GRETAP = 10

GRETAP tunnel

IP6GRETAP = 11

IPv6 GRETAP tunnel

GRE = 2

GRE tunnel

SIT = 3

SIT tunnel

ISATAP = 4

ISATAP tunnel

VTI = 5

VTI tunnel

IP6IP6 = 6

IPv6 in IPv6 tunnel

IPIP6 = 7

IPv4 in IPv6 tunnel

IP6GRE = 8

IPv6 GRE tunnel

VTI6 = 9

IPv6 VTI tunnel

class NM.ManagerError(value)

Bases: GObject.GEnum

Errors related to the main “network management” interface of NetworkManager. These may be returned from NM.Client methods that invoke D-Bus operations on the “org.freedesktop.NetworkManager” interface, and correspond to D-Bus errors in that namespace.

classmethod quark()
Return type:int
FAILED = 0

unknown or unclassified error

PERMISSIONDENIED = 1

Permission denied.

UNKNOWNLOGLEVEL = 10

Unknown log level in SetLogging

UNKNOWNLOGDOMAIN = 11

Unknown log domain in SetLogging

INVALIDARGUMENTS = 12

Invalid arguments for D-Bus request

MISSINGPLUGIN = 13

A plug-in was needed to complete the activation but is not available.

UNKNOWNCONNECTION = 2

The requested connection is not known.

UNKNOWNDEVICE = 3

The requested device is not known.

CONNECTIONNOTAVAILABLE = 4

The requested connection cannot be activated at this time.

CONNECTIONNOTACTIVE = 5

The request could not be completed because a required connection is not active.

CONNECTIONALREADYACTIVE = 6

The connection to be activated was already active on another device.

DEPENDENCYFAILED = 7

An activation request failed due to a dependency being unavailable.

ALREADYASLEEPORAWAKE = 8

The manager is already in the requested sleep/wake state.

ALREADYENABLEDORDISABLED = 9

The network is already enabled/disabled.

class NM.Metered(value)

Bases: GObject.GEnum

The NM.Metered enum has two different purposes: one is to configure “connection.metered” setting of a connection profile in NM.SettingConnection, and the other is to express the actual metered state of the NM.Device at a given moment.

For the connection profile only NM.Metered.UNKNOWN, NM.Metered.NO and NM.Metered.YES are allowed.

The device’s metered state at runtime is determined by the profile which is currently active. If the profile explicitly specifies NM.Metered.NO or NM.Metered.YES, then the device’s metered state is as such. If the connection profile leaves it undecided at NM.Metered.UNKNOWN (the default), then NetworkManager tries to guess the metered state, for example based on the device type or on DHCP options (like Android devices exposing a “ANDROID_METERED” DHCP vendor option). This then leads to either NM.Metered.GUESS_NO or NM.Metered.GUESS_YES.

Most applications probably should treat the runtime state NM.Metered.GUESS_YES like NM.Metered.YES, and all other states as not metered.

Note that the per-device metered states are then combined to a global metered state. This is basically the metered state of the device with the best default route. However, that generalization of a global metered state may not be correct if the default routes for IPv4 and IPv6 are on different devices, or if policy routing is configured. In general, the global metered state tries to express whether the traffic is likely metered, but since that depends on the traffic itself, there is not one answer in all cases. Hence, an application may want to consider the per-device’s metered states.

New in version 1.2.

UNKNOWN = 0

The metered status is unknown

YES = 1

Metered, the value was explicitly configured

NO = 2

Not metered, the value was explicitly configured

GUESS_YES = 3

Metered, the value was guessed

GUESS_NO = 4

Not metered, the value was guessed

class NM.RollbackResult(value)

Bases: GLib.Enum

The result of a checkpoint Rollback() operation for a specific device.

New in version 1.4.

OK = 0

the rollback succeeded.

ERR_NO_DEVICE = 1

the device no longer exists.

ERR_DEVICE_UNMANAGED = 2

the device is now unmanaged.

ERR_FAILED = 3

other errors during rollback.

class NM.SecretAgentError(value)

Bases: GObject.GEnum

NM.SecretAgentError values are passed by secret agents back to NetworkManager when they encounter problems retrieving secrets on behalf of NM. They correspond to errors in the “org.freedesktop.NetworkManager.SecretManager” namespace.

Client APIs such as nm_client_activate_connection() will not see these error codes; instead, the secret agent manager will translate them to the corresponding NM.AgentManagerError codes.

classmethod quark()
Return type:int
FAILED = 0

unknown or unclassified error

PERMISSIONDENIED = 1

the caller (ie, NetworkManager) is not authorized to make this request

INVALIDCONNECTION = 2

the connection for which secrets were requested is invalid

USERCANCELED = 3

the request was canceled by the user

AGENTCANCELED = 4

the agent canceled the request because it was requested to do so by NetworkManager

NOSECRETS = 5

the agent cannot find any secrets for this connection

class NM.Setting8021xCKFormat(value)

Bases: GObject.GEnum

NM.Setting8021xCKFormat values indicate the general type of a certificate or private key

UNKNOWN = 0

unknown file format

X509 = 1

file contains an X.509 format certificate

RAW_KEY = 2

file contains an old-style OpenSSL PEM or DER private key

PKCS12 = 3

file contains a PKCS# 12 certificate and private key

class NM.Setting8021xCKScheme(value)

Bases: GObject.GEnum

NM.Setting8021xCKScheme values indicate how a certificate or private key is stored in the setting properties, either as a blob of the item’s data, or as a path to a certificate or private key file on the filesystem

UNKNOWN = 0

unknown certificate or private key scheme

BLOB = 1

certificate or key is stored as the raw item data

PATH = 2

certificate or key is stored as a path to a file containing the certificate or key data

PKCS11 = 3

certificate or key is stored as a URI of an object on a PKCS#11 token

class NM.SettingCompareFlags(value)

Bases: GObject.GEnum

These flags modify the comparison behavior when comparing two settings or two connections.

EXACT = 0

match all properties exactly

FUZZY = 1

match only important attributes, like SSID, type, security settings, etc. Does not match, for example, connection ID or UUID.

IGNORE_TIMESTAMP = 128

ignore the connection’s timestamp

IGNORE_NOT_SAVED_SECRETS = 16

ignore secrets for which the secret’s flags indicate the secret should not be saved to persistent storage (ie, the secret’s flag includes NM.SettingSecretFlags.NOT_SAVED)

IGNORE_ID = 2

ignore the connection’s ID

DIFF_RESULT_WITH_DEFAULT = 32

if this flag is set, NM.Setting.diff() and NM.Connection.diff() will also include properties that are set to their default value. See also NM.SettingCompareFlags.DIFF_RESULT_NO_DEFAULT.

IGNORE_SECRETS = 4

ignore all secrets

DIFF_RESULT_NO_DEFAULT = 64

if this flag is set, NM.Setting.diff() and NM.Connection.diff() will not include properties that are set to their default value. This is the opposite of NM.SettingCompareFlags.DIFF_RESULT_WITH_DEFAULT. If both flags are set together, NM.SettingCompareFlags.DIFF_RESULT_WITH_DEFAULT wins. If both flags are unset, this means to exclude default properties if there is a setting to compare, but include all properties, if the setting ‘b’ is missing. This is the legacy behaviour of libnm-util, where NM.Setting.diff() behaved differently depending on whether the setting ‘b’ was available. If NM.SettingCompareFlags.DIFF_RESULT_WITH_DEFAULT is set, NM.Setting.diff() will also set the flags NM.SettingDiffResult.IN_A_DEFAULT and NM.SettingDiffResult.IN_B_DEFAULT, if the values are default values.

IGNORE_AGENT_OWNED_SECRETS = 8

ignore secrets for which the secret’s flags indicate the secret is owned by a user secret agent (ie, the secret’s flag includes NM.SettingSecretFlags.AGENT_OWNED)

class NM.SettingConnectionAutoconnectSlaves(value)

Bases: GObject.GEnum

NM.SettingConnectionAutoconnectSlaves values indicate whether slave connections should be activated when master is activated.

DEFAULT = -1

default value

NO = 0

slaves are not brought up when master is activated

YES = 1

slaves are brought up when master is activated

class NM.SettingConnectionLldp(value)

Bases: GObject.GEnum

NM.SettingConnectionLldp values indicate whether LLDP should be enabled.

DEFAULT = -1

default value

DISABLE = 0

disable LLDP

ENABLE_RX = 1

enable reception of LLDP frames

class NM.SettingConnectionLlmnr(value)

Bases: GObject.GEnum

NM.SettingConnectionLlmnr values indicate whether LLMNR should be enabled.

New in version 1.14.

DEFAULT = -1

default value

NO = 0

disable LLMNR

RESOLVE = 1

support only resolving, do not register hostname

YES = 2

enable LLMNR

class NM.SettingConnectionMdns(value)

Bases: GObject.GEnum

NM.SettingConnectionMdns values indicate whether mDNS should be enabled.

New in version 1.12.

DEFAULT = -1

default value

NO = 0

disable mDNS

RESOLVE = 1

support only resolving, do not register hostname

YES = 2

enable mDNS

class NM.SettingDiffResult(value)

Bases: GObject.GEnum

These values indicate the result of a setting difference operation.

UNKNOWN = 0

unknown result

IN_A = 1

the property is present in setting A

IN_B = 2

the property is present in setting B

IN_A_DEFAULT = 4

the property is present in setting A but is set to the default value. This flag is only set, if you specify NM.SettingCompareFlags.DIFF_RESULT_WITH_DEFAULT.

IN_B_DEFAULT = 8

analog to NM.SettingDiffResult.IN_A_DEFAULT.

class NM.SettingIP6ConfigAddrGenMode(value)

Bases: GObject.GEnum

NM.SettingIP6ConfigAddrGenMode controls how the Interface Identifier for RFC4862 Stateless Address Autoconfiguration is created.

New in version 1.2.

EUI64 = 0

The Interface Identifier is derived from the interface hardware address.

STABLE_PRIVACY = 1

The Interface Identifier is created by using a cryptographically secure hash of a secret host-specific key along with the connection identification and the network address as specified by RFC7217.

class NM.SettingIP6ConfigPrivacy(value)

Bases: GObject.GEnum

NM.SettingIP6ConfigPrivacy values indicate if and how IPv6 Privacy Extensions are used (RFC4941).

UNKNOWN = -1

unknown or no value specified

DISABLED = 0

IPv6 Privacy Extensions are disabled

PREFER_PUBLIC_ADDR = 1

IPv6 Privacy Extensions are enabled, but public addresses are preferred over temporary addresses

PREFER_TEMP_ADDR = 2

IPv6 Privacy Extensions are enabled and temporary addresses are preferred over public addresses

class NM.SettingMacRandomization(value)

Bases: GObject.GEnum

Controls if and how the MAC address of a device is randomzied.

DEFAULT = 0

the default value, which unless overridden by user-controlled defaults configuration, is “never”.

NEVER = 1

the device’s MAC address is always used.

ALWAYS = 2

a random MAC address is used.

class NM.SettingMacsecMode(value)

Bases: GObject.GEnum

NM.SettingMacsecMode controls how the CAK (Connectivity Association Key) used in MKA (MACsec Key Agreement) is obtained.

New in version 1.6.

PSK = 0

The CAK is pre-shared

EAP = 1

The CAK is the result of participation in EAP

class NM.SettingMacsecValidation(value)

Bases: GObject.GEnum

NM.SettingMacsecValidation specifies a validation mode for incoming frames.

New in version 1.6.

DISABLE = 0

All incoming frames are accepted if possible

CHECK = 1

Non protected, invalid, or impossible to verify frames are accepted and counted as “invalid”

STRICT = 2

Non protected, invalid, or impossible to verify frames are dropped

class NM.SettingMacvlanMode(value)

Bases: GObject.GEnum

UNKNOWN = 0

unknown/unset mode

VEPA = 1

Virtual Ethernet Port Aggregator mode

BRIDGE = 2

bridge mode

PRIVATE = 3

private mode

PASSTHRU = 4

passthru mode

SOURCE = 5

source mode

class NM.SettingProxyMethod(value)

Bases: GObject.GEnum

The Proxy method.

New in version 1.6.

NONE = 0

No Proxy for the Connection

AUTO = 1

DHCP obtained Proxy/ Manual override

class NM.SettingSerialParity(value)

Bases: GObject.GEnum

The parity setting of a serial port.

NONE = 0

No parity bits (default)

EVEN = 1

Even parity

ODD = 2

Odd parity

class NM.SettingTunMode(value)

Bases: GObject.GEnum

NM.SettingTunMode values indicate the device type (TUN/TAP)

UNKNOWN = 0

an unknown device type

TUN = 1

a TUN device

TAP = 2

a TAP device

class NM.SettingWirelessPowersave(value)

Bases: GObject.GEnum

These flags indicate whether wireless powersave must be enabled.

DEFAULT = 0

use the default value

IGNORE = 1

don’t touch existing setting

DISABLE = 2

disable powersave

ENABLE = 3

enable powersave

class NM.SettingWirelessSecurityFils(value)

Bases: GObject.GEnum

These flags indicate whether FILS must be enabled.

New in version 1.12.

DEFAULT = 0

use the default value

DISABLE = 1

disable FILS

OPTIONAL = 2

enable FILS if the supplicant and the AP support it

REQUIRED = 3

require FILS and fail if not available

class NM.SettingWirelessSecurityPmf(value)

Bases: GObject.GEnum

These flags indicate whether PMF must be enabled.

DEFAULT = 0

use the default value

DISABLE = 1

disable PMF

OPTIONAL = 2

enable PMF if the supplicant and the AP support it

REQUIRED = 3

require PMF and fail if not available

class NM.SettingsError(value)

Bases: GObject.GEnum

Errors related to the settings/persistent configuration interface of NetworkManager.

These may be returned from NM.Client methods that invoke D-Bus operations on the “org.freedesktop.NetworkManager.Settings” interface, and correspond to D-Bus errors in that namespace.

classmethod quark()
Return type:int
FAILED = 0

unknown or unclassified error

PERMISSIONDENIED = 1

permission denied

NOTSUPPORTED = 2

the requested operation is not supported by any active settings backend

INVALIDCONNECTION = 3

the connection was invalid

READONLYCONNECTION = 4

attempted to modify a read-only connection

UUIDEXISTS = 5

a connection with that UUID already exists

INVALIDHOSTNAME = 6

attempted to set an invalid hostname

INVALIDARGUMENTS = 7

invalid arguments

class NM.SriovVFVlanProtocol(value)

Bases: GObject.GEnum

NM.SriovVFVlanProtocol indicates the VLAN protocol to use.

New in version 1.14.

1Q = 0
_1Q = 0

use 802.1Q

1AD = 1
_1AD = 1

use 802.1ad

class NM.State(value)

Bases: GObject.GEnum

NM.State values indicate the current overall networking state.

UNKNOWN = 0

Networking state is unknown. This indicates a daemon error that makes it unable to reasonably assess the state. In such event the applications are expected to assume Internet connectivity might be present and not disable controls that require network access. The graphical shells may hide the network accessibility indicator altogether since no meaningful status indication can be provided.

ASLEEP = 10

Networking is not enabled, the system is being suspended or resumed from suspend.

DISCONNECTED = 20

There is no active network connection. The graphical shell should indicate no network connectivity and the applications should not attempt to access the network.

DISCONNECTING = 30

Network connections are being cleaned up. The applications should tear down their network sessions.

CONNECTING = 40

A network connection is being started The graphical shell should indicate the network is being connected while the applications should still make no attempts to connect the network.

CONNECTED_LOCAL = 50

There is only local IPv4 and/or IPv6 connectivity, but no default route to access the Internet. The graphical shell should indicate no network connectivity.

CONNECTED_SITE = 60

There is only site-wide IPv4 and/or IPv6 connectivity. This means a default route is available, but the Internet connectivity check (see “Connectivity” property) did not succeed. The graphical shell should indicate limited network connectivity.

CONNECTED_GLOBAL = 70

There is global IPv4 and/or IPv6 Internet connectivity This means the Internet connectivity check succeeded, the graphical shell should indicate full network connectivity.

class NM.Ternary(value)

Bases: GObject.GEnum

An boolean value that can be overridden by a default.

New in version 1.14.

DEFAULT = -1

use the globally-configured default value.

FALSE = 0

the option is disabled.

TRUE = 1

the option is enabled.

class NM.UtilsSecurityType(value)

Bases: GObject.GEnum

Describes generic security mechanisms that 802.11 access points may offer. Used with NM.utils_security_valid() for checking whether a given access point is compatible with a network device.

INVALID = 0

unknown or invalid security, placeholder and not used

NONE = 1

unencrypted and open

OWE = 10

is used with Enhanced Open

STATIC_WEP = 2

static WEP keys are used for encryption

LEAP = 3

Cisco LEAP is used for authentication and for generating the dynamic WEP keys automatically

DYNAMIC_WEP = 4

standard 802.1x is used for authentication and generating the dynamic WEP keys automatically

WPA_PSK = 5

WPA1 is used with Pre-Shared Keys (PSK)

WPA_ENTERPRISE = 6

WPA1 is used with 802.1x authentication

WPA2_PSK = 7

WPA2/RSN is used with Pre-Shared Keys (PSK)

WPA2_ENTERPRISE = 8

WPA2 is used with 802.1x authentication

SAE = 9

is used with WPA3 Enterprise

class NM.VlanPriorityMap(value)

Bases: GObject.GEnum

A selector for traffic priority maps; these map Linux SKB priorities to 802.1p priorities used in VLANs.

INGRESS_MAP = 0

map for incoming data

EGRESS_MAP = 1

map for outgoing data

class NM.VpnConnectionState(value)

Bases: GObject.GEnum

VPN connection states

UNKNOWN = 0

The state of the VPN connection is unknown.

PREPARE = 1

The VPN connection is preparing to connect.

NEED_AUTH = 2

The VPN connection needs authorization credentials.

CONNECT = 3

The VPN connection is being established.

IP_CONFIG_GET = 4

The VPN connection is getting an IP address.

ACTIVATED = 5

The VPN connection is active.

FAILED = 6

The VPN connection failed.

DISCONNECTED = 7

The VPN connection is disconnected.

class NM.VpnConnectionStateReason(value)

Bases: GObject.GEnum

VPN connection state reasons

UNKNOWN = 0

The reason for the VPN connection state change is unknown.

NONE = 1

No reason was given for the VPN connection state change.

LOGIN_FAILED = 10

Authentication to the VPN server failed.

CONNECTION_REMOVED = 11

The connection was deleted from settings.

USER_DISCONNECTED = 2

The VPN connection changed state because the user disconnected it.

DEVICE_DISCONNECTED = 3

The VPN connection changed state because the device it was using was disconnected.

SERVICE_STOPPED = 4

The service providing the VPN connection was stopped.

IP_CONFIG_INVALID = 5

The IP config of the VPN connection was invalid.

CONNECT_TIMEOUT = 6

The connection attempt to the VPN service timed out.

SERVICE_START_TIMEOUT = 7

A timeout occurred while starting the service providing the VPN connection.

SERVICE_START_FAILED = 8

Starting the service starting the service providing the VPN connection failed.

NO_SECRETS = 9

Necessary secrets for the VPN connection were not provided.

class NM.VpnPluginError(value)

Bases: GObject.GEnum

Returned by the VPN service plugin to indicate errors. These codes correspond to errors in the “org.freedesktop.NetworkManager.VPN.Error” namespace.

classmethod quark()
Return type:int
FAILED = 0

unknown or unclassified error

STARTINGINPROGRESS = 1

the plugin is already starting, and another connect request was received

ALREADYSTARTED = 2

the plugin is already connected, and another connect request was received

STOPPINGINPROGRESS = 3

the plugin is already stopping, and another stop request was received

ALREADYSTOPPED = 4

the plugin is already stopped, and another disconnect request was received

WRONGSTATE = 5

the operation could not be performed in this state

BADARGUMENTS = 6

the operation could not be performed as the request contained malformed arguments, or arguments of unexpected type. Usually means that one of the VPN setting data items or secrets was not of the expected type (ie int, string, bool, etc).

LAUNCHFAILED = 7

a child process failed to launch

INVALIDCONNECTION = 8

the operation could not be performed because the connection was invalid. Usually means that the connection’s VPN setting was missing some required data item or secret.

INTERACTIVENOTSUPPORTED = 9

the operation could not be performed as the plugin does not support interactive operations, such as ConnectInteractive() or NewSecrets()

class NM.VpnPluginFailure(value)

Bases: GObject.GEnum

VPN plugin failure reasons

LOGIN_FAILED = 0

Login failed.

CONNECT_FAILED = 1

Connect failed.

BAD_IP_CONFIG = 2

Invalid IP configuration returned from the VPN plugin.

class NM.VpnServiceState(value)

Bases: GObject.GEnum

VPN daemon states

UNKNOWN = 0

The state of the VPN plugin is unknown.

INIT = 1

The VPN plugin is initialized.

SHUTDOWN = 2

Not used.

STARTING = 3

The plugin is attempting to connect to a VPN server.

STARTED = 4

The plugin has connected to a VPN server.

STOPPING = 5

The plugin is disconnecting from the VPN server.

STOPPED = 6

The plugin has disconnected from the VPN server.

class NM.WepKeyType(value)

Bases: GObject.GEnum

The NM.WepKeyType values specify how any WEP keys present in the setting are interpreted. There are no standards governing how to hash the various WEP key/passphrase formats into the actual WEP key. Unfortunately some WEP keys can be interpreted in multiple ways, requiring the setting to specify how to interpret the any WEP keys. For example, the key “732f2d712e4a394a375d366931” is both a valid Hexadecimal WEP key and a WEP passphrase. Further, many ASCII keys are also valid WEP passphrases, but since passphrases and ASCII keys are hashed differently to determine the actual WEP key the type must be specified.

UNKNOWN = 0

unknown WEP key type

KEY = 1

indicates a hexadecimal or ASCII formatted WEP key. Hex keys are either 10 or 26 hexadecimal characters (ie “5f782f2f5f” or “732f2d712e4a394a375d366931”), while ASCII keys are either 5 or 13 ASCII characters (ie “abcde” or “blahblah99$*1”).

PASSPHRASE = 2

indicates a WEP passphrase (ex “I bought a duck on my way back from the market 235Q&^%^*%”) instead of a hexadecimal or ASCII key. Passphrases are between 8 and 64 characters inclusive and are hashed the actual WEP key using the MD5 hash algorithm.

class NM.WimaxNspNetworkType(value)

Bases: GObject.GEnum

WiMAX network type.

UNKNOWN = 0

unknown network type

HOME = 1

home network

PARTNER = 2

partner network

ROAMING_PARTNER = 3

roaming partner network