diff options
Diffstat (limited to 'introspection/org.freedesktop.NetworkManager.Settings.xml')
| -rw-r--r-- | introspection/org.freedesktop.NetworkManager.Settings.xml | 67 |
1 files changed, 48 insertions, 19 deletions
diff --git a/introspection/org.freedesktop.NetworkManager.Settings.xml b/introspection/org.freedesktop.NetworkManager.Settings.xml index 28c89ff4..ea271dfa 100644 --- a/introspection/org.freedesktop.NetworkManager.Settings.xml +++ b/introspection/org.freedesktop.NetworkManager.Settings.xml @@ -3,7 +3,7 @@ <!-- org.freedesktop.NetworkManager.Settings: - @short_description: Connection Settings Profile Manager + @short_description: Connection Settings Profile Manager. The Settings interface allows clients to view and administrate the connections stored and used by NetworkManager. @@ -66,29 +66,55 @@ <!-- AddConnection2: @settings: New connection settings, properties, and (optionally) secrets. - @flags: optional flags argument. Currently, the following flags are supported: - "0x1" (to-disk), - "0x2" (in-memory), - "0x20" (block-autoconnect). - Unknown flags cause the call to fail. - @args: optional arguments dictionary, for extentibility. Currently, no - arguments are accepted. Specifying unknown keys causes the call - to fail. + @flags: Flags. Unknown flags cause the call to fail. + @args: Optional arguments dictionary, for extentibility. Specifying unknown keys causes the call to fail. @path: Object path of the new connection that was just added. - @result: output argument, currently no additional results are returned. + @result: Output argument, currently no additional results are returned. + @since: 1.20 Add a new connection profile. - Either the flags 0x1 (to-disk) or 0x2 (in-memory) must be specified. - The effect is whether to behave like AddConnection or AddConnectionUnsaved. - If 0x20 (block-autoconnect) is specified, autoconnect for the new profile - is blocked from the beginning. Otherwise, the profile might automatically - connect if a suitable device is around. - - AddConnection2 is a extensible alternative to AddConnection, and AddConnectionUnsaved. + AddConnection2 is an alternative to + <link linkend="gdbus-method-org-freedesktop-NetworkManager-Settings.AddConnection">AddConnection</link> and + <link linkend="gdbus-method-org-freedesktop-NetworkManager-Settings.AddConnectionUnsaved">AddConnectionUnsaved</link>. The new variant can do everything that the older variants could, and more. + Its behavior is extensible via extra %flags and %args arguments. + + The %flags argument accepts the combination of following values, + logically or-ed together: + + <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>0x20 (block-autoconnect)</literal>:</term> + <listitem><para>Blocks auto-connect on the new profile</para></listitem> + </varlistentry> + </variablelist> + + The %args argument accepts the following keys: + + <variablelist> + <varlistentry> + <term><literal>plugin</literal>:</term> + <listitem><para>The settings plugin the newly added connection will + use, such as "keyfile" or "ifcfg-rh".</para> + <para role="since">Since 1.38</para></listitem> + </varlistentry> + </variablelist> - Since: 1.20 + Either the flags 0x1 (to-disk) or 0x2 (in-memory) must be specified. + The effect is whether to behave like + <link linkend="gdbus-method-org-freedesktop-NetworkManager-Settings.AddConnection">AddConnection</link> or + <link linkend="gdbus-method-org-freedesktop-NetworkManager-Settings.AddConnectionUnsaved">AddConnectionUnsaved</link>. --> <method name="AddConnection2"> <arg name="settings" type="a{sa{sv}}" direction="in"/> @@ -102,7 +128,6 @@ LoadConnections: @filenames: Array of paths to on-disk connection profiles in directories monitored by NetworkManager. @status: Success or failure of the operation as a whole. True if NetworkManager at least tried to load the indicated connections, even if it did not succeed. False if an error occurred before trying to load the connections (eg, permission denied). - Note that before 1.20, NetworkManager had a bug and this @status value was wrong. It is better to assume success if the method does not return with a D-Bus error. On top of that, you can look at @failures to know whether any of the requested files failed. @failures: Paths of connection files that could not be loaded. Loads or reloads the indicated connections from disk. You should call this @@ -110,6 +135,10 @@ that NetworkManager sees the changes. As with AddConnection(), this operation does not necessarily start the network connection. + + Note that before 1.20, NetworkManager had a bug and this @status value was wrong. + It is better to assume success if the method does not return with a D-Bus error. + On top of that, you can look at @failures to know whether any of the requested files failed. --> <method name="LoadConnections"> <arg name="filenames" type="as" direction="in"/> |