diff options
Diffstat (limited to 'docs/api/dbus-org.freedesktop.NetworkManager.Settings.Connection.xml')
| -rw-r--r-- | docs/api/dbus-org.freedesktop.NetworkManager.Settings.Connection.xml | 97 |
1 files changed, 61 insertions, 36 deletions
diff --git a/docs/api/dbus-org.freedesktop.NetworkManager.Settings.Connection.xml b/docs/api/dbus-org.freedesktop.NetworkManager.Settings.Connection.xml index b0de0550..d7648152 100644 --- a/docs/api/dbus-org.freedesktop.NetworkManager.Settings.Connection.xml +++ b/docs/api/dbus-org.freedesktop.NetworkManager.Settings.Connection.xml @@ -5,7 +5,7 @@ <refentry id="gdbus-org.freedesktop.NetworkManager.Settings.Connection"> <refmeta> <refentrytitle role="top_of_page" id="gdbus-interface-org-freedesktop-NetworkManager-Settings-Connection.top_of_page">org.freedesktop.NetworkManager.Settings.Connection</refentrytitle> <indexterm zone="gdbus-interface-org-freedesktop-NetworkManager-Settings-Connection.top_of_page"><primary sortas=".Settings.Connection">org.freedesktop.NetworkManager.Settings.Connection</primary></indexterm> - </refmeta> <refnamediv> <refname>org.freedesktop.NetworkManager.Settings.Connection</refname> <refpurpose>Connection Settings Profile</refpurpose> </refnamediv> <refsynopsisdiv role="synopsis"> + </refmeta> <refnamediv> <refname>org.freedesktop.NetworkManager.Settings.Connection</refname> <refpurpose>Connection Settings Profile.</refpurpose> </refnamediv> <refsynopsisdiv role="synopsis"> <title role="synopsis.title">Methods</title> <synopsis> <link linkend="gdbus-method-org-freedesktop-NetworkManager-Settings-Connection.Update">Update</link> (IN a{sa{sv}} properties); @@ -163,56 +163,81 @@ Update2 (IN a{sa{sv}} settings, IN a{sv} args, OUT a{sv} result); </programlisting> -<para> Provide an empty array, to use the current settings. - <parameter>flags</parameter>: optional flags argument. Currently, supported flags are: - "0x1" (to-disk), - "0x2" (in-memory), - "0x4" (in-memory-detached), - "0x8" (in-memory-only), - "0x10" (volatile), - "0x20" (block-autoconnect), - "0x40" (no-reapply). - Unknown flags cause the call to fail. - <parameter>args</parameter>: optional arguments dictionary, for extentibility. Currently, no - arguments are accepted. Specifying unknown keys causes the call - to fail. - <parameter>result</parameter>: output argument, currently no results are returned. -</para><para> Update the connection with new settings and properties (replacing all - previous settings and properties). If the flag 0x1 is present, - the connection is persisted to disk. If the flag 0x2 is present, - 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. - The flags 0x4 (in-memory-detached) and 0x8 (in-memory-only) are like - "in-memory", but behave slightly different when migrating the profile - from disk to in-memory. - The flag 0x20 (block-autoconnect) blocks auto-connect on the updated - profile, and 0x40 (no-reapply) prevents "connection.zone" and "connection.metered" - properties to take effect on currently active devices. - Secrets may be part of the update request, and will be either stored in persistent +<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><para> Update2 is a extensible alternative to Update, UpdateUnsaved and Save. -</para><para> Since: 1.12 </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.</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></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></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></para></listitem> + <listitem><para>Currently no results are returned.</para></listitem> </varlistentry> </variablelist> +<para role="since">Since 1.12</para> </refsect2> </refsect1> <refsect1 role="details" id="gdbus-signals-org.freedesktop.NetworkManager.Settings.Connection"> @@ -264,8 +289,8 @@ Flags readable u </programlisting> <para> Additional flags of the connection profile. </para><para> Returns: <link linkend="NMSettingsConnectionFlags">NMSettingsConnectionFlags</link> -</para><para> Since: 1.12 </para> +<para role="since">Since 1.12</para> </refsect2> <refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager-Settings-Connection.Filename"> <title>The "Filename" property</title> @@ -274,8 +299,8 @@ Flags readable u Filename readable s </programlisting> <para> File that stores the connection in case the connection is file-backed. -</para><para> Since: 1.12 </para> +<para role="since">Since 1.12</para> </refsect2> </refsect1> </refentry> |