nm_connection_error_quark ()

GQuark
nm_connection_error_quark (void);

Registers an error quark for NMConnection if necessary.

nm_connection_new ()

NMConnection *
nm_connection_new (void);

Creates a new NMConnection object with no NMSetting objects.

nm_connection_new_from_hash ()

NMConnection *
nm_connection_new_from_hash (GHashTable *hash,
                             GError **error);

Creates a new NMConnection from a hash table describing the connection. See nm_connection_to_hash() for a description of the expected hash table.

nm_connection_duplicate ()

NMConnection *
nm_connection_duplicate (NMConnection *connection);

Duplicates a NMConnection.

nm_connection_create_setting ()

NMSetting *
nm_connection_create_setting (const char *name);

Create a new NMSetting object of the desired type, given a setting name.

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.

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_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_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_replace_settings ()

gboolean
nm_connection_replace_settings (NMConnection *connection,
                                GHashTable *new_settings,
                                GError **error);

nm_connection_replace_settings_from_connection ()

gboolean
nm_connection_replace_settings_from_connection
                               (NMConnection *connection,
                                NMConnection *new_connection,
                                GError **error);

Deep-copies the settings of new_conenction and replaces the settings of connection with the copied settings.

Since 0.9.10

nm_connection_compare ()

gboolean
nm_connection_compare (NMConnection *a,
                       NMConnection *b,
                       NMSettingCompareFlags flags);

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.

nm_connection_diff ()

gboolean
nm_connection_diff (NMConnection *a,
                    NMConnection *b,
                    NMSettingCompareFlags flags,
                    GHashTable **out_settings);

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.

nm_connection_verify ()

gboolean
nm_connection_verify (NMConnection *connection,
                      GError **error);

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

nm_connection_normalize ()

gboolean
nm_connection_normalize (NMConnection *connection,
                         GHashTable *parameters,
                         gboolean *modified,
                         GError **error);

Does some basic normalization and fixup of well known inconsistencies and deprecated fields. If the connection was modified in any way, the output parameter modified is set TRUE.

Finally the connection will be verified and TRUE returns if the connection is valid. As this function only performs some specific normalization steps it cannot repair all connections. If the connection has errors that cannot be normalized, the connection will not be modified.

Since 1.0

nm_connection_need_secrets ()

const char *
nm_connection_need_secrets (NMConnection *connection,
                            GPtrArray **hints);

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.

nm_connection_clear_secrets ()

void
nm_connection_clear_secrets (NMConnection *connection);

Clears and frees any secrets that may be stored in the connection, to avoid keeping secret data in memory when not needed.

nm_connection_clear_secrets_with_flags ()

void
nm_connection_clear_secrets_with_flags
                               (NMConnection *connection,
                                NMSettingClearSecretsWithFlagsFn func,
                                gpointer user_data);

Clears and frees secrets determined by func .

nm_connection_update_secrets ()

gboolean
nm_connection_update_secrets (NMConnection *connection,
                              const char *setting_name,
                              GHashTable *secrets,
                              GError **error);

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(). If setting_name is NULL, expects a fully serialized NMConnection as returned by nm_connection_to_hash() and will update all secrets from all settings contained in secrets .

nm_connection_set_path ()

void
nm_connection_set_path (NMConnection *connection,
                        const char *path);

Sets the D-Bus path of the connection. This property is not serialized, and is only for the reference of the caller. Sets the “path” property.

nm_connection_get_path ()

const char *
nm_connection_get_path (NMConnection *connection);

Returns the connection's D-Bus path.

nm_connection_get_virtual_iface_name ()

const char *
nm_connection_get_virtual_iface_name (NMConnection *connection);

Returns the name of the virtual kernel interface which the connection needs to use if specified in the settings. This function abstracts all connection types which require this functionality. For all other connection types, this function will return NULL.

nm_connection_get_interface_name ()

const char *
nm_connection_get_interface_name (NMConnection *connection);

Returns the interface name as stored in NMSettingConnection:interface_name. If the connection contains no NMSettingConnection, it will return NULL.

For hardware devices and software devices created outside of NetworkManager, this name is used to match the device. for software devices created by NetworkManager, this is the name of the created interface.

Since 1.0

nm_connection_is_type ()

gboolean
nm_connection_is_type (NMConnection *connection,
                       const char *type);

A convenience function to check if the given connection is a particular type (ie wired, Wi-Fi, ppp, etc). Checks the “type” property of the connection and matches that against type .

nm_connection_for_each_setting_value ()

void
nm_connection_for_each_setting_value (NMConnection *connection,
                                      NMSettingValueIterFn func,
                                      gpointer user_data);

Iterates over the properties of each NMSetting object in the NMConnection, calling the supplied user function for each property.

nm_connection_to_hash ()

GHashTable *
nm_connection_to_hash (NMConnection *connection,
                       NMSettingHashFlags flags);

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.

nm_connection_dump ()

void
nm_connection_dump (NMConnection *connection);

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.

nm_connection_lookup_setting_type ()

GType
nm_connection_lookup_setting_type (const char *name);

Returns the GType of the setting's class for a given setting name.

nm_connection_lookup_setting_type_by_quark ()

GType
nm_connection_lookup_setting_type_by_quark
                               (GQuark error_quark);

Returns the GType of the setting's class for a given setting error quark. Useful for figuring out which setting a returned error is for.

nm_connection_get_uuid ()

const char *
nm_connection_get_uuid (NMConnection *connection);

A shortcut to return the UUID from the connection's NMSettingConnection.

nm_connection_get_id ()

const char *
nm_connection_get_id (NMConnection *connection);

A shortcut to return the ID from the connection's NMSettingConnection.

nm_connection_get_connection_type ()

const char *
nm_connection_get_connection_type (NMConnection *connection);

A shortcut to return the type from the connection's NMSettingConnection.

Since 0.9.10

nm_connection_get_virtual_device_description ()

char *
nm_connection_get_virtual_device_description
                               (NMConnection *connection);

Returns the name that nm_device_disambiguate_names() would return for the virtual device that would be created for connection . Eg, "VLAN (eth1.1)".

Since 0.9.10

nm_connection_get_setting_802_1x ()

NMSetting8021x *
nm_connection_get_setting_802_1x (NMConnection *connection);

A shortcut to return any NMSetting8021x the connection might contain.

nm_connection_get_setting_bluetooth ()

NMSettingBluetooth *
nm_connection_get_setting_bluetooth (NMConnection *connection);

A shortcut to return any NMSettingBluetooth the connection might contain.

nm_connection_get_setting_bond ()

NMSettingBond *
nm_connection_get_setting_bond (NMConnection *connection);

A shortcut to return any NMSettingBond the connection might contain.

nm_connection_get_setting_team ()

NMSettingTeam *
nm_connection_get_setting_team (NMConnection *connection);

A shortcut to return any NMSettingTeam the connection might contain.

Since 0.9.10

nm_connection_get_setting_team_port ()

NMSettingTeamPort *
nm_connection_get_setting_team_port (NMConnection *connection);

A shortcut to return any NMSettingTeamPort the connection might contain.

Since 0.9.10

nm_connection_get_setting_bridge ()

NMSettingBridge *
nm_connection_get_setting_bridge (NMConnection *connection);

A shortcut to return any NMSettingBridge the connection might contain.

nm_connection_get_setting_bridge_port ()

NMSettingBridgePort *
nm_connection_get_setting_bridge_port (NMConnection *connection);

A shortcut to return any NMSettingBridgePort the connection might contain.

nm_connection_get_setting_cdma ()

NMSettingCdma *
nm_connection_get_setting_cdma (NMConnection *connection);

A shortcut to return any NMSettingCdma the connection might contain.

nm_connection_get_setting_connection ()

NMSettingConnection *
nm_connection_get_setting_connection (NMConnection *connection);

A shortcut to return any NMSettingConnection the connection might contain.

nm_connection_get_setting_dcb ()

NMSettingDcb *
nm_connection_get_setting_dcb (NMConnection *connection);

A shortcut to return any NMSettingDcb the connection might contain.

Since 0.9.10

nm_connection_get_setting_generic ()

NMSettingGeneric *
nm_connection_get_setting_generic (NMConnection *connection);

A shortcut to return any NMSettingGeneric the connection might contain.

Since 0.9.10

nm_connection_get_setting_gsm ()

NMSettingGsm *
nm_connection_get_setting_gsm (NMConnection *connection);

A shortcut to return any NMSettingGsm the connection might contain.

nm_connection_get_setting_infiniband ()

NMSettingInfiniband *
nm_connection_get_setting_infiniband (NMConnection *connection);

A shortcut to return any NMSettingInfiniband the connection might contain.

nm_connection_get_setting_ip4_config ()

NMSettingIP4Config *
nm_connection_get_setting_ip4_config (NMConnection *connection);

A shortcut to return any NMSettingIP4Config the connection might contain.

nm_connection_get_setting_ip6_config ()

NMSettingIP6Config *
nm_connection_get_setting_ip6_config (NMConnection *connection);

A shortcut to return any NMSettingIP6Config the connection might contain.

nm_connection_get_setting_olpc_mesh ()

NMSettingOlpcMesh *
nm_connection_get_setting_olpc_mesh (NMConnection *connection);

A shortcut to return any NMSettingOlpcMesh the connection might contain.

nm_connection_get_setting_ppp ()

NMSettingPPP *
nm_connection_get_setting_ppp (NMConnection *connection);

A shortcut to return any NMSettingPPP the connection might contain.

nm_connection_get_setting_pppoe ()

NMSettingPPPOE *
nm_connection_get_setting_pppoe (NMConnection *connection);

A shortcut to return any NMSettingPPPOE the connection might contain.

nm_connection_get_setting_serial ()

NMSettingSerial *
nm_connection_get_setting_serial (NMConnection *connection);

A shortcut to return any NMSettingSerial the connection might contain.

nm_connection_get_setting_vpn ()

NMSettingVPN *
nm_connection_get_setting_vpn (NMConnection *connection);

A shortcut to return any NMSettingVPN the connection might contain.

nm_connection_get_setting_wimax ()

NMSettingWimax *
nm_connection_get_setting_wimax (NMConnection *connection);

A shortcut to return any NMSettingWimax the connection might contain.

nm_connection_get_setting_adsl ()

NMSettingAdsl *
nm_connection_get_setting_adsl (NMConnection *connection);

A shortcut to return any NMSettingAdsl the connection might contain.

nm_connection_get_setting_wired ()

NMSettingWired *
nm_connection_get_setting_wired (NMConnection *connection);

A shortcut to return any NMSettingWired the connection might contain.

nm_connection_get_setting_wireless ()

NMSettingWireless *
nm_connection_get_setting_wireless (NMConnection *connection);

A shortcut to return any NMSettingWireless the connection might contain.

nm_connection_get_setting_wireless_security ()

NMSettingWirelessSecurity *
nm_connection_get_setting_wireless_security
                               (NMConnection *connection);

A shortcut to return any NMSettingWirelessSecurity the connection might contain.

nm_connection_get_setting_vlan ()

NMSettingVlan *
nm_connection_get_setting_vlan (NMConnection *connection);

A shortcut to return any NMSettingVlan the connection might contain.

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_PATH

#define NM_CONNECTION_PATH "path"

enum NMConnectionError

Describes errors that may result from operations involving a NMConnection.

NM_CONNECTION_NORMALIZE_PARAM_IP6_CONFIG_METHOD

#define NM_CONNECTION_NORMALIZE_PARAM_IP6_CONFIG_METHOD "ip6-config-method"

NM_CONNECTION_ERROR

#define NM_CONNECTION_ERROR nm_connection_error_quark ()

NMConnection

typedef struct _NMConnection NMConnection;

The NMConnection struct contains only private data. It should only be accessed through the functions described below.

The “path” property

  “path”                     gchar *

The connection's D-Bus path, used only by the calling process as a record of the D-Bus path of the connection as provided by a settings service.

Flags: Read / Write / Construct

Default value: NULL

The “changed” signal

void
user_function (NMConnection *connection,
               gpointer      user_data)

The ::changed signal is emitted when any property of any property (including secrets) of any setting of the connection is modified, or when settings are added or removed.

Flags: Run First

Since 0.9.10

The “secrets-cleared” signal

void
user_function (NMConnection *connection,
               gpointer      user_data)

The ::secrets-cleared signal is emitted when the secrets of a connection are cleared.

Flags: Run First

The “secrets-updated” signal

void
user_function (NMConnection *connection,
               gchar        *setting_name,
               gpointer      user_data)

The ::secrets-updated signal is emitted when the secrets of a setting have been changed.

Flags: Run First