<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=ascii" /><title>NetworkManager D-Bus Interface Specification version 0.8.5.92</title><style type="text/css">
body {
font-family: sans-serif;
margin: 2em;
height: 100%;
font-size: 1.2em;
}
h1 {
padding-top: 5px;
padding-bottom: 5px;
font-size: 1.6em;
background: #dadae2;
}
h2 {
font-size: 1.3em;
}
h3 {
font-size: 1.2em;
}
a:link, a:visited, a:link:hover, a:visited:hover {
font-weight: bold;
}
.topbox {
padding-top: 10px;
padding-left: 10px;
border-bottom: black solid 1px;
padding-bottom: 10px;
background: #dadae2;
font-size: 2em;
font-weight: bold;
color: #5c5c5c;
}
.topnavbox {
padding-left: 10px;
padding-top: 5px;
padding-bottom: 5px;
background: #abacba;
border-bottom: black solid 1px;
font-size: 1.2em;
}
.topnavbox a{
color: black;
font-weight: normal;
}
.sidebar {
float: left;
/* width:9em;
border-right:#abacba solid 1px;
border-left: #abacba solid 1px;
height:100%; */
border: #abacba solid 1px;
padding-left: 10px;
margin-left: 10px;
padding-right: 10px;
margin-right: 10px;
color: #5d5d5d;
background: #dadae2;
}
.sidebar a {
text-decoration: none;
border-bottom: #e29625 dotted 1px;
color: #e29625;
font-weight: normal;
}
.sidebar h1 {
font-size: 1.2em;
color: black;
}
.sidebar ul {
padding-left: 25px;
padding-bottom: 10px;
border-bottom: #abacba solid 1px;
}
.sidebar li {
padding-top: 2px;
padding-bottom: 2px;
}
.sidebar h2 {
font-style:italic;
font-size: 0.81em;
padding-left: 5px;
padding-right: 5px;
font-weight: normal;
}
.date {
font-size: 0.6em;
float: right;
font-style: italic;
}
.method {
margin-left: 1em;
margin-right: 4em;
}
.signal {
margin-left: 1em;
margin-right: 4em;
}
</style></head><body><h1 class="topbox">NetworkManager D-Bus Interface Specification</h1><h2>Version 0.8.5.92</h2><div>Copyright (C) 2008 - 2011 Red Hat, Inc.</div><div>Copyright (C) 2008 - 2009 Novell, Inc.</div><div class="license">
<p>This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.</p>
<p>This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
General Public License for more details.</p>
<p>You should have received a copy of the GNU Lesser General Public
License along with this library; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</p>
</div><h2>Interfaces</h2><ul><li><code><a href="#org.freedesktop.NetworkManager">org.freedesktop.NetworkManager</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.AccessPoint">org.freedesktop.NetworkManager.AccessPoint</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.Device">org.freedesktop.NetworkManager.Device</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.Device.Wired">org.freedesktop.NetworkManager.Device.Wired</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.Device.Wireless">org.freedesktop.NetworkManager.Device.Wireless</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.Device.Cdma">org.freedesktop.NetworkManager.Device.Cdma</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.Device.Gsm">org.freedesktop.NetworkManager.Device.Gsm</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.Device.Serial">org.freedesktop.NetworkManager.Device.Serial</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.Device.Bluetooth">org.freedesktop.NetworkManager.Device.Bluetooth</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.Device.OlpcMesh">org.freedesktop.NetworkManager.Device.OlpcMesh</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.IP4Config">org.freedesktop.NetworkManager.IP4Config</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.IP6Config">org.freedesktop.NetworkManager.IP6Config</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.DHCP4Config">org.freedesktop.NetworkManager.DHCP4Config</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.DHCP6Config">org.freedesktop.NetworkManager.DHCP6Config</a></code></li><li><code><a href="#org.freedesktop.NetworkManagerSettings">org.freedesktop.NetworkManagerSettings</a></code></li><li><code><a href="#org.freedesktop.NetworkManagerSettings.System">org.freedesktop.NetworkManagerSettings.System</a></code></li><li><code><a href="#org.freedesktop.NetworkManagerSettings.Connection">org.freedesktop.NetworkManagerSettings.Connection</a></code></li><li><code><a href="#org.freedesktop.NetworkManagerSettings.Connection.Secrets">org.freedesktop.NetworkManagerSettings.Connection.Secrets</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.Connection.Active">org.freedesktop.NetworkManager.Connection.Active</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.VPN.Connection">org.freedesktop.NetworkManager.VPN.Connection</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.VPN.Plugin">org.freedesktop.NetworkManager.VPN.Plugin</a></code></li></ul>
<h1><a name="org.freedesktop.NetworkManager" id="org.freedesktop.NetworkManager"></a>org.freedesktop.NetworkManager</h1><h2>Methods:</h2><div class="method"><h3><a name="org.freedesktop.NetworkManager.GetDevices" id="org.freedesktop.NetworkManager.GetDevices">GetDevices</a> (
) →
ao</h3><div class="docstring">
Get the list of network devices.
</div><div><h4>Returns</h4><dl><dt><code>devices</code> -
<code>ao</code></dt><dd>
List of object paths of network devices known to the system.
</dd></dl></div></div><div class="method"><h3><a name="org.freedesktop.NetworkManager.ActivateConnection" id="org.freedesktop.NetworkManager.ActivateConnection">ActivateConnection</a> (
s: service_name, o: connection, o: device, o: specific_object
) →
o</h3><div class="docstring">
Activate a connection using the supplied device.
</div><div><h4>Parameters</h4><dl><dt><code>service_name</code> -
<code>s</code></dt><dd>
The D-Bus service name of the settings service that provides this connection.
</dd><dt><code>connection</code> -
<code>o</code></dt><dd>
The connection to activate the devices with.
</dd><dt><code>device</code> -
<code>o</code></dt><dd>
The object path of device to be activated for physical connections. This parameter is ignored for VPN connections, because the specific_object (if provided) specifies the device to use.
</dd><dt><code>specific_object</code> -
<code>o</code></dt><dd>
The path of a connection-type-specific object this activation should use.
This parameter is currently ignored for wired and mobile broadband connections,
and the value of "/" should be used (ie, no specific object). For WiFi
connections, pass the object path of a specific AP from the card's scan
list, or "/" to pick and AP automatically. For VPN connections, pass
the object path of an ActiveConnection object that should serve as the
"base" connection (to which the VPN connections lifetime will be tied),
or pass "/" and NM will automatically use the current default device.
</dd></dl></div><div><h4>Returns</h4><dl><dt><code>active_connection</code> -
<code>o</code></dt><dd>
The path of the active connection object representing this active connection.
</dd></dl></div><div><h4>Possible errors</h4><dl><dt><code>org.freedesktop.NetworkManager.Error.UnknownConnection</code></dt><dd>
Connection was not provided by any known settings service.
<em>(generic description)</em></dd><dt><code>org.freedesktop.NetworkManager.Error.UnknownDevice</code></dt><dd>
Unknown device.
<em>(generic description)</em></dd><dt><code>org.freedesktop.NetworkManager.Error.InvalidService</code></dt><dd>
Invalid settings service (not a recognized system or user settings service name).
<em>(generic description)</em></dd><dt><code>org.freedesktop.NetworkManager.Error.ConnectionActivating</code></dt><dd>Another connection is already activating or the same connection is already active. FIXME: check if the error name is correct. FIXME: split into 2 errors?</dd><dt><code>org.freedesktop.NetworkManager.Error.ConnectionInvalid</code></dt><dd>The connection is invalid for this device.</dd></dl></div></div><div class="method"><h3><a name="org.freedesktop.NetworkManager.DeactivateConnection" id="org.freedesktop.NetworkManager.DeactivateConnection">DeactivateConnection</a> (
o: active_connection
) →
nothing</h3><div class="docstring">
Deactivate an active connection.
</div><div><h4>Parameters</h4><dl><dt><code>active_connection</code> -
<code>o</code></dt><dd>
The currently active connection to deactivate.
</dd></dl></div></div><div class="method"><h3><a name="org.freedesktop.NetworkManager.Sleep" id="org.freedesktop.NetworkManager.Sleep">Sleep</a> (
b: sleep
) →
nothing</h3><div class="docstring">
Control the NetworkManager daemon's sleep state. When asleep, all
interfaces that it manages are deactivated. When awake, devices are
available to be activated. This command should not be called directly
by users or clients; it is intended for system suspend/resume tracking.
</div><div><h4>Parameters</h4><dl><dt><code>sleep</code> -
<code>b</code></dt><dd>
Indicates whether the NetworkManager daemon should sleep or wake.
</dd></dl></div></div><div class="method"><h3><a name="org.freedesktop.NetworkManager.Enable" id="org.freedesktop.NetworkManager.Enable">Enable</a> (
b: enable
) →
nothing</h3><div class="docstring">
Control whether overall networking is enabled or disabled. When
disabled, all interfaces that NM manages are deactivated. When enabled,
all managed interfaces are re-enabled and available to be activated.
This command should be used by clients that provide to users the ability
to enable/disable all networking.
</div><div><h4>Parameters</h4><dl><dt><code>enable</code> -
<code>b</code></dt><dd>
If FALSE, indicates that all networking should be disabled. If TRUE,
indicates that NetworkManager should begin managing network devices.
</dd></dl></div></div><div class="method"><h3><a name="org.freedesktop.NetworkManager.GetPermissions" id="org.freedesktop.NetworkManager.GetPermissions">GetPermissions</a> (
) →
a{ss}</h3><div class="docstring">
Returns the permissions a caller has for various authenticated operations
that NetworkManager provides, like Enable/Disable networking, changing
WiFi, WWAN, and WiMAX state, etc.
</div><div><h4>Returns</h4><dl><dt><code>permissions</code> -
<code>a{ss}</code></dt><dd>
Dictionary of available permissions and results. Each permission
is represented by a name (ie "org.freedesktop.NetworkManager.Foobar")
and each result is one of the following values: "yes" (the permission
is available), "auth" (the permission is available after a successful
authentication), or "no" (the permission is denied). Clients may use
these values in the UI to indicate the ability to perform certain
operations.
</dd></dl></div></div><div class="method"><h3><a name="org.freedesktop.NetworkManager.SetLogging" id="org.freedesktop.NetworkManager.SetLogging">SetLogging</a> (
s: level, s: domains
) →
nothing</h3><div class="docstring">
Set logging verbosity and which operations are logged.
</div><div><h4>Parameters</h4><dl><dt><code>level</code> -
<code>s</code></dt><dd>
One of [ERR, WARN, INFO, DEBUG].
</dd><dt><code>domains</code> -
<code>s</code></dt><dd>
A combination of logging domains separated by commas (','), or "NONE"
to disable logging. Each domain enables logging for operations
related to that domain. Available domains are: [NONE, HW, RFKILL,
ETHER, WIFI, BT, MB, DHCP4, DHCP6, PPP, WIFI_SCAN, IP4, IP6, AUTOIP4,
DNS, VPN, SHARING, SUPPLICANT, USER_SET, SYS_SET, SUSPEND, CORE,
DEVICE, OLPC]. If an empty string is given, the log level is changed
but the current set of log domains remains unchanged.
</dd></dl></div></div><div class="method"><h3><a name="org.freedesktop.NetworkManager.sleep" id="org.freedesktop.NetworkManager.sleep">sleep</a> (
) →
nothing</h3><div class="docstring">
DEPRECATED. Control the NetworkManager daemon's sleep state. When asleep, all interfaces that it manages are deactivated.
</div></div><div class="method"><h3><a name="org.freedesktop.NetworkManager.wake" id="org.freedesktop.NetworkManager.wake">wake</a> (
) →
nothing</h3><div class="docstring">
DEPRECATED. Control the NetworkManager daemon's sleep state. When awake, all known interfaces are available to be activated.
</div></div><div class="method"><h3><a name="org.freedesktop.NetworkManager.state" id="org.freedesktop.NetworkManager.state">state</a> (
) →
u</h3><div class="docstring">
DEPRECATED. The overall state of the NetworkManager daemon.
</div><div><h4>Returns</h4><dl><dt><code>state</code> -
<code>u</code>
(<a xmlns="" href="#type-NM_STATE">NM_STATE</a>)
</dt><dd></dd></dl></div></div><h2>Signals:</h2><div class="signal"><h3><a name="org.freedesktop.NetworkManager.CheckPermissions" id="org.freedesktop.NetworkManager.CheckPermissions">CheckPermissions</a> (
)</h3><div class="docstring">
Emitted when system authorization details change, indicating that
clients may wish to recheck permissions with GetPermissions.
</div></div><div class="signal"><h3><a name="org.freedesktop.NetworkManager.StateChanged" id="org.freedesktop.NetworkManager.StateChanged">StateChanged</a> (
u: state
)</h3><div class="docstring">
NetworkManager's state changed.
</div><div><h4>Parameters</h4><dl><dt><code>state</code> -
<code>u</code>
(<a xmlns="" href="#type-NM_STATE">NM_STATE</a>)
</dt><dd>
The new state of NetworkManager.
</dd></dl></div></div><div class="signal"><h3><a name="org.freedesktop.NetworkManager.PropertiesChanged" id="org.freedesktop.NetworkManager.PropertiesChanged">PropertiesChanged</a> (
a{sv}: properties
)</h3><div class="docstring">
NetworkManager's properties changed.
</div><div><h4>Parameters</h4><dl><dt><code>properties</code> -
<code>a{sv}</code>
(<a xmlns="" href="#type-String_Variant_Map">String_Variant_Map</a>)
</dt><dd>
The changed properties.
</dd></dl></div></div><div class="signal"><h3><a name="org.freedesktop.NetworkManager.DeviceAdded" id="org.freedesktop.NetworkManager.DeviceAdded">DeviceAdded</a> (
o: device_path
)</h3><div class="docstring">
A device was added to the system
</div><div><h4>Parameters</h4><dl><dt><code>device_path</code> -
<code>o</code></dt><dd>
The object path of the newly added device.
</dd></dl></div></div><div class="signal"><h3><a name="org.freedesktop.NetworkManager.DeviceRemoved" id="org.freedesktop.NetworkManager.DeviceRemoved">DeviceRemoved</a> (
o: device_path
)</h3><div class="docstring">
A device was removed from the system, and is no longer available.
</div><div><h4>Parameters</h4><dl><dt><code>device_path</code> -
<code>o</code></dt><dd>
The object path of the device that was just removed.
</dd></dl></div></div><div class="signal"><h3><a name="org.freedesktop.NetworkManager.StateChange" id="org.freedesktop.NetworkManager.StateChange">StateChange</a> (
u: state
)</h3><div class="docstring">
DEPRECATED. NetworkManager's state changed. Use the 'StateChanged' signal instead.
</div><div><h4>Parameters</h4><dl><dt><code>state</code> -
<code>u</code>
(<a xmlns="" href="#type-NM_STATE">NM_STATE</a>)
</dt><dd>
The new state of NetworkManager.
</dd></dl></div></div><h2>Properties:</h2><dl><dt><code>NetworkingEnabled</code> -
<code>b</code> -
<code>(read)</code></dt><dd>
Indicates if overall networking is currently enabled or not. See the
Enable() method.
</dd><dt><code>WirelessEnabled</code> -
<code>b</code> -
<code>(readwrite)</code></dt><dd>
Indicates if wireless is currently enabled or not.
</dd><dt><code>WirelessHardwareEnabled</code> -
<code>b</code> -
<code>(read)</code></dt><dd>
Indicates if the wireless hardware is currently enabled, i.e. the state of the RF kill switch.
</dd><dt><code>WwanEnabled</code> -
<code>b</code> -
<code>(readwrite)</code></dt><dd>
Indicates if mobile broadband devices are currently enabled or not.
</dd><dt><code>WwanHardwareEnabled</code> -
<code>b</code> -
<code>(read)</code></dt><dd>
Indicates if the mobile broadband hardware is currently enabled, i.e. the state of the RF kill switch.
</dd><dt><code>ActiveConnections</code> -
<code>ao</code> -
<code>(read)</code></dt><dd>
List of active connection object paths.
</dd><dt><code>Version</code> -
<code>s</code> -
<code>(read)</code></dt><dd>
NetworkManager version.
</dd><dt><code>State</code> -
<code>u</code> -
<code>(read)</code>
(<a xmlns="" href="#type-NM_STATE">NM_STATE</a>)
</dt><dd>
The overall state of the NetworkManager daemon.
</dd></dl><h2>Enumerated types:</h2><h3><a name="type-NM_STATE" id="type-NM_STATE">NM_STATE</a></h3>
Describes the overall state of the daemon.
<dl><dt><code>NM_STATE_UNKNOWN = 0</code></dt><dd>
The NetworkManager daemon is in an unknown state.
</dd><dt><code>NM_STATE_ASLEEP = 1</code></dt><dd>
The NetworkManager daemon is asleep and all interfaces managed by it are inactive.
</dd><dt><code>NM_STATE_CONNECTING = 2</code></dt><dd>
The NetworkManager daemon is connecting a device. FIXME: What does this mean when one device is active and another is connecting?
</dd><dt><code>NM_STATE_CONNECTED = 3</code></dt><dd>
The NetworkManager daemon is connected.
</dd><dt><code>NM_STATE_DISCONNECTED = 4</code></dt><dd>
The NetworkManager daemon is disconnected.
</dd></dl>
<h1><a name="org.freedesktop.NetworkManager.AccessPoint" id="org.freedesktop.NetworkManager.AccessPoint"></a>org.freedesktop.NetworkManager.AccessPoint</h1><p>Interface has no methods.</p><h2>Signals:</h2><div class="signal"><h3><a name="org.freedesktop.NetworkManager.AccessPoint.PropertiesChanged" id="org.freedesktop.NetworkManager.AccessPoint.PropertiesChanged">PropertiesChanged</a> (
a{sv}: properties
)</h3><div class="docstring"></div><div><h4>Parameters</h4><dl><dt><code>properties</code> -
<code>a{sv}</code>
(<a xmlns="" href="#type-String_Variant_Map">String_Variant_Map</a>)
</dt><dd>
A dictionary mapping property names to variant boxed values
</dd></dl></div></div><h2>Properties:</h2><dl><dt><code>Flags</code> -
<code>u</code> -
<code>(read)</code>
(<a xmlns="" href="#type-NM_802_11_AP_FLAGS">NM_802_11_AP_FLAGS</a>)
</dt><dd>Flags describing the capabilities of the access point.</dd><dt><code>WpaFlags</code> -
<code>u</code> -
<code>(read)</code>
(<a xmlns="" href="#type-NM_802_11_AP_SEC">NM_802_11_AP_SEC</a>)
</dt><dd>Flags describing the access point's capabilities according to WPA (Wifi Protected Access).</dd><dt><code>RsnFlags</code> -
<code>u</code> -
<code>(read)</code>
(<a xmlns="" href="#type-NM_802_11_AP_SEC">NM_802_11_AP_SEC</a>)
</dt><dd>Flags describing the access point's capabilities according to the RSN (Robust Secure Network) protocol.</dd><dt><code>Ssid</code> -
<code>ay</code> -
<code>(read)</code></dt><dd>The Service Set Identifier identifying the access point.</dd><dt><code>Frequency</code> -
<code>u</code> -
<code>(read)</code></dt><dd>The radio channel frequency in use by the access point, in MHz.</dd><dt><code>HwAddress</code> -
<code>s</code> -
<code>(read)</code></dt><dd>The hardware address (BSSID) of the access point.</dd><dt><code>Mode</code> -
<code>u</code> -
<code>(read)</code>
(<a xmlns="" href="#type-NM_802_11_MODE">NM_802_11_MODE</a>)
</dt><dd>Describes the operating mode of the access point.</dd><dt><code>MaxBitrate</code> -
<code>u</code> -
<code>(read)</code></dt><dd>The maximum bitrate this access point is capable of, in kilobits/second (Kb/s).</dd><dt><code>Strength</code> -
<code>y</code> -
<code>(read)</code></dt><dd>The current signal quality of the access point, in percent.</dd></dl><h2>Sets of flags:</h2><h3 xmlns=""><a name="type-NM_802_11_AP_FLAGS" id="type-NM_802_11_AP_FLAGS">NM_802_11_AP_FLAGS</a></h3>
Flags describing the general capabilities of the access point.
<dl><dt><code>NM_802_11_AP_FLAGS_NONE = 0x0</code></dt><dd>Null capability - says nothing about the access point.</dd><dt><code>NM_802_11_AP_FLAGS_PRIVACY = 0x1</code></dt><dd>Access point supports privacy measures.</dd></dl><h3 xmlns=""><a name="type-NM_802_11_AP_SEC" id="type-NM_802_11_AP_SEC">NM_802_11_AP_SEC</a></h3>
Flags describing the security capabilities of the access point.
<dl><dt><code>NM_802_11_AP_SEC_NONE = 0x0</code></dt><dd>Null flag.</dd><dt><code>NM_802_11_AP_SEC_PAIR_WEP40 = 0x1</code></dt><dd>Access point supports pairwise 40-bit WEP encryption.</dd><dt><code>NM_802_11_AP_SEC_PAIR_WEP104 = 0x2</code></dt><dd>Access point supports pairwise 104-bit WEP encryption.</dd><dt><code>NM_802_11_AP_SEC_PAIR_TKIP = 0x4</code></dt><dd>Access point supports pairwise TKIP encryption.</dd><dt><code>NM_802_11_AP_SEC_PAIR_CCMP = 0x8</code></dt><dd>Access point supports pairwise CCMP encryption.</dd><dt><code>NM_802_11_AP_SEC_GROUP_WEP40 = 0x10</code></dt><dd>Access point supports a group 40-bit WEP cipher.</dd><dt><code>NM_802_11_AP_SEC_GROUP_WEP104 = 0x20</code></dt><dd>Access point supports a group 104-bit WEP cipher.</dd><dt><code>NM_802_11_AP_SEC_GROUP_TKIP = 0x40</code></dt><dd>Access point supports a group TKIP cipher.</dd><dt><code>NM_802_11_AP_SEC_GROUP_CCMP = 0x80</code></dt><dd>Access point supports a group CCMP cipher.</dd><dt><code>NM_802_11_AP_SEC_KEY_MGMT_PSK = 0x100</code></dt><dd>Access point supports PSK key management.</dd><dt><code>NM_802_11_AP_SEC_KEY_MGMT_802_1X = 0x200</code></dt><dd>Access point supports 802.1x key management.</dd></dl>
<h1><a name="org.freedesktop.NetworkManager.Device" id="org.freedesktop.NetworkManager.Device"></a>org.freedesktop.NetworkManager.Device</h1><h2>Methods:</h2><div class="method"><h3><a name="org.freedesktop.NetworkManager.Device.Disconnect" id="org.freedesktop.NetworkManager.Device.Disconnect">Disconnect</a> (
) →
nothing</h3><div class="docstring">
Disconnects a device and prevents the device from automatically activating further connections without user intervention.
</div></div><h2>Signals:</h2><div class="signal"><h3><a name="org.freedesktop.NetworkManager.Device.StateChanged" id="org.freedesktop.NetworkManager.Device.StateChanged">StateChanged</a> (
u: new_state, u: old_state, u: reason
)</h3><div class="docstring"></div><div><h4>Parameters</h4><dl><dt><code>new_state</code> -
<code>u</code>
(<a xmlns="" href="#type-NM_DEVICE_STATE">NM_DEVICE_STATE</a>)
</dt><dd>
The new state of the device.
</dd><dt><code>old_state</code> -
<code>u</code>
(<a xmlns="" href="#type-NM_DEVICE_STATE">NM_DEVICE_STATE</a>)
</dt><dd>
The previous state of the device.
</dd><dt><code>reason</code> -
<code>u</code>
(<a xmlns="" href="#type-NM_DEVICE_STATE_REASON">NM_DEVICE_STATE_REASON</a>)
</dt><dd>
A reason for the state transition.
</dd></dl></div></div><h2>Properties:</h2><dl><dt><code>Udi</code> -
<code>s</code> -
<code>(read)</code></dt><dd>
Unique Device Identifier.
</dd><dt><code>Interface</code> -
<code>s</code> -
<code>(read)</code></dt><dd>
The name of the device's control (and often data) interface.
</dd><dt><code>IpInterface</code> -
<code>s</code> -
<code>(read)</code></dt><dd>
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.
</dd><dt><code>Driver</code> -
<code>s</code> -
<code>(read)</code></dt><dd>
The driver handling the device.
</dd><dt><code>Capabilities</code> -
<code>u</code> -
<code>(read)</code>
(<a xmlns="" href="#type-NM_DEVICE_CAP">NM_DEVICE_CAP</a>)
</dt><dd>
Flags describing the capabilities of the device.
</dd><dt><code>Ip4Address</code> -
<code>i</code> -
<code>(read)</code></dt><dd>
The IPv4 address bound to the device. FIXME: what about devices with >1 IP address?
</dd><dt><code>State</code> -
<code>u</code> -
<code>(read)</code>
(<a xmlns="" href="#type-NM_DEVICE_STATE">NM_DEVICE_STATE</a>)
</dt><dd>
The current state of the device.
</dd><dt><code>Ip4Config</code> -
<code>o</code> -
<code>(read)</code></dt><dd>
Object path of the Ip4Config object describing the configuration of the device. Only valid when the device is in the NM_DEVICE_STATE_ACTIVATED state.
</dd><dt><code>Dhcp4Config</code> -
<code>o</code> -
<code>(read)</code></dt><dd>
Object path of the Dhcp4Config object describing the DHCP options returned by the DHCP server. Only valid when the device is in the NM_DEVICE_STATE_ACTIVATED state.
</dd><dt><code>Ip6Config</code> -
<code>o</code> -
<code>(read)</code></dt><dd>
Object path of the Ip6Config object describing the configuration of the device. Only valid when the device is in the NM_DEVICE_STATE_ACTIVATED state.
</dd><dt><code>Dhcp6Config</code> -
<code>o</code> -
<code>(read)</code></dt><dd>
Object path of the Dhcp6Config object describing the DHCP options
returned by the DHCP server. Only valid when the device is in the
NM_DEVICE_STATE_ACTIVATED state.
</dd><dt><code>Managed</code> -
<code>b</code> -
<code>(read)</code></dt><dd>
Whether or not this device is managed by NetworkManager.
</dd><dt><code>FirmwareMissing</code> -
<code>b</code> -
<code>(read)</code></dt><dd>
If TRUE, indicates the device is likely missing firmware necessary for
its operation.
</dd><dt><code>DeviceType</code> -
<code>u</code> -
<code>(read)</code>
(<a xmlns="" href="#type-NM_DEVICE_TYPE">NM_DEVICE_TYPE</a>)
</dt><dd>
The general type of the network device; ie Ethernet, WiFi, etc.
</dd></dl><h2>Enumerated types:</h2><h3><a name="type-NM_DEVICE_STATE" id="type-NM_DEVICE_STATE">NM_DEVICE_STATE</a></h3><dl><dt><code>NM_DEVICE_STATE_UNKNOWN = 0</code></dt><dd>
The device is in an unknown state.
</dd><dt><code>NM_DEVICE_STATE_UNMANAGED = 1</code></dt><dd>
The device is not managed by NetworkManager.
</dd><dt><code>NM_DEVICE_STATE_UNAVAILABLE = 2</code></dt><dd>
The device cannot be used (carrier off, rfkill, etc).
</dd><dt><code>NM_DEVICE_STATE_DISCONNECTED = 3</code></dt><dd>
The device is not connected.
</dd><dt><code>NM_DEVICE_STATE_PREPARE = 4</code></dt><dd>
The device is preparing to connect.
</dd><dt><code>NM_DEVICE_STATE_CONFIG = 5</code></dt><dd>
The device is being configured.
</dd><dt><code>NM_DEVICE_STATE_NEED_AUTH = 6</code></dt><dd>
The device is awaiting secrets necessary to continue connection.
</dd><dt><code>NM_DEVICE_STATE_IP_CONFIG = 7</code></dt><dd>
The IP settings of the device are being requested and configured.
</dd><dt><code>NM_DEVICE_STATE_ACTIVATED = 8</code></dt><dd>
The device is active.
</dd><dt><code>NM_DEVICE_STATE_FAILED = 9</code></dt><dd>
The device is in a failure state following an attempt to activate it.
</dd></dl><h3><a name="type-NM_DEVICE_TYPE" id="type-NM_DEVICE_TYPE">NM_DEVICE_TYPE</a></h3><dl><dt><code>NM_DEVICE_TYPE_UNKNOWN = 0</code></dt><dd>
The device type is unknown.
</dd><dt><code>NM_DEVICE_TYPE_ETHERNET = 1</code></dt><dd>
The device is wired Ethernet device.
</dd><dt><code>NM_DEVICE_TYPE_WIFI = 2</code></dt><dd>
The device is an 802.11 WiFi device.
</dd><dt><code>NM_DEVICE_TYPE_GSM = 3</code></dt><dd>
The device is a GSM-based cellular WAN device.
</dd><dt><code>NM_DEVICE_TYPE_CDMA = 4</code></dt><dd>
The device is a CDMA/IS-95-based cellular WAN device.
</dd></dl><h3><a name="type-NM_DEVICE_STATE_REASON" id="type-NM_DEVICE_STATE_REASON">NM_DEVICE_STATE_REASON</a></h3><dl><dt><code>NM_DEVICE_STATE_REASON_UNKNOWN = 0</code></dt><dd>
The reason for the device state change is unknown.
</dd><dt><code>NM_DEVICE_STATE_REASON_NONE = 1</code></dt><dd>
The state change is normal.
</dd><dt><code>NM_DEVICE_STATE_REASON_NOW_MANAGED = 2</code></dt><dd>
The device is now managed.
</dd><dt><code>NM_DEVICE_STATE_REASON_NOW_UNMANAGED = 3</code></dt><dd>
The device is no longer managed.
</dd><dt><code>NM_DEVICE_STATE_REASON_CONFIG_FAILED = 4</code></dt><dd>
The device could not be readied for configuration.
</dd><dt><code>NM_DEVICE_STATE_REASON_CONFIG_UNAVAILABLE = 5</code></dt><dd>
IP configuration could not be reserved (no available address, timeout, etc).
</dd><dt><code>NM_DEVICE_STATE_REASON_CONFIG_EXPIRED = 6</code></dt><dd>
The IP configuration is no longer valid.
</dd><dt><code>NM_DEVICE_STATE_REASON_NO_SECRETS = 7</code></dt><dd>
Secrets were required, but not provided.
</dd><dt><code>NM_DEVICE_STATE_REASON_SUPPLICANT_DISCONNECT = 8</code></dt><dd>
The 802.1X supplicant disconnected from the access point or authentication server.
</dd><dt><code>NM_DEVICE_STATE_REASON_SUPPLICANT_CONFIG_FAILED = 9</code></dt><dd>
Configuration of the 802.1X supplicant failed.
</dd><dt><code>NM_DEVICE_STATE_REASON_SUPPLICANT_FAILED = 10</code></dt><dd>
The 802.1X supplicant quit or failed unexpectedly.
</dd><dt><code>NM_DEVICE_STATE_REASON_SUPPLICANT_TIMEOUT = 11</code></dt><dd>
The 802.1X supplicant took too long to authenticate.
</dd><dt><code>NM_DEVICE_STATE_REASON_PPP_START_FAILED = 12</code></dt><dd>
The PPP service failed to start within the allowed time.
</dd><dt><code>NM_DEVICE_STATE_REASON_PPP_DISCONNECT = 13</code></dt><dd>
The PPP service disconnected unexpectedly.
</dd><dt><code>NM_DEVICE_STATE_REASON_PPP_FAILED = 14</code></dt><dd>
The PPP service quit or failed unexpectedly.
</dd><dt><code>NM_DEVICE_STATE_REASON_DHCP_START_FAILED = 15</code></dt><dd>
The DHCP service failed to start within the allowed time.
</dd><dt><code>NM_DEVICE_STATE_REASON_DHCP_ERROR = 16</code></dt><dd>
The DHCP service reported an unexpected error.
</dd><dt><code>NM_DEVICE_STATE_REASON_DHCP_FAILED = 17</code></dt><dd>
The DHCP service quit or failed unexpectedly.
</dd><dt><code>NM_DEVICE_STATE_REASON_SHARED_START_FAILED = 18</code></dt><dd>
The shared connection service failed to start.
</dd><dt><code>NM_DEVICE_STATE_REASON_SHARED_FAILED = 19</code></dt><dd>
The shared connection service quit or failed unexpectedly.
</dd><dt><code>NM_DEVICE_STATE_REASON_AUTOIP_START_FAILED = 20</code></dt><dd>
The AutoIP service failed to start.
</dd><dt><code>NM_DEVICE_STATE_REASON_AUTOIP_ERROR = 21</code></dt><dd>
The AutoIP service reported an unexpected error.
</dd><dt><code>NM_DEVICE_STATE_REASON_AUTOIP_FAILED = 22</code></dt><dd>
The AutoIP service quit or failed unexpectedly.
</dd><dt><code>NM_DEVICE_STATE_REASON_MODEM_BUSY = 23</code></dt><dd>
Dialing failed because the line was busy.
</dd><dt><code>NM_DEVICE_STATE_REASON_MODEM_NO_DIAL_TONE = 24</code></dt><dd>
Dialing failed because there was no dial tone.
</dd><dt><code>NM_DEVICE_STATE_REASON_MODEM_NO_CARRIER = 25</code></dt><dd>
Dialing failed because there was carrier.
</dd><dt><code>NM_DEVICE_STATE_REASON_MODEM_DIAL_TIMEOUT = 26</code></dt><dd>
Dialing timed out.
</dd><dt><code>NM_DEVICE_STATE_REASON_MODEM_DIAL_FAILED = 27</code></dt><dd>
Dialing failed.
</dd><dt><code>NM_DEVICE_STATE_REASON_MODEM_INIT_FAILED = 28</code></dt><dd>
Modem initialization failed.
</dd><dt><code>NM_DEVICE_STATE_REASON_GSM_APN_FAILED = 29</code></dt><dd>
Failed to select the specified GSM APN.
</dd><dt><code>NM_DEVICE_STATE_REASON_GSM_REGISTRATION_NOT_SEARCHING = 30</code></dt><dd>
Not searching for networks.
</dd><dt><code>NM_DEVICE_STATE_REASON_GSM_REGISTRATION_DENIED = 31</code></dt><dd>
Network registration was denied.
</dd><dt><code>NM_DEVICE_STATE_REASON_GSM_REGISTRATION_TIMEOUT = 32</code></dt><dd>
Network registration timed out.
</dd><dt><code>NM_DEVICE_STATE_REASON_GSM_REGISTRATION_FAILED = 33</code></dt><dd>
Failed to register with the requested GSM network.
</dd><dt><code>NM_DEVICE_STATE_REASON_GSM_PIN_CHECK_FAILED = 34</code></dt><dd>
PIN check failed.
</dd><dt><code>NM_DEVICE_STATE_REASON_FIRMWARE_MISSING = 35</code></dt><dd>
Necessary firmware for the device may be missing.
</dd><dt><code>NM_DEVICE_STATE_REASON_REMOVED = 36</code></dt><dd>
The device was removed.
</dd><dt><code>NM_DEVICE_STATE_REASON_SLEEPING = 37</code></dt><dd>
NetworkManager went to sleep.
</dd><dt><code>NM_DEVICE_STATE_REASON_CONNECTION_REMOVED = 38</code></dt><dd>
The device's active connection was removed or disappeared.
</dd><dt><code>NM_DEVICE_STATE_REASON_USER_REQUESTED = 39</code></dt><dd>
A user or client requested the disconnection.
</dd><dt><code>NM_DEVICE_STATE_REASON_CARRIER = 40</code></dt><dd>
The device's carrier/link changed.
</dd><dt><code>NM_DEVICE_STATE_REASON_CONNECTION_ASSUMED = 41</code></dt><dd>
The device's existing connection was assumed.
</dd><dt><code>NM_DEVICE_STATE_REASON_SUPPLICANT_AVAILABLE = 42</code></dt><dd>
The 802.1x supplicant is now available.
</dd><dt><code>NM_DEVICE_STATE_REASON_MODEM_NOT_FOUND = 43</code></dt><dd>
The modem could not be found.
</dd><dt><code>NM_DEVICE_STATE_REASON_BT_FAILED = 44</code></dt><dd>
The Bluetooth connection timed out or failed.
</dd></dl><h2>Sets of flags:</h2><h3 xmlns=""><a name="type-NM_DEVICE_CAP" id="type-NM_DEVICE_CAP">NM_DEVICE_CAP</a></h3><dl><dt><code>NM_DEVICE_CAP_NONE = 0x0</code></dt><dd>Null capability.</dd><dt><code>NM_DEVICE_CAP_NM_SUPPORTED = 0x1</code></dt><dd>The device is supported by NetworkManager.</dd><dt><code>NM_DEVICE_CAP_CARRIER_DETECT = 0x2</code></dt><dd>The device supports carrier detection.</dd></dl>
<h1><a name="org.freedesktop.NetworkManager.Device.Wired" id="org.freedesktop.NetworkManager.Device.Wired"></a>org.freedesktop.NetworkManager.Device.Wired</h1><p>Interface has no methods.</p><h2>Signals:</h2><div class="signal"><h3><a name="org.freedesktop.NetworkManager.Device.Wired.PropertiesChanged" id="org.freedesktop.NetworkManager.Device.Wired.PropertiesChanged">PropertiesChanged</a> (
a{sv}: properties
)</h3><div class="docstring"></div><div><h4>Parameters</h4><dl><dt><code>properties</code> -
<code>a{sv}</code>
(<a xmlns="" href="#type-String_Variant_Map">String_Variant_Map</a>)
</dt><dd>
A dictionary mapping property names to variant boxed values
</dd></dl></div></div><h2>Properties:</h2><dl><dt><code>HwAddress</code> -
<code>s</code> -
<code>(read)</code></dt><dd>
Active hardware address of the device.
</dd><dt><code>PermHwAddress</code> -
<code>s</code> -
<code>(read)</code></dt><dd>
Permanent hardware address of the device.
</dd><dt><code>Speed</code> -
<code>u</code> -
<code>(read)</code></dt><dd>
Design speed of the device, in megabits/second (Mb/s).
</dd><dt><code>Carrier</code> -
<code>b</code> -
<code>(read)</code></dt><dd>
Indicates whether the physical carrier is found (e.g. whether a cable is plugged in or not).
</dd></dl>
<h1><a name="org.freedesktop.NetworkManager.Device.Wireless" id="org.freedesktop.NetworkManager.Device.Wireless"></a>org.freedesktop.NetworkManager.Device.Wireless</h1><h2>Methods:</h2><div class="method"><h3><a name="org.freedesktop.NetworkManager.Device.Wireless.GetAccessPoints" id="org.freedesktop.NetworkManager.Device.Wireless.GetAccessPoints">GetAccessPoints</a> (
) →
ao</h3><div class="docstring">
Get the list of access points visible to this device.
</div><div><h4>Returns</h4><dl><dt><code>access_points</code> -
<code>ao</code></dt><dd>
List of access point object paths
</dd></dl></div></div><h2>Signals:</h2><div class="signal"><h3><a name="org.freedesktop.NetworkManager.Device.Wireless.PropertiesChanged" id="org.freedesktop.NetworkManager.Device.Wireless.PropertiesChanged">PropertiesChanged</a> (
a{sv}: properties
)</h3><div class="docstring">
Emitted when the wireless device's properties changed.
</div><div><h4>Parameters</h4><dl><dt><code>properties</code> -
<code>a{sv}</code>
(<a xmlns="" href="#type-String_Variant_Map">String_Variant_Map</a>)
</dt><dd>
A dictionary containing the FIXME: check changed parameters.
</dd></dl></div></div><div class="signal"><h3><a name="org.freedesktop.NetworkManager.Device.Wireless.AccessPointAdded" id="org.freedesktop.NetworkManager.Device.Wireless.AccessPointAdded">AccessPointAdded</a> (
o: access_point
)</h3><div class="docstring">
Emitted when a new access point is found by the device.
</div><div><h4>Parameters</h4><dl><dt><code>access_point</code> -
<code>o</code></dt><dd>
The object path of the newly found access point.
</dd></dl></div></div><div class="signal"><h3><a name="org.freedesktop.NetworkManager.Device.Wireless.AccessPointRemoved" id="org.freedesktop.NetworkManager.Device.Wireless.AccessPointRemoved">AccessPointRemoved</a> (
o: access_point
)</h3><div class="docstring">
Emitted when an access point disappears from view of the device.
</div><div><h4>Parameters</h4><dl><dt><code>access_point</code> -
<code>o</code></dt><dd>
The object path of the access point that has disappeared.
</dd></dl></div></div><h2>Properties:</h2><dl><dt><code>HwAddress</code> -
<code>s</code> -
<code>(read)</code></dt><dd>
The active hardware address of the device.
</dd><dt><code>PermHwAddress</code> -
<code>s</code> -
<code>(read)</code></dt><dd>
The permanent hardware address of the device.
</dd><dt><code>Mode</code> -
<code>u</code> -
<code>(read)</code>
(<a xmlns="" href="#type-NM_802_11_MODE">NM_802_11_MODE</a>)
</dt><dd>
The operating mode of the wireless device.
</dd><dt><code>Bitrate</code> -
<code>u</code> -
<code>(read)</code></dt><dd>
The bit rate currently used by the wireless device, in kilobits/second (Kb/s).
</dd><dt><code>ActiveAccessPoint</code> -
<code>o</code> -
<code>(read)</code></dt><dd>
Object path of the access point currently used by the wireless device.
</dd><dt><code>WirelessCapabilities</code> -
<code>u</code> -
<code>(read)</code>
(<a xmlns="" href="#type-NM_802_11_DEVICE_CAP">NM_802_11_DEVICE_CAP</a>)
</dt><dd>
The capabilities of the wireless device.
</dd></dl><h2>Sets of flags:</h2><h3 xmlns=""><a name="type-NM_802_11_DEVICE_CAP" id="type-NM_802_11_DEVICE_CAP">NM_802_11_DEVICE_CAP</a></h3>
Flags describing the capabilities of a wireless device.
<dl><dt><code>NM_802_11_DEVICE_CAP_NONE = 0x0</code></dt><dd>Null capability - syntactic sugar for no capabilities supported. Do not AND this with other capabilities!</dd><dt><code>NM_802_11_DEVICE_CAP_CIPHER_WEP40 = 0x1</code></dt><dd>The device supports the 40-bit WEP cipher.</dd><dt><code>NM_802_11_DEVICE_CAP_CIPHER_WEP104 = 0x2</code></dt><dd>The device supports the 104-bit WEP cipher.</dd><dt><code>NM_802_11_DEVICE_CAP_CIPHER_TKIP = 0x4</code></dt><dd>The device supports the TKIP cipher.</dd><dt><code>NM_802_11_DEVICE_CAP_CIPHER_CCMP = 0x8</code></dt><dd>The device supports the CCMP cipher.</dd><dt><code>NM_802_11_DEVICE_CAP_WPA = 0x10</code></dt><dd>The device supports the WPA encryption/authentication protocol.</dd><dt><code>NM_802_11_DEVICE_CAP_RSN = 0x20</code></dt><dd>The device supports the RSN encryption/authentication protocol.</dd></dl>
<h1><a name="org.freedesktop.NetworkManager.Device.Cdma" id="org.freedesktop.NetworkManager.Device.Cdma"></a>org.freedesktop.NetworkManager.Device.Cdma</h1><p>Interface has no methods.</p><h2>Signals:</h2><div class="signal"><h3><a name="org.freedesktop.NetworkManager.Device.Cdma.PropertiesChanged" id="org.freedesktop.NetworkManager.Device.Cdma.PropertiesChanged">PropertiesChanged</a> (
a{sv}: properties
)</h3><div class="docstring"></div><div><h4>Parameters</h4><dl><dt><code>properties</code> -
<code>a{sv}</code>
(<a xmlns="" href="#type-String_Variant_Map">String_Variant_Map</a>)
</dt><dd>
A dictionary mapping property names to variant boxed values
</dd></dl></div></div><p>Interface has no properties.</p>
<h1><a name="org.freedesktop.NetworkManager.Device.Gsm" id="org.freedesktop.NetworkManager.Device.Gsm"></a>org.freedesktop.NetworkManager.Device.Gsm</h1><p>Interface has no methods.</p><h2>Signals:</h2><div class="signal"><h3><a name="org.freedesktop.NetworkManager.Device.Gsm.PropertiesChanged" id="org.freedesktop.NetworkManager.Device.Gsm.PropertiesChanged">PropertiesChanged</a> (
a{sv}: properties
)</h3><div class="docstring"></div><div><h4>Parameters</h4><dl><dt><code>properties</code> -
<code>a{sv}</code>
(<a xmlns="" href="#type-String_Variant_Map">String_Variant_Map</a>)
</dt><dd>
A dictionary mapping property names to variant boxed values
</dd></dl></div></div><p>Interface has no properties.</p>
<h1><a name="org.freedesktop.NetworkManager.Device.Serial" id="org.freedesktop.NetworkManager.Device.Serial"></a>org.freedesktop.NetworkManager.Device.Serial</h1><p>Interface has no methods.</p><h2>Signals:</h2><div class="signal"><h3><a name="org.freedesktop.NetworkManager.Device.Serial.PppStats" id="org.freedesktop.NetworkManager.Device.Serial.PppStats">PppStats</a> (
u: in_bytes, u: out_bytes
)</h3><div class="docstring"></div><div><h4>Parameters</h4><dl><dt><code>in_bytes</code> -
<code>u</code></dt><dd>
Bytes received
</dd><dt><code>out_bytes</code> -
<code>u</code></dt><dd>
Bytes sent
</dd></dl></div></div><p>Interface has no properties.</p>
<h1><a name="org.freedesktop.NetworkManager.Device.Bluetooth" id="org.freedesktop.NetworkManager.Device.Bluetooth"></a>org.freedesktop.NetworkManager.Device.Bluetooth</h1><p>Interface has no methods.</p><h2>Signals:</h2><div class="signal"><h3><a name="org.freedesktop.NetworkManager.Device.Bluetooth.PropertiesChanged" id="org.freedesktop.NetworkManager.Device.Bluetooth.PropertiesChanged">PropertiesChanged</a> (
a{sv}: properties
)</h3><div class="docstring"></div><div><h4>Parameters</h4><dl><dt><code>properties</code> -
<code>a{sv}</code>
(<a xmlns="" href="#type-String_Variant_Map">String_Variant_Map</a>)
</dt><dd>
A dictionary mapping property names to variant boxed values
</dd></dl></div></div><h2>Properties:</h2><dl><dt><code>HwAddress</code> -
<code>s</code> -
<code>(read)</code></dt><dd>
Bluetooth hardware address of the device.
</dd><dt><code>Name</code> -
<code>s</code> -
<code>(read)</code></dt><dd>
Bluetooth name of the device.
</dd><dt><code>BtCapabilities</code> -
<code>u</code> -
<code>(read)</code>
(<a xmlns="" href="#type-NM_BT_CAPABILITIES">NM_BT_CAPABILITIES</a>)
</dt><dd>
Bluetooth capabilities of the device (either DUN or NAP).
</dd></dl><h2>Sets of flags:</h2><h3 xmlns=""><a name="type-NM_BT_CAPABILITIES" id="type-NM_BT_CAPABILITIES">NM_BT_CAPABILITIES</a></h3>
Flags describing the capabilities of a Bluetooth device.
<dl><dt><code>NM_BT_CAPABILITY_NONE = 0x0</code></dt><dd>The device has no recognized capabilities.</dd><dt><code>NM_BT_CAPABILITY_DUN = 0x1</code></dt><dd>The device supports Bluetooth Dial-Up Networking.</dd><dt><code>NM_BT_CAPABILITY_PAN = 0x2</code></dt><dd>The device supports Bluetooth Personal Area Networking.</dd></dl>
<h1><a name="org.freedesktop.NetworkManager.Device.OlpcMesh" id="org.freedesktop.NetworkManager.Device.OlpcMesh"></a>org.freedesktop.NetworkManager.Device.OlpcMesh</h1><p>Interface has no methods.</p><h2>Signals:</h2><div class="signal"><h3><a name="org.freedesktop.NetworkManager.Device.OlpcMesh.PropertiesChanged" id="org.freedesktop.NetworkManager.Device.OlpcMesh.PropertiesChanged">PropertiesChanged</a> (
a{sv}: properties
)</h3><div class="docstring">
Emitted when the wireless device's properties changed.
</div><div><h4>Parameters</h4><dl><dt><code>properties</code> -
<code>a{sv}</code>
(<a xmlns="" href="#type-String_Variant_Map">String_Variant_Map</a>)
</dt><dd>
A dictionary containing the FIXME: check changed parameters.
</dd></dl></div></div><h2>Properties:</h2><dl><dt><code>HwAddress</code> -
<code>s</code> -
<code>(read)</code></dt><dd>
The hardware address of the device.
</dd><dt><code>Companion</code> -
<code>o</code> -
<code>(read)</code></dt><dd>
The object path of the companion device.
</dd><dt><code>ActiveChannel</code> -
<code>u</code> -
<code>(read)</code></dt><dd>
The currently active channel.
</dd></dl>
<h1><a name="org.freedesktop.NetworkManager.IP4Config" id="org.freedesktop.NetworkManager.IP4Config"></a>org.freedesktop.NetworkManager.IP4Config</h1><p>Interface has no methods.</p><p>Interface has no signals.</p><h2>Properties:</h2><dl><dt><code>Addresses</code> -
<code>aau</code> -
<code>(read)</code></dt><dd>Array of tuples of IPv4 address/prefix/gateway. All 3
elements of each tuple are in network byte order. Essentially:
[(addr, prefix, gateway), (addr, prefix, gateway), ...]
</dd><dt><code>Nameservers</code> -
<code>au</code> -
<code>(read)</code></dt><dd>The nameservers in use.</dd><dt><code>WinsServers</code> -
<code>au</code> -
<code>(read)</code></dt><dd>The Windows Internet Name Service servers associated with the connection. Each address is in network byte order.</dd><dt><code>Domains</code> -
<code>as</code> -
<code>(read)</code></dt><dd>A list of domains this address belongs to.</dd><dt><code>Routes</code> -
<code>aau</code> -
<code>(read)</code></dt><dd>Tuples of IPv4 route/prefix/next-hop/metric. All 4 elements
of each tuple are in network byte order. 'route' and 'next hop' are IPv4
addresses, while prefix and metric are simple unsigned integers. Essentially:
[(route, prefix, next-hop, metric), (route, prefix, next-hop, metric), ...]
</dd></dl>
<h1><a name="org.freedesktop.NetworkManager.IP6Config" id="org.freedesktop.NetworkManager.IP6Config"></a>org.freedesktop.NetworkManager.IP6Config</h1><p>Interface has no methods.</p><p>Interface has no signals.</p><h2>Properties:</h2><dl><dt><code>Addresses</code> -
<code>a(ayuay)</code> -
<code>(read)</code></dt><dd>Tuples of IPv6 address/prefix/gateway.</dd><dt><code>Nameservers</code> -
<code>aay</code> -
<code>(read)</code></dt><dd>The nameservers in use.</dd><dt><code>Domains</code> -
<code>as</code> -
<code>(read)</code></dt><dd>A list of domains this address belongs to.</dd><dt><code>Routes</code> -
<code>a(ayuayu)</code> -
<code>(read)</code></dt><dd>Tuples of IPv6 route/prefix/next-hop/metric.</dd></dl>
<h1><a name="org.freedesktop.NetworkManager.DHCP4Config" id="org.freedesktop.NetworkManager.DHCP4Config"></a>org.freedesktop.NetworkManager.DHCP4Config</h1>
Options and configuration returned by the IPv4 DHCP server.
<p>Interface has no methods.</p><h2>Signals:</h2><div class="signal"><h3><a name="org.freedesktop.NetworkManager.DHCP4Config.PropertiesChanged" id="org.freedesktop.NetworkManager.DHCP4Config.PropertiesChanged">PropertiesChanged</a> (
a{sv}: properties
)</h3><div class="docstring"></div><div><h4>Parameters</h4><dl><dt><code>properties</code> -
<code>a{sv}</code>
(<a xmlns="" href="#type-String_Variant_Map">String_Variant_Map</a>)
</dt><dd>
A dictionary mapping property names to variant boxed values
</dd></dl></div></div><h2>Properties:</h2><dl><dt><code>Options</code> -
<code>a{sv}</code> -
<code>(read)</code></dt><dd>Configuration options returned by a DHCP server, if any.</dd></dl>
<h1><a name="org.freedesktop.NetworkManager.DHCP6Config" id="org.freedesktop.NetworkManager.DHCP6Config"></a>org.freedesktop.NetworkManager.DHCP6Config</h1>
Options and configuration returned by the IPv6 DHCP server.
<p>Interface has no methods.</p><h2>Signals:</h2><div class="signal"><h3><a name="org.freedesktop.NetworkManager.DHCP6Config.PropertiesChanged" id="org.freedesktop.NetworkManager.DHCP6Config.PropertiesChanged">PropertiesChanged</a> (
a{sv}: properties
)</h3><div class="docstring"></div><div><h4>Parameters</h4><dl><dt><code>properties</code> -
<code>a{sv}</code>
(<a xmlns="" href="#type-String_Variant_Map">String_Variant_Map</a>)
</dt><dd>
A dictionary mapping property names to variant boxed values
</dd></dl></div></div><h2>Properties:</h2><dl><dt><code>Options</code> -
<code>a{sv}</code> -
<code>(read)</code></dt><dd>Configuration options returned by a DHCP server, if any.</dd></dl>
<h1><a name="org.freedesktop.NetworkManagerSettings" id="org.freedesktop.NetworkManagerSettings"></a>org.freedesktop.NetworkManagerSettings</h1>
The NetworkManagerSettings interface is provided by the service which provides connections to NetworkManager.
<h2>Methods:</h2><div class="method"><h3><a name="org.freedesktop.NetworkManagerSettings.ListConnections" id="org.freedesktop.NetworkManagerSettings.ListConnections">ListConnections</a> (
) →
ao</h3><div class="docstring">
List the connections stored by this Settings object.
</div><div><h4>Returns</h4><dl><dt><code>connections</code> -
<code>ao</code></dt><dd>
List of connections.
</dd></dl></div></div><div class="method"><h3><a name="org.freedesktop.NetworkManagerSettings.AddConnection" id="org.freedesktop.NetworkManagerSettings.AddConnection">AddConnection</a> (
a{sa{sv}}: connection
) →
nothing</h3><div class="docstring">
Add new connection.
</div><div><h4>Parameters</h4><dl><dt><code>connection</code> -
<code>a{sa{sv}}</code></dt><dd>
Connection settings and properties.
</dd></dl></div></div><h2>Signals:</h2><div class="signal"><h3><a name="org.freedesktop.NetworkManagerSettings.NewConnection" id="org.freedesktop.NetworkManagerSettings.NewConnection">NewConnection</a> (
o: connection
)</h3><div class="docstring">
Emitted when a new connection has been added.
</div><div><h4>Parameters</h4><dl><dt><code>connection</code> -
<code>o</code></dt><dd>
Object path of the new connection.
</dd></dl></div></div><p>Interface has no properties.</p>
<h1><a name="org.freedesktop.NetworkManagerSettings.System" id="org.freedesktop.NetworkManagerSettings.System"></a>org.freedesktop.NetworkManagerSettings.System</h1>
Implemented by the system settings service to provide additional settings to NetworkManager.
<h2>Methods:</h2><div class="method"><h3><a name="org.freedesktop.NetworkManagerSettings.System.SaveHostname" id="org.freedesktop.NetworkManagerSettings.System.SaveHostname">SaveHostname</a> (
s: hostname
) →
nothing</h3><div class="docstring">
Save the hostname to persistent configuration.
</div><div><h4>Parameters</h4><dl><dt><code>hostname</code> -
<code>s</code></dt><dd>
The hostname to save to persistent configuration. If blank, the persistent hostname is cleared.
</dd></dl></div></div><div class="method"><h3><a name="org.freedesktop.NetworkManagerSettings.System.GetPermissions" id="org.freedesktop.NetworkManagerSettings.System.GetPermissions">GetPermissions</a> (
) →
u</h3><div class="docstring">
Returns a bitfield indicating certain operations the caller is permitted to perform. Some of these operations may require authorization by the user.
</div><div><h4>Returns</h4><dl><dt><code>permissions</code> -
<code>u</code>
(<a xmlns="" href="#type-NM_SETTINGS_SYSTEM_PERMISSIONS">NM_SETTINGS_SYSTEM_PERMISSIONS</a>)
</dt><dd>
A bitfield of permitted operations. Some of these operations may require the user to authorize via password entry or other means.
</dd></dl></div></div><h2>Signals:</h2><div class="signal"><h3><a name="org.freedesktop.NetworkManagerSettings.System.PropertiesChanged" id="org.freedesktop.NetworkManagerSettings.System.PropertiesChanged">PropertiesChanged</a> (
a{sv}: properties
)</h3><div class="docstring"></div><div><h4>Parameters</h4><dl><dt><code>properties</code> -
<code>a{sv}</code>
(<a xmlns="" href="#type-String_Variant_Map">String_Variant_Map</a>)
</dt><dd>
A dictionary mapping property names to variant boxed values
</dd></dl></div></div><div class="signal"><h3><a name="org.freedesktop.NetworkManagerSettings.System.CheckPermissions" id="org.freedesktop.NetworkManagerSettings.System.CheckPermissions">CheckPermissions</a> (
)</h3><div class="docstring">
Emitted when system authorization details change, indicating that clients may wish to recheck permissions with GetPermissions.
</div></div><h2>Properties:</h2><dl><dt><code>Hostname</code> -
<code>s</code> -
<code>(read)</code></dt><dd>
The machine hostname stored in persistent configuration.
</dd><dt><code>CanModify</code> -
<code>b</code> -
<code>(read)</code></dt><dd>
If true, adding and modifying connections is supported.
</dd></dl><h2>Sets of flags:</h2><h3 xmlns=""><a name="type-NM_SETTINGS_SYSTEM_PERMISSIONS" id="type-NM_SETTINGS_SYSTEM_PERMISSIONS">NM_SETTINGS_SYSTEM_PERMISSIONS</a></h3><dl><dt><code>NM_SETTINGS_SYSTEM_PERMISSION_NONE = 0x0</code></dt><dd>No permissions.</dd><dt><code>NM_SETTINGS_SYSTEM_PERMISSION_CONNECTION_MODIFY = 0x1</code></dt><dd>Can modify/add/delete connections.</dd><dt><code>NM_SETTINGS_SYSTEM_PERMISSION_WIFI_SHARING_PROTECTED = 0x2</code></dt><dd>Can share connections via a encrypted user-created WiFi network.</dd><dt><code>NM_SETTINGS_SYSTEM_PERMISSION_WIFI_SHARING_OPEN = 0x4</code></dt><dd>Can share connections via a open/unencrypted user-created WiFi network.</dd><dt><code>NM_SETTINGS_SYSTEM_PERMISSION_HOSTNAME_MODIFY = 0x8</code></dt><dd>Can modify the persistent system hostname.</dd></dl>
<h1><a name="org.freedesktop.NetworkManagerSettings.Connection" id="org.freedesktop.NetworkManagerSettings.Connection"></a>org.freedesktop.NetworkManagerSettings.Connection</h1>
Represents a single network connection configuration.
<h2>Methods:</h2><div class="method"><h3><a name="org.freedesktop.NetworkManagerSettings.Connection.Update" id="org.freedesktop.NetworkManagerSettings.Connection.Update">Update</a> (
a{sa{sv}}: properties
) →
nothing</h3><div class="docstring">
Update the connection with new settings and properties, replacing all previous settings and properties.
</div><div><h4>Parameters</h4><dl><dt><code>properties</code> -
<code>a{sa{sv}}</code></dt><dd>
New connection properties.
</dd></dl></div></div><div class="method"><h3><a name="org.freedesktop.NetworkManagerSettings.Connection.Delete" id="org.freedesktop.NetworkManagerSettings.Connection.Delete">Delete</a> (
) →
nothing</h3><div class="docstring">
Delete the connection.
</div></div><div class="method"><h3><a name="org.freedesktop.NetworkManagerSettings.Connection.GetSettings" id="org.freedesktop.NetworkManagerSettings.Connection.GetSettings">GetSettings</a> (
) →
a{sa{sv}}</h3><div class="docstring">
Get the settings maps describing this object.
</div><div><h4>Returns</h4><dl><dt><code>settings</code> -
<code>a{sa{sv}}</code>
(<a xmlns="" href="#type-String_String_Variant_Map_Map">String_String_Variant_Map_Map</a>)
</dt><dd>
The nested settings maps describing this object.
</dd></dl></div></div><h2>Signals:</h2><div class="signal"><h3><a name="org.freedesktop.NetworkManagerSettings.Connection.Updated" id="org.freedesktop.NetworkManagerSettings.Connection.Updated">Updated</a> (
a{sa{sv}}: settings
)</h3><div class="docstring">
Emitted when some settings changed.
</div><div><h4>Parameters</h4><dl><dt><code>settings</code> -
<code>a{sa{sv}}</code>
(<a xmlns="" href="#type-String_String_Variant_Map_Map">String_String_Variant_Map_Map</a>)
</dt><dd>
Contains complete connection setting parameters, including changes.
</dd></dl></div></div><div class="signal"><h3><a name="org.freedesktop.NetworkManagerSettings.Connection.Removed" id="org.freedesktop.NetworkManagerSettings.Connection.Removed">Removed</a> (
)</h3><div class="docstring">
Emitted when this connection has been deleted/removed. After receipt of this signal, the object no longer exists.
</div></div><p>Interface has no properties.</p>
<h1><a name="org.freedesktop.NetworkManagerSettings.Connection.Secrets" id="org.freedesktop.NetworkManagerSettings.Connection.Secrets"></a>org.freedesktop.NetworkManagerSettings.Connection.Secrets</h1>
Secrets have a separate interface so that they can be locked down.
<h2>Methods:</h2><div class="method"><h3><a name="org.freedesktop.NetworkManagerSettings.Connection.Secrets.GetSecrets" id="org.freedesktop.NetworkManagerSettings.Connection.Secrets.GetSecrets">GetSecrets</a> (
s: setting_name, as: hints, b: request_new
) →
a{sa{sv}}</h3><div class="docstring">
Get the secrets encapsulated in this object.
</div><div><h4>Parameters</h4><dl><dt><code>setting_name</code> -
<code>s</code></dt><dd>
Name of the setting to return.
</dd><dt><code>hints</code> -
<code>as</code></dt><dd>
Array of strings of key names in the Setting for which NM thinks
a secrets may be required.
</dd><dt><code>request_new</code> -
<code>b</code></dt><dd>
Indicates whether new secrets should be requested or if the request can be fulfilled from storage.
</dd></dl></div><div><h4>Returns</h4><dl><dt><code>secrets</code> -
<code>a{sa{sv}}</code>
(<a xmlns="" href="#type-String_String_Variant_Map_Map">String_String_Variant_Map_Map</a>)
</dt><dd>
Nested settings maps containing secrets. Each setting MUST contain at least the 'name' field, containing the name of the setting, and one or more secrets.
</dd></dl></div></div><p>Interface has no signals.</p><p>Interface has no properties.</p>
<h1><a name="org.freedesktop.NetworkManager.Connection.Active" id="org.freedesktop.NetworkManager.Connection.Active"></a>org.freedesktop.NetworkManager.Connection.Active</h1><p>Interface has no methods.</p><h2>Signals:</h2><div class="signal"><h3><a name="org.freedesktop.NetworkManager.Connection.Active.PropertiesChanged" id="org.freedesktop.NetworkManager.Connection.Active.PropertiesChanged">PropertiesChanged</a> (
a{sv}: properties
)</h3><div class="docstring"></div><div><h4>Parameters</h4><dl><dt><code>properties</code> -
<code>a{sv}</code>
(<a xmlns="" href="#type-String_Variant_Map">String_Variant_Map</a>)
</dt><dd>
A dictionary mapping property names to variant boxed values
</dd></dl></div></div><h2>Properties:</h2><dl><dt><code>ServiceName</code> -
<code>s</code> -
<code>(read)</code></dt><dd>The D-Bus service name providing this connection.</dd><dt><code>Connection</code> -
<code>o</code> -
<code>(read)</code></dt><dd>The path of the connection.</dd><dt><code>SpecificObject</code> -
<code>o</code> -
<code>(read)</code></dt><dd>A specific object associated with the active connection.</dd><dt><code>Uuid</code> -
<code>s</code> -
<code>(read)</code></dt><dd>
The UUID of the connection, provided as a convenience so that clients
do not have to retrieve all connection details.
</dd><dt><code>Devices</code> -
<code>ao</code> -
<code>(read)</code></dt><dd>Array of object paths representing devices which are part of this active connection.</dd><dt><code>State</code> -
<code>u</code> -
<code>(read)</code>
(<a xmlns="" href="#type-NM_ACTIVE_CONNECTION_STATE">NM_ACTIVE_CONNECTION_STATE</a>)
</dt><dd>The state of this active connection.</dd><dt><code>Default</code> -
<code>b</code> -
<code>(read)</code></dt><dd>Whether this active connection is the default IPv4 connection, i.e. whether it currently owns the default IPv4 route.</dd><dt><code>Default6</code> -
<code>b</code> -
<code>(read)</code></dt><dd>Whether this active connection is the default IPv6 connection, i.e. whether it currently owns the default IPv6 route.</dd><dt><code>Vpn</code> -
<code>b</code> -
<code>(read)</code></dt><dd>Whether this active connection is also a VPN connection.</dd></dl><h2>Enumerated types:</h2><h3><a name="type-NM_ACTIVE_CONNECTION_STATE" id="type-NM_ACTIVE_CONNECTION_STATE">NM_ACTIVE_CONNECTION_STATE</a></h3><dl><dt><code>NM_ACTIVE_CONNECTION_STATE_UNKNOWN = 0</code></dt><dd>
The active connection is in an unknown state.
</dd><dt><code>NM_ACTIVE_CONNECTION_STATE_ACTIVATING = 1</code></dt><dd>
The connection is activating.
</dd><dt><code>NM_ACTIVE_CONNECTION_STATE_ACTIVATED = 2</code></dt><dd>
The connection is activated.
</dd></dl>
<h1><a name="org.freedesktop.NetworkManager.VPN.Connection" id="org.freedesktop.NetworkManager.VPN.Connection"></a>org.freedesktop.NetworkManager.VPN.Connection</h1>
Represents an active connection to a Virtual Private Network.
<p>Interface has no methods.</p><h2>Signals:</h2><div class="signal"><h3><a name="org.freedesktop.NetworkManager.VPN.Connection.PropertiesChanged" id="org.freedesktop.NetworkManager.VPN.Connection.PropertiesChanged">PropertiesChanged</a> (
a{sv}: properties
)</h3><div class="docstring"></div><div><h4>Parameters</h4><dl><dt><code>properties</code> -
<code>a{sv}</code>
(<a xmlns="" href="#type-String_Variant_Map">String_Variant_Map</a>)
</dt><dd>
A dictionary mapping property names to variant boxed values
</dd></dl></div></div><div class="signal"><h3><a name="org.freedesktop.NetworkManager.VPN.Connection.VpnStateChanged" id="org.freedesktop.NetworkManager.VPN.Connection.VpnStateChanged">VpnStateChanged</a> (
u: state, u: reason
)</h3><div class="docstring">
Emitted when the state of the VPN connection has changed.
</div><div><h4>Parameters</h4><dl><dt><code>state</code> -
<code>u</code>
(<a xmlns="" href="#type-NM_VPN_CONNECTION_STATE">NM_VPN_CONNECTION_STATE</a>)
</dt><dd>
The new state of the VPN connection.
</dd><dt><code>reason</code> -
<code>u</code>
(<a xmlns="" href="#type-NM_VPN_CONNECTION_STATE_REASON">NM_VPN_CONNECTION_STATE_REASON</a>)
</dt><dd>
Reason code describing the change to the new state.
</dd></dl></div></div><h2>Properties:</h2><dl><dt><code>VpnState</code> -
<code>u</code> -
<code>(read)</code>
(<a xmlns="" href="#type-NM_VPN_CONNECTION_STATE">NM_VPN_CONNECTION_STATE</a>)
</dt><dd>The VPN-specific state of the connection.</dd><dt><code>Banner</code> -
<code>s</code> -
<code>(read)</code></dt><dd>The banner string of the VPN connection.</dd></dl><h2>Enumerated types:</h2><h3><a name="type-NM_VPN_CONNECTION_STATE" id="type-NM_VPN_CONNECTION_STATE">NM_VPN_CONNECTION_STATE</a></h3><dl><dt><code>NM_VPN_CONNECTION_STATE_UNKNOWN = 0</code></dt><dd>
The state of the VPN connection is unknown.
</dd><dt><code>NM_VPN_CONNECTION_STATE_PREPARE = 1</code></dt><dd>
The VPN connection is preparing to connect.
</dd><dt><code>NM_VPN_CONNECTION_STATE_NEED_AUTH = 2</code></dt><dd>
The VPN connection needs authorization credentials.
</dd><dt><code>NM_VPN_CONNECTION_STATE_CONNECT = 3</code></dt><dd>
The VPN connection is being established. FIXME: Should be CONNECTING or CONNECTED.
</dd><dt><code>NM_VPN_CONNECTION_STATE_IP_CONFIG_GET = 4</code></dt><dd>
The VPN connection is getting an IP address. FIXME: Should be an -ING
</dd><dt><code>NM_VPN_CONNECTION_STATE_ACTIVATED = 5</code></dt><dd>
The VPN connection is active.
</dd><dt><code>NM_VPN_CONNECTION_STATE_FAILED = 6</code></dt><dd>
The VPN connection failed.
</dd><dt><code>NM_VPN_CONNECTION_STATE_DISCONNECTED = 7</code></dt><dd>
The VPN connection is disconnected.
</dd></dl><h3><a name="type-NM_VPN_CONNECTION_STATE_REASON" id="type-NM_VPN_CONNECTION_STATE_REASON">NM_VPN_CONNECTION_STATE_REASON</a></h3><dl><dt><code>NM_VPN_CONNECTION_STATE_REASON_UNKNOWN = 0</code></dt><dd>
The reason for the VPN connection state change is unknown.
</dd><dt><code>NM_VPN_CONNECTION_STATE_REASON_NONE = 1</code></dt><dd>
No reason was given for the VPN connection state change.
</dd><dt><code>NM_VPN_CONNECTION_STATE_REASON_USER_DISCONNECTED = 2</code></dt><dd>
The VPN connection changed state because the user disconnected it.
</dd><dt><code>NM_VPN_CONNECTION_STATE_REASON_DEVICE_DISCONNECTED = 3</code></dt><dd>
The VPN connection changed state because the device it was using was disconnected.
</dd><dt><code>NM_VPN_CONNECTION_STATE_REASON_SERVICE_STOPPED = 4</code></dt><dd>
The service providing the VPN connection was stopped.
</dd><dt><code>NM_VPN_CONNECTION_STATE_REASON_IP_CONFIG_INVALID = 5</code></dt><dd>
The IP config of the VPN connection was invalid.
</dd><dt><code>NM_VPN_CONNECTION_STATE_REASON_CONNECT_TIMEOUT = 6</code></dt><dd>
The connection attempt to the VPN service timed out.
</dd><dt><code>NM_VPN_CONNECTION_STATE_REASON_SERVICE_START_TIMEOUT = 7</code></dt><dd>
A timeout occurred while starting the service providing the VPN connection.
</dd><dt><code>NM_VPN_CONNECTION_STATE_REASON_SERVICE_START_FAILED = 8</code></dt><dd>
Starting the service starting the service providing the VPN connection failed.
</dd><dt><code>NM_VPN_CONNECTION_STATE_REASON_NO_SECRETS = 9</code></dt><dd>
Necessary secrets for the VPN connection were not provided.
</dd><dt><code>NM_VPN_CONNECTION_STATE_REASON_LOGIN_FAILED = 10</code></dt><dd>
Authentication to the VPN server failed.
</dd><dt><code>NM_VPN_CONNECTION_STATE_REASON_CONNECTION_REMOVED = 11</code></dt><dd>
The connection was deleted from settings.
</dd></dl>
<h1><a name="org.freedesktop.NetworkManager.VPN.Plugin" id="org.freedesktop.NetworkManager.VPN.Plugin"></a>org.freedesktop.NetworkManager.VPN.Plugin</h1>
This interface is provided by plugins providing VPN services to the NetworkManager daemon.
<h2>Methods:</h2><div class="method"><h3><a name="org.freedesktop.NetworkManager.VPN.Plugin.Connect" id="org.freedesktop.NetworkManager.VPN.Plugin.Connect">Connect</a> (
a{sa{sv}}: connection
) →
nothing</h3><div class="docstring">
Tells the plugin to connect.
</div><div><h4>Parameters</h4><dl><dt><code>connection</code> -
<code>a{sa{sv}}</code>
(<a xmlns="" href="#type-String_String_Variant_Map_Map">String_String_Variant_Map_Map</a>)
</dt><dd>
Describes the connection to be established.
</dd></dl></div><div><h4>Possible errors</h4><dl><dt><code>org.freedesktop.NetworkManager.VPN.Error.StartingInProgress</code></dt><dd>The request could not be processed because the VPN connection is already being started.<em>(generic description)</em></dd><dt><code>org.freedesktop.NetworkManager.VPN.Error.AlreadyStarted</code></dt><dd>The request could not be processed because a VPN connection was already active.<em>(generic description)</em></dd><dt><code>org.freedesktop.NetworkManager.VPN.Error.StoppingInProgress</code></dt><dd>The request could not be processed because the VPN connection is already being stopped.<em>(generic description)</em></dd><dt><code>org.freedesktop.NetworkManager.VPN.Error.BadArguments</code></dt><dd>Invalid arguments were passed with the request. FIXME: too general.<em>(generic description)</em></dd><dt><code>org.freedesktop.NetworkManager.VPN.Error.LaunchFailed</code></dt><dd>A binary providing the service failed to launch.<em>(generic description)</em></dd></dl></div></div><div class="method"><h3><a name="org.freedesktop.NetworkManager.VPN.Plugin.NeedSecrets" id="org.freedesktop.NetworkManager.VPN.Plugin.NeedSecrets">NeedSecrets</a> (
a{sa{sv}}: settings
) →
s</h3><div class="docstring">
Asks the plugin whether the provided connection will require secrets to connect successfully.
</div><div><h4>Parameters</h4><dl><dt><code>settings</code> -
<code>a{sa{sv}}</code>
(<a xmlns="" href="#type-String_String_Variant_Map_Map">String_String_Variant_Map_Map</a>)
</dt><dd>
Describes the connection that may need secrets.
</dd></dl></div><div><h4>Returns</h4><dl><dt><code>setting_name</code> -
<code>s</code></dt><dd>
The setting name within the provided connection that requires secrets, if any.
</dd></dl></div><div><h4>Possible errors</h4><dl><dt><code>org.freedesktop.NetworkManager.VPN.Error.ConnectionInvalid</code></dt><dd>The request could not be processed because the VPN connection settings were invalid.<em>(generic description)</em></dd></dl></div></div><div class="method"><h3><a name="org.freedesktop.NetworkManager.VPN.Plugin.Disconnect" id="org.freedesktop.NetworkManager.VPN.Plugin.Disconnect">Disconnect</a> (
) →
nothing</h3><div class="docstring">
Disconnect the plugin.
</div><div><h4>Possible errors</h4><dl><dt><code>org.freedesktop.NetworkManager.VPN.Error.StoppingInProgress</code></dt><dd>The request could not be processed because the VPN connection is already being stopped.<em>(generic description)</em></dd><dt><code>org.freedesktop.NetworkManager.VPN.Error.AlreadyStopped</code></dt><dd>The request could not be processed because the VPN connection was already stopped.<em>(generic description)</em></dd></dl></div></div><div class="method"><h3><a name="org.freedesktop.NetworkManager.VPN.Plugin.SetIp4Config" id="org.freedesktop.NetworkManager.VPN.Plugin.SetIp4Config">SetIp4Config</a> (
a{sv}: config
) →
nothing</h3><div class="docstring">
Set IPv4 details on the connection.
</div><div><h4>Parameters</h4><dl><dt><code>config</code> -
<code>a{sv}</code>
(<a xmlns="" href="#type-String_Variant_Map">String_Variant_Map</a>)
</dt><dd>
Ip4Config details for the conneciton.
</dd></dl></div></div><div class="method"><h3><a name="org.freedesktop.NetworkManager.VPN.Plugin.SetFailure" id="org.freedesktop.NetworkManager.VPN.Plugin.SetFailure">SetFailure</a> (
s: reason
) →
nothing</h3><div class="docstring">
Indicate a failure to the plugin.
</div><div><h4>Parameters</h4><dl><dt><code>reason</code> -
<code>s</code></dt><dd>
The reason for the failure.
</dd></dl></div></div><h2>Signals:</h2><div class="signal"><h3><a name="org.freedesktop.NetworkManager.VPN.Plugin.StateChanged" id="org.freedesktop.NetworkManager.VPN.Plugin.StateChanged">StateChanged</a> (
u: state
)</h3><div class="docstring">
Emitted when the plugin state changes.
</div><div><h4>Parameters</h4><dl><dt><code>state</code> -
<code>u</code>
(<a xmlns="" href="#type-NM_VPN_CONNECTION_STATE">NM_VPN_CONNECTION_STATE</a>)
</dt><dd>
The new state of the plugin.
</dd></dl></div></div><div class="signal"><h3><a name="org.freedesktop.NetworkManager.VPN.Plugin.Ip4Config" id="org.freedesktop.NetworkManager.VPN.Plugin.Ip4Config">Ip4Config</a> (
a{sv}: ip4config
)</h3><div class="docstring">
The plugin obtained an IPv4 configuration.
</div><div><h4>Parameters</h4><dl><dt><code>ip4config</code> -
<code>a{sv}</code>
(<a xmlns="" href="#type-String_Variant_Map">String_Variant_Map</a>)
</dt><dd>
The IPv4 configuration.
</dd></dl></div></div><div class="signal"><h3><a name="org.freedesktop.NetworkManager.VPN.Plugin.LoginBanner" id="org.freedesktop.NetworkManager.VPN.Plugin.LoginBanner">LoginBanner</a> (
s: banner
)</h3><div class="docstring">
Emitted when the plugin receives a login banner from the VPN service.
</div><div><h4>Parameters</h4><dl><dt><code>banner</code> -
<code>s</code></dt><dd>
The login banner string.
</dd></dl></div></div><div class="signal"><h3><a name="org.freedesktop.NetworkManager.VPN.Plugin.Failure" id="org.freedesktop.NetworkManager.VPN.Plugin.Failure">Failure</a> (
u: reason
)</h3><div class="docstring">
Emitted when a failure in the VPN plugin occurs.
</div><div><h4>Parameters</h4><dl><dt><code>reason</code> -
<code>u</code>
(<a xmlns="" href="#type-NM_VPN_PLUGIN_FAILURE">NM_VPN_PLUGIN_FAILURE</a>)
</dt><dd>
Reason code for the failure.
</dd></dl></div></div><h2>Properties:</h2><dl><dt><code>State</code> -
<code>u</code> -
<code>(read)</code>
(<a xmlns="" href="#type-NM_VPN_CONNECTION_STATE">NM_VPN_CONNECTION_STATE</a>)
</dt><dd>
The state of the plugin.
</dd></dl><h2>Enumerated types:</h2><h3><a name="type-NM_VPN_PLUGIN_FAILURE" id="type-NM_VPN_PLUGIN_FAILURE">NM_VPN_PLUGIN_FAILURE</a></h3><dl><dt><code>NM_VPN_PLUGIN_FAILURE_LOGIN_FAILED = 0</code></dt><dd>
Login failed.
</dd><dt><code>NM_VPN_PLUGIN_FAILURE_CONNECT_FAILED = 1</code></dt><dd>
Connect failed.
</dd><dt><code>NM_VPN_PLUGIN_FAILURE_BAD_IP_CONFIG = 2</code></dt><dd>
Invalid IP configuration returned from the VPN plugin.
</dd></dl>
<h1>Generic types:</h1><h2>Enumerated types:</h2><h3><a name="type-NM_802_11_MODE" id="type-NM_802_11_MODE">NM_802_11_MODE</a></h3><dl><dt><code>NM_802_11_MODE_UNKNOWN = 0</code></dt><dd>Mode is unknown.</dd><dt><code>NM_802_11_MODE_ADHOC = 1</code></dt><dd>Uncoordinated network without central infrastructure.</dd><dt><code>NM_802_11_MODE_INFRA = 2</code></dt><dd>Coordinated network with one or more central controllers.</dd></dl><h2>Mapping types:</h2><div class="struct"><h3><a name="type-String_Variant_Map" id="type-String_Variant_Map">String_Variant_Map</a> - a{
s: Key → v: Value
}
</h3><div class="docstring">A mapping from strings to variants representing extra
key-value pairs.</div><div><h4>Members</h4><dl><dt><code>Key</code> -
<code>s</code></dt><dd><em>(undocumented)</em></dd><dt><code>Value</code> -
<code>v</code></dt><dd><em>(undocumented)</em></dd></dl></div></div><div class="struct"><h3><a name="type-String_String_Map" id="type-String_String_Map">String_String_Map</a> - a{
s: Key → s: Value
}
</h3><div class="docstring">A mapping from strings to strings representing extra
key-value pairs.</div><div><h4>Members</h4><dl><dt><code>Key</code> -
<code>s</code></dt><dd><em>(undocumented)</em></dd><dt><code>Value</code> -
<code>s</code></dt><dd><em>(undocumented)</em></dd></dl></div></div><div class="struct"><h3><a name="type-String_String_Variant_Map_Map" id="type-String_String_Variant_Map_Map">String_String_Variant_Map_Map</a> - a{
s: Key → a{sv}: Value
}
</h3><div class="docstring">A mapping from strings to a map of string to variant.</div><div><h4>Members</h4><dl><dt><code>Key</code> -
<code>s</code></dt><dd><em>(undocumented)</em></dd><dt><code>Value</code> -
<code>a{sv}</code>
(<a xmlns="" href="#type-String_Variant_Map">String_Variant_Map</a>)
</dt><dd><em>(undocumented)</em></dd></dl></div></div><h1>Errors:</h1>
<h2><a name="org.freedesktop.NetworkManager.Error.UnknownConnection" id="org.freedesktop.NetworkManager.Error.UnknownConnection"></a>org.freedesktop.NetworkManager.Error.UnknownConnection</h2>
Connection was not provided by any known settings service.
<h2><a name="org.freedesktop.NetworkManager.Error.UnknownDevice" id="org.freedesktop.NetworkManager.Error.UnknownDevice"></a>org.freedesktop.NetworkManager.Error.UnknownDevice</h2>
Unknown device.
<h2><a name="org.freedesktop.NetworkManager.Error.InvalidService" id="org.freedesktop.NetworkManager.Error.InvalidService"></a>org.freedesktop.NetworkManager.Error.InvalidService</h2>
Invalid settings service (not a recognized system or user settings service name).
<h2><a name="org.freedesktop.NetworkManager.Error.SystemConnection" id="org.freedesktop.NetworkManager.Error.SystemConnection"></a>org.freedesktop.NetworkManager.Error.SystemConnection</h2>
Connection was superseded by a system connection.
<h2><a name="org.freedesktop.NetworkManager.Error.PermissionDenied" id="org.freedesktop.NetworkManager.Error.PermissionDenied"></a>org.freedesktop.NetworkManager.Error.PermissionDenied</h2>
User does not have the permission to activate this connection.
<h1>Errors:</h1>
<h2><a name="org.freedesktop.NetworkManager.VPN.Error.General" id="org.freedesktop.NetworkManager.VPN.Error.General"></a>org.freedesktop.NetworkManager.VPN.Error.General</h2>This is a drab, nondescript error.
<h2><a name="org.freedesktop.NetworkManager.VPN.Error.StartingInProgress" id="org.freedesktop.NetworkManager.VPN.Error.StartingInProgress"></a>org.freedesktop.NetworkManager.VPN.Error.StartingInProgress</h2>The request could not be processed because the VPN connection is already being started.
<h2><a name="org.freedesktop.NetworkManager.VPN.Error.AlreadyStarted" id="org.freedesktop.NetworkManager.VPN.Error.AlreadyStarted"></a>org.freedesktop.NetworkManager.VPN.Error.AlreadyStarted</h2>The request could not be processed because a VPN connection was already active.
<h2><a name="org.freedesktop.NetworkManager.VPN.Error.StoppingInProgress" id="org.freedesktop.NetworkManager.VPN.Error.StoppingInProgress"></a>org.freedesktop.NetworkManager.VPN.Error.StoppingInProgress</h2>The request could not be processed because the VPN connection is already being stopped.
<h2><a name="org.freedesktop.NetworkManager.VPN.Error.AlreadyStopped" id="org.freedesktop.NetworkManager.VPN.Error.AlreadyStopped"></a>org.freedesktop.NetworkManager.VPN.Error.AlreadyStopped</h2>The request could not be processed because the VPN connection was already stopped.
<h2><a name="org.freedesktop.NetworkManager.VPN.Error.WrongState" id="org.freedesktop.NetworkManager.VPN.Error.WrongState"></a>org.freedesktop.NetworkManager.VPN.Error.WrongState</h2>The request could not be processed because the VPN connection is in the wrong state for this type of request. FIXME: too general?
<h2><a name="org.freedesktop.NetworkManager.VPN.Error.BadArguments" id="org.freedesktop.NetworkManager.VPN.Error.BadArguments"></a>org.freedesktop.NetworkManager.VPN.Error.BadArguments</h2>Invalid arguments were passed with the request. FIXME: too general.
<h2><a name="org.freedesktop.NetworkManager.VPN.Error.LaunchFailed" id="org.freedesktop.NetworkManager.VPN.Error.LaunchFailed"></a>org.freedesktop.NetworkManager.VPN.Error.LaunchFailed</h2>A binary providing the service failed to launch.
<h2><a name="org.freedesktop.NetworkManager.VPN.Error.ConnectionInvalid" id="org.freedesktop.NetworkManager.VPN.Error.ConnectionInvalid"></a>org.freedesktop.NetworkManager.VPN.Error.ConnectionInvalid</h2>The request could not be processed because the VPN connection settings were invalid.
<h1>Index</h1><h2>Index of interfaces</h2><ul><li><code><a href="#org.freedesktop.NetworkManager">org.freedesktop.NetworkManager</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.AccessPoint">org.freedesktop.NetworkManager.AccessPoint</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.Device">org.freedesktop.NetworkManager.Device</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.Device.Wired">org.freedesktop.NetworkManager.Device.Wired</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.Device.Wireless">org.freedesktop.NetworkManager.Device.Wireless</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.Device.Cdma">org.freedesktop.NetworkManager.Device.Cdma</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.Device.Gsm">org.freedesktop.NetworkManager.Device.Gsm</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.Device.Serial">org.freedesktop.NetworkManager.Device.Serial</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.Device.Bluetooth">org.freedesktop.NetworkManager.Device.Bluetooth</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.Device.OlpcMesh">org.freedesktop.NetworkManager.Device.OlpcMesh</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.IP4Config">org.freedesktop.NetworkManager.IP4Config</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.IP6Config">org.freedesktop.NetworkManager.IP6Config</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.DHCP4Config">org.freedesktop.NetworkManager.DHCP4Config</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.DHCP6Config">org.freedesktop.NetworkManager.DHCP6Config</a></code></li><li><code><a href="#org.freedesktop.NetworkManagerSettings">org.freedesktop.NetworkManagerSettings</a></code></li><li><code><a href="#org.freedesktop.NetworkManagerSettings.System">org.freedesktop.NetworkManagerSettings.System</a></code></li><li><code><a href="#org.freedesktop.NetworkManagerSettings.Connection">org.freedesktop.NetworkManagerSettings.Connection</a></code></li><li><code><a href="#org.freedesktop.NetworkManagerSettings.Connection.Secrets">org.freedesktop.NetworkManagerSettings.Connection.Secrets</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.Connection.Active">org.freedesktop.NetworkManager.Connection.Active</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.VPN.Connection">org.freedesktop.NetworkManager.VPN.Connection</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.VPN.Plugin">org.freedesktop.NetworkManager.VPN.Plugin</a></code></li></ul><h2>Index of types</h2><ul><li><code><a href="#type-NM_802_11_AP_FLAGS">NM_802_11_AP_FLAGS</a></code>
- u</li><li><code><a href="#type-NM_802_11_AP_SEC">NM_802_11_AP_SEC</a></code>
- u</li><li><code><a href="#type-NM_802_11_DEVICE_CAP">NM_802_11_DEVICE_CAP</a></code>
- u</li><li><code><a href="#type-NM_802_11_MODE">NM_802_11_MODE</a></code>
- u</li><li><code><a href="#type-NM_ACTIVE_CONNECTION_STATE">NM_ACTIVE_CONNECTION_STATE</a></code>
- u</li><li><code><a href="#type-NM_BT_CAPABILITIES">NM_BT_CAPABILITIES</a></code>
- u</li><li><code><a href="#type-NM_DEVICE_CAP">NM_DEVICE_CAP</a></code>
- u</li><li><code><a href="#type-NM_DEVICE_STATE">NM_DEVICE_STATE</a></code>
- u</li><li><code><a href="#type-NM_DEVICE_STATE_REASON">NM_DEVICE_STATE_REASON</a></code>
- u</li><li><code><a href="#type-NM_DEVICE_TYPE">NM_DEVICE_TYPE</a></code>
- u</li><li><code><a href="#type-NM_SETTINGS_SYSTEM_PERMISSIONS">NM_SETTINGS_SYSTEM_PERMISSIONS</a></code>
- u</li><li><code><a href="#type-NM_STATE">NM_STATE</a></code>
- u</li><li><code><a href="#type-NM_VPN_CONNECTION_STATE">NM_VPN_CONNECTION_STATE</a></code>
- u</li><li><code><a href="#type-NM_VPN_CONNECTION_STATE_REASON">NM_VPN_CONNECTION_STATE_REASON</a></code>
- u</li><li><code><a href="#type-NM_VPN_PLUGIN_FAILURE">NM_VPN_PLUGIN_FAILURE</a></code>
- u</li><li><code><a href="#type-String_String_Map">String_String_Map</a></code>
- a{ s → s }
</li><li><code><a href="#type-String_String_Variant_Map_Map">String_String_Variant_Map_Map</a></code>
- a{ s → a{sv} }
</li><li><code><a href="#type-String_Variant_Map">String_Variant_Map</a></code>
- a{ s → v }
</li></ul></body></html>
