|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
<html>
|
|
Packit |
5756e2 |
<head>
|
|
Packit |
5756e2 |
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
|
Packit |
5756e2 |
<title>org.freedesktop.NetworkManager.Settings.Connection: NetworkManager Reference Manual</title>
|
|
Packit |
5756e2 |
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
|
|
Packit |
5756e2 |
<link rel="home" href="index.html" title="NetworkManager Reference Manual">
|
|
Packit |
5756e2 |
<link rel="up" href="ref-dbus-settings.html" title="The /org/freedesktop/NetworkManager/Settings/* objects">
|
|
Packit |
5756e2 |
<link rel="prev" href="ref-dbus-settings.html" title="The /org/freedesktop/NetworkManager/Settings/* objects">
|
|
Packit |
5756e2 |
<link rel="next" href="ref-dbus-devices.html" title="The /org/freedesktop/NetworkManager/Devices/* objects">
|
|
Packit Service |
018b0a |
<meta name="generator" content="GTK-Doc V1.33.0 (XML mode)">
|
|
Packit |
5756e2 |
<link rel="stylesheet" href="style.css" type="text/css">
|
|
Packit |
5756e2 |
</head>
|
|
Packit |
5756e2 |
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
Top |
|
|
Packit |
5756e2 |
Description |
|
|
Packit |
5756e2 |
Properties |
|
|
Packit |
5756e2 |
Signals
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
org.freedesktop.NetworkManager.Settings.Connection
|
|
Packit |
5756e2 |
org.freedesktop.NetworkManager.Settings.Connection — Connection Settings Profile
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
Methods
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
Update (IN a{sa{sv}} properties);
|
|
Packit |
5756e2 |
UpdateUnsaved (IN a{sa{sv}} properties);
|
|
Packit |
5756e2 |
Delete ();
|
|
Packit |
5756e2 |
GetSettings (OUT a{sa{sv}} settings);
|
|
Packit |
5756e2 |
GetSecrets (IN s setting_name,
|
|
Packit |
5756e2 |
OUT a{sa{sv}} secrets);
|
|
Packit |
5756e2 |
ClearSecrets ();
|
|
Packit |
5756e2 |
Save ();
|
|
Packit |
5756e2 |
Update2 (IN a{sa{sv}} settings,
|
|
Packit |
5756e2 |
IN u flags,
|
|
Packit |
5756e2 |
IN a{sv} args,
|
|
Packit |
5756e2 |
OUT a{sv} result);
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
Signals
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
Updated ();
|
|
Packit |
5756e2 |
Removed ();
|
|
Packit |
5756e2 |
PropertiesChanged (a{sv} properties);
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
Properties
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
Unsaved readable b
|
|
Packit |
5756e2 |
Flags readable u
|
|
Packit |
5756e2 |
Filename readable s
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
Description
|
|
Packit |
5756e2 |
Represents a single network connection configuration.
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
Method Details
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
The Update() method
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
Update (IN a{sa{sv}} properties);
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
Update the connection with new settings and properties (replacing all
|
|
Packit |
5756e2 |
previous settings and properties) and save the connection to disk. Secrets
|
|
Packit |
5756e2 |
may be part of the update request, and will be either stored in persistent
|
|
Packit |
5756e2 |
storage or sent to a Secret Agent for storage, depending on the flags
|
|
Packit |
5756e2 |
associated with each secret.
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
IN a{sa{sv}} properties:
|
|
Packit |
5756e2 |
New connection settings, properties, and (optionally) secrets.
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
The UpdateUnsaved() method
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
UpdateUnsaved (IN a{sa{sv}} properties);
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
Update the connection with new settings and properties (replacing all
|
|
Packit |
5756e2 |
previous settings and properties) but do not immediately save the
|
|
Packit |
5756e2 |
connection to disk. Secrets may be part of the update request and may sent
|
|
Packit |
5756e2 |
to a Secret Agent for storage, depending on the flags associated with each
|
|
Packit |
5756e2 |
secret. Use the 'Save' method to save these changes to disk. Note that
|
|
Packit |
5756e2 |
unsaved changes will be lost if the connection is reloaded from disk
|
|
Packit |
5756e2 |
(either automatically on file change or due to an explicit
|
|
Packit |
5756e2 |
ReloadConnections call).
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
IN a{sa{sv}} properties:
|
|
Packit |
5756e2 |
New connection settings, properties, and (optionally) secrets.
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
The Delete() method
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
Delete ();
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
Delete the connection.
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
The GetSettings() method
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
GetSettings (OUT a{sa{sv}} settings);
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
Get the settings maps describing this network configuration. This will
|
|
Packit |
5756e2 |
never include any secrets required for connection to the network, as those
|
|
Packit |
5756e2 |
are often protected. Secrets must be requested separately using the
|
|
Packit |
5756e2 |
GetSecrets() call.
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
OUT a{sa{sv}} settings:
|
|
Packit |
5756e2 |
The nested settings maps describing this object.
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
The GetSecrets() method
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
GetSecrets (IN s setting_name,
|
|
Packit |
5756e2 |
OUT a{sa{sv}} secrets);
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
Get the secrets belonging to this network configuration. Only secrets from
|
|
Packit |
5756e2 |
persistent storage or a Secret Agent running in the requestor's session
|
|
Packit |
5756e2 |
will be returned. The user will never be prompted for secrets as a result
|
|
Packit |
5756e2 |
of this request.
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
IN s setting_name:
|
|
Packit |
5756e2 |
Name of the setting to return secrets for. If empty, all secrets will be returned.
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
OUT a{sa{sv}} secrets:
|
|
Packit |
5756e2 |
Nested settings maps containing secrets.
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
The ClearSecrets() method
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
ClearSecrets ();
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
Clear the secrets belonging to this network connection profile.
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
The Save() method
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
Save ();
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
Saves a "dirty" connection (that had previously been updated with
|
|
Packit |
5756e2 |
UpdateUnsaved) to persistent storage.
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
The Update2() method
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
Update2 (IN a{sa{sv}} settings,
|
|
Packit |
5756e2 |
IN u flags,
|
|
Packit |
5756e2 |
IN a{sv} args,
|
|
Packit |
5756e2 |
OUT a{sv} result);
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
Provide an empty array, to use the current settings.
|
|
Packit |
5756e2 |
flags: optional flags argument. Currently, supported flags are:
|
|
Packit |
5756e2 |
"0x1" (to-disk),
|
|
Packit |
5756e2 |
"0x2" (in-memory),
|
|
Packit |
5756e2 |
"0x4" (in-memory-detached),
|
|
Packit |
5756e2 |
"0x8" (in-memory-only),
|
|
Packit |
5756e2 |
"0x10" (volatile),
|
|
Packit |
5756e2 |
"0x20" (block-autoconnect),
|
|
Packit |
5756e2 |
"0x40" (no-reapply).
|
|
Packit |
5756e2 |
Unknown flags cause the call to fail.
|
|
Packit |
5756e2 |
args: optional arguments dictionary, for extentibility. Currently, no
|
|
Packit |
5756e2 |
arguments are accepted. Specifying unknown keys causes the call
|
|
Packit |
5756e2 |
to fail.
|
|
Packit |
5756e2 |
result: output argument, currently no results are returned.
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
Update the connection with new settings and properties (replacing all
|
|
Packit |
5756e2 |
previous settings and properties). If the flag 0x1 is present,
|
|
Packit |
5756e2 |
the connection is persisted to disk. If the flag 0x2 is present,
|
|
Packit |
5756e2 |
the change is only made in memory (without touching an eventual
|
|
Packit |
5756e2 |
profile on disk). If neither 0x1 nor 0x2 is set, the change is made
|
|
Packit |
5756e2 |
in memory only, if the connection is already in memory only.
|
|
Packit |
5756e2 |
The flags 0x4 (in-memory-detached) and 0x8 (in-memory-only) are like
|
|
Packit |
5756e2 |
"in-memory", but behave slightly different when migrating the profile
|
|
Packit |
5756e2 |
from disk to in-memory.
|
|
Packit |
5756e2 |
The flag 0x20 (block-autoconnect) blocks auto-connect on the updated
|
|
Packit |
5756e2 |
profile, and 0x40 (no-reapply) prevents "connection.zone" and "connection.metered"
|
|
Packit |
5756e2 |
properties to take effect on currently active devices.
|
|
Packit |
5756e2 |
Secrets may be part of the update request, and will be either stored in persistent
|
|
Packit |
5756e2 |
storage or sent to a Secret Agent for storage, depending on the flags
|
|
Packit |
5756e2 |
associated with each secret.
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
Update2 is a extensible alternative to Update, UpdateUnsaved and Save.
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
Since: 1.12
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
IN a{sa{sv}} settings:
|
|
Packit |
5756e2 |
New connection settings, properties, and (optionally) secrets.
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
IN u flags:
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
IN a{sv} args:
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
OUT a{sv} result:
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
Signal Details
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
The "Updated" signal
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
Updated ();
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
Emitted when any settings or permissions change. When handling this
|
|
Packit |
5756e2 |
signal, clients should re-read the connection using the GetSettings method
|
|
Packit |
5756e2 |
to get the changes and to ensure the client still has permission to access
|
|
Packit |
5756e2 |
the connection.
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
The "Removed" signal
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
Removed ();
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
Emitted when this connection is no longer available. This happens when the
|
|
Packit |
5756e2 |
connection is deleted or if it is no longer accessible by any of the
|
|
Packit |
5756e2 |
system's logged-in users. After receipt of this signal, the object no
|
|
Packit |
5756e2 |
longer exists. Also see the Settings.ConnectionRemoved signal.
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
The "PropertiesChanged" signal
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
PropertiesChanged (a{sv} properties);
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
DEPRECATED. Use the standard "PropertiesChanged" signal from "org.freedesktop.DBus.Properties" instead which exists since version NetworkManager 1.2.0.
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
a{sv} properties:
|
|
Packit |
5756e2 |
A dictionary mapping property names to variant boxed values.
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
Property Details
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
The "Unsaved" property
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
Unsaved readable b
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
If set, indicates that the in-memory state of the connection does not
|
|
Packit |
5756e2 |
match the on-disk state. This flag will be set when UpdateUnsaved() is
|
|
Packit |
5756e2 |
called or when any connection details change, and cleared when the
|
|
Packit |
5756e2 |
connection is saved to disk via Save() or from internal operations.
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
The "Flags" property
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
Flags readable u
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
Additional flags of the connection profile.
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
Returns: NMSettingsConnectionFlags
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
Since: 1.12
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
The "Filename" property
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
Filename readable s
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
File that stores the connection in case the connection is file-backed.
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
Since: 1.12
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit Service |
018b0a |
Generated by GTK-Doc V1.33.0
|
|
Packit |
5756e2 |
</body>
|
|
Packit |
5756e2 |
</html>
|