| Top | |
|
|
|
| #define | NM_CONNECTION_SECRETS_UPDATED |
| #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 |
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).
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.
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.
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.
the NMSetting, or NULL if no setting of that type was previously
added to the NMConnection.
[transfer none]
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.
the NMSetting, or NULL if no setting with that name was previously
added to the NMConnection.
[transfer none]
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.
a new floating GVariant describing the connection, its settings, and each setting's properties.
[transfer none]
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()).
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.
void
nm_connection_clear_settings (NMConnection *connection);
Deletes all of connection
's settings.
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.
a |
||
b |
a second NMConnection to compare with the first |
|
flags |
compare flags, e.g. |
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.
a |
||
b |
a second NMConnection to compare with the first |
|
flags |
compare flags, e.g. |
|
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 |
[element-type utf8 GLib.HashTable] |
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.
gboolean nm_connection_verify_secrets (NMConnection *connection,GError **error);
Verifies the secrets in the connection.
Since: 1.2
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.
connection |
the NMConnection to normalize |
|
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 compared with |
[allow-none][element-type utf8 gpointer] |
modified |
outputs whether any settings were modified. |
[out][allow-none] |
error |
location to store error, or |
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.
connection |
the NMConnection |
|
hints |
the address of a pointer to a GPtrArray, initialized to |
[out][element-type utf8][allow-none][transfer container] |
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.
void nm_connection_clear_secrets_with_flags (NMConnection *connection,NMSettingClearSecretsWithFlagsFn func,gpointer user_data);
Clears and frees secrets determined by func
.
connection |
the NMConnection |
|
func |
function to be called to determine whether a
specific secret should be cleared or not. If |
[scope call][allow-none] |
user_data |
caller-supplied data passed to |
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
.
connection |
the NMConnection |
|
setting_name |
the setting object name to which the secrets apply |
|
secrets |
a GVariant of secrets, of type |
|
error |
location to store error, or |
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.
connection |
the NMConnection |
|
path |
the D-Bus path of the connection as given by the settings service which provides the connection |
const char *
nm_connection_get_path (NMConnection *connection);
Returns the connection's D-Bus path.
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.
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
.
connection |
the NMConnection |
|
type |
a setting name to check the connection's type against (like
|
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.
connection |
the NMConnection |
|
func |
user-supplied function called for each setting's property. |
[scope call] |
user_data |
user data passed to |
NMSetting ** nm_connection_get_settings (NMConnection *connection,guint *out_length);
Retrieves the settings in connection
.
The returned array is NULL-terminated.
connection |
the NMConnection instance |
|
out_length |
the length of the returned array. |
[allow-none][out] |
a
NULL-terminated array containing every setting of
connection
.
If the connection has no settings, NULL is returned.
[array length=out_length][transfer container]
Since: 1.10
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.
const char *
nm_connection_get_uuid (NMConnection *connection);
A shortcut to return the UUID from the connection's NMSettingConnection.
const char *
nm_connection_get_id (NMConnection *connection);
A shortcut to return the ID from the connection's NMSettingConnection.
const char *
nm_connection_get_connection_type (NMConnection *connection);
A shortcut to return the type from the connection's NMSettingConnection.
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).
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)".
the name of connection
's device,
or NULL if connection
is not a virtual connection type.
[transfer full]
NMSetting8021x *
nm_connection_get_setting_802_1x (NMConnection *connection);
A shortcut to return any NMSetting8021x the connection might contain.
NMSettingBluetooth *
nm_connection_get_setting_bluetooth (NMConnection *connection);
A shortcut to return any NMSettingBluetooth the connection might contain.
NMSettingBond *
nm_connection_get_setting_bond (NMConnection *connection);
A shortcut to return any NMSettingBond the connection might contain.
NMSettingTeam *
nm_connection_get_setting_team (NMConnection *connection);
A shortcut to return any NMSettingTeam the connection might contain.
NMSettingTeamPort *
nm_connection_get_setting_team_port (NMConnection *connection);
A shortcut to return any NMSettingTeamPort the connection might contain.
NMSettingBridge *
nm_connection_get_setting_bridge (NMConnection *connection);
A shortcut to return any NMSettingBridge the connection might contain.
NMSettingBridgePort *
nm_connection_get_setting_bridge_port (NMConnection *connection);
A shortcut to return any NMSettingBridgePort the connection might contain.
NMSettingCdma *
nm_connection_get_setting_cdma (NMConnection *connection);
A shortcut to return any NMSettingCdma the connection might contain.
NMSettingConnection *
nm_connection_get_setting_connection (NMConnection *connection);
A shortcut to return any NMSettingConnection the connection might contain.
NMSettingDcb *
nm_connection_get_setting_dcb (NMConnection *connection);
A shortcut to return any NMSettingDcb the connection might contain.
NMSettingDummy *
nm_connection_get_setting_dummy (NMConnection *connection);
A shortcut to return any NMSettingDummy the connection might contain.
Since: 1.8
NMSettingGeneric *
nm_connection_get_setting_generic (NMConnection *connection);
A shortcut to return any NMSettingGeneric the connection might contain.
NMSettingGsm *
nm_connection_get_setting_gsm (NMConnection *connection);
A shortcut to return any NMSettingGsm the connection might contain.
NMSettingInfiniband *
nm_connection_get_setting_infiniband (NMConnection *connection);
A shortcut to return any NMSettingInfiniband the connection might contain.
NMSettingIPTunnel *
nm_connection_get_setting_ip_tunnel (NMConnection *connection);
A shortcut to return any NMSettingIPTunnel the connection might contain.
Since: 1.2
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.
an NMSettingIP4Config if the
connection contains one, otherwise NULL.
[type NMSettingIP4Config][transfer none]
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.
an NMSettingIP6Config if the
connection contains one, otherwise NULL.
[type NMSettingIP6Config][transfer none]
NMSettingMacsec *
nm_connection_get_setting_macsec (NMConnection *connection);
A shortcut to return any NMSettingMacsec the connection might contain.
Since: 1.6
NMSettingMacvlan *
nm_connection_get_setting_macvlan (NMConnection *connection);
A shortcut to return any NMSettingMacvlan the connection might contain.
Since: 1.2
NMSettingOlpcMesh *
nm_connection_get_setting_olpc_mesh (NMConnection *connection);
A shortcut to return any NMSettingOlpcMesh the connection might contain.
NMSettingOvsBridge *
nm_connection_get_setting_ovs_bridge (NMConnection *connection);
A shortcut to return any NMSettingOvsBridge the connection might contain.
Since: 1.10
NMSettingOvsInterface *
nm_connection_get_setting_ovs_interface
(NMConnection *connection);
A shortcut to return any NMSettingOvsInterface the connection might contain.
Since: 1.10
NMSettingOvsPatch *
nm_connection_get_setting_ovs_patch (NMConnection *connection);
A shortcut to return any NMSettingOvsPatch the connection might contain.
Since: 1.10
NMSettingOvsPort *
nm_connection_get_setting_ovs_port (NMConnection *connection);
A shortcut to return any NMSettingOvsPort the connection might contain.
Since: 1.10
NMSettingPpp *
nm_connection_get_setting_ppp (NMConnection *connection);
A shortcut to return any NMSettingPpp the connection might contain.
NMSettingPppoe *
nm_connection_get_setting_pppoe (NMConnection *connection);
A shortcut to return any NMSettingPppoe the connection might contain.
NMSettingProxy *
nm_connection_get_setting_proxy (NMConnection *connection);
A shortcut to return any NMSettingProxy the connection might contain.
Since: 1.6
NMSettingSerial *
nm_connection_get_setting_serial (NMConnection *connection);
A shortcut to return any NMSettingSerial the connection might contain.
NMSettingTCConfig *
nm_connection_get_setting_tc_config (NMConnection *connection);
A shortcut to return any NMSettingTCConfig the connection might contain.
Since: 1.12
NMSettingTun *
nm_connection_get_setting_tun (NMConnection *connection);
A shortcut to return any NMSettingTun the connection might contain.
Since: 1.2
NMSettingVpn *
nm_connection_get_setting_vpn (NMConnection *connection);
A shortcut to return any NMSettingVpn the connection might contain.
NMSettingWimax *
nm_connection_get_setting_wimax (NMConnection *connection);
A shortcut to return any NMSettingWimax the connection might contain.
NMSettingAdsl *
nm_connection_get_setting_adsl (NMConnection *connection);
A shortcut to return any NMSettingAdsl the connection might contain.
NMSettingWired *
nm_connection_get_setting_wired (NMConnection *connection);
A shortcut to return any NMSettingWired the connection might contain.
NMSettingWireless *
nm_connection_get_setting_wireless (NMConnection *connection);
A shortcut to return any NMSettingWireless the connection might contain.
NMSettingWirelessSecurity *
nm_connection_get_setting_wireless_security
(NMConnection *connection);
A shortcut to return any NMSettingWirelessSecurity the connection might contain.
an NMSettingWirelessSecurity if the connection contains one, otherwise NULL.
[transfer none]
NMSettingVlan *
nm_connection_get_setting_vlan (NMConnection *connection);
A shortcut to return any NMSettingVlan the connection might contain.
NMSettingVxlan *
nm_connection_get_setting_vxlan (NMConnection *connection);
A shortcut to return any NMSettingVxlan the connection might contain.
Since: 1.2
#define NM_CONNECTION_NORMALIZE_PARAM_IP6_CONFIG_METHOD "ip6-config-method"
typedef struct {
GTypeInterface parent;
/* Signals */
void (*secrets_updated) (NMConnection *connection,
const char *setting);
void (*secrets_cleared) (NMConnection *connection);
void (*changed) (NMConnection *connection);
} NMConnectionInterface;
GTypeInterface |
the parent interface struct |
|
emitted when the connection's secrets are updated |
||
emitted when the connection's secrets are cleared |
||
emitted when any change to the connection's settings occurs |
#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.
These flags determine which properties are serialized when calling when
calling nm_connection_to_dbus().