diff options
| author | Michael Biebl <biebl@debian.org> | 2016-01-20 16:26:51 +0100 |
|---|---|---|
| committer | Michael Biebl <biebl@debian.org> | 2016-01-20 16:26:51 +0100 |
| commit | 494f296a3baab08522617b24b1f126d8f9a17502 (patch) | |
| tree | c8ef32fb0dd1c4ff35a0b38e787abb58692de0cd /docs/api/html/spec.html | |
| parent | 54f6333410ffd570e62717d9e77c5c987175e397 (diff) | |
Imported Upstream version 1.1.90 upstream/1.1.90
Diffstat (limited to 'docs/api/html/spec.html')
| -rw-r--r-- | docs/api/html/spec.html | 117 |
1 files changed, 104 insertions, 13 deletions
diff --git a/docs/api/html/spec.html b/docs/api/html/spec.html index 870e837f..dd4be9bf 100644 --- a/docs/api/html/spec.html +++ b/docs/api/html/spec.html @@ -1,4 +1,4 @@ -<!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 1.0.10</title><style type="text/css"> +<!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 1.1.90</title><style type="text/css"> body { font-family: sans-serif; @@ -97,7 +97,7 @@ margin-right: 4em; } - </style></head><body><h1 class="topbox">NetworkManager D-Bus Interface Specification</h1><h2>Version 1.0.10</h2><div>Copyright (C) 2008 - 2011 Red Hat, Inc.</div><div>Copyright (C) 2008 - 2009 Novell, Inc.</div><div class="license"> + </style></head><body><h1 class="topbox">NetworkManager D-Bus Interface Specification</h1><h2>Version 1.1.90</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 @@ -116,10 +116,22 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</ ) → ao</h3><div class="docstring"> - Get the list of network devices. + Get the list of realized 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. + List of object paths of network devices known to the system. This + list does not include device placeholders (see GetAllDevices()). + </dd></dl></div></div><div class="method"><h3><a name="org.freedesktop.NetworkManager.GetAllDevices" id="org.freedesktop.NetworkManager.GetAllDevices">GetAllDevices</a> ( + + ) → + ao</h3><div class="docstring"> + Get the list of all network devices. + </div><div><h4>Returns</h4><dl><dt><code>devices</code> - + <code>ao</code></dt><dd> + List of object paths of network devices and device placeholders + (eg, devices that do not yet exist but which can be automatically + created by NetworkManager if one of their AvailableConnections + was activated). </dd></dl></div></div><div class="method"><h3><a name="org.freedesktop.NetworkManager.GetDeviceByIpIface" id="org.freedesktop.NetworkManager.GetDeviceByIpIface">GetDeviceByIpIface</a> ( s: iface ) → @@ -246,7 +258,13 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</ 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, TRACE]. + One of [ERR, WARN, INFO, DEBUG, TRACE, OFF, KEEP]. + This level is applied to the domains as specified in the domains + argument. Except for the special level "KEEP", all unmentioned + domains are disabled entirely. "KEEP" is special and allows + not to change the current setting except for the specified + domains. E.g. level=KEEP and domains=PLATFORM:DEBUG will only + touch the platform domain. </dd><dt><code>domains</code> - <code>s</code></dt><dd> A combination of logging domains separated by commas (','), or "NONE" @@ -332,7 +350,16 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</ </dd></dl></div></div><h2>Properties:</h2><dl><dt><code>Devices</code> - <code>ao</code> - <code>(read)</code></dt><dd> - The list of network devices/interfaces NetworkManager knows about. + The list of realized network devices. Realized devices are those which + have backing resources (eg from the kernel or a management daemon like + ModemManager, teamd, etc). + </dd><dt><code>AllDevices</code> - + <code>ao</code> - + <code>(read)</code></dt><dd> + The list of both realized and un-realized network devices. Un-realized + devices are software devices which do not yet have backing resources, + but for which backing resources can be created if the device is + activated. </dd><dt><code>NetworkingEnabled</code> - <code>b</code> - <code>(read)</code></dt><dd> @@ -386,8 +413,8 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</ <code>(read)</code> (<a xmlns="" href="#type-NM_METERED">NM_METERED</a>) </dt><dd> - Wheter the connectivity is metered. This is equivalent to the - metered property of the device associated with the primary + Indicates whether the connectivity is metered. This is equivalent + to the metered property of the device associated with the primary connection. </dd><dt><code>ActivatingConnection</code> - <code>o</code> - @@ -417,6 +444,18 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</ (<a xmlns="" href="#type-NM_CONNECTIVITY">NM_CONNECTIVITY</a>) </dt><dd> The network connectivity state. + </dd><dt><code>GlobalDnsConfiguration</code> - + <code>a{sv}</code> - + <code>(readwrite)</code></dt><dd> + Dictionary of global DNS settings where the key is one of + "searches", "options" and "domains". The values for the + "searches" and "options" keys are string arrays describing the + list of search domains and resolver options, respectively. + The value of the "domains" key is a second-level dictionary, + where each key is a domain name, and each key's value is a + third-level dictionary with the keys "servers" and + "options". "servers" is a string array of DNS servers, + "options" is a string array of domain-specific options. </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> @@ -498,7 +537,23 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</ 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> ( + <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.Reapply" id="org.freedesktop.NetworkManager.Device.Reapply">Reapply</a> ( + a{sa{sv}}: connection, u: flags + ) → + nothing</h3><div class="docstring"> + Attempts to update the configuration of a device without deactivating it. + You can either modify the configuration by passing the desired setup via "connection" + argument or just omit the argument to bring it in sync with the connection that + has been activated but could have been modified since. + </div><div><h4>Parameters</h4><dl><dt><code>connection</code> - + <code>a{sa{sv}}</code></dt><dd> + The effective connection settings and properties to use. If empty, the connection + settings from the connection that is active on the device will be used. + </dd><dt><code>flags</code> - + <code>u</code></dt><dd> + Flags which would modify the behavior of the Reapply call. + There are no flags defined currently and the users should use the value of 0. + </dd></dl></div></div><div class="method"><h3><a name="org.freedesktop.NetworkManager.Device.Disconnect" id="org.freedesktop.NetworkManager.Device.Disconnect">Disconnect</a> ( ) → nothing</h3><div class="docstring"> @@ -613,8 +668,12 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</ 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. + <code>(readwrite)</code></dt><dd> + Whether or not this device is managed by NetworkManager. Setting this + property has a similar effect to configuring the device as unmanaged + via the keyfile.unmanaged-devices setting in NetworkManager.conf. + Changes to this value are not persistent and lost after NetworkManager + restart. </dd><dt><code>Autoconnect</code> - <code>b</code> - <code>(readwrite)</code></dt><dd> @@ -628,6 +687,11 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</ <code>(read)</code></dt><dd> If TRUE, indicates the device is likely missing firmware necessary for its operation. + </dd><dt><code>NmPluginMissing</code> - + <code>b</code> - + <code>(read)</code></dt><dd> + If TRUE, indicates the NetworkManager plugin for the device is likely + missing or misconfigured. </dd><dt><code>DeviceType</code> - <code>u</code> - <code>(read)</code> @@ -656,6 +720,17 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</ </dt><dd> Whether the amount of traffic flowing through the device is subject to limitations, for example set by service providers. + </dd><dt><code>LldpNeighbors</code> - + <code>aa{sv}</code> - + <code>(read)</code></dt><dd> + Array of LLDP neighbors; each element is a dictionary mapping + LLDP TLV names to variant boxed values. + </dd><dt><code>Real</code> - + <code>b</code> - + <code>(read)</code></dt><dd> + True if the device exists, or False for placeholder devices that + do not yet exist but could be automatically created by NetworkManager + if one of their AvailableConnections was activated. </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 = 10</code></dt><dd> @@ -883,6 +958,10 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</ <code>u</code> - <code>(read)</code></dt><dd> Design speed of the device, in megabits/second (Mb/s). + </dd><dt><code>S390Subchannels</code> - + <code>as</code> - + <code>(read)</code></dt><dd> + Array of S/390 subchannels for S/390 or z/Architecture devices. </dd><dt><code>Carrier</code> - <code>b</code> - <code>(read)</code></dt><dd> @@ -1351,7 +1430,13 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</ <code>as</code> - <code>(read)</code></dt><dd>A list of domains this address belongs to.</dd><dt><code>Searches</code> - <code>as</code> - - <code>(read)</code></dt><dd>A list of dns searches.</dd><dt><code>WinsServers</code> - + <code>(read)</code></dt><dd>A list of dns searches.</dd><dt><code>DnsOptions</code> - + <code>as</code> - + <code>(read)</code></dt><dd> + A list of DNS options that modify the behavior of the DNS + resolver. See resolv.conf(5) manual page for the list of + supported options. + </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></dl> @@ -1395,7 +1480,13 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</ <code>as</code> - <code>(read)</code></dt><dd>A list of domains this address belongs to.</dd><dt><code>Searches</code> - <code>as</code> - - <code>(read)</code></dt><dd>A list of dns searches.</dd></dl> + <code>(read)</code></dt><dd>A list of dns searches.</dd><dt><code>DnsOptions</code> - + <code>as</code> - + <code>(read)</code></dt><dd> + A list of DNS options that modify the behavior of the DNS + resolver. See resolv.conf(5) manual page for the list of + supported options. + </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. |