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_to_dbus ()

GVariant *
nm_connection_to_dbus (NMConnection *connection,
                       NMConnectionSerializationFlags flags);

Converts the NMConnection into a GVariant of type NM_VARIANT_TYPE_CONNECTION describing the connection, suitable for marshalling over D-Bus or otherwise serializing.

nm_connection_replace_settings ()

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

Replaces connection 's settings with new_settings (which must be syntactically valid, and describe a known type of connection, but does not need to result in a connection that passes nm_connection_verify()).

nm_connection_replace_settings_from_connection ()

void
nm_connection_replace_settings_from_connection
                               (NMConnection *connection,
                                NMConnection *new_connection);

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

nm_connection_clear_settings ()

void
nm_connection_clear_settings (NMConnection *connection);

Deletes all of connection 's settings.

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_verify_secrets ()

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

Verifies the secrets in the connection.

Since: 1.2

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.

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,
                              GVariant *secrets,
                              GError **error);

Update the specified setting's secrets, given a dictionary of secrets intended for that setting (deserialized from D-Bus for example). Will also extract the given setting's secrets hash if given a connection dictionary. If setting_name is NULL, expects a fully serialized NMConnection as returned by nm_connection_to_dbus() 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_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.

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_get_settings ()

NMSetting **
nm_connection_get_settings (NMConnection *connection,
                            guint *out_length);

Retrieves the settings in connection .

The returned array is NULL-terminated.

Since: 1.10

nm_connection_dump ()

void
nm_connection_dump (NMConnection *connection);

Print the connection (including secrets!) to stdout. For debugging purposes ONLY, should NOT be used for serialization of the setting, or machine-parsed in any way. The output format is not guaranteed to be stable and may change at any time.

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.

nm_connection_is_virtual ()

gboolean
nm_connection_is_virtual (NMConnection *connection);

Checks if connection refers to a virtual device (and thus can potentially be activated even if the device it refers to doesn't exist).

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

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.

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.

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.

nm_connection_get_setting_dummy ()

NMSettingDummy *
nm_connection_get_setting_dummy (NMConnection *connection);

A shortcut to return any NMSettingDummy the connection might contain.

Since: 1.8

nm_connection_get_setting_generic ()

NMSettingGeneric *
nm_connection_get_setting_generic (NMConnection *connection);

A shortcut to return any NMSettingGeneric the connection might contain.

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_ip_tunnel ()

NMSettingIPTunnel *
nm_connection_get_setting_ip_tunnel (NMConnection *connection);

A shortcut to return any NMSettingIPTunnel the connection might contain.

Since: 1.2

nm_connection_get_setting_ip4_config ()

NMSettingIPConfig *
nm_connection_get_setting_ip4_config (NMConnection *connection);

A shortcut to return any NMSettingIP4Config the connection might contain.

Note that it returns the value as type NMSettingIPConfig, since the vast majority of IPv4-setting-related methods are on that type, not NMSettingIP4Config.

nm_connection_get_setting_ip6_config ()

NMSettingIPConfig *
nm_connection_get_setting_ip6_config (NMConnection *connection);

A shortcut to return any NMSettingIP6Config the connection might contain.

Note that it returns the value as type NMSettingIPConfig, since the vast majority of IPv6-setting-related methods are on that type, not NMSettingIP6Config.

nm_connection_get_setting_macsec ()

NMSettingMacsec *
nm_connection_get_setting_macsec (NMConnection *connection);

A shortcut to return any NMSettingMacsec the connection might contain.

Since: 1.6

nm_connection_get_setting_macvlan ()

NMSettingMacvlan *
nm_connection_get_setting_macvlan (NMConnection *connection);

A shortcut to return any NMSettingMacvlan the connection might contain.

Since: 1.2

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_ovs_bridge ()

NMSettingOvsBridge *
nm_connection_get_setting_ovs_bridge (NMConnection *connection);

A shortcut to return any NMSettingOvsBridge the connection might contain.

Since: 1.10

nm_connection_get_setting_ovs_interface ()

NMSettingOvsInterface *
nm_connection_get_setting_ovs_interface
                               (NMConnection *connection);

A shortcut to return any NMSettingOvsInterface the connection might contain.

Since: 1.10

nm_connection_get_setting_ovs_patch ()

NMSettingOvsPatch *
nm_connection_get_setting_ovs_patch (NMConnection *connection);

A shortcut to return any NMSettingOvsPatch the connection might contain.

Since: 1.10

nm_connection_get_setting_ovs_port ()

NMSettingOvsPort *
nm_connection_get_setting_ovs_port (NMConnection *connection);

A shortcut to return any NMSettingOvsPort the connection might contain.

Since: 1.10

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_proxy ()

NMSettingProxy *
nm_connection_get_setting_proxy (NMConnection *connection);

A shortcut to return any NMSettingProxy the connection might contain.

Since: 1.6

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_tc_config ()

NMSettingTCConfig *
nm_connection_get_setting_tc_config (NMConnection *connection);

A shortcut to return any NMSettingTCConfig the connection might contain.

Since: 1.12

nm_connection_get_setting_tun ()

NMSettingTun *
nm_connection_get_setting_tun (NMConnection *connection);

A shortcut to return any NMSettingTun the connection might contain.

Since: 1.2

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_get_setting_vxlan ()

NMSettingVxlan *
nm_connection_get_setting_vxlan (NMConnection *connection);

A shortcut to return any NMSettingVxlan the connection might contain.

Since: 1.2

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;

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.

enum NMConnectionSerializationFlags

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