1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
|
<?xml version="1.0" encoding="UTF-8"?>
<node name="/">
<!--
org.freedesktop.NetworkManager.Settings.Connection:
@short_description: Connection Settings Profile.
Represents a single network connection configuration.
-->
<interface name="org.freedesktop.NetworkManager.Settings.Connection">
<!--
Update:
@properties: New connection settings, properties, and (optionally) secrets.
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.
-->
<method name="Update">
<arg name="properties" type="a{sa{sv}}" direction="in"/>
</method>
<!--
UpdateUnsaved:
@properties: New connection settings, properties, and (optionally) secrets.
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).
-->
<method name="UpdateUnsaved">
<arg name="properties" type="a{sa{sv}}" direction="in"/>
</method>
<!--
Delete:
Delete the connection.
-->
<method name="Delete"/>
<!--
GetSettings:
@settings: The nested settings maps describing this object.
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.
-->
<method name="GetSettings">
<arg name="settings" type="a{sa{sv}}" direction="out"/>
</method>
<!--
GetSecrets:
@setting_name: Name of the setting to return secrets for. If empty, all secrets will be returned.
@secrets: Nested settings maps containing secrets.
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.
-->
<method name="GetSecrets">
<arg name="setting_name" type="s" direction="in"/>
<arg name="secrets" type="a{sa{sv}}" direction="out"/>
</method>
<!--
ClearSecrets:
Clear the secrets belonging to this network connection profile.
-->
<method name="ClearSecrets"/>
<!--
Save:
Saves a "dirty" connection (that had previously been updated with
UpdateUnsaved) to persistent storage.
-->
<method name="Save"/>
<!--
Updated:
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.
-->
<signal name="Updated"/>
<!--
Update2:
@settings: New connection settings, properties, and (optionally) secrets. Provide an empty array to use the current settings.
@flags: Optional flags. Unknown flags cause the call to fail.
@args: Optional arguments dictionary, for extentibility. Specifying unknown keys causes the call to fail.
@result: Currently no results are returned.
@since: 1.12
Update the connection with new settings and properties (replacing all
previous settings and properties).
Update2 is an alternative to
<link linkend="gdbus-method-org-freedesktop-NetworkManager-Settings-Connection.Update">Update</link>,
<link linkend="gdbus-method-org-freedesktop-NetworkManager-Settings-Connection.UpdateUnsaved">UpdateUnsaved</link>
and <link linkend="gdbus-method-org-freedesktop-NetworkManager-Settings-Connection.Save">Save</link>
extensible with 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>0x4 (in-memory-detached)</literal>:</term>
<listitem><para>Like "in-memory", but behaves slightly different when migrating
the profile from disk to in-memory.</para></listitem>
</varlistentry>
<varlistentry>
<term><literal>0x8 (in-memory-only)</literal>:</term>
<listitem><para>Like "in-memory", but behaves slightly different when migrating
the profile from disk to in-memory.</para></listitem>
</varlistentry>
<varlistentry>
<term><literal>0x10 (volatile)</literal>:</term>
</varlistentry>
<varlistentry>
<term><literal>0x20 (block-autoconnect)</literal>:</term>
<listitem><para>Blocks auto-connect on the updated profile</para></listitem>
</varlistentry>
<varlistentry>
<term><literal>0x40 (no-reapply)</literal>:</term>
<listitem><para>Prevents "connection.zone" and "connection.metered" properties
to take effect on currently active devices.</para></listitem>
</varlistentry>
</variablelist>
The %args argument accepts the following keys:
<variablelist>
<varlistentry>
<term><literal>plugin</literal>:</term>
<listitem><para>The settings plugin the connection will be migrated to
such as "keyfile" or "ifcfg-rh".</para>
<para role="since">Since 1.38</para></listitem>
<term><literal>version-id</literal>:</term>
<listitem><para>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.</para><para role="since">Since 1.44</para></listitem>
</varlistentry>
</variablelist>
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.
-->
<method name="Update2">
<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="result" type="a{sv}" direction="out"/>
</method>
<!--
Removed:
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.
-->
<signal name="Removed"/>
<!--
Unsaved:
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.
-->
<property name="Unsaved" type="b" access="read"/>
<!--
Flags:
@since: 1.12
Additional flags of the connection profile.
Returns: <link linkend="NMSettingsConnectionFlags">NMSettingsConnectionFlags</link>
-->
<property name="Flags" type="u" access="read"/>
<!--
Filename:
@since: 1.12
File that stores the connection in case the connection is file-backed.
-->
<property name="Filename" type="s" access="read"/>
</interface>
</node>
|
