org.freedesktop.NetworkManager.Connection.Active: NetworkManager Reference Manual

- - -

org.freedesktop.NetworkManager.Connection.Active

org.freedesktop.NetworkManager.Connection.Active — Active Connection.

Signals

-StateChanged (u state,
-              u reason);
-

Properties

-Connection      readable   o
-SpecificObject  readable   o
-Id              readable   s
-Uuid            readable   s
-Type            readable   s
-Devices         readable   ao
-State           readable   u
-StateFlags      readable   u
-Default         readable   b
-Ip4Config       readable   o
-Dhcp4Config     readable   o
-Default6        readable   b
-Ip6Config       readable   o
-Dhcp6Config     readable   o
-Vpn             readable   b
-Controller      readable   o
-Master          readable   o
-

Description

-Objects that implement the Connection.Active interface represent an -attempt to connect to a network using the details provided by a Connection -object. The Connection.Active object tracks the life-cycle of the -connection attempt and if successful indicates whether the connected -network is the "default" or preferred network for access. NetworkManager -has the concept of connections, which can be thought of as settings, a -profile or a configuration that can be applied on a networking device. -Such settings-connections are exposed as D-Bus object and the -active-connection expresses this relationship between device and -settings-connection. At any time a settings-connection can only be -activated on one device and vice versa. However, during activation and -deactivation multiple active-connections can reference the same device or -settings-connection as they are waiting to be activated or to be -deactivated. -

Signal Details

The "StateChanged" signal

-StateChanged (u state,
-              u reason);
-

-Emitted when the state of the active connection has changed. -

---- - - - - - - - - - - -

`u state`:	-(NMActiveConnectionState) The new state of the active connection. -
`u reason`:	-(NMActiveConnectionStateReason) Reason code describing the change to the new state. -

Since 1.8

Property Details

The "Connection" property

-Connection  readable   o
-

-The path of the connection. -

The "SpecificObject" property

-SpecificObject  readable   o
-

-A specific object associated with the active connection. This property -reflects the specific object used during connection activation, and will -not change over the lifetime of the ActiveConnection once set. -

The "Id" property

-Id  readable   s
-

-The ID of the connection, provided as a convenience so that clients do not -have to retrieve all connection details. -

The "Uuid" property

-Uuid  readable   s
-

-The UUID of the connection, provided as a convenience so that clients do -not have to retrieve all connection details. -

The "Type" property

-Type  readable   s
-

-The type of the connection, provided as a convenience so that clients do -not have to retrieve all connection details. -

The "Devices" property

-Devices  readable   ao
-

-Array of object paths representing devices which are part of this active -connection. -

The "State" property

-State  readable   u
-

-The state of this active connection. -

-Returns: NMActiveConnectionState -

The "StateFlags" property

-StateFlags  readable   u
-

-The state flags of this active connection. -

-Returns: NMActivationStateFlags -

The "Default" property

-Default  readable   b
-

-Whether this active connection is the default IPv4 connection, i.e. -whether it currently owns the default IPv4 route. -

The "Ip4Config" property

-Ip4Config  readable   o
-

-Object path of the Ip4Config object describing the configuration of the -connection. Only valid when the connection is in the -NM_ACTIVE_CONNECTION_STATE_ACTIVATED state. -

The "Dhcp4Config" property

-Dhcp4Config  readable   o
-

-Object path of the Dhcp4Config object describing the DHCP options returned -by the DHCP server (assuming the connection used DHCP). Only valid when -the connection is in the NM_ACTIVE_CONNECTION_STATE_ACTIVATED state. -

The "Default6" property

-Default6  readable   b
-

-Whether this active connection is the default IPv6 connection, i.e. -whether it currently owns the default IPv6 route. -

The "Ip6Config" property

-Ip6Config  readable   o
-

-Object path of the Ip6Config object describing the configuration of the -connection. Only valid when the connection is in the -NM_ACTIVE_CONNECTION_STATE_ACTIVATED state. -

The "Dhcp6Config" property

-Dhcp6Config  readable   o
-

-Object path of the Dhcp6Config object describing the DHCP options returned -by the DHCP server (assuming the connection used DHCP). Only valid when -the connection is in the NM_ACTIVE_CONNECTION_STATE_ACTIVATED state. -

The "Vpn" property

-Vpn  readable   b
-

-Whether this active connection is also a VPN connection. -

The "Controller" property

-Controller  readable   o
-

-The path to the controller device if the connection is a port. This -property replaces the deprecated 'Master' property. -

The "Master" property

-Master  readable   o
-

-The path to the controller device if the connection is a port. -

-DEPRECATED. This property is deprecated in favor of the 'Controller' -property since 1.44. -