|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
<html>
|
|
Packit |
5756e2 |
<head>
|
|
Packit |
5756e2 |
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
|
Packit |
5756e2 |
<title>org.freedesktop.NetworkManager.Connection.Active: NetworkManager Reference Manual</title>
|
|
Packit |
5756e2 |
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
|
|
Packit |
5756e2 |
<link rel="home" href="index.html" title="NetworkManager Reference Manual">
|
|
Packit |
5756e2 |
<link rel="up" href="ref-dbus-active-connections.html" title="The /org/freedesktop/NetworkManager/ActiveConnection/* objects">
|
|
Packit |
5756e2 |
<link rel="prev" href="ref-dbus-active-connections.html" title="The /org/freedesktop/NetworkManager/ActiveConnection/* objects">
|
|
Packit |
5756e2 |
<link rel="next" href="gdbus-org.freedesktop.NetworkManager.VPN.Connection.html" title="org.freedesktop.NetworkManager.VPN.Connection">
|
|
Packit Service |
dff8e4 |
<meta name="generator" content="GTK-Doc V1.33.0 (XML mode)">
|
|
Packit |
5756e2 |
<link rel="stylesheet" href="style.css" type="text/css">
|
|
Packit |
5756e2 |
</head>
|
|
Packit |
5756e2 |
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
Top |
|
|
Packit |
5756e2 |
Description |
|
|
Packit |
5756e2 |
Properties |
|
|
Packit |
5756e2 |
Signals
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
![Home](home.png)
|
|
Packit |
5756e2 |
![Up](up.png)
|
|
Packit |
5756e2 |
![Prev](left.png)
|
|
Packit |
5756e2 |
![Next](right.png)
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
org.freedesktop.NetworkManager.Connection.Active
|
|
Packit |
5756e2 |
org.freedesktop.NetworkManager.Connection.Active — Active Connection
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
Signals
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
StateChanged (u state,
|
|
Packit |
5756e2 |
u reason);
|
|
Packit |
5756e2 |
PropertiesChanged (a{sv} properties);
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
Properties
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
Connection readable o
|
|
Packit |
5756e2 |
SpecificObject readable o
|
|
Packit |
5756e2 |
Id readable s
|
|
Packit |
5756e2 |
Uuid readable s
|
|
Packit |
5756e2 |
Type readable s
|
|
Packit |
5756e2 |
Devices readable ao
|
|
Packit |
5756e2 |
State readable u
|
|
Packit |
5756e2 |
StateFlags readable u
|
|
Packit |
5756e2 |
Default readable b
|
|
Packit |
5756e2 |
Ip4Config readable o
|
|
Packit |
5756e2 |
Dhcp4Config readable o
|
|
Packit |
5756e2 |
Default6 readable b
|
|
Packit |
5756e2 |
Ip6Config readable o
|
|
Packit |
5756e2 |
Dhcp6Config readable o
|
|
Packit |
5756e2 |
Vpn readable b
|
|
Packit |
5756e2 |
Master readable o
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
Description
|
|
Packit |
5756e2 |
Objects that implement the Connection.Active interface represent an
|
|
Packit |
5756e2 |
attempt to connect to a network using the details provided by a Connection
|
|
Packit |
5756e2 |
object. The Connection.Active object tracks the life-cycle of the
|
|
Packit |
5756e2 |
connection attempt and if successful indicates whether the connected
|
|
Packit |
5756e2 |
network is the "default" or preferred network for access. NetworkManager
|
|
Packit |
5756e2 |
has the concept of connections, which can be thought of as settings, a
|
|
Packit |
5756e2 |
profile or a configuration that can be applied on a networking device.
|
|
Packit |
5756e2 |
Such settings-connections are exposed as D-Bus object and the
|
|
Packit |
5756e2 |
active-connection expresses this relationship between device and
|
|
Packit |
5756e2 |
settings-connection. At any time a settings-connection can only be
|
|
Packit |
5756e2 |
activated on one device and vice versa. However, during activation and
|
|
Packit |
5756e2 |
deactivation multiple active-connections can reference the same device or
|
|
Packit |
5756e2 |
settings-connection as they are waiting to be activated or to be
|
|
Packit |
5756e2 |
deactivated.
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
Signal Details
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
The "StateChanged" signal
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
StateChanged (u state,
|
|
Packit |
5756e2 |
u reason);
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
Emitted when the state of the active connection has changed.
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
Since: 1.8
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
u state :
|
|
Packit |
5756e2 |
(NMActiveConnectionState) The new state of the active connection.
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
u reason :
|
|
Packit |
5756e2 |
(NMActiveConnectionStateReason) Reason code describing the change to the new state.
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
The "PropertiesChanged" signal
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
PropertiesChanged (a{sv} properties);
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
DEPRECATED. Use the standard "PropertiesChanged" signal from "org.freedesktop.DBus.Properties" instead which exists since version NetworkManager 1.2.0.
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
a{sv} properties :
|
|
Packit |
5756e2 |
A dictionary mapping property names to variant boxed values
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
Property Details
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
The "Connection" property
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
Connection readable o
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
The path of the connection.
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
The "SpecificObject" property
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
SpecificObject readable o
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
A specific object associated with the active connection. This property
|
|
Packit |
5756e2 |
reflects the specific object used during connection activation, and will
|
|
Packit |
5756e2 |
not change over the lifetime of the ActiveConnection once set.
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
The "Id" property
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
Id readable s
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
The ID of the connection, provided as a convenience so that clients do not
|
|
Packit |
5756e2 |
have to retrieve all connection details.
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
The "Uuid" property
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
Uuid readable s
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
The UUID of the connection, provided as a convenience so that clients do
|
|
Packit |
5756e2 |
not have to retrieve all connection details.
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
The "Type" property
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
Type readable s
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
The type of the connection, provided as a convenience so that clients do
|
|
Packit |
5756e2 |
not have to retrieve all connection details.
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
The "Devices" property
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
Devices readable ao
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
Array of object paths representing devices which are part of this active
|
|
Packit |
5756e2 |
connection.
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
The "State" property
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
State readable u
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
The state of this active connection.
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
Returns: NMActiveConnectionState
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
The "StateFlags" property
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
StateFlags readable u
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
The state flags of this active connection.
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
Returns: NMActivationStateFlags
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
The "Default" property
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
Default readable b
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
Whether this active connection is the default IPv4 connection, i.e.
|
|
Packit |
5756e2 |
whether it currently owns the default IPv4 route.
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
The "Ip4Config" property
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
Ip4Config readable o
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
Object path of the Ip4Config object describing the configuration of the
|
|
Packit |
5756e2 |
connection. Only valid when the connection is in the
|
|
Packit |
5756e2 |
NM_ACTIVE_CONNECTION_STATE_ACTIVATED state.
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
The "Dhcp4Config" property
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
Dhcp4Config readable o
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
Object path of the Dhcp4Config object describing the DHCP options returned
|
|
Packit |
5756e2 |
by the DHCP server (assuming the connection used DHCP). Only valid when
|
|
Packit |
5756e2 |
the connection is in the NM_ACTIVE_CONNECTION_STATE_ACTIVATED state.
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
The "Default6" property
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
Default6 readable b
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
Whether this active connection is the default IPv6 connection, i.e.
|
|
Packit |
5756e2 |
whether it currently owns the default IPv6 route.
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
The "Ip6Config" property
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
Ip6Config readable o
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
Object path of the Ip6Config object describing the configuration of the
|
|
Packit |
5756e2 |
connection. Only valid when the connection is in the
|
|
Packit |
5756e2 |
NM_ACTIVE_CONNECTION_STATE_ACTIVATED state.
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
The "Dhcp6Config" property
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
Dhcp6Config readable o
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
Object path of the Dhcp6Config object describing the DHCP options returned
|
|
Packit |
5756e2 |
by the DHCP server (assuming the connection used DHCP). Only valid when
|
|
Packit |
5756e2 |
the connection is in the NM_ACTIVE_CONNECTION_STATE_ACTIVATED state.
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
The "Vpn" property
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
Vpn readable b
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
Whether this active connection is also a VPN connection.
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
The "Master" property
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
Master readable o
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
The path to the master device if the connection is a slave.
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit Service |
dff8e4 |
Generated by GTK-Doc V1.33.0
|
|
Packit |
5756e2 |
</body>
|
|
Packit |
5756e2 |
</html>
|