org.freedesktop.NetworkManager.Settings.Connection: NetworkManager Reference Manual

- - -

org.freedesktop.NetworkManager.Settings.Connection

org.freedesktop.NetworkManager.Settings.Connection — Connection Settings Profile.

Methods

-Update        (IN  a{sa{sv}} properties);
-UpdateUnsaved (IN  a{sa{sv}} properties);
-Delete        ();
-GetSettings   (OUT a{sa{sv}} settings);
-GetSecrets    (IN  s         setting_name,
-               OUT a{sa{sv}} secrets);
-ClearSecrets  ();
-Save          ();
-Update2       (IN  a{sa{sv}} settings,
-               IN  u         flags,
-               IN  a{sv}     args,
-               OUT a{sv}     result);
-

Signals

-Updated ();
-Removed ();
-

Properties

-Unsaved   readable   b
-Flags     readable   u
-Filename  readable   s
-

Description

-Represents a single network connection configuration. -

Method Details

The Update() method

-Update (IN  a{sa{sv}} properties);
-

-Update the connection with new settings and properties (replacing all -previous settings and properties) and save the connection to disk. Secrets -may be part of the update request, and will be either stored in persistent -storage or sent to a Secret Agent for storage, depending on the flags -associated with each secret. -

---- - - - - -

IN a{sa{sv}} properties:

-New connection settings, properties, and (optionally) secrets. -

The UpdateUnsaved() method

-UpdateUnsaved (IN  a{sa{sv}} properties);
-

-Update the connection with new settings and properties (replacing all -previous settings and properties) but do not immediately save the -connection to disk. Secrets may be part of the update request and may sent -to a Secret Agent for storage, depending on the flags associated with each -secret. Use the 'Save' method to save these changes to disk. Note that -unsaved changes will be lost if the connection is reloaded from disk -(either automatically on file change or due to an explicit -ReloadConnections call). -

---- - - - - -

IN a{sa{sv}} properties:

-New connection settings, properties, and (optionally) secrets. -

The Delete() method

-Delete ();
-

-Delete the connection. -

The GetSettings() method

-GetSettings (OUT a{sa{sv}} settings);
-

-Get the settings maps describing this network configuration. This will -never include any secrets required for connection to the network, as those -are often protected. Secrets must be requested separately using the -GetSecrets() call. -

---- - - - - -

OUT a{sa{sv}} settings:

-The nested settings maps describing this object. -

The GetSecrets() method

-GetSecrets (IN  s         setting_name,
-            OUT a{sa{sv}} secrets);
-

-Get the secrets belonging to this network configuration. Only secrets from -persistent storage or a Secret Agent running in the requestor's session -will be returned. The user will never be prompted for secrets as a result -of this request. -

---- - - - - - - - - - - -

`IN s setting_name`:	-Name of the setting to return secrets for. If empty, all secrets will be returned. -
`OUT a{sa{sv}} secrets`:	-Nested settings maps containing secrets. -

The ClearSecrets() method

-ClearSecrets ();
-

-Clear the secrets belonging to this network connection profile. -

The Save() method

-Save ();
-

-Saves a "dirty" connection (that had previously been updated with -UpdateUnsaved) to persistent storage. -

The Update2() method

-Update2 (IN  a{sa{sv}} settings,
-         IN  u         flags,
-         IN  a{sv}     args,
-         OUT a{sv}     result);
-

-Update the connection with new settings and properties (replacing all -previous settings and properties). -

-Update2 is an alternative to -Update, -UpdateUnsaved -and Save -extensible with extra flags and args arguments. -

-The flags argument accepts the combination of following values, -logically or-ed together: -

---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

`0x1 (to-disk)`:	The connection is persisted to disk.
`0x2 (in-memory)`:	The change is only made in memory (without touching an eventual - profile on disk). If neither 0x1 nor 0x2 is set, the change is made in memory - only, if the connection is already in memory only.
`0x4 (in-memory-detached)`:	Like "in-memory", but behaves slightly different when migrating - the profile from disk to in-memory.
`0x8 (in-memory-only)`:	Like "in-memory", but behaves slightly different when migrating - the profile from disk to in-memory.
`0x10 (volatile)`:
`0x20 (block-autoconnect)`:	Blocks auto-connect on the updated profile
`0x40 (no-reapply)`:	Prevents "connection.zone" and "connection.metered" properties - to take effect on currently active devices.

-The args argument accepts the following keys: -

---- - - - - -

plugin:, version-id:

The settings plugin the connection will be migrated to - such as "keyfile" or "ifcfg-rh".

Since 1.38

If specified, the update request is rejected if the - profile's version-id does not match. This can be used to catch concurrent - modifications. Zero means no version check.

Since 1.44

-Secrets may be part of the update request, and will be either stored in persistent -storage or sent to a Secret Agent for storage, depending on the flags -associated with each secret. -

---- - - - - - - - - - - - - - - - - - - -

`IN a{sa{sv}} settings`:	-New connection settings, properties, and (optionally) secrets. Provide an empty array to use the current settings. -
`IN u flags`:	-Optional flags. Unknown flags cause the call to fail. -
`IN a{sv} args`:	-Optional arguments dictionary, for extentibility. Specifying unknown keys causes the call to fail. -
`OUT a{sv} result`:	-Currently no results are returned. -

Since 1.12

Signal Details

The "Updated" signal

-Updated ();
-

-Emitted when any settings or permissions change. When handling this -signal, clients should re-read the connection using the GetSettings method -to get the changes and to ensure the client still has permission to access -the connection. -

The "Removed" signal

-Removed ();
-

-Emitted when this connection is no longer available. This happens when the -connection is deleted or if it is no longer accessible by any of the -system's logged-in users. After receipt of this signal, the object no -longer exists. Also see the Settings.ConnectionRemoved signal. -

Property Details

The "Unsaved" property

-Unsaved  readable   b
-

-If set, indicates that the in-memory state of the connection does not -match the on-disk state. This flag will be set when UpdateUnsaved() is -called or when any connection details change, and cleared when the -connection is saved to disk via Save() or from internal operations. -

The "Flags" property

-Flags  readable   u
-

-Additional flags of the connection profile. -

-Returns: NMSettingsConnectionFlags -

Since 1.12

The "Filename" property

-Filename  readable   s
-

-File that stores the connection in case the connection is file-backed. -

Since 1.12