NMConnection

@@ -35,1834 +30,2326 @@

NMConnection

NMConnection — Describes a connection to specific network or provider

- +

Synopsis

#define             NM_CONNECTION_SECRETS_UPDATED
-#define             NM_CONNECTION_SECRETS_CLEARED
-#define             NM_CONNECTION_CHANGED
-#define             NM_CONNECTION_NORMALIZE_PARAM_IP6_CONFIG_METHOD
-                    NMConnectionInterface;
-void                nm_connection_add_setting           (NMConnection *connection,
-                                                         NMSetting *setting);
-void                nm_connection_remove_setting        (NMConnection *connection,
-                                                         GType setting_type);
-NMSetting *         nm_connection_get_setting           (NMConnection *connection,
-                                                         GType setting_type);
-NMSetting *         nm_connection_get_setting_by_name   (NMConnection *connection,
-                                                         const char *name);
-#define             NM_VARIANT_TYPE_SETTING
-enum                NMConnectionSerializationFlags;
-GVariant *          nm_connection_to_dbus               (NMConnection *connection,
-                                                         NMConnectionSerializationFlags flags);
-gboolean            nm_connection_replace_settings      (NMConnection *connection,
-                                                         GVariant *new_settings,
-                                                         GError **error);
-void                nm_connection_replace_settings_from_connection
-                                                        (NMConnection *connection,
-                                                         NMConnection *new_connection);
-void                nm_connection_clear_settings        (NMConnection *connection);
-gboolean            nm_connection_compare               (NMConnection *a,
-                                                         NMConnection *b,
-                                                         NMSettingCompareFlags flags);
-gboolean            nm_connection_diff                  (NMConnection *a,
-                                                         NMConnection *b,
-                                                         NMSettingCompareFlags flags,
-                                                         GHashTable **out_settings);
-gboolean            nm_connection_verify                (NMConnection *connection,
-                                                         GError **error);
-gboolean            nm_connection_normalize             (NMConnection *connection,
-                                                         GHashTable *parameters,
-                                                         gboolean *modified,
-                                                         GError **error);
-const char *        nm_connection_need_secrets          (NMConnection *connection,
-                                                         GPtrArray **hints);
-void                nm_connection_clear_secrets         (NMConnection *connection);
-void                nm_connection_clear_secrets_with_flags
-                                                        (NMConnection *connection,
-                                                         NMSettingClearSecretsWithFlagsFn func,
-                                                         gpointer user_data);
-gboolean            nm_connection_update_secrets        (NMConnection *connection,
-                                                         const char *setting_name,
-                                                         GVariant *secrets,
-                                                         GError **error);
-void                nm_connection_set_path              (NMConnection *connection,
-                                                         const char *path);
-const char *        nm_connection_get_path              (NMConnection *connection);
-const char *        nm_connection_get_interface_name    (NMConnection *connection);
-gboolean            nm_connection_is_type               (NMConnection *connection,
-                                                         const char *type);
-void                nm_connection_for_each_setting_value
-                                                        (NMConnection *connection,
-                                                         NMSettingValueIterFn func,
-                                                         gpointer user_data);
-void                nm_connection_dump                  (NMConnection *connection);
-const char *        nm_connection_get_uuid              (NMConnection *connection);
-const char *        nm_connection_get_id                (NMConnection *connection);
-const char *        nm_connection_get_connection_type   (NMConnection *connection);
-gboolean            nm_connection_is_virtual            (NMConnection *connection);
-char *              nm_connection_get_virtual_device_description
-                                                        (NMConnection *connection);
-NMSetting8021x *    nm_connection_get_setting_802_1x    (NMConnection *connection);
-NMSettingBluetooth * nm_connection_get_setting_bluetooth
-                                                        (NMConnection *connection);
-NMSettingBond *     nm_connection_get_setting_bond      (NMConnection *connection);
-NMSettingTeam *     nm_connection_get_setting_team      (NMConnection *connection);
-NMSettingTeamPort * nm_connection_get_setting_team_port (NMConnection *connection);
-NMSettingBridge *   nm_connection_get_setting_bridge    (NMConnection *connection);
-NMSettingBridgePort * nm_connection_get_setting_bridge_port
-                                                        (NMConnection *connection);
-NMSettingCdma *     nm_connection_get_setting_cdma      (NMConnection *connection);
-NMSettingConnection * nm_connection_get_setting_connection
-                                                        (NMConnection *connection);
-NMSettingDcb *      nm_connection_get_setting_dcb       (NMConnection *connection);
-NMSettingGeneric *  nm_connection_get_setting_generic   (NMConnection *connection);
-NMSettingGsm *      nm_connection_get_setting_gsm       (NMConnection *connection);
-NMSettingInfiniband * nm_connection_get_setting_infiniband
-                                                        (NMConnection *connection);
-NMSettingIPConfig * nm_connection_get_setting_ip4_config
-                                                        (NMConnection *connection);
-NMSettingIPConfig * nm_connection_get_setting_ip6_config
-                                                        (NMConnection *connection);
-NMSettingOlpcMesh * nm_connection_get_setting_olpc_mesh (NMConnection *connection);
-NMSettingPpp *      nm_connection_get_setting_ppp       (NMConnection *connection);
-NMSettingPppoe *    nm_connection_get_setting_pppoe     (NMConnection *connection);
-NMSettingSerial *   nm_connection_get_setting_serial    (NMConnection *connection);
-NMSettingVpn *      nm_connection_get_setting_vpn       (NMConnection *connection);
-NMSettingWimax *    nm_connection_get_setting_wimax     (NMConnection *connection);
-NMSettingAdsl *     nm_connection_get_setting_adsl      (NMConnection *connection);
-NMSettingWired *    nm_connection_get_setting_wired     (NMConnection *connection);
-NMSettingWireless * nm_connection_get_setting_wireless  (NMConnection *connection);
-NMSettingWirelessSecurity * nm_connection_get_setting_wireless_security
-                                                        (NMConnection *connection);
-NMSettingVlan *     nm_connection_get_setting_vlan      (NMConnection *connection);
-

Object Hierarchy

-  GFlags
-   +----NMConnectionSerializationFlags
-

Description

-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). -

Details

NM_CONNECTION_SECRETS_UPDATED

#define NM_CONNECTION_SECRETS_UPDATED "secrets-updated"
-

NM_CONNECTION_SECRETS_CLEARED

#define NM_CONNECTION_SECRETS_CLEARED "secrets-cleared"
-

NM_CONNECTION_CHANGED

#define NM_CONNECTION_CHANGED         "changed"
-

NM_CONNECTION_NORMALIZE_PARAM_IP6_CONFIG_METHOD

#define NM_CONNECTION_NORMALIZE_PARAM_IP6_CONFIG_METHOD "ip6-config-method"
-

NMConnectionInterface

typedef struct {
-	GTypeInterface parent;
-
-	/* Signals */
-	void (*secrets_updated) (NMConnection *connection,
-	                         const char   *setting);
-	void (*secrets_cleared) (NMConnection *connection);
-	void (*changed)         (NMConnection *connection);
-} NMConnectionInterface;
-

Functions

--++ - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - + + - - + + - - + +

GTypeInterface `parent`;	the parent interace struct	+void +	+nm_connection_add_setting () +
+void +	+nm_connection_remove_setting () +
+NMSetting * +	+nm_connection_get_setting () +
+NMSetting * +	+nm_connection_get_setting_by_name () +
+GVariant * +	+nm_connection_to_dbus () +
+gboolean +	+nm_connection_replace_settings () +
+void +	+nm_connection_replace_settings_from_connection () +
+void +	+nm_connection_clear_settings () +
+gboolean +	+nm_connection_compare () +
+gboolean +	+nm_connection_diff () +
+gboolean +	+nm_connection_verify () +
+gboolean +	+nm_connection_normalize () +
const char * +	+nm_connection_need_secrets () +
+void +	+nm_connection_clear_secrets () +
+void +	+nm_connection_clear_secrets_with_flags () +
+gboolean +	+nm_connection_update_secrets () +
+void +	+nm_connection_set_path () +
const char * +	+nm_connection_get_path () +
const char * +	+nm_connection_get_interface_name () +
+gboolean +	+nm_connection_is_type () +
+void +	+nm_connection_for_each_setting_value () +
+void +	+nm_connection_dump () +
const char * +	+nm_connection_get_uuid () +
const char * +	+nm_connection_get_id () +
const char * +	+nm_connection_get_connection_type () +
+gboolean +	+nm_connection_is_virtual () +
+char * +	+nm_connection_get_virtual_device_description () +
+NMSetting8021x * +	+nm_connection_get_setting_802_1x () +
+NMSettingBluetooth * +	+nm_connection_get_setting_bluetooth () +
+NMSettingBond * +	+nm_connection_get_setting_bond () +
+NMSettingTeam * +	+nm_connection_get_setting_team () +
+NMSettingTeamPort * +	+nm_connection_get_setting_team_port () +
+NMSettingBridge * +	+nm_connection_get_setting_bridge () +
+NMSettingBridgePort * +	+nm_connection_get_setting_bridge_port () +
+NMSettingCdma * +	+nm_connection_get_setting_cdma () +
+NMSettingConnection * +	+nm_connection_get_setting_connection () +
+NMSettingDcb * +	+nm_connection_get_setting_dcb () +
+NMSettingGeneric * +	+nm_connection_get_setting_generic () +
+NMSettingGsm * +	+nm_connection_get_setting_gsm () +
+NMSettingInfiniband * +	+nm_connection_get_setting_infiniband () +
+NMSettingIPConfig * +	+nm_connection_get_setting_ip4_config () +
+NMSettingIPConfig * +	+nm_connection_get_setting_ip6_config () +
+NMSettingOlpcMesh * +	+nm_connection_get_setting_olpc_mesh () +
+NMSettingPpp * +	+nm_connection_get_setting_ppp () +
+NMSettingPppoe * +	+nm_connection_get_setting_pppoe () +
+NMSettingSerial * +	+nm_connection_get_setting_serial () +
+NMSettingVpn * +	+nm_connection_get_setting_vpn () +
+NMSettingWimax * +	+nm_connection_get_setting_wimax () +
+NMSettingAdsl * +	+nm_connection_get_setting_adsl () +
+NMSettingWired * +	+nm_connection_get_setting_wired () +
`secrets_updated` ()	emitted when the connection's secrets are updated	+NMSettingWireless * +	+nm_connection_get_setting_wireless () +
`secrets_cleared` ()	emitted when the connection's secrets are cleared	+NMSettingWirelessSecurity * +	+nm_connection_get_setting_wireless_security () +
`changed` ()	emitted when any change to the connection's settings occurs	+NMSettingVlan * +	+nm_connection_get_setting_vlan () +

nm_connection_add_setting ()

void                nm_connection_add_setting           (NMConnection *connection,
-                                                         NMSetting *setting);

-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. -

Types and Values

--++ - - + + - - + + + + + + + + + + + + + + + + + + + + + +

`connection` :	a NMConnection -	#define	NM_CONNECTION_SECRETS_UPDATED
`setting` :	the NMSetting to add to the connection object. [transfer full] -	#define	NM_CONNECTION_SECRETS_CLEARED
#define	NM_CONNECTION_CHANGED
#define	NM_CONNECTION_NORMALIZE_PARAM_IP6_CONFIG_METHOD
	NMConnectionInterface
#define	NM_VARIANT_TYPE_SETTING
enum	NMConnectionSerializationFlags

Object Hierarchy

    GFlags
+    ╰── NMConnectionSerializationFlags
+

Description

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).

Functions

nm_connection_remove_setting ()

void                nm_connection_remove_setting        (NMConnection *connection,
-                                                         GType setting_type);

-Removes the NMSetting with the given GType from the NMConnection. This -operation dereferences the NMSetting object. -

nm_connection_add_setting ()

void
+nm_connection_add_setting (NMConnection *connection,
+                           NMSetting *setting);

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.

Parameters

--+++ - - + + + - - + + +

`connection` :	a NMConnection -	connection	a NMConnection
`setting_type` :	the GType of the setting object to remove	setting	the NMSetting to add to the connection object.	[transfer full]

nm_connection_get_setting ()

NMSetting *         nm_connection_get_setting           (NMConnection *connection,
-                                                         GType setting_type);

-Gets the NMSetting with the given GType, if one has been previously added -to the NMConnection. -

nm_connection_remove_setting ()

void
+nm_connection_remove_setting (NMConnection *connection,
+                              GType setting_type);

Removes the NMSetting with the given GType from the NMConnection. This +operation dereferences the NMSetting object.

Parameters

--+++ - - - - - - + + + - - + + +

`connection` :	a NMConnection -
`setting_type` :	the GType of the setting object to return	connection	a NMConnection
Returns :	the NMSetting, or `NULL` if no setting of that type was previously -added to the NMConnection. [transfer none] -	setting_type	the GType of the setting object to remove

nm_connection_get_setting_by_name ()

NMSetting *         nm_connection_get_setting_by_name   (NMConnection *connection,
-                                                         const char *name);

-Gets the NMSetting with the given name, if one has been previously added -the NMConnection. -

nm_connection_get_setting ()

NMSetting *
+nm_connection_get_setting (NMConnection *connection,
+                           GType setting_type);

Gets the NMSetting with the given GType, if one has been previously added +to the NMConnection.

Parameters

--+++ - - + + + - - - - - - + + +

`connection` :	a NMConnection -	connection	a NMConnection
`name` :	a setting name
Returns :	the NMSetting, or `NULL` if no setting with that name was previously -added to the NMConnection. [transfer none] -	setting_type	the GType of the setting object to return

NM_VARIANT_TYPE_SETTING

#define NM_VARIANT_TYPE_SETTING G_VARIANT_TYPE_VARDICT
-

-GVariantType for a dictionary mapping from property names to values. This is -an alias for G_VARIANT_TYPE_VARDICT, and is the type of each element of -an NM_VARIANT_TYPE_CONNECTION dictionary. -

Returns

the NMSetting, or NULL if no setting of that type was previously +added to the NMConnection.

[transfer none]

enum NMConnectionSerializationFlags

typedef enum {
- /*< flags >*/
-	NM_CONNECTION_SERIALIZE_ALL = 0x00000000,
-	NM_CONNECTION_SERIALIZE_NO_SECRETS = 0x00000001,
-	NM_CONNECTION_SERIALIZE_ONLY_SECRETS = 0x00000002,
-} NMConnectionSerializationFlags;
-

-These flags determine which properties are serialized when calling when -calling nm_connection_to_dbus(). -

nm_connection_get_setting_by_name ()

NMSetting *
+nm_connection_get_setting_by_name (NMConnection *connection,
+                                   const char *name);

Gets the NMSetting with the given name, if one has been previously added +the NMConnection.

Parameters

--+++ - - - - - - + + + - - + + +

`NM_CONNECTION_SERIALIZE_ALL`	serialize all properties (including secrets) -
`NM_CONNECTION_SERIALIZE_NO_SECRETS`	do not include secrets -	connection	a NMConnection
`NM_CONNECTION_SERIALIZE_ONLY_SECRETS`	only serialize secrets -	name	a setting name

Returns

the NMSetting, or NULL if no setting with that name was previously +added to the NMConnection.

[transfer none]

`a` :	a NMConnection -
`b` :	a second NMConnection to compare with the first	a	a NMConnection
`flags` :	compare flags, e.g. `NM_SETTING_COMPARE_FLAG_EXACT` -	b	a second NMConnection to compare with the first
Returns :	-`TRUE` if the comparison succeeds, `FALSE` if it does not	flags	compare flags, e.g. `NM_SETTING_COMPARE_FLAG_EXACT`

`a` :	a NMConnection -	a	a NMConnection
`b` :	a second NMConnection to compare with the first	b	a second NMConnection to compare with the first
`flags` :	compare flags, e.g. `NM_SETTING_COMPARE_FLAG_EXACT` -	flags	compare flags, e.g. `NM_SETTING_COMPARE_FLAG_EXACT`
`out_settings` :	if the +	out_settings	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	[element-type utf8 GLib.HashTable]

`connection` :	the NMConnection to verify
`error` :	location to store error, or `NULL` -	connection	the NMConnection to verify
Returns :	-`TRUE` if the connection is valid, `FALSE` if it is not	error	location to store error, or `NULL`

`connection` :	the NMConnection to normalize	connection	the NMConnection to normalize
`parameters` :	a GHashTable with +	parameters	a GHashTable with normalization parameters to allow customization of the normalization by providing specific arguments. Unknown arguments will be ignored and the default will be -used. The keys must be strings, hashed by `g_str_hash()` and `g_str_equal()` functions. -The values are opaque and depend on the parameter name. [allow-none][element-type utf8 gpointer] -
`modified` :	outputs whether any settings were modified. [out][allow-none] -	[allow-none][element-type utf8 gpointer]
`error` :	location to store error, or `NULL`. Contains the reason, -why the connection is invalid, if the function returns an error.	modified	outputs whether any settings were modified.	[out][allow-none]
Returns :	-`TRUE` if the connection is valid, `FALSE` if it is not	error	location to store error, or `NULL`. Contains the reason, +why the connection is invalid, if the function returns an error.

`connection` :	the NMConnection -	connection	the NMConnection
`hints` :	the address of a pointer to a GPtrArray, initialized to `NULL`, which on -return points to an allocated GPtrArray containing the property names of +	hints	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 array itself with `g_ptr_array_free()`, but not free its -elements. [out][element-type utf8][allow-none][transfer container] -
Returns :	the setting name of the NMSetting object which has invalid or -missing secrets	[out][element-type utf8][allow-none][transfer container]

			libnm Reference Manual
-Top - \| - Description - \| - Object Hierarchy -

`connection` :	a NMConnection -
`new_settings` :	a GVariant of type `NM_VARIANT_TYPE_CONNECTION`, with the new settings	connection	a NMConnection
`error` :	location to store error, or `NULL` -	new_settings	a GVariant of type `NM_VARIANT_TYPE_CONNECTION`, with the new settings
Returns :	-`TRUE` if connection was updated, `FALSE` if `new_settings` could not -be deserialized (in which case `connection` will be unchanged).	error	location to store error, or `NULL`

`connection` :	the NMConnection -
`type` :	a setting name to check the connection's type against (like -`NM_SETTING_WIRELESS_SETTING_NAME` or `NM_SETTING_WIRED_SETTING_NAME`)	connection	the NMConnection
Returns :	-`TRUE` if the connection is of the given `type`, `FALSE` if not	type	a setting name to check the connection's type against (like +`NM_SETTING_WIRELESS_SETTING_NAME` or `NM_SETTING_WIRED_SETTING_NAME`)

`connection` :	an NMConnection -
Returns :	whether `connection` refers to a virtual device
connection	an NMConnection

`connection` :	an NMConnection for a virtual device type
Returns :	the name of `connection`'s device, -or `NULL` if `connection` is not a virtual connection type. [transfer full] -
connection	an NMConnection for a virtual device type

`connection` :	the NMConnection +	NM_CONNECTION_SERIALIZE_ALL	+ serialize all properties (including secrets)
Returns :	an NMSettingVlan if the connection contains one, otherwise `NULL`. [transfer none] +	NM_CONNECTION_SERIALIZE_NO_SECRETS	+ do not include secrets
NM_CONNECTION_SERIALIZE_ONLY_SECRETS	+ only serialize secrets +

`connection` :	the NMConnection -	connection	the NMConnection
`func` :	function to be called to determine whether a -specific secret should be cleared or not. [scope call] -	func	function to be called to determine whether a +specific secret should be cleared or not.	[scope call]
`user_data` :	caller-supplied data passed to `func` -	user_data	caller-supplied data passed to `func` +

NMConnection

Synopsis

Object Hierarchy

Description

Details

NM_CONNECTION_SECRETS_UPDATED

NM_CONNECTION_SECRETS_CLEARED

NM_CONNECTION_CHANGED

NM_CONNECTION_NORMALIZE_PARAM_IP6_CONFIG_METHOD

NMConnectionInterface

Functions

nm_connection_add_setting ()

Types and Values

Object Hierarchy

Description

Functions

nm_connection_remove_setting ()

nm_connection_add_setting ()

Parameters

nm_connection_get_setting ()

nm_connection_remove_setting ()

Parameters

nm_connection_get_setting_by_name ()

nm_connection_get_setting ()

Parameters

NM_VARIANT_TYPE_SETTING

Returns

enum NMConnectionSerializationFlags

nm_connection_get_setting_by_name ()

Parameters

Returns

nm_connection_to_dbus ()

nm_connection_to_dbus ()

Parameters

Returns

nm_connection_replace_settings ()

nm_connection_replace_settings ()

Parameters

Returns

nm_connection_replace_settings_from_connection ()

nm_connection_replace_settings_from_connection ()

Parameters

nm_connection_clear_settings ()

nm_connection_clear_settings ()

Parameters

nm_connection_compare ()

nm_connection_compare ()

Parameters

Returns

nm_connection_diff ()

nm_connection_diff ()

Parameters

Returns

nm_connection_verify ()

nm_connection_verify ()

Parameters

Returns

nm_connection_normalize ()

nm_connection_normalize ()

Parameters

Returns

nm_connection_need_secrets ()

nm_connection_need_secrets ()

Parameters

Returns

nm_connection_clear_secrets ()

nm_connection_clear_secrets ()

Parameters

nm_connection_clear_secrets_with_flags ()

nm_connection_clear_secrets_with_flags ()

Parameters

nm_connection_update_secrets ()

nm_connection_update_secrets ()

Parameters

Returns

nm_connection_set_path ()

nm_connection_set_path ()

Parameters

nm_connection_get_path ()

nm_connection_get_path ()