From 6accbd3ec0e42d8633bbde4d47ed7bfe854e7e0b Mon Sep 17 00:00:00 2001 From: Michael Biebl Date: Fri, 12 Aug 2022 19:21:11 +0200 Subject: New upstream version 1.38.4 --- ...edesktop.NetworkManager.Settings.Connection.xml | 249 ++++++++++++--------- 1 file changed, 144 insertions(+), 105 deletions(-) (limited to 'docs/api/dbus-org.freedesktop.NetworkManager.Settings.Connection.xml') diff --git a/docs/api/dbus-org.freedesktop.NetworkManager.Settings.Connection.xml b/docs/api/dbus-org.freedesktop.NetworkManager.Settings.Connection.xml index d7648152..bdd3c2a4 100644 --- a/docs/api/dbus-org.freedesktop.NetworkManager.Settings.Connection.xml +++ b/docs/api/dbus-org.freedesktop.NetworkManager.Settings.Connection.xml @@ -39,7 +39,8 @@ Description - Represents a single network connection configuration. + +Represents a single network connection configuration. @@ -50,16 +51,19 @@ 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. + +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. + +New connection settings, properties, and (optionally) secrets. + @@ -69,19 +73,22 @@ Update (IN a{sa{sv}} properties); 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). + +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. + +New connection settings, properties, and (optionally) secrets. + @@ -91,7 +98,8 @@ UpdateUnsaved (IN a{sa{sv}} properties); Delete (); - Delete the connection. + +Delete the connection. @@ -100,15 +108,18 @@ Delete (); 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. + +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 nested settings maps describing this object. + @@ -119,19 +130,24 @@ GetSettings (OUT a{sa{sv}} settings); 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. + +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. + +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. + +Nested settings maps containing secrets. + @@ -141,7 +157,8 @@ GetSecrets (IN s setting_name, ClearSecrets (); - Clear the secrets belonging to this network connection profile. + +Clear the secrets belonging to this network connection profile. @@ -150,8 +167,9 @@ ClearSecrets (); Save (); - Saves a "dirty" connection (that had previously been updated with - UpdateUnsaved) to persistent storage. + +Saves a "dirty" connection (that had previously been updated with +UpdateUnsaved) to persistent storage. @@ -163,78 +181,93 @@ Update2 (IN a{sa{sv}} settings, 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: - The settings plugin the connection will be migrated to - such as "keyfile" or "ifcfg-rh". - Since 1.38 - - - 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. + +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: +The settings plugin the connection will be migrated to +such as "keyfile" or "ifcfg-rh". +Since 1.38 + + + +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. + +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. + +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. + +Optional arguments dictionary, for extentibility. Specifying unknown keys causes the call to fail. + OUT a{sv} result: - Currently no results are returned. + +Currently no results are returned. + Since 1.12 @@ -248,10 +281,11 @@ Update2 (IN a{sa{sv}} settings, 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. + +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. @@ -260,10 +294,11 @@ Updated (); 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. + +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. @@ -275,10 +310,11 @@ Removed (); 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. + +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. @@ -287,8 +323,10 @@ Unsaved readable b Flags readable u - Additional flags of the connection profile. - Returns: NMSettingsConnectionFlags + +Additional flags of the connection profile. + +Returns: NMSettingsConnectionFlags Since 1.12 @@ -298,7 +336,8 @@ Flags readable u Filename readable s - File that stores the connection in case the connection is file-backed. + +File that stores the connection in case the connection is file-backed. Since 1.12 -- cgit 1.3.0-6-gf8a5