From 6accbd3ec0e42d8633bbde4d47ed7bfe854e7e0b Mon Sep 17 00:00:00 2001 From: Michael Biebl Date: Fri, 12 Aug 2022 19:21:11 +0200 Subject: New upstream version 1.38.4 --- ...us-org.freedesktop.NetworkManager.Settings.html | 217 +++++++++++++-------- 1 file changed, 138 insertions(+), 79 deletions(-) (limited to 'docs/api/html/gdbus-org.freedesktop.NetworkManager.Settings.html') diff --git a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Settings.html b/docs/api/html/gdbus-org.freedesktop.NetworkManager.Settings.html index 1d4adbea..7efdc770 100644 --- a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Settings.html +++ b/docs/api/html/gdbus-org.freedesktop.NetworkManager.Settings.html @@ -8,7 +8,7 @@ - + @@ -72,8 +72,9 @@

Description

The Settings interface allows clients to view and administrate the - connections stored and used by NetworkManager. +

+The Settings interface allows clients to view and administrate the +connections stored and used by NetworkManager.

@@ -83,7 +84,8 @@

 ListConnections (OUT ao connections);

List the saved network connections known to NetworkManager. +

+List the saved network connections known to NetworkManager.

@@ -92,7 +94,9 @@ ListConnections (OUT ao connections); - +

OUT ao connections:

List of connections.

+List of connections. +

@@ -103,7 +107,8 @@ ListConnections (OUT ao connections); GetConnectionByUuid (IN s uuid, OUT o connection); -

Retrieve the object path of a connection, given that connection's UUID. +

+Retrieve the object path of a connection, given that connection's UUID.

@@ -113,11 +118,15 @@ GetConnectionByUuid (IN s uuid, - + - +

`IN s uuid`:	The UUID to find the connection object path for.	+The UUID to find the connection object path for. +
`OUT o connection`:	The connection's object path.	+The connection's object path. +

@@ -129,10 +138,11 @@ GetConnectionByUuid (IN s uuid, AddConnection (IN a{sa{sv}} connection, OUT o path); -

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. +

+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.

@@ -142,11 +152,15 @@ AddConnection (IN a{sa{sv}} connection, - + - +

`IN a{sa{sv}} connection`:	Connection settings and properties.	+Connection settings and properties. +
`OUT o path`:	Object path of the new connection that was just added.	+Object path of the new connection that was just added. +

@@ -158,11 +172,12 @@ AddConnection (IN a{sa{sv}} connection, AddConnectionUnsaved (IN a{sa{sv}} connection, OUT o path); -

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 - on the connection to save these changes to disk. +

+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 +on the connection to save these changes to disk.

@@ -172,11 +187,15 @@ AddConnectionUnsaved (IN a{sa{sv}} connection, - + - +

`IN a{sa{sv}} connection`:	Connection settings and properties.	+Connection settings and properties. +
`OUT o path`:	Object path of the new connection that was just added.	+Object path of the new connection that was just added. +

@@ -191,18 +210,22 @@ AddConnection2 (IN a{sa{sv}} settings, OUT o path, OUT a{sv} result); -

Add a new connection profile. +

+Add a new connection profile.

AddConnection2 is an alternative to - AddConnection and - AddConnectionUnsaved. - The new variant can do everything that the older variants could, and more. - Its behavior is extensible via extra flags and args arguments. +

+AddConnection2 is an alternative to +AddConnection and +AddConnectionUnsaved. +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:

The flags argument accepts the combination of following values, - logically or-ed together: +

@@ -216,8 +239,8 @@ AddConnection2 (IN a{sa{sv}} settings, +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.

@@ -227,9 +250,11 @@ AddConnection2 (IN a{sa{sv}} settings,

`0x2 (in-memory)`:	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.
`0x20 (block-autoconnect)`:

The args argument accepts the following keys: +

+The args argument accepts the following keys: +

@@ -239,17 +264,18 @@ AddConnection2 (IN a{sa{sv}} settings,

plugin:

The settings plugin the newly added connection will - use, such as "keyfile" or "ifcfg-rh".

+use, such as "keyfile" or "ifcfg-rh".

Since 1.38

Either the flags 0x1 (to-disk) or 0x2 (in-memory) must be specified. - The effect is whether to behave like - AddConnection or - AddConnectionUnsaved. +

+Either the flags 0x1 (to-disk) or 0x2 (in-memory) must be specified. +The effect is whether to behave like +AddConnection or +AddConnectionUnsaved.

@@ -259,23 +285,33 @@ AddConnection2 (IN a{sa{sv}} settings, - + - + - + - + - +

`IN a{sa{sv}} settings`:	New connection settings, properties, and (optionally) secrets.	+New connection settings, properties, and (optionally) secrets. +
`IN u flags`:	Flags. Unknown flags cause the call to fail.	+Flags. Unknown flags cause the call to fail. +
`IN a{sv} args`:	Optional arguments dictionary, for extentibility. Specifying unknown keys causes the call to fail.	+Optional arguments dictionary, for extentibility. Specifying unknown keys causes the call to fail. +
`OUT o path`:	Object path of the new connection that was just added.	+Object path of the new connection that was just added. +
`OUT a{sv} result`:	Output argument, currently no additional results are returned.	+Output argument, currently no additional results are returned. +

@@ -289,15 +325,17 @@ LoadConnections (IN as filenames, OUT b status, OUT as failures); -

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 - that NetworkManager sees the changes. - As with AddConnection(), this operation does not necessarily - start the network connection. +

+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 +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. +

+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.

@@ -307,15 +345,21 @@ LoadConnections (IN as filenames, - + - + - +

`IN as filenames`:	Array of paths to on-disk connection profiles in directories monitored by NetworkManager.	+Array of paths to on-disk connection profiles in directories monitored by NetworkManager. +
`OUT b 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).	+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). +
`OUT as failures`:	Paths of connection files that could not be loaded.	+Paths of connection files that could not be loaded. +

@@ -326,8 +370,9 @@ LoadConnections (IN as filenames,

 ReloadConnections (OUT b status);

Tells NetworkManager to reload all connection files from disk, including - noticing any added or deleted connection files. +

+Tells NetworkManager to reload all connection files from disk, including +noticing any added or deleted connection files.

@@ -336,7 +381,9 @@ ReloadConnections (OUT b status); - +

OUT b status:

This always returns TRUE.

+This always returns TRUE. +

@@ -346,7 +393,8 @@ ReloadConnections (OUT b status);

 SaveHostname (IN  s hostname);

Save the hostname to persistent configuration. +

+Save the hostname to persistent configuration.

@@ -355,7 +403,9 @@ SaveHostname (IN s hostname); - +

IN s hostname:

The hostname to save to persistent configuration. If blank, the persistent hostname is cleared.

+The hostname to save to persistent configuration. If blank, the persistent hostname is cleared. +

@@ -367,14 +417,15 @@ SaveHostname (IN s hostname);

 NewConnection (o connection);

Emitted when a new connection has been added after NetworkManager has - started up and initialized. This signal is not emitted for connections - read while starting up, because NetworkManager's D-Bus service is only - available after all connections have been read, and to prevent spamming - listeners with too many signals at one time. To retrieve the initial - connection list, call the ListConnections() method once, and then listen - for individual Settings.NewConnection and Settings.Connection.Deleted - signals for further updates. +

+Emitted when a new connection has been added after NetworkManager has +started up and initialized. This signal is not emitted for connections +read while starting up, because NetworkManager's D-Bus service is only +available after all connections have been read, and to prevent spamming +listeners with too many signals at one time. To retrieve the initial +connection list, call the ListConnections() method once, and then listen +for individual Settings.NewConnection and Settings.Connection.Deleted +signals for further updates.

@@ -383,7 +434,9 @@ NewConnection (o connection); - +

o connection:

Object path of the new connection.

+Object path of the new connection. +

@@ -393,11 +446,12 @@ NewConnection (o connection);

 ConnectionRemoved (o 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. +

+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.

@@ -406,7 +460,9 @@ ConnectionRemoved (o connection); - +

o connection:

Object path of the removed connection.

+Object path of the removed connection. +

@@ -418,7 +474,8 @@ ConnectionRemoved (o connection);

 Connections  readable   ao

List of object paths of available network connection profiles. +

+List of object paths of available network connection profiles.

@@ -427,7 +484,8 @@ Connections readable ao

 Hostname  readable   s

The machine hostname stored in persistent configuration. +

+The machine hostname stored in persistent configuration.

@@ -436,12 +494,13 @@ Hostname readable s

 CanModify  readable   b

If true, adding and modifying connections is supported. +

+If true, adding and modifying connections is supported.

Generated by GTK-Doc V1.33.1 \ No newline at end of file -- cgit 1.3.0-6-gf8a5