summary refs log tree commit diff
path: root/docs/api/dbus-org.freedesktop.NetworkManager.Settings.Connection.xml
diff options
context:
space:
mode:
authorMichael Biebl <biebl@debian.org>2022-08-12 19:21:11 +0200
committerMichael Biebl <biebl@debian.org>2022-08-12 19:21:11 +0200
commit6accbd3ec0e42d8633bbde4d47ed7bfe854e7e0b (patch)
treea77a0617213a5183a4de43824e3fbae9779e9b8e /docs/api/dbus-org.freedesktop.NetworkManager.Settings.Connection.xml
parentf7c750061dab327e638c0129cfafd5b2215b3a2e (diff)
New upstream version 1.38.4 upstream/1.38.4
Diffstat (limited to 'docs/api/dbus-org.freedesktop.NetworkManager.Settings.Connection.xml')
-rw-r--r--docs/api/dbus-org.freedesktop.NetworkManager.Settings.Connection.xml249
1 files changed, 144 insertions, 105 deletions
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 @@
   </refsect1>
 <refsect1 role="desc" id="gdbus-interface-org-freedesktop-NetworkManager-Settings-Connection">
   <title role="desc.title">Description</title>
-  <para>      Represents a single network connection configuration.
+  <para>
+Represents a single network connection configuration.
 </para>
 </refsect1>
 <refsect1 role="details" id="gdbus-methods-org.freedesktop.NetworkManager.Settings.Connection">
@@ -50,16 +51,19 @@
 <programlisting>
 Update (IN  a{sa{sv}} properties);
 </programlisting>
-<para>        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.
+<para>
+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.
 </para>
 <variablelist role="params">
 <varlistentry>
   <term><literal>IN a{sa{sv}} <parameter>properties</parameter></literal>:</term>
-  <listitem><para>New connection settings, properties, and (optionally) secrets.</para></listitem>
+  <listitem><para>
+New connection settings, properties, and (optionally) secrets.
+</para></listitem>
 </varlistentry>
 </variablelist>
 </refsect2>
@@ -69,19 +73,22 @@ Update (IN  a{sa{sv}} properties);
 <programlisting>
 UpdateUnsaved (IN  a{sa{sv}} properties);
 </programlisting>
-<para>        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).
+<para>
+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).
 </para>
 <variablelist role="params">
 <varlistentry>
   <term><literal>IN a{sa{sv}} <parameter>properties</parameter></literal>:</term>
-  <listitem><para>New connection settings, properties, and (optionally) secrets.</para></listitem>
+  <listitem><para>
+New connection settings, properties, and (optionally) secrets.
+</para></listitem>
 </varlistentry>
 </variablelist>
 </refsect2>
@@ -91,7 +98,8 @@ UpdateUnsaved (IN  a{sa{sv}} properties);
 <programlisting>
 Delete ();
 </programlisting>
-<para>        Delete the connection.
+<para>
+Delete the connection.
 </para>
 </refsect2>
 <refsect2 role="method" id="gdbus-method-org-freedesktop-NetworkManager-Settings-Connection.GetSettings">
@@ -100,15 +108,18 @@ Delete ();
 <programlisting>
 GetSettings (OUT a{sa{sv}} settings);
 </programlisting>
-<para>        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.
+<para>
+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.
 </para>
 <variablelist role="params">
 <varlistentry>
   <term><literal>OUT a{sa{sv}} <parameter>settings</parameter></literal>:</term>
-  <listitem><para>The nested settings maps describing this object.</para></listitem>
+  <listitem><para>
+The nested settings maps describing this object.
+</para></listitem>
 </varlistentry>
 </variablelist>
 </refsect2>
@@ -119,19 +130,24 @@ GetSettings (OUT a{sa{sv}} settings);
 GetSecrets (IN  s         setting_name,
             OUT a{sa{sv}} secrets);
 </programlisting>
-<para>        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.
+<para>
+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.
 </para>
 <variablelist role="params">
 <varlistentry>
   <term><literal>IN s <parameter>setting_name</parameter></literal>:</term>
-  <listitem><para>Name of the setting to return secrets for. If empty, all secrets will be returned.</para></listitem>
+  <listitem><para>
+Name of the setting to return secrets for. If empty, all secrets will be returned.
+</para></listitem>
 </varlistentry>
 <varlistentry>
   <term><literal>OUT a{sa{sv}} <parameter>secrets</parameter></literal>:</term>
-  <listitem><para>Nested settings maps containing secrets.</para></listitem>
+  <listitem><para>
+Nested settings maps containing secrets.
+</para></listitem>
 </varlistentry>
 </variablelist>
 </refsect2>
@@ -141,7 +157,8 @@ GetSecrets (IN  s         setting_name,
 <programlisting>
 ClearSecrets ();
 </programlisting>
-<para>        Clear the secrets belonging to this network connection profile.
+<para>
+Clear the secrets belonging to this network connection profile.
 </para>
 </refsect2>
 <refsect2 role="method" id="gdbus-method-org-freedesktop-NetworkManager-Settings-Connection.Save">
@@ -150,8 +167,9 @@ ClearSecrets ();
 <programlisting>
 Save ();
 </programlisting>
-<para>        Saves a "dirty" connection (that had previously been updated with
-        UpdateUnsaved) to persistent storage.
+<para>
+Saves a "dirty" connection (that had previously been updated with
+UpdateUnsaved) to persistent storage.
 </para>
 </refsect2>
 <refsect2 role="method" id="gdbus-method-org-freedesktop-NetworkManager-Settings-Connection.Update2">
@@ -163,78 +181,93 @@ Update2 (IN  a{sa{sv}} settings,
          IN  a{sv}     args,
          OUT a{sv}     result);
 </programlisting>
-<para>        Update the connection with new settings and properties (replacing all
-        previous settings and properties).
-</para><para>        Update2 is an alternative to
-        <link linkend="gdbus-method-org-freedesktop-NetworkManager-Settings-Connection.Update">Update</link>,
-        <link linkend="gdbus-method-org-freedesktop-NetworkManager-Settings-Connection.UpdateUnsaved">UpdateUnsaved</link>
-        and <link linkend="gdbus-method-org-freedesktop-NetworkManager-Settings-Connection.Save">Save</link>
-        extensible with extra <constant>flags</constant> and <constant>args</constant> arguments.
-</para><para>        The <constant>flags</constant> argument accepts the combination of following values,
-        logically or-ed together:
-</para><para>        <variablelist>
-        <varlistentry>
-          <term><literal>0x1 (to-disk)</literal>:</term>
-          <listitem><para>The connection is persisted to disk.</para></listitem>
-        </varlistentry>
-        <varlistentry>
-          <term><literal>0x2 (in-memory)</literal>:</term>
-          <listitem><para>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.</para></listitem>
-        </varlistentry>
-        <varlistentry>
-          <term><literal>0x4 (in-memory-detached)</literal>:</term>
-          <listitem><para>Like "in-memory", but behaves slightly different when migrating
-          the profile from disk to in-memory.</para></listitem>
-        </varlistentry>
-        <varlistentry>
-          <term><literal>0x8 (in-memory-only)</literal>:</term>
-          <listitem><para>Like "in-memory", but behaves slightly different when migrating
-          the profile from disk to in-memory.</para></listitem>
-        </varlistentry>
-        <varlistentry>
-          <term><literal>0x10 (volatile)</literal>:</term>
-        </varlistentry>
-        <varlistentry>
-          <term><literal>0x20 (block-autoconnect)</literal>:</term>
-          <listitem><para>Blocks auto-connect on the updated profile</para></listitem>
-        </varlistentry>
-        <varlistentry>
-          <term><literal>0x40 (no-reapply)</literal>:</term>
-          <listitem><para>Prevents "connection.zone" and "connection.metered" properties
-          to take effect on currently active devices.</para></listitem>
-        </varlistentry>
-        </variablelist>
-</para><para>        The <constant>args</constant> argument accepts the following keys:
-</para><para>        <variablelist>
-        <varlistentry>
-          <term><literal>plugin</literal>:</term>
-          <listitem><para>The settings plugin the connection will be migrated to
-          such as "keyfile" or "ifcfg-rh".</para>
-          <para role="since">Since 1.38</para></listitem>
-        </varlistentry>
-        </variablelist>
-</para><para>        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.
+<para>
+Update the connection with new settings and properties (replacing all
+previous settings and properties).
+</para><para>
+Update2 is an alternative to
+<link linkend="gdbus-method-org-freedesktop-NetworkManager-Settings-Connection.Update">Update</link>,
+<link linkend="gdbus-method-org-freedesktop-NetworkManager-Settings-Connection.UpdateUnsaved">UpdateUnsaved</link>
+and <link linkend="gdbus-method-org-freedesktop-NetworkManager-Settings-Connection.Save">Save</link>
+extensible with extra <constant>flags</constant> and <constant>args</constant> arguments.
+</para><para>
+The <constant>flags</constant> argument accepts the combination of following values,
+logically or-ed together:
+</para><para>
+<variablelist>
+<varlistentry>
+<term><literal>0x1 (to-disk)</literal>:</term>
+<listitem><para>The connection is persisted to disk.</para></listitem>
+</varlistentry>
+<varlistentry>
+<term><literal>0x2 (in-memory)</literal>:</term>
+<listitem><para>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.</para></listitem>
+</varlistentry>
+<varlistentry>
+<term><literal>0x4 (in-memory-detached)</literal>:</term>
+<listitem><para>Like "in-memory", but behaves slightly different when migrating
+the profile from disk to in-memory.</para></listitem>
+</varlistentry>
+<varlistentry>
+<term><literal>0x8 (in-memory-only)</literal>:</term>
+<listitem><para>Like "in-memory", but behaves slightly different when migrating
+the profile from disk to in-memory.</para></listitem>
+</varlistentry>
+<varlistentry>
+<term><literal>0x10 (volatile)</literal>:</term>
+</varlistentry>
+<varlistentry>
+<term><literal>0x20 (block-autoconnect)</literal>:</term>
+<listitem><para>Blocks auto-connect on the updated profile</para></listitem>
+</varlistentry>
+<varlistentry>
+<term><literal>0x40 (no-reapply)</literal>:</term>
+<listitem><para>Prevents "connection.zone" and "connection.metered" properties
+to take effect on currently active devices.</para></listitem>
+</varlistentry>
+</variablelist>
+</para><para>
+The <constant>args</constant> argument accepts the following keys:
+</para><para>
+<variablelist>
+<varlistentry>
+<term><literal>plugin</literal>:</term>
+<listitem><para>The settings plugin the connection will be migrated to
+such as "keyfile" or "ifcfg-rh".</para>
+<para role="since">Since 1.38</para></listitem>
+</varlistentry>
+</variablelist>
+</para><para>
+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.
 </para>
 <variablelist role="params">
 <varlistentry>
   <term><literal>IN a{sa{sv}} <parameter>settings</parameter></literal>:</term>
-  <listitem><para>New connection settings, properties, and (optionally) secrets. Provide an empty array to use the current settings.</para></listitem>
+  <listitem><para>
+New connection settings, properties, and (optionally) secrets. Provide an empty array to use the current settings.
+</para></listitem>
 </varlistentry>
 <varlistentry>
   <term><literal>IN u <parameter>flags</parameter></literal>:</term>
-  <listitem><para>Optional flags. Unknown flags cause the call to fail.</para></listitem>
+  <listitem><para>
+Optional flags. Unknown flags cause the call to fail.
+</para></listitem>
 </varlistentry>
 <varlistentry>
   <term><literal>IN a{sv} <parameter>args</parameter></literal>:</term>
-  <listitem><para>Optional arguments dictionary, for extentibility. Specifying unknown keys causes the call to fail.</para></listitem>
+  <listitem><para>
+Optional arguments dictionary, for extentibility. Specifying unknown keys causes the call to fail.
+</para></listitem>
 </varlistentry>
 <varlistentry>
   <term><literal>OUT a{sv} <parameter>result</parameter></literal>:</term>
-  <listitem><para>Currently no results are returned.</para></listitem>
+  <listitem><para>
+Currently no results are returned.
+</para></listitem>
 </varlistentry>
 </variablelist>
 <para role="since">Since 1.12</para>
@@ -248,10 +281,11 @@ Update2 (IN  a{sa{sv}} settings,
 <programlisting>
 Updated ();
 </programlisting>
-<para>        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.
+<para>
+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.
 </para>
 </refsect2>
 <refsect2 role="signal" id="gdbus-signal-org-freedesktop-NetworkManager-Settings-Connection.Removed">
@@ -260,10 +294,11 @@ Updated ();
 <programlisting>
 Removed ();
 </programlisting>
-<para>        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.
+<para>
+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.
 </para>
 </refsect2>
 </refsect1>
@@ -275,10 +310,11 @@ Removed ();
 <programlisting>
 Unsaved  readable   b
 </programlisting>
-<para>        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.
+<para>
+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.
 </para>
 </refsect2>
 <refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager-Settings-Connection.Flags">
@@ -287,8 +323,10 @@ Unsaved  readable   b
 <programlisting>
 Flags  readable   u
 </programlisting>
-<para>        Additional flags of the connection profile.
-</para><para>        Returns: <link linkend="NMSettingsConnectionFlags">NMSettingsConnectionFlags</link>
+<para>
+Additional flags of the connection profile.
+</para><para>
+Returns: <link linkend="NMSettingsConnectionFlags">NMSettingsConnectionFlags</link>
 </para>
 <para role="since">Since 1.12</para>
 </refsect2>
@@ -298,7 +336,8 @@ Flags  readable   u
 <programlisting>
 Filename  readable   s
 </programlisting>
-<para>        File that stores the connection in case the connection is file-backed.
+<para>
+File that stores the connection in case the connection is file-backed.
 </para>
 <para role="since">Since 1.12</para>
 </refsect2>