1NM-SETTINGS(5) Configuration NM-SETTINGS(5)
2
6 nm-settings - Description of settings and properties of NetworkManager
7 connection profiles
8
10 NetworkManager is based on a concept of connection profiles, sometimes
11 referred to as connections only. These connection profiles contain a
12 network configuration. When NetworkManager activates a connection
13 profile on a network device the configuration will be applied and an
14 active network connection will be established. Users are free to create
15 as many connection profiles as they see fit. Thus they are flexible in
16 having various network configurations for different networking needs.
17 The connection profiles are handled by NetworkManager via settings
18 service and are exported on D-Bus
19 (/org/freedesktop/NetworkManager/Settings/<num> objects). The
20 conceptual objects can be described as follows:
21 Connection (profile)
23 A specific, encapsulated, independent group of settings describing
24 all the configuration required to connect to a specific network. It
25 is referred to by a unique identifier called the UUID. A connection
26 is tied to a one specific device type, but not necessarily a
27 specific hardware device. It is composed of one or more Settings
28 objects.
29 Setting
31 A group of related key/value pairs describing a specific piece of a
32 Connection (profile). Settings keys and allowed values are
33 described in the tables below. Keys are also referred to as
34 properties. Developers can find the setting objects and their
35 properties in the libnm-core sources. Look for the *_class_init
36 functions near the bottom of each setting source file.
37 The settings and properties shown in tables below list all available
39 connection configuration options. However, note that not all settings
40 are applicable to all connection types. NetworkManager provides a
41 command-line tool nmcli that allows direct configuration of the
42 settings and properties according to a connection profile type. nmcli
43 connection editor has also a built-in describe command that can display
44 description of particular settings and properties of this page.
45 connection setting
47 General Connection Profile Settings.
48 ┌─────────────────────┬──────────────────────────────────────┬───────────────┬────────────────────────────────────────┐
50 │Key Name │ Value Type │ Default Value │ Value │
51 │ │ │ │ Description │
52 ├─────────────────────┼──────────────────────────────────────┼───────────────┼────────────────────────────────────────┤
53 │auth-retries │ int32 │ -1 │ The number of │
54 │ │ │ │ retries for the │
55 │ │ │ │ authentication. │
56 │ │ │ │ Zero means to │
57 │ │ │ │ try │
58 │ │ │ │ indefinitely; -1 │
59 │ │ │ │ means to use a │
60 │ │ │ │ global default. │
61 │ │ │ │ If the global │
62 │ │ │ │ default is not │
63 │ │ │ │ set, the │
64 │ │ │ │ authentication │
65 │ │ │ │ retries for 3 │
66 │ │ │ │ times before │
67 │ │ │ │ failing the │
68 │ │ │ │ connection. │
69 │ │ │ │ Currently this │
70 │ │ │ │ only applies to │
71 │ │ │ │ 802-1x │
72 │ │ │ │ authentication. │
73 ├─────────────────────┼──────────────────────────────────────┼───────────────┼────────────────────────────────────────┤
74 │autoconnect │ boolean │ TRUE │ Whether or not │
75 │ │ │ │ the connection │
76 │ │ │ │ should be │
77 │ │ │ │ automatically │
78 │ │ │ │ connected by │
79 │ │ │ │ NetworkManager │
80 │ │ │ │ when the │
81 │ │ │ │ resources for │
82 │ │ │ │ the connection │
83 │ │ │ │ are available. │
84 │ │ │ │ TRUE to │
85 │ │ │ │ automatically │
86 │ │ │ │ activate the │
87 │ │ │ │ connection, │
88 │ │ │ │ FALSE to require │
89 │ │ │ │ manual │
90 │ │ │ │ intervention to │
91 │ │ │ │ activate the │
92 │ │ │ │ connection. Note │
93 │ │ │ │ that autoconnect │
94 │ │ │ │ is not │
95 │ │ │ │ implemented for │
96 │ │ │ │ VPN profiles. │
97 │ │ │ │ See │
98 │ │ │ │ "secondaries" as │
99 │ │ │ │ an alternative │
100 │ │ │ │ to automatically │
101 │ │ │ │ connect VPN │
102 │ │ │ │ profiles. │
103 ├─────────────────────┼──────────────────────────────────────┼───────────────┼────────────────────────────────────────┤
104 │autoconnect-priority │ int32 │ 0 │ The autoconnect │
105 │ │ │ │ priority. If the │
106 │ │ │ │ connection is │
107 │ │ │ │ set to │
108 │ │ │ │ autoconnect, │
109 │ │ │ │ connections with │
110 │ │ │ │ higher priority │
111 │ │ │ │ will be │
112 │ │ │ │ preferred. │
113 │ │ │ │ Defaults to 0. │
114 │ │ │ │ The higher │
115 │ │ │ │ number means │
116 │ │ │ │ higher priority. │
117 ├─────────────────────┼──────────────────────────────────────┼───────────────┼────────────────────────────────────────┤
118 │autoconnect-retries │ int32 │ -1 │ The number of │
119 │ │ │ │ times a │
120 │ │ │ │ connection │
121 │ │ │ │ should be tried │
122 │ │ │ │ when │
123 │ │ │ │ autoactivating │
124 │ │ │ │ before giving │
125 │ │ │ │ up. Zero means │
126 │ │ │ │ forever, -1 │
127 │ │ │ │ means the global │
128 │ │ │ │ default (4 times │
129 │ │ │ │ if not │
130 │ │ │ │ overridden). │
131 │ │ │ │ Setting this to │
132 │ │ │ │ 1 means to try │
133 │ │ │ │ activation only │
134 │ │ │ │ once before │
135 │ │ │ │ blocking │
136 │ │ │ │ autoconnect. │
137 │ │ │ │ Note that after │
138 │ │ │ │ a timeout, │
139 │ │ │ │ NetworkManager │
140 │ │ │ │ will try to │
141 │ │ │ │ autoconnect │
142 │ │ │ │ again. │
143 ├─────────────────────┼──────────────────────────────────────┼───────────────┼────────────────────────────────────────┤
144 │autoconnect-slaves │ NMSettingConnectionAutoconnectSlaves │ │ Whether or not │
145 │ │ (int32) │ │ slaves of this │
146 │ │ │ │ connection │
147 │ │ │ │ should be │
148 │ │ │ │ automatically │
149 │ │ │ │ brought up when │
150 │ │ │ │ NetworkManager │
151 │ │ │ │ activates this │
152 │ │ │ │ connection. This │
153 │ │ │ │ only has a real │
154 │ │ │ │ effect for │
155 │ │ │ │ master │
156 │ │ │ │ connections. The │
157 │ │ │ │ properties │
158 │ │ │ │ "autoconnect", │
159 │ │ │ │ "autoconnect-priority" │
160 │ │ │ │ and │
161 │ │ │ │ "autoconnect-retries" │
162 │ │ │ │ are unrelated to │
163 │ │ │ │ this setting. │
164 │ │ │ │ The permitted │
165 │ │ │ │ values are: 0: │
166 │ │ │ │ leave slave │
167 │ │ │ │ connections │
168 │ │ │ │ untouched, 1: │
169 │ │ │ │ activate all the │
170 │ │ │ │ slave │
171 │ │ │ │ connections with │
172 │ │ │ │ this connection, │
173 │ │ │ │ -1: default. If │
174 │ │ │ │ -1 (default) is │
175 │ │ │ │ set, global │
176 │ │ │ │ connection.autoconnect-slaves │
177 │ │ │ │ is read to │
178 │ │ │ │ determine the │
179 │ │ │ │ real value. If │
180 │ │ │ │ it is default as │
181 │ │ │ │ well, this │
182 │ │ │ │ fallbacks to 0. │
183 ├─────────────────────┼──────────────────────────────────────┼───────────────┼────────────────────────────────────────┤
184 │gateway-ping-timeout │ uint32 │ 0 │ If greater than zero, delay │
185 │ │ │ │ success of IP addressing │
186 │ │ │ │ until either the timeout is │
187 │ │ │ │ reached, or an IP gateway │
188 │ │ │ │ replies to a ping. │
189 ├─────────────────────┼──────────────────────────────────────┼───────────────┼────────────────────────────────────────┤
190 │id │ string │ │ A human readable unique │
191 │ │ │ │ identifier for the │
192 │ │ │ │ connection, like "Work Wi-Fi" │
193 │ │ │ │ or "T-Mobile 3G". │
194 ├─────────────────────┼──────────────────────────────────────┼───────────────┼────────────────────────────────────────┤
195 │interface-name │ string │ │ The name of the network │
196 │ │ │ │ interface this connection is │
197 │ │ │ │ bound to. If not set, then │
198 │ │ │ │ the connection can be │
199 │ │ │ │ attached to any interface of │
200 │ │ │ │ the appropriate type (subject │
201 │ │ │ │ to restrictions imposed by │
202 │ │ │ │ other settings). For software │
203 │ │ │ │ devices this specifies the │
204 │ │ │ │ name of the created device. │
205 │ │ │ │ For connection types where │
206 │ │ │ │ interface names cannot easily │
207 │ │ │ │ be made persistent (e.g. │
208 │ │ │ │ mobile broadband or USB │
209 │ │ │ │ Ethernet), this property │
210 │ │ │ │ should not be used. Setting │
211 │ │ │ │ this property restricts the │
212 │ │ │ │ interfaces a connection can │
213 │ │ │ │ be used with, and if │
214 │ │ │ │ interface names change or are │
215 │ │ │ │ reordered the connection may │
216 │ │ │ │ be applied to the wrong │
217 │ │ │ │ interface. │
218 ├─────────────────────┼──────────────────────────────────────┼───────────────┼────────────────────────────────────────┤
219 │lldp │ int32 │ -1 │ Whether LLDP is enabled for │
220 │ │ │ │ the connection. │
221 ├─────────────────────┼──────────────────────────────────────┼───────────────┼────────────────────────────────────────┤
222 │master │ string │ │ Interface name of the master │
223 │ │ │ │ device or UUID of the master │
224 │ │ │ │ connection. │
225 ├─────────────────────┼──────────────────────────────────────┼───────────────┼────────────────────────────────────────┤
226 │mdns │ int32 │ -1 │ Whether mDNS is enabled for │
227 │ │ │ │ the connection. The permitted │
228 │ │ │ │ values are: yes: register │
229 │ │ │ │ hostname and resolving for │
230 │ │ │ │ the connection, no: disable │
231 │ │ │ │ mDNS for the interface, │
232 │ │ │ │ resolve: do not register │
233 │ │ │ │ hostname but allow resolving │
234 │ │ │ │ of mDNS host names. This │
235 │ │ │ │ feature requires a plugin │
236 │ │ │ │ which supports mDNS. One such │
237 │ │ │ │ plugin is │
238 │ │ │ │ dns-systemd-resolved. │
239 ├─────────────────────┼──────────────────────────────────────┼───────────────┼────────────────────────────────────────┤
240 │metered │ NMMetered (int32) │ │ Whether the connection is │
241 │ │ │ │ metered. When updating this │
242 │ │ │ │ property on a currently │
243 │ │ │ │ activated connection, the │
244 │ │ │ │ change takes effect │
245 │ │ │ │ immediately. │
246 ├─────────────────────┼──────────────────────────────────────┼───────────────┼────────────────────────────────────────┤
247 │name │ string │ connection │ The setting's name, which │
248 │ │ │ │ uniquely identifies the │
249 │ │ │ │ setting within the │
250 │ │ │ │ connection. Each setting │
251 │ │ │ │ type has a name unique to │
252 │ │ │ │ that type, for example "ppp" │
253 │ │ │ │ or "wireless" or "wired". │
254 ├─────────────────────┼──────────────────────────────────────┼───────────────┼────────────────────────────────────────┤
255 │permissions │ array of string │ [] │ An array of strings defining │
256 │ │ │ │ what access a given user has │
257 │ │ │ │ to this connection. If this │
258 │ │ │ │ is NULL or empty, all users │
259 │ │ │ │ are allowed to access this │
260 │ │ │ │ connection; otherwise users │
261 │ │ │ │ are allowed if and only if │
262 │ │ │ │ they are in this list. When │
263 │ │ │ │ this is not empty, the │
264 │ │ │ │ connection can be active only │
265 │ │ │ │ when one of the specified │
266 │ │ │ │ users is logged into an │
267 │ │ │ │ active session. Each entry │
268 │ │ │ │ is of the form │
269 │ │ │ │ "[type]:[id]:[reserved]"; for │
270 │ │ │ │ example, "user:dcbw:blah". At │
271 │ │ │ │ this time only the "user" │
272 │ │ │ │ [type] is allowed. Any other │
273 │ │ │ │ values are ignored and │
274 │ │ │ │ reserved for future use. │
275 │ │ │ │ [id] is the username that │
276 │ │ │ │ this permission refers to, │
277 │ │ │ │ which may not contain the ":" │
278 │ │ │ │ character. Any [reserved] │
279 │ │ │ │ information present must be │
280 │ │ │ │ ignored and is reserved for │
281 │ │ │ │ future use. All of [type], │
282 │ │ │ │ [id], and [reserved] must be │
283 │ │ │ │ valid UTF-8. │
284 ├─────────────────────┼──────────────────────────────────────┼───────────────┼────────────────────────────────────────┤
285 │read-only │ boolean │ FALSE │ FALSE if the connection can │
286 │ │ │ │ be modified using the │
287 │ │ │ │ provided settings service's │
288 │ │ │ │ D-Bus interface with the │
289 │ │ │ │ right privileges, or TRUE if │
290 │ │ │ │ the connection is read-only │
291 │ │ │ │ and cannot be modified. │
292 ├─────────────────────┼──────────────────────────────────────┼───────────────┼────────────────────────────────────────┤
293 │secondaries │ array of string │ [] │ List of connection UUIDs that │
294 │ │ │ │ should be activated when the │
295 │ │ │ │ base connection itself is │
296 │ │ │ │ activated. Currently only VPN │
297 │ │ │ │ connections are supported. │
298 ├─────────────────────┼──────────────────────────────────────┼───────────────┼────────────────────────────────────────┤
299 │slave-type │ string │ │ Setting name of the device │
300 │ │ │ │ type of this slave's master │
301 │ │ │ │ connection (eg, "bond"), or │
302 │ │ │ │ NULL if this connection is │
303 │ │ │ │ not a slave. │
304 ├─────────────────────┼──────────────────────────────────────┼───────────────┼────────────────────────────────────────┤
305 │stable-id │ string │ │ This represents the identity │
306 │ │ │ │ of the connection used for │
307 │ │ │ │ various purposes. It allows │
308 │ │ │ │ to configure multiple │
309 │ │ │ │ profiles to share the │
310 │ │ │ │ identity. Also, the stable-id │
311 │ │ │ │ can contain placeholders that │
312 │ │ │ │ are substituted dynamically │
313 │ │ │ │ and deterministically │
314 │ │ │ │ depending on the context. The │
315 │ │ │ │ stable-id is used for │
316 │ │ │ │ generating IPv6 stable │
317 │ │ │ │ private addresses with │
318 │ │ │ │ ipv6.addr-gen-mode=stable-privacy. │
319 │ │ │ │ It is also used to seed the │
320 │ │ │ │ generated cloned MAC address │
321 │ │ │ │ for │
322 │ │ │ │ ethernet.cloned-mac-address=stable │
323 │ │ │ │ and │
324 │ │ │ │ wifi.cloned-mac-address=stable. │
325 │ │ │ │ It is also used as DHCP │
326 │ │ │ │ client identifier with │
327 │ │ │ │ ipv4.dhcp-client-id=stable │
328 │ │ │ │ and to derive the DHCP DUID │
329 │ │ │ │ with │
330 │ │ │ │ ipv6.dhcp-duid=stable-[llt,ll,uuid]. │
331 │ │ │ │ Note that depending on the │
332 │ │ │ │ context where it is used, │
333 │ │ │ │ other parameters are also │
334 │ │ │ │ seeded into the generation │
335 │ │ │ │ algorithm. For example, a │
336 │ │ │ │ per-host key is commonly also │
337 │ │ │ │ included, so that different │
338 │ │ │ │ systems end up generating │
339 │ │ │ │ different IDs. Or with │
340 │ │ │ │ ipv6.addr-gen-mode=stable-privacy, │
341 │ │ │ │ also the device's name is │
342 │ │ │ │ included, so that different │
343 │ │ │ │ interfaces yield different │
344 │ │ │ │ addresses. The '$' character │
345 │ │ │ │ is treated special to perform │
346 │ │ │ │ dynamic substitutions at │
347 │ │ │ │ runtime. Currently supported │
348 │ │ │ │ are "${CONNECTION}", │
349 │ │ │ │ "${DEVICE}", "${BOOT}", │
350 │ │ │ │ "${RANDOM}". These │
351 │ │ │ │ effectively create unique IDs │
352 │ │ │ │ per-connection, per-device, │
353 │ │ │ │ per-boot, or every time. Note │
354 │ │ │ │ that "${DEVICE}" corresponds │
355 │ │ │ │ the the interface name of the │
356 │ │ │ │ device. Any unrecognized │
357 │ │ │ │ patterns following '$' are │
358 │ │ │ │ treated verbatim, however are │
359 │ │ │ │ reserved for future use. You │
360 │ │ │ │ are thus advised to avoid '$' │
361 │ │ │ │ or escape it as "$$". For │
362 │ │ │ │ example, set it to │
363 │ │ │ │ "${CONNECTION}-${BOOT}-${DEVICE}" │
364 │ │ │ │ to create a unique id for │
365 │ │ │ │ this connection that changes │
366 │ │ │ │ with every reboot and differs │
367 │ │ │ │ depending on the interface │
368 │ │ │ │ where the profile activates. │
369 │ │ │ │ If the value is unset, a │
370 │ │ │ │ global connection default is │
371 │ │ │ │ consulted. If the value is │
372 │ │ │ │ still unset, the default is │
373 │ │ │ │ similar to "${CONNECTION}" │
374 │ │ │ │ and uses a unique, fixed ID │
375 │ │ │ │ for the connection. │
376 ├─────────────────────┼──────────────────────────────────────┼───────────────┼────────────────────────────────────────┤
377 │timestamp │ uint64 │ 0 │ The time, in seconds since the Unix │
378 │ │ │ │ Epoch, that the connection was last │
379 │ │ │ │ _successfully_ fully activated. │
380 │ │ │ │ NetworkManager updates the │
381 │ │ │ │ connection timestamp periodically │
382 │ │ │ │ when the connection is active to │
383 │ │ │ │ ensure that an active connection has │
384 │ │ │ │ the latest timestamp. The property │
385 │ │ │ │ is only meant for reading (changes │
386 │ │ │ │ to this property will not be │
387 │ │ │ │ preserved). │
388 ├─────────────────────┼──────────────────────────────────────┼───────────────┼────────────────────────────────────────┤
389 │type │ string │ │ Base type of the connection. For │
390 │ │ │ │ hardware-dependent connections, │
391 │ │ │ │ should contain the setting name of │
392 │ │ │ │ the hardware-type specific setting │
393 │ │ │ │ (ie, "802-3-ethernet" or │
394 │ │ │ │ "802-11-wireless" or "bluetooth", │
395 │ │ │ │ etc), and for non-hardware dependent │
396 │ │ │ │ connections like VPN or otherwise, │
397 │ │ │ │ should contain the setting name of │
398 │ │ │ │ that setting type (ie, "vpn" or │
399 │ │ │ │ "bridge", etc). │
400 ├─────────────────────┼──────────────────────────────────────┼───────────────┼────────────────────────────────────────┤
401 │uuid │ string │ │ A universally unique identifier for │
402 │ │ │ │ the connection, for example │
403 │ │ │ │ generated with libuuid. It should │
404 │ │ │ │ be assigned when the connection is │
405 │ │ │ │ created, and never changed as long │
406 │ │ │ │ as the connection still applies to │
407 │ │ │ │ the same network. For example, it │
408 │ │ │ │ should not be changed when the "id" │
409 │ │ │ │ property or NMSettingIP4Config │
410 │ │ │ │ changes, but might need to be │
411 │ │ │ │ re-created when the Wi-Fi SSID, │
412 │ │ │ │ mobile broadband network provider, │
413 │ │ │ │ or "type" property changes. The UUID │
414 │ │ │ │ must be in the format │
415 │ │ │ │ "2815492f-7e56-435e-b2e9-246bd7cdc664" │
416 │ │ │ │ (ie, contains only hexadecimal │
417 │ │ │ │ characters and "-"). │
418 ├─────────────────────┼──────────────────────────────────────┼───────────────┼────────────────────────────────────────┤
419 │zone │ string │ │ The trust level of a the connection. │
420 │ │ │ │ Free form case-insensitive string (for │
421 │ │ │ │ example "Home", "Work", "Public"). │
422 │ │ │ │ NULL or unspecified zone means the │
423 │ │ │ │ connection will be placed in the │
424 │ │ │ │ default zone as defined by the │
425 │ │ │ │ firewall. When updating this property │
426 │ │ │ │ on a currently activated connection, │
427 │ │ │ │ the change takes effect immediately. │
428 └─────────────────────┴──────────────────────────────────────┴───────────────┴────────────────────────────────────────┘
429 802-1x setting
431 IEEE 802.1x Authentication Settings.
432 ┌──────────────────────────────────┬──────────────────────┬───────────────┬────────────────────────────────────────────┐
434 │Key Name │ Value Type │ Default Value │ Value │
435 │ │ │ │ Description │
436 ├──────────────────────────────────┼──────────────────────┼───────────────┼────────────────────────────────────────────┤
437 │altsubject-matches │ array of string │ [] │ List of strings │
438 │ │ │ │ to be matched │
439 │ │ │ │ against the │
440 │ │ │ │ altSubjectName │
441 │ │ │ │ of the │
442 │ │ │ │ certificate │
443 │ │ │ │ presented by the │
444 │ │ │ │ authentication │
445 │ │ │ │ server. If the │
446 │ │ │ │ list is empty, │
447 │ │ │ │ no verification │
448 │ │ │ │ of the server │
449 │ │ │ │ certificate's │
450 │ │ │ │ altSubjectName │
451 │ │ │ │ is performed. │
452 ├──────────────────────────────────┼──────────────────────┼───────────────┼────────────────────────────────────────────┤
453 │anonymous-identity │ string │ │ Anonymous │
454 │ │ │ │ identity string │
455 │ │ │ │ for EAP │
456 │ │ │ │ authentication │
457 │ │ │ │ methods. Used │
458 │ │ │ │ as the │
459 │ │ │ │ unencrypted │
460 │ │ │ │ identity with │
461 │ │ │ │ EAP types that │
462 │ │ │ │ support │
463 │ │ │ │ different │
464 │ │ │ │ tunneled │
465 │ │ │ │ identity like │
466 │ │ │ │ EAP-TTLS. │
467 ├──────────────────────────────────┼──────────────────────┼───────────────┼────────────────────────────────────────────┤
468 │auth-timeout │ int32 │ 0 │ A timeout for │
469 │ │ │ │ the │
470 │ │ │ │ authentication. │
471 │ │ │ │ Zero means the │
472 │ │ │ │ global default; │
473 │ │ │ │ if the global │
474 │ │ │ │ default is not │
475 │ │ │ │ set, the │
476 │ │ │ │ authentication │
477 │ │ │ │ timeout is 25 │
478 │ │ │ │ seconds. │
479 ├──────────────────────────────────┼──────────────────────┼───────────────┼────────────────────────────────────────────┤
480 │ca-cert │ byte array │ │ Contains the CA │
481 │ │ │ │ certificate if │
482 │ │ │ │ used by the EAP │
483 │ │ │ │ method specified │
484 │ │ │ │ in the "eap" │
485 │ │ │ │ property. │
486 │ │ │ │ Certificate data │
487 │ │ │ │ is specified │
488 │ │ │ │ using a │
489 │ │ │ │ "scheme"; two │
490 │ │ │ │ are currently │
491 │ │ │ │ supported: blob │
492 │ │ │ │ and path. When │
493 │ │ │ │ using the blob │
494 │ │ │ │ scheme (which is │
495 │ │ │ │ backwards │
496 │ │ │ │ compatible with │
497 │ │ │ │ NM 0.7.x) this │
498 │ │ │ │ property should │
499 │ │ │ │ be set to the │
500 │ │ │ │ certificate's │
501 │ │ │ │ DER encoded │
502 │ │ │ │ data. When using │
503 │ │ │ │ the path scheme, │
504 │ │ │ │ this property │
505 │ │ │ │ should be set to │
506 │ │ │ │ the full UTF-8 │
507 │ │ │ │ encoded path of │
508 │ │ │ │ the certificate, │
509 │ │ │ │ prefixed with │
510 │ │ │ │ the string │
511 │ │ │ │ "file://" and │
512 │ │ │ │ ending with a │
513 │ │ │ │ terminating NUL │
514 │ │ │ │ byte. This │
515 │ │ │ │ property can be │
516 │ │ │ │ unset even if │
517 │ │ │ │ the EAP method │
518 │ │ │ │ supports CA │
519 │ │ │ │ certificates, │
520 │ │ │ │ but this allows │
521 │ │ │ │ man-in-the-middle │
522 │ │ │ │ attacks and is │
523 │ │ │ │ NOT recommended. │
524 ├──────────────────────────────────┼──────────────────────┼───────────────┼────────────────────────────────────────────┤
525 │ca-cert-password │ string │ │ The password used │
526 │ │ │ │ to access the CA │
527 │ │ │ │ certificate │
528 │ │ │ │ stored in │
529 │ │ │ │ "ca-cert" │
530 │ │ │ │ property. Only │
531 │ │ │ │ makes sense if │
532 │ │ │ │ the certificate │
533 │ │ │ │ is stored on a │
534 │ │ │ │ PKCS#11 token │
535 │ │ │ │ that requires a │
536 │ │ │ │ login. │
537 ├──────────────────────────────────┼──────────────────────┼───────────────┼────────────────────────────────────────────┤
538 │ca-cert-password-flags │ NMSettingSecretFlags │ │ Flags indicating │
539 │ │ (uint32) │ │ how to handle the │
540 │ │ │ │ "ca-cert-password" │
541 │ │ │ │ property. (see │
542 │ │ │ │ the section │
543 │ │ │ │ called “Secret │
544 │ │ │ │ flag types:” for │
545 │ │ │ │ flag values) │
546 ├──────────────────────────────────┼──────────────────────┼───────────────┼────────────────────────────────────────────┤
547 │ca-path │ string │ │ UTF-8 encoded path │
548 │ │ │ │ to a directory │
549 │ │ │ │ containing PEM or │
550 │ │ │ │ DER formatted │
551 │ │ │ │ certificates to be │
552 │ │ │ │ added to the │
553 │ │ │ │ verification chain │
554 │ │ │ │ in addition to the │
555 │ │ │ │ certificate │
556 │ │ │ │ specified in the │
557 │ │ │ │ "ca-cert" │
558 │ │ │ │ property. │
559 ├──────────────────────────────────┼──────────────────────┼───────────────┼────────────────────────────────────────────┤
560 │client-cert │ byte array │ │ Contains the │
561 │ │ │ │ client certificate │
562 │ │ │ │ if used by the EAP │
563 │ │ │ │ method specified │
564 │ │ │ │ in the "eap" │
565 │ │ │ │ property. │
566 │ │ │ │ Certificate data │
567 │ │ │ │ is specified using │
568 │ │ │ │ a "scheme"; two │
569 │ │ │ │ are currently │
570 │ │ │ │ supported: blob │
571 │ │ │ │ and path. When │
572 │ │ │ │ using the blob │
573 │ │ │ │ scheme (which is │
574 │ │ │ │ backwards │
575 │ │ │ │ compatible with NM │
576 │ │ │ │ 0.7.x) this │
577 │ │ │ │ property should be │
578 │ │ │ │ set to the │
579 │ │ │ │ certificate's DER │
580 │ │ │ │ encoded data. When │
581 │ │ │ │ using the path │
582 │ │ │ │ scheme, this │
583 │ │ │ │ property should be │
584 │ │ │ │ set to the full │
585 │ │ │ │ UTF-8 encoded path │
586 │ │ │ │ of the │
587 │ │ │ │ certificate, │
588 │ │ │ │ prefixed with the │
589 │ │ │ │ string "file://" │
590 │ │ │ │ and ending with a │
591 │ │ │ │ terminating NUL │
592 │ │ │ │ byte. │
593 ├──────────────────────────────────┼──────────────────────┼───────────────┼────────────────────────────────────────────┤
594 │client-cert-password │ string │ │ The password used │
595 │ │ │ │ to access the │
596 │ │ │ │ client certificate │
597 │ │ │ │ stored in │
598 │ │ │ │ "client-cert" │
599 │ │ │ │ property. Only │
600 │ │ │ │ makes sense if the │
601 │ │ │ │ certificate is │
602 │ │ │ │ stored on a │
603 │ │ │ │ PKCS#11 token that │
604 │ │ │ │ requires a login. │
605 ├──────────────────────────────────┼──────────────────────┼───────────────┼────────────────────────────────────────────┤
606 │client-cert-password-flags │ NMSettingSecretFlags │ │ Flags indicating │
607 │ │ (uint32) │ │ how to handle the │
608 │ │ │ │ "client-cert-password" │
609 │ │ │ │ property. (see the │
610 │ │ │ │ section called │
611 │ │ │ │ “Secret flag │
612 │ │ │ │ types:” for flag │
613 │ │ │ │ values) │
614 ├──────────────────────────────────┼──────────────────────┼───────────────┼────────────────────────────────────────────┤
615 │domain-suffix-match │ string │ │ Constraint for server │
616 │ │ │ │ domain name. If set, │
617 │ │ │ │ this FQDN is used as a │
618 │ │ │ │ suffix match │
619 │ │ │ │ requirement for │
620 │ │ │ │ dNSName element(s) of │
621 │ │ │ │ the certificate │
622 │ │ │ │ presented by the │
623 │ │ │ │ authentication server. │
624 │ │ │ │ If a matching dNSName │
625 │ │ │ │ is found, this │
626 │ │ │ │ constraint is met. If │
627 │ │ │ │ no dNSName values are │
628 │ │ │ │ present, this │
629 │ │ │ │ constraint is matched │
630 │ │ │ │ against SubjectName CN │
631 │ │ │ │ using same suffix │
632 │ │ │ │ match comparison. │
633 ├──────────────────────────────────┼──────────────────────┼───────────────┼────────────────────────────────────────────┤
634 │eap │ array of string │ [] │ The allowed EAP method │
635 │ │ │ │ to be used when │
636 │ │ │ │ authenticating to the │
637 │ │ │ │ network with 802.1x. │
638 │ │ │ │ Valid methods are: │
639 │ │ │ │ "leap", "md5", "tls", │
640 │ │ │ │ "peap", "ttls", "pwd", │
641 │ │ │ │ and "fast". Each │
642 │ │ │ │ method requires │
643 │ │ │ │ different │
644 │ │ │ │ configuration using │
645 │ │ │ │ the properties of this │
646 │ │ │ │ setting; refer to │
647 │ │ │ │ wpa_supplicant │
648 │ │ │ │ documentation for the │
649 │ │ │ │ allowed combinations. │
650 ├──────────────────────────────────┼──────────────────────┼───────────────┼────────────────────────────────────────────┤
651 │identity │ string │ │ Identity string for │
652 │ │ │ │ EAP authentication │
653 │ │ │ │ methods. Often the │
654 │ │ │ │ user's user or login │
655 │ │ │ │ name. │
656 ├──────────────────────────────────┼──────────────────────┼───────────────┼────────────────────────────────────────────┤
657 │name │ string │ 802-1x │ The setting's name, │
658 │ │ │ │ which uniquely │
659 │ │ │ │ identifies the setting │
660 │ │ │ │ within the connection. │
661 │ │ │ │ Each setting type has │
662 │ │ │ │ a name unique to that │
663 │ │ │ │ type, for example │
664 │ │ │ │ "ppp" or "wireless" or │
665 │ │ │ │ "wired". │
666 ├──────────────────────────────────┼──────────────────────┼───────────────┼────────────────────────────────────────────┤
667 │pac-file │ string │ │ UTF-8 encoded file │
668 │ │ │ │ path containing PAC │
669 │ │ │ │ for EAP-FAST. │
670 ├──────────────────────────────────┼──────────────────────┼───────────────┼────────────────────────────────────────────┤
671 │password │ string │ │ UTF-8 encoded password │
672 │ │ │ │ used for EAP │
673 │ │ │ │ authentication │
674 │ │ │ │ methods. If both the │
675 │ │ │ │ "password" property │
676 │ │ │ │ and the "password-raw" │
677 │ │ │ │ property are │
678 │ │ │ │ specified, "password" │
679 │ │ │ │ is preferred. │
680 ├──────────────────────────────────┼──────────────────────┼───────────────┼────────────────────────────────────────────┤
681 │password-flags │ NMSettingSecretFlags │ │ Flags indicating how │
682 │ │ (uint32) │ │ to handle the │
683 │ │ │ │ "password" property. │
684 │ │ │ │ (see the section │
685 │ │ │ │ called “Secret flag │
686 │ │ │ │ types:” for flag │
687 │ │ │ │ values) │
688 ├──────────────────────────────────┼──────────────────────┼───────────────┼────────────────────────────────────────────┤
689 │password-raw │ byte array │ │ Password used for EAP │
690 │ │ │ │ authentication │
691 │ │ │ │ methods, given as a │
692 │ │ │ │ byte array to allow │
693 │ │ │ │ passwords in other │
694 │ │ │ │ encodings than UTF-8 │
695 │ │ │ │ to be used. If both │
696 │ │ │ │ the "password" │
697 │ │ │ │ property and the │
698 │ │ │ │ "password-raw" │
699 │ │ │ │ property are │
700 │ │ │ │ specified, "password" │
701 │ │ │ │ is preferred. │
702 ├──────────────────────────────────┼──────────────────────┼───────────────┼────────────────────────────────────────────┤
703 │password-raw-flags │ NMSettingSecretFlags │ │ Flags indicating how │
704 │ │ (uint32) │ │ to handle the │
705 │ │ │ │ "password-raw" │
706 │ │ │ │ property. (see the │
707 │ │ │ │ section called “Secret │
708 │ │ │ │ flag types:” for flag │
709 │ │ │ │ values) │
710 ├──────────────────────────────────┼──────────────────────┼───────────────┼────────────────────────────────────────────┤
711 │phase1-auth-flags │ uint32 │ 0 │ Specifies │
712 │ │ │ │ authentication flags │
713 │ │ │ │ to use in "phase 1" │
714 │ │ │ │ outer authentication │
715 │ │ │ │ using │
716 │ │ │ │ NMSetting8021xAuthFlags │
717 │ │ │ │ options. The │
718 │ │ │ │ individual TLS │
719 │ │ │ │ versions can be │
720 │ │ │ │ explicitly disabled. │
721 │ │ │ │ If a certain TLS │
722 │ │ │ │ disable flag is not │
723 │ │ │ │ set, it is up to the │
724 │ │ │ │ supplicant to allow or │
725 │ │ │ │ forbid it. The TLS │
726 │ │ │ │ options map to │
727 │ │ │ │ tls_disable_tlsv1_x │
728 │ │ │ │ settings. See the │
729 │ │ │ │ wpa_supplicant │
730 │ │ │ │ documentation for more │
731 │ │ │ │ details. │
732 ├──────────────────────────────────┼──────────────────────┼───────────────┼────────────────────────────────────────────┤
733 │phase1-fast-provisioning │ string │ │ Enables or disables │
734 │ │ │ │ in-line provisioning of │
735 │ │ │ │ EAP-FAST credentials │
736 │ │ │ │ when FAST is specified │
737 │ │ │ │ as the EAP method in │
738 │ │ │ │ the "eap" property. │
739 │ │ │ │ Recognized values are │
740 │ │ │ │ "0" (disabled), "1" │
741 │ │ │ │ (allow unauthenticated │
742 │ │ │ │ provisioning), "2" │
743 │ │ │ │ (allow authenticated │
744 │ │ │ │ provisioning), and "3" │
745 │ │ │ │ (allow both │
746 │ │ │ │ authenticated and │
747 │ │ │ │ unauthenticated │
748 │ │ │ │ provisioning). See the │
749 │ │ │ │ wpa_supplicant │
750 │ │ │ │ documentation for more │
751 │ │ │ │ details. │
752 ├──────────────────────────────────┼──────────────────────┼───────────────┼────────────────────────────────────────────┤
753 │phase1-peaplabel │ string │ │ Forces use of the new │
754 │ │ │ │ PEAP label during key │
755 │ │ │ │ derivation. Some │
756 │ │ │ │ RADIUS servers may │
757 │ │ │ │ require forcing the new │
758 │ │ │ │ PEAP label to │
759 │ │ │ │ interoperate with │
760 │ │ │ │ PEAPv1. Set to "1" to │
761 │ │ │ │ force use of the new │
762 │ │ │ │ PEAP label. See the │
763 │ │ │ │ wpa_supplicant │
764 │ │ │ │ documentation for more │
765 │ │ │ │ details. │
766 ├──────────────────────────────────┼──────────────────────┼───────────────┼────────────────────────────────────────────┤
767 │phase1-peapver │ string │ │ Forces which PEAP │
768 │ │ │ │ version is used when │
769 │ │ │ │ PEAP is set as the EAP │
770 │ │ │ │ method in the "eap" │
771 │ │ │ │ property. When unset, │
772 │ │ │ │ the version reported by │
773 │ │ │ │ the server will be │
774 │ │ │ │ used. Sometimes when │
775 │ │ │ │ using older RADIUS │
776 │ │ │ │ servers, it is │
777 │ │ │ │ necessary to force the │
778 │ │ │ │ client to use a │
779 │ │ │ │ particular PEAP │
780 │ │ │ │ version. To do so, │
781 │ │ │ │ this property may be │
782 │ │ │ │ set to "0" or "1" to │
783 │ │ │ │ force that specific │
784 │ │ │ │ PEAP version. │
785 ├──────────────────────────────────┼──────────────────────┼───────────────┼────────────────────────────────────────────┤
786 │phase2-altsubject-matches │ array of string │ [] │ List of strings to be │
787 │ │ │ │ matched against the │
788 │ │ │ │ altSubjectName of the │
789 │ │ │ │ certificate presented │
790 │ │ │ │ by the authentication │
791 │ │ │ │ server during the inner │
792 │ │ │ │ "phase 2" │
793 │ │ │ │ authentication. If the │
794 │ │ │ │ list is empty, no │
795 │ │ │ │ verification of the │
796 │ │ │ │ server certificate's │
797 │ │ │ │ altSubjectName is │
798 │ │ │ │ performed. │
799 ├──────────────────────────────────┼──────────────────────┼───────────────┼────────────────────────────────────────────┤
800 │phase2-auth │ string │ │ Specifies the allowed │
801 │ │ │ │ "phase 2" inner non-EAP │
802 │ │ │ │ authentication methods │
803 │ │ │ │ when an EAP method that │
804 │ │ │ │ uses an inner TLS │
805 │ │ │ │ tunnel is specified in │
806 │ │ │ │ the "eap" property. │
807 │ │ │ │ Recognized non-EAP │
808 │ │ │ │ "phase 2" methods are │
809 │ │ │ │ "pap", "chap", │
810 │ │ │ │ "mschap", "mschapv2", │
811 │ │ │ │ "gtc", "otp", "md5", │
812 │ │ │ │ and "tls". Each "phase │
813 │ │ │ │ 2" inner method │
814 │ │ │ │ requires specific │
815 │ │ │ │ parameters for │
816 │ │ │ │ successful │
817 │ │ │ │ authentication; see the │
818 │ │ │ │ wpa_supplicant │
819 │ │ │ │ documentation for more │
820 │ │ │ │ details. │
821 ├──────────────────────────────────┼──────────────────────┼───────────────┼────────────────────────────────────────────┤
822 │phase2-autheap │ string │ │ Specifies the allowed │
823 │ │ │ │ "phase 2" inner │
824 │ │ │ │ EAP-based │
825 │ │ │ │ authentication methods │
826 │ │ │ │ when an EAP method that │
827 │ │ │ │ uses an inner TLS │
828 │ │ │ │ tunnel is specified in │
829 │ │ │ │ the "eap" property. │
830 │ │ │ │ Recognized EAP-based │
831 │ │ │ │ "phase 2" methods are │
832 │ │ │ │ "md5", "mschapv2", │
833 │ │ │ │ "otp", "gtc", and │
834 │ │ │ │ "tls". Each "phase 2" │
835 │ │ │ │ inner method requires │
836 │ │ │ │ specific parameters for │
837 │ │ │ │ successful │
838 │ │ │ │ authentication; see the │
839 │ │ │ │ wpa_supplicant │
840 │ │ │ │ documentation for more │
841 │ │ │ │ details. │
842 ├──────────────────────────────────┼──────────────────────┼───────────────┼────────────────────────────────────────────┤
843 │phase2-ca-cert │ byte array │ │ Contains the "phase 2" │
844 │ │ │ │ CA certificate if used │
845 │ │ │ │ by the EAP method │
846 │ │ │ │ specified in the │
847 │ │ │ │ "phase2-auth" or │
848 │ │ │ │ "phase2-autheap" │
849 │ │ │ │ properties. Certificate │
850 │ │ │ │ data is specified using │
851 │ │ │ │ a "scheme"; two are │
852 │ │ │ │ currently supported: │
853 │ │ │ │ blob and path. When │
854 │ │ │ │ using the blob scheme │
855 │ │ │ │ (which is backwards │
856 │ │ │ │ compatible with NM │
857 │ │ │ │ 0.7.x) this property │
858 │ │ │ │ should be set to the │
859 │ │ │ │ certificate's DER │
860 │ │ │ │ encoded data. When │
861 │ │ │ │ using the path scheme, │
862 │ │ │ │ this property should be │
863 │ │ │ │ set to the full UTF-8 │
864 │ │ │ │ encoded path of the │
865 │ │ │ │ certificate, prefixed │
866 │ │ │ │ with the string │
867 │ │ │ │ "file://" and ending │
868 │ │ │ │ with a terminating NUL │
869 │ │ │ │ byte. This property can │
870 │ │ │ │ be unset even if the │
871 │ │ │ │ EAP method supports CA │
872 │ │ │ │ certificates, but this │
873 │ │ │ │ allows │
874 │ │ │ │ man-in-the-middle │
875 │ │ │ │ attacks and is NOT │
876 │ │ │ │ recommended. │
877 ├──────────────────────────────────┼──────────────────────┼───────────────┼────────────────────────────────────────────┤
878 │phase2-ca-cert-password │ string │ │ The password used to │
879 │ │ │ │ access the "phase2" CA │
880 │ │ │ │ certificate stored in │
881 │ │ │ │ "phase2-ca-cert" │
882 │ │ │ │ property. Only makes │
883 │ │ │ │ sense if the │
884 │ │ │ │ certificate is stored │
885 │ │ │ │ on a PKCS#11 token that │
886 │ │ │ │ requires a login. │
887 ├──────────────────────────────────┼──────────────────────┼───────────────┼────────────────────────────────────────────┤
888 │phase2-ca-cert-password-flags │ NMSettingSecretFlags │ │ Flags indicating how to │
889 │ │ (uint32) │ │ handle the │
890 │ │ │ │ "phase2-ca-cert-password" │
891 │ │ │ │ property. (see the │
892 │ │ │ │ section called “Secret │
893 │ │ │ │ flag types:” for flag │
894 │ │ │ │ values) │
895 ├──────────────────────────────────┼──────────────────────┼───────────────┼────────────────────────────────────────────┤
896 │phase2-ca-path │ string │ │ UTF-8 encoded path to a │
897 │ │ │ │ directory containing PEM │
898 │ │ │ │ or DER formatted │
899 │ │ │ │ certificates to be added │
900 │ │ │ │ to the verification chain │
901 │ │ │ │ in addition to the │
902 │ │ │ │ certificate specified in │
903 │ │ │ │ the "phase2-ca-cert" │
904 │ │ │ │ property. │
905 ├──────────────────────────────────┼──────────────────────┼───────────────┼────────────────────────────────────────────┤
906 │phase2-client-cert │ byte array │ │ Contains the "phase 2" │
907 │ │ │ │ client certificate if │
908 │ │ │ │ used by the EAP method │
909 │ │ │ │ specified in the │
910 │ │ │ │ "phase2-auth" or │
911 │ │ │ │ "phase2-autheap" │
912 │ │ │ │ properties. Certificate │
913 │ │ │ │ data is specified using a │
914 │ │ │ │ "scheme"; two are │
915 │ │ │ │ currently supported: blob │
916 │ │ │ │ and path. When using the │
917 │ │ │ │ blob scheme (which is │
918 │ │ │ │ backwards compatible with │
919 │ │ │ │ NM 0.7.x) this property │
920 │ │ │ │ should be set to the │
921 │ │ │ │ certificate's DER encoded │
922 │ │ │ │ data. When using the path │
923 │ │ │ │ scheme, this property │
924 │ │ │ │ should be set to the full │
925 │ │ │ │ UTF-8 encoded path of the │
926 │ │ │ │ certificate, prefixed │
927 │ │ │ │ with the string "file://" │
928 │ │ │ │ and ending with a │
929 │ │ │ │ terminating NUL byte. │
930 │ │ │ │ This property can be │
931 │ │ │ │ unset even if the EAP │
932 │ │ │ │ method supports CA │
933 │ │ │ │ certificates, but this │
934 │ │ │ │ allows man-in-the-middle │
935 │ │ │ │ attacks and is NOT │
936 │ │ │ │ recommended. │
937 ├──────────────────────────────────┼──────────────────────┼───────────────┼────────────────────────────────────────────┤
938 │phase2-client-cert-password │ string │ │ The password used to │
939 │ │ │ │ access the "phase2" │
940 │ │ │ │ client certificate stored │
941 │ │ │ │ in "phase2-client-cert" │
942 │ │ │ │ property. Only makes │
943 │ │ │ │ sense if the certificate │
944 │ │ │ │ is stored on a PKCS#11 │
945 │ │ │ │ token that requires a │
946 │ │ │ │ login. │
947 ├──────────────────────────────────┼──────────────────────┼───────────────┼────────────────────────────────────────────┤
948 │phase2-client-cert-password-flags │ NMSettingSecretFlags │ │ Flags indicating how to │
949 │ │ (uint32) │ │ handle the │
950 │ │ │ │ "phase2-client-cert-password" │
951 │ │ │ │ property. (see the │
952 │ │ │ │ section called “Secret │
953 │ │ │ │ flag types:” for flag │
954 │ │ │ │ values) │
955 ├──────────────────────────────────┼──────────────────────┼───────────────┼────────────────────────────────────────────┤
956 │phase2-domain-suffix-match │ string │ │ Constraint for server domain │
957 │ │ │ │ name. If set, this FQDN is │
958 │ │ │ │ used as a suffix match │
959 │ │ │ │ requirement for dNSName │
960 │ │ │ │ element(s) of the certificate │
961 │ │ │ │ presented by the │
962 │ │ │ │ authentication server during │
963 │ │ │ │ the inner "phase 2" │
964 │ │ │ │ authentication. If a │
965 │ │ │ │ matching dNSName is found, │
966 │ │ │ │ this constraint is met. If │
967 │ │ │ │ no dNSName values are │
968 │ │ │ │ present, this constraint is │
969 │ │ │ │ matched against SubjectName │
970 │ │ │ │ CN using same suffix match │
971 │ │ │ │ comparison. │
972 ├──────────────────────────────────┼──────────────────────┼───────────────┼────────────────────────────────────────────┤
973 │phase2-private-key │ byte array │ │ Contains the "phase 2" inner │
974 │ │ │ │ private key when the │
975 │ │ │ │ "phase2-auth" or │
976 │ │ │ │ "phase2-autheap" property is │
977 │ │ │ │ set to "tls". Key data is │
978 │ │ │ │ specified using a "scheme"; │
979 │ │ │ │ two are currently supported: │
980 │ │ │ │ blob and path. When using the │
981 │ │ │ │ blob scheme and private keys, │
982 │ │ │ │ this property should be set │
983 │ │ │ │ to the key's encrypted PEM │
984 │ │ │ │ encoded data. When using │
985 │ │ │ │ private keys with the path │
986 │ │ │ │ scheme, this property should │
987 │ │ │ │ be set to the full UTF-8 │
988 │ │ │ │ encoded path of the key, │
989 │ │ │ │ prefixed with the string │
990 │ │ │ │ "file://" and ending with a │
991 │ │ │ │ terminating NUL byte. When │
992 │ │ │ │ using PKCS#12 format private │
993 │ │ │ │ keys and the blob scheme, │
994 │ │ │ │ this property should be set │
995 │ │ │ │ to the PKCS#12 data and the │
996 │ │ │ │ "phase2-private-key-password" │
997 │ │ │ │ property must be set to │
998 │ │ │ │ password used to decrypt the │
999 │ │ │ │ PKCS#12 certificate and key. │
1000 │ │ │ │ When using PKCS#12 files and │
1001 │ │ │ │ the path scheme, this │
1002 │ │ │ │ property should be set to the │
1003 │ │ │ │ full UTF-8 encoded path of │
1004 │ │ │ │ the key, prefixed with the │
1005 │ │ │ │ string "file://" and ending │
1006 │ │ │ │ with a terminating NUL byte, │
1007 │ │ │ │ and as with the blob scheme │
1008 │ │ │ │ the │
1009 │ │ │ │ "phase2-private-key-password" │
1010 │ │ │ │ property must be set to the │
1011 │ │ │ │ password used to decode the │
1012 │ │ │ │ PKCS#12 private key and │
1013 │ │ │ │ certificate. │
1014 ├──────────────────────────────────┼──────────────────────┼───────────────┼────────────────────────────────────────────┤
1015 │phase2-private-key-password │ string │ │ The password used to decrypt │
1016 │ │ │ │ the "phase 2" private key │
1017 │ │ │ │ specified in the │
1018 │ │ │ │ "phase2-private-key" property │
1019 │ │ │ │ when the private key either │
1020 │ │ │ │ uses the path scheme, or is a │
1021 │ │ │ │ PKCS#12 format key. │
1022 ├──────────────────────────────────┼──────────────────────┼───────────────┼────────────────────────────────────────────┤
1023 │phase2-private-key-password-flags │ NMSettingSecretFlags │ │ Flags indicating how to │
1024 │ │ (uint32) │ │ handle the │
1025 │ │ │ │ "phase2-private-key-password" │
1026 │ │ │ │ property. (see the section │
1027 │ │ │ │ called “Secret flag types:” │
1028 │ │ │ │ for flag values) │
1029 ├──────────────────────────────────┼──────────────────────┼───────────────┼────────────────────────────────────────────┤
1030 │phase2-subject-match │ string │ │ Substring to be matched │
1031 │ │ │ │ against the subject of the │
1032 │ │ │ │ certificate presented by the │
1033 │ │ │ │ authentication server during │
1034 │ │ │ │ the inner "phase 2" │
1035 │ │ │ │ authentication. When unset, │
1036 │ │ │ │ no verification of the │
1037 │ │ │ │ authentication server │
1038 │ │ │ │ certificate's subject is │
1039 │ │ │ │ performed. This property │
1040 │ │ │ │ provides little security, if │
1041 │ │ │ │ any, and its use is │
1042 │ │ │ │ deprecated in favor of │
1043 │ │ │ │ NMSetting8021x:phase2-domain-suffix-match. │
1044 ├──────────────────────────────────┼──────────────────────┼───────────────┼────────────────────────────────────────────┤
1045 │pin │ string │ │ PIN used for EAP authentication methods. │
1046 ├──────────────────────────────────┼──────────────────────┼───────────────┼────────────────────────────────────────────┤
1047 │pin-flags │ NMSettingSecretFlags │ │ Flags indicating how to handle the "pin" │
1048 │ │ (uint32) │ │ property. (see the section called “Secret │
1049 │ │ │ │ flag types:” for flag values) │
1050 ├──────────────────────────────────┼──────────────────────┼───────────────┼────────────────────────────────────────────┤
1051 │private-key │ byte array │ │ Contains the private key when the "eap" │
1052 │ │ │ │ property is set to "tls". Key data is │
1053 │ │ │ │ specified using a "scheme"; two are │
1054 │ │ │ │ currently supported: blob and path. When │
1055 │ │ │ │ using the blob scheme and private keys, │
1056 │ │ │ │ this property should be set to the key's │
1057 │ │ │ │ encrypted PEM encoded data. When using │
1058 │ │ │ │ private keys with the path scheme, this │
1059 │ │ │ │ property should be set to the full UTF-8 │
1060 │ │ │ │ encoded path of the key, prefixed with the │
1061 │ │ │ │ string "file://" and ending with a │
1062 │ │ │ │ terminating NUL byte. When using PKCS#12 │
1063 │ │ │ │ format private keys and the blob scheme, │
1064 │ │ │ │ this property should be set to the PKCS#12 │
1065 │ │ │ │ data and the "private-key-password" │
1066 │ │ │ │ property must be set to password used to │
1067 │ │ │ │ decrypt the PKCS#12 certificate and key. │
1068 │ │ │ │ When using PKCS#12 files and the path │
1069 │ │ │ │ scheme, this property should be set to the │
1070 │ │ │ │ full UTF-8 encoded path of the key, │
1071 │ │ │ │ prefixed with the string "file://" and │
1072 │ │ │ │ ending with a terminating NUL byte, and as │
1073 │ │ │ │ with the blob scheme the │
1074 │ │ │ │ "private-key-password" property must be │
1075 │ │ │ │ set to the password used to decode the │
1076 │ │ │ │ PKCS#12 private key and certificate. │
1077 │ │ │ │ WARNING: "private-key" is not a "secret" │
1078 │ │ │ │ property, and thus unencrypted private key │
1079 │ │ │ │ data using the BLOB scheme may be readable │
1080 │ │ │ │ by unprivileged users. Private keys │
1081 │ │ │ │ should always be encrypted with a private │
1082 │ │ │ │ key password to prevent unauthorized │
1083 │ │ │ │ access to unencrypted private key data. │
1084 ├──────────────────────────────────┼──────────────────────┼───────────────┼────────────────────────────────────────────┤
1085 │private-key-password │ string │ │ The password used to decrypt the private │
1086 │ │ │ │ key specified in the "private-key" │
1087 │ │ │ │ property when the private key either uses │
1088 │ │ │ │ the path scheme, or if the private key is │
1089 │ │ │ │ a PKCS#12 format key. │
1090 ├──────────────────────────────────┼──────────────────────┼───────────────┼────────────────────────────────────────────┤
1091 │private-key-password-flags │ NMSettingSecretFlags │ │ Flags indicating how to handle the │
1092 │ │ (uint32) │ │ "private-key-password" property. (see the │
1093 │ │ │ │ section called “Secret flag types:” for │
1094 │ │ │ │ flag values) │
1095 ├──────────────────────────────────┼──────────────────────┼───────────────┼────────────────────────────────────────────┤
1096 │subject-match │ string │ │ Substring to be matched against the │
1097 │ │ │ │ subject of the certificate presented by │
1098 │ │ │ │ the authentication server. When unset, no │
1099 │ │ │ │ verification of the authentication server │
1100 │ │ │ │ certificate's subject is performed. This │
1101 │ │ │ │ property provides little security, if any, │
1102 │ │ │ │ and its use is deprecated in favor of │
1103 │ │ │ │ NMSetting8021x:domain-suffix-match. │
1104 ├──────────────────────────────────┼──────────────────────┼───────────────┼────────────────────────────────────────────┤
1105 │system-ca-certs │ boolean │ FALSE │ When TRUE, overrides the "ca-path" and │
1106 │ │ │ │ "phase2-ca-path" properties using the │
1107 │ │ │ │ system CA directory specified at configure │
1108 │ │ │ │ time with the --system-ca-path switch. │
1109 │ │ │ │ The certificates in this directory are │
1110 │ │ │ │ added to the verification chain in │
1111 │ │ │ │ addition to any certificates specified by │
1112 │ │ │ │ the "ca-cert" and "phase2-ca-cert" │
1113 │ │ │ │ properties. If the path provided with │
1114 │ │ │ │ --system-ca-path is rather a file name │
1115 │ │ │ │ (bundle of trusted CA certificates), it │
1116 │ │ │ │ overrides "ca-cert" and "phase2-ca-cert" │
1117 │ │ │ │ properties instead (sets ca_cert/ca_cert2 │
1118 │ │ │ │ options for wpa_supplicant). │
1119 └──────────────────────────────────┴──────────────────────┴───────────────┴────────────────────────────────────────────┘
1120 adsl setting
1122 ADSL Settings.
1123 ┌───────────────┬──────────────────────┬───────────────┬──────────────────┐
1125 │Key Name │ Value Type │ Default Value │ Value │
1126 │ │ │ │ Description │
1127 ├───────────────┼──────────────────────┼───────────────┼──────────────────┤
1128 │encapsulation │ string │ │ Encapsulation of │
1129 │ │ │ │ ADSL connection. │
1130 │ │ │ │ Can be "vcmux" │
1131 │ │ │ │ or "llc". │
1132 ├───────────────┼──────────────────────┼───────────────┼──────────────────┤
1133 │name │ string │ adsl │ The setting's │
1134 │ │ │ │ name, which │
1135 │ │ │ │ uniquely │
1136 │ │ │ │ identifies the │
1137 │ │ │ │ setting within │
1138 │ │ │ │ the connection. │
1139 │ │ │ │ Each setting │
1140 │ │ │ │ type has a name │
1141 │ │ │ │ unique to that │
1142 │ │ │ │ type, for │
1143 │ │ │ │ example "ppp" or │
1144 │ │ │ │ "wireless" or │
1145 │ │ │ │ "wired". │
1146 ├───────────────┼──────────────────────┼───────────────┼──────────────────┤
1147 │password │ string │ │ Password used to │
1148 │ │ │ │ authenticate │
1149 │ │ │ │ with the ADSL │
1150 │ │ │ │ service. │
1151 ├───────────────┼──────────────────────┼───────────────┼──────────────────┤
1152 │password-flags │ NMSettingSecretFlags │ │ Flags indicating │
1153 │ │ (uint32) │ │ how to handle │
1154 │ │ │ │ the "password" │
1155 │ │ │ │ property. (see │
1156 │ │ │ │ the section │
1157 │ │ │ │ called “Secret │
1158 │ │ │ │ flag types:” for │
1159 │ │ │ │ flag values) │
1160 ├───────────────┼──────────────────────┼───────────────┼──────────────────┤
1161 │protocol │ string │ │ ADSL connection │
1162 │ │ │ │ protocol. Can │
1163 │ │ │ │ be "pppoa", │
1164 │ │ │ │ "pppoe" or │
1165 │ │ │ │ "ipoatm". │
1166 ├───────────────┼──────────────────────┼───────────────┼──────────────────┤
1167 │username │ string │ │ Username used to │
1168 │ │ │ │ authenticate │
1169 │ │ │ │ with the ADSL │
1170 │ │ │ │ service. │
1171 ├───────────────┼──────────────────────┼───────────────┼──────────────────┤
1172 │vci │ uint32 │ 0 │ VCI of ADSL │
1173 │ │ │ │ connection │
1174 ├───────────────┼──────────────────────┼───────────────┼──────────────────┤
1175 │vpi │ uint32 │ 0 │ VPI of ADSL │
1176 │ │ │ │ connection │
1177 └───────────────┴──────────────────────┴───────────────┴──────────────────┘
1178 bluetooth setting
1180 Bluetooth Settings.
1181 ┌─────────┬────────────┬───────────────┬──────────────────┐
1183 │Key Name │ Value Type │ Default Value │ Value │
1184 │ │ │ │ Description │
1185 ├─────────┼────────────┼───────────────┼──────────────────┤
1186 │bdaddr │ byte array │ │ The Bluetooth │
1187 │ │ │ │ address of the │
1188 │ │ │ │ device. │
1189 ├─────────┼────────────┼───────────────┼──────────────────┤
1190 │name │ string │ bluetooth │ The setting's │
1191 │ │ │ │ name, which │
1192 │ │ │ │ uniquely │
1193 │ │ │ │ identifies the │
1194 │ │ │ │ setting within │
1195 │ │ │ │ the connection. │
1196 │ │ │ │ Each setting │
1197 │ │ │ │ type has a name │
1198 │ │ │ │ unique to that │
1199 │ │ │ │ type, for │
1200 │ │ │ │ example "ppp" or │
1201 │ │ │ │ "wireless" or │
1202 │ │ │ │ "wired". │
1203 ├─────────┼────────────┼───────────────┼──────────────────┤
1204 │type │ string │ │ Either "dun" for │
1205 │ │ │ │ Dial-Up │
1206 │ │ │ │ Networking │
1207 │ │ │ │ connections or │
1208 │ │ │ │ "panu" for │
1209 │ │ │ │ Personal Area │
1210 │ │ │ │ Networking │
1211 │ │ │ │ connections to │
1212 │ │ │ │ devices │
1213 │ │ │ │ supporting the │
1214 │ │ │ │ NAP profile. │
1215 └─────────┴────────────┴───────────────┴──────────────────┘
1216 bond setting
1218 Bonding Settings.
1219 ┌───────────────┬────────────────┬───────────────┬────────────────────────────┐
1221 │Key Name │ Value Type │ Default Value │ Value │
1222 │ │ │ │ Description │
1223 ├───────────────┼────────────────┼───────────────┼────────────────────────────┤
1224 │interface-name │ string │ │ Deprecated in │
1225 │ │ │ │ favor of │
1226 │ │ │ │ connection.interface-name, │
1227 │ │ │ │ but can be used │
1228 │ │ │ │ for │
1229 │ │ │ │ backward-compatibility │
1230 │ │ │ │ with older │
1231 │ │ │ │ daemons, to set │
1232 │ │ │ │ the bond's │
1233 │ │ │ │ interface name. │
1234 ├───────────────┼────────────────┼───────────────┼────────────────────────────┤
1235 │name │ string │ bond │ The setting's name, which │
1236 │ │ │ │ uniquely identifies the │
1237 │ │ │ │ setting within the │
1238 │ │ │ │ connection. Each setting │
1239 │ │ │ │ type has a name unique to │
1240 │ │ │ │ that type, for example │
1241 │ │ │ │ "ppp" or "wireless" or │
1242 │ │ │ │ "wired". │
1243 ├───────────────┼────────────────┼───────────────┼────────────────────────────┤
1244 │options │ dict of string │ {'mode': │ Dictionary of key/value │
1245 │ │ to string │ 'balance-rr'} │ pairs of bonding options. │
1246 │ │ │ │ Both keys and values must │
1247 │ │ │ │ be strings. Option names │
1248 │ │ │ │ must contain only │
1249 │ │ │ │ alphanumeric characters │
1250 │ │ │ │ (ie, [a-zA-Z0-9]). │
1251 └───────────────┴────────────────┴───────────────┴────────────────────────────┘
1252 bridge setting
1254 Bridging Settings.
1255 ┌───────────────────┬────────────┬───────────────┬───────────────────────────────┐
1257 │Key Name │ Value Type │ Default Value │ Value │
1258 │ │ │ │ Description │
1259 ├───────────────────┼────────────┼───────────────┼───────────────────────────────┤
1260 │ageing-time │ uint32 │ 300 │ The Ethernet MAC │
1261 │ │ │ │ address aging │
1262 │ │ │ │ time, in │
1263 │ │ │ │ seconds. │
1264 ├───────────────────┼────────────┼───────────────┼───────────────────────────────┤
1265 │forward-delay │ uint32 │ 15 │ The Spanning │
1266 │ │ │ │ Tree Protocol │
1267 │ │ │ │ (STP) forwarding │
1268 │ │ │ │ delay, in │
1269 │ │ │ │ seconds. │
1270 ├───────────────────┼────────────┼───────────────┼───────────────────────────────┤
1271 │group-forward-mask │ uint32 │ 0 │ A mask of group │
1272 │ │ │ │ addresses to │
1273 │ │ │ │ forward. │
1274 │ │ │ │ Usually, group │
1275 │ │ │ │ addresses in the │
1276 │ │ │ │ range from │
1277 │ │ │ │ 01:80:C2:00:00:00 │
1278 │ │ │ │ to │
1279 │ │ │ │ 01:80:C2:00:00:0F │
1280 │ │ │ │ are not │
1281 │ │ │ │ forwarded │
1282 │ │ │ │ according to │
1283 │ │ │ │ standards. This │
1284 │ │ │ │ property is a │
1285 │ │ │ │ mask of 16 bits, │
1286 │ │ │ │ each │
1287 │ │ │ │ corresponding to │
1288 │ │ │ │ a group address │
1289 │ │ │ │ in that range │
1290 │ │ │ │ that must be │
1291 │ │ │ │ forwarded. The │
1292 │ │ │ │ mask can't have │
1293 │ │ │ │ bits 0, 1 or 2 │
1294 │ │ │ │ set because they │
1295 │ │ │ │ are used for │
1296 │ │ │ │ STP, MAC pause │
1297 │ │ │ │ frames and LACP. │
1298 ├───────────────────┼────────────┼───────────────┼───────────────────────────────┤
1299 │hello-time │ uint32 │ 2 │ The Spanning Tree │
1300 │ │ │ │ Protocol (STP) │
1301 │ │ │ │ hello time, in │
1302 │ │ │ │ seconds. │
1303 ├───────────────────┼────────────┼───────────────┼───────────────────────────────┤
1304 │interface-name │ string │ │ Deprecated in │
1305 │ │ │ │ favor of │
1306 │ │ │ │ connection.interface-name, │
1307 │ │ │ │ but can be used │
1308 │ │ │ │ for │
1309 │ │ │ │ backward-compatibility │
1310 │ │ │ │ with older │
1311 │ │ │ │ daemons, to set │
1312 │ │ │ │ the bridge's │
1313 │ │ │ │ interface name. │
1314 ├───────────────────┼────────────┼───────────────┼───────────────────────────────┤
1315 │mac-address │ byte array │ │ If specified, the MAC │
1316 │ │ │ │ address of bridge. When │
1317 │ │ │ │ creating a new bridge, │
1318 │ │ │ │ this MAC address will be │
1319 │ │ │ │ set. If this field is left │
1320 │ │ │ │ unspecified, the │
1321 │ │ │ │ "ethernet.cloned-mac-address" │
1322 │ │ │ │ is referred instead to │
1323 │ │ │ │ generate the initial MAC │
1324 │ │ │ │ address. Note that setting │
1325 │ │ │ │ "ethernet.cloned-mac-address" │
1326 │ │ │ │ anyway overwrites the MAC │
1327 │ │ │ │ address of the bridge │
1328 │ │ │ │ later while activating the │
1329 │ │ │ │ bridge. Hence, this │
1330 │ │ │ │ property is deprecated. │
1331 │ │ │ │ Deprecated: 1 │
1332 ├───────────────────┼────────────┼───────────────┼───────────────────────────────┤
1333 │max-age │ uint32 │ 20 │ The Spanning Tree Protocol │
1334 │ │ │ │ (STP) maximum message age, in │
1335 │ │ │ │ seconds. │
1336 ├───────────────────┼────────────┼───────────────┼───────────────────────────────┤
1337 │multicast-snooping │ boolean │ TRUE │ Controls whether IGMP │
1338 │ │ │ │ snooping is enabled for this │
1339 │ │ │ │ bridge. Note that if snooping │
1340 │ │ │ │ was automatically disabled │
1341 │ │ │ │ due to hash collisions, the │
1342 │ │ │ │ system may refuse to enable │
1343 │ │ │ │ the feature until the │
1344 │ │ │ │ collisions are resolved. │
1345 ├───────────────────┼────────────┼───────────────┼───────────────────────────────┤
1346 │name │ string │ bridge │ The setting's name, which │
1347 │ │ │ │ uniquely identifies the │
1348 │ │ │ │ setting within the │
1349 │ │ │ │ connection. Each setting │
1350 │ │ │ │ type has a name unique to │
1351 │ │ │ │ that type, for example "ppp" │
1352 │ │ │ │ or "wireless" or "wired". │
1353 ├───────────────────┼────────────┼───────────────┼───────────────────────────────┤
1354 │priority │ uint32 │ 32768 │ Sets the Spanning Tree │
1355 │ │ │ │ Protocol (STP) priority for │
1356 │ │ │ │ this bridge. Lower values │
1357 │ │ │ │ are "better"; the lowest │
1358 │ │ │ │ priority bridge will be │
1359 │ │ │ │ elected the root bridge. │
1360 ├───────────────────┼────────────┼───────────────┼───────────────────────────────┤
1361 │stp │ boolean │ TRUE │ Controls whether Spanning │
1362 │ │ │ │ Tree Protocol (STP) is │
1363 │ │ │ │ enabled for this bridge. │
1364 └───────────────────┴────────────┴───────────────┴───────────────────────────────┘
1365 bridge-port setting
1367 Bridge Port Settings.
1368 ┌─────────────┬────────────┬───────────────┬──────────────────┐
1370 │Key Name │ Value Type │ Default Value │ Value │
1371 │ │ │ │ Description │
1372 ├─────────────┼────────────┼───────────────┼──────────────────┤
1373 │hairpin-mode │ boolean │ FALSE │ Enables or │
1374 │ │ │ │ disables │
1375 │ │ │ │ "hairpin mode" │
1376 │ │ │ │ for the port, │
1377 │ │ │ │ which allows │
1378 │ │ │ │ frames to be │
1379 │ │ │ │ sent back out │
1380 │ │ │ │ through the port │
1381 │ │ │ │ the frame was │
1382 │ │ │ │ received on. │
1383 ├─────────────┼────────────┼───────────────┼──────────────────┤
1384 │name │ string │ bridge-port │ The setting's │
1385 │ │ │ │ name, which │
1386 │ │ │ │ uniquely │
1387 │ │ │ │ identifies the │
1388 │ │ │ │ setting within │
1389 │ │ │ │ the connection. │
1390 │ │ │ │ Each setting │
1391 │ │ │ │ type has a name │
1392 │ │ │ │ unique to that │
1393 │ │ │ │ type, for │
1394 │ │ │ │ example "ppp" or │
1395 │ │ │ │ "wireless" or │
1396 │ │ │ │ "wired". │
1397 ├─────────────┼────────────┼───────────────┼──────────────────┤
1398 │path-cost │ uint32 │ 100 │ The Spanning │
1399 │ │ │ │ Tree Protocol │
1400 │ │ │ │ (STP) port cost │
1401 │ │ │ │ for destinations │
1402 │ │ │ │ via this port. │
1403 ├─────────────┼────────────┼───────────────┼──────────────────┤
1404 │priority │ uint32 │ 32 │ The Spanning │
1405 │ │ │ │ Tree Protocol │
1406 │ │ │ │ (STP) priority │
1407 │ │ │ │ of this bridge │
1408 │ │ │ │ port. │
1409 └─────────────┴────────────┴───────────────┴──────────────────┘
1410 cdma setting
1412 CDMA-based Mobile Broadband Settings.
1413 ┌───────────────┬──────────────────────┬───────────────┬──────────────────┐
1415 │Key Name │ Value Type │ Default Value │ Value │
1416 │ │ │ │ Description │
1417 ├───────────────┼──────────────────────┼───────────────┼──────────────────┤
1418 │mtu │ uint32 │ 0 │ If non-zero, │
1419 │ │ │ │ only transmit │
1420 │ │ │ │ packets of the │
1421 │ │ │ │ specified size │
1422 │ │ │ │ or smaller, │
1423 │ │ │ │ breaking larger │
1424 │ │ │ │ packets up into │
1425 │ │ │ │ multiple frames. │
1426 ├───────────────┼──────────────────────┼───────────────┼──────────────────┤
1427 │name │ string │ cdma │ The setting's │
1428 │ │ │ │ name, which │
1429 │ │ │ │ uniquely │
1430 │ │ │ │ identifies the │
1431 │ │ │ │ setting within │
1432 │ │ │ │ the connection. │
1433 │ │ │ │ Each setting │
1434 │ │ │ │ type has a name │
1435 │ │ │ │ unique to that │
1436 │ │ │ │ type, for │
1437 │ │ │ │ example "ppp" or │
1438 │ │ │ │ "wireless" or │
1439 │ │ │ │ "wired". │
1440 ├───────────────┼──────────────────────┼───────────────┼──────────────────┤
1441 │number │ string │ │ The number to │
1442 │ │ │ │ dial to │
1443 │ │ │ │ establish the │
1444 │ │ │ │ connection to │
1445 │ │ │ │ the CDMA-based │
1446 │ │ │ │ mobile broadband │
1447 │ │ │ │ network, if any. │
1448 │ │ │ │ If not │
1449 │ │ │ │ specified, the │
1450 │ │ │ │ default number │
1451 │ │ │ │ (#777) is used │
1452 │ │ │ │ when required. │
1453 ├───────────────┼──────────────────────┼───────────────┼──────────────────┤
1454 │password │ string │ │ The password │
1455 │ │ │ │ used to │
1456 │ │ │ │ authenticate │
1457 │ │ │ │ with the │
1458 │ │ │ │ network, if │
1459 │ │ │ │ required. Many │
1460 │ │ │ │ providers do not │
1461 │ │ │ │ require a │
1462 │ │ │ │ password, or │
1463 │ │ │ │ accept any │
1464 │ │ │ │ password. But │
1465 │ │ │ │ if a password is │
1466 │ │ │ │ required, it is │
1467 │ │ │ │ specified here. │
1468 ├───────────────┼──────────────────────┼───────────────┼──────────────────┤
1469 │password-flags │ NMSettingSecretFlags │ │ Flags indicating │
1470 │ │ (uint32) │ │ how to handle │
1471 │ │ │ │ the "password" │
1472 │ │ │ │ property. (see │
1473 │ │ │ │ the section │
1474 │ │ │ │ called “Secret │
1475 │ │ │ │ flag types:” for │
1476 │ │ │ │ flag values) │
1477 ├───────────────┼──────────────────────┼───────────────┼──────────────────┤
1478 │username │ string │ │ The username │
1479 │ │ │ │ used to │
1480 │ │ │ │ authenticate │
1481 │ │ │ │ with the │
1482 │ │ │ │ network, if │
1483 │ │ │ │ required. Many │
1484 │ │ │ │ providers do not │
1485 │ │ │ │ require a │
1486 │ │ │ │ username, or │
1487 │ │ │ │ accept any │
1488 │ │ │ │ username. But │
1489 │ │ │ │ if a username is │
1490 │ │ │ │ required, it is │
1491 │ │ │ │ specified here. │
1492 └───────────────┴──────────────────────┴───────────────┴──────────────────┘
1493 dcb setting
1495 Data Center Bridging Settings.
1496 ┌────────────────────────────┬───────────────────┬─────────────────┬───────────────────────────────┐
1498 │Key Name │ Value Type │ Default Value │ Value │
1499 │ │ │ │ Description │
1500 ├────────────────────────────┼───────────────────┼─────────────────┼───────────────────────────────┤
1501 │app-fcoe-flags │ NMSettingDcbFlags │ │ Specifies the │
1502 │ │ (uint32) │ │ NMSettingDcbFlags │
1503 │ │ │ │ for the DCB FCoE │
1504 │ │ │ │ application. │
1505 │ │ │ │ Flags may be any │
1506 │ │ │ │ combination of │
1507 │ │ │ │ NM_SETTING_DCB_FLAG_ENABLE │
1508 │ │ │ │ (0x1), │
1509 │ │ │ │ NM_SETTING_DCB_FLAG_ADVERTISE │
1510 │ │ │ │ (0x2), and │
1511 │ │ │ │ NM_SETTING_DCB_FLAG_WILLING │
1512 │ │ │ │ (0x4). │
1513 ├────────────────────────────┼───────────────────┼─────────────────┼───────────────────────────────┤
1514 │app-fcoe-mode │ string │ "fabric" │ The FCoE controller mode; │
1515 │ │ │ │ either "fabric" (default) or │
1516 │ │ │ │ "vn2vn". │
1517 ├────────────────────────────┼───────────────────┼─────────────────┼───────────────────────────────┤
1518 │app-fcoe-priority │ int32 │ -1 │ The highest User Priority (0 │
1519 │ │ │ │ - 7) which FCoE frames should │
1520 │ │ │ │ use, or -1 for default │
1521 │ │ │ │ priority. Only used when the │
1522 │ │ │ │ "app-fcoe-flags" property │
1523 │ │ │ │ includes the │
1524 │ │ │ │ NM_SETTING_DCB_FLAG_ENABLE │
1525 │ │ │ │ (0x1) flag. │
1526 ├────────────────────────────┼───────────────────┼─────────────────┼───────────────────────────────┤
1527 │app-fip-flags │ NMSettingDcbFlags │ │ Specifies the │
1528 │ │ (uint32) │ │ NMSettingDcbFlags for the DCB │
1529 │ │ │ │ FIP application. Flags may │
1530 │ │ │ │ be any combination of │
1531 │ │ │ │ NM_SETTING_DCB_FLAG_ENABLE │
1532 │ │ │ │ (0x1), │
1533 │ │ │ │ NM_SETTING_DCB_FLAG_ADVERTISE │
1534 │ │ │ │ (0x2), and │
1535 │ │ │ │ NM_SETTING_DCB_FLAG_WILLING │
1536 │ │ │ │ (0x4). │
1537 ├────────────────────────────┼───────────────────┼─────────────────┼───────────────────────────────┤
1538 │app-fip-priority │ int32 │ -1 │ The highest User Priority (0 │
1539 │ │ │ │ - 7) which FIP frames should │
1540 │ │ │ │ use, or -1 for default │
1541 │ │ │ │ priority. Only used when the │
1542 │ │ │ │ "app-fip-flags" property │
1543 │ │ │ │ includes the │
1544 │ │ │ │ NM_SETTING_DCB_FLAG_ENABLE │
1545 │ │ │ │ (0x1) flag. │
1546 ├────────────────────────────┼───────────────────┼─────────────────┼───────────────────────────────┤
1547 │app-iscsi-flags │ NMSettingDcbFlags │ │ Specifies the │
1548 │ │ (uint32) │ │ NMSettingDcbFlags for the DCB │
1549 │ │ │ │ iSCSI application. Flags may │
1550 │ │ │ │ be any combination of │
1551 │ │ │ │ NM_SETTING_DCB_FLAG_ENABLE │
1552 │ │ │ │ (0x1), │
1553 │ │ │ │ NM_SETTING_DCB_FLAG_ADVERTISE │
1554 │ │ │ │ (0x2), and │
1555 │ │ │ │ NM_SETTING_DCB_FLAG_WILLING │
1556 │ │ │ │ (0x4). │
1557 ├────────────────────────────┼───────────────────┼─────────────────┼───────────────────────────────┤
1558 │app-iscsi-priority │ int32 │ -1 │ The highest User Priority (0 │
1559 │ │ │ │ - 7) which iSCSI frames │
1560 │ │ │ │ should use, or -1 for default │
1561 │ │ │ │ priority. Only used when the │
1562 │ │ │ │ "app-iscsi-flags" property │
1563 │ │ │ │ includes the │
1564 │ │ │ │ NM_SETTING_DCB_FLAG_ENABLE │
1565 │ │ │ │ (0x1) flag. │
1566 ├────────────────────────────┼───────────────────┼─────────────────┼───────────────────────────────┤
1567 │name │ string │ dcb │ The setting's name, which │
1568 │ │ │ │ uniquely identifies the │
1569 │ │ │ │ setting within the │
1570 │ │ │ │ connection. Each setting │
1571 │ │ │ │ type has a name unique to │
1572 │ │ │ │ that type, for example "ppp" │
1573 │ │ │ │ or "wireless" or "wired". │
1574 ├────────────────────────────┼───────────────────┼─────────────────┼───────────────────────────────┤
1575 │priority-bandwidth │ array of uint32 │ [0, 0, 0, 0, 0, │ An array of 8 uint values, │
1576 │ │ │ 0, 0, 0] │ where the array index │
1577 │ │ │ │ corresponds to the User │
1578 │ │ │ │ Priority (0 - 7) and the │
1579 │ │ │ │ value indicates the │
1580 │ │ │ │ percentage of bandwidth of │
1581 │ │ │ │ the priority's assigned group │
1582 │ │ │ │ that the priority may use. │
1583 │ │ │ │ The sum of all percentages │
1584 │ │ │ │ for priorities which belong │
1585 │ │ │ │ to the same group must total │
1586 │ │ │ │ 100 percents. │
1587 ├────────────────────────────┼───────────────────┼─────────────────┼───────────────────────────────┤
1588 │priority-flow-control │ array of uint32 │ [False, False, │ An array of 8 boolean values, │
1589 │ │ │ False, False, │ where the array index │
1590 │ │ │ False, False, │ corresponds to the User │
1591 │ │ │ False, False] │ Priority (0 - 7) and the │
1592 │ │ │ │ value indicates whether or │
1593 │ │ │ │ not the corresponding │
1594 │ │ │ │ priority should transmit │
1595 │ │ │ │ priority pause. │
1596 ├────────────────────────────┼───────────────────┼─────────────────┼───────────────────────────────┤
1597 │priority-flow-control-flags │ NMSettingDcbFlags │ │ Specifies the │
1598 │ │ (uint32) │ │ NMSettingDcbFlags for DCB │
1599 │ │ │ │ Priority Flow Control (PFC). │
1600 │ │ │ │ Flags may be any combination │
1601 │ │ │ │ of NM_SETTING_DCB_FLAG_ENABLE │
1602 │ │ │ │ (0x1), │
1603 │ │ │ │ NM_SETTING_DCB_FLAG_ADVERTISE │
1604 │ │ │ │ (0x2), and │
1605 │ │ │ │ NM_SETTING_DCB_FLAG_WILLING │
1606 │ │ │ │ (0x4). │
1607 ├────────────────────────────┼───────────────────┼─────────────────┼───────────────────────────────┤
1608 │priority-group-bandwidth │ array of uint32 │ [0, 0, 0, 0, 0, │ An array of 8 uint values, │
1609 │ │ │ 0, 0, 0] │ where the array index │
1610 │ │ │ │ corresponds to the Priority │
1611 │ │ │ │ Group ID (0 - 7) and the │
1612 │ │ │ │ value indicates the │
1613 │ │ │ │ percentage of link bandwidth │
1614 │ │ │ │ allocated to that group. │
1615 │ │ │ │ Allowed values are 0 - 100, │
1616 │ │ │ │ and the sum of all values │
1617 │ │ │ │ must total 100 percents. │
1618 ├────────────────────────────┼───────────────────┼─────────────────┼───────────────────────────────┤
1619 │priority-group-flags │ NMSettingDcbFlags │ │ Specifies the │
1620 │ │ (uint32) │ │ NMSettingDcbFlags for DCB │
1621 │ │ │ │ Priority Groups. Flags may │
1622 │ │ │ │ be any combination of │
1623 │ │ │ │ NM_SETTING_DCB_FLAG_ENABLE │
1624 │ │ │ │ (0x1), │
1625 │ │ │ │ NM_SETTING_DCB_FLAG_ADVERTISE │
1626 │ │ │ │ (0x2), and │
1627 │ │ │ │ NM_SETTING_DCB_FLAG_WILLING │
1628 │ │ │ │ (0x4). │
1629 ├────────────────────────────┼───────────────────┼─────────────────┼───────────────────────────────┤
1630 │priority-group-id │ array of uint32 │ [0, 0, 0, 0, 0, │ An array of 8 uint values, │
1631 │ │ │ 0, 0, 0] │ where the array index │
1632 │ │ │ │ corresponds to the User │
1633 │ │ │ │ Priority (0 - 7) and the │
1634 │ │ │ │ value indicates the Priority │
1635 │ │ │ │ Group ID. Allowed Priority │
1636 │ │ │ │ Group ID values are 0 - 7 or │
1637 │ │ │ │ 15 for the unrestricted │
1638 │ │ │ │ group. │
1639 ├────────────────────────────┼───────────────────┼─────────────────┼───────────────────────────────┤
1640 │priority-strict-bandwidth │ array of uint32 │ [False, False, │ An array of 8 boolean values, │
1641 │ │ │ False, False, │ where the array index │
1642 │ │ │ False, False, │ corresponds to the User │
1643 │ │ │ False, False] │ Priority (0 - 7) and the │
1644 │ │ │ │ value indicates whether or │
1645 │ │ │ │ not the priority may use all │
1646 │ │ │ │ of the bandwidth allocated to │
1647 │ │ │ │ its assigned group. │
1648 ├────────────────────────────┼───────────────────┼─────────────────┼───────────────────────────────┤
1649 │priority-traffic-class │ array of uint32 │ [0, 0, 0, 0, 0, │ An array of 8 uint values, │
1650 │ │ │ 0, 0, 0] │ where the array index │
1651 │ │ │ │ corresponds to the User │
1652 │ │ │ │ Priority (0 - 7) and the │
1653 │ │ │ │ value indicates the traffic │
1654 │ │ │ │ class (0 - 7) to which the │
1655 │ │ │ │ priority is mapped. │
1656 └────────────────────────────┴───────────────────┴─────────────────┴───────────────────────────────┘
1657 dummy setting
1659 Dummy Link Settings.
1660 ┌─────────┬────────────┬───────────────┬──────────────────┐
1662 │Key Name │ Value Type │ Default Value │ Value │
1663 │ │ │ │ Description │
1664 ├─────────┼────────────┼───────────────┼──────────────────┤
1665 │name │ string │ dummy │ The setting's │
1666 │ │ │ │ name, which │
1667 │ │ │ │ uniquely │
1668 │ │ │ │ identifies the │
1669 │ │ │ │ setting within │
1670 │ │ │ │ the connection. │
1671 │ │ │ │ Each setting │
1672 │ │ │ │ type has a name │
1673 │ │ │ │ unique to that │
1674 │ │ │ │ type, for │
1675 │ │ │ │ example "ppp" or │
1676 │ │ │ │ "wireless" or │
1677 │ │ │ │ "wired". │
1678 └─────────┴────────────┴───────────────┴──────────────────┘
1679 generic setting
1681 Generic Link Settings.
1682 ┌─────────┬────────────┬───────────────┬──────────────────┐
1684 │Key Name │ Value Type │ Default Value │ Value │
1685 │ │ │ │ Description │
1686 ├─────────┼────────────┼───────────────┼──────────────────┤
1687 │name │ string │ generic │ The setting's │
1688 │ │ │ │ name, which │
1689 │ │ │ │ uniquely │
1690 │ │ │ │ identifies the │
1691 │ │ │ │ setting within │
1692 │ │ │ │ the connection. │
1693 │ │ │ │ Each setting │
1694 │ │ │ │ type has a name │
1695 │ │ │ │ unique to that │
1696 │ │ │ │ type, for │
1697 │ │ │ │ example "ppp" or │
1698 │ │ │ │ "wireless" or │
1699 │ │ │ │ "wired". │
1700 └─────────┴────────────┴───────────────┴──────────────────┘
1701 gsm setting
1703 GSM-based Mobile Broadband Settings.
1704 ┌────────────────┬──────────────────────┬───────────────┬───────────────────┐
1706 │Key Name │ Value Type │ Default Value │ Value │
1707 │ │ │ │ Description │
1708 ├────────────────┼──────────────────────┼───────────────┼───────────────────┤
1709 │apn │ string │ │ The GPRS Access │
1710 │ │ │ │ Point Name │
1711 │ │ │ │ specifying the │
1712 │ │ │ │ APN used when │
1713 │ │ │ │ establishing a │
1714 │ │ │ │ data session │
1715 │ │ │ │ with the │
1716 │ │ │ │ GSM-based │
1717 │ │ │ │ network. The │
1718 │ │ │ │ APN often │
1719 │ │ │ │ determines how │
1720 │ │ │ │ the user will be │
1721 │ │ │ │ billed for their │
1722 │ │ │ │ network usage │
1723 │ │ │ │ and whether the │
1724 │ │ │ │ user has access │
1725 │ │ │ │ to the Internet │
1726 │ │ │ │ or just a │
1727 │ │ │ │ provider-specific │
1728 │ │ │ │ walled-garden, │
1729 │ │ │ │ so it is │
1730 │ │ │ │ important to use │
1731 │ │ │ │ the correct APN │
1732 │ │ │ │ for the user's │
1733 │ │ │ │ mobile broadband │
1734 │ │ │ │ plan. The APN │
1735 │ │ │ │ may only be │
1736 │ │ │ │ composed of the │
1737 │ │ │ │ characters a-z, │
1738 │ │ │ │ 0-9, ., and - │
1739 │ │ │ │ per GSM 03.60 │
1740 │ │ │ │ Section 14.9. │
1741 ├────────────────┼──────────────────────┼───────────────┼───────────────────┤
1742 │device-id │ string │ │ The device unique │
1743 │ │ │ │ identifier (as │
1744 │ │ │ │ given by the WWAN │
1745 │ │ │ │ management │
1746 │ │ │ │ service) which │
1747 │ │ │ │ this connection │
1748 │ │ │ │ applies to. If │
1749 │ │ │ │ given, the │
1750 │ │ │ │ connection will │
1751 │ │ │ │ only apply to the │
1752 │ │ │ │ specified device. │
1753 ├────────────────┼──────────────────────┼───────────────┼───────────────────┤
1754 │home-only │ boolean │ FALSE │ When TRUE, only │
1755 │ │ │ │ connections to │
1756 │ │ │ │ the home network │
1757 │ │ │ │ will be allowed. │
1758 │ │ │ │ Connections to │
1759 │ │ │ │ roaming networks │
1760 │ │ │ │ will not be made. │
1761 ├────────────────┼──────────────────────┼───────────────┼───────────────────┤
1762 │mtu │ uint32 │ 0 │ If non-zero, only │
1763 │ │ │ │ transmit packets │
1764 │ │ │ │ of the specified │
1765 │ │ │ │ size or smaller, │
1766 │ │ │ │ breaking larger │
1767 │ │ │ │ packets up into │
1768 │ │ │ │ multiple frames. │
1769 ├────────────────┼──────────────────────┼───────────────┼───────────────────┤
1770 │name │ string │ gsm │ The setting's │
1771 │ │ │ │ name, which │
1772 │ │ │ │ uniquely │
1773 │ │ │ │ identifies the │
1774 │ │ │ │ setting within │
1775 │ │ │ │ the connection. │
1776 │ │ │ │ Each setting type │
1777 │ │ │ │ has a name unique │
1778 │ │ │ │ to that type, for │
1779 │ │ │ │ example "ppp" or │
1780 │ │ │ │ "wireless" or │
1781 │ │ │ │ "wired". │
1782 ├────────────────┼──────────────────────┼───────────────┼───────────────────┤
1783 │network-id │ string │ │ The Network ID │
1784 │ │ │ │ (GSM LAI format, │
1785 │ │ │ │ ie MCC-MNC) to │
1786 │ │ │ │ force specific │
1787 │ │ │ │ network │
1788 │ │ │ │ registration. If │
1789 │ │ │ │ the Network ID is │
1790 │ │ │ │ specified, │
1791 │ │ │ │ NetworkManager │
1792 │ │ │ │ will attempt to │
1793 │ │ │ │ force the device │
1794 │ │ │ │ to register only │
1795 │ │ │ │ on the specified │
1796 │ │ │ │ network. This can │
1797 │ │ │ │ be used to ensure │
1798 │ │ │ │ that the device │
1799 │ │ │ │ does not roam │
1800 │ │ │ │ when direct │
1801 │ │ │ │ roaming control │
1802 │ │ │ │ of the device is │
1803 │ │ │ │ not otherwise │
1804 │ │ │ │ possible. │
1805 ├────────────────┼──────────────────────┼───────────────┼───────────────────┤
1806 │number │ string │ │ Number to dial │
1807 │ │ │ │ when establishing │
1808 │ │ │ │ a PPP data │
1809 │ │ │ │ session with the │
1810 │ │ │ │ GSM-based mobile │
1811 │ │ │ │ broadband │
1812 │ │ │ │ network. Many │
1813 │ │ │ │ modems do not │
1814 │ │ │ │ require PPP for │
1815 │ │ │ │ connections to │
1816 │ │ │ │ the mobile │
1817 │ │ │ │ network and thus │
1818 │ │ │ │ this property │
1819 │ │ │ │ should be left │
1820 │ │ │ │ blank, which │
1821 │ │ │ │ allows │
1822 │ │ │ │ NetworkManager to │
1823 │ │ │ │ select the │
1824 │ │ │ │ appropriate │
1825 │ │ │ │ settings │
1826 │ │ │ │ automatically. │
1827 ├────────────────┼──────────────────────┼───────────────┼───────────────────┤
1828 │password │ string │ │ The password used │
1829 │ │ │ │ to authenticate │
1830 │ │ │ │ with the network, │
1831 │ │ │ │ if required. │
1832 │ │ │ │ Many providers do │
1833 │ │ │ │ not require a │
1834 │ │ │ │ password, or │
1835 │ │ │ │ accept any │
1836 │ │ │ │ password. But if │
1837 │ │ │ │ a password is │
1838 │ │ │ │ required, it is │
1839 │ │ │ │ specified here. │
1840 ├────────────────┼──────────────────────┼───────────────┼───────────────────┤
1841 │password-flags │ NMSettingSecretFlags │ │ Flags indicating │
1842 │ │ (uint32) │ │ how to handle the │
1843 │ │ │ │ "password" │
1844 │ │ │ │ property. (see │
1845 │ │ │ │ the section │
1846 │ │ │ │ called “Secret │
1847 │ │ │ │ flag types:” for │
1848 │ │ │ │ flag values) │
1849 ├────────────────┼──────────────────────┼───────────────┼───────────────────┤
1850 │pin │ string │ │ If the SIM is │
1851 │ │ │ │ locked with a PIN │
1852 │ │ │ │ it must be │
1853 │ │ │ │ unlocked before │
1854 │ │ │ │ any other │
1855 │ │ │ │ operations are │
1856 │ │ │ │ requested. │
1857 │ │ │ │ Specify the PIN │
1858 │ │ │ │ here to allow │
1859 │ │ │ │ operation of the │
1860 │ │ │ │ device. │
1861 ├────────────────┼──────────────────────┼───────────────┼───────────────────┤
1862 │pin-flags │ NMSettingSecretFlags │ │ Flags indicating │
1863 │ │ (uint32) │ │ how to handle the │
1864 │ │ │ │ "pin" property. │
1865 │ │ │ │ (see the section │
1866 │ │ │ │ called “Secret │
1867 │ │ │ │ flag types:” for │
1868 │ │ │ │ flag values) │
1869 ├────────────────┼──────────────────────┼───────────────┼───────────────────┤
1870 │sim-id │ string │ │ The SIM card │
1871 │ │ │ │ unique identifier │
1872 │ │ │ │ (as given by the │
1873 │ │ │ │ WWAN management │
1874 │ │ │ │ service) which │
1875 │ │ │ │ this connection │
1876 │ │ │ │ applies to. If │
1877 │ │ │ │ given, the │
1878 │ │ │ │ connection will │
1879 │ │ │ │ apply to any │
1880 │ │ │ │ device also │
1881 │ │ │ │ allowed by │
1882 │ │ │ │ "device-id" which │
1883 │ │ │ │ contains a SIM │
1884 │ │ │ │ card matching the │
1885 │ │ │ │ given identifier. │
1886 ├────────────────┼──────────────────────┼───────────────┼───────────────────┤
1887 │sim-operator-id │ string │ │ A MCC/MNC string │
1888 │ │ │ │ like "310260" or │
1889 │ │ │ │ "21601" │
1890 │ │ │ │ identifying the │
1891 │ │ │ │ specific mobile │
1892 │ │ │ │ network operator │
1893 │ │ │ │ which this │
1894 │ │ │ │ connection │
1895 │ │ │ │ applies to. If │
1896 │ │ │ │ given, the │
1897 │ │ │ │ connection will │
1898 │ │ │ │ apply to any │
1899 │ │ │ │ device also │
1900 │ │ │ │ allowed by │
1901 │ │ │ │ "device-id" and │
1902 │ │ │ │ "sim-id" which │
1903 │ │ │ │ contains a SIM │
1904 │ │ │ │ card provisioned │
1905 │ │ │ │ by the given │
1906 │ │ │ │ operator. │
1907 ├────────────────┼──────────────────────┼───────────────┼───────────────────┤
1908 │username │ string │ │ The username used │
1909 │ │ │ │ to authenticate │
1910 │ │ │ │ with the network, │
1911 │ │ │ │ if required. │
1912 │ │ │ │ Many providers do │
1913 │ │ │ │ not require a │
1914 │ │ │ │ username, or │
1915 │ │ │ │ accept any │
1916 │ │ │ │ username. But if │
1917 │ │ │ │ a username is │
1918 │ │ │ │ required, it is │
1919 │ │ │ │ specified here. │
1920 └────────────────┴──────────────────────┴───────────────┴───────────────────┘
1921 infiniband setting
1923 Infiniband Settings.
1924 ┌───────────────┬────────────┬───────────────┬────────────────────┐
1926 │Key Name │ Value Type │ Default Value │ Value │
1927 │ │ │ │ Description │
1928 ├───────────────┼────────────┼───────────────┼────────────────────┤
1929 │mac-address │ byte array │ │ If specified, │
1930 │ │ │ │ this connection │
1931 │ │ │ │ will only apply │
1932 │ │ │ │ to the IPoIB │
1933 │ │ │ │ device whose │
1934 │ │ │ │ permanent MAC │
1935 │ │ │ │ address matches. │
1936 │ │ │ │ This property │
1937 │ │ │ │ does not change │
1938 │ │ │ │ the MAC address │
1939 │ │ │ │ of the device │
1940 │ │ │ │ (i.e. MAC │
1941 │ │ │ │ spoofing). │
1942 ├───────────────┼────────────┼───────────────┼────────────────────┤
1943 │mtu │ uint32 │ 0 │ If non-zero, │
1944 │ │ │ │ only transmit │
1945 │ │ │ │ packets of the │
1946 │ │ │ │ specified size │
1947 │ │ │ │ or smaller, │
1948 │ │ │ │ breaking larger │
1949 │ │ │ │ packets up into │
1950 │ │ │ │ multiple frames. │
1951 ├───────────────┼────────────┼───────────────┼────────────────────┤
1952 │name │ string │ infiniband │ The setting's │
1953 │ │ │ │ name, which │
1954 │ │ │ │ uniquely │
1955 │ │ │ │ identifies the │
1956 │ │ │ │ setting within │
1957 │ │ │ │ the connection. │
1958 │ │ │ │ Each setting │
1959 │ │ │ │ type has a name │
1960 │ │ │ │ unique to that │
1961 │ │ │ │ type, for │
1962 │ │ │ │ example "ppp" or │
1963 │ │ │ │ "wireless" or │
1964 │ │ │ │ "wired". │
1965 ├───────────────┼────────────┼───────────────┼────────────────────┤
1966 │p-key │ int32 │ -1 │ The InfiniBand │
1967 │ │ │ │ P_Key to use for │
1968 │ │ │ │ this device. A │
1969 │ │ │ │ value of -1 │
1970 │ │ │ │ means to use the │
1971 │ │ │ │ default P_Key │
1972 │ │ │ │ (aka "the P_Key │
1973 │ │ │ │ at index 0"). │
1974 │ │ │ │ Otherwise it is │
1975 │ │ │ │ a 16-bit │
1976 │ │ │ │ unsigned │
1977 │ │ │ │ integer, whose │
1978 │ │ │ │ high bit is set │
1979 │ │ │ │ if it is a "full │
1980 │ │ │ │ membership" │
1981 │ │ │ │ P_Key. │
1982 ├───────────────┼────────────┼───────────────┼────────────────────┤
1983 │parent │ string │ │ The interface │
1984 │ │ │ │ name of the │
1985 │ │ │ │ parent device of │
1986 │ │ │ │ this device. │
1987 │ │ │ │ Normally NULL, │
1988 │ │ │ │ but if the │
1989 │ │ │ │ "p_key" property │
1990 │ │ │ │ is set, then you │
1991 │ │ │ │ must specify the │
1992 │ │ │ │ base device by │
1993 │ │ │ │ setting either │
1994 │ │ │ │ this property or │
1995 │ │ │ │ "mac-address". │
1996 ├───────────────┼────────────┼───────────────┼────────────────────┤
1997 │transport-mode │ string │ │ The │
1998 │ │ │ │ IP-over-InfiniBand │
1999 │ │ │ │ transport mode. │
2000 │ │ │ │ Either │
2001 │ │ │ │ "datagram" or │
2002 │ │ │ │ "connected". │
2003 └───────────────┴────────────┴───────────────┴────────────────────┘
2004 ipv4 setting
2006 IPv4 Settings.
2007 ┌───────────────────┬──────────────────┬───────────────┬────────────────────────┐
2009 │Key Name │ Value Type │ Default Value │ Value │
2010 │ │ │ │ Description │
2011 ├───────────────────┼──────────────────┼───────────────┼────────────────────────┤
2012 │address-data │ array of vardict │ │ Array of IPv4 │
2013 │ │ │ │ addresses. Each │
2014 │ │ │ │ address │
2015 │ │ │ │ dictionary │
2016 │ │ │ │ contains at │
2017 │ │ │ │ least 'address' │
2018 │ │ │ │ and 'prefix' │
2019 │ │ │ │ entries, │
2020 │ │ │ │ containing the │
2021 │ │ │ │ IP address as a │
2022 │ │ │ │ string, and the │
2023 │ │ │ │ prefix length as │
2024 │ │ │ │ a uint32. │
2025 │ │ │ │ Additional │
2026 │ │ │ │ attributes may │
2027 │ │ │ │ also exist on │
2028 │ │ │ │ some addresses. │
2029 ├───────────────────┼──────────────────┼───────────────┼────────────────────────┤
2030 │addresses │ array of array │ [] │ Deprecated in │
2031 │ │ of uint32 │ │ favor of the │
2032 │ │ │ │ 'address-data' │
2033 │ │ │ │ and 'gateway' │
2034 │ │ │ │ properties, but │
2035 │ │ │ │ this can be used │
2036 │ │ │ │ for │
2037 │ │ │ │ backward-compatibility │
2038 │ │ │ │ with older │
2039 │ │ │ │ daemons. Note │
2040 │ │ │ │ that if you send │
2041 │ │ │ │ this property │
2042 │ │ │ │ the daemon will │
2043 │ │ │ │ ignore │
2044 │ │ │ │ 'address-data' │
2045 │ │ │ │ and 'gateway'. │
2046 │ │ │ │ Array of IPv4 │
2047 │ │ │ │ address │
2048 │ │ │ │ structures. │
2049 │ │ │ │ Each IPv4 │
2050 │ │ │ │ address │
2051 │ │ │ │ structure is │
2052 │ │ │ │ composed of 3 │
2053 │ │ │ │ 32-bit values; │
2054 │ │ │ │ the first being │
2055 │ │ │ │ the IPv4 address │
2056 │ │ │ │ (network byte │
2057 │ │ │ │ order), the │
2058 │ │ │ │ second the │
2059 │ │ │ │ prefix (1 - 32), │
2060 │ │ │ │ and last the │
2061 │ │ │ │ IPv4 gateway │
2062 │ │ │ │ (network byte │
2063 │ │ │ │ order). The │
2064 │ │ │ │ gateway may be │
2065 │ │ │ │ left as 0 if no │
2066 │ │ │ │ gateway exists │
2067 │ │ │ │ for that subnet. │
2068 ├───────────────────┼──────────────────┼───────────────┼────────────────────────┤
2069 │dad-timeout │ int32 │ -1 │ Timeout in │
2070 │ │ │ │ milliseconds used to │
2071 │ │ │ │ check for the presence │
2072 │ │ │ │ of duplicate IP │
2073 │ │ │ │ addresses on the │
2074 │ │ │ │ network. If an │
2075 │ │ │ │ address conflict is │
2076 │ │ │ │ detected, the │
2077 │ │ │ │ activation will fail. │
2078 │ │ │ │ A zero value means │
2079 │ │ │ │ that no duplicate │
2080 │ │ │ │ address detection is │
2081 │ │ │ │ performed, -1 means │
2082 │ │ │ │ the default value │
2083 │ │ │ │ (either configuration │
2084 │ │ │ │ ipvx.dad-timeout │
2085 │ │ │ │ override or zero). A │
2086 │ │ │ │ value greater than │
2087 │ │ │ │ zero is a timeout in │
2088 │ │ │ │ milliseconds. The │
2089 │ │ │ │ property is currently │
2090 │ │ │ │ implemented only for │
2091 │ │ │ │ IPv4. │
2092 ├───────────────────┼──────────────────┼───────────────┼────────────────────────┤
2093 │dhcp-client-id │ string │ │ A string sent to the │
2094 │ │ │ │ DHCP server to │
2095 │ │ │ │ identify the local │
2096 │ │ │ │ machine which the DHCP │
2097 │ │ │ │ server may use to │
2098 │ │ │ │ customize the DHCP │
2099 │ │ │ │ lease and options. │
2100 │ │ │ │ When the property is a │
2101 │ │ │ │ hex string │
2102 │ │ │ │ ('aa:bb:cc') it is │
2103 │ │ │ │ interpreted as a │
2104 │ │ │ │ binary client ID, in │
2105 │ │ │ │ which case the first │
2106 │ │ │ │ byte is assumed to be │
2107 │ │ │ │ the 'type' field as │
2108 │ │ │ │ per RFC 2132 section │
2109 │ │ │ │ 9.14 and the remaining │
2110 │ │ │ │ bytes may be an │
2111 │ │ │ │ hardware address (e.g. │
2112 │ │ │ │ '01:xx:xx:xx:xx:xx:xx' │
2113 │ │ │ │ where 1 is the │
2114 │ │ │ │ Ethernet ARP type and │
2115 │ │ │ │ the rest is a MAC │
2116 │ │ │ │ address). If the │
2117 │ │ │ │ property is not a hex │
2118 │ │ │ │ string it is │
2119 │ │ │ │ considered as a │
2120 │ │ │ │ non-hardware-address │
2121 │ │ │ │ client ID and the │
2122 │ │ │ │ 'type' field is set to │
2123 │ │ │ │ 0. The special values │
2124 │ │ │ │ "mac" and "perm-mac" │
2125 │ │ │ │ are supported, which │
2126 │ │ │ │ use the current or │
2127 │ │ │ │ permanent MAC address │
2128 │ │ │ │ of the device to │
2129 │ │ │ │ generate a client │
2130 │ │ │ │ identifier with type │
2131 │ │ │ │ ethernet (01). │
2132 │ │ │ │ Currently, these │
2133 │ │ │ │ options only work for │
2134 │ │ │ │ ethernet type of │
2135 │ │ │ │ links. The special │
2136 │ │ │ │ value "stable" is │
2137 │ │ │ │ supported to generate │
2138 │ │ │ │ a type 0 client │
2139 │ │ │ │ identifier based on │
2140 │ │ │ │ the stable-id (see │
2141 │ │ │ │ connection.stable-id) │
2142 │ │ │ │ and a per-host key. If │
2143 │ │ │ │ unset, a globally │
2144 │ │ │ │ configured default is │
2145 │ │ │ │ used. If still unset, │
2146 │ │ │ │ the client-id from the │
2147 │ │ │ │ last lease is reused. │
2148 ├───────────────────┼──────────────────┼───────────────┼────────────────────────┤
2149 │dhcp-fqdn │ string │ │ If the │
2150 │ │ │ │ "dhcp-send-hostname" │
2151 │ │ │ │ property is TRUE, then │
2152 │ │ │ │ the specified FQDN │
2153 │ │ │ │ will be sent to the │
2154 │ │ │ │ DHCP server when │
2155 │ │ │ │ acquiring a lease. │
2156 │ │ │ │ This property and │
2157 │ │ │ │ "dhcp-hostname" are │
2158 │ │ │ │ mutually exclusive and │
2159 │ │ │ │ cannot be set at the │
2160 │ │ │ │ same time. │
2161 ├───────────────────┼──────────────────┼───────────────┼────────────────────────┤
2162 │dhcp-hostname │ string │ │ If the │
2163 │ │ │ │ "dhcp-send-hostname" │
2164 │ │ │ │ property is TRUE, then │
2165 │ │ │ │ the specified name │
2166 │ │ │ │ will be sent to the │
2167 │ │ │ │ DHCP server when │
2168 │ │ │ │ acquiring a lease. │
2169 │ │ │ │ This property and │
2170 │ │ │ │ "dhcp-fqdn" are │
2171 │ │ │ │ mutually exclusive and │
2172 │ │ │ │ cannot be set at the │
2173 │ │ │ │ same time. │
2174 ├───────────────────┼──────────────────┼───────────────┼────────────────────────┤
2175 │dhcp-send-hostname │ boolean │ TRUE │ If TRUE, a hostname is │
2176 │ │ │ │ sent to the DHCP │
2177 │ │ │ │ server when acquiring │
2178 │ │ │ │ a lease. Some DHCP │
2179 │ │ │ │ servers use this │
2180 │ │ │ │ hostname to update DNS │
2181 │ │ │ │ databases, essentially │
2182 │ │ │ │ providing a static │
2183 │ │ │ │ hostname for the │
2184 │ │ │ │ computer. If the │
2185 │ │ │ │ "dhcp-hostname" │
2186 │ │ │ │ property is NULL and │
2187 │ │ │ │ this property is TRUE, │
2188 │ │ │ │ the current persistent │
2189 │ │ │ │ hostname of the │
2190 │ │ │ │ computer is sent. │
2191 ├───────────────────┼──────────────────┼───────────────┼────────────────────────┤
2192 │dhcp-timeout │ int32 │ 0 │ A timeout for a DHCP │
2193 │ │ │ │ transaction in │
2194 │ │ │ │ seconds. │
2195 ├───────────────────┼──────────────────┼───────────────┼────────────────────────┤
2196 │dns │ array of uint32 │ [] │ Array of IP addresses │
2197 │ │ │ │ of DNS servers (as │
2198 │ │ │ │ network-byte-order │
2199 │ │ │ │ integers) │
2200 ├───────────────────┼──────────────────┼───────────────┼────────────────────────┤
2201 │dns-options │ array of string │ [] │ Array of DNS options │
2202 │ │ │ │ as described in man 5 │
2203 │ │ │ │ resolv.conf. NULL │
2204 │ │ │ │ means that the options │
2205 │ │ │ │ are unset and left at │
2206 │ │ │ │ the default. In this │
2207 │ │ │ │ case NetworkManager │
2208 │ │ │ │ will use default │
2209 │ │ │ │ options. This is │
2210 │ │ │ │ distinct from an empty │
2211 │ │ │ │ list of properties. │
2212 ├───────────────────┼──────────────────┼───────────────┼────────────────────────┤
2213 │dns-priority │ int32 │ 0 │ DNS servers priority. │
2214 │ │ │ │ The relative priority │
2215 │ │ │ │ for DNS servers │
2216 │ │ │ │ specified by this │
2217 │ │ │ │ setting. A lower │
2218 │ │ │ │ value is better │
2219 │ │ │ │ (higher priority). │
2220 │ │ │ │ Zero selects the │
2221 │ │ │ │ default value, which │
2222 │ │ │ │ is 50 for VPNs and 100 │
2223 │ │ │ │ for other connections. │
2224 │ │ │ │ Note that the priority │
2225 │ │ │ │ is to order DNS │
2226 │ │ │ │ settings for multiple │
2227 │ │ │ │ active connections. │
2228 │ │ │ │ It does not │
2229 │ │ │ │ disambiguate multiple │
2230 │ │ │ │ DNS servers within the │
2231 │ │ │ │ same connection │
2232 │ │ │ │ profile. When using │
2233 │ │ │ │ dns=default, servers │
2234 │ │ │ │ with higher priority │
2235 │ │ │ │ will be on top of │
2236 │ │ │ │ resolv.conf. To │
2237 │ │ │ │ prioritize a given │
2238 │ │ │ │ server over another │
2239 │ │ │ │ one within the same │
2240 │ │ │ │ connection, just │
2241 │ │ │ │ specify them in the │
2242 │ │ │ │ desired order. When │
2243 │ │ │ │ multiple devices have │
2244 │ │ │ │ configurations with │
2245 │ │ │ │ the same priority, the │
2246 │ │ │ │ one with an active │
2247 │ │ │ │ default route will be │
2248 │ │ │ │ preferred. Negative │
2249 │ │ │ │ values have the │
2250 │ │ │ │ special effect of │
2251 │ │ │ │ excluding other │
2252 │ │ │ │ configurations with a │
2253 │ │ │ │ greater priority │
2254 │ │ │ │ value; so in presence │
2255 │ │ │ │ of at least a negative │
2256 │ │ │ │ priority, only DNS │
2257 │ │ │ │ servers from │
2258 │ │ │ │ connections with the │
2259 │ │ │ │ lowest priority value │
2260 │ │ │ │ will be used. When │
2261 │ │ │ │ using a DNS resolver │
2262 │ │ │ │ that supports │
2263 │ │ │ │ split-DNS as │
2264 │ │ │ │ dns=dnsmasq or │
2265 │ │ │ │ dns=systemd-resolved, │
2266 │ │ │ │ each connection is │
2267 │ │ │ │ used to query domains │
2268 │ │ │ │ in its search list. │
2269 │ │ │ │ Queries for domains │
2270 │ │ │ │ not present in any │
2271 │ │ │ │ search list are routed │
2272 │ │ │ │ through connections │
2273 │ │ │ │ having the '~.' │
2274 │ │ │ │ special wildcard │
2275 │ │ │ │ domain, which is added │
2276 │ │ │ │ automatically to │
2277 │ │ │ │ connections with the │
2278 │ │ │ │ default route (or can │
2279 │ │ │ │ be added manually). │
2280 │ │ │ │ When multiple │
2281 │ │ │ │ connections specify │
2282 │ │ │ │ the same domain, the │
2283 │ │ │ │ one with the highest │
2284 │ │ │ │ priority (lowest │
2285 │ │ │ │ numerical value) wins. │
2286 │ │ │ │ If a connection │
2287 │ │ │ │ specifies a domain │
2288 │ │ │ │ which is subdomain of │
2289 │ │ │ │ another domain with a │
2290 │ │ │ │ negative DNS priority │
2291 │ │ │ │ value, the subdomain │
2292 │ │ │ │ is ignored. │
2293 ├───────────────────┼──────────────────┼───────────────┼────────────────────────┤
2294 │dns-search │ array of string │ [] │ Array of DNS search │
2295 │ │ │ │ domains. Domains │
2296 │ │ │ │ starting with a tilde │
2297 │ │ │ │ ('~') are considered │
2298 │ │ │ │ 'routing' domains and │
2299 │ │ │ │ are used only to │
2300 │ │ │ │ decide the interface │
2301 │ │ │ │ over which a query │
2302 │ │ │ │ must be forwarded; │
2303 │ │ │ │ they are not used to │
2304 │ │ │ │ complete unqualified │
2305 │ │ │ │ host names. │
2306 ├───────────────────┼──────────────────┼───────────────┼────────────────────────┤
2307 │gateway │ string │ │ The gateway associated │
2308 │ │ │ │ with this │
2309 │ │ │ │ configuration. This is │
2310 │ │ │ │ only meaningful if │
2311 │ │ │ │ "addresses" is also │
2312 │ │ │ │ set. │
2313 ├───────────────────┼──────────────────┼───────────────┼────────────────────────┤
2314 │ignore-auto-dns │ boolean │ FALSE │ When "method" is set │
2315 │ │ │ │ to "auto" and this │
2316 │ │ │ │ property to TRUE, │
2317 │ │ │ │ automatically │
2318 │ │ │ │ configured nameservers │
2319 │ │ │ │ and search domains are │
2320 │ │ │ │ ignored and only │
2321 │ │ │ │ nameservers and search │
2322 │ │ │ │ domains specified in │
2323 │ │ │ │ the "dns" and │
2324 │ │ │ │ "dns-search" │
2325 │ │ │ │ properties, if any, │
2326 │ │ │ │ are used. │
2327 ├───────────────────┼──────────────────┼───────────────┼────────────────────────┤
2328 │ignore-auto-routes │ boolean │ FALSE │ When "method" is set │
2329 │ │ │ │ to "auto" and this │
2330 │ │ │ │ property to TRUE, │
2331 │ │ │ │ automatically │
2332 │ │ │ │ configured routes are │
2333 │ │ │ │ ignored and only │
2334 │ │ │ │ routes specified in │
2335 │ │ │ │ the "routes" property, │
2336 │ │ │ │ if any, are used. │
2337 ├───────────────────┼──────────────────┼───────────────┼────────────────────────┤
2338 │may-fail │ boolean │ TRUE │ If TRUE, allow overall │
2339 │ │ │ │ network configuration │
2340 │ │ │ │ to proceed even if the │
2341 │ │ │ │ configuration │
2342 │ │ │ │ specified by this │
2343 │ │ │ │ property times out. │
2344 │ │ │ │ Note that at least one │
2345 │ │ │ │ IP configuration must │
2346 │ │ │ │ succeed or overall │
2347 │ │ │ │ network configuration │
2348 │ │ │ │ will still fail. For │
2349 │ │ │ │ example, in IPv6-only │
2350 │ │ │ │ networks, setting this │
2351 │ │ │ │ property to TRUE on │
2352 │ │ │ │ the NMSettingIP4Config │
2353 │ │ │ │ allows the overall │
2354 │ │ │ │ network configuration │
2355 │ │ │ │ to succeed if IPv4 │
2356 │ │ │ │ configuration fails │
2357 │ │ │ │ but IPv6 configuration │
2358 │ │ │ │ completes │
2359 │ │ │ │ successfully. │
2360 ├───────────────────┼──────────────────┼───────────────┼────────────────────────┤
2361 │method │ string │ │ IP configuration │
2362 │ │ │ │ method. │
2363 │ │ │ │ NMSettingIP4Config and │
2364 │ │ │ │ NMSettingIP6Config │
2365 │ │ │ │ both support "auto", │
2366 │ │ │ │ "manual", and │
2367 │ │ │ │ "link-local". See the │
2368 │ │ │ │ subclass-specific │
2369 │ │ │ │ documentation for │
2370 │ │ │ │ other values. In │
2371 │ │ │ │ general, for the │
2372 │ │ │ │ "auto" method, │
2373 │ │ │ │ properties such as │
2374 │ │ │ │ "dns" and "routes" │
2375 │ │ │ │ specify information │
2376 │ │ │ │ that is added on to │
2377 │ │ │ │ the information │
2378 │ │ │ │ returned from │
2379 │ │ │ │ automatic │
2380 │ │ │ │ configuration. The │
2381 │ │ │ │ "ignore-auto-routes" │
2382 │ │ │ │ and "ignore-auto-dns" │
2383 │ │ │ │ properties modify this │
2384 │ │ │ │ behavior. For methods │
2385 │ │ │ │ that imply no upstream │
2386 │ │ │ │ network, such as │
2387 │ │ │ │ "shared" or │
2388 │ │ │ │ "link-local", these │
2389 │ │ │ │ properties must be │
2390 │ │ │ │ empty. For IPv4 method │
2391 │ │ │ │ "shared", the IP │
2392 │ │ │ │ subnet can be │
2393 │ │ │ │ configured by adding │
2394 │ │ │ │ one manual IPv4 │
2395 │ │ │ │ address or otherwise │
2396 │ │ │ │ 10.42.x.0/24 is │
2397 │ │ │ │ chosen. │
2398 ├───────────────────┼──────────────────┼───────────────┼────────────────────────┤
2399 │name │ string │ ipv4 │ The setting's name, │
2400 │ │ │ │ which uniquely │
2401 │ │ │ │ identifies the setting │
2402 │ │ │ │ within the connection. │
2403 │ │ │ │ Each setting type has │
2404 │ │ │ │ a name unique to that │
2405 │ │ │ │ type, for example │
2406 │ │ │ │ "ppp" or "wireless" or │
2407 │ │ │ │ "wired". │
2408 ├───────────────────┼──────────────────┼───────────────┼────────────────────────┤
2409 │never-default │ boolean │ FALSE │ If TRUE, this │
2410 │ │ │ │ connection will never │
2411 │ │ │ │ be the default │
2412 │ │ │ │ connection for this IP │
2413 │ │ │ │ type, meaning it will │
2414 │ │ │ │ never be assigned the │
2415 │ │ │ │ default route by │
2416 │ │ │ │ NetworkManager. │
2417 ├───────────────────┼──────────────────┼───────────────┼────────────────────────┤
2418 │route-data │ array of vardict │ │ Array of IPv4 routes. │
2419 │ │ │ │ Each route dictionary │
2420 │ │ │ │ contains at least │
2421 │ │ │ │ 'dest' and 'prefix' │
2422 │ │ │ │ entries, containing │
2423 │ │ │ │ the destination IP │
2424 │ │ │ │ address as a string, │
2425 │ │ │ │ and the prefix length │
2426 │ │ │ │ as a uint32. Most │
2427 │ │ │ │ routes will also have │
2428 │ │ │ │ a 'gateway' entry, │
2429 │ │ │ │ containing the gateway │
2430 │ │ │ │ IP address as a │
2431 │ │ │ │ string. If the route │
2432 │ │ │ │ has a 'metric' entry │
2433 │ │ │ │ (containing a uint32), │
2434 │ │ │ │ that will be used as │
2435 │ │ │ │ the metric for the │
2436 │ │ │ │ route (otherwise NM │
2437 │ │ │ │ will pick a default │
2438 │ │ │ │ value appropriate to │
2439 │ │ │ │ the device). │
2440 │ │ │ │ Additional attributes │
2441 │ │ │ │ may also exist on some │
2442 │ │ │ │ routes. │
2443 ├───────────────────┼──────────────────┼───────────────┼────────────────────────┤
2444 │route-metric │ int64 │ -1 │ The default metric for │
2445 │ │ │ │ routes that don't │
2446 │ │ │ │ explicitly specify a │
2447 │ │ │ │ metric. The default │
2448 │ │ │ │ value -1 means that │
2449 │ │ │ │ the metric is chosen │
2450 │ │ │ │ automatically based on │
2451 │ │ │ │ the device type. The │
2452 │ │ │ │ metric applies to │
2453 │ │ │ │ dynamic routes, manual │
2454 │ │ │ │ (static) routes that │
2455 │ │ │ │ don't have an explicit │
2456 │ │ │ │ metric setting, │
2457 │ │ │ │ address prefix routes, │
2458 │ │ │ │ and the default route. │
2459 │ │ │ │ Note that for IPv6, │
2460 │ │ │ │ the kernel accepts │
2461 │ │ │ │ zero (0) but coerces │
2462 │ │ │ │ it to 1024 (user │
2463 │ │ │ │ default). Hence, │
2464 │ │ │ │ setting this property │
2465 │ │ │ │ to zero effectively │
2466 │ │ │ │ mean setting it to │
2467 │ │ │ │ 1024. For IPv4, zero │
2468 │ │ │ │ is a regular value for │
2469 │ │ │ │ the metric. │
2470 ├───────────────────┼──────────────────┼───────────────┼────────────────────────┤
2471 │route-table │ uint32 │ 0 │ Enable policy routing │
2472 │ │ │ │ (source routing) and │
2473 │ │ │ │ set the routing table │
2474 │ │ │ │ used when adding │
2475 │ │ │ │ routes. This affects │
2476 │ │ │ │ all routes, including │
2477 │ │ │ │ device-routes, IPv4LL, │
2478 │ │ │ │ DHCP, SLAAC, │
2479 │ │ │ │ default-routes and │
2480 │ │ │ │ static routes. But │
2481 │ │ │ │ note that static │
2482 │ │ │ │ routes can │
2483 │ │ │ │ individually overwrite │
2484 │ │ │ │ the setting by │
2485 │ │ │ │ explicitly specifying │
2486 │ │ │ │ a non-zero routing │
2487 │ │ │ │ table. If the table │
2488 │ │ │ │ setting is left at │
2489 │ │ │ │ zero, it is eligible │
2490 │ │ │ │ to be overwritten via │
2491 │ │ │ │ global configuration. │
2492 │ │ │ │ If the property is │
2493 │ │ │ │ zero even after │
2494 │ │ │ │ applying the global │
2495 │ │ │ │ configuration value, │
2496 │ │ │ │ policy routing is │
2497 │ │ │ │ disabled for the │
2498 │ │ │ │ address family of this │
2499 │ │ │ │ connection. Policy │
2500 │ │ │ │ routing disabled means │
2501 │ │ │ │ that NetworkManager │
2502 │ │ │ │ will add all routes to │
2503 │ │ │ │ the main table (except │
2504 │ │ │ │ static routes that │
2505 │ │ │ │ explicitly configure a │
2506 │ │ │ │ different table). │
2507 │ │ │ │ Additionally, │
2508 │ │ │ │ NetworkManager will │
2509 │ │ │ │ not delete any │
2510 │ │ │ │ extraneous routes from │
2511 │ │ │ │ tables except the main │
2512 │ │ │ │ table. This is to │
2513 │ │ │ │ preserve backward │
2514 │ │ │ │ compatibility for │
2515 │ │ │ │ users who manage │
2516 │ │ │ │ routing tables outside │
2517 │ │ │ │ of NetworkManager. │
2518 ├───────────────────┼──────────────────┼───────────────┼────────────────────────┤
2519 │routes │ array of array │ [] │ Deprecated in favor of │
2520 │ │ of uint32 │ │ the 'route-data' │
2521 │ │ │ │ property, but this can │
2522 │ │ │ │ be used for │
2523 │ │ │ │ backward-compatibility │
2524 │ │ │ │ with older daemons. │
2525 │ │ │ │ Note that if you send │
2526 │ │ │ │ this property the │
2527 │ │ │ │ daemon will ignore │
2528 │ │ │ │ 'route-data'. Array │
2529 │ │ │ │ of IPv4 route │
2530 │ │ │ │ structures. Each IPv4 │
2531 │ │ │ │ route structure is │
2532 │ │ │ │ composed of 4 32-bit │
2533 │ │ │ │ values; the first │
2534 │ │ │ │ being the destination │
2535 │ │ │ │ IPv4 network or │
2536 │ │ │ │ address (network byte │
2537 │ │ │ │ order), the second the │
2538 │ │ │ │ destination network or │
2539 │ │ │ │ address prefix (1 - │
2540 │ │ │ │ 32), the third being │
2541 │ │ │ │ the next-hop (network │
2542 │ │ │ │ byte order) if any, │
2543 │ │ │ │ and the fourth being │
2544 │ │ │ │ the route metric. If │
2545 │ │ │ │ the metric is 0, NM │
2546 │ │ │ │ will choose an │
2547 │ │ │ │ appropriate default │
2548 │ │ │ │ metric for the device. │
2549 │ │ │ │ (There is no way to │
2550 │ │ │ │ explicitly specify an │
2551 │ │ │ │ actual metric of 0 │
2552 │ │ │ │ with this property.) │
2553 └───────────────────┴──────────────────┴───────────────┴────────────────────────┘
2554 ipv6 setting
2556 IPv6 Settings.
2557 ┌───────────────────┬───────────────────────────┬───────────────┬────────────────────────────────────────────────────┐
2559 │Key Name │ Value Type │ Default Value │ Value │
2560 │ │ │ │ Description │
2561 ├───────────────────┼───────────────────────────┼───────────────┼────────────────────────────────────────────────────┤
2562 │addr-gen-mode │ int32 │ 1 │ Configure method │
2563 │ │ │ │ for creating the │
2564 │ │ │ │ address for use │
2565 │ │ │ │ with RFC4862 │
2566 │ │ │ │ IPv6 Stateless │
2567 │ │ │ │ Address │
2568 │ │ │ │ Autoconfiguration. │
2569 │ │ │ │ The permitted │
2570 │ │ │ │ values are: │
2571 │ │ │ │ NM_SETTING_IP6_CONFIG_ADDR_GEN_MODE_EUI64 │
2572 │ │ │ │ (0) or │
2573 │ │ │ │ NM_SETTING_IP6_CONFIG_ADDR_GEN_MODE_STABLE_PRIVACY │
2574 │ │ │ │ (1). If the │
2575 │ │ │ │ property is set │
2576 │ │ │ │ to EUI64, the │
2577 │ │ │ │ addresses will │
2578 │ │ │ │ be generated │
2579 │ │ │ │ using the │
2580 │ │ │ │ interface tokens │
2581 │ │ │ │ derived from │
2582 │ │ │ │ hardware │
2583 │ │ │ │ address. This │
2584 │ │ │ │ makes the host │
2585 │ │ │ │ part of the │
2586 │ │ │ │ address to stay │
2587 │ │ │ │ constant, making │
2588 │ │ │ │ it possible to │
2589 │ │ │ │ track host's │
2590 │ │ │ │ presence when it │
2591 │ │ │ │ changes │
2592 │ │ │ │ networks. The │
2593 │ │ │ │ address changes │
2594 │ │ │ │ when the │
2595 │ │ │ │ interface │
2596 │ │ │ │ hardware is │
2597 │ │ │ │ replaced. The │
2598 │ │ │ │ value of │
2599 │ │ │ │ stable-privacy │
2600 │ │ │ │ enables use of │
2601 │ │ │ │ cryptographically │
2602 │ │ │ │ secure hash of a │
2603 │ │ │ │ secret │
2604 │ │ │ │ host-specific │
2605 │ │ │ │ key along with │
2606 │ │ │ │ the connection's │
2607 │ │ │ │ stable-id and │
2608 │ │ │ │ the network │
2609 │ │ │ │ address as │
2610 │ │ │ │ specified by │
2611 │ │ │ │ RFC7217. This │
2612 │ │ │ │ makes it │
2613 │ │ │ │ impossible to │
2614 │ │ │ │ use the address │
2615 │ │ │ │ track host's │
2616 │ │ │ │ presence, and │
2617 │ │ │ │ makes the │
2618 │ │ │ │ address stable │
2619 │ │ │ │ when the network │
2620 │ │ │ │ interface │
2621 │ │ │ │ hardware is │
2622 │ │ │ │ replaced. On │
2623 │ │ │ │ D-Bus, the │
2624 │ │ │ │ absence of an │
2625 │ │ │ │ addr-gen-mode │
2626 │ │ │ │ setting equals │
2627 │ │ │ │ enabling │
2628 │ │ │ │ stable-privacy. │
2629 │ │ │ │ For keyfile │
2630 │ │ │ │ plugin, the │
2631 │ │ │ │ absence of the │
2632 │ │ │ │ setting on disk │
2633 │ │ │ │ means EUI64 so │
2634 │ │ │ │ that the │
2635 │ │ │ │ property doesn't │
2636 │ │ │ │ change on │
2637 │ │ │ │ upgrade from │
2638 │ │ │ │ older versions. │
2639 │ │ │ │ Note that this │
2640 │ │ │ │ setting is │
2641 │ │ │ │ distinct from │
2642 │ │ │ │ the Privacy │
2643 │ │ │ │ Extensions as │
2644 │ │ │ │ configured by │
2645 │ │ │ │ "ip6-privacy" │
2646 │ │ │ │ property and it │
2647 │ │ │ │ does not affect │
2648 │ │ │ │ the temporary │
2649 │ │ │ │ addresses │
2650 │ │ │ │ configured with │
2651 │ │ │ │ this option. │
2652 ├───────────────────┼───────────────────────────┼───────────────┼────────────────────────────────────────────────────┤
2653 │address-data │ array of vardict │ │ Array of IPv6 addresses. Each address dictionary │
2654 │ │ │ │ contains at least 'address' and 'prefix' entries, │
2655 │ │ │ │ containing the IP address as a string, and the │
2656 │ │ │ │ prefix length as a uint32. Additional attributes │
2657 │ │ │ │ may also exist on some addresses. │
2658 ├───────────────────┼───────────────────────────┼───────────────┼────────────────────────────────────────────────────┤
2659 │addresses │ array of legacy │ [] │ Deprecated in favor of the 'address-data' and │
2660 │ │ IPv6 address │ │ 'gateway' properties, but this can be used for │
2661 │ │ struct │ │ backward-compatibility with older daemons. Note │
2662 │ │ (a(ayuay)) │ │ that if you send this property the daemon will │
2663 │ │ │ │ ignore 'address-data' and 'gateway'. Array of │
2664 │ │ │ │ IPv6 address structures. Each IPv6 address │
2665 │ │ │ │ structure is composed of an IPv6 address, a prefix │
2666 │ │ │ │ length (1 - 128), and an IPv6 gateway address. The │
2667 │ │ │ │ gateway may be zeroed out if no gateway exists for │
2668 │ │ │ │ that subnet. │
2669 ├───────────────────┼───────────────────────────┼───────────────┼────────────────────────────────────────────────────┤
2670 │dad-timeout │ int32 │ -1 │ Timeout in milliseconds used to check for the │
2671 │ │ │ │ presence of duplicate IP addresses on the network. │
2672 │ │ │ │ If an address conflict is detected, the activation │
2673 │ │ │ │ will fail. A zero value means that no duplicate │
2674 │ │ │ │ address detection is performed, -1 means the │
2675 │ │ │ │ default value (either configuration │
2676 │ │ │ │ ipvx.dad-timeout override or zero). A value │
2677 │ │ │ │ greater than zero is a timeout in milliseconds. │
2678 │ │ │ │ The property is currently implemented only for │
2679 │ │ │ │ IPv4. │
2680 ├───────────────────┼───────────────────────────┼───────────────┼────────────────────────────────────────────────────┤
2681 │dhcp-duid │ string │ │ A string containing the DHCPv6 Unique Identifier │
2682 │ │ │ │ (DUID) used by the dhcp client to identify itself │
2683 │ │ │ │ to DHCPv6 servers (RFC 3315). The DUID is carried │
2684 │ │ │ │ in the Client Identifier option. If the property │
2685 │ │ │ │ is a hex string ('aa:bb:cc') it is interpreted as │
2686 │ │ │ │ a binary DUID and filled as an opaque value in the │
2687 │ │ │ │ Client Identifier option. The special value │
2688 │ │ │ │ "lease" will retrieve the DUID previously used │
2689 │ │ │ │ from the lease file belonging to the connection. │
2690 │ │ │ │ If no DUID is found and "dhclient" is the │
2691 │ │ │ │ configured dhcp client, the DUID is searched in │
2692 │ │ │ │ the system-wide dhclient lease file. If still no │
2693 │ │ │ │ DUID is found, or another dhcp client is used, a │
2694 │ │ │ │ global and permanent DUID-UUID (RFC 6355) will be │
2695 │ │ │ │ generated based on the machine-id. The special │
2696 │ │ │ │ values "llt" and "ll" will generate a DUID of type │
2697 │ │ │ │ LLT or LL (see RFC 3315) based on the current MAC │
2698 │ │ │ │ address of the device. In order to try providing a │
2699 │ │ │ │ stable DUID-LLT, the time field will contain a │
2700 │ │ │ │ constant timestamp that is used globally (for all │
2701 │ │ │ │ profiles) and persisted to disk. The special │
2702 │ │ │ │ values "stable-llt", "stable-ll" and "stable-uuid" │
2703 │ │ │ │ will generate a DUID of the corresponding type, │
2704 │ │ │ │ derived from the connection's stable-id and a │
2705 │ │ │ │ per-host unique key. So, the link-layer address of │
2706 │ │ │ │ "stable-ll" and "stable-llt" will be a generated │
2707 │ │ │ │ address derived from the stable id. The DUID-LLT │
2708 │ │ │ │ time value in the "stable-llt" option will be │
2709 │ │ │ │ picked among a static timespan of three years (the │
2710 │ │ │ │ upper bound of the interval is the same constant │
2711 │ │ │ │ timestamp used in "llt"). When the property is │
2712 │ │ │ │ unset, the global value provided for │
2713 │ │ │ │ "ipv6.dhcp-duid" is used. If no global value is │
2714 │ │ │ │ provided, the default "lease" value is assumed. │
2715 ├───────────────────┼───────────────────────────┼───────────────┼────────────────────────────────────────────────────┤
2716 │dhcp-hostname │ string │ │ If the "dhcp-send-hostname" property is TRUE, then │
2717 │ │ │ │ the specified name will be sent to the DHCP server │
2718 │ │ │ │ when acquiring a lease. This property and │
2719 │ │ │ │ "dhcp-fqdn" are mutually exclusive and cannot be │
2720 │ │ │ │ set at the same time. │
2721 ├───────────────────┼───────────────────────────┼───────────────┼────────────────────────────────────────────────────┤
2722 │dhcp-send-hostname │ boolean │ TRUE │ If TRUE, a hostname is sent to the DHCP server │
2723 │ │ │ │ when acquiring a lease. Some DHCP servers use this │
2724 │ │ │ │ hostname to update DNS databases, essentially │
2725 │ │ │ │ providing a static hostname for the computer. If │
2726 │ │ │ │ the "dhcp-hostname" property is NULL and this │
2727 │ │ │ │ property is TRUE, the current persistent hostname │
2728 │ │ │ │ of the computer is sent. │
2729 ├───────────────────┼───────────────────────────┼───────────────┼────────────────────────────────────────────────────┤
2730 │dhcp-timeout │ int32 │ 0 │ A timeout for a DHCP transaction in seconds. │
2731 ├───────────────────┼───────────────────────────┼───────────────┼────────────────────────────────────────────────────┤
2732 │dns │ array of byte │ [] │ Array of IP addresses of DNS servers (in network │
2733 │ │ array │ │ byte order) │
2734 ├───────────────────┼───────────────────────────┼───────────────┼────────────────────────────────────────────────────┤
2735 │dns-options │ array of string │ [] │ Array of DNS options as described in man 5 │
2736 │ │ │ │ resolv.conf. NULL means that the options are unset │
2737 │ │ │ │ and left at the default. In this case │
2738 │ │ │ │ NetworkManager will use default options. This is │
2739 │ │ │ │ distinct from an empty list of properties. │
2740 ├───────────────────┼───────────────────────────┼───────────────┼────────────────────────────────────────────────────┤
2741 │dns-priority │ int32 │ 0 │ DNS servers priority. The relative priority for │
2742 │ │ │ │ DNS servers specified by this setting. A lower │
2743 │ │ │ │ value is better (higher priority). Zero selects │
2744 │ │ │ │ the default value, which is 50 for VPNs and 100 │
2745 │ │ │ │ for other connections. Note that the priority is │
2746 │ │ │ │ to order DNS settings for multiple active │
2747 │ │ │ │ connections. It does not disambiguate multiple │
2748 │ │ │ │ DNS servers within the same connection profile. │
2749 │ │ │ │ When using dns=default, servers with higher │
2750 │ │ │ │ priority will be on top of resolv.conf. To │
2751 │ │ │ │ prioritize a given server over another one within │
2752 │ │ │ │ the same connection, just specify them in the │
2753 │ │ │ │ desired order. When multiple devices have │
2754 │ │ │ │ configurations with the same priority, the one │
2755 │ │ │ │ with an active default route will be preferred. │
2756 │ │ │ │ Negative values have the special effect of │
2757 │ │ │ │ excluding other configurations with a greater │
2758 │ │ │ │ priority value; so in presence of at least a │
2759 │ │ │ │ negative priority, only DNS servers from │
2760 │ │ │ │ connections with the lowest priority value will be │
2761 │ │ │ │ used. When using a DNS resolver that supports │
2762 │ │ │ │ split-DNS as dns=dnsmasq or dns=systemd-resolved, │
2763 │ │ │ │ each connection is used to query domains in its │
2764 │ │ │ │ search list. Queries for domains not present in │
2765 │ │ │ │ any search list are routed through connections │
2766 │ │ │ │ having the '~.' special wildcard domain, which is │
2767 │ │ │ │ added automatically to connections with the │
2768 │ │ │ │ default route (or can be added manually). When │
2769 │ │ │ │ multiple connections specify the same domain, the │
2770 │ │ │ │ one with the highest priority (lowest numerical │
2771 │ │ │ │ value) wins. If a connection specifies a domain │
2772 │ │ │ │ which is subdomain of another domain with a │
2773 │ │ │ │ negative DNS priority value, the subdomain is │
2774 │ │ │ │ ignored. │
2775 ├───────────────────┼───────────────────────────┼───────────────┼────────────────────────────────────────────────────┤
2776 │dns-search │ array of string │ [] │ Array of DNS search domains. Domains starting with │
2777 │ │ │ │ a tilde ('~') are considered 'routing' domains and │
2778 │ │ │ │ are used only to decide the interface over which a │
2779 │ │ │ │ query must be forwarded; they are not used to │
2780 │ │ │ │ complete unqualified host names. │
2781 ├───────────────────┼───────────────────────────┼───────────────┼────────────────────────────────────────────────────┤
2782 │gateway │ string │ │ The gateway associated with this configuration. │
2783 │ │ │ │ This is only meaningful if "addresses" is also │
2784 │ │ │ │ set. │
2785 ├───────────────────┼───────────────────────────┼───────────────┼────────────────────────────────────────────────────┤
2786 │ignore-auto-dns │ boolean │ FALSE │ When "method" is set to "auto" and this property │
2787 │ │ │ │ to TRUE, automatically configured nameservers and │
2788 │ │ │ │ search domains are ignored and only nameservers │
2789 │ │ │ │ and search domains specified in the "dns" and │
2790 │ │ │ │ "dns-search" properties, if any, are used. │
2791 ├───────────────────┼───────────────────────────┼───────────────┼────────────────────────────────────────────────────┤
2792 │ignore-auto-routes │ boolean │ FALSE │ When "method" is set to "auto" and this property │
2793 │ │ │ │ to TRUE, automatically configured routes are │
2794 │ │ │ │ ignored and only routes specified in the "routes" │
2795 │ │ │ │ property, if any, are used. │
2796 ├───────────────────┼───────────────────────────┼───────────────┼────────────────────────────────────────────────────┤
2797 │ip6-privacy │ NMSettingIP6ConfigPrivacy │ │ Configure IPv6 Privacy Extensions for SLAAC, │
2798 │ │ (int32) │ │ described in RFC4941. If enabled, it makes the │
2799 │ │ │ │ kernel generate a temporary IPv6 address in │
2800 │ │ │ │ addition to the public one generated from MAC │
2801 │ │ │ │ address via modified EUI-64. This enhances │
2802 │ │ │ │ privacy, but could cause problems in some │
2803 │ │ │ │ applications, on the other hand. The permitted │
2804 │ │ │ │ values are: -1: unknown, 0: disabled, 1: enabled │
2805 │ │ │ │ (prefer public address), 2: enabled (prefer │
2806 │ │ │ │ temporary addresses). Having a per-connection │
2807 │ │ │ │ setting set to "-1" (unknown) means fallback to │
2808 │ │ │ │ global configuration "ipv6.ip6-privacy". If also │
2809 │ │ │ │ global configuration is unspecified or set to │
2810 │ │ │ │ "-1", fallback to read │
2811 │ │ │ │ "/proc/sys/net/ipv6/conf/default/use_tempaddr". │
2812 │ │ │ │ Note that this setting is distinct from the Stable │
2813 │ │ │ │ Privacy addresses that can be enabled with the │
2814 │ │ │ │ "addr-gen-mode" property's "stable-privacy" │
2815 │ │ │ │ setting as another way of avoiding host tracking │
2816 │ │ │ │ with IPv6 addresses. │
2817 ├───────────────────┼───────────────────────────┼───────────────┼────────────────────────────────────────────────────┤
2818 │may-fail │ boolean │ TRUE │ If TRUE, allow overall network configuration to │
2819 │ │ │ │ proceed even if the configuration specified by │
2820 │ │ │ │ this property times out. Note that at least one │
2821 │ │ │ │ IP configuration must succeed or overall network │
2822 │ │ │ │ configuration will still fail. For example, in │
2823 │ │ │ │ IPv6-only networks, setting this property to TRUE │
2824 │ │ │ │ on the NMSettingIP4Config allows the overall │
2825 │ │ │ │ network configuration to succeed if IPv4 │
2826 │ │ │ │ configuration fails but IPv6 configuration │
2827 │ │ │ │ completes successfully. │
2828 ├───────────────────┼───────────────────────────┼───────────────┼────────────────────────────────────────────────────┤
2829 │method │ string │ │ IP configuration method. NMSettingIP4Config and │
2830 │ │ │ │ NMSettingIP6Config both support "auto", "manual", │
2831 │ │ │ │ and "link-local". See the subclass-specific │
2832 │ │ │ │ documentation for other values. In general, for │
2833 │ │ │ │ the "auto" method, properties such as "dns" and │
2834 │ │ │ │ "routes" specify information that is added on to │
2835 │ │ │ │ the information returned from automatic │
2836 │ │ │ │ configuration. The "ignore-auto-routes" and │
2837 │ │ │ │ "ignore-auto-dns" properties modify this behavior. │
2838 │ │ │ │ For methods that imply no upstream network, such │
2839 │ │ │ │ as "shared" or "link-local", these properties must │
2840 │ │ │ │ be empty. For IPv4 method "shared", the IP subnet │
2841 │ │ │ │ can be configured by adding one manual IPv4 │
2842 │ │ │ │ address or otherwise 10.42.x.0/24 is chosen. │
2843 ├───────────────────┼───────────────────────────┼───────────────┼────────────────────────────────────────────────────┤
2844 │name │ string │ ipv6 │ The setting's name, which uniquely identifies the │
2845 │ │ │ │ setting within the connection. Each setting type │
2846 │ │ │ │ has a name unique to that type, for example "ppp" │
2847 │ │ │ │ or "wireless" or "wired". │
2848 ├───────────────────┼───────────────────────────┼───────────────┼────────────────────────────────────────────────────┤
2849 │never-default │ boolean │ FALSE │ If TRUE, this connection will never be the default │
2850 │ │ │ │ connection for this IP type, meaning it will never │
2851 │ │ │ │ be assigned the default route by NetworkManager. │
2852 ├───────────────────┼───────────────────────────┼───────────────┼────────────────────────────────────────────────────┤
2853 │route-data │ array of vardict │ │ Array of IPv6 routes. Each route dictionary │
2854 │ │ │ │ contains at least 'dest' and 'prefix' entries, │
2855 │ │ │ │ containing the destination IP address as a string, │
2856 │ │ │ │ and the prefix length as a uint32. Most routes │
2857 │ │ │ │ will also have a 'next-hop' entry, containing the │
2858 │ │ │ │ next hop IP address as a string. If the route has │
2859 │ │ │ │ a 'metric' entry (containing a uint32), that will │
2860 │ │ │ │ be used as the metric for the route (otherwise NM │
2861 │ │ │ │ will pick a default value appropriate to the │
2862 │ │ │ │ device). Additional attributes may also exist on │
2863 │ │ │ │ some routes. │
2864 ├───────────────────┼───────────────────────────┼───────────────┼────────────────────────────────────────────────────┤
2865 │route-metric │ int64 │ -1 │ The default metric for routes that don't │
2866 │ │ │ │ explicitly specify a metric. The default value -1 │
2867 │ │ │ │ means that the metric is chosen automatically │
2868 │ │ │ │ based on the device type. The metric applies to │
2869 │ │ │ │ dynamic routes, manual (static) routes that don't │
2870 │ │ │ │ have an explicit metric setting, address prefix │
2871 │ │ │ │ routes, and the default route. Note that for IPv6, │
2872 │ │ │ │ the kernel accepts zero (0) but coerces it to 1024 │
2873 │ │ │ │ (user default). Hence, setting this property to │
2874 │ │ │ │ zero effectively mean setting it to 1024. For │
2875 │ │ │ │ IPv4, zero is a regular value for the metric. │
2876 ├───────────────────┼───────────────────────────┼───────────────┼────────────────────────────────────────────────────┤
2877 │route-table │ uint32 │ 0 │ Enable policy routing (source routing) and set the │
2878 │ │ │ │ routing table used when adding routes. This │
2879 │ │ │ │ affects all routes, including device-routes, │
2880 │ │ │ │ IPv4LL, DHCP, SLAAC, default-routes and static │
2881 │ │ │ │ routes. But note that static routes can │
2882 │ │ │ │ individually overwrite the setting by explicitly │
2883 │ │ │ │ specifying a non-zero routing table. If the table │
2884 │ │ │ │ setting is left at zero, it is eligible to be │
2885 │ │ │ │ overwritten via global configuration. If the │
2886 │ │ │ │ property is zero even after applying the global │
2887 │ │ │ │ configuration value, policy routing is disabled │
2888 │ │ │ │ for the address family of this connection. Policy │
2889 │ │ │ │ routing disabled means that NetworkManager will │
2890 │ │ │ │ add all routes to the main table (except static │
2891 │ │ │ │ routes that explicitly configure a different │
2892 │ │ │ │ table). Additionally, NetworkManager will not │
2893 │ │ │ │ delete any extraneous routes from tables except │
2894 │ │ │ │ the main table. This is to preserve backward │
2895 │ │ │ │ compatibility for users who manage routing tables │
2896 │ │ │ │ outside of NetworkManager. │
2897 ├───────────────────┼───────────────────────────┼───────────────┼────────────────────────────────────────────────────┤
2898 │routes │ array of legacy IPv6 │ [] │ Deprecated in favor of the 'route-data' property, │
2899 │ │ route struct (a(ayuayu)) │ │ but this can be used for backward-compatibility │
2900 │ │ │ │ with older daemons. Note that if you send this │
2901 │ │ │ │ property the daemon will ignore 'route-data'. │
2902 │ │ │ │ Array of IPv6 route structures. Each IPv6 route │
2903 │ │ │ │ structure is composed of an IPv6 address, a prefix │
2904 │ │ │ │ length (1 - 128), an IPv6 next hop address (which │
2905 │ │ │ │ may be zeroed out if there is no next hop), and a │
2906 │ │ │ │ metric. If the metric is 0, NM will choose an │
2907 │ │ │ │ appropriate default metric for the device. │
2908 ├───────────────────┼───────────────────────────┼───────────────┼────────────────────────────────────────────────────┤
2909 │token │ string │ │ Configure the token for │
2910 │ │ │ │ draft-chown-6man-tokenised-ipv6-identifiers-02 │
2911 │ │ │ │ IPv6 tokenized interface identifiers. Useful with │
2912 │ │ │ │ eui64 addr-gen-mode. │
2913 └───────────────────┴───────────────────────────┴───────────────┴────────────────────────────────────────────────────┘
2914 ip-tunnel setting
2916 IP Tunneling Settings.
2917 ┌────────────────────┬────────────┬───────────────┬──────────────────────────────────────────┐
2919 │Key Name │ Value Type │ Default Value │ Value │
2920 │ │ │ │ Description │
2921 ├────────────────────┼────────────┼───────────────┼──────────────────────────────────────────┤
2922 │encapsulation-limit │ uint32 │ 0 │ How many │
2923 │ │ │ │ additional │
2924 │ │ │ │ levels of │
2925 │ │ │ │ encapsulation │
2926 │ │ │ │ are permitted to │
2927 │ │ │ │ be prepended to │
2928 │ │ │ │ packets. This │
2929 │ │ │ │ property applies │
2930 │ │ │ │ only to IPv6 │
2931 │ │ │ │ tunnels. │
2932 ├────────────────────┼────────────┼───────────────┼──────────────────────────────────────────┤
2933 │flags │ uint32 │ 0 │ Tunnel flags. │
2934 │ │ │ │ Currently the │
2935 │ │ │ │ following values │
2936 │ │ │ │ are supported: │
2937 │ │ │ │ NM_IP_TUNNEL_FLAG_IP6_IGN_ENCAP_LIMIT │
2938 │ │ │ │ (0x1), │
2939 │ │ │ │ NM_IP_TUNNEL_FLAG_IP6_USE_ORIG_TCLASS │
2940 │ │ │ │ (0x2), │
2941 │ │ │ │ NM_IP_TUNNEL_FLAG_IP6_USE_ORIG_FLOWLABEL │
2942 │ │ │ │ (0x4), │
2943 │ │ │ │ NM_IP_TUNNEL_FLAG_IP6_MIP6_DEV │
2944 │ │ │ │ (0x8), │
2945 │ │ │ │ NM_IP_TUNNEL_FLAG_IP6_RCV_DSCP_COPY │
2946 │ │ │ │ (0x10), │
2947 │ │ │ │ NM_IP_TUNNEL_FLAG_IP6_USE_ORIG_FWMARK │
2948 │ │ │ │ (0x20). They are │
2949 │ │ │ │ valid only for │
2950 │ │ │ │ IPv6 tunnels. │
2951 ├────────────────────┼────────────┼───────────────┼──────────────────────────────────────────┤
2952 │flow-label │ uint32 │ 0 │ The flow label to assign to tunnel │
2953 │ │ │ │ packets. This property applies only to │
2954 │ │ │ │ IPv6 tunnels. │
2955 ├────────────────────┼────────────┼───────────────┼──────────────────────────────────────────┤
2956 │input-key │ string │ │ The key used for tunnel input packets; │
2957 │ │ │ │ the property is valid only for certain │
2958 │ │ │ │ tunnel modes (GRE, IP6GRE). If empty, no │
2959 │ │ │ │ key is used. │
2960 ├────────────────────┼────────────┼───────────────┼──────────────────────────────────────────┤
2961 │local │ string │ │ The local endpoint of the tunnel; the │
2962 │ │ │ │ value can be empty, otherwise it must │
2963 │ │ │ │ contain an IPv4 or IPv6 address. │
2964 ├────────────────────┼────────────┼───────────────┼──────────────────────────────────────────┤
2965 │mode │ uint32 │ 0 │ The tunneling mode, for example │
2966 │ │ │ │ NM_IP_TUNNEL_MODE_IPIP (1) or │
2967 │ │ │ │ NM_IP_TUNNEL_MODE_GRE (2). │
2968 ├────────────────────┼────────────┼───────────────┼──────────────────────────────────────────┤
2969 │mtu │ uint32 │ 0 │ If non-zero, only transmit packets of │
2970 │ │ │ │ the specified size or smaller, breaking │
2971 │ │ │ │ larger packets up into multiple │
2972 │ │ │ │ fragments. │
2973 ├────────────────────┼────────────┼───────────────┼──────────────────────────────────────────┤
2974 │name │ string │ ip-tunnel │ The setting's name, which uniquely │
2975 │ │ │ │ identifies the setting within the │
2976 │ │ │ │ connection. Each setting type has a │
2977 │ │ │ │ name unique to that type, for example │
2978 │ │ │ │ "ppp" or "wireless" or "wired". │
2979 ├────────────────────┼────────────┼───────────────┼──────────────────────────────────────────┤
2980 │output-key │ string │ │ The key used for tunnel output packets; │
2981 │ │ │ │ the property is valid only for certain │
2982 │ │ │ │ tunnel modes (GRE, IP6GRE). If empty, no │
2983 │ │ │ │ key is used. │
2984 ├────────────────────┼────────────┼───────────────┼──────────────────────────────────────────┤
2985 │parent │ string │ │ If given, specifies the parent interface │
2986 │ │ │ │ name or parent connection UUID the new │
2987 │ │ │ │ device will be bound to so that tunneled │
2988 │ │ │ │ packets will only be routed via that │
2989 │ │ │ │ interface. │
2990 ├────────────────────┼────────────┼───────────────┼──────────────────────────────────────────┤
2991 │path-mtu-discovery │ boolean │ TRUE │ Whether to enable Path MTU Discovery on │
2992 │ │ │ │ this tunnel. │
2993 ├────────────────────┼────────────┼───────────────┼──────────────────────────────────────────┤
2994 │remote │ string │ │ The remote endpoint of the tunnel; the │
2995 │ │ │ │ value must contain an IPv4 or IPv6 │
2996 │ │ │ │ address. │
2997 ├────────────────────┼────────────┼───────────────┼──────────────────────────────────────────┤
2998 │tos │ uint32 │ 0 │ The type of service (IPv4) or traffic │
2999 │ │ │ │ class (IPv6) field to be set on tunneled │
3000 │ │ │ │ packets. │
3001 ├────────────────────┼────────────┼───────────────┼──────────────────────────────────────────┤
3002 │ttl │ uint32 │ 0 │ The TTL to assign to tunneled packets. 0 │
3003 │ │ │ │ is a special value meaning that packets │
3004 │ │ │ │ inherit the TTL value. │
3005 └────────────────────┴────────────┴───────────────┴──────────────────────────────────────────┘
3006 macsec setting
3008 MACSec Settings.
3009 ┌──────────────┬──────────────────────┬───────────────┬───────────────────────────┐
3011 │Key Name │ Value Type │ Default Value │ Value │
3012 │ │ │ │ Description │
3013 ├──────────────┼──────────────────────┼───────────────┼───────────────────────────┤
3014 │encrypt │ boolean │ TRUE │ Whether the │
3015 │ │ │ │ transmitted │
3016 │ │ │ │ traffic must be │
3017 │ │ │ │ encrypted. │
3018 ├──────────────┼──────────────────────┼───────────────┼───────────────────────────┤
3019 │mka-cak │ string │ │ The pre-shared │
3020 │ │ │ │ CAK │
3021 │ │ │ │ (Connectivity │
3022 │ │ │ │ Association Key) │
3023 │ │ │ │ for MACsec Key │
3024 │ │ │ │ Agreement. │
3025 ├──────────────┼──────────────────────┼───────────────┼───────────────────────────┤
3026 │mka-cak-flags │ NMSettingSecretFlags │ │ Flags indicating │
3027 │ │ (uint32) │ │ how to handle │
3028 │ │ │ │ the "mka-cak" │
3029 │ │ │ │ property. (see │
3030 │ │ │ │ the section │
3031 │ │ │ │ called “Secret │
3032 │ │ │ │ flag types:” for │
3033 │ │ │ │ flag values) │
3034 ├──────────────┼──────────────────────┼───────────────┼───────────────────────────┤
3035 │mka-ckn │ string │ │ The pre-shared │
3036 │ │ │ │ CKN │
3037 │ │ │ │ (Connectivity-association │
3038 │ │ │ │ Key Name) for │
3039 │ │ │ │ MACsec Key │
3040 │ │ │ │ Agreement. │
3041 ├──────────────┼──────────────────────┼───────────────┼───────────────────────────┤
3042 │mode │ int32 │ 0 │ Specifies how the CAK │
3043 │ │ │ │ (Connectivity Association │
3044 │ │ │ │ Key) for MKA (MACsec Key │
3045 │ │ │ │ Agreement) is obtained. │
3046 ├──────────────┼──────────────────────┼───────────────┼───────────────────────────┤
3047 │name │ string │ macsec │ The setting's name, which │
3048 │ │ │ │ uniquely identifies the │
3049 │ │ │ │ setting within the │
3050 │ │ │ │ connection. Each setting │
3051 │ │ │ │ type has a name unique to │
3052 │ │ │ │ that type, for example │
3053 │ │ │ │ "ppp" or "wireless" or │
3054 │ │ │ │ "wired". │
3055 ├──────────────┼──────────────────────┼───────────────┼───────────────────────────┤
3056 │parent │ string │ │ If given, specifies the │
3057 │ │ │ │ parent interface name or │
3058 │ │ │ │ parent connection UUID │
3059 │ │ │ │ from which this MACSEC │
3060 │ │ │ │ interface should be │
3061 │ │ │ │ created. If this │
3062 │ │ │ │ property is not │
3063 │ │ │ │ specified, the connection │
3064 │ │ │ │ must contain an │
3065 │ │ │ │ "802-3-ethernet" setting │
3066 │ │ │ │ with a "mac-address" │
3067 │ │ │ │ property. │
3068 ├──────────────┼──────────────────────┼───────────────┼───────────────────────────┤
3069 │port │ int32 │ 1 │ The port component of the │
3070 │ │ │ │ SCI (Secure Channel │
3071 │ │ │ │ Identifier), between 1 │
3072 │ │ │ │ and 65534. │
3073 ├──────────────┼──────────────────────┼───────────────┼───────────────────────────┤
3074 │send-sci │ boolean │ TRUE │ Specifies whether the SCI │
3075 │ │ │ │ (Secure Channel │
3076 │ │ │ │ Identifier) is included │
3077 │ │ │ │ in every packet. │
3078 ├──────────────┼──────────────────────┼───────────────┼───────────────────────────┤
3079 │validation │ int32 │ 2 │ Specifies the validation │
3080 │ │ │ │ mode for incoming frames. │
3081 └──────────────┴──────────────────────┴───────────────┴───────────────────────────┘
3082 macvlan setting
3084 MAC VLAN Settings.
3085 ┌────────────┬────────────┬───────────────┬──────────────────┐
3087 │Key Name │ Value Type │ Default Value │ Value │
3088 │ │ │ │ Description │
3089 ├────────────┼────────────┼───────────────┼──────────────────┤
3090 │mode │ uint32 │ 0 │ The macvlan │
3091 │ │ │ │ mode, which │
3092 │ │ │ │ specifies the │
3093 │ │ │ │ communication │
3094 │ │ │ │ mechanism │
3095 │ │ │ │ between multiple │
3096 │ │ │ │ macvlans on the │
3097 │ │ │ │ same lower │
3098 │ │ │ │ device. │
3099 ├────────────┼────────────┼───────────────┼──────────────────┤
3100 │name │ string │ macvlan │ The setting's │
3101 │ │ │ │ name, which │
3102 │ │ │ │ uniquely │
3103 │ │ │ │ identifies the │
3104 │ │ │ │ setting within │
3105 │ │ │ │ the connection. │
3106 │ │ │ │ Each setting │
3107 │ │ │ │ type has a name │
3108 │ │ │ │ unique to that │
3109 │ │ │ │ type, for │
3110 │ │ │ │ example "ppp" or │
3111 │ │ │ │ "wireless" or │
3112 │ │ │ │ "wired". │
3113 ├────────────┼────────────┼───────────────┼──────────────────┤
3114 │parent │ string │ │ If given, │
3115 │ │ │ │ specifies the │
3116 │ │ │ │ parent interface │
3117 │ │ │ │ name or parent │
3118 │ │ │ │ connection UUID │
3119 │ │ │ │ from which this │
3120 │ │ │ │ MAC-VLAN │
3121 │ │ │ │ interface should │
3122 │ │ │ │ be created. If │
3123 │ │ │ │ this property is │
3124 │ │ │ │ not specified, │
3125 │ │ │ │ the connection │
3126 │ │ │ │ must contain an │
3127 │ │ │ │ "802-3-ethernet" │
3128 │ │ │ │ setting with a │
3129 │ │ │ │ "mac-address" │
3130 │ │ │ │ property. │
3131 ├────────────┼────────────┼───────────────┼──────────────────┤
3132 │promiscuous │ boolean │ TRUE │ Whether the │
3133 │ │ │ │ interface should │
3134 │ │ │ │ be put in │
3135 │ │ │ │ promiscuous │
3136 │ │ │ │ mode. │
3137 ├────────────┼────────────┼───────────────┼──────────────────┤
3138 │tap │ boolean │ FALSE │ Whether the │
3139 │ │ │ │ interface should │
3140 │ │ │ │ be a MACVTAP. │
3141 └────────────┴────────────┴───────────────┴──────────────────┘
3142 802-11-olpc-mesh setting
3144 OLPC Wireless Mesh Settings.
3145 ┌─────────────────────┬────────────┬──────────────────┬──────────────────┐
3147 │Key Name │ Value Type │ Default Value │ Value │
3148 │ │ │ │ Description │
3149 ├─────────────────────┼────────────┼──────────────────┼──────────────────┤
3150 │channel │ uint32 │ 0 │ Channel on which │
3151 │ │ │ │ the mesh network │
3152 │ │ │ │ to join is │
3153 │ │ │ │ located. │
3154 ├─────────────────────┼────────────┼──────────────────┼──────────────────┤
3155 │dhcp-anycast-address │ byte array │ │ Anycast DHCP MAC │
3156 │ │ │ │ address used │
3157 │ │ │ │ when requesting │
3158 │ │ │ │ an IP address │
3159 │ │ │ │ via DHCP. The │
3160 │ │ │ │ specific anycast │
3161 │ │ │ │ address used │
3162 │ │ │ │ determines which │
3163 │ │ │ │ DHCP server │
3164 │ │ │ │ class answers │
3165 │ │ │ │ the request. │
3166 ├─────────────────────┼────────────┼──────────────────┼──────────────────┤
3167 │name │ string │ 802-11-olpc-mesh │ The setting's │
3168 │ │ │ │ name, which │
3169 │ │ │ │ uniquely │
3170 │ │ │ │ identifies the │
3171 │ │ │ │ setting within │
3172 │ │ │ │ the connection. │
3173 │ │ │ │ Each setting │
3174 │ │ │ │ type has a name │
3175 │ │ │ │ unique to that │
3176 │ │ │ │ type, for │
3177 │ │ │ │ example "ppp" or │
3178 │ │ │ │ "wireless" or │
3179 │ │ │ │ "wired". │
3180 ├─────────────────────┼────────────┼──────────────────┼──────────────────┤
3181 │ssid │ byte array │ │ SSID of the mesh │
3182 │ │ │ │ network to join. │
3183 └─────────────────────┴────────────┴──────────────────┴──────────────────┘
3184 ovs-bridge setting
3186 OvsBridge Link Settings.
3187 ┌──────────────────────┬────────────┬───────────────┬──────────────────┐
3189 │Key Name │ Value Type │ Default Value │ Value │
3190 │ │ │ │ Description │
3191 ├──────────────────────┼────────────┼───────────────┼──────────────────┤
3192 │fail-mode │ string │ │ The bridge │
3193 │ │ │ │ failure mode. │
3194 │ │ │ │ One of "secure", │
3195 │ │ │ │ "standalone" or │
3196 │ │ │ │ empty. │
3197 ├──────────────────────┼────────────┼───────────────┼──────────────────┤
3198 │mcast-snooping-enable │ boolean │ FALSE │ Enable or │
3199 │ │ │ │ disable │
3200 │ │ │ │ multicast │
3201 │ │ │ │ snooping. │
3202 ├──────────────────────┼────────────┼───────────────┼──────────────────┤
3203 │name │ string │ ovs-bridge │ The setting's │
3204 │ │ │ │ name, which │
3205 │ │ │ │ uniquely │
3206 │ │ │ │ identifies the │
3207 │ │ │ │ setting within │
3208 │ │ │ │ the connection. │
3209 │ │ │ │ Each setting │
3210 │ │ │ │ type has a name │
3211 │ │ │ │ unique to that │
3212 │ │ │ │ type, for │
3213 │ │ │ │ example "ppp" or │
3214 │ │ │ │ "wireless" or │
3215 │ │ │ │ "wired". │
3216 ├──────────────────────┼────────────┼───────────────┼──────────────────┤
3217 │rstp-enable │ boolean │ FALSE │ Enable or │
3218 │ │ │ │ disable RSTP. │
3219 ├──────────────────────┼────────────┼───────────────┼──────────────────┤
3220 │stp-enable │ boolean │ FALSE │ Enable or │
3221 │ │ │ │ disable STP. │
3222 └──────────────────────┴────────────┴───────────────┴──────────────────┘
3223 ovs-interface setting
3225 Open vSwitch Interface Settings.
3226 ┌─────────┬────────────┬───────────────┬──────────────────┐
3228 │Key Name │ Value Type │ Default Value │ Value │
3229 │ │ │ │ Description │
3230 ├─────────┼────────────┼───────────────┼──────────────────┤
3231 │name │ string │ ovs-interface │ The setting's │
3232 │ │ │ │ name, which │
3233 │ │ │ │ uniquely │
3234 │ │ │ │ identifies the │
3235 │ │ │ │ setting within │
3236 │ │ │ │ the connection. │
3237 │ │ │ │ Each setting │
3238 │ │ │ │ type has a name │
3239 │ │ │ │ unique to that │
3240 │ │ │ │ type, for │
3241 │ │ │ │ example "ppp" or │
3242 │ │ │ │ "wireless" or │
3243 │ │ │ │ "wired". │
3244 ├─────────┼────────────┼───────────────┼──────────────────┤
3245 │type │ string │ │ The interface │
3246 │ │ │ │ type. Either │
3247 │ │ │ │ "internal", or │
3248 │ │ │ │ empty. │
3249 └─────────┴────────────┴───────────────┴──────────────────┘
3250 ovs-patch setting
3252 OvsPatch Link Settings.
3253 ┌─────────┬────────────┬───────────────┬──────────────────┐
3255 │Key Name │ Value Type │ Default Value │ Value │
3256 │ │ │ │ Description │
3257 ├─────────┼────────────┼───────────────┼──────────────────┤
3258 │name │ string │ ovs-patch │ The setting's │
3259 │ │ │ │ name, which │
3260 │ │ │ │ uniquely │
3261 │ │ │ │ identifies the │
3262 │ │ │ │ setting within │
3263 │ │ │ │ the connection. │
3264 │ │ │ │ Each setting │
3265 │ │ │ │ type has a name │
3266 │ │ │ │ unique to that │
3267 │ │ │ │ type, for │
3268 │ │ │ │ example "ppp" or │
3269 │ │ │ │ "wireless" or │
3270 │ │ │ │ "wired". │
3271 ├─────────┼────────────┼───────────────┼──────────────────┤
3272 │peer │ string │ │ Specifies the │
3273 │ │ │ │ unicast │
3274 │ │ │ │ destination IP │
3275 │ │ │ │ address of a │
3276 │ │ │ │ remote Open │
3277 │ │ │ │ vSwitch bridge │
3278 │ │ │ │ port to connect │
3279 │ │ │ │ to. │
3280 └─────────┴────────────┴───────────────┴──────────────────┘
3281 ovs-port setting
3283 OvsPort Link Settings.
3284 ┌───────────────┬────────────┬───────────────┬────────────────────┐
3286 │Key Name │ Value Type │ Default Value │ Value │
3287 │ │ │ │ Description │
3288 ├───────────────┼────────────┼───────────────┼────────────────────┤
3289 │bond-downdelay │ uint32 │ 0 │ The time port │
3290 │ │ │ │ must be inactive │
3291 │ │ │ │ in order to be │
3292 │ │ │ │ considered down. │
3293 ├───────────────┼────────────┼───────────────┼────────────────────┤
3294 │bond-mode │ string │ │ Bonding mode. │
3295 │ │ │ │ One of │
3296 │ │ │ │ "active-backup", │
3297 │ │ │ │ "balance-slb", │
3298 │ │ │ │ or │
3299 │ │ │ │ "balance-tcp". │
3300 ├───────────────┼────────────┼───────────────┼────────────────────┤
3301 │bond-updelay │ uint32 │ 0 │ The time port │
3302 │ │ │ │ must be active │
3303 │ │ │ │ before it starts │
3304 │ │ │ │ forwarding │
3305 │ │ │ │ traffic. │
3306 ├───────────────┼────────────┼───────────────┼────────────────────┤
3307 │lacp │ string │ │ LACP mode. One │
3308 │ │ │ │ of "active", │
3309 │ │ │ │ "off", or │
3310 │ │ │ │ "passive". │
3311 ├───────────────┼────────────┼───────────────┼────────────────────┤
3312 │name │ string │ ovs-port │ The setting's │
3313 │ │ │ │ name, which │
3314 │ │ │ │ uniquely │
3315 │ │ │ │ identifies the │
3316 │ │ │ │ setting within │
3317 │ │ │ │ the connection. │
3318 │ │ │ │ Each setting │
3319 │ │ │ │ type has a name │
3320 │ │ │ │ unique to that │
3321 │ │ │ │ type, for │
3322 │ │ │ │ example "ppp" or │
3323 │ │ │ │ "wireless" or │
3324 │ │ │ │ "wired". │
3325 ├───────────────┼────────────┼───────────────┼────────────────────┤
3326 │tag │ uint32 │ 0 │ The VLAN tag in │
3327 │ │ │ │ the range │
3328 │ │ │ │ 0-4095. │
3329 ├───────────────┼────────────┼───────────────┼────────────────────┤
3330 │vlan-mode │ string │ │ The VLAN mode. │
3331 │ │ │ │ One of "access", │
3332 │ │ │ │ "native-tagged", │
3333 │ │ │ │ "native-untagged", │
3334 │ │ │ │ "trunk" or │
3335 │ │ │ │ unset. │
3336 └───────────────┴────────────┴───────────────┴────────────────────┘
3337 ppp setting
3339 Point-to-Point Protocol Settings.
3340 ┌──────────────────┬────────────┬───────────────┬─────────────────────┐
3342 │Key Name │ Value Type │ Default Value │ Value │
3343 │ │ │ │ Description │
3344 ├──────────────────┼────────────┼───────────────┼─────────────────────┤
3345 │baud │ uint32 │ 0 │ If non-zero, │
3346 │ │ │ │ instruct pppd to │
3347 │ │ │ │ set the serial │
3348 │ │ │ │ port to the │
3349 │ │ │ │ specified │
3350 │ │ │ │ baudrate. This │
3351 │ │ │ │ value should │
3352 │ │ │ │ normally be left │
3353 │ │ │ │ as 0 to │
3354 │ │ │ │ automatically │
3355 │ │ │ │ choose the │
3356 │ │ │ │ speed. │
3357 ├──────────────────┼────────────┼───────────────┼─────────────────────┤
3358 │crtscts │ boolean │ FALSE │ If TRUE, specify │
3359 │ │ │ │ that pppd should │
3360 │ │ │ │ set the serial │
3361 │ │ │ │ port to use │
3362 │ │ │ │ hardware flow │
3363 │ │ │ │ control with RTS │
3364 │ │ │ │ and CTS signals. │
3365 │ │ │ │ This value │
3366 │ │ │ │ should normally │
3367 │ │ │ │ be set to FALSE. │
3368 ├──────────────────┼────────────┼───────────────┼─────────────────────┤
3369 │lcp-echo-failure │ uint32 │ 0 │ If non-zero, │
3370 │ │ │ │ instruct pppd to │
3371 │ │ │ │ presume the │
3372 │ │ │ │ connection to │
3373 │ │ │ │ the peer has │
3374 │ │ │ │ failed if the │
3375 │ │ │ │ specified number │
3376 │ │ │ │ of LCP │
3377 │ │ │ │ echo-requests go │
3378 │ │ │ │ unanswered by │
3379 │ │ │ │ the peer. The │
3380 │ │ │ │ "lcp-echo-interval" │
3381 │ │ │ │ property must │
3382 │ │ │ │ also be set to a │
3383 │ │ │ │ non-zero value │
3384 │ │ │ │ if this property │
3385 │ │ │ │ is used. │
3386 ├──────────────────┼────────────┼───────────────┼─────────────────────┤
3387 │lcp-echo-interval │ uint32 │ 0 │ If non-zero, │
3388 │ │ │ │ instruct pppd to │
3389 │ │ │ │ send an LCP │
3390 │ │ │ │ echo-request frame │
3391 │ │ │ │ to the peer every n │
3392 │ │ │ │ seconds (where n is │
3393 │ │ │ │ the specified │
3394 │ │ │ │ value). Note that │
3395 │ │ │ │ some PPP peers will │
3396 │ │ │ │ respond to echo │
3397 │ │ │ │ requests and some │
3398 │ │ │ │ will not, and it is │
3399 │ │ │ │ not possible to │
3400 │ │ │ │ autodetect this. │
3401 ├──────────────────┼────────────┼───────────────┼─────────────────────┤
3402 │mppe-stateful │ boolean │ FALSE │ If TRUE, stateful │
3403 │ │ │ │ MPPE is used. See │
3404 │ │ │ │ pppd documentation │
3405 │ │ │ │ for more │
3406 │ │ │ │ information on │
3407 │ │ │ │ stateful MPPE. │
3408 ├──────────────────┼────────────┼───────────────┼─────────────────────┤
3409 │mru │ uint32 │ 0 │ If non-zero, │
3410 │ │ │ │ instruct pppd to │
3411 │ │ │ │ request that the │
3412 │ │ │ │ peer send packets │
3413 │ │ │ │ no larger than the │
3414 │ │ │ │ specified size. If │
3415 │ │ │ │ non-zero, the MRU │
3416 │ │ │ │ should be between │
3417 │ │ │ │ 128 and 16384. │
3418 ├──────────────────┼────────────┼───────────────┼─────────────────────┤
3419 │mtu │ uint32 │ 0 │ If non-zero, │
3420 │ │ │ │ instruct pppd to │
3421 │ │ │ │ send packets no │
3422 │ │ │ │ larger than the │
3423 │ │ │ │ specified size. │
3424 ├──────────────────┼────────────┼───────────────┼─────────────────────┤
3425 │name │ string │ ppp │ The setting's name, │
3426 │ │ │ │ which uniquely │
3427 │ │ │ │ identifies the │
3428 │ │ │ │ setting within the │
3429 │ │ │ │ connection. Each │
3430 │ │ │ │ setting type has a │
3431 │ │ │ │ name unique to that │
3432 │ │ │ │ type, for example │
3433 │ │ │ │ "ppp" or "wireless" │
3434 │ │ │ │ or "wired". │
3435 ├──────────────────┼────────────┼───────────────┼─────────────────────┤
3436 │no-vj-comp │ boolean │ FALSE │ If TRUE, Van │
3437 │ │ │ │ Jacobsen TCP header │
3438 │ │ │ │ compression will │
3439 │ │ │ │ not be requested. │
3440 ├──────────────────┼────────────┼───────────────┼─────────────────────┤
3441 │noauth │ boolean │ TRUE │ If TRUE, do not │
3442 │ │ │ │ require the other │
3443 │ │ │ │ side (usually the │
3444 │ │ │ │ PPP server) to │
3445 │ │ │ │ authenticate itself │
3446 │ │ │ │ to the client. If │
3447 │ │ │ │ FALSE, require │
3448 │ │ │ │ authentication from │
3449 │ │ │ │ the remote side. │
3450 │ │ │ │ In almost all │
3451 │ │ │ │ cases, this should │
3452 │ │ │ │ be TRUE. │
3453 ├──────────────────┼────────────┼───────────────┼─────────────────────┤
3454 │nobsdcomp │ boolean │ FALSE │ If TRUE, BSD │
3455 │ │ │ │ compression will │
3456 │ │ │ │ not be requested. │
3457 ├──────────────────┼────────────┼───────────────┼─────────────────────┤
3458 │nodeflate │ boolean │ FALSE │ If TRUE, "deflate" │
3459 │ │ │ │ compression will │
3460 │ │ │ │ not be requested. │
3461 ├──────────────────┼────────────┼───────────────┼─────────────────────┤
3462 │refuse-chap │ boolean │ FALSE │ If TRUE, the CHAP │
3463 │ │ │ │ authentication │
3464 │ │ │ │ method will not be │
3465 │ │ │ │ used. │
3466 ├──────────────────┼────────────┼───────────────┼─────────────────────┤
3467 │refuse-eap │ boolean │ FALSE │ If TRUE, the EAP │
3468 │ │ │ │ authentication │
3469 │ │ │ │ method will not be │
3470 │ │ │ │ used. │
3471 ├──────────────────┼────────────┼───────────────┼─────────────────────┤
3472 │refuse-mschap │ boolean │ FALSE │ If TRUE, the MSCHAP │
3473 │ │ │ │ authentication │
3474 │ │ │ │ method will not be │
3475 │ │ │ │ used. │
3476 ├──────────────────┼────────────┼───────────────┼─────────────────────┤
3477 │refuse-mschapv2 │ boolean │ FALSE │ If TRUE, the │
3478 │ │ │ │ MSCHAPv2 │
3479 │ │ │ │ authentication │
3480 │ │ │ │ method will not be │
3481 │ │ │ │ used. │
3482 ├──────────────────┼────────────┼───────────────┼─────────────────────┤
3483 │refuse-pap │ boolean │ FALSE │ If TRUE, the PAP │
3484 │ │ │ │ authentication │
3485 │ │ │ │ method will not be │
3486 │ │ │ │ used. │
3487 ├──────────────────┼────────────┼───────────────┼─────────────────────┤
3488 │require-mppe │ boolean │ FALSE │ If TRUE, MPPE │
3489 │ │ │ │ (Microsoft │
3490 │ │ │ │ Point-to-Point │
3491 │ │ │ │ Encryption) will be │
3492 │ │ │ │ required for the │
3493 │ │ │ │ PPP session. If │
3494 │ │ │ │ either 64-bit or │
3495 │ │ │ │ 128-bit MPPE is not │
3496 │ │ │ │ available the │
3497 │ │ │ │ session will fail. │
3498 │ │ │ │ Note that MPPE is │
3499 │ │ │ │ not used on mobile │
3500 │ │ │ │ broadband │
3501 │ │ │ │ connections. │
3502 ├──────────────────┼────────────┼───────────────┼─────────────────────┤
3503 │require-mppe-128 │ boolean │ FALSE │ If TRUE, 128-bit │
3504 │ │ │ │ MPPE (Microsoft │
3505 │ │ │ │ Point-to-Point │
3506 │ │ │ │ Encryption) will be │
3507 │ │ │ │ required for the │
3508 │ │ │ │ PPP session, and │
3509 │ │ │ │ the "require-mppe" │
3510 │ │ │ │ property must also │
3511 │ │ │ │ be set to TRUE. If │
3512 │ │ │ │ 128-bit MPPE is not │
3513 │ │ │ │ available the │
3514 │ │ │ │ session will fail. │
3515 └──────────────────┴────────────┴───────────────┴─────────────────────┘
3516 pppoe setting
3518 PPP-over-Ethernet Settings.
3519 ┌───────────────┬──────────────────────┬───────────────┬──────────────────────┐
3521 │Key Name │ Value Type │ Default Value │ Value │
3522 │ │ │ │ Description │
3523 ├───────────────┼──────────────────────┼───────────────┼──────────────────────┤
3524 │name │ string │ pppoe │ The setting's │
3525 │ │ │ │ name, which │
3526 │ │ │ │ uniquely │
3527 │ │ │ │ identifies the │
3528 │ │ │ │ setting within │
3529 │ │ │ │ the connection. │
3530 │ │ │ │ Each setting │
3531 │ │ │ │ type has a name │
3532 │ │ │ │ unique to that │
3533 │ │ │ │ type, for │
3534 │ │ │ │ example "ppp" or │
3535 │ │ │ │ "wireless" or │
3536 │ │ │ │ "wired". │
3537 ├───────────────┼──────────────────────┼───────────────┼──────────────────────┤
3538 │parent │ string │ │ If given, │
3539 │ │ │ │ specifies the │
3540 │ │ │ │ parent interface │
3541 │ │ │ │ name on which │
3542 │ │ │ │ this PPPoE │
3543 │ │ │ │ connection │
3544 │ │ │ │ should be │
3545 │ │ │ │ created. If │
3546 │ │ │ │ this property is │
3547 │ │ │ │ not specified, │
3548 │ │ │ │ the connection │
3549 │ │ │ │ is activated on │
3550 │ │ │ │ the interface │
3551 │ │ │ │ specified in │
3552 │ │ │ │ "interface-name" │
3553 │ │ │ │ of │
3554 │ │ │ │ NMSettingConnection. │
3555 ├───────────────┼──────────────────────┼───────────────┼──────────────────────┤
3556 │password │ string │ │ Password used to │
3557 │ │ │ │ authenticate with │
3558 │ │ │ │ the PPPoE service. │
3559 ├───────────────┼──────────────────────┼───────────────┼──────────────────────┤
3560 │password-flags │ NMSettingSecretFlags │ │ Flags indicating how │
3561 │ │ (uint32) │ │ to handle the │
3562 │ │ │ │ "password" property. │
3563 │ │ │ │ (see the section │
3564 │ │ │ │ called “Secret flag │
3565 │ │ │ │ types:” for flag │
3566 │ │ │ │ values) │
3567 ├───────────────┼──────────────────────┼───────────────┼──────────────────────┤
3568 │service │ string │ │ If specified, │
3569 │ │ │ │ instruct PPPoE to │
3570 │ │ │ │ only initiate │
3571 │ │ │ │ sessions with access │
3572 │ │ │ │ concentrators that │
3573 │ │ │ │ provide the │
3574 │ │ │ │ specified service. │
3575 │ │ │ │ For most providers, │
3576 │ │ │ │ this should be left │
3577 │ │ │ │ blank. It is only │
3578 │ │ │ │ required if there │
3579 │ │ │ │ are multiple access │
3580 │ │ │ │ concentrators or a │
3581 │ │ │ │ specific service is │
3582 │ │ │ │ known to be │
3583 │ │ │ │ required. │
3584 ├───────────────┼──────────────────────┼───────────────┼──────────────────────┤
3585 │username │ string │ │ Username used to │
3586 │ │ │ │ authenticate with │
3587 │ │ │ │ the PPPoE service. │
3588 └───────────────┴──────────────────────┴───────────────┴──────────────────────┘
3589 proxy setting
3591 WWW Proxy Settings.
3592 ┌─────────────┬────────────┬───────────────┬──────────────────────────────┐
3594 │Key Name │ Value Type │ Default Value │ Value │
3595 │ │ │ │ Description │
3596 ├─────────────┼────────────┼───────────────┼──────────────────────────────┤
3597 │browser-only │ boolean │ FALSE │ Whether the │
3598 │ │ │ │ proxy │
3599 │ │ │ │ configuration is │
3600 │ │ │ │ for browser │
3601 │ │ │ │ only. │
3602 ├─────────────┼────────────┼───────────────┼──────────────────────────────┤
3603 │method │ int32 │ 0 │ Method for proxy │
3604 │ │ │ │ configuration, │
3605 │ │ │ │ Default is │
3606 │ │ │ │ NM_SETTING_PROXY_METHOD_NONE │
3607 │ │ │ │ (0) │
3608 ├─────────────┼────────────┼───────────────┼──────────────────────────────┤
3609 │name │ string │ proxy │ The setting's name, which │
3610 │ │ │ │ uniquely identifies the │
3611 │ │ │ │ setting within the │
3612 │ │ │ │ connection. Each setting │
3613 │ │ │ │ type has a name unique to │
3614 │ │ │ │ that type, for example "ppp" │
3615 │ │ │ │ or "wireless" or "wired". │
3616 ├─────────────┼────────────┼───────────────┼──────────────────────────────┤
3617 │pac-script │ string │ │ PAC script for the │
3618 │ │ │ │ connection. │
3619 ├─────────────┼────────────┼───────────────┼──────────────────────────────┤
3620 │pac-url │ string │ │ PAC URL for obtaining PAC │
3621 │ │ │ │ file. │
3622 └─────────────┴────────────┴───────────────┴──────────────────────────────┘
3623 serial setting
3625 Serial Link Settings.
3626 ┌───────────┬────────────┬───────────────┬──────────────────┐
3628 │Key Name │ Value Type │ Default Value │ Value │
3629 │ │ │ │ Description │
3630 ├───────────┼────────────┼───────────────┼──────────────────┤
3631 │baud │ uint32 │ 57600 │ Speed to use for │
3632 │ │ │ │ communication │
3633 │ │ │ │ over the serial │
3634 │ │ │ │ port. Note that │
3635 │ │ │ │ this value │
3636 │ │ │ │ usually has no │
3637 │ │ │ │ effect for │
3638 │ │ │ │ mobile broadband │
3639 │ │ │ │ modems as they │
3640 │ │ │ │ generally ignore │
3641 │ │ │ │ speed settings │
3642 │ │ │ │ and use the │
3643 │ │ │ │ highest │
3644 │ │ │ │ available speed. │
3645 ├───────────┼────────────┼───────────────┼──────────────────┤
3646 │bits │ uint32 │ 8 │ Byte-width of │
3647 │ │ │ │ the serial │
3648 │ │ │ │ communication. │
3649 │ │ │ │ The 8 in "8n1" │
3650 │ │ │ │ for example. │
3651 ├───────────┼────────────┼───────────────┼──────────────────┤
3652 │name │ string │ serial │ The setting's │
3653 │ │ │ │ name, which │
3654 │ │ │ │ uniquely │
3655 │ │ │ │ identifies the │
3656 │ │ │ │ setting within │
3657 │ │ │ │ the connection. │
3658 │ │ │ │ Each setting │
3659 │ │ │ │ type has a name │
3660 │ │ │ │ unique to that │
3661 │ │ │ │ type, for │
3662 │ │ │ │ example "ppp" or │
3663 │ │ │ │ "wireless" or │
3664 │ │ │ │ "wired". │
3665 ├───────────┼────────────┼───────────────┼──────────────────┤
3666 │parity │ byte │ │ The connection │
3667 │ │ │ │ parity: 69 │
3668 │ │ │ │ (ASCII 'E') for │
3669 │ │ │ │ even parity, 111 │
3670 │ │ │ │ (ASCII 'o') for │
3671 │ │ │ │ odd, 110 (ASCII │
3672 │ │ │ │ 'n') for none. │
3673 ├───────────┼────────────┼───────────────┼──────────────────┤
3674 │send-delay │ uint64 │ 0 │ Time to delay │
3675 │ │ │ │ between each │
3676 │ │ │ │ byte sent to the │
3677 │ │ │ │ modem, in │
3678 │ │ │ │ microseconds. │
3679 ├───────────┼────────────┼───────────────┼──────────────────┤
3680 │stopbits │ uint32 │ 1 │ Number of stop │
3681 │ │ │ │ bits for │
3682 │ │ │ │ communication on │
3683 │ │ │ │ the serial port. │
3684 │ │ │ │ Either 1 or 2. │
3685 │ │ │ │ The 1 in "8n1" │
3686 │ │ │ │ for example. │
3687 └───────────┴────────────┴───────────────┴──────────────────┘
3688 tc setting
3690 Linux Traffic Contril Settings..
3691 ┌─────────┬──────────────────┬───────────────┬──────────────────┐
3693 │Key Name │ Value Type │ Default Value │ Value │
3694 │ │ │ │ Description │
3695 ├─────────┼──────────────────┼───────────────┼──────────────────┤
3696 │name │ string │ tc │ The setting's │
3697 │ │ │ │ name, which │
3698 │ │ │ │ uniquely │
3699 │ │ │ │ identifies the │
3700 │ │ │ │ setting within │
3701 │ │ │ │ the connection. │
3702 │ │ │ │ Each setting │
3703 │ │ │ │ type has a name │
3704 │ │ │ │ unique to that │
3705 │ │ │ │ type, for │
3706 │ │ │ │ example "ppp" or │
3707 │ │ │ │ "wireless" or │
3708 │ │ │ │ "wired". │
3709 ├─────────┼──────────────────┼───────────────┼──────────────────┤
3710 │qdiscs │ array of vardict │ [] │ Array of TC │
3711 │ │ │ │ queuening │
3712 │ │ │ │ disciplines. │
3713 ├─────────┼──────────────────┼───────────────┼──────────────────┤
3714 │tfilters │ array of vardict │ [] │ Array of TC │
3715 │ │ │ │ traffic filters. │
3716 └─────────┴──────────────────┴───────────────┴──────────────────┘
3717 team setting
3719 Teaming Settings.
3720 ┌────────────────────────────┬──────────────────┬───────────────┬──────────────────────────────┐
3722 │Key Name │ Value Type │ Default Value │ Value │
3723 │ │ │ │ Description │
3724 ├────────────────────────────┼──────────────────┼───────────────┼──────────────────────────────┤
3725 │config │ string │ │ The JSON │
3726 │ │ │ │ configuration │
3727 │ │ │ │ for the team │
3728 │ │ │ │ network │
3729 │ │ │ │ interface. The │
3730 │ │ │ │ property should │
3731 │ │ │ │ contain raw JSON │
3732 │ │ │ │ configuration │
3733 │ │ │ │ data suitable │
3734 │ │ │ │ for teamd, │
3735 │ │ │ │ because the │
3736 │ │ │ │ value is passed │
3737 │ │ │ │ directly to │
3738 │ │ │ │ teamd. If not │
3739 │ │ │ │ specified, the │
3740 │ │ │ │ default │
3741 │ │ │ │ configuration is │
3742 │ │ │ │ used. See man │
3743 │ │ │ │ teamd.conf for │
3744 │ │ │ │ the format │
3745 │ │ │ │ details. │
3746 ├────────────────────────────┼──────────────────┼───────────────┼──────────────────────────────┤
3747 │interface-name │ string │ │ Deprecated in │
3748 │ │ │ │ favor of │
3749 │ │ │ │ connection.interface-name, │
3750 │ │ │ │ but can be used │
3751 │ │ │ │ for │
3752 │ │ │ │ backward-compatibility │
3753 │ │ │ │ with older │
3754 │ │ │ │ daemons, to set │
3755 │ │ │ │ the team's │
3756 │ │ │ │ interface name. │
3757 ├────────────────────────────┼──────────────────┼───────────────┼──────────────────────────────┤
3758 │link-watchers │ array of vardict │ [] │ Link watchers │
3759 │ │ │ │ configuration for the │
3760 │ │ │ │ connection: each link │
3761 │ │ │ │ watcher is defined by a │
3762 │ │ │ │ dictionary, whose keys │
3763 │ │ │ │ depend upon the selected │
3764 │ │ │ │ link watcher. Available │
3765 │ │ │ │ link watchers are │
3766 │ │ │ │ 'ethtool', 'nsna_ping' and │
3767 │ │ │ │ 'arp_ping' and it is │
3768 │ │ │ │ specified in the │
3769 │ │ │ │ dictionary with the key │
3770 │ │ │ │ 'name'. Available keys │
3771 │ │ │ │ are: ethtool: │
3772 │ │ │ │ 'delay-up', 'delay-down', │
3773 │ │ │ │ 'init-wait'; nsna_ping: │
3774 │ │ │ │ 'init-wait', 'interval', │
3775 │ │ │ │ 'missed-max', │
3776 │ │ │ │ 'target-host'; arp_ping: │
3777 │ │ │ │ all the ones in nsna_ping │
3778 │ │ │ │ and 'source-host', │
3779 │ │ │ │ 'validate-active', │
3780 │ │ │ │ 'validate-incative', │
3781 │ │ │ │ 'send-always'. See │
3782 │ │ │ │ teamd.conf man for more │
3783 │ │ │ │ details. │
3784 ├────────────────────────────┼──────────────────┼───────────────┼──────────────────────────────┤
3785 │mcast-rejoin-count │ int32 │ 0 │ Corresponds to the teamd │
3786 │ │ │ │ mcast_rejoin.count. │
3787 ├────────────────────────────┼──────────────────┼───────────────┼──────────────────────────────┤
3788 │mcast-rejoin-interval │ int32 │ 0 │ Corresponds to the teamd │
3789 │ │ │ │ mcast_rejoin.interval. │
3790 ├────────────────────────────┼──────────────────┼───────────────┼──────────────────────────────┤
3791 │name │ string │ team │ The setting's name, which │
3792 │ │ │ │ uniquely identifies the │
3793 │ │ │ │ setting within the │
3794 │ │ │ │ connection. Each setting │
3795 │ │ │ │ type has a name unique to │
3796 │ │ │ │ that type, for example │
3797 │ │ │ │ "ppp" or "wireless" or │
3798 │ │ │ │ "wired". │
3799 ├────────────────────────────┼──────────────────┼───────────────┼──────────────────────────────┤
3800 │notify-peers-count │ int32 │ 0 │ Corresponds to the teamd │
3801 │ │ │ │ notify_peers.count. │
3802 ├────────────────────────────┼──────────────────┼───────────────┼──────────────────────────────┤
3803 │notify-peers-interval │ int32 │ 0 │ Corresponds to the teamd │
3804 │ │ │ │ notify_peers.interval. │
3805 ├────────────────────────────┼──────────────────┼───────────────┼──────────────────────────────┤
3806 │runner │ string │ "roundrobin" │ Corresponds to the teamd │
3807 │ │ │ │ runner.name. Permitted │
3808 │ │ │ │ values are: "roundrobin", │
3809 │ │ │ │ "broadcast", │
3810 │ │ │ │ "activebackup", │
3811 │ │ │ │ "loadbalance", "lacp", │
3812 │ │ │ │ "random". When setting the │
3813 │ │ │ │ runner, all the properties │
3814 │ │ │ │ specific to the runner │
3815 │ │ │ │ will be reset to the │
3816 │ │ │ │ default value; all the │
3817 │ │ │ │ properties specific to │
3818 │ │ │ │ other runners will be set │
3819 │ │ │ │ to an empty value (or if │
3820 │ │ │ │ not possible to a default │
3821 │ │ │ │ value). │
3822 ├────────────────────────────┼──────────────────┼───────────────┼──────────────────────────────┤
3823 │runner-active │ boolean │ FALSE │ Corresponds to the teamd │
3824 │ │ │ │ runner.active. │
3825 ├────────────────────────────┼──────────────────┼───────────────┼──────────────────────────────┤
3826 │runner-agg-select-policy │ string │ │ Corresponds to the teamd │
3827 │ │ │ │ runner.agg_select_policy. │
3828 ├────────────────────────────┼──────────────────┼───────────────┼──────────────────────────────┤
3829 │runner-fast-rate │ boolean │ FALSE │ Corresponds to the teamd │
3830 │ │ │ │ runner.fast_rate. │
3831 ├────────────────────────────┼──────────────────┼───────────────┼──────────────────────────────┤
3832 │runner-hwaddr-policy │ string │ │ Corresponds to the teamd │
3833 │ │ │ │ runner.hwaddr_policy. │
3834 ├────────────────────────────┼──────────────────┼───────────────┼──────────────────────────────┤
3835 │runner-min-ports │ int32 │ -1 │ Corresponds to the teamd │
3836 │ │ │ │ runner.min_ports. │
3837 ├────────────────────────────┼──────────────────┼───────────────┼──────────────────────────────┤
3838 │runner-sys-prio │ int32 │ -1 │ Corresponds to the teamd │
3839 │ │ │ │ runner.sys_prio. │
3840 ├────────────────────────────┼──────────────────┼───────────────┼──────────────────────────────┤
3841 │runner-tx-balancer │ string │ │ Corresponds to the teamd │
3842 │ │ │ │ runner.tx_balancer.name. │
3843 ├────────────────────────────┼──────────────────┼───────────────┼──────────────────────────────┤
3844 │runner-tx-balancer-interval │ int32 │ -1 │ Corresponds to the teamd │
3845 │ │ │ │ runner.tx_balancer.interval. │
3846 ├────────────────────────────┼──────────────────┼───────────────┼──────────────────────────────┤
3847 │runner-tx-hash │ array of string │ [] │ Corresponds to the teamd │
3848 │ │ │ │ runner.tx_hash. │
3849 └────────────────────────────┴──────────────────┴───────────────┴──────────────────────────────┘
3850 team-port setting
3852 Team Port Settings.
3853 ┌──────────────┬──────────────────┬───────────────┬─────────────────────────────┐
3855 │Key Name │ Value Type │ Default Value │ Value │
3856 │ │ │ │ Description │
3857 ├──────────────┼──────────────────┼───────────────┼─────────────────────────────┤
3858 │config │ string │ │ The JSON │
3859 │ │ │ │ configuration │
3860 │ │ │ │ for the team │
3861 │ │ │ │ port. The │
3862 │ │ │ │ property should │
3863 │ │ │ │ contain raw JSON │
3864 │ │ │ │ configuration │
3865 │ │ │ │ data suitable │
3866 │ │ │ │ for teamd, │
3867 │ │ │ │ because the │
3868 │ │ │ │ value is passed │
3869 │ │ │ │ directly to │
3870 │ │ │ │ teamd. If not │
3871 │ │ │ │ specified, the │
3872 │ │ │ │ default │
3873 │ │ │ │ configuration is │
3874 │ │ │ │ used. See man │
3875 │ │ │ │ teamd.conf for │
3876 │ │ │ │ the format │
3877 │ │ │ │ details. │
3878 ├──────────────┼──────────────────┼───────────────┼─────────────────────────────┤
3879 │lacp-key │ int32 │ 0 │ Corresponds to │
3880 │ │ │ │ the teamd │
3881 │ │ │ │ ports.PORTIFNAME.lacp_key. │
3882 ├──────────────┼──────────────────┼───────────────┼─────────────────────────────┤
3883 │lacp-prio │ int32 │ 255 │ Corresponds to the teamd │
3884 │ │ │ │ ports.PORTIFNAME.lacp_prio. │
3885 ├──────────────┼──────────────────┼───────────────┼─────────────────────────────┤
3886 │link-watchers │ array of vardict │ [] │ Link watchers configuration │
3887 │ │ │ │ for the connection: each │
3888 │ │ │ │ link watcher is defined by │
3889 │ │ │ │ a dictionary, whose keys │
3890 │ │ │ │ depend upon the selected │
3891 │ │ │ │ link watcher. Available │
3892 │ │ │ │ link watchers are │
3893 │ │ │ │ 'ethtool', 'nsna_ping' and │
3894 │ │ │ │ 'arp_ping' and it is │
3895 │ │ │ │ specified in the dictionary │
3896 │ │ │ │ with the key 'name'. │
3897 │ │ │ │ Available keys are: │
3898 │ │ │ │ ethtool: 'delay-up', │
3899 │ │ │ │ 'delay-down', 'init-wait'; │
3900 │ │ │ │ nsna_ping: 'init-wait', │
3901 │ │ │ │ 'interval', 'missed-max', │
3902 │ │ │ │ 'target-host'; arp_ping: │
3903 │ │ │ │ all the ones in nsna_ping │
3904 │ │ │ │ and 'source-host', │
3905 │ │ │ │ 'validate-active', │
3906 │ │ │ │ 'validate-incative', │
3907 │ │ │ │ 'send-always'. See │
3908 │ │ │ │ teamd.conf man for more │
3909 │ │ │ │ details. │
3910 ├──────────────┼──────────────────┼───────────────┼─────────────────────────────┤
3911 │name │ string │ team-port │ The setting's name, which │
3912 │ │ │ │ uniquely identifies the │
3913 │ │ │ │ setting within the │
3914 │ │ │ │ connection. Each setting │
3915 │ │ │ │ type has a name unique to │
3916 │ │ │ │ that type, for example │
3917 │ │ │ │ "ppp" or "wireless" or │
3918 │ │ │ │ "wired". │
3919 ├──────────────┼──────────────────┼───────────────┼─────────────────────────────┤
3920 │prio │ int32 │ 0 │ Corresponds to the teamd │
3921 │ │ │ │ ports.PORTIFNAME.prio. │
3922 ├──────────────┼──────────────────┼───────────────┼─────────────────────────────┤
3923 │queue-id │ int32 │ -1 │ Corresponds to the teamd │
3924 │ │ │ │ ports.PORTIFNAME.queue_id. │
3925 │ │ │ │ When set to -1 means the │
3926 │ │ │ │ parameter is skipped from │
3927 │ │ │ │ the json config. │
3928 ├──────────────┼──────────────────┼───────────────┼─────────────────────────────┤
3929 │sticky │ boolean │ FALSE │ Corresponds to the teamd │
3930 │ │ │ │ ports.PORTIFNAME.sticky. │
3931 └──────────────┴──────────────────┴───────────────┴─────────────────────────────┘
3932 tun setting
3934 Tunnel Settings.
3935 ┌────────────┬────────────┬───────────────┬─────────────────────────┐
3937 │Key Name │ Value Type │ Default Value │ Value │
3938 │ │ │ │ Description │
3939 ├────────────┼────────────┼───────────────┼─────────────────────────┤
3940 │group │ string │ │ The group ID │
3941 │ │ │ │ which will own │
3942 │ │ │ │ the device. If │
3943 │ │ │ │ set to NULL │
3944 │ │ │ │ everyone will be │
3945 │ │ │ │ able to use the │
3946 │ │ │ │ device. │
3947 ├────────────┼────────────┼───────────────┼─────────────────────────┤
3948 │mode │ uint32 │ 1 │ The operating │
3949 │ │ │ │ mode of the │
3950 │ │ │ │ virtual device. │
3951 │ │ │ │ Allowed values │
3952 │ │ │ │ are │
3953 │ │ │ │ NM_SETTING_TUN_MODE_TUN │
3954 │ │ │ │ (1) to create a │
3955 │ │ │ │ layer 3 device │
3956 │ │ │ │ and │
3957 │ │ │ │ NM_SETTING_TUN_MODE_TAP │
3958 │ │ │ │ (2) to create an │
3959 │ │ │ │ Ethernet-like │
3960 │ │ │ │ layer 2 one. │
3961 ├────────────┼────────────┼───────────────┼─────────────────────────┤
3962 │multi-queue │ boolean │ FALSE │ If the property is set │
3963 │ │ │ │ to TRUE, the interface │
3964 │ │ │ │ will support multiple │
3965 │ │ │ │ file descriptors │
3966 │ │ │ │ (queues) to parallelize │
3967 │ │ │ │ packet sending or │
3968 │ │ │ │ receiving. Otherwise, │
3969 │ │ │ │ the interface will only │
3970 │ │ │ │ support a single queue. │
3971 ├────────────┼────────────┼───────────────┼─────────────────────────┤
3972 │name │ string │ tun │ The setting's name, │
3973 │ │ │ │ which uniquely │
3974 │ │ │ │ identifies the setting │
3975 │ │ │ │ within the connection. │
3976 │ │ │ │ Each setting type has a │
3977 │ │ │ │ name unique to that │
3978 │ │ │ │ type, for example "ppp" │
3979 │ │ │ │ or "wireless" or │
3980 │ │ │ │ "wired". │
3981 ├────────────┼────────────┼───────────────┼─────────────────────────┤
3982 │owner │ string │ │ The user ID which will │
3983 │ │ │ │ own the device. If set │
3984 │ │ │ │ to NULL everyone will │
3985 │ │ │ │ be able to use the │
3986 │ │ │ │ device. │
3987 ├────────────┼────────────┼───────────────┼─────────────────────────┤
3988 │pi │ boolean │ FALSE │ If TRUE the interface │
3989 │ │ │ │ will prepend a 4 byte │
3990 │ │ │ │ header describing the │
3991 │ │ │ │ physical interface to │
3992 │ │ │ │ the packets. │
3993 ├────────────┼────────────┼───────────────┼─────────────────────────┤
3994 │vnet-hdr │ boolean │ FALSE │ If TRUE the │
3995 │ │ │ │ IFF_VNET_HDR the tunnel │
3996 │ │ │ │ packets will include a │
3997 │ │ │ │ virtio network header. │
3998 └────────────┴────────────┴───────────────┴─────────────────────────┘
3999 user setting
4001 General User Profile Settings.
4002 ┌─────────┬────────────────┬───────────────┬──────────────────┐
4004 │Key Name │ Value Type │ Default Value │ Value │
4005 │ │ │ │ Description │
4006 ├─────────┼────────────────┼───────────────┼──────────────────┤
4007 │data │ dict of string │ {} │ A dictionary of │
4008 │ │ to string │ │ key/value pairs │
4009 │ │ │ │ with user data. │
4010 │ │ │ │ This data is │
4011 │ │ │ │ ignored by │
4012 │ │ │ │ NetworkManager │
4013 │ │ │ │ and can be used │
4014 │ │ │ │ at the users │
4015 │ │ │ │ discretion. The │
4016 │ │ │ │ keys only │
4017 │ │ │ │ support a strict │
4018 │ │ │ │ ascii format, │
4019 │ │ │ │ but the values │
4020 │ │ │ │ can be arbitrary │
4021 │ │ │ │ UTF8 strings up │
4022 │ │ │ │ to a certain │
4023 │ │ │ │ length. │
4024 ├─────────┼────────────────┼───────────────┼──────────────────┤
4025 │name │ string │ user │ The setting's │
4026 │ │ │ │ name, which │
4027 │ │ │ │ uniquely │
4028 │ │ │ │ identifies the │
4029 │ │ │ │ setting within │
4030 │ │ │ │ the connection. │
4031 │ │ │ │ Each setting │
4032 │ │ │ │ type has a name │
4033 │ │ │ │ unique to that │
4034 │ │ │ │ type, for │
4035 │ │ │ │ example "ppp" or │
4036 │ │ │ │ "wireless" or │
4037 │ │ │ │ "wired". │
4038 └─────────┴────────────────┴───────────────┴──────────────────┘
4039 vlan setting
4041 VLAN Settings.
4042 ┌─────────────────────┬─────────────────┬───────────────┬───────────────────────────────┐
4044 │Key Name │ Value Type │ Default Value │ Value │
4045 │ │ │ │ Description │
4046 ├─────────────────────┼─────────────────┼───────────────┼───────────────────────────────┤
4047 │egress-priority-map │ array of string │ [] │ For outgoing │
4048 │ │ │ │ packets, a list │
4049 │ │ │ │ of mappings from │
4050 │ │ │ │ Linux SKB │
4051 │ │ │ │ priorities to │
4052 │ │ │ │ 802.1p │
4053 │ │ │ │ priorities. The │
4054 │ │ │ │ mapping is given │
4055 │ │ │ │ in the format │
4056 │ │ │ │ "from:to" where │
4057 │ │ │ │ both "from" and │
4058 │ │ │ │ "to" are │
4059 │ │ │ │ unsigned │
4060 │ │ │ │ integers, ie │
4061 │ │ │ │ "7:3". │
4062 ├─────────────────────┼─────────────────┼───────────────┼───────────────────────────────┤
4063 │flags │ NMVlanFlags │ │ One or more │
4064 │ │ (uint32) │ │ flags which │
4065 │ │ │ │ control the │
4066 │ │ │ │ behavior and │
4067 │ │ │ │ features of the │
4068 │ │ │ │ VLAN interface. │
4069 │ │ │ │ Flags include │
4070 │ │ │ │ NM_VLAN_FLAG_REORDER_HEADERS │
4071 │ │ │ │ (0x1) │
4072 │ │ │ │ (reordering of │
4073 │ │ │ │ output packet │
4074 │ │ │ │ headers), │
4075 │ │ │ │ NM_VLAN_FLAG_GVRP │
4076 │ │ │ │ (0x2) (use of │
4077 │ │ │ │ the GVRP │
4078 │ │ │ │ protocol), and │
4079 │ │ │ │ NM_VLAN_FLAG_LOOSE_BINDING │
4080 │ │ │ │ (0x4) (loose │
4081 │ │ │ │ binding of the │
4082 │ │ │ │ interface to its │
4083 │ │ │ │ master device's │
4084 │ │ │ │ operating │
4085 │ │ │ │ state). │
4086 │ │ │ │ NM_VLAN_FLAG_MVRP │
4087 │ │ │ │ (0x8) (use of │
4088 │ │ │ │ the MVRP │
4089 │ │ │ │ protocol). The │
4090 │ │ │ │ default value of │
4091 │ │ │ │ this property is │
4092 │ │ │ │ NM_VLAN_FLAG_REORDER_HEADERS, │
4093 │ │ │ │ but it used to │
4094 │ │ │ │ be 0. To │
4095 │ │ │ │ preserve │
4096 │ │ │ │ backward │
4097 │ │ │ │ compatibility, │
4098 │ │ │ │ the │
4099 │ │ │ │ default-value in │
4100 │ │ │ │ the D-Bus API │
4101 │ │ │ │ continues to be │
4102 │ │ │ │ 0 and a missing │
4103 │ │ │ │ property on │
4104 │ │ │ │ D-Bus is still │
4105 │ │ │ │ considered as 0. │
4106 ├─────────────────────┼─────────────────┼───────────────┼───────────────────────────────┤
4107 │id │ uint32 │ 0 │ The VLAN identifier that the │
4108 │ │ │ │ interface created by this │
4109 │ │ │ │ connection should be │
4110 │ │ │ │ assigned. The valid range is │
4111 │ │ │ │ from 0 to 4094, without the │
4112 │ │ │ │ reserved id 4095. │
4113 ├─────────────────────┼─────────────────┼───────────────┼───────────────────────────────┤
4114 │ingress-priority-map │ array of string │ [] │ For incoming packets, a list │
4115 │ │ │ │ of mappings from 802.1p │
4116 │ │ │ │ priorities to Linux SKB │
4117 │ │ │ │ priorities. The mapping is │
4118 │ │ │ │ given in the format "from:to" │
4119 │ │ │ │ where both "from" and "to" │
4120 │ │ │ │ are unsigned integers, ie │
4121 │ │ │ │ "7:3". │
4122 ├─────────────────────┼─────────────────┼───────────────┼───────────────────────────────┤
4123 │interface-name │ string │ │ Deprecated in favor of │
4124 │ │ │ │ connection.interface-name, │
4125 │ │ │ │ but can be used for │
4126 │ │ │ │ backward-compatibility with │
4127 │ │ │ │ older daemons, to set the │
4128 │ │ │ │ vlan's interface name. │
4129 ├─────────────────────┼─────────────────┼───────────────┼───────────────────────────────┤
4130 │name │ string │ vlan │ The setting's name, which │
4131 │ │ │ │ uniquely identifies the │
4132 │ │ │ │ setting within the │
4133 │ │ │ │ connection. Each setting │
4134 │ │ │ │ type has a name unique to │
4135 │ │ │ │ that type, for example "ppp" │
4136 │ │ │ │ or "wireless" or "wired". │
4137 ├─────────────────────┼─────────────────┼───────────────┼───────────────────────────────┤
4138 │parent │ string │ │ If given, specifies the │
4139 │ │ │ │ parent interface name or │
4140 │ │ │ │ parent connection UUID from │
4141 │ │ │ │ which this VLAN interface │
4142 │ │ │ │ should be created. If this │
4143 │ │ │ │ property is not specified, │
4144 │ │ │ │ the connection must contain │
4145 │ │ │ │ an "802-3-ethernet" setting │
4146 │ │ │ │ with a "mac-address" │
4147 │ │ │ │ property. │
4148 └─────────────────────┴─────────────────┴───────────────┴───────────────────────────────┘
4149 vpn setting
4151 VPN Settings.
4152 ┌─────────────┬────────────────┬───────────────┬─────────────────────────────────────┐
4154 │Key Name │ Value Type │ Default Value │ Value │
4155 │ │ │ │ Description │
4156 ├─────────────┼────────────────┼───────────────┼─────────────────────────────────────┤
4157 │data │ dict of string │ {} │ Dictionary of │
4158 │ │ to string │ │ key/value pairs │
4159 │ │ │ │ of VPN plugin │
4160 │ │ │ │ specific data. │
4161 │ │ │ │ Both keys and │
4162 │ │ │ │ values must be │
4163 │ │ │ │ strings. │
4164 ├─────────────┼────────────────┼───────────────┼─────────────────────────────────────┤
4165 │name │ string │ vpn │ The setting's │
4166 │ │ │ │ name, which │
4167 │ │ │ │ uniquely │
4168 │ │ │ │ identifies the │
4169 │ │ │ │ setting within │
4170 │ │ │ │ the connection. │
4171 │ │ │ │ Each setting │
4172 │ │ │ │ type has a name │
4173 │ │ │ │ unique to that │
4174 │ │ │ │ type, for │
4175 │ │ │ │ example "ppp" or │
4176 │ │ │ │ "wireless" or │
4177 │ │ │ │ "wired". │
4178 ├─────────────┼────────────────┼───────────────┼─────────────────────────────────────┤
4179 │persistent │ boolean │ FALSE │ If the VPN │
4180 │ │ │ │ service supports │
4181 │ │ │ │ persistence, and │
4182 │ │ │ │ this property is │
4183 │ │ │ │ TRUE, the VPN │
4184 │ │ │ │ will attempt to │
4185 │ │ │ │ stay connected │
4186 │ │ │ │ across link │
4187 │ │ │ │ changes and │
4188 │ │ │ │ outages, until │
4189 │ │ │ │ explicitly │
4190 │ │ │ │ disconnected. │
4191 ├─────────────┼────────────────┼───────────────┼─────────────────────────────────────┤
4192 │secrets │ dict of string │ {} │ Dictionary of │
4193 │ │ to string │ │ key/value pairs │
4194 │ │ │ │ of VPN plugin │
4195 │ │ │ │ specific secrets │
4196 │ │ │ │ like passwords │
4197 │ │ │ │ or private keys. │
4198 │ │ │ │ Both keys and │
4199 │ │ │ │ values must be │
4200 │ │ │ │ strings. │
4201 ├─────────────┼────────────────┼───────────────┼─────────────────────────────────────┤
4202 │service-type │ string │ │ D-Bus service │
4203 │ │ │ │ name of the VPN │
4204 │ │ │ │ plugin that this │
4205 │ │ │ │ setting uses to │
4206 │ │ │ │ connect to its │
4207 │ │ │ │ network. i.e. │
4208 │ │ │ │ org.freedesktop.NetworkManager.vpnc │
4209 │ │ │ │ for the vpnc │
4210 │ │ │ │ plugin. │
4211 ├─────────────┼────────────────┼───────────────┼─────────────────────────────────────┤
4212 │timeout │ uint32 │ 0 │ Timeout for the VPN service to │
4213 │ │ │ │ establish the connection. Some │
4214 │ │ │ │ services may take quite a long time │
4215 │ │ │ │ to connect. Value of 0 means a │
4216 │ │ │ │ default timeout, which is 60 │
4217 │ │ │ │ seconds (unless overridden by │
4218 │ │ │ │ vpn.timeout in configuration file). │
4219 │ │ │ │ Values greater than zero mean │
4220 │ │ │ │ timeout in seconds. │
4221 ├─────────────┼────────────────┼───────────────┼─────────────────────────────────────┤
4222 │user-name │ string │ │ If the VPN connection requires a │
4223 │ │ │ │ user name for authentication, that │
4224 │ │ │ │ name should be provided here. If │
4225 │ │ │ │ the connection is available to more │
4226 │ │ │ │ than one user, and the VPN requires │
4227 │ │ │ │ each user to supply a different │
4228 │ │ │ │ name, then leave this property │
4229 │ │ │ │ empty. If this property is empty, │
4230 │ │ │ │ NetworkManager will automatically │
4231 │ │ │ │ supply the username of the user │
4232 │ │ │ │ which requested the VPN connection. │
4233 └─────────────┴────────────────┴───────────────┴─────────────────────────────────────┘
4234 vxlan setting
4236 VXLAN Settings.
4237 ┌─────────────────┬────────────┬───────────────┬──────────────────┐
4239 │Key Name │ Value Type │ Default Value │ Value │
4240 │ │ │ │ Description │
4241 ├─────────────────┼────────────┼───────────────┼──────────────────┤
4242 │ageing │ uint32 │ 300 │ Specifies the │
4243 │ │ │ │ lifetime in │
4244 │ │ │ │ seconds of FDB │
4245 │ │ │ │ entries learnt │
4246 │ │ │ │ by the kernel. │
4247 ├─────────────────┼────────────┼───────────────┼──────────────────┤
4248 │destination-port │ uint32 │ 8472 │ Specifies the │
4249 │ │ │ │ UDP destination │
4250 │ │ │ │ port to │
4251 │ │ │ │ communicate to │
4252 │ │ │ │ the remote VXLAN │
4253 │ │ │ │ tunnel endpoint. │
4254 ├─────────────────┼────────────┼───────────────┼──────────────────┤
4255 │id │ uint32 │ 0 │ Specifies the │
4256 │ │ │ │ VXLAN Network │
4257 │ │ │ │ Identifier (or │
4258 │ │ │ │ VXLAN Segment │
4259 │ │ │ │ Identifier) to │
4260 │ │ │ │ use. │
4261 ├─────────────────┼────────────┼───────────────┼──────────────────┤
4262 │l2-miss │ boolean │ FALSE │ Specifies │
4263 │ │ │ │ whether netlink │
4264 │ │ │ │ LL ADDR miss │
4265 │ │ │ │ notifications │
4266 │ │ │ │ are generated. │
4267 ├─────────────────┼────────────┼───────────────┼──────────────────┤
4268 │l3-miss │ boolean │ FALSE │ Specifies │
4269 │ │ │ │ whether netlink │
4270 │ │ │ │ IP ADDR miss │
4271 │ │ │ │ notifications │
4272 │ │ │ │ are generated. │
4273 ├─────────────────┼────────────┼───────────────┼──────────────────┤
4274 │learning │ boolean │ TRUE │ Specifies │
4275 │ │ │ │ whether unknown │
4276 │ │ │ │ source link │
4277 │ │ │ │ layer addresses │
4278 │ │ │ │ and IP addresses │
4279 │ │ │ │ are entered into │
4280 │ │ │ │ the VXLAN device │
4281 │ │ │ │ forwarding │
4282 │ │ │ │ database. │
4283 ├─────────────────┼────────────┼───────────────┼──────────────────┤
4284 │limit │ uint32 │ 0 │ Specifies the │
4285 │ │ │ │ maximum number │
4286 │ │ │ │ of FDB entries. │
4287 │ │ │ │ A value of zero │
4288 │ │ │ │ means that the │
4289 │ │ │ │ kernel will │
4290 │ │ │ │ store unlimited │
4291 │ │ │ │ entries. │
4292 ├─────────────────┼────────────┼───────────────┼──────────────────┤
4293 │local │ string │ │ If given, │
4294 │ │ │ │ specifies the │
4295 │ │ │ │ source IP │
4296 │ │ │ │ address to use │
4297 │ │ │ │ in outgoing │
4298 │ │ │ │ packets. │
4299 ├─────────────────┼────────────┼───────────────┼──────────────────┤
4300 │name │ string │ vxlan │ The setting's │
4301 │ │ │ │ name, which │
4302 │ │ │ │ uniquely │
4303 │ │ │ │ identifies the │
4304 │ │ │ │ setting within │
4305 │ │ │ │ the connection. │
4306 │ │ │ │ Each setting │
4307 │ │ │ │ type has a name │
4308 │ │ │ │ unique to that │
4309 │ │ │ │ type, for │
4310 │ │ │ │ example "ppp" or │
4311 │ │ │ │ "wireless" or │
4312 │ │ │ │ "wired". │
4313 ├─────────────────┼────────────┼───────────────┼──────────────────┤
4314 │parent │ string │ │ If given, │
4315 │ │ │ │ specifies the │
4316 │ │ │ │ parent interface │
4317 │ │ │ │ name or parent │
4318 │ │ │ │ connection UUID. │
4319 ├─────────────────┼────────────┼───────────────┼──────────────────┤
4320 │proxy │ boolean │ FALSE │ Specifies │
4321 │ │ │ │ whether ARP │
4322 │ │ │ │ proxy is turned │
4323 │ │ │ │ on. │
4324 ├─────────────────┼────────────┼───────────────┼──────────────────┤
4325 │remote │ string │ │ Specifies the │
4326 │ │ │ │ unicast │
4327 │ │ │ │ destination IP │
4328 │ │ │ │ address to use │
4329 │ │ │ │ in outgoing │
4330 │ │ │ │ packets when the │
4331 │ │ │ │ destination link │
4332 │ │ │ │ layer address is │
4333 │ │ │ │ not known in the │
4334 │ │ │ │ VXLAN device │
4335 │ │ │ │ forwarding │
4336 │ │ │ │ database, or the │
4337 │ │ │ │ multicast IP │
4338 │ │ │ │ address to join. │
4339 ├─────────────────┼────────────┼───────────────┼──────────────────┤
4340 │rsc │ boolean │ FALSE │ Specifies │
4341 │ │ │ │ whether route │
4342 │ │ │ │ short circuit is │
4343 │ │ │ │ turned on. │
4344 ├─────────────────┼────────────┼───────────────┼──────────────────┤
4345 │source-port-max │ uint32 │ 0 │ Specifies the │
4346 │ │ │ │ maximum UDP │
4347 │ │ │ │ source port to │
4348 │ │ │ │ communicate to │
4349 │ │ │ │ the remote VXLAN │
4350 │ │ │ │ tunnel endpoint. │
4351 ├─────────────────┼────────────┼───────────────┼──────────────────┤
4352 │source-port-min │ uint32 │ 0 │ Specifies the │
4353 │ │ │ │ minimum UDP │
4354 │ │ │ │ source port to │
4355 │ │ │ │ communicate to │
4356 │ │ │ │ the remote VXLAN │
4357 │ │ │ │ tunnel endpoint. │
4358 ├─────────────────┼────────────┼───────────────┼──────────────────┤
4359 │tos │ uint32 │ 0 │ Specifies the │
4360 │ │ │ │ TOS value to use │
4361 │ │ │ │ in outgoing │
4362 │ │ │ │ packets. │
4363 ├─────────────────┼────────────┼───────────────┼──────────────────┤
4364 │ttl │ uint32 │ 0 │ Specifies the │
4365 │ │ │ │ time-to-live │
4366 │ │ │ │ value to use in │
4367 │ │ │ │ outgoing │
4368 │ │ │ │ packets. │
4369 └─────────────────┴────────────┴───────────────┴──────────────────┘
4370 wimax setting
4372 WiMax Settings.
4373 ┌─────────────┬────────────┬───────────────┬──────────────────┐
4375 │Key Name │ Value Type │ Default Value │ Value │
4376 │ │ │ │ Description │
4377 ├─────────────┼────────────┼───────────────┼──────────────────┤
4378 │mac-address │ byte array │ │ If specified, │
4379 │ │ │ │ this connection │
4380 │ │ │ │ will only apply │
4381 │ │ │ │ to the WiMAX │
4382 │ │ │ │ device whose MAC │
4383 │ │ │ │ address matches. │
4384 │ │ │ │ This property │
4385 │ │ │ │ does not change │
4386 │ │ │ │ the MAC address │
4387 │ │ │ │ of the device │
4388 │ │ │ │ (known as MAC │
4389 │ │ │ │ spoofing). │
4390 │ │ │ │ Deprecated: 1 │
4391 ├─────────────┼────────────┼───────────────┼──────────────────┤
4392 │name │ string │ wimax │ The setting's │
4393 │ │ │ │ name, which │
4394 │ │ │ │ uniquely │
4395 │ │ │ │ identifies the │
4396 │ │ │ │ setting within │
4397 │ │ │ │ the connection. │
4398 │ │ │ │ Each setting │
4399 │ │ │ │ type has a name │
4400 │ │ │ │ unique to that │
4401 │ │ │ │ type, for │
4402 │ │ │ │ example "ppp" or │
4403 │ │ │ │ "wireless" or │
4404 │ │ │ │ "wired". │
4405 ├─────────────┼────────────┼───────────────┼──────────────────┤
4406 │network-name │ string │ │ Network Service │
4407 │ │ │ │ Provider (NSP) │
4408 │ │ │ │ name of the │
4409 │ │ │ │ WiMAX network │
4410 │ │ │ │ this connection │
4411 │ │ │ │ should use. │
4412 │ │ │ │ Deprecated: 1 │
4413 └─────────────┴────────────┴───────────────┴──────────────────┘
4414 802-3-ethernet setting
4416 Wired Ethernet Settings.
4417 ┌──────────────────────────┬─────────────────┬────────────────┬────────────────────────────────────────┐
4419 │Key Name │ Value Type │ Default Value │ Value │
4420 │ │ │ │ Description │
4421 ├──────────────────────────┼─────────────────┼────────────────┼────────────────────────────────────────┤
4422 │assigned-mac-address │ string │ │ The new field │
4423 │ │ │ │ for the cloned │
4424 │ │ │ │ MAC address. It │
4425 │ │ │ │ can be either a │
4426 │ │ │ │ hardware address │
4427 │ │ │ │ in ASCII │
4428 │ │ │ │ representation, │
4429 │ │ │ │ or one of the │
4430 │ │ │ │ special values │
4431 │ │ │ │ "preserve", │
4432 │ │ │ │ "permanent", │
4433 │ │ │ │ "random" or │
4434 │ │ │ │ "stable". This │
4435 │ │ │ │ field replaces │
4436 │ │ │ │ the deprecated │
4437 │ │ │ │ "cloned-mac-address" │
4438 │ │ │ │ on D-Bus, which │
4439 │ │ │ │ can only contain │
4440 │ │ │ │ explict hardware │
4441 │ │ │ │ addresses. Note │
4442 │ │ │ │ that this │
4443 │ │ │ │ property only │
4444 │ │ │ │ exists in D-Bus │
4445 │ │ │ │ API. libnm and │
4446 │ │ │ │ nmcli continue │
4447 │ │ │ │ to call this │
4448 │ │ │ │ property │
4449 │ │ │ │ "cloned-mac-address". │
4450 ├──────────────────────────┼─────────────────┼────────────────┼────────────────────────────────────────┤
4451 │auto-negotiate │ boolean │ FALSE │ When TRUE, enforce │
4452 │ │ │ │ auto-negotiation of │
4453 │ │ │ │ speed and duplex │
4454 │ │ │ │ mode. If "speed" and │
4455 │ │ │ │ "duplex" properties │
4456 │ │ │ │ are both specified, │
4457 │ │ │ │ only that single mode │
4458 │ │ │ │ will be advertised │
4459 │ │ │ │ and accepted during │
4460 │ │ │ │ the link │
4461 │ │ │ │ auto-negotiation │
4462 │ │ │ │ process: this works │
4463 │ │ │ │ only for BASE-T 802.3 │
4464 │ │ │ │ specifications and is │
4465 │ │ │ │ useful for enforcing │
4466 │ │ │ │ gigabits modes, as in │
4467 │ │ │ │ these cases link │
4468 │ │ │ │ negotiation is │
4469 │ │ │ │ mandatory. When │
4470 │ │ │ │ FALSE, "speed" and │
4471 │ │ │ │ "duplex" properties │
4472 │ │ │ │ should be both set or │
4473 │ │ │ │ link configuration │
4474 │ │ │ │ will be skipped. │
4475 ├──────────────────────────┼─────────────────┼────────────────┼────────────────────────────────────────┤
4476 │cloned-mac-address │ byte array │ │ This D-Bus field is │
4477 │ │ │ │ deprecated in favor │
4478 │ │ │ │ of │
4479 │ │ │ │ "assigned-mac-address" │
4480 │ │ │ │ which is more │
4481 │ │ │ │ flexible and allows │
4482 │ │ │ │ specifying special │
4483 │ │ │ │ variants like │
4484 │ │ │ │ "random". For libnm │
4485 │ │ │ │ and nmcli, this field │
4486 │ │ │ │ is called │
4487 │ │ │ │ "cloned-mac-address". │
4488 ├──────────────────────────┼─────────────────┼────────────────┼────────────────────────────────────────┤
4489 │duplex │ string │ │ When a value is set, │
4490 │ │ │ │ either "half" or │
4491 │ │ │ │ "full", configures the │
4492 │ │ │ │ device to use the │
4493 │ │ │ │ specified duplex mode. │
4494 │ │ │ │ If "auto-negotiate" is │
4495 │ │ │ │ "yes" the specified │
4496 │ │ │ │ duplex mode will be │
4497 │ │ │ │ the only one │
4498 │ │ │ │ advertised during link │
4499 │ │ │ │ negotiation: this │
4500 │ │ │ │ works only for BASE-T │
4501 │ │ │ │ 802.3 specifications │
4502 │ │ │ │ and is useful for │
4503 │ │ │ │ enforcing gigabits │
4504 │ │ │ │ modes, as in these │
4505 │ │ │ │ cases link negotiation │
4506 │ │ │ │ is mandatory. If the │
4507 │ │ │ │ value is unset (the │
4508 │ │ │ │ default), the link │
4509 │ │ │ │ configuration will be │
4510 │ │ │ │ either skipped (if │
4511 │ │ │ │ "auto-negotiate" is │
4512 │ │ │ │ "no", the default) or │
4513 │ │ │ │ will be │
4514 │ │ │ │ auto-negotiated (if │
4515 │ │ │ │ "auto-negotiate" is │
4516 │ │ │ │ "yes") and the local │
4517 │ │ │ │ device will advertise │
4518 │ │ │ │ all the supported │
4519 │ │ │ │ duplex modes. Must be │
4520 │ │ │ │ set together with the │
4521 │ │ │ │ "speed" property if │
4522 │ │ │ │ specified. Before │
4523 │ │ │ │ specifying a duplex │
4524 │ │ │ │ mode be sure your │
4525 │ │ │ │ device supports it. │
4526 ├──────────────────────────┼─────────────────┼────────────────┼────────────────────────────────────────┤
4527 │generate-mac-address-mask │ string │ │ With │
4528 │ │ │ │ "cloned-mac-address" │
4529 │ │ │ │ setting "random" or │
4530 │ │ │ │ "stable", by default │
4531 │ │ │ │ all bits of the MAC │
4532 │ │ │ │ address are scrambled │
4533 │ │ │ │ and a │
4534 │ │ │ │ locally-administered, │
4535 │ │ │ │ unicast MAC address is │
4536 │ │ │ │ created. This property │
4537 │ │ │ │ allows to specify that │
4538 │ │ │ │ certain bits are │
4539 │ │ │ │ fixed. Note that the │
4540 │ │ │ │ least significant bit │
4541 │ │ │ │ of the first MAC │
4542 │ │ │ │ address will always be │
4543 │ │ │ │ unset to create a │
4544 │ │ │ │ unicast MAC address. │
4545 │ │ │ │ If the property is │
4546 │ │ │ │ NULL, it is eligible │
4547 │ │ │ │ to be overwritten by a │
4548 │ │ │ │ default connection │
4549 │ │ │ │ setting. If the value │
4550 │ │ │ │ is still NULL or an │
4551 │ │ │ │ empty string, the │
4552 │ │ │ │ default is to create a │
4553 │ │ │ │ locally-administered, │
4554 │ │ │ │ unicast MAC address. │
4555 │ │ │ │ If the value contains │
4556 │ │ │ │ one MAC address, this │
4557 │ │ │ │ address is used as │
4558 │ │ │ │ mask. The set bits of │
4559 │ │ │ │ the mask are to be │
4560 │ │ │ │ filled with the │
4561 │ │ │ │ current MAC address of │
4562 │ │ │ │ the device, while the │
4563 │ │ │ │ unset bits are subject │
4564 │ │ │ │ to randomization. │
4565 │ │ │ │ Setting │
4566 │ │ │ │ "FE:FF:FF:00:00:00" │
4567 │ │ │ │ means to preserve the │
4568 │ │ │ │ OUI of the current MAC │
4569 │ │ │ │ address and only │
4570 │ │ │ │ randomize the lower 3 │
4571 │ │ │ │ bytes using the │
4572 │ │ │ │ "random" or "stable" │
4573 │ │ │ │ algorithm. If the │
4574 │ │ │ │ value contains one │
4575 │ │ │ │ additional MAC address │
4576 │ │ │ │ after the mask, this │
4577 │ │ │ │ address is used │
4578 │ │ │ │ instead of the current │
4579 │ │ │ │ MAC address to fill │
4580 │ │ │ │ the bits that shall │
4581 │ │ │ │ not be randomized. For │
4582 │ │ │ │ example, a value of │
4583 │ │ │ │ "FE:FF:FF:00:00:00 │
4584 │ │ │ │ 68:F7:28:00:00:00" │
4585 │ │ │ │ will set the OUI of │
4586 │ │ │ │ the MAC address to │
4587 │ │ │ │ 68:F7:28, while the │
4588 │ │ │ │ lower bits are │
4589 │ │ │ │ randomized. A value of │
4590 │ │ │ │ "02:00:00:00:00:00 │
4591 │ │ │ │ 00:00:00:00:00:00" │
4592 │ │ │ │ will create a fully │
4593 │ │ │ │ scrambled │
4594 │ │ │ │ globally-administered, │
4595 │ │ │ │ burned-in MAC address. │
4596 │ │ │ │ If the value contains │
4597 │ │ │ │ more than one │
4598 │ │ │ │ additional MAC │
4599 │ │ │ │ addresses, one of them │
4600 │ │ │ │ is chosen randomly. │
4601 │ │ │ │ For example, │
4602 │ │ │ │ "02:00:00:00:00:00 │
4603 │ │ │ │ 00:00:00:00:00:00 │
4604 │ │ │ │ 02:00:00:00:00:00" │
4605 │ │ │ │ will create a fully │
4606 │ │ │ │ scrambled MAC address, │
4607 │ │ │ │ randomly locally or │
4608 │ │ │ │ globally administered. │
4609 ├──────────────────────────┼─────────────────┼────────────────┼────────────────────────────────────────┤
4610 │mac-address │ byte array │ │ If specified, this │
4611 │ │ │ │ connection will only │
4612 │ │ │ │ apply to the Ethernet │
4613 │ │ │ │ device whose permanent │
4614 │ │ │ │ MAC address matches. │
4615 │ │ │ │ This property does not │
4616 │ │ │ │ change the MAC address │
4617 │ │ │ │ of the device (i.e. │
4618 │ │ │ │ MAC spoofing). │
4619 ├──────────────────────────┼─────────────────┼────────────────┼────────────────────────────────────────┤
4620 │mac-address-blacklist │ array of string │ [] │ If specified, this │
4621 │ │ │ │ connection will never │
4622 │ │ │ │ apply to the Ethernet │
4623 │ │ │ │ device whose permanent │
4624 │ │ │ │ MAC address matches an │
4625 │ │ │ │ address in the list. │
4626 │ │ │ │ Each MAC address is in │
4627 │ │ │ │ the standard │
4628 │ │ │ │ hex-digits-and-colons │
4629 │ │ │ │ notation │
4630 │ │ │ │ (00:11:22:33:44:55). │
4631 ├──────────────────────────┼─────────────────┼────────────────┼────────────────────────────────────────┤
4632 │mtu │ uint32 │ 0 │ If non-zero, only │
4633 │ │ │ │ transmit packets of │
4634 │ │ │ │ the specified size or │
4635 │ │ │ │ smaller, breaking │
4636 │ │ │ │ larger packets up into │
4637 │ │ │ │ multiple Ethernet │
4638 │ │ │ │ frames. │
4639 ├──────────────────────────┼─────────────────┼────────────────┼────────────────────────────────────────┤
4640 │name │ string │ 802-3-ethernet │ The setting's name, │
4641 │ │ │ │ which uniquely │
4642 │ │ │ │ identifies the setting │
4643 │ │ │ │ within the connection. │
4644 │ │ │ │ Each setting type has │
4645 │ │ │ │ a name unique to that │
4646 │ │ │ │ type, for example │
4647 │ │ │ │ "ppp" or "wireless" or │
4648 │ │ │ │ "wired". │
4649 ├──────────────────────────┼─────────────────┼────────────────┼────────────────────────────────────────┤
4650 │port │ string │ │ Specific port type to │
4651 │ │ │ │ use if the device │
4652 │ │ │ │ supports multiple │
4653 │ │ │ │ attachment methods. │
4654 │ │ │ │ One of "tp" (Twisted │
4655 │ │ │ │ Pair), "aui" │
4656 │ │ │ │ (Attachment Unit │
4657 │ │ │ │ Interface), "bnc" │
4658 │ │ │ │ (Thin Ethernet) or │
4659 │ │ │ │ "mii" (Media │
4660 │ │ │ │ Independent │
4661 │ │ │ │ Interface). If the │
4662 │ │ │ │ device supports only │
4663 │ │ │ │ one port type, this │
4664 │ │ │ │ setting is ignored. │
4665 ├──────────────────────────┼─────────────────┼────────────────┼────────────────────────────────────────┤
4666 │s390-nettype │ string │ │ s390 network device │
4667 │ │ │ │ type; one of "qeth", │
4668 │ │ │ │ "lcs", or "ctc", │
4669 │ │ │ │ representing the │
4670 │ │ │ │ different types of │
4671 │ │ │ │ virtual network │
4672 │ │ │ │ devices available on │
4673 │ │ │ │ s390 systems. │
4674 ├──────────────────────────┼─────────────────┼────────────────┼────────────────────────────────────────┤
4675 │s390-options │ dict of string │ {} │ Dictionary of │
4676 │ │ to string │ │ key/value pairs of │
4677 │ │ │ │ s390-specific device │
4678 │ │ │ │ options. Both keys │
4679 │ │ │ │ and values must be │
4680 │ │ │ │ strings. Allowed keys │
4681 │ │ │ │ include "portno", │
4682 │ │ │ │ "layer2", "portname", │
4683 │ │ │ │ "protocol", among │
4684 │ │ │ │ others. Key names │
4685 │ │ │ │ must contain only │
4686 │ │ │ │ alphanumeric │
4687 │ │ │ │ characters (ie, │
4688 │ │ │ │ [a-zA-Z0-9]). │
4689 ├──────────────────────────┼─────────────────┼────────────────┼────────────────────────────────────────┤
4690 │s390-subchannels │ array of string │ [] │ Identifies specific │
4691 │ │ │ │ subchannels that this │
4692 │ │ │ │ network device uses │
4693 │ │ │ │ for communication with │
4694 │ │ │ │ z/VM or s390 host. │
4695 │ │ │ │ Like the "mac-address" │
4696 │ │ │ │ property for non-z/VM │
4697 │ │ │ │ devices, this property │
4698 │ │ │ │ can be used to ensure │
4699 │ │ │ │ this connection only │
4700 │ │ │ │ applies to the network │
4701 │ │ │ │ device that uses these │
4702 │ │ │ │ subchannels. The list │
4703 │ │ │ │ should contain exactly │
4704 │ │ │ │ 3 strings, and each │
4705 │ │ │ │ string may only be │
4706 │ │ │ │ composed of │
4707 │ │ │ │ hexadecimal characters │
4708 │ │ │ │ and the period (.) │
4709 │ │ │ │ character. │
4710 ├──────────────────────────┼─────────────────┼────────────────┼────────────────────────────────────────┤
4711 │speed │ uint32 │ 0 │ When a value grater │
4712 │ │ │ │ than 0 is set, │
4713 │ │ │ │ configures the device │
4714 │ │ │ │ to use the specified │
4715 │ │ │ │ speed. If │
4716 │ │ │ │ "auto-negotiate" is │
4717 │ │ │ │ "yes" the specified │
4718 │ │ │ │ speed will be the only │
4719 │ │ │ │ one advertised during │
4720 │ │ │ │ link negotiation: this │
4721 │ │ │ │ works only for BASE-T │
4722 │ │ │ │ 802.3 specifications │
4723 │ │ │ │ and is useful for │
4724 │ │ │ │ enforcing gigabit │
4725 │ │ │ │ speeds, as in this │
4726 │ │ │ │ case link negotiation │
4727 │ │ │ │ is mandatory. If the │
4728 │ │ │ │ value is unset (0, the │
4729 │ │ │ │ default), the link │
4730 │ │ │ │ configuration will be │
4731 │ │ │ │ either skipped (if │
4732 │ │ │ │ "auto-negotiate" is │
4733 │ │ │ │ "no", the default) or │
4734 │ │ │ │ will be │
4735 │ │ │ │ auto-negotiated (if │
4736 │ │ │ │ "auto-negotiate" is │
4737 │ │ │ │ "yes") and the local │
4738 │ │ │ │ device will advertise │
4739 │ │ │ │ all the supported │
4740 │ │ │ │ speeds. In Mbit/s, ie │
4741 │ │ │ │ 100 == 100Mbit/s. Must │
4742 │ │ │ │ be set together with │
4743 │ │ │ │ the "duplex" property │
4744 │ │ │ │ when non-zero. Before │
4745 │ │ │ │ specifying a speed │
4746 │ │ │ │ value be sure your │
4747 │ │ │ │ device supports it. │
4748 ├──────────────────────────┼─────────────────┼────────────────┼────────────────────────────────────────┤
4749 │wake-on-lan │ uint32 │ 1 │ The │
4750 │ │ │ │ NMSettingWiredWakeOnLan │
4751 │ │ │ │ options to enable. Not │
4752 │ │ │ │ all devices support │
4753 │ │ │ │ all options. May be │
4754 │ │ │ │ any combination of │
4755 │ │ │ │ NM_SETTING_WIRED_WAKE_ON_LAN_PHY │
4756 │ │ │ │ (0x2), │
4757 │ │ │ │ NM_SETTING_WIRED_WAKE_ON_LAN_UNICAST │
4758 │ │ │ │ (0x4), │
4759 │ │ │ │ NM_SETTING_WIRED_WAKE_ON_LAN_MULTICAST │
4760 │ │ │ │ (0x8), │
4761 │ │ │ │ NM_SETTING_WIRED_WAKE_ON_LAN_BROADCAST │
4762 │ │ │ │ (0x10), │
4763 │ │ │ │ NM_SETTING_WIRED_WAKE_ON_LAN_ARP │
4764 │ │ │ │ (0x20), │
4765 │ │ │ │ NM_SETTING_WIRED_WAKE_ON_LAN_MAGIC │
4766 │ │ │ │ (0x40) or the special │
4767 │ │ │ │ values │
4768 │ │ │ │ NM_SETTING_WIRED_WAKE_ON_LAN_DEFAULT │
4769 │ │ │ │ (0x1) (to use global │
4770 │ │ │ │ settings) and │
4771 │ │ │ │ NM_SETTING_WIRED_WAKE_ON_LAN_IGNORE │
4772 │ │ │ │ (0x8000) (to disable │
4773 │ │ │ │ management of │
4774 │ │ │ │ Wake-on-LAN in │
4775 │ │ │ │ NetworkManager). │
4776 ├──────────────────────────┼─────────────────┼────────────────┼────────────────────────────────────────┤
4777 │wake-on-lan-password │ string │ │ If specified, the password used with │
4778 │ │ │ │ magic-packet-based Wake-on-LAN, │
4779 │ │ │ │ represented as an Ethernet MAC │
4780 │ │ │ │ address. If NULL, no password will be │
4781 │ │ │ │ required. │
4782 └──────────────────────────┴─────────────────┴────────────────┴────────────────────────────────────────┘
4783 802-11-wireless setting
4785 Wi-Fi Settings.
4786 ┌──────────────────────────┬─────────────────┬─────────────────┬───────────────────────────────────────────────────────┐
4788 │Key Name │ Value Type │ Default Value │ Value │
4789 │ │ │ │ Description │
4790 ├──────────────────────────┼─────────────────┼─────────────────┼───────────────────────────────────────────────────────┤
4791 │assigned-mac-address │ string │ │ The new field │
4792 │ │ │ │ for the cloned │
4793 │ │ │ │ MAC address. It │
4794 │ │ │ │ can be either a │
4795 │ │ │ │ hardware address │
4796 │ │ │ │ in ASCII │
4797 │ │ │ │ representation, │
4798 │ │ │ │ or one of the │
4799 │ │ │ │ special values │
4800 │ │ │ │ "preserve", │
4801 │ │ │ │ "permanent", │
4802 │ │ │ │ "random" or │
4803 │ │ │ │ "stable". This │
4804 │ │ │ │ field replaces │
4805 │ │ │ │ the deprecated │
4806 │ │ │ │ "cloned-mac-address" │
4807 │ │ │ │ on D-Bus, which │
4808 │ │ │ │ can only contain │
4809 │ │ │ │ explict hardware │
4810 │ │ │ │ addresses. Note │
4811 │ │ │ │ that this │
4812 │ │ │ │ property only │
4813 │ │ │ │ exists in D-Bus │
4814 │ │ │ │ API. libnm and │
4815 │ │ │ │ nmcli continue │
4816 │ │ │ │ to call this │
4817 │ │ │ │ property │
4818 │ │ │ │ "cloned-mac-address". │
4819 ├──────────────────────────┼─────────────────┼─────────────────┼───────────────────────────────────────────────────────┤
4820 │band │ string │ │ 802.11 frequency band │
4821 │ │ │ │ of the network. One │
4822 │ │ │ │ of "a" for 5GHz │
4823 │ │ │ │ 802.11a or "bg" for │
4824 │ │ │ │ 2.4GHz 802.11. This │
4825 │ │ │ │ will lock │
4826 │ │ │ │ associations to the │
4827 │ │ │ │ Wi-Fi network to the │
4828 │ │ │ │ specific band, i.e. │
4829 │ │ │ │ if "a" is specified, │
4830 │ │ │ │ the device will not │
4831 │ │ │ │ associate with the │
4832 │ │ │ │ same network in the │
4833 │ │ │ │ 2.4GHz band even if │
4834 │ │ │ │ the network's │
4835 │ │ │ │ settings are │
4836 │ │ │ │ compatible. This │
4837 │ │ │ │ setting depends on │
4838 │ │ │ │ specific driver │
4839 │ │ │ │ capability and may │
4840 │ │ │ │ not work with all │
4841 │ │ │ │ drivers. │
4842 ├──────────────────────────┼─────────────────┼─────────────────┼───────────────────────────────────────────────────────┤
4843 │bssid │ byte array │ │ If specified, directs │
4844 │ │ │ │ the device to only │
4845 │ │ │ │ associate with the │
4846 │ │ │ │ given access point. │
4847 │ │ │ │ This capability is │
4848 │ │ │ │ highly driver │
4849 │ │ │ │ dependent and not │
4850 │ │ │ │ supported by all │
4851 │ │ │ │ devices. Note: this │
4852 │ │ │ │ property does not │
4853 │ │ │ │ control the BSSID │
4854 │ │ │ │ used when creating an │
4855 │ │ │ │ Ad-Hoc network and is │
4856 │ │ │ │ unlikely to in the │
4857 │ │ │ │ future. │
4858 ├──────────────────────────┼─────────────────┼─────────────────┼───────────────────────────────────────────────────────┤
4859 │channel │ uint32 │ 0 │ Wireless channel to │
4860 │ │ │ │ use for the Wi-Fi │
4861 │ │ │ │ connection. The │
4862 │ │ │ │ device will only join │
4863 │ │ │ │ (or create for Ad-Hoc │
4864 │ │ │ │ networks) a Wi-Fi │
4865 │ │ │ │ network on the │
4866 │ │ │ │ specified channel. │
4867 │ │ │ │ Because channel │
4868 │ │ │ │ numbers overlap │
4869 │ │ │ │ between bands, this │
4870 │ │ │ │ property also │
4871 │ │ │ │ requires the "band" │
4872 │ │ │ │ property to be set. │
4873 ├──────────────────────────┼─────────────────┼─────────────────┼───────────────────────────────────────────────────────┤
4874 │cloned-mac-address │ byte array │ │ This D-Bus field is │
4875 │ │ │ │ deprecated in favor │
4876 │ │ │ │ of │
4877 │ │ │ │ "assigned-mac-address" │
4878 │ │ │ │ which is more │
4879 │ │ │ │ flexible and allows │
4880 │ │ │ │ specifying special │
4881 │ │ │ │ variants like │
4882 │ │ │ │ "random". For libnm │
4883 │ │ │ │ and nmcli, this field │
4884 │ │ │ │ is called │
4885 │ │ │ │ "cloned-mac-address". │
4886 ├──────────────────────────┼─────────────────┼─────────────────┼───────────────────────────────────────────────────────┤
4887 │generate-mac-address-mask │ string │ │ With │
4888 │ │ │ │ "cloned-mac-address" │
4889 │ │ │ │ setting "random" or │
4890 │ │ │ │ "stable", by default │
4891 │ │ │ │ all bits of the MAC │
4892 │ │ │ │ address are scrambled │
4893 │ │ │ │ and a │
4894 │ │ │ │ locally-administered, │
4895 │ │ │ │ unicast MAC address is │
4896 │ │ │ │ created. This property │
4897 │ │ │ │ allows to specify that │
4898 │ │ │ │ certain bits are │
4899 │ │ │ │ fixed. Note that the │
4900 │ │ │ │ least significant bit │
4901 │ │ │ │ of the first MAC │
4902 │ │ │ │ address will always be │
4903 │ │ │ │ unset to create a │
4904 │ │ │ │ unicast MAC address. │
4905 │ │ │ │ If the property is │
4906 │ │ │ │ NULL, it is eligible │
4907 │ │ │ │ to be overwritten by a │
4908 │ │ │ │ default connection │
4909 │ │ │ │ setting. If the value │
4910 │ │ │ │ is still NULL or an │
4911 │ │ │ │ empty string, the │
4912 │ │ │ │ default is to create a │
4913 │ │ │ │ locally-administered, │
4914 │ │ │ │ unicast MAC address. │
4915 │ │ │ │ If the value contains │
4916 │ │ │ │ one MAC address, this │
4917 │ │ │ │ address is used as │
4918 │ │ │ │ mask. The set bits of │
4919 │ │ │ │ the mask are to be │
4920 │ │ │ │ filled with the │
4921 │ │ │ │ current MAC address of │
4922 │ │ │ │ the device, while the │
4923 │ │ │ │ unset bits are subject │
4924 │ │ │ │ to randomization. │
4925 │ │ │ │ Setting │
4926 │ │ │ │ "FE:FF:FF:00:00:00" │
4927 │ │ │ │ means to preserve the │
4928 │ │ │ │ OUI of the current MAC │
4929 │ │ │ │ address and only │
4930 │ │ │ │ randomize the lower 3 │
4931 │ │ │ │ bytes using the │
4932 │ │ │ │ "random" or "stable" │
4933 │ │ │ │ algorithm. If the │
4934 │ │ │ │ value contains one │
4935 │ │ │ │ additional MAC address │
4936 │ │ │ │ after the mask, this │
4937 │ │ │ │ address is used │
4938 │ │ │ │ instead of the current │
4939 │ │ │ │ MAC address to fill │
4940 │ │ │ │ the bits that shall │
4941 │ │ │ │ not be randomized. For │
4942 │ │ │ │ example, a value of │
4943 │ │ │ │ "FE:FF:FF:00:00:00 │
4944 │ │ │ │ 68:F7:28:00:00:00" │
4945 │ │ │ │ will set the OUI of │
4946 │ │ │ │ the MAC address to │
4947 │ │ │ │ 68:F7:28, while the │
4948 │ │ │ │ lower bits are │
4949 │ │ │ │ randomized. A value of │
4950 │ │ │ │ "02:00:00:00:00:00 │
4951 │ │ │ │ 00:00:00:00:00:00" │
4952 │ │ │ │ will create a fully │
4953 │ │ │ │ scrambled │
4954 │ │ │ │ globally-administered, │
4955 │ │ │ │ burned-in MAC address. │
4956 │ │ │ │ If the value contains │
4957 │ │ │ │ more than one │
4958 │ │ │ │ additional MAC │
4959 │ │ │ │ addresses, one of them │
4960 │ │ │ │ is chosen randomly. │
4961 │ │ │ │ For example, │
4962 │ │ │ │ "02:00:00:00:00:00 │
4963 │ │ │ │ 00:00:00:00:00:00 │
4964 │ │ │ │ 02:00:00:00:00:00" │
4965 │ │ │ │ will create a fully │
4966 │ │ │ │ scrambled MAC address, │
4967 │ │ │ │ randomly locally or │
4968 │ │ │ │ globally administered. │
4969 ├──────────────────────────┼─────────────────┼─────────────────┼───────────────────────────────────────────────────────┤
4970 │hidden │ boolean │ FALSE │ If TRUE, indicates │
4971 │ │ │ │ that the network is a │
4972 │ │ │ │ non-broadcasting │
4973 │ │ │ │ network that hides its │
4974 │ │ │ │ SSID. This works both │
4975 │ │ │ │ in infrastructure and │
4976 │ │ │ │ AP mode. In │
4977 │ │ │ │ infrastructure mode, │
4978 │ │ │ │ various workarounds │
4979 │ │ │ │ are used for a more │
4980 │ │ │ │ reliable discovery of │
4981 │ │ │ │ hidden networks, such │
4982 │ │ │ │ as probe-scanning the │
4983 │ │ │ │ SSID. However, these │
4984 │ │ │ │ workarounds expose │
4985 │ │ │ │ inherent insecurities │
4986 │ │ │ │ with hidden SSID │
4987 │ │ │ │ networks, and thus │
4988 │ │ │ │ hidden SSID networks │
4989 │ │ │ │ should be used with │
4990 │ │ │ │ caution. In AP mode, │
4991 │ │ │ │ the created network │
4992 │ │ │ │ does not broadcast its │
4993 │ │ │ │ SSID. Note that │
4994 │ │ │ │ marking the network as │
4995 │ │ │ │ hidden may be a │
4996 │ │ │ │ privacy issue for you │
4997 │ │ │ │ (in infrastructure │
4998 │ │ │ │ mode) or client │
4999 │ │ │ │ stations (in AP mode), │
5000 │ │ │ │ as the explicit │
5001 │ │ │ │ probe-scans are │
5002 │ │ │ │ distinctly │
5003 │ │ │ │ recognizable on the │
5004 │ │ │ │ air. │
5005 ├──────────────────────────┼─────────────────┼─────────────────┼───────────────────────────────────────────────────────┤
5006 │mac-address │ byte array │ │ If specified, this │
5007 │ │ │ │ connection will only │
5008 │ │ │ │ apply to the Wi-Fi │
5009 │ │ │ │ device whose permanent │
5010 │ │ │ │ MAC address matches. │
5011 │ │ │ │ This property does not │
5012 │ │ │ │ change the MAC address │
5013 │ │ │ │ of the device (i.e. │
5014 │ │ │ │ MAC spoofing). │
5015 ├──────────────────────────┼─────────────────┼─────────────────┼───────────────────────────────────────────────────────┤
5016 │mac-address-blacklist │ array of string │ [] │ A list of permanent │
5017 │ │ │ │ MAC addresses of Wi-Fi │
5018 │ │ │ │ devices to which this │
5019 │ │ │ │ connection should │
5020 │ │ │ │ never apply. Each MAC │
5021 │ │ │ │ address should be │
5022 │ │ │ │ given in the standard │
5023 │ │ │ │ hex-digits-and-colons │
5024 │ │ │ │ notation (eg │
5025 │ │ │ │ "00:11:22:33:44:55"). │
5026 ├──────────────────────────┼─────────────────┼─────────────────┼───────────────────────────────────────────────────────┤
5027 │mac-address-randomization │ uint32 │ 0 │ One of │
5028 │ │ │ │ NM_SETTING_MAC_RANDOMIZATION_DEFAULT │
5029 │ │ │ │ (0) (never randomize │
5030 │ │ │ │ unless the user has │
5031 │ │ │ │ set a global default │
5032 │ │ │ │ to randomize and the │
5033 │ │ │ │ supplicant supports │
5034 │ │ │ │ randomization), │
5035 │ │ │ │ NM_SETTING_MAC_RANDOMIZATION_NEVER │
5036 │ │ │ │ (1) (never randomize │
5037 │ │ │ │ the MAC address), or │
5038 │ │ │ │ NM_SETTING_MAC_RANDOMIZATION_ALWAYS │
5039 │ │ │ │ (2) (always randomize │
5040 │ │ │ │ the MAC address). This │
5041 │ │ │ │ property is deprecated │
5042 │ │ │ │ for │
5043 │ │ │ │ 'cloned-mac-address'. │
5044 │ │ │ │ Deprecated: 1 │
5045 ├──────────────────────────┼─────────────────┼─────────────────┼───────────────────────────────────────────────────────┤
5046 │mode │ string │ │ Wi-Fi network mode; one of │
5047 │ │ │ │ "infrastructure", "adhoc" or "ap". │
5048 │ │ │ │ If blank, infrastructure is assumed. │
5049 ├──────────────────────────┼─────────────────┼─────────────────┼───────────────────────────────────────────────────────┤
5050 │mtu │ uint32 │ 0 │ If non-zero, only transmit packets │
5051 │ │ │ │ of the specified size or smaller, │
5052 │ │ │ │ breaking larger packets up into │
5053 │ │ │ │ multiple Ethernet frames. │
5054 ├──────────────────────────┼─────────────────┼─────────────────┼───────────────────────────────────────────────────────┤
5055 │name │ string │ 802-11-wireless │ The setting's name, which uniquely │
5056 │ │ │ │ identifies the setting within the │
5057 │ │ │ │ connection. Each setting type has a │
5058 │ │ │ │ name unique to that type, for │
5059 │ │ │ │ example "ppp" or "wireless" or │
5060 │ │ │ │ "wired". │
5061 ├──────────────────────────┼─────────────────┼─────────────────┼───────────────────────────────────────────────────────┤
5062 │powersave │ uint32 │ 0 │ One of │
5063 │ │ │ │ NM_SETTING_WIRELESS_POWERSAVE_DISABLE │
5064 │ │ │ │ (2) (disable Wi-Fi power saving), │
5065 │ │ │ │ NM_SETTING_WIRELESS_POWERSAVE_ENABLE │
5066 │ │ │ │ (3) (enable Wi-Fi power saving), │
5067 │ │ │ │ NM_SETTING_WIRELESS_POWERSAVE_IGNORE │
5068 │ │ │ │ (1) (don't touch currently configure │
5069 │ │ │ │ setting) or │
5070 │ │ │ │ NM_SETTING_WIRELESS_POWERSAVE_DEFAULT │
5071 │ │ │ │ (0) (use the globally configured │
5072 │ │ │ │ value). All other values are │
5073 │ │ │ │ reserved. │
5074 ├──────────────────────────┼─────────────────┼─────────────────┼───────────────────────────────────────────────────────┤
5075 │rate │ uint32 │ 0 │ If non-zero, directs the device to │
5076 │ │ │ │ only use the specified bitrate for │
5077 │ │ │ │ communication with the access point. │
5078 │ │ │ │ Units are in Kb/s, ie 5500 = 5.5 │
5079 │ │ │ │ Mbit/s. This property is highly │
5080 │ │ │ │ driver dependent and not all devices │
5081 │ │ │ │ support setting a static bitrate. │
5082 ├──────────────────────────┼─────────────────┼─────────────────┼───────────────────────────────────────────────────────┤
5083 │security │ None │ │ This property is deprecated, but can │
5084 │ │ │ │ be set to the value │
5085 │ │ │ │ '802-11-wireless-security' when a │
5086 │ │ │ │ wireless security setting is also │
5087 │ │ │ │ present in the connection dictionary, │
5088 │ │ │ │ for compatibility with very old │
5089 │ │ │ │ NetworkManager daemons. │
5090 ├──────────────────────────┼─────────────────┼─────────────────┼───────────────────────────────────────────────────────┤
5091 │seen-bssids │ array of string │ [] │ A list of BSSIDs (each BSSID │
5092 │ │ │ │ formatted as a MAC address like │
5093 │ │ │ │ "00:11:22:33:44:55") that have been │
5094 │ │ │ │ detected as part of the Wi-Fi │
5095 │ │ │ │ network. NetworkManager internally │
5096 │ │ │ │ tracks previously seen BSSIDs. The │
5097 │ │ │ │ property is only meant for reading │
5098 │ │ │ │ and reflects the BSSID list of │
5099 │ │ │ │ NetworkManager. The changes you make │
5100 │ │ │ │ to this property will not be │
5101 │ │ │ │ preserved. │
5102 ├──────────────────────────┼─────────────────┼─────────────────┼───────────────────────────────────────────────────────┤
5103 │ssid │ byte array │ │ SSID of the Wi-Fi network. Must be │
5104 │ │ │ │ specified. │
5105 ├──────────────────────────┼─────────────────┼─────────────────┼───────────────────────────────────────────────────────┤
5106 │tx-power │ uint32 │ 0 │ If non-zero, directs the device to │
5107 │ │ │ │ use the specified transmit power. │
5108 │ │ │ │ Units are dBm. This property is │
5109 │ │ │ │ highly driver dependent and not all │
5110 │ │ │ │ devices support setting a static │
5111 │ │ │ │ transmit power. │
5112 ├──────────────────────────┼─────────────────┼─────────────────┼───────────────────────────────────────────────────────┤
5113 │wake-on-wlan │ uint32 │ 1 │ The NMSettingWirelessWakeOnWLan │
5114 │ │ │ │ options to enable. Not all devices │
5115 │ │ │ │ support all options. May be any │
5116 │ │ │ │ combination of │
5117 │ │ │ │ NM_SETTING_WIRELESS_WAKE_ON_WLAN_ANY │
5118 │ │ │ │ (0x2), │
5119 │ │ │ │ NM_SETTING_WIRELESS_WAKE_ON_WLAN_DISCONNECT │
5120 │ │ │ │ (0x4), │
5121 │ │ │ │ NM_SETTING_WIRELESS_WAKE_ON_WLAN_MAGIC │
5122 │ │ │ │ (0x8), │
5123 │ │ │ │ NM_SETTING_WIRELESS_WAKE_ON_WLAN_GTK_REKEY_FAILURE │
5124 │ │ │ │ (0x10), │
5125 │ │ │ │ NM_SETTING_WIRELESS_WAKE_ON_WLAN_EAP_IDENTITY_REQUEST │
5126 │ │ │ │ (0x20), │
5127 │ │ │ │ NM_SETTING_WIRELESS_WAKE_ON_WLAN_4WAY_HANDSHAKE │
5128 │ │ │ │ (0x40), │
5129 │ │ │ │ NM_SETTING_WIRELESS_WAKE_ON_WLAN_RFKILL_RELEASE │
5130 │ │ │ │ (0x80), │
5131 │ │ │ │ NM_SETTING_WIRELESS_WAKE_ON_WLAN_TCP │
5132 │ │ │ │ (0x100) or the special values │
5133 │ │ │ │ NM_SETTING_WIRELESS_WAKE_ON_WLAN_DEFAULT │
5134 │ │ │ │ (0x1) (to use global settings) and │
5135 │ │ │ │ NM_SETTING_WIRELESS_WAKE_ON_WLAN_IGNORE │
5136 │ │ │ │ (0x8000) (to disable management of │
5137 │ │ │ │ Wake-on-LAN in NetworkManager). │
5138 └──────────────────────────┴─────────────────┴─────────────────┴───────────────────────────────────────────────────────┘
5139 802-11-wireless-security setting
5141 Wi-Fi Security Settings.
5142 ┌────────────────────┬──────────────────────┬──────────────────────────┬────────────────────────────────────────────┐
5144 │Key Name │ Value Type │ Default Value │ Value │
5145 │ │ │ │ Description │
5146 ├────────────────────┼──────────────────────┼──────────────────────────┼────────────────────────────────────────────┤
5147 │auth-alg │ string │ │ When WEP is used │
5148 │ │ │ │ (ie, key-mgmt = │
5149 │ │ │ │ "none" or │
5150 │ │ │ │ "ieee8021x") │
5151 │ │ │ │ indicate the │
5152 │ │ │ │ 802.11 │
5153 │ │ │ │ authentication │
5154 │ │ │ │ algorithm │
5155 │ │ │ │ required by the │
5156 │ │ │ │ AP here. One of │
5157 │ │ │ │ "open" for Open │
5158 │ │ │ │ System, "shared" │
5159 │ │ │ │ for Shared Key, │
5160 │ │ │ │ or "leap" for │
5161 │ │ │ │ Cisco LEAP. │
5162 │ │ │ │ When using Cisco │
5163 │ │ │ │ LEAP (ie, │
5164 │ │ │ │ key-mgmt = │
5165 │ │ │ │ "ieee8021x" and │
5166 │ │ │ │ auth-alg = │
5167 │ │ │ │ "leap") the │
5168 │ │ │ │ "leap-username" │
5169 │ │ │ │ and │
5170 │ │ │ │ "leap-password" │
5171 │ │ │ │ properties must │
5172 │ │ │ │ be specified. │
5173 ├────────────────────┼──────────────────────┼──────────────────────────┼────────────────────────────────────────────┤
5174 │fils │ int32 │ 0 │ Indicates │
5175 │ │ │ │ whether Fast │
5176 │ │ │ │ Initial Link │
5177 │ │ │ │ Setup (802.11ai) │
5178 │ │ │ │ must be enabled │
5179 │ │ │ │ for the │
5180 │ │ │ │ connection. One │
5181 │ │ │ │ of │
5182 │ │ │ │ NM_SETTING_WIRELESS_SECURITY_FILS_DEFAULT │
5183 │ │ │ │ (0) (use global │
5184 │ │ │ │ default value), │
5185 │ │ │ │ NM_SETTING_WIRELESS_SECURITY_FILS_DISABLE │
5186 │ │ │ │ (1) (disable │
5187 │ │ │ │ FILS), │
5188 │ │ │ │ NM_SETTING_WIRELESS_SECURITY_FILS_OPTIONAL │
5189 │ │ │ │ (2) (enable FILS │
5190 │ │ │ │ if the │
5191 │ │ │ │ supplicant and │
5192 │ │ │ │ the access point │
5193 │ │ │ │ support it) or │
5194 │ │ │ │ NM_SETTING_WIRELESS_SECURITY_FILS_REQUIRED │
5195 │ │ │ │ (3) (enable FILS │
5196 │ │ │ │ and fail if not │
5197 │ │ │ │ supported). │
5198 │ │ │ │ When set to │
5199 │ │ │ │ NM_SETTING_WIRELESS_SECURITY_FILS_DEFAULT │
5200 │ │ │ │ (0) and no │
5201 │ │ │ │ global default │
5202 │ │ │ │ is set, FILS │
5203 │ │ │ │ will be │
5204 │ │ │ │ optionally │
5205 │ │ │ │ enabled. │
5206 ├────────────────────┼──────────────────────┼──────────────────────────┼────────────────────────────────────────────┤
5207 │group │ array of string │ [] │ A list of group/broadcast encryption │
5208 │ │ │ │ algorithms which prevents connections to │
5209 │ │ │ │ Wi-Fi networks that do not utilize one of │
5210 │ │ │ │ the algorithms in the list. For maximum │
5211 │ │ │ │ compatibility leave this property empty. │
5212 │ │ │ │ Each list element may be one of "wep40", │
5213 │ │ │ │ "wep104", "tkip", or "ccmp". │
5214 ├────────────────────┼──────────────────────┼──────────────────────────┼────────────────────────────────────────────┤
5215 │key-mgmt │ string │ │ Key management used for the connection. │
5216 │ │ │ │ One of "none" (WEP), "ieee8021x" (Dynamic │
5217 │ │ │ │ WEP), "wpa-none" (Ad-Hoc WPA-PSK), │
5218 │ │ │ │ "wpa-psk" (infrastructure WPA-PSK), or │
5219 │ │ │ │ "wpa-eap" (WPA-Enterprise). This property │
5220 │ │ │ │ must be set for any Wi-Fi connection that │
5221 │ │ │ │ uses security. │
5222 ├────────────────────┼──────────────────────┼──────────────────────────┼────────────────────────────────────────────┤
5223 │leap-password │ string │ │ The login password for legacy LEAP │
5224 │ │ │ │ connections (ie, key-mgmt = "ieee8021x" │
5225 │ │ │ │ and auth-alg = "leap"). │
5226 ├────────────────────┼──────────────────────┼──────────────────────────┼────────────────────────────────────────────┤
5227 │leap-password-flags │ NMSettingSecretFlags │ │ Flags indicating how to handle the │
5228 │ │ (uint32) │ │ "leap-password" property. (see the section │
5229 │ │ │ │ called “Secret flag types:” for flag │
5230 │ │ │ │ values) │
5231 ├────────────────────┼──────────────────────┼──────────────────────────┼────────────────────────────────────────────┤
5232 │leap-username │ string │ │ The login username for legacy LEAP │
5233 │ │ │ │ connections (ie, key-mgmt = "ieee8021x" │
5234 │ │ │ │ and auth-alg = "leap"). │
5235 ├────────────────────┼──────────────────────┼──────────────────────────┼────────────────────────────────────────────┤
5236 │name │ string │ 802-11-wireless-security │ The setting's name, which uniquely │
5237 │ │ │ │ identifies the setting within the │
5238 │ │ │ │ connection. Each setting type has a name │
5239 │ │ │ │ unique to that type, for example "ppp" or │
5240 │ │ │ │ "wireless" or "wired". │
5241 ├────────────────────┼──────────────────────┼──────────────────────────┼────────────────────────────────────────────┤
5242 │pairwise │ array of string │ [] │ A list of pairwise encryption algorithms │
5243 │ │ │ │ which prevents connections to Wi-Fi │
5244 │ │ │ │ networks that do not utilize one of the │
5245 │ │ │ │ algorithms in the list. For maximum │
5246 │ │ │ │ compatibility leave this property empty. │
5247 │ │ │ │ Each list element may be one of "tkip" or │
5248 │ │ │ │ "ccmp". │
5249 ├────────────────────┼──────────────────────┼──────────────────────────┼────────────────────────────────────────────┤
5250 │pmf │ int32 │ 0 │ Indicates whether Protected Management │
5251 │ │ │ │ Frames (802.11w) must be enabled for the │
5252 │ │ │ │ connection. One of │
5253 │ │ │ │ NM_SETTING_WIRELESS_SECURITY_PMF_DEFAULT │
5254 │ │ │ │ (0) (use global default value), │
5255 │ │ │ │ NM_SETTING_WIRELESS_SECURITY_PMF_DISABLE │
5256 │ │ │ │ (1) (disable PMF), │
5257 │ │ │ │ NM_SETTING_WIRELESS_SECURITY_PMF_OPTIONAL │
5258 │ │ │ │ (2) (enable PMF if the supplicant and the │
5259 │ │ │ │ access point support it) or │
5260 │ │ │ │ NM_SETTING_WIRELESS_SECURITY_PMF_REQUIRED │
5261 │ │ │ │ (3) (enable PMF and fail if not │
5262 │ │ │ │ supported). When set to │
5263 │ │ │ │ NM_SETTING_WIRELESS_SECURITY_PMF_DEFAULT │
5264 │ │ │ │ (0) and no global default is set, PMF will │
5265 │ │ │ │ be optionally enabled. │
5266 ├────────────────────┼──────────────────────┼──────────────────────────┼────────────────────────────────────────────┤
5267 │proto │ array of string │ [] │ List of strings specifying the allowed WPA │
5268 │ │ │ │ protocol versions to use. Each element may │
5269 │ │ │ │ be one "wpa" (allow WPA) or "rsn" (allow │
5270 │ │ │ │ WPA2/RSN). If not specified, both WPA and │
5271 │ │ │ │ RSN connections are allowed. │
5272 ├────────────────────┼──────────────────────┼──────────────────────────┼────────────────────────────────────────────┤
5273 │psk │ string │ │ Pre-Shared-Key for WPA networks. If the │
5274 │ │ │ │ key is 64-characters long, it must contain │
5275 │ │ │ │ only hexadecimal characters and is │
5276 │ │ │ │ interpreted as a hexadecimal WPA key. │
5277 │ │ │ │ Otherwise, the key must be between 8 and │
5278 │ │ │ │ 63 ASCII characters (as specified in the │
5279 │ │ │ │ 802.11i standard) and is interpreted as a │
5280 │ │ │ │ WPA passphrase, and is hashed to derive │
5281 │ │ │ │ the actual WPA-PSK used when connecting to │
5282 │ │ │ │ the Wi-Fi network. │
5283 ├────────────────────┼──────────────────────┼──────────────────────────┼────────────────────────────────────────────┤
5284 │psk-flags │ NMSettingSecretFlags │ │ Flags indicating how to handle the "psk" │
5285 │ │ (uint32) │ │ property. (see the section called “Secret │
5286 │ │ │ │ flag types:” for flag values) │
5287 ├────────────────────┼──────────────────────┼──────────────────────────┼────────────────────────────────────────────┤
5288 │wep-key-flags │ NMSettingSecretFlags │ │ Flags indicating how to handle the │
5289 │ │ (uint32) │ │ "wep-key0", "wep-key1", "wep-key2", and │
5290 │ │ │ │ "wep-key3" properties. (see the section │
5291 │ │ │ │ called “Secret flag types:” for flag │
5292 │ │ │ │ values) │
5293 ├────────────────────┼──────────────────────┼──────────────────────────┼────────────────────────────────────────────┤
5294 │wep-key-type │ NMWepKeyType │ │ Controls the interpretation of WEP keys. │
5295 │ │ (uint32) │ │ Allowed values are NM_WEP_KEY_TYPE_KEY │
5296 │ │ │ │ (1), in which case the key is either a 10- │
5297 │ │ │ │ or 26-character hexadecimal string, or a │
5298 │ │ │ │ 5- or 13-character ASCII password; or │
5299 │ │ │ │ NM_WEP_KEY_TYPE_PASSPHRASE (2), in which │
5300 │ │ │ │ case the passphrase is provided as a │
5301 │ │ │ │ string and will be hashed using the │
5302 │ │ │ │ de-facto MD5 method to derive the actual │
5303 │ │ │ │ WEP key. │
5304 ├────────────────────┼──────────────────────┼──────────────────────────┼────────────────────────────────────────────┤
5305 │wep-key0 │ string │ │ Index 0 WEP key. This is the WEP key used │
5306 │ │ │ │ in most networks. See the "wep-key-type" │
5307 │ │ │ │ property for a description of how this key │
5308 │ │ │ │ is interpreted. │
5309 ├────────────────────┼──────────────────────┼──────────────────────────┼────────────────────────────────────────────┤
5310 │wep-key1 │ string │ │ Index 1 WEP key. This WEP index is not │
5311 │ │ │ │ used by most networks. See the │
5312 │ │ │ │ "wep-key-type" property for a description │
5313 │ │ │ │ of how this key is interpreted. │
5314 ├────────────────────┼──────────────────────┼──────────────────────────┼────────────────────────────────────────────┤
5315 │wep-key2 │ string │ │ Index 2 WEP key. This WEP index is not │
5316 │ │ │ │ used by most networks. See the │
5317 │ │ │ │ "wep-key-type" property for a description │
5318 │ │ │ │ of how this key is interpreted. │
5319 ├────────────────────┼──────────────────────┼──────────────────────────┼────────────────────────────────────────────┤
5320 │wep-key3 │ string │ │ Index 3 WEP key. This WEP index is not │
5321 │ │ │ │ used by most networks. See the │
5322 │ │ │ │ "wep-key-type" property for a description │
5323 │ │ │ │ of how this key is interpreted. │
5324 ├────────────────────┼──────────────────────┼──────────────────────────┼────────────────────────────────────────────┤
5325 │wep-tx-keyidx │ uint32 │ 0 │ When static WEP is used (ie, key-mgmt = │
5326 │ │ │ │ "none") and a non-default WEP key index is │
5327 │ │ │ │ used by the AP, put that WEP key index │
5328 │ │ │ │ here. Valid values are 0 (default key) │
5329 │ │ │ │ through 3. Note that some consumer access │
5330 │ │ │ │ points (like the Linksys WRT54G) number │
5331 │ │ │ │ the keys 1 - 4. │
5332 ├────────────────────┼──────────────────────┼──────────────────────────┼────────────────────────────────────────────┤
5333 │wps-method │ uint32 │ 0 │ Flags indicating which mode of WPS is to │
5334 │ │ │ │ be used if any. There's little point in │
5335 │ │ │ │ changing the default setting as │
5336 │ │ │ │ NetworkManager will automatically │
5337 │ │ │ │ determine whether it's feasible to start │
5338 │ │ │ │ WPS enrollment from the Access Point │
5339 │ │ │ │ capabilities. WPS can be disabled by │
5340 │ │ │ │ setting this property to a value of 1. │
5341 └────────────────────┴──────────────────────┴──────────────────────────┴────────────────────────────────────────────┘
5342 Secret flag types:
5344 Each password or secret property in a setting has an associated flags
5345 property that describes how to handle that secret. The flags property
5346 is a bitfield that contains zero or more of the following values
5347 logically OR-ed together.
5348 · 0x0 (none) - the system is responsible for providing and storing
5350 this secret. This may be required so that secrets are already
5351 available before the user logs in. It also commonly means that the
5352 secret will be stored in plain text on disk, accessible to root
5353 only. For example via the keyfile settings plugin as described in
5354 the "PLUGINS" section in NetworkManager.conf(5).
5355 · 0x1 (agent-owned) - a user-session secret agent is responsible for
5357 providing and storing this secret; when it is required, agents will
5358 be asked to provide it.
5359 · 0x2 (not-saved) - this secret should not be saved but should be
5361 requested from the user each time it is required. This flag should
5362 be used for One-Time-Pad secrets, PIN codes from hardware tokens,
5363 or if the user simply does not want to save the secret.
5364 · 0x4 (not-required) - in some situations it cannot be automatically
5366 determined that a secret is required or not. This flag hints that
5367 the secret is not required and should not be requested from the
5368 user.
5369
5371 /etc/NetworkManager/system-connections or distro plugin-specific
5372 location
5373
5375 NetworkManager(8), nmcli(1), nmcli-examples(7), NetworkManager.conf(5)
5376NetworkManager 1.12.6 NM-SETTINGS(5)