diff options
Diffstat (limited to 'docs/api/html/gdbus-org.freedesktop.NetworkManager.Settings.Connection.html')
| -rw-r--r-- | docs/api/html/gdbus-org.freedesktop.NetworkManager.Settings.Connection.html | 127 |
1 files changed, 85 insertions, 42 deletions
diff --git a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Settings.Connection.html b/docs/api/html/gdbus-org.freedesktop.NetworkManager.Settings.Connection.html index 9955af25..08c3f4d2 100644 --- a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Settings.Connection.html +++ b/docs/api/html/gdbus-org.freedesktop.NetworkManager.Settings.Connection.html @@ -8,7 +8,7 @@ <link rel="up" href="ref-dbus-settings.html" title="The /org/freedesktop/NetworkManager/Settings/* objects"> <link rel="prev" href="ref-dbus-settings.html" title="The /org/freedesktop/NetworkManager/Settings/* objects"> <link rel="next" href="ref-dbus-devices.html" title="The /org/freedesktop/NetworkManager/Devices/* objects"> -<meta name="generator" content="GTK-Doc V1.33.0 (XML mode)"> +<meta name="generator" content="GTK-Doc V1.33.1 (XML mode)"> <link rel="stylesheet" href="style.css" type="text/css"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> @@ -29,7 +29,7 @@ <div class="refnamediv"><table width="100%"><tr> <td valign="top"> <h2><span class="refentrytitle"><a name="gdbus-interface-org-freedesktop-NetworkManager-Settings-Connection.top_of_page"></a>org.freedesktop.NetworkManager.Settings.Connection</span></h2> -<p>org.freedesktop.NetworkManager.Settings.Connection — Connection Settings Profile</p> +<p>org.freedesktop.NetworkManager.Settings.Connection — Connection Settings Profile.</p> </td> <td class="gallery_image" valign="top" align="right"></td> </tr></table></div> @@ -208,40 +208,84 @@ Update2 (IN a{sa{sv}} settings, IN a{sv} args, OUT a{sv} result); </pre> -<p> Provide an empty array, to use the current settings. - <em class="parameter"><code>flags</code></em>: 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. - <em class="parameter"><code>args</code></em>: optional arguments dictionary, for extentibility. Currently, no - arguments are accepted. Specifying unknown keys causes the call - to fail. - <em class="parameter"><code>result</code></em>: output argument, currently no results are returned. -</p> <p> 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 - storage or sent to a Secret Agent for storage, depending on the flags - associated with each secret. + previous settings and properties). </p> -<p> Update2 is a extensible alternative to Update, UpdateUnsaved and Save. +<p> Update2 is an alternative to + <a class="link" href="gdbus-org.freedesktop.NetworkManager.Settings.Connection.html#gdbus-method-org-freedesktop-NetworkManager-Settings-Connection.Update" title="The Update() method">Update</a>, + <a class="link" href="gdbus-org.freedesktop.NetworkManager.Settings.Connection.html#gdbus-method-org-freedesktop-NetworkManager-Settings-Connection.UpdateUnsaved" title="The UpdateUnsaved() method">UpdateUnsaved</a> + and <a class="link" href="gdbus-org.freedesktop.NetworkManager.Settings.Connection.html#gdbus-method-org-freedesktop-NetworkManager-Settings-Connection.Save" title="The Save() method">Save</a> + extensible with extra <code class="constant">flags</code> and <code class="constant">args</code> arguments. </p> -<p> Since: 1.12 +<p> The <code class="constant">flags</code> argument accepts the combination of following values, + logically or-ed together: +</p> +<p> </p> +<div class="variablelist"><table border="0" class="variablelist"> +<colgroup> +<col align="left" valign="top"> +<col> +</colgroup> +<tbody> +<tr> +<td><p><span class="term"><code class="literal">0x1 (to-disk)</code>:</span></p></td> +<td><p>The connection is persisted to disk.</p></td> +</tr> +<tr> +<td><p><span class="term"><code class="literal">0x2 (in-memory)</code>:</span></p></td> +<td><p>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.</p></td> +</tr> +<tr> +<td><p><span class="term"><code class="literal">0x4 (in-memory-detached)</code>:</span></p></td> +<td><p>Like "in-memory", but behaves slightly different when migrating + the profile from disk to in-memory.</p></td> +</tr> +<tr> +<td><p><span class="term"><code class="literal">0x8 (in-memory-only)</code>:</span></p></td> +<td><p>Like "in-memory", but behaves slightly different when migrating + the profile from disk to in-memory.</p></td> +</tr> +<tr> +<td><p><span class="term"><code class="literal">0x10 (volatile)</code>:</span></p></td> +<td></td> +</tr> +<tr> +<td><p><span class="term"><code class="literal">0x20 (block-autoconnect)</code>:</span></p></td> +<td><p>Blocks auto-connect on the updated profile</p></td> +</tr> +<tr> +<td><p><span class="term"><code class="literal">0x40 (no-reapply)</code>:</span></p></td> +<td><p>Prevents "connection.zone" and "connection.metered" properties + to take effect on currently active devices.</p></td> +</tr> +</tbody> +</table></div> +<p> +</p> +<p> The <code class="constant">args</code> argument accepts the following keys: +</p> +<p> </p> +<div class="variablelist"><table border="0" class="variablelist"> +<colgroup> +<col align="left" valign="top"> +<col> +</colgroup> +<tbody><tr> +<td><p><span class="term"><code class="literal">plugin</code>:</span></p></td> +<td> +<p>The settings plugin the connection will be migrated to + such as "keyfile" or "ifcfg-rh".</p> +<p class="since">Since 1.38</p> +</td> +</tr></tbody> +</table></div> +<p> +</p> +<p> 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. </p> <div class="variablelist"><table border="0" class="variablelist"> <colgroup> @@ -251,22 +295,23 @@ Update2 (IN a{sa{sv}} settings, <tbody> <tr> <td><p><span class="term"><code class="literal">IN a{sa{sv}} <em class="parameter"><code>settings</code></em></code>:</span></p></td> -<td><p>New connection settings, properties, and (optionally) secrets.</p></td> +<td><p>New connection settings, properties, and (optionally) secrets. Provide an empty array to use the current settings.</p></td> </tr> <tr> <td><p><span class="term"><code class="literal">IN u <em class="parameter"><code>flags</code></em></code>:</span></p></td> -<td><p></p></td> +<td><p>Optional flags. Unknown flags cause the call to fail.</p></td> </tr> <tr> <td><p><span class="term"><code class="literal">IN a{sv} <em class="parameter"><code>args</code></em></code>:</span></p></td> -<td><p></p></td> +<td><p>Optional arguments dictionary, for extentibility. Specifying unknown keys causes the call to fail.</p></td> </tr> <tr> <td><p><span class="term"><code class="literal">OUT a{sv} <em class="parameter"><code>result</code></em></code>:</span></p></td> -<td><p></p></td> +<td><p>Currently no results are returned.</p></td> </tr> </tbody> </table></div> +<p class="since">Since 1.12</p> </div> </div> <div class="refsect1"> @@ -318,8 +363,7 @@ Flags readable u </p> <p> Returns: <a class="link" href="nm-dbus-types.html#NMSettingsConnectionFlags" title="enum NMSettingsConnectionFlags">NMSettingsConnectionFlags</a> </p> -<p> Since: 1.12 -</p> +<p class="since">Since 1.12</p> </div> <hr> <div class="refsect2"> @@ -329,12 +373,11 @@ Filename readable s </pre> <p> File that stores the connection in case the connection is file-backed. </p> -<p> Since: 1.12 -</p> +<p class="since">Since 1.12</p> </div> </div> </div> <div class="footer"> -<hr>Generated by GTK-Doc V1.33.0</div> +<hr>Generated by GTK-Doc V1.33.1</div> </body> </html> \ No newline at end of file |