2016-04-04 23:09:48 +00:00
<?xml version="1.0" encoding="UTF-8"?>
<node name= "/org/freedesktop/NetworkManager/Settings" >
2007-08-03 16:10:04 +00:00
2016-04-04 23:09:48 +00:00
<!--
org.freedesktop.NetworkManager.Settings:
2022-03-18 14:52:48 +00:00
@short_description: Connection Settings Profile Manager.
2016-04-04 23:09:48 +00:00
The Settings interface allows clients to view and administrate the
connections stored and used by NetworkManager.
-->
2010-08-07 05:07:44 +00:00
<interface name= "org.freedesktop.NetworkManager.Settings" >
2008-04-04 14:57:02 +00:00
2016-04-04 23:09:48 +00:00
<!--
ListConnections:
@connections: List of connections.
2013-04-10 18:49:02 +00:00
List the saved network connections known to NetworkManager.
2016-04-04 23:09:48 +00:00
-->
<method name= "ListConnections" >
<arg name= "connections" type= "ao" direction= "out" />
2008-04-04 14:57:02 +00:00
</method>
2007-08-03 16:10:04 +00:00
2016-04-04 23:09:48 +00:00
<!--
GetConnectionByUuid:
@uuid: The UUID to find the connection object path for.
@connection: The connection's object path.
2011-04-22 16:55:52 +00:00
Retrieve the object path of a connection, given that connection's UUID.
2016-04-04 23:09:48 +00:00
-->
<method name= "GetConnectionByUuid" >
<arg name= "uuid" type= "s" direction= "in" />
<arg name= "connection" type= "o" direction= "out" />
2011-04-22 16:55:52 +00:00
</method>
2016-04-04 23:09:48 +00:00
<!--
AddConnection:
@connection: Connection settings and properties.
@path: Object path of the new connection that was just added.
Add new connection and save it to disk. This operation does not start the
network connection unless (1) device is idle and able to connect to the
network described by the new connection, and (2) the connection is allowed
to be started automatically.
-->
2009-07-23 13:20:52 +00:00
<method name= "AddConnection" >
2016-04-04 23:09:48 +00:00
<arg name= "connection" type= "a{sa{sv}}" direction= "in" />
<arg name= "path" type= "o" direction= "out" />
2013-04-12 21:09:29 +00:00
</method>
2016-04-04 23:09:48 +00:00
<!--
AddConnectionUnsaved:
@connection: Connection settings and properties.
@path: Object path of the new connection that was just added.
Add new connection but do not save it to disk immediately. This operation
does not start the network connection unless (1) device is idle and able
to connect to the network described by the new connection, and (2) the
connection is allowed to be started automatically. Use the 'Save' method
settings: rework tracking settings connections and settings plugins
Completely rework how settings plugin handle connections and how
NMSettings tracks the list of connections.
Previously, settings plugins would return objects of (a subtype of) type
NMSettingsConnection. The NMSettingsConnection was tightly coupled with
the settings plugin. That has a lot of downsides.
Change that. When changing this basic relation how settings connections
are tracked, everything falls appart. That's why this is a huge change.
Also, since I have to largely rewrite the settings plugins, I also
added support for multiple keyfile directories, handle in-memory
connections only by keyfile plugin and (partly) use copy-on-write NMConnection
instances. I don't want to spend effort rewriting large parts while
preserving the old way, that anyway should change. E.g. while rewriting ifcfg-rh,
I don't want to let it handle in-memory connections because that's not right
long-term.
--
If the settings plugins themself create subtypes of NMSettingsConnection
instances, then a lot of knowledge about tracking connections moves
to the plugins.
Just try to follow the code what happend during nm_settings_add_connection().
Note how the logic is spread out:
- nm_settings_add_connection() calls plugin's add_connection()
- add_connection() creates a NMSettingsConnection subtype
- the plugin has to know that it's called during add-connection and
not emit NM_SETTINGS_PLUGIN_CONNECTION_ADDED signal
- NMSettings calls claim_connection() which hocks up the new
NMSettingsConnection instance and configures the instance
(like calling nm_settings_connection_added()).
This summary does not sound like a lot, but try to follow that code. The logic
is all over the place.
Instead, settings plugins should have a very simple API for adding, modifying,
deleting, loading and reloading connections. All the plugin does is to return a
NMSettingsStorage handle. The storage instance is a handle to identify a profile
in storage (e.g. a particular file). The settings plugin is free to subtype
NMSettingsStorage, but it's not necessary.
There are no more events raised, and the settings plugin implements the small
API in a straightforward manner.
NMSettings now drives all of this. Even NMSettingsConnection has now
very little concern about how it's tracked and delegates only to NMSettings.
This should make settings plugins simpler. Currently settings plugins
are so cumbersome to implement, that we avoid having them. It should not be
like that and it should be easy, beneficial and lightweight to create a new
settings plugin.
Note also how the settings plugins no longer care about duplicate UUIDs.
Duplicated UUIDs are a fact of life and NMSettings must handle them. No
need to overly concern settings plugins with that.
--
NMSettingsConnection is exposed directly on D-Bus (being a subtype of
NMDBusObject) but it was also a GObject type provided by the settings
plugin. Hence, it was not possible to migrate a profile from one plugin to
another.
However that would be useful when one profile does not support a
connection type (like ifcfg-rh not supporting VPN). Currently such
migration is not implemented except for migrating them to/from keyfile's
run directory. The problem is that migrating profiles in general is
complicated but in some cases it is important to do.
For example checkpoint rollback should recreate the profile in the right
settings plugin, not just add it to persistent storage. This is not yet
properly implemented.
--
Previously, both keyfile and ifcfg-rh plugin implemented in-memory (unsaved)
profiles, while ifupdown plugin cannot handle them. That meant duplication of code
and a ifupdown profile could not be modified or made unsaved.
This is now unified and only keyfile plugin handles in-memory profiles (bgo #744711).
Also, NMSettings is aware of such profiles and treats them specially.
In particular, NMSettings drives the migration between persistent and non-persistent
storage.
Note that a settings plugins may create truly generated, in-memory profiles.
The settings plugin is free to generate and persist the profiles in any way it
wishes. But the concept of "unsaved" profiles is now something explicitly handled
by keyfile plugin. Also, these "unsaved" keyfile profiles are persisted to file system
too, to the /run directory. This is great for two reasons: first of all, all
profiles from keyfile storage in fact have a backing file -- even the
unsaved ones. It also means you can create "unsaved" profiles in /run
and load them with `nmcli connection load`, meaning there is a file
based API for creating unsaved profiles.
The other advantage is that these profiles now survive restarting
NetworkManager. It's paramount that restarting the daemon is as
non-disruptive as possible. Persisting unsaved files to /run improves
here significantly.
--
In the past, NMSettingsConnection also implemented NMConnection interface.
That was already changed a while ago and instead users call now
nm_settings_connection_get_connection() to delegate to a
NMSimpleConnection. What however still happened was that the NMConnection
instance gets never swapped but instead the instance was modified with
nm_connection_replace_settings_from_connection(), clear-secrets, etc.
Change that and treat the NMConnection instance immutable. Instead of modifying
it, reference/clone a new instance. This changes that previously when somebody
wanted to keep a reference to an NMConnection, then the profile would be cloned.
Now, it is supposed to be safe to reference the instance directly and everybody
must ensure not to modify the instance. nmtst_connection_assert_unchanging()
should help with that.
The point is that the settings plugins may keep references to the
NMConnection instance, and so does the NMSettingsConnection. We want
to avoid cloning the instances as long as they are the same.
Likewise, the device's applied connection can now also be referenced
instead of cloning it. This is not yet done, and possibly there are
further improvements possible.
--
Also implement multiple keyfile directores /usr/lib, /etc, /run (rh #1674545,
bgo #772414).
It was always the case that multiple files could provide the same UUID
(both in case of keyfile and ifcfg-rh). For keyfile plugin, if a profile in
read-only storage in /usr/lib gets modified, then it gets actually stored in
/etc (or /run, if the profile is unsaved).
--
While at it, make /etc/network/interfaces profiles for ifupdown plugin reloadable.
--
https://bugzilla.gnome.org/show_bug.cgi?id=772414
https://bugzilla.gnome.org/show_bug.cgi?id=744711
https://bugzilla.redhat.com/show_bug.cgi?id=1674545
2019-06-13 15:12:20 +00:00
on the connection to save these changes to disk.
2016-04-04 23:09:48 +00:00
-->
2013-04-12 21:09:29 +00:00
<method name= "AddConnectionUnsaved" >
2016-04-04 23:09:48 +00:00
<arg name= "connection" type= "a{sa{sv}}" direction= "in" />
<arg name= "path" type= "o" direction= "out" />
2013-05-23 22:05:40 +00:00
</method>
core,libnm: add AddConnection2() D-Bus API to block autoconnect from the start
It should be possible to add a profile with autoconnect blocked form the
start. Update2() has a %NM_SETTINGS_UPDATE2_FLAG_BLOCK_AUTOCONNECT flag to
block autoconnect, and so we need something similar when adding a connection.
As the existing AddConnection() and AddConnectionUnsaved() API is not
extensible, add AddConnection2() that has flags and room for additional
arguments.
Then add and implement the new flag %NM_SETTINGS_ADD_CONNECTION2_FLAG_BLOCK_AUTOCONNECT
for AddConnection2().
Note that libnm's nm_client_add_connection2() API can completely replace
the existing nm_client_add_connection_async() call. In particular, it
will automatically prefer to call the D-Bus methods AddConnection() and
AddConnectionUnsaved(), in order to work with server versions older than
1.20. The purpose of this is that when upgrading the package, the
running NetworkManager might still be older than the installed libnm.
Anyway, so since nm_client_add_connection2_finish() also has a result
output, the caller needs to decide whether he cares about that result.
Hence it has an argument ignore_out_result, which allows to fallback to
the old API. One might argue that a caller who doesn't care about the
output results while still wanting to be backward compatible, should
itself choose to call nm_client_add_connection_async() or
nm_client_add_connection2(). But instead, it's more convenient if the
new function can fully replace the old one, so that the caller does not
need to switch which start/finish method to call.
https://bugzilla.redhat.com/show_bug.cgi?id=1677068
2019-07-09 13:22:01 +00:00
<!--
AddConnection2:
@settings: New connection settings, properties, and (optionally) secrets.
2022-03-18 14:38:05 +00:00
@flags: Flags. Unknown flags cause the call to fail.
2022-03-14 09:20:11 +00:00
@args: Optional arguments dictionary, for extentibility. Specifying unknown keys causes the call to fail.
core,libnm: add AddConnection2() D-Bus API to block autoconnect from the start
It should be possible to add a profile with autoconnect blocked form the
start. Update2() has a %NM_SETTINGS_UPDATE2_FLAG_BLOCK_AUTOCONNECT flag to
block autoconnect, and so we need something similar when adding a connection.
As the existing AddConnection() and AddConnectionUnsaved() API is not
extensible, add AddConnection2() that has flags and room for additional
arguments.
Then add and implement the new flag %NM_SETTINGS_ADD_CONNECTION2_FLAG_BLOCK_AUTOCONNECT
for AddConnection2().
Note that libnm's nm_client_add_connection2() API can completely replace
the existing nm_client_add_connection_async() call. In particular, it
will automatically prefer to call the D-Bus methods AddConnection() and
AddConnectionUnsaved(), in order to work with server versions older than
1.20. The purpose of this is that when upgrading the package, the
running NetworkManager might still be older than the installed libnm.
Anyway, so since nm_client_add_connection2_finish() also has a result
output, the caller needs to decide whether he cares about that result.
Hence it has an argument ignore_out_result, which allows to fallback to
the old API. One might argue that a caller who doesn't care about the
output results while still wanting to be backward compatible, should
itself choose to call nm_client_add_connection_async() or
nm_client_add_connection2(). But instead, it's more convenient if the
new function can fully replace the old one, so that the caller does not
need to switch which start/finish method to call.
https://bugzilla.redhat.com/show_bug.cgi?id=1677068
2019-07-09 13:22:01 +00:00
@path: Object path of the new connection that was just added.
2022-03-18 14:38:05 +00:00
@result: Output argument, currently no additional results are returned.
2022-03-18 13:41:57 +00:00
@since: 1.20
core,libnm: add AddConnection2() D-Bus API to block autoconnect from the start
It should be possible to add a profile with autoconnect blocked form the
start. Update2() has a %NM_SETTINGS_UPDATE2_FLAG_BLOCK_AUTOCONNECT flag to
block autoconnect, and so we need something similar when adding a connection.
As the existing AddConnection() and AddConnectionUnsaved() API is not
extensible, add AddConnection2() that has flags and room for additional
arguments.
Then add and implement the new flag %NM_SETTINGS_ADD_CONNECTION2_FLAG_BLOCK_AUTOCONNECT
for AddConnection2().
Note that libnm's nm_client_add_connection2() API can completely replace
the existing nm_client_add_connection_async() call. In particular, it
will automatically prefer to call the D-Bus methods AddConnection() and
AddConnectionUnsaved(), in order to work with server versions older than
1.20. The purpose of this is that when upgrading the package, the
running NetworkManager might still be older than the installed libnm.
Anyway, so since nm_client_add_connection2_finish() also has a result
output, the caller needs to decide whether he cares about that result.
Hence it has an argument ignore_out_result, which allows to fallback to
the old API. One might argue that a caller who doesn't care about the
output results while still wanting to be backward compatible, should
itself choose to call nm_client_add_connection_async() or
nm_client_add_connection2(). But instead, it's more convenient if the
new function can fully replace the old one, so that the caller does not
need to switch which start/finish method to call.
https://bugzilla.redhat.com/show_bug.cgi?id=1677068
2019-07-09 13:22:01 +00:00
Add a new connection profile.
2022-03-18 14:38:05 +00:00
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> .
core,libnm: add AddConnection2() D-Bus API to block autoconnect from the start
It should be possible to add a profile with autoconnect blocked form the
start. Update2() has a %NM_SETTINGS_UPDATE2_FLAG_BLOCK_AUTOCONNECT flag to
block autoconnect, and so we need something similar when adding a connection.
As the existing AddConnection() and AddConnectionUnsaved() API is not
extensible, add AddConnection2() that has flags and room for additional
arguments.
Then add and implement the new flag %NM_SETTINGS_ADD_CONNECTION2_FLAG_BLOCK_AUTOCONNECT
for AddConnection2().
Note that libnm's nm_client_add_connection2() API can completely replace
the existing nm_client_add_connection_async() call. In particular, it
will automatically prefer to call the D-Bus methods AddConnection() and
AddConnectionUnsaved(), in order to work with server versions older than
1.20. The purpose of this is that when upgrading the package, the
running NetworkManager might still be older than the installed libnm.
Anyway, so since nm_client_add_connection2_finish() also has a result
output, the caller needs to decide whether he cares about that result.
Hence it has an argument ignore_out_result, which allows to fallback to
the old API. One might argue that a caller who doesn't care about the
output results while still wanting to be backward compatible, should
itself choose to call nm_client_add_connection_async() or
nm_client_add_connection2(). But instead, it's more convenient if the
new function can fully replace the old one, so that the caller does not
need to switch which start/finish method to call.
https://bugzilla.redhat.com/show_bug.cgi?id=1677068
2019-07-09 13:22:01 +00:00
The new variant can do everything that the older variants could, and more.
2022-03-18 14:38:05 +00:00
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>
2022-03-14 09:20:11 +00:00
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>
2022-03-18 14:38:05 +00:00
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> .
core,libnm: add AddConnection2() D-Bus API to block autoconnect from the start
It should be possible to add a profile with autoconnect blocked form the
start. Update2() has a %NM_SETTINGS_UPDATE2_FLAG_BLOCK_AUTOCONNECT flag to
block autoconnect, and so we need something similar when adding a connection.
As the existing AddConnection() and AddConnectionUnsaved() API is not
extensible, add AddConnection2() that has flags and room for additional
arguments.
Then add and implement the new flag %NM_SETTINGS_ADD_CONNECTION2_FLAG_BLOCK_AUTOCONNECT
for AddConnection2().
Note that libnm's nm_client_add_connection2() API can completely replace
the existing nm_client_add_connection_async() call. In particular, it
will automatically prefer to call the D-Bus methods AddConnection() and
AddConnectionUnsaved(), in order to work with server versions older than
1.20. The purpose of this is that when upgrading the package, the
running NetworkManager might still be older than the installed libnm.
Anyway, so since nm_client_add_connection2_finish() also has a result
output, the caller needs to decide whether he cares about that result.
Hence it has an argument ignore_out_result, which allows to fallback to
the old API. One might argue that a caller who doesn't care about the
output results while still wanting to be backward compatible, should
itself choose to call nm_client_add_connection_async() or
nm_client_add_connection2(). But instead, it's more convenient if the
new function can fully replace the old one, so that the caller does not
need to switch which start/finish method to call.
https://bugzilla.redhat.com/show_bug.cgi?id=1677068
2019-07-09 13:22:01 +00:00
-->
<method name= "AddConnection2" >
<arg name= "settings" type= "a{sa{sv}}" direction= "in" />
<arg name= "flags" type= "u" direction= "in" />
<arg name= "args" type= "a{sv}" direction= "in" />
<arg name= "path" type= "o" direction= "out" />
<arg name= "result" type= "a{sv}" direction= "out" />
</method>
2016-04-04 23:09:48 +00:00
<!--
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).
@failures: Paths of connection files that could not be loaded.
Loads or reloads the indicated connections from disk. You should call this
after making changes directly to an on-disk connection file to make sure
2020-04-10 12:49:44 +00:00
that NetworkManager sees the changes.
As with AddConnection(), this operation does not necessarily
2016-04-04 23:09:48 +00:00
start the network connection.
2022-03-18 13:57:08 +00:00
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.
2016-04-04 23:09:48 +00:00
-->
2013-10-31 19:17:33 +00:00
<method name= "LoadConnections" >
2016-04-04 23:09:48 +00:00
<arg name= "filenames" type= "as" direction= "in" />
<arg name= "status" type= "b" direction= "out" />
<arg name= "failures" type= "as" direction= "out" />
2013-10-31 19:17:33 +00:00
</method>
2016-04-04 23:09:48 +00:00
<!--
ReloadConnections:
2019-10-06 21:19:32 +00:00
@status: This always returns %TRUE.
2016-04-04 23:09:48 +00:00
Tells NetworkManager to reload all connection files from disk, including
2020-04-10 12:49:44 +00:00
noticing any added or deleted connection files.
2016-04-04 23:09:48 +00:00
-->
2013-05-23 22:05:40 +00:00
<method name= "ReloadConnections" >
2016-04-04 23:09:48 +00:00
<arg name= "status" type= "b" direction= "out" />
2009-07-23 13:20:52 +00:00
</method>
2016-04-04 23:09:48 +00:00
<!--
SaveHostname:
@hostname: The hostname to save to persistent configuration. If blank, the persistent hostname is cleared.
2010-07-30 01:58:16 +00:00
Save the hostname to persistent configuration.
2016-04-04 23:09:48 +00:00
-->
<method name= "SaveHostname" >
<arg name= "hostname" type= "s" direction= "in" />
2010-07-30 01:58:16 +00:00
</method>
2016-04-04 23:09:48 +00:00
<!--
Connections:
2013-11-25 20:58:21 +00:00
List of object paths of available network connection profiles.
2016-04-04 23:09:48 +00:00
-->
<property name= "Connections" type= "ao" access= "read" />
<!--
Hostname:
2013-11-25 20:58:21 +00:00
2010-07-30 01:58:16 +00:00
The machine hostname stored in persistent configuration.
2016-04-04 23:09:48 +00:00
-->
<property name= "Hostname" type= "s" access= "read" />
<!--
CanModify:
2010-07-30 01:58:16 +00:00
If true, adding and modifying connections is supported.
2016-04-04 23:09:48 +00:00
-->
<property name= "CanModify" type= "b" access= "read" />
2010-07-30 01:58:16 +00:00
2022-02-25 13:22:53 +00:00
<!--
VersionId:
The version of the settings. This is incremented whenever the profile
changes and can be used to detect concurrent modifications.
Since: 1.44
-->
<property name= "VersionId" type= "t" access= "read" />
2016-04-04 23:09:48 +00:00
<!--
NewConnection:
@connection: Object path of the new connection.
2013-04-10 18:49:02 +00:00
Emitted when a new connection has been added after NetworkManager has
2016-04-04 23:09:48 +00:00
started up and initialized. This signal is not emitted for connections
2013-04-10 18:49:02 +00:00
read while starting up, because NetworkManager's D-Bus service is only
available after all connections have been read, and to prevent spamming
2016-04-04 23:09:48 +00:00
listeners with too many signals at one time. To retrieve the initial
2013-04-10 18:49:02 +00:00
connection list, call the ListConnections() method once, and then listen
for individual Settings.NewConnection and Settings.Connection.Deleted
signals for further updates.
2016-04-04 23:09:48 +00:00
-->
<signal name= "NewConnection" >
<arg name= "connection" type= "o" />
2008-04-04 14:57:02 +00:00
</signal>
2009-08-24 14:38:38 +00:00
2016-04-04 23:09:48 +00:00
<!--
ConnectionRemoved:
@connection: Object path of the removed connection.
Emitted when a 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 connection no
longer exists and cannot be used. Also see the Settings.Connection.Removed
signal.
-->
2013-11-26 15:45:21 +00:00
<signal name= "ConnectionRemoved" >
2016-04-04 23:09:48 +00:00
<arg name= "connection" type= "o" />
2013-11-26 15:45:21 +00:00
</signal>
2021-05-12 16:18:57 +00:00
2008-04-04 14:57:02 +00:00
</interface>
2007-08-03 16:10:04 +00:00
</node>
