Permission is granted to copy, distribute and/or modify this
document under the terms of the GNU Free
Documentation License, Version 1.1 or any later
@@ -61,25 +61,25 @@
This section details the architectural and D-Bus API changes in
NetworkManager 0.9.
-Elimination of the User Settings Service
+Elimination of the User Settings Service
Previously there were two "settings services", or D-Bus services that
provided and saved network configuration information. NetworkManager
@@ -103,7 +103,7 @@
-User Secret Agents
+User Secret Agents
Even with the elimination of the user settings service, in some cases it
is still desirable to store secrets in the user's session and not in
@@ -152,7 +152,7 @@
-Settings Service Interface Changes
+Settings Service Interface Changes
With the elimination of the user settings service, the old
org.freedesktop.NetworkManagerUserSettings and
@@ -188,7 +188,7 @@
-Connection Object Interface Changes
+Connection Object Interface Changes
Consistent with the interface changes to the Settings object, the
Connection object's D-Bus interface has changed to
@@ -222,7 +222,7 @@
-Permissions Methods Consolidation
+Permissions Methods Consolidation
Previously there were two D-Bus method calls to retrieve the list of
operations that a user client could perform, and two signals notifying
@@ -254,7 +254,7 @@
are now string-based permissions. The mapping is as follows:
-
Table 17.
+
Table 17.
@@ -305,7 +305,7 @@
-AddConnection Returns Object Path of New Connection
+AddConnection Returns Object Path of New Connection
Many new mobile broadband devices support multiple access families, like
Qualcomm Gobi cards (CDMA/EVDO and GSM/UMTS), or multi-mode EVDO/LTE
@@ -413,7 +413,7 @@
-Secret Property Flags
+Secret Property Flags
In the Connection object's configuration properties, each setting's secret
properties (like WiFi passphrases, or public key passwords, etc) now has
@@ -422,7 +422,7 @@
following values:
-
Table 18.
+
Table 18.
@@ -484,7 +484,7 @@
-Deprecated Methods Removed
+Deprecated Methods Removed
A few methods and signals of the org.freedesktop.NetworkManager
interface deprecated in version 0.7 have been removed. All the
@@ -494,7 +494,7 @@
their replacements:
diff --git a/docs/api/html/spec.html b/docs/api/html/spec.html
index 5bb127d4..4533e786 100644
--- a/docs/api/html/spec.html
+++ b/docs/api/html/spec.html
@@ -258,7 +258,8 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
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]
+ DEVICE, OLPC]. If an empty string is given, the log level is changed
+ but the current set of log domains remains unchanged.
state (
) →
@@ -476,6 +477,13 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
(NM_DEVICE_STATE)
The current state of the device.
+
ActiveConnection -
+ o -
+ (read)
+ Object path of an ActiveConnection object that "owns" this device during
+ activation. The ActiveConnection object tracks the life-cycle of a
+ connection to a specific network and implements the
+ org.freedesktop.NetworkManager.Connection.Active D-Bus interface.
Ip4Config -
o -
(read)
@@ -1093,7 +1101,13 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ Objects that implement the Connection.Active interface represent an attempt
+ to connect to a network using the details provided by a Connection object.
+ The Connection.Active object tracks the life-cycle of the connection
+ attempt and if successful indicates whether the connected network is the
+ "default" or preferred network for access.
+
properties -
a{sv}
diff --git a/docs/api/spec.html b/docs/api/spec.html
index 5bb127d4..4533e786 100644
--- a/docs/api/spec.html
+++ b/docs/api/spec.html
@@ -258,7 +258,8 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
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]
+ DEVICE, OLPC]. If an empty string is given, the log level is changed
+ but the current set of log domains remains unchanged.
state (
) →
@@ -476,6 +477,13 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
(NM_DEVICE_STATE)
The current state of the device.
+
ActiveConnection -
+ o -
+ (read)
+ Object path of an ActiveConnection object that "owns" this device during
+ activation. The ActiveConnection object tracks the life-cycle of a
+ connection to a specific network and implements the
+ org.freedesktop.NetworkManager.Connection.Active D-Bus interface.
Ip4Config -
o -
(read)
@@ -1093,7 +1101,13 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ Objects that implement the Connection.Active interface represent an attempt
+ to connect to a network using the details provided by a Connection object.
+ The Connection.Active object tracks the life-cycle of the connection
+ attempt and if successful indicates whether the connected network is the
+ "default" or preferred network for access.
+
@@ -457,13 +457,13 @@ other attributes like security settings, channel, etc.
connections :
a list of
-NMConnection objects to filter. [element-type NetworkManager.Connection]
+NMConnection objects to filter. [element-type NetworkManager.Connection]
Returns :
a
-list of NMConnection objects that could be activated with the given ap.
+list of NMConnection objects that could be activated with the given ap.
The elements of the list are owned by their creator and should not be freed
by the caller, but the returned list itself is owned by the caller and should
be freed with g_slist_free() when it is no longer required. [transfer container][element-type NetworkManager.Connection]
@@ -476,7 +476,7 @@ be freed with
@@ -462,7 +462,7 @@ details of the newly added connection. [
nm_client_add_and_activate_connection ()
void nm_client_add_and_activate_connection
(NMClient *client,
- NMConnection *partial,
+ NMConnection *partial,
NMDevice *device,
const char *specific_object,
NMClientAddActivateFn callback,
@@ -483,7 +483,7 @@ Cannot be used for VPN connections at this time.
partial :
-
an NMConnection to add; the connection may be
+
an NMConnection to add; the connection may be
partially filled (or even NULL) and will be completed by NetworkManager
using the given device and specific_object before being added. [allow-none]
@@ -728,13 +762,13 @@ incompatible with the device.
connections :
-
a list of NMConnection objects to filter. [element-type NetworkManager.Connection]
+
a list of NMConnection objects to filter. [element-type NetworkManager.Connection]
Returns :
a
-list of NMConnection objects that could be activated with the given device.
+list of NMConnection objects that could be activated with the given device.
The elements of the list are owned by their creator and should not be freed
by the caller, but the returned list itself is owned by the caller and should
be freed with g_slist_free() when it is no longer required. [transfer container][element-type NetworkManager.Connection]
@@ -747,7 +781,7 @@ be freed with
Validates a given connection for a given NMDevice object and returns
whether the connection may be activated with the device. For example if
@@ -766,7 +800,7 @@ device.
@@ -256,13 +256,13 @@ returned connections will match the nsp'
connections :
a list of
-NMConnection objects to filter. [element-type NetworkManager.Connection]
+NMConnection objects to filter. [element-type NetworkManager.Connection]
Returns :
a
-list of NMConnection objects that could be activated with the given nsp.
+list of NMConnection objects that could be activated with the given nsp.
The elements of the list are owned by their creator and should not be freed
by the caller, but the returned list itself is owned by the caller and should
be freed with g_slist_free() when it is no longer required. [transfer container][element-type NetworkManager.Connection]
@@ -275,7 +275,7 @@ be freed with
+An NMConnection describes all the settings and configuration values that
+are necessary to configure network devices for operation on a specific
+network. Connections are the fundamental operating object for
+NetworkManager; no device is connected without a NMConnection, or
+disconnected without having been connected with a NMConnection.
+
+
+Each NMConnection contains a list of NMSetting objects usually referenced
+by name (using nm_connection_get_setting_by_name()) or by type (with
+nm_connection_get_setting()). The settings describe the actual parameters
+with which the network devices are configured, including device-specific
+parameters (MTU, SSID, APN, channel, rate, etc) and IP-level parameters
+(addresses, routes, addressing methods, etc).
+
+Describes errors that may result from operations involving a NMConnection.
+
+
+
+
+
+
NM_CONNECTION_ERROR_UNKNOWN
+
unknown or unclassified error
+
+
+
+
NM_CONNECTION_ERROR_CONNECTION_SETTING_NOT_FOUND
+
the NMConnection object
+ did not contain the required NMSettingConnection object, which must be
+ present for all connections
+
+
+
+
NM_CONNECTION_ERROR_CONNECTION_TYPE_INVALID
+
the 'type' property of the
+ 'connection' setting did not point to a valid connection base type; ie
+ it was not a hardware-related setting like NMSettingWired or
+ NMSettingWireless.
+
+Adds a NMSetting to the connection, replacing any previous NMSetting of the
+same name which has previously been added to the NMConnection. The
+connection takes ownership of the NMSetting object and does not increase
+the setting object's reference count.
+
+Compares two NMConnection objects for similarity, with comparison behavior
+modified by a set of flags. See nm_setting_compare() for a description of
+each flag's behavior.
+
+Compares two NMConnection objects for similarity, with comparison behavior
+modified by a set of flags. See nm_setting_compare() for a description of
+each flag's behavior. If the connections differ, settings and keys within
+each setting that differ are added to the returned out_settings hash table.
+No values are returned, only key names.
+
if the
+connections differ, on return a hash table mapping setting names to
+second-level GHashTable (utf8 to guint32), which contains the key names that
+differ mapped to one or more of NMSettingDiffResult as a bitfield. [element-type utf8 GLib.HashTable]
+
+
+
+
Returns :
+
+TRUE if the connections contain the same values, FALSE if they do
+not
+Validates the connection and all its settings. Each setting's properties
+have allowed values, and some values are dependent on other values. For
+example, if a WiFi connection is security enabled, the NMSettingWireless
+setting object's 'security' property must contain the setting name of the
+NMSettingWirelessSecurity object, which must also be present in the
+connection for the connection to be valid. As another example, the
+NMSettingWired object's 'mac-address' property must be a validly formatted
+MAC address. The returned GError contains information about which
+setting and which property failed validation, and how it failed validation.
+
+Returns the name of the first setting object in the connection which would
+need secrets to make a successful connection. The returned hints are only
+intended as a guide to what secrets may be required, because in some
+circumstances, there is no way to conclusively determine exactly which
+secrets are needed.
+
the address of a pointer to a GPtrArray, initialized to NULL, which on
+return points to an allocated GPtrArray containing the property names of
+secrets of the NMSetting which may be required; the caller owns the array
+and must free the each array element with g_free(), as well as the array
+itself with g_ptr_array_free(). [out callee-allocates][element-type utf8][allow-none][transfer full]
+
+
+
+
Returns :
+
the setting name of the NMSetting object which has invalid or
+missing secrets
+Update the specified setting's secrets, given a hash table of secrets
+intended for that setting (deserialized from D-Bus for example). Will also
+extract the given setting's secrets hash if given a hash of hashes, as would
+be returned from nm_connection_to_hash().
+
+Converts the NMConnection into a GHashTable describing the connection,
+suitable for marshalling over D-Bus or serializing. The hash table mapping
+is string:GHashTable with each element in the returned hash representing
+a NMSetting object. The keys are setting object names, and the values
+are GHashTables mapping string:GValue, each of which represents the
+properties of the NMSetting object.
+
a new
+GHashTable describing the connection, its settings, and each setting's
+properties. The caller owns the hash table and must unref the hash table
+with g_hash_table_unref() when it is no longer needed. [transfer full][element-type utf8 GLib.HashTable]
+
+Print the connection to stdout. For debugging purposes ONLY, should NOT
+be used for serialization of the connection or machine-parsed in any way. The
+output format is not guaranteed to be stable and may change at any time.
+
+The ::secrets-updated signal is emitted when the secrets of a setting
+have been changed.
+
+
+
+
+
+
connection :
+
the object on which the signal is emitted
+
+
+
setting_name :
+
the setting name of the NMSetting for which secrets were
+updated
+
+
+
user_data :
+
user data set when the signal handler was connected.
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/libnm-util/html/NMSetting.html b/docs/libnm-util/html/NMSetting.html
index c77c5985..b9c258d2 100644
--- a/docs/libnm-util/html/NMSetting.html
+++ b/docs/libnm-util/html/NMSetting.html
@@ -6,7 +6,7 @@
-
+
@@ -14,7 +14,7 @@
-
+
libnm-util Reference Manual
@@ -140,7 +140,7 @@ enum NMSetting contains properties that describe configuration that applies
to a specific network layer (like IPv4 or IPv6 configuration) or device type
(like Ethernet, or WiFi). A collection of individual settings together
-make up an NMConnection. Each property is strongly typed and usually has
+make up an NMConnection. Each property is strongly typed and usually has
a number of allowed values. See each NMSetting subclass for a description
of properties and allowed values.
@@ -420,7 +420,7 @@ when calling NMSetting into a GHashTable mapping each setting property
name to a GValue describing that property, suitable for marshalling over
-D-Bus or serializing. The mapping is string:GValue.
+D-Bus or serializing. The mapping is string to GValue.
@@ -437,7 +437,8 @@ D-Bus or serializing. The mapping is string:GValue.
Returns :
-
a new GHashTable describing the setting's properties. [transfer full][element-type utf8 GObject.Value]
+
a new GHashTable
+describing the setting's properties. [transfer full][element-type utf8 GObject.Value]
@@ -465,8 +466,9 @@ property names and value types.
hash :
-
the GHashTable containing a string:GValue mapping of properties
-that apply to the setting
+
the GHashTable containing a
+string to GValue mapping of properties that apply to the setting. [element-type utf8 GObject.Value]
+
if the settings differ, on return a
-hash table mapping the differing keys to one or more NMSettingDiffResult
-values OR-ed together. If the settings do not differ, any hash table passed
-in is unmodified. If no hash table is passed in, a new one is created. [element-type utf8 guint32]
+
if the
+settings differ, on return a hash table mapping the differing keys to one or
+more NMSettingDiffResult values OR-ed together. If the settings do not
+differ, any hash table passed in is unmodified. If no hash table is passed
+in and the settings differ, a new one is created and returned. [inout][transfer full][element-type utf8 guint32]
@@ -847,8 +850,9 @@ setting (deserialized from D-Bus for example).
secrets :
-
a GHashTable mapping string:GValue of setting property names and
-secrets
+
a GHashTable mapping
+string to GValue of setting property names and secrets. [element-type utf8 GObject.Value]
+
when scheme is set to either NM_SETTING_802_1X_CK_SCHEME_PATH or
NM_SETTING_802_1X_CK_SCHEME_BLOB, pass the path of the "phase2" private
key file (PEM, DER, or PKCS12 format). The path must be UTF-8 encoded;
diff --git a/docs/libnm-util/html/NMSettingConnection.html b/docs/libnm-util/html/NMSettingConnection.html
index 27c30ebd..2b113d2d 100644
--- a/docs/libnm-util/html/NMSettingConnection.html
+++ b/docs/libnm-util/html/NMSettingConnection.html
@@ -117,8 +117,8 @@ const char *
Description
The NMSettingConnection object is a NMSetting subclass that describes
-properties that apply to all NMConnection objects, regardless of what type
-of network connection they describe. Each NMConnection object must contain
+properties that apply to all NMConnection objects, regardless of what type
+of network connection they describe. Each NMConnection object must contain
a NMSettingConnection setting.
@@ -170,7 +170,7 @@ Describes errors that may result from operations involving a
the NMSetting object
referenced by the setting name contained in the
- "type" property was not present in the NMConnection
+ "type" property was not present in the NMConnection
-Iterates all data items stored in this setting
+Iterates all data items stored in this setting. It is safe to add, remove,
+and modify data items inside func, though any additions or removals made
+during iteration will not be part of the iteration.
@@ -331,7 +333,9 @@ Iterates all data items stored in this setting
NMVPNIterFunc func,
gpointer user_data);
-Iterates all secrets stored in this setting.
+Iterates all secrets stored in this setting. It is safe to add, remove,
+and modify secrets inside func, though any additions or removals made during
+iteration will not be part of the iteration.
diff --git a/docs/libnm-util/html/annotation-glossary.html b/docs/libnm-util/html/annotation-glossary.html
index e0a1c869..5c359816 100644
--- a/docs/libnm-util/html/annotation-glossary.html
+++ b/docs/libnm-util/html/annotation-glossary.html
@@ -24,6 +24,8 @@
|
A
|
+ I
+ |
E
|
T
@@ -44,6 +46,10 @@
allow-none
NULL is ok, both for passing and for returning.
+
I
+
+inout
+
Parameter for input and for returning results. Default is transfer full.
E
element-type
diff --git a/docs/libnm-util/html/api-index-full.html b/docs/libnm-util/html/api-index-full.html
index b6776b7d..0ea92385 100644
--- a/docs/libnm-util/html/api-index-full.html
+++ b/docs/libnm-util/html/api-index-full.html
@@ -41,195 +41,195 @@
API Index