summary refs log tree commit diff
path: root/docs/api/html/gdbus-org.freedesktop.NetworkManager.Settings.Connection.html
diff options
context:
space:
mode:
authorMichael Biebl <biebl@debian.org>2024-12-25 20:36:29 +0100
committerMichael Biebl <biebl@debian.org>2024-12-25 20:36:29 +0100
commite465722b908aa870bdc293b9a417d3c15294aa6d (patch)
tree7c959d3b73f427d6c40522a7464eaa4531ef2f05 /docs/api/html/gdbus-org.freedesktop.NetworkManager.Settings.Connection.html
parent56928734cbcf1d3a02fae4f152a541df1b04e04a (diff)
New upstream version 1.50.1 upstream/1.50.1
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.html426
1 files changed, 0 insertions, 426 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
deleted file mode 100644
index b5e89291..00000000
--- a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Settings.Connection.html
+++ /dev/null
@@ -1,426 +0,0 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
-<html>
-<head>
-<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
-<title>org.freedesktop.NetworkManager.Settings.Connection: NetworkManager Reference Manual</title>
-<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
-<link rel="home" href="index.html" title="NetworkManager Reference Manual">
-<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.34.0 (XML mode)">
-<link rel="stylesheet" href="style.css" type="text/css">
-</head>
-<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
-<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
-<td width="100%" align="left" class="shortcuts">
-<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
-                  <a href="#gdbus-org.freedesktop.NetworkManager.Settings.Connection.description" class="shortcut">Description</a></span><span id="nav_properties">  <span class="dim">|</span> 
-                  <a href="#gdbus-org.freedesktop.NetworkManager.Settings.Connection.properties" class="shortcut">Properties</a></span><span id="nav_signals">  <span class="dim">|</span> 
-                  <a href="#gdbus-org.freedesktop.NetworkManager.Settings.Connection.signals" class="shortcut">Signals</a></span>
-</td>
-<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
-<td><a accesskey="u" href="ref-dbus-settings.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
-<td><a accesskey="p" href="ref-dbus-settings.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
-<td><a accesskey="n" href="ref-dbus-devices.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
-</tr></table>
-<div class="refentry">
-<a name="gdbus-org.freedesktop.NetworkManager.Settings.Connection"></a><div class="titlepage"></div>
-<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>
-</td>
-<td class="gallery_image" valign="top" align="right"></td>
-</tr></table></div>
-<div class="refsynopsisdiv">
-<h2>Methods</h2>
-<pre class="synopsis">
-<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>        (IN  a{sa{sv}} properties);
-<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> (IN  a{sa{sv}} properties);
-<a class="link" href="gdbus-org.freedesktop.NetworkManager.Settings.Connection.html#gdbus-method-org-freedesktop-NetworkManager-Settings-Connection.Delete" title="The Delete() method">Delete</a>        ();
-<a class="link" href="gdbus-org.freedesktop.NetworkManager.Settings.Connection.html#gdbus-method-org-freedesktop-NetworkManager-Settings-Connection.GetSettings" title="The GetSettings() method">GetSettings</a>   (OUT a{sa{sv}} settings);
-<a class="link" href="gdbus-org.freedesktop.NetworkManager.Settings.Connection.html#gdbus-method-org-freedesktop-NetworkManager-Settings-Connection.GetSecrets" title="The GetSecrets() method">GetSecrets</a>    (IN  s         setting_name,
-               OUT a{sa{sv}} secrets);
-<a class="link" href="gdbus-org.freedesktop.NetworkManager.Settings.Connection.html#gdbus-method-org-freedesktop-NetworkManager-Settings-Connection.ClearSecrets" title="The ClearSecrets() method">ClearSecrets</a>  ();
-<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>          ();
-<a class="link" href="gdbus-org.freedesktop.NetworkManager.Settings.Connection.html#gdbus-method-org-freedesktop-NetworkManager-Settings-Connection.Update2" title="The Update2() method">Update2</a>       (IN  a{sa{sv}} settings,
-               IN  u         flags,
-               IN  a{sv}     args,
-               OUT a{sv}     result);
-</pre>
-</div>
-<div class="refsect1">
-<a name="id-1.4.7.2.4"></a><h2>Signals</h2>
-<pre class="synopsis">
-<a class="link" href="gdbus-org.freedesktop.NetworkManager.Settings.Connection.html#gdbus-signal-org-freedesktop-NetworkManager-Settings-Connection.Updated" title='The "Updated" signal'>Updated</a> ();
-<a class="link" href="gdbus-org.freedesktop.NetworkManager.Settings.Connection.html#gdbus-signal-org-freedesktop-NetworkManager-Settings-Connection.Removed" title='The "Removed" signal'>Removed</a> ();
-</pre>
-</div>
-<div class="refsect1">
-<a name="id-1.4.7.2.5"></a><h2>Properties</h2>
-<pre class="synopsis">
-<a class="link" href="gdbus-org.freedesktop.NetworkManager.Settings.Connection.html#gdbus-property-org-freedesktop-NetworkManager-Settings-Connection.Unsaved" title='The "Unsaved" property'>Unsaved</a>   readable   b
-<a class="link" href="gdbus-org.freedesktop.NetworkManager.Settings.Connection.html#gdbus-property-org-freedesktop-NetworkManager-Settings-Connection.Flags" title='The "Flags" property'>Flags</a>     readable   u
-<a class="link" href="gdbus-org.freedesktop.NetworkManager.Settings.Connection.html#gdbus-property-org-freedesktop-NetworkManager-Settings-Connection.Filename" title='The "Filename" property'>Filename</a>  readable   s
-</pre>
-</div>
-<div class="refsect1">
-<a name="gdbus-interface-org-freedesktop-NetworkManager-Settings-Connection"></a><h2>Description</h2>
-<p>
-Represents a single network connection configuration.
-</p>
-</div>
-<div class="refsect1">
-<a name="gdbus-methods-org.freedesktop.NetworkManager.Settings.Connection"></a><h2>Method Details</h2>
-<div class="refsect2">
-<a name="gdbus-method-org-freedesktop-NetworkManager-Settings-Connection.Update"></a><h3>The Update() method</h3>
-<pre class="programlisting">
-Update (IN  a{sa{sv}} properties);
-</pre>
-<p>
-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.
-</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">IN a{sa{sv}} <em class="parameter"><code>properties</code></em></code>:</span></p></td>
-<td><p>
-New connection settings, properties, and (optionally) secrets.
-</p></td>
-</tr></tbody>
-</table></div>
-</div>
-<hr>
-<div class="refsect2">
-<a name="gdbus-method-org-freedesktop-NetworkManager-Settings-Connection.UpdateUnsaved"></a><h3>The UpdateUnsaved() method</h3>
-<pre class="programlisting">
-UpdateUnsaved (IN  a{sa{sv}} properties);
-</pre>
-<p>
-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).
-</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">IN a{sa{sv}} <em class="parameter"><code>properties</code></em></code>:</span></p></td>
-<td><p>
-New connection settings, properties, and (optionally) secrets.
-</p></td>
-</tr></tbody>
-</table></div>
-</div>
-<hr>
-<div class="refsect2">
-<a name="gdbus-method-org-freedesktop-NetworkManager-Settings-Connection.Delete"></a><h3>The Delete() method</h3>
-<pre class="programlisting">
-Delete ();
-</pre>
-<p>
-Delete the connection.
-</p>
-</div>
-<hr>
-<div class="refsect2">
-<a name="gdbus-method-org-freedesktop-NetworkManager-Settings-Connection.GetSettings"></a><h3>The GetSettings() method</h3>
-<pre class="programlisting">
-GetSettings (OUT a{sa{sv}} settings);
-</pre>
-<p>
-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.
-</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">OUT a{sa{sv}} <em class="parameter"><code>settings</code></em></code>:</span></p></td>
-<td><p>
-The nested settings maps describing this object.
-</p></td>
-</tr></tbody>
-</table></div>
-</div>
-<hr>
-<div class="refsect2">
-<a name="gdbus-method-org-freedesktop-NetworkManager-Settings-Connection.GetSecrets"></a><h3>The GetSecrets() method</h3>
-<pre class="programlisting">
-GetSecrets (IN  s         setting_name,
-            OUT a{sa{sv}} secrets);
-</pre>
-<p>
-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.
-</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">IN s <em class="parameter"><code>setting_name</code></em></code>:</span></p></td>
-<td><p>
-Name of the setting to return secrets for. If empty, all secrets will be returned.
-</p></td>
-</tr>
-<tr>
-<td><p><span class="term"><code class="literal">OUT a{sa{sv}} <em class="parameter"><code>secrets</code></em></code>:</span></p></td>
-<td><p>
-Nested settings maps containing secrets.
-</p></td>
-</tr>
-</tbody>
-</table></div>
-</div>
-<hr>
-<div class="refsect2">
-<a name="gdbus-method-org-freedesktop-NetworkManager-Settings-Connection.ClearSecrets"></a><h3>The ClearSecrets() method</h3>
-<pre class="programlisting">
-ClearSecrets ();
-</pre>
-<p>
-Clear the secrets belonging to this network connection profile.
-</p>
-</div>
-<hr>
-<div class="refsect2">
-<a name="gdbus-method-org-freedesktop-NetworkManager-Settings-Connection.Save"></a><h3>The Save() method</h3>
-<pre class="programlisting">
-Save ();
-</pre>
-<p>
-Saves a "dirty" connection (that had previously been updated with
-UpdateUnsaved) to persistent storage.
-</p>
-</div>
-<hr>
-<div class="refsect2">
-<a name="gdbus-method-org-freedesktop-NetworkManager-Settings-Connection.Update2"></a><h3>The Update2() method</h3>
-<pre class="programlisting">
-Update2 (IN  a{sa{sv}} settings,
-         IN  u         flags,
-         IN  a{sv}     args,
-         OUT a{sv}     result);
-</pre>
-<p>
-Update the connection with new settings and properties (replacing all
-previous settings and properties).
-</p>
-<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>
-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><span class="term"><code class="literal">version-id</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>
-<p>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.</p>
-<p class="since">Since 1.44</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>
-<col align="left" valign="top">
-<col>
-</colgroup>
-<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. 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>
-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>
-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>
-Currently no results are returned.
-</p></td>
-</tr>
-</tbody>
-</table></div>
-<p class="since">Since 1.12</p>
-</div>
-</div>
-<div class="refsect1">
-<a name="gdbus-signals-org.freedesktop.NetworkManager.Settings.Connection"></a><h2>Signal Details</h2>
-<div class="refsect2">
-<a name="gdbus-signal-org-freedesktop-NetworkManager-Settings-Connection.Updated"></a><h3>The "Updated" signal</h3>
-<pre class="programlisting">
-Updated ();
-</pre>
-<p>
-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.
-</p>
-</div>
-<hr>
-<div class="refsect2">
-<a name="gdbus-signal-org-freedesktop-NetworkManager-Settings-Connection.Removed"></a><h3>The "Removed" signal</h3>
-<pre class="programlisting">
-Removed ();
-</pre>
-<p>
-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.
-</p>
-</div>
-</div>
-<div class="refsect1">
-<a name="gdbus-properties-org.freedesktop.NetworkManager.Settings.Connection"></a><h2>Property Details</h2>
-<div class="refsect2">
-<a name="gdbus-property-org-freedesktop-NetworkManager-Settings-Connection.Unsaved"></a><h3>The "Unsaved" property</h3>
-<pre class="programlisting">
-Unsaved  readable   b
-</pre>
-<p>
-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.
-</p>
-</div>
-<hr>
-<div class="refsect2">
-<a name="gdbus-property-org-freedesktop-NetworkManager-Settings-Connection.Flags"></a><h3>The "Flags" property</h3>
-<pre class="programlisting">
-Flags  readable   u
-</pre>
-<p>
-Additional flags of the connection profile.
-</p>
-<p>
-Returns: <a class="link" href="nm-dbus-types.html#NMSettingsConnectionFlags" title="enum NMSettingsConnectionFlags">NMSettingsConnectionFlags</a>
-</p>
-<p class="since">Since 1.12</p>
-</div>
-<hr>
-<div class="refsect2">
-<a name="gdbus-property-org-freedesktop-NetworkManager-Settings-Connection.Filename"></a><h3>The "Filename" property</h3>
-<pre class="programlisting">
-Filename  readable   s
-</pre>
-<p>
-File that stores the connection in case the connection is file-backed.
-</p>
-<p class="since">Since 1.12</p>
-</div>
-</div>
-</div>
-<div class="footer">
-<hr>Generated by GTK-Doc V1.34.0</div>
-</body>
-</html>
\ No newline at end of file