1NM-SETTINGS-DBUS(5) Configuration NM-SETTINGS-DBUS(5)
2
6 nm-settings-dbus - Description of settings and properties of
7 NetworkManager connection profiles on the D-Bus API
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 │ │ │ │ │
70 │ │ │ │ Currently, this │
71 │ │ │ │ only applies to │
72 │ │ │ │ 802-1x │
73 │ │ │ │ authentication. │
74 ├──────────────────────┼──────────────────────────────────────┼───────────────┼────────────────────────────────────────┤
75 │autoconnect │ boolean │ TRUE │ Whether or not │
76 │ │ │ │ the connection │
77 │ │ │ │ should be │
78 │ │ │ │ automatically │
79 │ │ │ │ connected by │
80 │ │ │ │ NetworkManager │
81 │ │ │ │ when the │
82 │ │ │ │ resources for │
83 │ │ │ │ the connection │
84 │ │ │ │ are available. │
85 │ │ │ │ TRUE to │
86 │ │ │ │ automatically │
87 │ │ │ │ activate the │
88 │ │ │ │ connection, │
89 │ │ │ │ FALSE to require │
90 │ │ │ │ manual │
91 │ │ │ │ intervention to │
92 │ │ │ │ activate the │
93 │ │ │ │ connection. │
94 │ │ │ │ │
95 │ │ │ │ Autoconnect │
96 │ │ │ │ happens when the │
97 │ │ │ │ circumstances │
98 │ │ │ │ are suitable. │
99 │ │ │ │ That means for │
100 │ │ │ │ example that the │
101 │ │ │ │ device is │
102 │ │ │ │ currently │
103 │ │ │ │ managed and not │
104 │ │ │ │ active. │
105 │ │ │ │ Autoconnect thus │
106 │ │ │ │ never replaces │
107 │ │ │ │ or competes with │
108 │ │ │ │ an already │
109 │ │ │ │ active profile. │
110 │ │ │ │ │
111 │ │ │ │ Note that │
112 │ │ │ │ autoconnect is │
113 │ │ │ │ not implemented │
114 │ │ │ │ for VPN │
115 │ │ │ │ profiles. See │
116 │ │ │ │ "secondaries" as │
117 │ │ │ │ an alternative │
118 │ │ │ │ to automatically │
119 │ │ │ │ connect VPN │
120 │ │ │ │ profiles. │
121 │ │ │ │ │
122 │ │ │ │ If multiple │
123 │ │ │ │ profiles are │
124 │ │ │ │ ready to │
125 │ │ │ │ autoconnect on │
126 │ │ │ │ the same device, │
127 │ │ │ │ the one with the │
128 │ │ │ │ better │
129 │ │ │ │ "connection.autoconnect-priority" │
130 │ │ │ │ is chosen. If │
131 │ │ │ │ the priorities │
132 │ │ │ │ are equal, then │
133 │ │ │ │ the most │
134 │ │ │ │ recently │
135 │ │ │ │ connected │
136 │ │ │ │ profile is │
137 │ │ │ │ activated. If │
138 │ │ │ │ the profiles │
139 │ │ │ │ were not │
140 │ │ │ │ connected │
141 │ │ │ │ earlier or their │
142 │ │ │ │ "connection.timestamp" │
143 │ │ │ │ is identical, │
144 │ │ │ │ the choice is │
145 │ │ │ │ undefined. │
146 │ │ │ │ │
147 │ │ │ │ Depending on │
148 │ │ │ │ "connection.multi-connect", │
149 │ │ │ │ a profile can │
150 │ │ │ │ (auto)connect │
151 │ │ │ │ only once at a │
152 │ │ │ │ time or multiple │
153 │ │ │ │ times. │
154 ├──────────────────────┼──────────────────────────────────────┼───────────────┼────────────────────────────────────────┤
155 │autoconnect-priority │ int32 │ 0 │ The autoconnect priority in range │
156 │ │ │ │ -999 to 999. If the connection is │
157 │ │ │ │ set to autoconnect, connections │
158 │ │ │ │ with higher priority will be │
159 │ │ │ │ preferred. The higher number │
160 │ │ │ │ means higher priority. Defaults │
161 │ │ │ │ to 0. Note that this property │
162 │ │ │ │ only matters if there are more │
163 │ │ │ │ than one candidate profile to │
164 │ │ │ │ select for autoconnect. In case │
165 │ │ │ │ of equal priority, the profile │
166 │ │ │ │ used most recently is chosen. │
167 ├──────────────────────┼──────────────────────────────────────┼───────────────┼────────────────────────────────────────┤
168 │autoconnect-retries │ int32 │ -1 │ The number of times a connection │
169 │ │ │ │ should be tried when │
170 │ │ │ │ autoactivating before giving up. │
171 │ │ │ │ Zero means forever, -1 means the │
172 │ │ │ │ global default (4 times if not │
173 │ │ │ │ overridden). Setting this to 1 │
174 │ │ │ │ means to try activation only once │
175 │ │ │ │ before blocking autoconnect. Note │
176 │ │ │ │ that after a timeout, │
177 │ │ │ │ NetworkManager will try to │
178 │ │ │ │ autoconnect again. │
179 ├──────────────────────┼──────────────────────────────────────┼───────────────┼────────────────────────────────────────┤
180 │autoconnect-slaves │ NMSettingConnectionAutoconnectSlaves │ │ Whether or not slaves of this │
181 │ │ (int32) │ │ connection should be │
182 │ │ │ │ automatically brought up when │
183 │ │ │ │ NetworkManager activates this │
184 │ │ │ │ connection. This only has a real │
185 │ │ │ │ effect for master connections. │
186 │ │ │ │ The properties "autoconnect", │
187 │ │ │ │ "autoconnect-priority" and │
188 │ │ │ │ "autoconnect-retries" are │
189 │ │ │ │ unrelated to this setting. The │
190 │ │ │ │ permitted values are: 0: leave │
191 │ │ │ │ slave connections untouched, 1: │
192 │ │ │ │ activate all the slave │
193 │ │ │ │ connections with this connection, │
194 │ │ │ │ -1: default. If -1 (default) is │
195 │ │ │ │ set, global │
196 │ │ │ │ connection.autoconnect-slaves is │
197 │ │ │ │ read to determine the real value. │
198 │ │ │ │ If it is default as well, this │
199 │ │ │ │ fallbacks to 0. │
200 ├──────────────────────┼──────────────────────────────────────┼───────────────┼────────────────────────────────────────┤
201 │dns-over-tls │ int32 │ -1 │ Whether DNSOverTls (dns-over-tls) │
202 │ │ │ │ is enabled for the connection. │
203 │ │ │ │ DNSOverTls is a technology which │
204 │ │ │ │ uses TLS to encrypt dns traffic. │
205 │ │ │ │ │
206 │ │ │ │ The permitted values are: "yes" │
207 │ │ │ │ (2) use DNSOverTls and disabled │
208 │ │ │ │ fallback, "opportunistic" (1) use │
209 │ │ │ │ DNSOverTls but allow fallback to │
210 │ │ │ │ unencrypted resolution, "no" (0) │
211 │ │ │ │ don't ever use DNSOverTls. If │
212 │ │ │ │ unspecified "default" depends on │
213 │ │ │ │ the plugin used. Systemd-resolved │
214 │ │ │ │ uses global setting. │
215 │ │ │ │ │
216 │ │ │ │ This feature requires a plugin │
217 │ │ │ │ which supports DNSOverTls. │
218 │ │ │ │ Otherwise, the setting has no │
219 │ │ │ │ effect. One such plugin is │
220 │ │ │ │ dns-systemd-resolved. │
221 ├──────────────────────┼──────────────────────────────────────┼───────────────┼────────────────────────────────────────┤
222 │gateway-ping-timeout │ uint32 │ 0 │ If greater than zero, delay │
223 │ │ │ │ success of IP addressing until │
224 │ │ │ │ either the timeout is reached, or │
225 │ │ │ │ an IP gateway replies to a ping. │
226 ├──────────────────────┼──────────────────────────────────────┼───────────────┼────────────────────────────────────────┤
227 │id │ string │ │ A human readable unique │
228 │ │ │ │ identifier for the connection, │
229 │ │ │ │ like "Work Wi-Fi" or "T-Mobile │
230 │ │ │ │ 3G". │
231 ├──────────────────────┼──────────────────────────────────────┼───────────────┼────────────────────────────────────────┤
232 │interface-name │ string │ │ The name of the network interface │
233 │ │ │ │ this connection is bound to. If │
234 │ │ │ │ not set, then the connection can │
235 │ │ │ │ be attached to any interface of │
236 │ │ │ │ the appropriate type (subject to │
237 │ │ │ │ restrictions imposed by other │
238 │ │ │ │ settings). │
239 │ │ │ │ │
240 │ │ │ │ For software devices this │
241 │ │ │ │ specifies the name of the created │
242 │ │ │ │ device. │
243 │ │ │ │ │
244 │ │ │ │ For connection types where │
245 │ │ │ │ interface names cannot easily be │
246 │ │ │ │ made persistent (e.g. mobile │
247 │ │ │ │ broadband or USB Ethernet), this │
248 │ │ │ │ property should not be used. │
249 │ │ │ │ Setting this property restricts │
250 │ │ │ │ the interfaces a connection can │
251 │ │ │ │ be used with, and if interface │
252 │ │ │ │ names change or are reordered the │
253 │ │ │ │ connection may be applied to the │
254 │ │ │ │ wrong interface. │
255 ├──────────────────────┼──────────────────────────────────────┼───────────────┼────────────────────────────────────────┤
256 │lldp │ int32 │ -1 │ Whether LLDP is enabled for the │
257 │ │ │ │ connection. │
258 ├──────────────────────┼──────────────────────────────────────┼───────────────┼────────────────────────────────────────┤
259 │llmnr │ int32 │ -1 │ Whether Link-Local Multicast Name │
260 │ │ │ │ Resolution (LLMNR) is enabled for │
261 │ │ │ │ the connection. LLMNR is a │
262 │ │ │ │ protocol based on the Domain Name │
263 │ │ │ │ System (DNS) packet format that │
264 │ │ │ │ allows both IPv4 and IPv6 hosts │
265 │ │ │ │ to perform name resolution for │
266 │ │ │ │ hosts on the same local link. │
267 │ │ │ │ │
268 │ │ │ │ The permitted values are: "yes" │
269 │ │ │ │ (2) register hostname and │
270 │ │ │ │ resolving for the connection, │
271 │ │ │ │ "no" (0) disable LLMNR for the │
272 │ │ │ │ interface, "resolve" (1) do not │
273 │ │ │ │ register hostname but allow │
274 │ │ │ │ resolving of LLMNR host names If │
275 │ │ │ │ unspecified, "default" ultimately │
276 │ │ │ │ depends on the DNS plugin (which │
277 │ │ │ │ for systemd-resolved currently │
278 │ │ │ │ means "yes"). │
279 │ │ │ │ │
280 │ │ │ │ This feature requires a plugin │
281 │ │ │ │ which supports LLMNR. Otherwise, │
282 │ │ │ │ the setting has no effect. One │
283 │ │ │ │ such plugin is │
284 │ │ │ │ dns-systemd-resolved. │
285 ├──────────────────────┼──────────────────────────────────────┼───────────────┼────────────────────────────────────────┤
286 │master │ string │ │ Interface name of the master │
287 │ │ │ │ device or UUID of the master │
288 │ │ │ │ connection. │
289 ├──────────────────────┼──────────────────────────────────────┼───────────────┼────────────────────────────────────────┤
290 │mdns │ int32 │ -1 │ Whether mDNS is enabled for the │
291 │ │ │ │ connection. │
292 │ │ │ │ │
293 │ │ │ │ The permitted values are: "yes" │
294 │ │ │ │ (2) register hostname and │
295 │ │ │ │ resolving for the connection, │
296 │ │ │ │ "no" (0) disable mDNS for the │
297 │ │ │ │ interface, "resolve" (1) do not │
298 │ │ │ │ register hostname but allow │
299 │ │ │ │ resolving of mDNS host names and │
300 │ │ │ │ "default" (-1) to allow lookup of │
301 │ │ │ │ a global default in │
302 │ │ │ │ NetworkManager.conf. If │
303 │ │ │ │ unspecified, "default" ultimately │
304 │ │ │ │ depends on the DNS plugin (which │
305 │ │ │ │ for systemd-resolved currently │
306 │ │ │ │ means "no"). │
307 │ │ │ │ │
308 │ │ │ │ This feature requires a plugin │
309 │ │ │ │ which supports mDNS. Otherwise, │
310 │ │ │ │ the setting has no effect. One │
311 │ │ │ │ such plugin is │
312 │ │ │ │ dns-systemd-resolved. │
313 ├──────────────────────┼──────────────────────────────────────┼───────────────┼────────────────────────────────────────┤
314 │metered │ NMMetered (int32) │ │ Whether the connection is │
315 │ │ │ │ metered. │
316 │ │ │ │ │
317 │ │ │ │ When updating this property on a │
318 │ │ │ │ currently activated connection, │
319 │ │ │ │ the change takes effect │
320 │ │ │ │ immediately. │
321 ├──────────────────────┼──────────────────────────────────────┼───────────────┼────────────────────────────────────────┤
322 │mptcp-flags │ uint32 │ 0 │ Whether to configure MPTCP │
323 │ │ │ │ endpoints and the address flags. │
324 │ │ │ │ If MPTCP is enabled in │
325 │ │ │ │ NetworkManager, it will configure │
326 │ │ │ │ the addresses of the interface as │
327 │ │ │ │ MPTCP endpoints. Note that IPv4 │
328 │ │ │ │ loopback addresses (127.0.0.0/8), │
329 │ │ │ │ IPv4 link local addresses │
330 │ │ │ │ (169.254.0.0/16), the IPv6 │
331 │ │ │ │ loopback address (::1), IPv6 link │
332 │ │ │ │ local addresses (fe80::/10), IPv6 │
333 │ │ │ │ unique local addresses (ULA, │
334 │ │ │ │ fc00::/7) and IPv6 privacy │
335 │ │ │ │ extension addresses (rfc3041, │
336 │ │ │ │ ipv6.ip6-privacy) will be │
337 │ │ │ │ excluded from being configured as │
338 │ │ │ │ endpoints. │
339 │ │ │ │ │
340 │ │ │ │ If "disabled" (0x1), MPTCP │
341 │ │ │ │ handling for the interface is │
342 │ │ │ │ disabled and no endpoints are │
343 │ │ │ │ registered. │
344 │ │ │ │ │
345 │ │ │ │ The "enabled" (0x2) flag means │
346 │ │ │ │ that MPTCP handling is enabled. │
347 │ │ │ │ This flag can also be implied │
348 │ │ │ │ from the presence of other flags. │
349 │ │ │ │ │
350 │ │ │ │ Even when enabled, MPTCP handling │
351 │ │ │ │ will by default still be disabled │
352 │ │ │ │ unless │
353 │ │ │ │ "/proc/sys/net/mptcp/enabled" │
354 │ │ │ │ sysctl is on. NetworkManager does │
355 │ │ │ │ not change the sysctl and this is │
356 │ │ │ │ up to the administrator or │
357 │ │ │ │ distribution. To configure │
358 │ │ │ │ endpoints even if the sysctl is │
359 │ │ │ │ disabled, "also-without-sysctl" │
360 │ │ │ │ (0x4) flag can be used. In that │
361 │ │ │ │ case, NetworkManager doesn't look │
362 │ │ │ │ at the sysctl and configures │
363 │ │ │ │ endpoints regardless. │
364 │ │ │ │ │
365 │ │ │ │ Even when enabled, NetworkManager │
366 │ │ │ │ will only configure MPTCP │
367 │ │ │ │ endpoints for a certain address │
368 │ │ │ │ family, if there is a unicast │
369 │ │ │ │ default route (0.0.0.0/0 or ::/0) │
370 │ │ │ │ in the main routing table. The │
371 │ │ │ │ flag "also-without-default-route" │
372 │ │ │ │ (0x8) can override that. │
373 │ │ │ │ │
374 │ │ │ │ When MPTCP handling is enabled │
375 │ │ │ │ then endpoints are configured │
376 │ │ │ │ with the specified address flags │
377 │ │ │ │ "signal" (0x10), "subflow" │
378 │ │ │ │ (0x20), "backup" (0x40), │
379 │ │ │ │ "fullmesh" (0x80). See │
380 │ │ │ │ ip-mptcp(8) manual for additional │
381 │ │ │ │ information about the flags. │
382 │ │ │ │ │
383 │ │ │ │ If the flags are zero (0x0), the │
384 │ │ │ │ global connection default from │
385 │ │ │ │ NetworkManager.conf is honored. │
386 │ │ │ │ If still unspecified, the │
387 │ │ │ │ fallback is "enabled,subflow". │
388 │ │ │ │ Note that this means that MPTCP │
389 │ │ │ │ is by default done depending on │
390 │ │ │ │ the "/proc/sys/net/mptcp/enabled" │
391 │ │ │ │ sysctl. │
392 │ │ │ │ │
393 │ │ │ │ NetworkManager does not change │
394 │ │ │ │ the MPTCP limits nor enable MPTCP │
395 │ │ │ │ via │
396 │ │ │ │ "/proc/sys/net/mptcp/enabled". │
397 │ │ │ │ That is a host configuration │
398 │ │ │ │ which the admin can change via │
399 │ │ │ │ sysctl and ip-mptcp. │
400 │ │ │ │ │
401 │ │ │ │ Strict reverse path filtering │
402 │ │ │ │ (rp_filter) breaks many MPTCP use │
403 │ │ │ │ cases, so when MPTCP handling for │
404 │ │ │ │ IPv4 addresses on the interface │
405 │ │ │ │ is enabled, NetworkManager would │
406 │ │ │ │ loosen the strict reverse path │
407 │ │ │ │ filtering (1) to the loose │
408 │ │ │ │ setting (2). │
409 ├──────────────────────┼──────────────────────────────────────┼───────────────┼────────────────────────────────────────┤
410 │mud-url │ string │ │ If configured, set to a │
411 │ │ │ │ Manufacturer Usage Description │
412 │ │ │ │ (MUD) URL that points to │
413 │ │ │ │ manufacturer-recommended network │
414 │ │ │ │ policies for IoT devices. It is │
415 │ │ │ │ transmitted as a DHCPv4 or DHCPv6 │
416 │ │ │ │ option. The value must be a valid │
417 │ │ │ │ URL starting with "https://". │
418 │ │ │ │ │
419 │ │ │ │ The special value "none" is │
420 │ │ │ │ allowed to indicate that no MUD │
421 │ │ │ │ URL is used. │
422 │ │ │ │ │
423 │ │ │ │ If the per-profile value is │
424 │ │ │ │ unspecified (the default), a │
425 │ │ │ │ global connection default gets │
426 │ │ │ │ consulted. If still unspecified, │
427 │ │ │ │ the ultimate default is "none". │
428 ├──────────────────────┼──────────────────────────────────────┼───────────────┼────────────────────────────────────────┤
429 │multi-connect │ int32 │ 0 │ Specifies whether the profile can │
430 │ │ │ │ be active multiple times at a │
431 │ │ │ │ particular moment. The value is │
432 │ │ │ │ of type NMConnectionMultiConnect. │
433 ├──────────────────────┼──────────────────────────────────────┼───────────────┼────────────────────────────────────────┤
434 │permissions │ array of string │ │ An array of strings defining what │
435 │ │ │ │ access a given user has to this │
436 │ │ │ │ connection. If this is NULL or │
437 │ │ │ │ empty, all users are allowed to │
438 │ │ │ │ access this connection; otherwise │
439 │ │ │ │ users are allowed if and only if │
440 │ │ │ │ they are in this list. When this │
441 │ │ │ │ is not empty, the connection can │
442 │ │ │ │ be active only when one of the │
443 │ │ │ │ specified users is logged into an │
444 │ │ │ │ active session. Each entry is of │
445 │ │ │ │ the form │
446 │ │ │ │ "[type]:[id]:[reserved]"; for │
447 │ │ │ │ example, "user:dcbw:blah". │
448 │ │ │ │ │
449 │ │ │ │ At this time only the "user" │
450 │ │ │ │ [type] is allowed. Any other │
451 │ │ │ │ values are ignored and reserved │
452 │ │ │ │ for future use. [id] is the │
453 │ │ │ │ username that this permission │
454 │ │ │ │ refers to, which may not contain │
455 │ │ │ │ the ":" character. Any [reserved] │
456 │ │ │ │ information present must be │
457 │ │ │ │ ignored and is reserved for │
458 │ │ │ │ future use. All of [type], [id], │
459 │ │ │ │ and [reserved] must be valid │
460 │ │ │ │ UTF-8. │
461 ├──────────────────────┼──────────────────────────────────────┼───────────────┼────────────────────────────────────────┤
462 │read-only │ boolean │ FALSE │ FALSE if the connection can be │
463 │ │ │ │ modified using the provided │
464 │ │ │ │ settings service's D-Bus │
465 │ │ │ │ interface with the right │
466 │ │ │ │ privileges, or TRUE if the │
467 │ │ │ │ connection is read-only and │
468 │ │ │ │ cannot be modified. │
469 ├──────────────────────┼──────────────────────────────────────┼───────────────┼────────────────────────────────────────┤
470 │secondaries │ array of string │ │ List of connection UUIDs that │
471 │ │ │ │ should be activated when the base │
472 │ │ │ │ connection itself is activated. │
473 │ │ │ │ Currently, only VPN connections │
474 │ │ │ │ are supported. │
475 ├──────────────────────┼──────────────────────────────────────┼───────────────┼────────────────────────────────────────┤
476 │slave-type │ string │ │ Setting name of the device type │
477 │ │ │ │ of this slave's master connection │
478 │ │ │ │ (eg, "bond"), or NULL if this │
479 │ │ │ │ connection is not a slave. │
480 ├──────────────────────┼──────────────────────────────────────┼───────────────┼────────────────────────────────────────┤
481 │stable-id │ string │ │ This represents the identity of │
482 │ │ │ │ the connection used for various │
483 │ │ │ │ purposes. It allows to configure │
484 │ │ │ │ multiple profiles to share the │
485 │ │ │ │ identity. Also, the stable-id can │
486 │ │ │ │ contain placeholders that are │
487 │ │ │ │ substituted dynamically and │
488 │ │ │ │ deterministically depending on │
489 │ │ │ │ the context. │
490 │ │ │ │ │
491 │ │ │ │ The stable-id is used for │
492 │ │ │ │ generating IPv6 stable private │
493 │ │ │ │ addresses with │
494 │ │ │ │ ipv6.addr-gen-mode=stable-privacy. │
495 │ │ │ │ It is also used to seed the │
496 │ │ │ │ generated cloned MAC address for │
497 │ │ │ │ ethernet.cloned-mac-address=stable │
498 │ │ │ │ and │
499 │ │ │ │ wifi.cloned-mac-address=stable. │
500 │ │ │ │ It is also used as DHCP client │
501 │ │ │ │ identifier with │
502 │ │ │ │ ipv4.dhcp-client-id=stable and to │
503 │ │ │ │ derive the DHCP DUID with │
504 │ │ │ │ ipv6.dhcp-duid=stable-[llt,ll,uuid]. │
505 │ │ │ │ │
506 │ │ │ │ Note that depending on the │
507 │ │ │ │ context where it is used, other │
508 │ │ │ │ parameters are also seeded into │
509 │ │ │ │ the generation algorithm. For │
510 │ │ │ │ example, a per-host key is │
511 │ │ │ │ commonly also included, so that │
512 │ │ │ │ different systems end up │
513 │ │ │ │ generating different IDs. Or with │
514 │ │ │ │ ipv6.addr-gen-mode=stable-privacy, │
515 │ │ │ │ also the device's name is │
516 │ │ │ │ included, so that different │
517 │ │ │ │ interfaces yield different │
518 │ │ │ │ addresses. The per-host key is │
519 │ │ │ │ the identity of your machine and │
520 │ │ │ │ stored in │
521 │ │ │ │ /var/lib/NetworkManager/secret_key. │
522 │ │ │ │ See NetworkManager(8) manual │
523 │ │ │ │ about the secret-key and the host │
524 │ │ │ │ identity. │
525 │ │ │ │ │
526 │ │ │ │ The '$' character is treated │
527 │ │ │ │ special to perform dynamic │
528 │ │ │ │ substitutions at runtime. │
529 │ │ │ │ Currently, supported are │
530 │ │ │ │ "${CONNECTION}", "${DEVICE}", │
531 │ │ │ │ "${MAC}", "${BOOT}", "${RANDOM}". │
532 │ │ │ │ These effectively create unique │
533 │ │ │ │ IDs per-connection, per-device, │
534 │ │ │ │ per-boot, or every time. Note │
535 │ │ │ │ that "${DEVICE}" corresponds to │
536 │ │ │ │ the interface name of the device │
537 │ │ │ │ and "${MAC}" is the permanent MAC │
538 │ │ │ │ address of the device. Any │
539 │ │ │ │ unrecognized patterns following │
540 │ │ │ │ '$' are treated verbatim, however │
541 │ │ │ │ are reserved for future use. You │
542 │ │ │ │ are thus advised to avoid '$' or │
543 │ │ │ │ escape it as "$$". For example, │
544 │ │ │ │ set it to │
545 │ │ │ │ "${CONNECTION}-${BOOT}-${DEVICE}" │
546 │ │ │ │ to create a unique id for this │
547 │ │ │ │ connection that changes with │
548 │ │ │ │ every reboot and differs │
549 │ │ │ │ depending on the interface where │
550 │ │ │ │ the profile activates. │
551 │ │ │ │ │
552 │ │ │ │ If the value is unset, a global │
553 │ │ │ │ connection default is consulted. │
554 │ │ │ │ If the value is still unset, the │
555 │ │ │ │ default is similar to │
556 │ │ │ │ "${CONNECTION}" and uses a │
557 │ │ │ │ unique, fixed ID for the │
558 │ │ │ │ connection. │
559 ├──────────────────────┼──────────────────────────────────────┼───────────────┼────────────────────────────────────────┤
560 │timestamp │ uint64 │ 0 │ The time, in seconds since the Unix │
561 │ │ │ │ Epoch, that the connection was last │
562 │ │ │ │ _successfully_ fully activated. │
563 │ │ │ │ │
564 │ │ │ │ NetworkManager updates the │
565 │ │ │ │ connection timestamp periodically │
566 │ │ │ │ when the connection is active to │
567 │ │ │ │ ensure that an active connection has │
568 │ │ │ │ the latest timestamp. The property │
569 │ │ │ │ is only meant for reading (changes │
570 │ │ │ │ to this property will not be │
571 │ │ │ │ preserved). │
572 ├──────────────────────┼──────────────────────────────────────┼───────────────┼────────────────────────────────────────┤
573 │type │ string │ │ Base type of the connection. For │
574 │ │ │ │ hardware-dependent connections, │
575 │ │ │ │ should contain the setting name of │
576 │ │ │ │ the hardware-type specific setting │
577 │ │ │ │ (ie, "802-3-ethernet" or │
578 │ │ │ │ "802-11-wireless" or "bluetooth", │
579 │ │ │ │ etc), and for non-hardware dependent │
580 │ │ │ │ connections like VPN or otherwise, │
581 │ │ │ │ should contain the setting name of │
582 │ │ │ │ that setting type (ie, "vpn" or │
583 │ │ │ │ "bridge", etc). │
584 ├──────────────────────┼──────────────────────────────────────┼───────────────┼────────────────────────────────────────┤
585 │uuid │ string │ │ A universally unique identifier for │
586 │ │ │ │ the connection, for example │
587 │ │ │ │ generated with libuuid. It should │
588 │ │ │ │ be assigned when the connection is │
589 │ │ │ │ created, and never changed as long │
590 │ │ │ │ as the connection still applies to │
591 │ │ │ │ the same network. For example, it │
592 │ │ │ │ should not be changed when the "id" │
593 │ │ │ │ property or NMSettingIP4Config │
594 │ │ │ │ changes, but might need to be │
595 │ │ │ │ re-created when the Wi-Fi SSID, │
596 │ │ │ │ mobile broadband network provider, │
597 │ │ │ │ or "type" property changes. │
598 │ │ │ │ │
599 │ │ │ │ The UUID must be in the format │
600 │ │ │ │ "2815492f-7e56-435e-b2e9-246bd7cdc664" │
601 │ │ │ │ (ie, contains only hexadecimal │
602 │ │ │ │ characters and "-"). │
603 ├──────────────────────┼──────────────────────────────────────┼───────────────┼────────────────────────────────────────┤
604 │wait-activation-delay │ int32 │ -1 │ Time in milliseconds to wait for │
605 │ │ │ │ connection to be considered activated. │
606 │ │ │ │ The wait will start after the pre-up │
607 │ │ │ │ dispatcher event. │
608 │ │ │ │ │
609 │ │ │ │ The value 0 means no wait time. The │
610 │ │ │ │ default value is -1, which currently │
611 │ │ │ │ has the same meaning as no wait time. │
612 ├──────────────────────┼──────────────────────────────────────┼───────────────┼────────────────────────────────────────┤
613 │wait-device-timeout │ int32 │ -1 │ Timeout in milliseconds to wait for │
614 │ │ │ │ device at startup. During boot, │
615 │ │ │ │ devices may take a while to be │
616 │ │ │ │ detected by the driver. This property │
617 │ │ │ │ will cause to delay │
618 │ │ │ │ NetworkManager-wait-online.service and │
619 │ │ │ │ nm-online to give the device a chance │
620 │ │ │ │ to appear. This works by waiting for │
621 │ │ │ │ the given timeout until a compatible │
622 │ │ │ │ device for the profile is available │
623 │ │ │ │ and managed. │
624 │ │ │ │ │
625 │ │ │ │ The value 0 means no wait time. The │
626 │ │ │ │ default value is -1, which currently │
627 │ │ │ │ has the same meaning as no wait time. │
628 ├──────────────────────┼──────────────────────────────────────┼───────────────┼────────────────────────────────────────┤
629 │zone │ string │ │ The trust level of a the connection. │
630 │ │ │ │ Free form case-insensitive string (for │
631 │ │ │ │ example "Home", "Work", "Public"). │
632 │ │ │ │ NULL or unspecified zone means the │
633 │ │ │ │ connection will be placed in the │
634 │ │ │ │ default zone as defined by the │
635 │ │ │ │ firewall. │
636 │ │ │ │ │
637 │ │ │ │ When updating this property on a │
638 │ │ │ │ currently activated connection, the │
639 │ │ │ │ change takes effect immediately. │
640 └──────────────────────┴──────────────────────────────────────┴───────────────┴────────────────────────────────────────┘
641 6lowpan setting
643 6LoWPAN Settings.
644 ┌─────────┬────────────┬───────────────┬──────────────────┐
646 │Key Name │ Value Type │ Default Value │ Value │
647 │ │ │ │ Description │
648 ├─────────┼────────────┼───────────────┼──────────────────┤
649 │parent │ string │ │ If given, │
650 │ │ │ │ specifies the │
651 │ │ │ │ parent interface │
652 │ │ │ │ name or parent │
653 │ │ │ │ connection UUID │
654 │ │ │ │ from which this │
655 │ │ │ │ 6LowPAN │
656 │ │ │ │ interface should │
657 │ │ │ │ be created. │
658 └─────────┴────────────┴───────────────┴──────────────────┘
659 802-1x setting
661 IEEE 802.1x Authentication Settings.
662 ┌──────────────────────────────────┬──────────────────────┬───────────────┬────────────────────────────────┐
664 │Key Name │ Value Type │ Default Value │ Value │
665 │ │ │ │ Description │
666 ├──────────────────────────────────┼──────────────────────┼───────────────┼────────────────────────────────┤
667 │altsubject-matches │ array of string │ │ List of strings │
668 │ │ │ │ to be matched │
669 │ │ │ │ against the │
670 │ │ │ │ altSubjectName │
671 │ │ │ │ of the │
672 │ │ │ │ certificate │
673 │ │ │ │ presented by the │
674 │ │ │ │ authentication │
675 │ │ │ │ server. If the │
676 │ │ │ │ list is empty, │
677 │ │ │ │ no verification │
678 │ │ │ │ of the server │
679 │ │ │ │ certificate's │
680 │ │ │ │ altSubjectName │
681 │ │ │ │ is performed. │
682 ├──────────────────────────────────┼──────────────────────┼───────────────┼────────────────────────────────┤
683 │anonymous-identity │ string │ │ Anonymous │
684 │ │ │ │ identity string │
685 │ │ │ │ for EAP │
686 │ │ │ │ authentication │
687 │ │ │ │ methods. Used │
688 │ │ │ │ as the │
689 │ │ │ │ unencrypted │
690 │ │ │ │ identity with │
691 │ │ │ │ EAP types that │
692 │ │ │ │ support │
693 │ │ │ │ different │
694 │ │ │ │ tunneled │
695 │ │ │ │ identity like │
696 │ │ │ │ EAP-TTLS. │
697 ├──────────────────────────────────┼──────────────────────┼───────────────┼────────────────────────────────┤
698 │auth-timeout │ int32 │ 0 │ A timeout for │
699 │ │ │ │ the │
700 │ │ │ │ authentication. │
701 │ │ │ │ Zero means the │
702 │ │ │ │ global default; │
703 │ │ │ │ if the global │
704 │ │ │ │ default is not │
705 │ │ │ │ set, the │
706 │ │ │ │ authentication │
707 │ │ │ │ timeout is 25 │
708 │ │ │ │ seconds. │
709 ├──────────────────────────────────┼──────────────────────┼───────────────┼────────────────────────────────┤
710 │ca-cert │ byte array │ │ Contains the CA │
711 │ │ │ │ certificate if │
712 │ │ │ │ used by the EAP │
713 │ │ │ │ method specified │
714 │ │ │ │ in the "eap" │
715 │ │ │ │ property. │
716 │ │ │ │ │
717 │ │ │ │ Certificate data │
718 │ │ │ │ is specified │
719 │ │ │ │ using a │
720 │ │ │ │ "scheme"; three │
721 │ │ │ │ are currently │
722 │ │ │ │ supported: blob, │
723 │ │ │ │ path and pkcs#11 │
724 │ │ │ │ URL. When using │
725 │ │ │ │ the blob scheme │
726 │ │ │ │ this property │
727 │ │ │ │ should be set to │
728 │ │ │ │ the │
729 │ │ │ │ certificate's │
730 │ │ │ │ DER encoded │
731 │ │ │ │ data. When using │
732 │ │ │ │ the path scheme, │
733 │ │ │ │ this property │
734 │ │ │ │ should be set to │
735 │ │ │ │ the full UTF-8 │
736 │ │ │ │ encoded path of │
737 │ │ │ │ the certificate, │
738 │ │ │ │ prefixed with │
739 │ │ │ │ the string │
740 │ │ │ │ "file://" and │
741 │ │ │ │ ending with a │
742 │ │ │ │ terminating NUL │
743 │ │ │ │ byte. This │
744 │ │ │ │ property can be │
745 │ │ │ │ unset even if │
746 │ │ │ │ the EAP method │
747 │ │ │ │ supports CA │
748 │ │ │ │ certificates, │
749 │ │ │ │ but this allows │
750 │ │ │ │ man-in-the-middle │
751 │ │ │ │ attacks and is │
752 │ │ │ │ NOT recommended. │
753 │ │ │ │ │
754 │ │ │ │ Note that │
755 │ │ │ │ enabling │
756 │ │ │ │ NMSetting8021x:system-ca-certs │
757 │ │ │ │ will override │
758 │ │ │ │ this setting to │
759 │ │ │ │ use the built-in │
760 │ │ │ │ path, if the │
761 │ │ │ │ built-in path is │
762 │ │ │ │ not a directory. │
763 ├──────────────────────────────────┼──────────────────────┼───────────────┼────────────────────────────────┤
764 │ca-cert-password │ string │ │ The password used to access │
765 │ │ │ │ the CA certificate stored in │
766 │ │ │ │ "ca-cert" property. Only makes │
767 │ │ │ │ sense if the certificate is │
768 │ │ │ │ stored on a PKCS#11 token that │
769 │ │ │ │ requires a login. │
770 ├──────────────────────────────────┼──────────────────────┼───────────────┼────────────────────────────────┤
771 │ca-cert-password-flags │ NMSettingSecretFlags │ │ Flags indicating how to handle │
772 │ │ (uint32) │ │ the "ca-cert-password" │
773 │ │ │ │ property. │
774 ├──────────────────────────────────┼──────────────────────┼───────────────┼────────────────────────────────┤
775 │ca-path │ string │ │ UTF-8 encoded path to a │
776 │ │ │ │ directory containing PEM or │
777 │ │ │ │ DER formatted certificates to │
778 │ │ │ │ be added to the verification │
779 │ │ │ │ chain in addition to the │
780 │ │ │ │ certificate specified in the │
781 │ │ │ │ "ca-cert" property. │
782 │ │ │ │ │
783 │ │ │ │ If │
784 │ │ │ │ NMSetting8021x:system-ca-certs │
785 │ │ │ │ is enabled and the built-in CA │
786 │ │ │ │ path is an existing directory, │
787 │ │ │ │ then this setting is ignored. │
788 ├──────────────────────────────────┼──────────────────────┼───────────────┼────────────────────────────────┤
789 │client-cert │ byte array │ │ Contains the client │
790 │ │ │ │ certificate if used by the EAP │
791 │ │ │ │ method specified in the "eap" │
792 │ │ │ │ property. │
793 │ │ │ │ │
794 │ │ │ │ Certificate data is specified │
795 │ │ │ │ using a "scheme"; two are │
796 │ │ │ │ currently supported: blob and │
797 │ │ │ │ path. When using the blob │
798 │ │ │ │ scheme (which is backwards │
799 │ │ │ │ compatible with NM 0.7.x) this │
800 │ │ │ │ property should be set to the │
801 │ │ │ │ certificate's DER encoded │
802 │ │ │ │ data. When using the path │
803 │ │ │ │ scheme, this property should │
804 │ │ │ │ be set to the full UTF-8 │
805 │ │ │ │ encoded path of the │
806 │ │ │ │ certificate, prefixed with the │
807 │ │ │ │ string "file://" and ending │
808 │ │ │ │ with a terminating NUL byte. │
809 ├──────────────────────────────────┼──────────────────────┼───────────────┼────────────────────────────────┤
810 │client-cert-password │ string │ │ The password used to access │
811 │ │ │ │ the client certificate stored │
812 │ │ │ │ in "client-cert" property. │
813 │ │ │ │ Only makes sense if the │
814 │ │ │ │ certificate is stored on a │
815 │ │ │ │ PKCS#11 token that requires a │
816 │ │ │ │ login. │
817 ├──────────────────────────────────┼──────────────────────┼───────────────┼────────────────────────────────┤
818 │client-cert-password-flags │ NMSettingSecretFlags │ │ Flags indicating how to handle │
819 │ │ (uint32) │ │ the "client-cert-password" │
820 │ │ │ │ property. │
821 ├──────────────────────────────────┼──────────────────────┼───────────────┼────────────────────────────────┤
822 │domain-match │ string │ │ Constraint for server domain │
823 │ │ │ │ name. If set, this list of │
824 │ │ │ │ FQDNs is used as a match │
825 │ │ │ │ requirement for dNSName │
826 │ │ │ │ element(s) of the certificate │
827 │ │ │ │ presented by the │
828 │ │ │ │ authentication server. If a │
829 │ │ │ │ matching dNSName is found, │
830 │ │ │ │ this constraint is met. If no │
831 │ │ │ │ dNSName values are present, │
832 │ │ │ │ this constraint is matched │
833 │ │ │ │ against SubjectName CN using │
834 │ │ │ │ the same comparison. Multiple │
835 │ │ │ │ valid FQDNs can be passed as a │
836 │ │ │ │ ";" delimited list. │
837 ├──────────────────────────────────┼──────────────────────┼───────────────┼────────────────────────────────┤
838 │domain-suffix-match │ string │ │ Constraint for server domain │
839 │ │ │ │ name. If set, this FQDN is │
840 │ │ │ │ used as a suffix match │
841 │ │ │ │ requirement for dNSName │
842 │ │ │ │ element(s) of the certificate │
843 │ │ │ │ presented by the │
844 │ │ │ │ authentication server. If a │
845 │ │ │ │ matching dNSName is found, │
846 │ │ │ │ this constraint is met. If no │
847 │ │ │ │ dNSName values are present, │
848 │ │ │ │ this constraint is matched │
849 │ │ │ │ against SubjectName CN using │
850 │ │ │ │ same suffix match comparison. │
851 │ │ │ │ Since version 1.24, multiple │
852 │ │ │ │ valid FQDNs can be passed as a │
853 │ │ │ │ ";" delimited list. │
854 ├──────────────────────────────────┼──────────────────────┼───────────────┼────────────────────────────────┤
855 │eap │ array of string │ │ The allowed EAP method to be │
856 │ │ │ │ used when authenticating to │
857 │ │ │ │ the network with 802.1x. │
858 │ │ │ │ Valid methods are: "leap", │
859 │ │ │ │ "md5", "tls", "peap", "ttls", │
860 │ │ │ │ "pwd", and "fast". Each │
861 │ │ │ │ method requires different │
862 │ │ │ │ configuration using the │
863 │ │ │ │ properties of this setting; │
864 │ │ │ │ refer to wpa_supplicant │
865 │ │ │ │ documentation for the allowed │
866 │ │ │ │ combinations. │
867 ├──────────────────────────────────┼──────────────────────┼───────────────┼────────────────────────────────┤
868 │identity │ string │ │ Identity string for EAP │
869 │ │ │ │ authentication methods. Often │
870 │ │ │ │ the user's user or login name. │
871 ├──────────────────────────────────┼──────────────────────┼───────────────┼────────────────────────────────┤
872 │optional │ boolean │ FALSE │ Whether the 802.1X │
873 │ │ │ │ authentication is optional. If │
874 │ │ │ │ TRUE, the activation will │
875 │ │ │ │ continue even after a timeout │
876 │ │ │ │ or an authentication failure. │
877 │ │ │ │ Setting the property to TRUE │
878 │ │ │ │ is currently allowed only for │
879 │ │ │ │ Ethernet connections. If set │
880 │ │ │ │ to FALSE, the activation can │
881 │ │ │ │ continue only after a │
882 │ │ │ │ successful authentication. │
883 ├──────────────────────────────────┼──────────────────────┼───────────────┼────────────────────────────────┤
884 │pac-file │ string │ │ UTF-8 encoded file path │
885 │ │ │ │ containing PAC for EAP-FAST. │
886 ├──────────────────────────────────┼──────────────────────┼───────────────┼────────────────────────────────┤
887 │password │ string │ │ UTF-8 encoded password used │
888 │ │ │ │ for EAP authentication │
889 │ │ │ │ methods. If both the │
890 │ │ │ │ "password" property and the │
891 │ │ │ │ "password-raw" property are │
892 │ │ │ │ specified, "password" is │
893 │ │ │ │ preferred. │
894 ├──────────────────────────────────┼──────────────────────┼───────────────┼────────────────────────────────┤
895 │password-flags │ NMSettingSecretFlags │ │ Flags indicating how to handle │
896 │ │ (uint32) │ │ the "password" property. │
897 ├──────────────────────────────────┼──────────────────────┼───────────────┼────────────────────────────────┤
898 │password-raw │ byte array │ │ Password used for EAP │
899 │ │ │ │ authentication methods, given │
900 │ │ │ │ as a byte array to allow │
901 │ │ │ │ passwords in other encodings │
902 │ │ │ │ than UTF-8 to be used. If both │
903 │ │ │ │ the "password" property and │
904 │ │ │ │ the "password-raw" property │
905 │ │ │ │ are specified, "password" is │
906 │ │ │ │ preferred. │
907 ├──────────────────────────────────┼──────────────────────┼───────────────┼────────────────────────────────┤
908 │password-raw-flags │ NMSettingSecretFlags │ │ Flags indicating how to handle │
909 │ │ (uint32) │ │ the "password-raw" property. │
910 ├──────────────────────────────────┼──────────────────────┼───────────────┼────────────────────────────────┤
911 │phase1-auth-flags │ uint32 │ 0 │ Specifies authentication flags │
912 │ │ │ │ to use in "phase 1" outer │
913 │ │ │ │ authentication using │
914 │ │ │ │ NMSetting8021xAuthFlags │
915 │ │ │ │ options. The individual TLS │
916 │ │ │ │ versions can be explicitly │
917 │ │ │ │ disabled. TLS time checks can │
918 │ │ │ │ be also disabled. If a certain │
919 │ │ │ │ TLS disable flag is not set, │
920 │ │ │ │ it is up to the supplicant to │
921 │ │ │ │ allow or forbid it. The TLS │
922 │ │ │ │ options map to │
923 │ │ │ │ tls_disable_tlsv1_x and │
924 │ │ │ │ tls_disable_time_checks │
925 │ │ │ │ settings. See the │
926 │ │ │ │ wpa_supplicant documentation │
927 │ │ │ │ for more details. │
928 ├──────────────────────────────────┼──────────────────────┼───────────────┼────────────────────────────────┤
929 │phase1-fast-provisioning │ string │ │ Enables or disables in-line │
930 │ │ │ │ provisioning of EAP-FAST │
931 │ │ │ │ credentials when FAST is │
932 │ │ │ │ specified as the EAP method in │
933 │ │ │ │ the "eap" property. Recognized │
934 │ │ │ │ values are "0" (disabled), "1" │
935 │ │ │ │ (allow unauthenticated │
936 │ │ │ │ provisioning), "2" (allow │
937 │ │ │ │ authenticated provisioning), │
938 │ │ │ │ and "3" (allow both │
939 │ │ │ │ authenticated and │
940 │ │ │ │ unauthenticated provisioning). │
941 │ │ │ │ See the wpa_supplicant │
942 │ │ │ │ documentation for more │
943 │ │ │ │ details. │
944 ├──────────────────────────────────┼──────────────────────┼───────────────┼────────────────────────────────┤
945 │phase1-peaplabel │ string │ │ Forces use of the new PEAP │
946 │ │ │ │ label during key derivation. │
947 │ │ │ │ Some RADIUS servers may │
948 │ │ │ │ require forcing the new PEAP │
949 │ │ │ │ label to interoperate with │
950 │ │ │ │ PEAPv1. Set to "1" to force │
951 │ │ │ │ use of the new PEAP label. │
952 │ │ │ │ See the wpa_supplicant │
953 │ │ │ │ documentation for more │
954 │ │ │ │ details. │
955 ├──────────────────────────────────┼──────────────────────┼───────────────┼────────────────────────────────┤
956 │phase1-peapver │ string │ │ Forces which PEAP version is │
957 │ │ │ │ used when PEAP is set as the │
958 │ │ │ │ EAP method in the "eap" │
959 │ │ │ │ property. When unset, the │
960 │ │ │ │ version reported by the server │
961 │ │ │ │ will be used. Sometimes when │
962 │ │ │ │ using older RADIUS servers, it │
963 │ │ │ │ is necessary to force the │
964 │ │ │ │ client to use a particular │
965 │ │ │ │ PEAP version. To do so, this │
966 │ │ │ │ property may be set to "0" or │
967 │ │ │ │ "1" to force that specific │
968 │ │ │ │ PEAP version. │
969 ├──────────────────────────────────┼──────────────────────┼───────────────┼────────────────────────────────┤
970 │phase2-altsubject-matches │ array of string │ │ List of strings to be matched │
971 │ │ │ │ against the altSubjectName of │
972 │ │ │ │ the certificate presented by │
973 │ │ │ │ the authentication server │
974 │ │ │ │ during the inner "phase 2" │
975 │ │ │ │ authentication. If the list is │
976 │ │ │ │ empty, no verification of the │
977 │ │ │ │ server certificate's │
978 │ │ │ │ altSubjectName is performed. │
979 ├──────────────────────────────────┼──────────────────────┼───────────────┼────────────────────────────────┤
980 │phase2-auth │ string │ │ Specifies the allowed "phase │
981 │ │ │ │ 2" inner authentication method │
982 │ │ │ │ when an EAP method that uses │
983 │ │ │ │ an inner TLS tunnel is │
984 │ │ │ │ specified in the "eap" │
985 │ │ │ │ property. For TTLS this │
986 │ │ │ │ property selects one of the │
987 │ │ │ │ supported non-EAP inner │
988 │ │ │ │ methods: "pap", "chap", │
989 │ │ │ │ "mschap", "mschapv2" while │
990 │ │ │ │ "phase2-autheap" selects an │
991 │ │ │ │ EAP inner method. For PEAP │
992 │ │ │ │ this selects an inner EAP │
993 │ │ │ │ method, one of: "gtc", "otp", │
994 │ │ │ │ "md5" and "tls". Each "phase │
995 │ │ │ │ 2" inner method requires │
996 │ │ │ │ specific parameters for │
997 │ │ │ │ successful authentication; see │
998 │ │ │ │ the wpa_supplicant │
999 │ │ │ │ documentation for more │
1000 │ │ │ │ details. Both "phase2-auth" │
1001 │ │ │ │ and "phase2-autheap" cannot be │
1002 │ │ │ │ specified. │
1003 ├──────────────────────────────────┼──────────────────────┼───────────────┼────────────────────────────────┤
1004 │phase2-autheap │ string │ │ Specifies the allowed "phase │
1005 │ │ │ │ 2" inner EAP-based │
1006 │ │ │ │ authentication method when │
1007 │ │ │ │ TTLS is specified in the "eap" │
1008 │ │ │ │ property. Recognized │
1009 │ │ │ │ EAP-based "phase 2" methods │
1010 │ │ │ │ are "md5", "mschapv2", "otp", │
1011 │ │ │ │ "gtc", and "tls". Each "phase │
1012 │ │ │ │ 2" inner method requires │
1013 │ │ │ │ specific parameters for │
1014 │ │ │ │ successful authentication; see │
1015 │ │ │ │ the wpa_supplicant │
1016 │ │ │ │ documentation for more │
1017 │ │ │ │ details. │
1018 ├──────────────────────────────────┼──────────────────────┼───────────────┼────────────────────────────────┤
1019 │phase2-ca-cert │ byte array │ │ Contains the "phase 2" CA │
1020 │ │ │ │ certificate if used by the EAP │
1021 │ │ │ │ method specified in the │
1022 │ │ │ │ "phase2-auth" or │
1023 │ │ │ │ "phase2-autheap" properties. │
1024 │ │ │ │ │
1025 │ │ │ │ Certificate data is specified │
1026 │ │ │ │ using a "scheme"; three are │
1027 │ │ │ │ currently supported: blob, │
1028 │ │ │ │ path and pkcs#11 URL. When │
1029 │ │ │ │ using the blob scheme this │
1030 │ │ │ │ property should be set to the │
1031 │ │ │ │ certificate's DER encoded │
1032 │ │ │ │ data. When using the path │
1033 │ │ │ │ scheme, this property should │
1034 │ │ │ │ be set to the full UTF-8 │
1035 │ │ │ │ encoded path of the │
1036 │ │ │ │ certificate, prefixed with the │
1037 │ │ │ │ string "file://" and ending │
1038 │ │ │ │ with a terminating NUL byte. │
1039 │ │ │ │ This property can be unset │
1040 │ │ │ │ even if the EAP method │
1041 │ │ │ │ supports CA certificates, but │
1042 │ │ │ │ this allows man-in-the-middle │
1043 │ │ │ │ attacks and is NOT │
1044 │ │ │ │ recommended. │
1045 │ │ │ │ │
1046 │ │ │ │ Note that enabling │
1047 │ │ │ │ NMSetting8021x:system-ca-certs │
1048 │ │ │ │ will override this setting to │
1049 │ │ │ │ use the built-in path, if the │
1050 │ │ │ │ built-in path is not a │
1051 │ │ │ │ directory. │
1052 ├──────────────────────────────────┼──────────────────────┼───────────────┼────────────────────────────────┤
1053 │phase2-ca-cert-password │ string │ │ The password used to access │
1054 │ │ │ │ the "phase2" CA certificate │
1055 │ │ │ │ stored in "phase2-ca-cert" │
1056 │ │ │ │ property. Only makes sense if │
1057 │ │ │ │ the certificate is stored on a │
1058 │ │ │ │ PKCS#11 token that requires a │
1059 │ │ │ │ login. │
1060 ├──────────────────────────────────┼──────────────────────┼───────────────┼────────────────────────────────┤
1061 │phase2-ca-cert-password-flags │ NMSettingSecretFlags │ │ Flags indicating how to handle │
1062 │ │ (uint32) │ │ the "phase2-ca-cert-password" │
1063 │ │ │ │ property. │
1064 ├──────────────────────────────────┼──────────────────────┼───────────────┼────────────────────────────────┤
1065 │phase2-ca-path │ string │ │ UTF-8 encoded path to a │
1066 │ │ │ │ directory containing PEM or │
1067 │ │ │ │ DER formatted certificates to │
1068 │ │ │ │ be added to the verification │
1069 │ │ │ │ chain in addition to the │
1070 │ │ │ │ certificate specified in the │
1071 │ │ │ │ "phase2-ca-cert" property. │
1072 │ │ │ │ │
1073 │ │ │ │ If │
1074 │ │ │ │ NMSetting8021x:system-ca-certs │
1075 │ │ │ │ is enabled and the built-in CA │
1076 │ │ │ │ path is an existing directory, │
1077 │ │ │ │ then this setting is ignored. │
1078 ├──────────────────────────────────┼──────────────────────┼───────────────┼────────────────────────────────┤
1079 │phase2-client-cert │ byte array │ │ Contains the "phase 2" client │
1080 │ │ │ │ certificate if used by the EAP │
1081 │ │ │ │ method specified in the │
1082 │ │ │ │ "phase2-auth" or │
1083 │ │ │ │ "phase2-autheap" properties. │
1084 │ │ │ │ │
1085 │ │ │ │ Certificate data is specified │
1086 │ │ │ │ using a "scheme"; two are │
1087 │ │ │ │ currently supported: blob and │
1088 │ │ │ │ path. When using the blob │
1089 │ │ │ │ scheme (which is backwards │
1090 │ │ │ │ compatible with NM 0.7.x) this │
1091 │ │ │ │ property should be set to the │
1092 │ │ │ │ certificate's DER encoded │
1093 │ │ │ │ data. When using the path │
1094 │ │ │ │ scheme, this property should │
1095 │ │ │ │ be set to the full UTF-8 │
1096 │ │ │ │ encoded path of the │
1097 │ │ │ │ certificate, prefixed with the │
1098 │ │ │ │ string "file://" and ending │
1099 │ │ │ │ with a terminating NUL byte. │
1100 │ │ │ │ This property can be unset │
1101 │ │ │ │ even if the EAP method │
1102 │ │ │ │ supports CA certificates, but │
1103 │ │ │ │ this allows man-in-the-middle │
1104 │ │ │ │ attacks and is NOT │
1105 │ │ │ │ recommended. │
1106 ├──────────────────────────────────┼──────────────────────┼───────────────┼────────────────────────────────┤
1107 │phase2-client-cert-password │ string │ │ The password used to access │
1108 │ │ │ │ the "phase2" client │
1109 │ │ │ │ certificate stored in │
1110 │ │ │ │ "phase2-client-cert" property. │
1111 │ │ │ │ Only makes sense if the │
1112 │ │ │ │ certificate is stored on a │
1113 │ │ │ │ PKCS#11 token that requires a │
1114 │ │ │ │ login. │
1115 ├──────────────────────────────────┼──────────────────────┼───────────────┼────────────────────────────────┤
1116 │phase2-client-cert-password-flags │ NMSettingSecretFlags │ │ Flags indicating how to handle │
1117 │ │ (uint32) │ │ the │
1118 │ │ │ │ "phase2-client-cert-password" │
1119 │ │ │ │ property. │
1120 ├──────────────────────────────────┼──────────────────────┼───────────────┼────────────────────────────────┤
1121 │phase2-domain-match │ string │ │ Constraint for server domain │
1122 │ │ │ │ name. If set, this list of │
1123 │ │ │ │ FQDNs is used as a match │
1124 │ │ │ │ requirement for dNSName │
1125 │ │ │ │ element(s) of the certificate │
1126 │ │ │ │ presented by the │
1127 │ │ │ │ authentication server during │
1128 │ │ │ │ the inner "phase 2" │
1129 │ │ │ │ authentication. If a matching │
1130 │ │ │ │ dNSName is found, this │
1131 │ │ │ │ constraint is met. If no │
1132 │ │ │ │ dNSName values are present, │
1133 │ │ │ │ this constraint is matched │
1134 │ │ │ │ against SubjectName CN using │
1135 │ │ │ │ the same comparison. Multiple │
1136 │ │ │ │ valid FQDNs can be passed as a │
1137 │ │ │ │ ";" delimited list. │
1138 ├──────────────────────────────────┼──────────────────────┼───────────────┼────────────────────────────────┤
1139 │phase2-domain-suffix-match │ string │ │ Constraint for server domain │
1140 │ │ │ │ name. If set, this FQDN is │
1141 │ │ │ │ used as a suffix match │
1142 │ │ │ │ requirement for dNSName │
1143 │ │ │ │ element(s) of the certificate │
1144 │ │ │ │ presented by the │
1145 │ │ │ │ authentication server during │
1146 │ │ │ │ the inner "phase 2" │
1147 │ │ │ │ authentication. If a matching │
1148 │ │ │ │ dNSName is found, this │
1149 │ │ │ │ constraint is met. If no │
1150 │ │ │ │ dNSName values are present, │
1151 │ │ │ │ this constraint is matched │
1152 │ │ │ │ against SubjectName CN using │
1153 │ │ │ │ same suffix match comparison. │
1154 │ │ │ │ Since version 1.24, multiple │
1155 │ │ │ │ valid FQDNs can be passed as a │
1156 │ │ │ │ ";" delimited list. │
1157 ├──────────────────────────────────┼──────────────────────┼───────────────┼────────────────────────────────┤
1158 │phase2-private-key │ byte array │ │ Contains the "phase 2" inner │
1159 │ │ │ │ private key when the │
1160 │ │ │ │ "phase2-auth" or │
1161 │ │ │ │ "phase2-autheap" property is │
1162 │ │ │ │ set to "tls". │
1163 │ │ │ │ │
1164 │ │ │ │ Key data is specified using a │
1165 │ │ │ │ "scheme"; two are currently │
1166 │ │ │ │ supported: blob and path. When │
1167 │ │ │ │ using the blob scheme and │
1168 │ │ │ │ private keys, this property │
1169 │ │ │ │ should be set to the key's │
1170 │ │ │ │ encrypted PEM encoded data. │
1171 │ │ │ │ When using private keys with │
1172 │ │ │ │ the path scheme, this property │
1173 │ │ │ │ should be set to the full │
1174 │ │ │ │ UTF-8 encoded path of the key, │
1175 │ │ │ │ prefixed with the string │
1176 │ │ │ │ "file://" and ending with a │
1177 │ │ │ │ terminating NUL byte. When │
1178 │ │ │ │ using PKCS#12 format private │
1179 │ │ │ │ keys and the blob scheme, this │
1180 │ │ │ │ property should be set to the │
1181 │ │ │ │ PKCS#12 data and the │
1182 │ │ │ │ "phase2-private-key-password" │
1183 │ │ │ │ property must be set to │
1184 │ │ │ │ password used to decrypt the │
1185 │ │ │ │ PKCS#12 certificate and key. │
1186 │ │ │ │ When using PKCS#12 files and │
1187 │ │ │ │ the path scheme, this property │
1188 │ │ │ │ should be set to the full │
1189 │ │ │ │ UTF-8 encoded path of the key, │
1190 │ │ │ │ prefixed with the string │
1191 │ │ │ │ "file://" and ending with a │
1192 │ │ │ │ terminating NUL byte, and as │
1193 │ │ │ │ with the blob scheme the │
1194 │ │ │ │ "phase2-private-key-password" │
1195 │ │ │ │ property must be set to the │
1196 │ │ │ │ password used to decode the │
1197 │ │ │ │ PKCS#12 private key and │
1198 │ │ │ │ certificate. │
1199 ├──────────────────────────────────┼──────────────────────┼───────────────┼────────────────────────────────┤
1200 │phase2-private-key-password │ string │ │ The password used to decrypt │
1201 │ │ │ │ the "phase 2" private key │
1202 │ │ │ │ specified in the │
1203 │ │ │ │ "phase2-private-key" property │
1204 │ │ │ │ when the private key either │
1205 │ │ │ │ uses the path scheme, or is a │
1206 │ │ │ │ PKCS#12 format key. │
1207 ├──────────────────────────────────┼──────────────────────┼───────────────┼────────────────────────────────┤
1208 │phase2-private-key-password-flags │ NMSettingSecretFlags │ │ Flags indicating how to handle │
1209 │ │ (uint32) │ │ the │
1210 │ │ │ │ "phase2-private-key-password" │
1211 │ │ │ │ property. │
1212 ├──────────────────────────────────┼──────────────────────┼───────────────┼────────────────────────────────┤
1213 │phase2-subject-match │ string │ │ Substring to be matched │
1214 │ │ │ │ against the subject of the │
1215 │ │ │ │ certificate presented by the │
1216 │ │ │ │ authentication server during │
1217 │ │ │ │ the inner "phase 2" │
1218 │ │ │ │ authentication. When unset, no │
1219 │ │ │ │ verification of the │
1220 │ │ │ │ authentication server │
1221 │ │ │ │ certificate's subject is │
1222 │ │ │ │ performed. This property │
1223 │ │ │ │ provides little security, if │
1224 │ │ │ │ any, and should not be used. │
1225 │ │ │ │ │
1226 │ │ │ │ This property is deprecated │
1227 │ │ │ │ since version 1.2.Use │
1228 │ │ │ │ "phase2-domain-suffix-match" │
1229 │ │ │ │ instead. │
1230 ├──────────────────────────────────┼──────────────────────┼───────────────┼────────────────────────────────┤
1231 │pin │ string │ │ PIN used for EAP │
1232 │ │ │ │ authentication methods. │
1233 ├──────────────────────────────────┼──────────────────────┼───────────────┼────────────────────────────────┤
1234 │pin-flags │ NMSettingSecretFlags │ │ Flags indicating how to handle │
1235 │ │ (uint32) │ │ the "pin" property. │
1236 ├──────────────────────────────────┼──────────────────────┼───────────────┼────────────────────────────────┤
1237 │private-key │ byte array │ │ Contains the private key when │
1238 │ │ │ │ the "eap" property is set to │
1239 │ │ │ │ "tls". │
1240 │ │ │ │ │
1241 │ │ │ │ Key data is specified using a │
1242 │ │ │ │ "scheme"; two are currently │
1243 │ │ │ │ supported: blob and path. When │
1244 │ │ │ │ using the blob scheme and │
1245 │ │ │ │ private keys, this property │
1246 │ │ │ │ should be set to the key's │
1247 │ │ │ │ encrypted PEM encoded data. │
1248 │ │ │ │ When using private keys with │
1249 │ │ │ │ the path scheme, this property │
1250 │ │ │ │ should be set to the full │
1251 │ │ │ │ UTF-8 encoded path of the key, │
1252 │ │ │ │ prefixed with the string │
1253 │ │ │ │ "file://" and ending with a │
1254 │ │ │ │ terminating NUL byte. When │
1255 │ │ │ │ using PKCS#12 format private │
1256 │ │ │ │ keys and the blob scheme, this │
1257 │ │ │ │ property should be set to the │
1258 │ │ │ │ PKCS#12 data and the │
1259 │ │ │ │ "private-key-password" │
1260 │ │ │ │ property must be set to │
1261 │ │ │ │ password used to decrypt the │
1262 │ │ │ │ PKCS#12 certificate and key. │
1263 │ │ │ │ When using PKCS#12 files and │
1264 │ │ │ │ the path scheme, this property │
1265 │ │ │ │ should be set to the full │
1266 │ │ │ │ UTF-8 encoded path of the key, │
1267 │ │ │ │ prefixed with the string │
1268 │ │ │ │ "file://" and ending with a │
1269 │ │ │ │ terminating NUL byte, and as │
1270 │ │ │ │ with the blob scheme the │
1271 │ │ │ │ "private-key-password" │
1272 │ │ │ │ property must be set to the │
1273 │ │ │ │ password used to decode the │
1274 │ │ │ │ PKCS#12 private key and │
1275 │ │ │ │ certificate. │
1276 │ │ │ │ │
1277 │ │ │ │ WARNING: "private-key" is not │
1278 │ │ │ │ a "secret" property, and thus │
1279 │ │ │ │ unencrypted private key data │
1280 │ │ │ │ using the BLOB scheme may be │
1281 │ │ │ │ readable by unprivileged │
1282 │ │ │ │ users. Private keys should │
1283 │ │ │ │ always be encrypted with a │
1284 │ │ │ │ private key password to │
1285 │ │ │ │ prevent unauthorized access to │
1286 │ │ │ │ unencrypted private key data. │
1287 ├──────────────────────────────────┼──────────────────────┼───────────────┼────────────────────────────────┤
1288 │private-key-password │ string │ │ The password used to decrypt │
1289 │ │ │ │ the private key specified in │
1290 │ │ │ │ the "private-key" property │
1291 │ │ │ │ when the private key either │
1292 │ │ │ │ uses the path scheme, or if │
1293 │ │ │ │ the private key is a PKCS#12 │
1294 │ │ │ │ format key. │
1295 ├──────────────────────────────────┼──────────────────────┼───────────────┼────────────────────────────────┤
1296 │private-key-password-flags │ NMSettingSecretFlags │ │ Flags indicating how to handle │
1297 │ │ (uint32) │ │ the "private-key-password" │
1298 │ │ │ │ property. │
1299 ├──────────────────────────────────┼──────────────────────┼───────────────┼────────────────────────────────┤
1300 │subject-match │ string │ │ Substring to be matched │
1301 │ │ │ │ against the subject of the │
1302 │ │ │ │ certificate presented by the │
1303 │ │ │ │ authentication server. When │
1304 │ │ │ │ unset, no verification of the │
1305 │ │ │ │ authentication server │
1306 │ │ │ │ certificate's subject is │
1307 │ │ │ │ performed. This property │
1308 │ │ │ │ provides little security, if │
1309 │ │ │ │ any, and should not be used. │
1310 │ │ │ │ │
1311 │ │ │ │ This property is deprecated │
1312 │ │ │ │ since version 1.2.Use │
1313 │ │ │ │ "phase2-domain-suffix-match" │
1314 │ │ │ │ instead. │
1315 ├──────────────────────────────────┼──────────────────────┼───────────────┼────────────────────────────────┤
1316 │system-ca-certs │ boolean │ FALSE │ When TRUE, overrides the │
1317 │ │ │ │ "ca-path" and "phase2-ca-path" │
1318 │ │ │ │ properties using the system CA │
1319 │ │ │ │ directory specified at │
1320 │ │ │ │ configure time with the │
1321 │ │ │ │ --system-ca-path switch. The │
1322 │ │ │ │ certificates in this directory │
1323 │ │ │ │ are added to the verification │
1324 │ │ │ │ chain in addition to any │
1325 │ │ │ │ certificates specified by the │
1326 │ │ │ │ "ca-cert" and "phase2-ca-cert" │
1327 │ │ │ │ properties. If the path │
1328 │ │ │ │ provided with --system-ca-path │
1329 │ │ │ │ is rather a file name (bundle │
1330 │ │ │ │ of trusted CA certificates), │
1331 │ │ │ │ it overrides "ca-cert" and │
1332 │ │ │ │ "phase2-ca-cert" properties │
1333 │ │ │ │ instead (sets ca_cert/ca_cert2 │
1334 │ │ │ │ options for wpa_supplicant). │
1335 └──────────────────────────────────┴──────────────────────┴───────────────┴────────────────────────────────┘
1336 adsl setting
1338 ADSL Settings.
1339 ┌───────────────┬──────────────────────┬───────────────┬──────────────────┐
1341 │Key Name │ Value Type │ Default Value │ Value │
1342 │ │ │ │ Description │
1343 ├───────────────┼──────────────────────┼───────────────┼──────────────────┤
1344 │encapsulation │ string │ │ Encapsulation of │
1345 │ │ │ │ ADSL connection. │
1346 │ │ │ │ Can be "vcmux" │
1347 │ │ │ │ or "llc". │
1348 ├───────────────┼──────────────────────┼───────────────┼──────────────────┤
1349 │password │ string │ │ Password used to │
1350 │ │ │ │ authenticate │
1351 │ │ │ │ with the ADSL │
1352 │ │ │ │ service. │
1353 ├───────────────┼──────────────────────┼───────────────┼──────────────────┤
1354 │password-flags │ NMSettingSecretFlags │ │ Flags indicating │
1355 │ │ (uint32) │ │ how to handle │
1356 │ │ │ │ the "password" │
1357 │ │ │ │ property. │
1358 ├───────────────┼──────────────────────┼───────────────┼──────────────────┤
1359 │protocol │ string │ │ ADSL connection │
1360 │ │ │ │ protocol. Can │
1361 │ │ │ │ be "pppoa", │
1362 │ │ │ │ "pppoe" or │
1363 │ │ │ │ "ipoatm". │
1364 ├───────────────┼──────────────────────┼───────────────┼──────────────────┤
1365 │username │ string │ │ Username used to │
1366 │ │ │ │ authenticate │
1367 │ │ │ │ with the ADSL │
1368 │ │ │ │ service. │
1369 ├───────────────┼──────────────────────┼───────────────┼──────────────────┤
1370 │vci │ uint32 │ 0 │ VCI of ADSL │
1371 │ │ │ │ connection │
1372 ├───────────────┼──────────────────────┼───────────────┼──────────────────┤
1373 │vpi │ uint32 │ 0 │ VPI of ADSL │
1374 │ │ │ │ connection │
1375 └───────────────┴──────────────────────┴───────────────┴──────────────────┘
1376 bluetooth setting
1378 Bluetooth Settings.
1379 ┌─────────┬────────────┬───────────────┬──────────────────┐
1381 │Key Name │ Value Type │ Default Value │ Value │
1382 │ │ │ │ Description │
1383 ├─────────┼────────────┼───────────────┼──────────────────┤
1384 │bdaddr │ byte array │ │ The Bluetooth │
1385 │ │ │ │ address of the │
1386 │ │ │ │ device. │
1387 ├─────────┼────────────┼───────────────┼──────────────────┤
1388 │type │ string │ │ Either "dun" for │
1389 │ │ │ │ Dial-Up │
1390 │ │ │ │ Networking │
1391 │ │ │ │ connections or │
1392 │ │ │ │ "panu" for │
1393 │ │ │ │ Personal Area │
1394 │ │ │ │ Networking │
1395 │ │ │ │ connections to │
1396 │ │ │ │ devices │
1397 │ │ │ │ supporting the │
1398 │ │ │ │ NAP profile. │
1399 └─────────┴────────────┴───────────────┴──────────────────┘
1400 bond setting
1402 Bonding Settings.
1403 ┌───────────────┬────────────────┬───────────────┬────────────────────────────┐
1405 │Key Name │ Value Type │ Default Value │ Value │
1406 │ │ │ │ Description │
1407 ├───────────────┼────────────────┼───────────────┼────────────────────────────┤
1408 │interface-name │ string │ │ Deprecated in │
1409 │ │ │ │ favor of │
1410 │ │ │ │ connection.interface-name, │
1411 │ │ │ │ but can be used │
1412 │ │ │ │ for │
1413 │ │ │ │ backward-compatibility │
1414 │ │ │ │ with older │
1415 │ │ │ │ daemons, to set │
1416 │ │ │ │ the bond's │
1417 │ │ │ │ interface name. │
1418 ├───────────────┼────────────────┼───────────────┼────────────────────────────┤
1419 │options │ dict of string │ {'mode': │ Dictionary of key/value │
1420 │ │ to string │ 'balance-rr'} │ pairs of bonding options. │
1421 │ │ │ │ Both keys and values must │
1422 │ │ │ │ be strings. Option names │
1423 │ │ │ │ must contain only │
1424 │ │ │ │ alphanumeric characters │
1425 │ │ │ │ (ie, [a-zA-Z0-9]). │
1426 └───────────────┴────────────────┴───────────────┴────────────────────────────┘
1427 bridge setting
1429 Bridging Settings.
1430 ┌──────────────────────────────────┬──────────────────┬───────────────┬───────────────────────────────┐
1432 │Key Name │ Value Type │ Default Value │ Value │
1433 │ │ │ │ Description │
1434 ├──────────────────────────────────┼──────────────────┼───────────────┼───────────────────────────────┤
1435 │ageing-time │ uint32 │ 300 │ The Ethernet MAC │
1436 │ │ │ │ address aging │
1437 │ │ │ │ time, in │
1438 │ │ │ │ seconds. │
1439 ├──────────────────────────────────┼──────────────────┼───────────────┼───────────────────────────────┤
1440 │forward-delay │ uint32 │ 15 │ The Spanning │
1441 │ │ │ │ Tree Protocol │
1442 │ │ │ │ (STP) forwarding │
1443 │ │ │ │ delay, in │
1444 │ │ │ │ seconds. │
1445 ├──────────────────────────────────┼──────────────────┼───────────────┼───────────────────────────────┤
1446 │group-address │ byte array │ │ If specified, │
1447 │ │ │ │ The MAC address │
1448 │ │ │ │ of the multicast │
1449 │ │ │ │ group this │
1450 │ │ │ │ bridge uses for │
1451 │ │ │ │ STP. │
1452 │ │ │ │ │
1453 │ │ │ │ The address must │
1454 │ │ │ │ be a link-local │
1455 │ │ │ │ address in │
1456 │ │ │ │ standard │
1457 │ │ │ │ Ethernet MAC │
1458 │ │ │ │ address format, │
1459 │ │ │ │ ie an address of │
1460 │ │ │ │ the form │
1461 │ │ │ │ 01:80:C2:00:00:0X, │
1462 │ │ │ │ with X in [0, │
1463 │ │ │ │ 4..F]. If not │
1464 │ │ │ │ specified the │
1465 │ │ │ │ default value is │
1466 │ │ │ │ 01:80:C2:00:00:00. │
1467 ├──────────────────────────────────┼──────────────────┼───────────────┼───────────────────────────────┤
1468 │group-forward-mask │ uint32 │ 0 │ A mask of group │
1469 │ │ │ │ addresses to │
1470 │ │ │ │ forward. Usually, │
1471 │ │ │ │ group addresses in │
1472 │ │ │ │ the range from │
1473 │ │ │ │ 01:80:C2:00:00:00 │
1474 │ │ │ │ to │
1475 │ │ │ │ 01:80:C2:00:00:0F │
1476 │ │ │ │ are not forwarded │
1477 │ │ │ │ according to │
1478 │ │ │ │ standards. This │
1479 │ │ │ │ property is a mask │
1480 │ │ │ │ of 16 bits, each │
1481 │ │ │ │ corresponding to a │
1482 │ │ │ │ group address in │
1483 │ │ │ │ that range that │
1484 │ │ │ │ must be forwarded. │
1485 │ │ │ │ The mask can't │
1486 │ │ │ │ have bits 0, 1 or │
1487 │ │ │ │ 2 set because they │
1488 │ │ │ │ are used for STP, │
1489 │ │ │ │ MAC pause frames │
1490 │ │ │ │ and LACP. │
1491 ├──────────────────────────────────┼──────────────────┼───────────────┼───────────────────────────────┤
1492 │hello-time │ uint32 │ 2 │ The Spanning Tree │
1493 │ │ │ │ Protocol (STP) │
1494 │ │ │ │ hello time, in │
1495 │ │ │ │ seconds. │
1496 ├──────────────────────────────────┼──────────────────┼───────────────┼───────────────────────────────┤
1497 │interface-name │ string │ │ Deprecated in │
1498 │ │ │ │ favor of │
1499 │ │ │ │ connection.interface-name, │
1500 │ │ │ │ but can be used │
1501 │ │ │ │ for │
1502 │ │ │ │ backward-compatibility │
1503 │ │ │ │ with older │
1504 │ │ │ │ daemons, to set │
1505 │ │ │ │ the bridge's │
1506 │ │ │ │ interface name. │
1507 ├──────────────────────────────────┼──────────────────┼───────────────┼───────────────────────────────┤
1508 │mac-address │ byte array │ │ If specified, the MAC │
1509 │ │ │ │ address of bridge. When │
1510 │ │ │ │ creating a new bridge, │
1511 │ │ │ │ this MAC address will be │
1512 │ │ │ │ set. │
1513 │ │ │ │ │
1514 │ │ │ │ If this field is left │
1515 │ │ │ │ unspecified, the │
1516 │ │ │ │ "ethernet.cloned-mac-address" │
1517 │ │ │ │ is referred instead to │
1518 │ │ │ │ generate the initial MAC │
1519 │ │ │ │ address. Note that setting │
1520 │ │ │ │ "ethernet.cloned-mac-address" │
1521 │ │ │ │ anyway overwrites the MAC │
1522 │ │ │ │ address of the bridge │
1523 │ │ │ │ later while activating the │
1524 │ │ │ │ bridge. │
1525 │ │ │ │ │
1526 │ │ │ │ This property is │
1527 │ │ │ │ deprecated since version │
1528 │ │ │ │ 1.12.Use the │
1529 │ │ │ │ "cloned-mac-address" │
1530 │ │ │ │ property instead. │
1531 ├──────────────────────────────────┼──────────────────┼───────────────┼───────────────────────────────┤
1532 │max-age │ uint32 │ 20 │ The Spanning Tree Protocol │
1533 │ │ │ │ (STP) maximum message age, in │
1534 │ │ │ │ seconds. │
1535 ├──────────────────────────────────┼──────────────────┼───────────────┼───────────────────────────────┤
1536 │multicast-hash-max │ uint32 │ 4096 │ Set maximum size of multicast │
1537 │ │ │ │ hash table (value must be a │
1538 │ │ │ │ power of 2). │
1539 ├──────────────────────────────────┼──────────────────┼───────────────┼───────────────────────────────┤
1540 │multicast-last-member-count │ uint32 │ 2 │ Set the number of queries the │
1541 │ │ │ │ bridge will send before │
1542 │ │ │ │ stopping forwarding a │
1543 │ │ │ │ multicast group after a │
1544 │ │ │ │ "leave" message has been │
1545 │ │ │ │ received. │
1546 ├──────────────────────────────────┼──────────────────┼───────────────┼───────────────────────────────┤
1547 │multicast-last-member-interval │ uint64 │ 100 │ Set interval (in deciseconds) │
1548 │ │ │ │ between queries to find │
1549 │ │ │ │ remaining members of a group, │
1550 │ │ │ │ after a "leave" message is │
1551 │ │ │ │ received. │
1552 ├──────────────────────────────────┼──────────────────┼───────────────┼───────────────────────────────┤
1553 │multicast-membership-interval │ uint64 │ 26000 │ Set delay (in deciseconds) │
1554 │ │ │ │ after which the bridge will │
1555 │ │ │ │ leave a group, if no │
1556 │ │ │ │ membership reports for this │
1557 │ │ │ │ group are received. │
1558 ├──────────────────────────────────┼──────────────────┼───────────────┼───────────────────────────────┤
1559 │multicast-querier │ boolean │ FALSE │ Enable or disable sending of │
1560 │ │ │ │ multicast queries by the │
1561 │ │ │ │ bridge. If not specified the │
1562 │ │ │ │ option is disabled. │
1563 ├──────────────────────────────────┼──────────────────┼───────────────┼───────────────────────────────┤
1564 │multicast-querier-interval │ uint64 │ 25500 │ If no queries are seen after │
1565 │ │ │ │ this delay (in deciseconds) │
1566 │ │ │ │ has passed, the bridge will │
1567 │ │ │ │ start to send its own │
1568 │ │ │ │ queries. │
1569 ├──────────────────────────────────┼──────────────────┼───────────────┼───────────────────────────────┤
1570 │multicast-query-interval │ uint64 │ 12500 │ Interval (in deciseconds) │
1571 │ │ │ │ between queries sent by the │
1572 │ │ │ │ bridge after the end of the │
1573 │ │ │ │ startup phase. │
1574 ├──────────────────────────────────┼──────────────────┼───────────────┼───────────────────────────────┤
1575 │multicast-query-response-interval │ uint64 │ 1000 │ Set the Max Response Time/Max │
1576 │ │ │ │ Response Delay (in │
1577 │ │ │ │ deciseconds) for IGMP/MLD │
1578 │ │ │ │ queries sent by the bridge. │
1579 ├──────────────────────────────────┼──────────────────┼───────────────┼───────────────────────────────┤
1580 │multicast-query-use-ifaddr │ boolean │ FALSE │ If enabled the bridge's own │
1581 │ │ │ │ IP address is used as the │
1582 │ │ │ │ source address for IGMP │
1583 │ │ │ │ queries otherwise the default │
1584 │ │ │ │ of 0.0.0.0 is used. │
1585 ├──────────────────────────────────┼──────────────────┼───────────────┼───────────────────────────────┤
1586 │multicast-router │ string │ │ Sets bridge's multicast │
1587 │ │ │ │ router. Multicast-snooping │
1588 │ │ │ │ must be enabled for this │
1589 │ │ │ │ option to work. │
1590 │ │ │ │ │
1591 │ │ │ │ Supported values are: 'auto', │
1592 │ │ │ │ 'disabled', 'enabled' to │
1593 │ │ │ │ which kernel assigns the │
1594 │ │ │ │ numbers 1, 0, and 2, │
1595 │ │ │ │ respectively. If not │
1596 │ │ │ │ specified the default value │
1597 │ │ │ │ is 'auto' (1). │
1598 ├──────────────────────────────────┼──────────────────┼───────────────┼───────────────────────────────┤
1599 │multicast-snooping │ boolean │ TRUE │ Controls whether IGMP │
1600 │ │ │ │ snooping is enabled for this │
1601 │ │ │ │ bridge. Note that if snooping │
1602 │ │ │ │ was automatically disabled │
1603 │ │ │ │ due to hash collisions, the │
1604 │ │ │ │ system may refuse to enable │
1605 │ │ │ │ the feature until the │
1606 │ │ │ │ collisions are resolved. │
1607 ├──────────────────────────────────┼──────────────────┼───────────────┼───────────────────────────────┤
1608 │multicast-startup-query-count │ uint32 │ 2 │ Set the number of IGMP │
1609 │ │ │ │ queries to send during │
1610 │ │ │ │ startup phase. │
1611 ├──────────────────────────────────┼──────────────────┼───────────────┼───────────────────────────────┤
1612 │multicast-startup-query-interval │ uint64 │ 3125 │ Sets the time (in │
1613 │ │ │ │ deciseconds) between queries │
1614 │ │ │ │ sent out at startup to │
1615 │ │ │ │ determine membership │
1616 │ │ │ │ information. │
1617 ├──────────────────────────────────┼──────────────────┼───────────────┼───────────────────────────────┤
1618 │priority │ uint32 │ 32768 │ Sets the Spanning Tree │
1619 │ │ │ │ Protocol (STP) priority for │
1620 │ │ │ │ this bridge. Lower values │
1621 │ │ │ │ are "better"; the lowest │
1622 │ │ │ │ priority bridge will be │
1623 │ │ │ │ elected the root bridge. │
1624 ├──────────────────────────────────┼──────────────────┼───────────────┼───────────────────────────────┤
1625 │stp │ boolean │ TRUE │ Controls whether Spanning │
1626 │ │ │ │ Tree Protocol (STP) is │
1627 │ │ │ │ enabled for this bridge. │
1628 ├──────────────────────────────────┼──────────────────┼───────────────┼───────────────────────────────┤
1629 │vlan-default-pvid │ uint32 │ 1 │ The default PVID for the │
1630 │ │ │ │ ports of the bridge, that is │
1631 │ │ │ │ the VLAN id assigned to │
1632 │ │ │ │ incoming untagged frames. │
1633 ├──────────────────────────────────┼──────────────────┼───────────────┼───────────────────────────────┤
1634 │vlan-filtering │ boolean │ FALSE │ Control whether VLAN │
1635 │ │ │ │ filtering is enabled on the │
1636 │ │ │ │ bridge. │
1637 ├──────────────────────────────────┼──────────────────┼───────────────┼───────────────────────────────┤
1638 │vlan-protocol │ string │ │ If specified, the protocol │
1639 │ │ │ │ used for VLAN filtering. │
1640 │ │ │ │ │
1641 │ │ │ │ Supported values are: │
1642 │ │ │ │ '802.1Q', '802.1ad'. If not │
1643 │ │ │ │ specified the default value │
1644 │ │ │ │ is '802.1Q'. │
1645 ├──────────────────────────────────┼──────────────────┼───────────────┼───────────────────────────────┤
1646 │vlan-stats-enabled │ boolean │ FALSE │ Controls whether per-VLAN │
1647 │ │ │ │ stats accounting is enabled. │
1648 ├──────────────────────────────────┼──────────────────┼───────────────┼───────────────────────────────┤
1649 │vlans │ array of vardict │ │ Array of bridge VLAN objects. │
1650 │ │ │ │ In addition to the VLANs │
1651 │ │ │ │ specified here, the bridge │
1652 │ │ │ │ will also have the │
1653 │ │ │ │ default-pvid VLAN configured │
1654 │ │ │ │ by the │
1655 │ │ │ │ bridge.vlan-default-pvid │
1656 │ │ │ │ property. │
1657 │ │ │ │ │
1658 │ │ │ │ In nmcli the VLAN list can be │
1659 │ │ │ │ specified with the following │
1660 │ │ │ │ syntax: │
1661 │ │ │ │ │
1662 │ │ │ │ $vid [pvid] [untagged] [, │
1663 │ │ │ │ $vid [pvid] [untagged]]... │
1664 │ │ │ │ │
1665 │ │ │ │ where $vid is either a single │
1666 │ │ │ │ id between 1 and 4094 or a │
1667 │ │ │ │ range, represented as a │
1668 │ │ │ │ couple of ids separated by a │
1669 │ │ │ │ dash. │
1670 └──────────────────────────────────┴──────────────────┴───────────────┴───────────────────────────────┘
1671 bridge-port setting
1673 Bridge Port Settings.
1674 ┌─────────────┬──────────────────┬───────────────┬──────────────────────────┐
1676 │Key Name │ Value Type │ Default Value │ Value │
1677 │ │ │ │ Description │
1678 ├─────────────┼──────────────────┼───────────────┼──────────────────────────┤
1679 │hairpin-mode │ boolean │ FALSE │ Enables or │
1680 │ │ │ │ disables │
1681 │ │ │ │ "hairpin mode" │
1682 │ │ │ │ for the port, │
1683 │ │ │ │ which allows │
1684 │ │ │ │ frames to be │
1685 │ │ │ │ sent back out │
1686 │ │ │ │ through the port │
1687 │ │ │ │ the frame was │
1688 │ │ │ │ received on. │
1689 ├─────────────┼──────────────────┼───────────────┼──────────────────────────┤
1690 │path-cost │ uint32 │ 100 │ The Spanning │
1691 │ │ │ │ Tree Protocol │
1692 │ │ │ │ (STP) port cost │
1693 │ │ │ │ for destinations │
1694 │ │ │ │ via this port. │
1695 ├─────────────┼──────────────────┼───────────────┼──────────────────────────┤
1696 │priority │ uint32 │ 32 │ The Spanning │
1697 │ │ │ │ Tree Protocol │
1698 │ │ │ │ (STP) priority │
1699 │ │ │ │ of this bridge │
1700 │ │ │ │ port. │
1701 ├─────────────┼──────────────────┼───────────────┼──────────────────────────┤
1702 │vlans │ array of vardict │ │ Array of bridge │
1703 │ │ │ │ VLAN objects. In │
1704 │ │ │ │ addition to the │
1705 │ │ │ │ VLANs specified │
1706 │ │ │ │ here, the port │
1707 │ │ │ │ will also have │
1708 │ │ │ │ the default-pvid │
1709 │ │ │ │ VLAN configured │
1710 │ │ │ │ on the bridge by │
1711 │ │ │ │ the │
1712 │ │ │ │ bridge.vlan-default-pvid │
1713 │ │ │ │ property. │
1714 │ │ │ │ │
1715 │ │ │ │ In nmcli the │
1716 │ │ │ │ VLAN list can be │
1717 │ │ │ │ specified with │
1718 │ │ │ │ the following │
1719 │ │ │ │ syntax: │
1720 │ │ │ │ │
1721 │ │ │ │ $vid [pvid] │
1722 │ │ │ │ [untagged] [, │
1723 │ │ │ │ $vid [pvid] │
1724 │ │ │ │ [untagged]]... │
1725 │ │ │ │ │
1726 │ │ │ │ where $vid is │
1727 │ │ │ │ either a single │
1728 │ │ │ │ id between 1 and │
1729 │ │ │ │ 4094 or a range, │
1730 │ │ │ │ represented as a │
1731 │ │ │ │ couple of ids │
1732 │ │ │ │ separated by a │
1733 │ │ │ │ dash. │
1734 └─────────────┴──────────────────┴───────────────┴──────────────────────────┘
1735 cdma setting
1737 CDMA-based Mobile Broadband Settings.
1738 ┌───────────────┬──────────────────────┬───────────────┬──────────────────┐
1740 │Key Name │ Value Type │ Default Value │ Value │
1741 │ │ │ │ Description │
1742 ├───────────────┼──────────────────────┼───────────────┼──────────────────┤
1743 │mtu │ uint32 │ 0 │ If non-zero, │
1744 │ │ │ │ only transmit │
1745 │ │ │ │ packets of the │
1746 │ │ │ │ specified size │
1747 │ │ │ │ or smaller, │
1748 │ │ │ │ breaking larger │
1749 │ │ │ │ packets up into │
1750 │ │ │ │ multiple frames. │
1751 ├───────────────┼──────────────────────┼───────────────┼──────────────────┤
1752 │number │ string │ │ The number to │
1753 │ │ │ │ dial to │
1754 │ │ │ │ establish the │
1755 │ │ │ │ connection to │
1756 │ │ │ │ the CDMA-based │
1757 │ │ │ │ mobile broadband │
1758 │ │ │ │ network, if any. │
1759 │ │ │ │ If not │
1760 │ │ │ │ specified, the │
1761 │ │ │ │ default number │
1762 │ │ │ │ (#777) is used │
1763 │ │ │ │ when required. │
1764 ├───────────────┼──────────────────────┼───────────────┼──────────────────┤
1765 │password │ string │ │ The password │
1766 │ │ │ │ used to │
1767 │ │ │ │ authenticate │
1768 │ │ │ │ with the │
1769 │ │ │ │ network, if │
1770 │ │ │ │ required. Many │
1771 │ │ │ │ providers do not │
1772 │ │ │ │ require a │
1773 │ │ │ │ password, or │
1774 │ │ │ │ accept any │
1775 │ │ │ │ password. But │
1776 │ │ │ │ if a password is │
1777 │ │ │ │ required, it is │
1778 │ │ │ │ specified here. │
1779 ├───────────────┼──────────────────────┼───────────────┼──────────────────┤
1780 │password-flags │ NMSettingSecretFlags │ │ Flags indicating │
1781 │ │ (uint32) │ │ how to handle │
1782 │ │ │ │ the "password" │
1783 │ │ │ │ property. │
1784 ├───────────────┼──────────────────────┼───────────────┼──────────────────┤
1785 │username │ string │ │ The username │
1786 │ │ │ │ used to │
1787 │ │ │ │ authenticate │
1788 │ │ │ │ with the │
1789 │ │ │ │ network, if │
1790 │ │ │ │ required. Many │
1791 │ │ │ │ providers do not │
1792 │ │ │ │ require a │
1793 │ │ │ │ username, or │
1794 │ │ │ │ accept any │
1795 │ │ │ │ username. But │
1796 │ │ │ │ if a username is │
1797 │ │ │ │ required, it is │
1798 │ │ │ │ specified here. │
1799 └───────────────┴──────────────────────┴───────────────┴──────────────────┘
1800 dcb setting
1802 Data Center Bridging Settings.
1803 ┌────────────────────────────┬───────────────────┬───────────────┬───────────────────────────────┐
1805 │Key Name │ Value Type │ Default Value │ Value │
1806 │ │ │ │ Description │
1807 ├────────────────────────────┼───────────────────┼───────────────┼───────────────────────────────┤
1808 │app-fcoe-flags │ NMSettingDcbFlags │ │ Specifies the │
1809 │ │ (uint32) │ │ NMSettingDcbFlags │
1810 │ │ │ │ for the DCB FCoE │
1811 │ │ │ │ application. │
1812 │ │ │ │ Flags may be any │
1813 │ │ │ │ combination of │
1814 │ │ │ │ NM_SETTING_DCB_FLAG_ENABLE │
1815 │ │ │ │ (0x1), │
1816 │ │ │ │ NM_SETTING_DCB_FLAG_ADVERTISE │
1817 │ │ │ │ (0x2), and │
1818 │ │ │ │ NM_SETTING_DCB_FLAG_WILLING │
1819 │ │ │ │ (0x4). │
1820 ├────────────────────────────┼───────────────────┼───────────────┼───────────────────────────────┤
1821 │app-fcoe-mode │ string │ │ The FCoE controller mode; │
1822 │ │ │ │ either "fabric" or "vn2vn". │
1823 │ │ │ │ │
1824 │ │ │ │ Since 1.34, NULL is the │
1825 │ │ │ │ default and means "fabric". │
1826 │ │ │ │ Before 1.34, NULL was │
1827 │ │ │ │ rejected as invalid and the │
1828 │ │ │ │ default was "fabric". │
1829 ├────────────────────────────┼───────────────────┼───────────────┼───────────────────────────────┤
1830 │app-fcoe-priority │ int32 │ -1 │ The highest User Priority (0 │
1831 │ │ │ │ - 7) which FCoE frames should │
1832 │ │ │ │ use, or -1 for default │
1833 │ │ │ │ priority. Only used when the │
1834 │ │ │ │ "app-fcoe-flags" property │
1835 │ │ │ │ includes the │
1836 │ │ │ │ NM_SETTING_DCB_FLAG_ENABLE │
1837 │ │ │ │ (0x1) flag. │
1838 ├────────────────────────────┼───────────────────┼───────────────┼───────────────────────────────┤
1839 │app-fip-flags │ NMSettingDcbFlags │ │ Specifies the │
1840 │ │ (uint32) │ │ NMSettingDcbFlags for the DCB │
1841 │ │ │ │ FIP application. Flags may │
1842 │ │ │ │ be any combination of │
1843 │ │ │ │ NM_SETTING_DCB_FLAG_ENABLE │
1844 │ │ │ │ (0x1), │
1845 │ │ │ │ NM_SETTING_DCB_FLAG_ADVERTISE │
1846 │ │ │ │ (0x2), and │
1847 │ │ │ │ NM_SETTING_DCB_FLAG_WILLING │
1848 │ │ │ │ (0x4). │
1849 ├────────────────────────────┼───────────────────┼───────────────┼───────────────────────────────┤
1850 │app-fip-priority │ int32 │ -1 │ The highest User Priority (0 │
1851 │ │ │ │ - 7) which FIP frames should │
1852 │ │ │ │ use, or -1 for default │
1853 │ │ │ │ priority. Only used when the │
1854 │ │ │ │ "app-fip-flags" property │
1855 │ │ │ │ includes the │
1856 │ │ │ │ NM_SETTING_DCB_FLAG_ENABLE │
1857 │ │ │ │ (0x1) flag. │
1858 ├────────────────────────────┼───────────────────┼───────────────┼───────────────────────────────┤
1859 │app-iscsi-flags │ NMSettingDcbFlags │ │ Specifies the │
1860 │ │ (uint32) │ │ NMSettingDcbFlags for the DCB │
1861 │ │ │ │ iSCSI application. Flags may │
1862 │ │ │ │ be any combination of │
1863 │ │ │ │ NM_SETTING_DCB_FLAG_ENABLE │
1864 │ │ │ │ (0x1), │
1865 │ │ │ │ NM_SETTING_DCB_FLAG_ADVERTISE │
1866 │ │ │ │ (0x2), and │
1867 │ │ │ │ NM_SETTING_DCB_FLAG_WILLING │
1868 │ │ │ │ (0x4). │
1869 ├────────────────────────────┼───────────────────┼───────────────┼───────────────────────────────┤
1870 │app-iscsi-priority │ int32 │ -1 │ The highest User Priority (0 │
1871 │ │ │ │ - 7) which iSCSI frames │
1872 │ │ │ │ should use, or -1 for default │
1873 │ │ │ │ priority. Only used when the │
1874 │ │ │ │ "app-iscsi-flags" property │
1875 │ │ │ │ includes the │
1876 │ │ │ │ NM_SETTING_DCB_FLAG_ENABLE │
1877 │ │ │ │ (0x1) flag. │
1878 ├────────────────────────────┼───────────────────┼───────────────┼───────────────────────────────┤
1879 │priority-bandwidth │ array of uint32 │ │ An array of 8 uint values, │
1880 │ │ │ │ where the array index │
1881 │ │ │ │ corresponds to the User │
1882 │ │ │ │ Priority (0 - 7) and the │
1883 │ │ │ │ value indicates the │
1884 │ │ │ │ percentage of bandwidth of │
1885 │ │ │ │ the priority's assigned group │
1886 │ │ │ │ that the priority may use. │
1887 │ │ │ │ The sum of all percentages │
1888 │ │ │ │ for priorities which belong │
1889 │ │ │ │ to the same group must total │
1890 │ │ │ │ 100 percents. │
1891 ├────────────────────────────┼───────────────────┼───────────────┼───────────────────────────────┤
1892 │priority-flow-control │ array of uint32 │ │ An array of 8 boolean values, │
1893 │ │ │ │ where the array index │
1894 │ │ │ │ corresponds to the User │
1895 │ │ │ │ Priority (0 - 7) and the │
1896 │ │ │ │ value indicates whether or │
1897 │ │ │ │ not the corresponding │
1898 │ │ │ │ priority should transmit │
1899 │ │ │ │ priority pause. │
1900 ├────────────────────────────┼───────────────────┼───────────────┼───────────────────────────────┤
1901 │priority-flow-control-flags │ NMSettingDcbFlags │ │ Specifies the │
1902 │ │ (uint32) │ │ NMSettingDcbFlags for DCB │
1903 │ │ │ │ Priority Flow Control (PFC). │
1904 │ │ │ │ Flags may be any combination │
1905 │ │ │ │ of NM_SETTING_DCB_FLAG_ENABLE │
1906 │ │ │ │ (0x1), │
1907 │ │ │ │ NM_SETTING_DCB_FLAG_ADVERTISE │
1908 │ │ │ │ (0x2), and │
1909 │ │ │ │ NM_SETTING_DCB_FLAG_WILLING │
1910 │ │ │ │ (0x4). │
1911 ├────────────────────────────┼───────────────────┼───────────────┼───────────────────────────────┤
1912 │priority-group-bandwidth │ array of uint32 │ │ An array of 8 uint values, │
1913 │ │ │ │ where the array index │
1914 │ │ │ │ corresponds to the Priority │
1915 │ │ │ │ Group ID (0 - 7) and the │
1916 │ │ │ │ value indicates the │
1917 │ │ │ │ percentage of link bandwidth │
1918 │ │ │ │ allocated to that group. │
1919 │ │ │ │ Allowed values are 0 - 100, │
1920 │ │ │ │ and the sum of all values │
1921 │ │ │ │ must total 100 percents. │
1922 ├────────────────────────────┼───────────────────┼───────────────┼───────────────────────────────┤
1923 │priority-group-flags │ NMSettingDcbFlags │ │ Specifies the │
1924 │ │ (uint32) │ │ NMSettingDcbFlags for DCB │
1925 │ │ │ │ Priority Groups. Flags may │
1926 │ │ │ │ be any combination of │
1927 │ │ │ │ NM_SETTING_DCB_FLAG_ENABLE │
1928 │ │ │ │ (0x1), │
1929 │ │ │ │ NM_SETTING_DCB_FLAG_ADVERTISE │
1930 │ │ │ │ (0x2), and │
1931 │ │ │ │ NM_SETTING_DCB_FLAG_WILLING │
1932 │ │ │ │ (0x4). │
1933 ├────────────────────────────┼───────────────────┼───────────────┼───────────────────────────────┤
1934 │priority-group-id │ array of uint32 │ │ An array of 8 uint values, │
1935 │ │ │ │ where the array index │
1936 │ │ │ │ corresponds to the User │
1937 │ │ │ │ Priority (0 - 7) and the │
1938 │ │ │ │ value indicates the Priority │
1939 │ │ │ │ Group ID. Allowed Priority │
1940 │ │ │ │ Group ID values are 0 - 7 or │
1941 │ │ │ │ 15 for the unrestricted │
1942 │ │ │ │ group. │
1943 ├────────────────────────────┼───────────────────┼───────────────┼───────────────────────────────┤
1944 │priority-strict-bandwidth │ array of uint32 │ │ An array of 8 boolean values, │
1945 │ │ │ │ where the array index │
1946 │ │ │ │ corresponds to the User │
1947 │ │ │ │ Priority (0 - 7) and the │
1948 │ │ │ │ value indicates whether or │
1949 │ │ │ │ not the priority may use all │
1950 │ │ │ │ of the bandwidth allocated to │
1951 │ │ │ │ its assigned group. │
1952 ├────────────────────────────┼───────────────────┼───────────────┼───────────────────────────────┤
1953 │priority-traffic-class │ array of uint32 │ │ An array of 8 uint values, │
1954 │ │ │ │ where the array index │
1955 │ │ │ │ corresponds to the User │
1956 │ │ │ │ Priority (0 - 7) and the │
1957 │ │ │ │ value indicates the traffic │
1958 │ │ │ │ class (0 - 7) to which the │
1959 │ │ │ │ priority is mapped. │
1960 └────────────────────────────┴───────────────────┴───────────────┴───────────────────────────────┘
1961 dummy setting
1963 Dummy Link Settings.
1964 ethtool setting
1968 Ethtool Ethernet Settings.
1969 generic setting
1973 Generic Link Settings.
1974 gsm setting
1978 GSM-based Mobile Broadband Settings.
1979 ┌────────────────┬──────────────────────┬───────────────┬────────────────────┐
1981 │Key Name │ Value Type │ Default Value │ Value │
1982 │ │ │ │ Description │
1983 ├────────────────┼──────────────────────┼───────────────┼────────────────────┤
1984 │apn │ string │ │ The GPRS Access │
1985 │ │ │ │ Point Name │
1986 │ │ │ │ specifying the │
1987 │ │ │ │ APN used when │
1988 │ │ │ │ establishing a │
1989 │ │ │ │ data session │
1990 │ │ │ │ with the │
1991 │ │ │ │ GSM-based │
1992 │ │ │ │ network. The │
1993 │ │ │ │ APN often │
1994 │ │ │ │ determines how │
1995 │ │ │ │ the user will be │
1996 │ │ │ │ billed for their │
1997 │ │ │ │ network usage │
1998 │ │ │ │ and whether the │
1999 │ │ │ │ user has access │
2000 │ │ │ │ to the Internet │
2001 │ │ │ │ or just a │
2002 │ │ │ │ provider-specific │
2003 │ │ │ │ walled-garden, │
2004 │ │ │ │ so it is │
2005 │ │ │ │ important to use │
2006 │ │ │ │ the correct APN │
2007 │ │ │ │ for the user's │
2008 │ │ │ │ mobile broadband │
2009 │ │ │ │ plan. The APN │
2010 │ │ │ │ may only be │
2011 │ │ │ │ composed of the │
2012 │ │ │ │ characters a-z, │
2013 │ │ │ │ 0-9, ., and - │
2014 │ │ │ │ per GSM 03.60 │
2015 │ │ │ │ Section 14.9. │
2016 ├────────────────┼──────────────────────┼───────────────┼────────────────────┤
2017 │auto-config │ boolean │ FALSE │ When TRUE, the │
2018 │ │ │ │ settings such as │
2019 │ │ │ │ APN, username, or │
2020 │ │ │ │ password will │
2021 │ │ │ │ default to values │
2022 │ │ │ │ that match the │
2023 │ │ │ │ network the modem │
2024 │ │ │ │ will register to │
2025 │ │ │ │ in the Mobile │
2026 │ │ │ │ Broadband │
2027 │ │ │ │ Provider │
2028 │ │ │ │ database. │
2029 ├────────────────┼──────────────────────┼───────────────┼────────────────────┤
2030 │device-id │ string │ │ The device unique │
2031 │ │ │ │ identifier (as │
2032 │ │ │ │ given by the WWAN │
2033 │ │ │ │ management │
2034 │ │ │ │ service) which │
2035 │ │ │ │ this connection │
2036 │ │ │ │ applies to. If │
2037 │ │ │ │ given, the │
2038 │ │ │ │ connection will │
2039 │ │ │ │ only apply to the │
2040 │ │ │ │ specified device. │
2041 ├────────────────┼──────────────────────┼───────────────┼────────────────────┤
2042 │home-only │ boolean │ FALSE │ When TRUE, only │
2043 │ │ │ │ connections to │
2044 │ │ │ │ the home network │
2045 │ │ │ │ will be allowed. │
2046 │ │ │ │ Connections to │
2047 │ │ │ │ roaming networks │
2048 │ │ │ │ will not be made. │
2049 ├────────────────┼──────────────────────┼───────────────┼────────────────────┤
2050 │mtu │ uint32 │ 0 │ If non-zero, only │
2051 │ │ │ │ transmit packets │
2052 │ │ │ │ of the specified │
2053 │ │ │ │ size or smaller, │
2054 │ │ │ │ breaking larger │
2055 │ │ │ │ packets up into │
2056 │ │ │ │ multiple frames. │
2057 ├────────────────┼──────────────────────┼───────────────┼────────────────────┤
2058 │network-id │ string │ │ The Network ID │
2059 │ │ │ │ (GSM LAI format, │
2060 │ │ │ │ ie MCC-MNC) to │
2061 │ │ │ │ force specific │
2062 │ │ │ │ network │
2063 │ │ │ │ registration. If │
2064 │ │ │ │ the Network ID is │
2065 │ │ │ │ specified, │
2066 │ │ │ │ NetworkManager │
2067 │ │ │ │ will attempt to │
2068 │ │ │ │ force the device │
2069 │ │ │ │ to register only │
2070 │ │ │ │ on the specified │
2071 │ │ │ │ network. This can │
2072 │ │ │ │ be used to ensure │
2073 │ │ │ │ that the device │
2074 │ │ │ │ does not roam │
2075 │ │ │ │ when direct │
2076 │ │ │ │ roaming control │
2077 │ │ │ │ of the device is │
2078 │ │ │ │ not otherwise │
2079 │ │ │ │ possible. │
2080 ├────────────────┼──────────────────────┼───────────────┼────────────────────┤
2081 │number │ string │ │ Legacy setting │
2082 │ │ │ │ that used to help │
2083 │ │ │ │ establishing PPP │
2084 │ │ │ │ data sessions for │
2085 │ │ │ │ GSM-based modems. │
2086 │ │ │ │ │
2087 │ │ │ │ This property is │
2088 │ │ │ │ deprecated since │
2089 │ │ │ │ version │
2090 │ │ │ │ 1.16.User-provided │
2091 │ │ │ │ values for this │
2092 │ │ │ │ setting are no │
2093 │ │ │ │ longer used. │
2094 ├────────────────┼──────────────────────┼───────────────┼────────────────────┤
2095 │password │ string │ │ The password used │
2096 │ │ │ │ to authenticate │
2097 │ │ │ │ with the network, │
2098 │ │ │ │ if required. Many │
2099 │ │ │ │ providers do not │
2100 │ │ │ │ require a │
2101 │ │ │ │ password, or │
2102 │ │ │ │ accept any │
2103 │ │ │ │ password. But if │
2104 │ │ │ │ a password is │
2105 │ │ │ │ required, it is │
2106 │ │ │ │ specified here. │
2107 ├────────────────┼──────────────────────┼───────────────┼────────────────────┤
2108 │password-flags │ NMSettingSecretFlags │ │ Flags indicating │
2109 │ │ (uint32) │ │ how to handle the │
2110 │ │ │ │ "password" │
2111 │ │ │ │ property. │
2112 ├────────────────┼──────────────────────┼───────────────┼────────────────────┤
2113 │pin │ string │ │ If the SIM is │
2114 │ │ │ │ locked with a PIN │
2115 │ │ │ │ it must be │
2116 │ │ │ │ unlocked before │
2117 │ │ │ │ any other │
2118 │ │ │ │ operations are │
2119 │ │ │ │ requested. │
2120 │ │ │ │ Specify the PIN │
2121 │ │ │ │ here to allow │
2122 │ │ │ │ operation of the │
2123 │ │ │ │ device. │
2124 ├────────────────┼──────────────────────┼───────────────┼────────────────────┤
2125 │pin-flags │ NMSettingSecretFlags │ │ Flags indicating │
2126 │ │ (uint32) │ │ how to handle the │
2127 │ │ │ │ "pin" property. │
2128 ├────────────────┼──────────────────────┼───────────────┼────────────────────┤
2129 │sim-id │ string │ │ The SIM card │
2130 │ │ │ │ unique identifier │
2131 │ │ │ │ (as given by the │
2132 │ │ │ │ WWAN management │
2133 │ │ │ │ service) which │
2134 │ │ │ │ this connection │
2135 │ │ │ │ applies to. If │
2136 │ │ │ │ given, the │
2137 │ │ │ │ connection will │
2138 │ │ │ │ apply to any │
2139 │ │ │ │ device also │
2140 │ │ │ │ allowed by │
2141 │ │ │ │ "device-id" which │
2142 │ │ │ │ contains a SIM │
2143 │ │ │ │ card matching the │
2144 │ │ │ │ given identifier. │
2145 ├────────────────┼──────────────────────┼───────────────┼────────────────────┤
2146 │sim-operator-id │ string │ │ A MCC/MNC string │
2147 │ │ │ │ like "310260" or │
2148 │ │ │ │ "21601" │
2149 │ │ │ │ identifying the │
2150 │ │ │ │ specific mobile │
2151 │ │ │ │ network operator │
2152 │ │ │ │ which this │
2153 │ │ │ │ connection applies │
2154 │ │ │ │ to. If given, the │
2155 │ │ │ │ connection will │
2156 │ │ │ │ apply to any │
2157 │ │ │ │ device also │
2158 │ │ │ │ allowed by │
2159 │ │ │ │ "device-id" and │
2160 │ │ │ │ "sim-id" which │
2161 │ │ │ │ contains a SIM │
2162 │ │ │ │ card provisioned │
2163 │ │ │ │ by the given │
2164 │ │ │ │ operator. │
2165 ├────────────────┼──────────────────────┼───────────────┼────────────────────┤
2166 │username │ string │ │ The username used │
2167 │ │ │ │ to authenticate │
2168 │ │ │ │ with the network, │
2169 │ │ │ │ if required. Many │
2170 │ │ │ │ providers do not │
2171 │ │ │ │ require a │
2172 │ │ │ │ username, or │
2173 │ │ │ │ accept any │
2174 │ │ │ │ username. But if │
2175 │ │ │ │ a username is │
2176 │ │ │ │ required, it is │
2177 │ │ │ │ specified here. │
2178 └────────────────┴──────────────────────┴───────────────┴────────────────────┘
2179 infiniband setting
2181 Infiniband Settings.
2182 ┌───────────────┬────────────┬───────────────┬─────────────────────────────┐
2184 │Key Name │ Value Type │ Default Value │ Value │
2185 │ │ │ │ Description │
2186 ├───────────────┼────────────┼───────────────┼─────────────────────────────┤
2187 │mac-address │ byte array │ │ If specified, │
2188 │ │ │ │ this connection │
2189 │ │ │ │ will only apply │
2190 │ │ │ │ to the IPoIB │
2191 │ │ │ │ device whose │
2192 │ │ │ │ permanent MAC │
2193 │ │ │ │ address matches. │
2194 │ │ │ │ This property │
2195 │ │ │ │ does not change │
2196 │ │ │ │ the MAC address │
2197 │ │ │ │ of the device │
2198 │ │ │ │ (i.e. MAC │
2199 │ │ │ │ spoofing). │
2200 ├───────────────┼────────────┼───────────────┼─────────────────────────────┤
2201 │mtu │ uint32 │ 0 │ If non-zero, │
2202 │ │ │ │ only transmit │
2203 │ │ │ │ packets of the │
2204 │ │ │ │ specified size │
2205 │ │ │ │ or smaller, │
2206 │ │ │ │ breaking larger │
2207 │ │ │ │ packets up into │
2208 │ │ │ │ multiple frames. │
2209 ├───────────────┼────────────┼───────────────┼─────────────────────────────┤
2210 │p-key │ int32 │ -1 │ The InfiniBand │
2211 │ │ │ │ p-key to use for │
2212 │ │ │ │ this device. A │
2213 │ │ │ │ value of -1 │
2214 │ │ │ │ means to use the │
2215 │ │ │ │ default p-key │
2216 │ │ │ │ (aka "the p-key │
2217 │ │ │ │ at index 0"). │
2218 │ │ │ │ Otherwise, it is │
2219 │ │ │ │ a 16-bit │
2220 │ │ │ │ unsigned │
2221 │ │ │ │ integer, whose │
2222 │ │ │ │ high bit 0x8000 │
2223 │ │ │ │ is set if it is │
2224 │ │ │ │ a "full │
2225 │ │ │ │ membership" │
2226 │ │ │ │ p-key. The │
2227 │ │ │ │ values 0 and │
2228 │ │ │ │ 0x8000 are not │
2229 │ │ │ │ allowed. │
2230 │ │ │ │ │
2231 │ │ │ │ With the p-key │
2232 │ │ │ │ set, the │
2233 │ │ │ │ interface name │
2234 │ │ │ │ is always │
2235 │ │ │ │ "$parent.$p_key". │
2236 │ │ │ │ Setting │
2237 │ │ │ │ "connection.interface-name" │
2238 │ │ │ │ to another name │
2239 │ │ │ │ is not │
2240 │ │ │ │ supported. │
2241 │ │ │ │ │
2242 │ │ │ │ Note that kernel │
2243 │ │ │ │ will internally │
2244 │ │ │ │ always set the │
2245 │ │ │ │ full membership │
2246 │ │ │ │ bit, although │
2247 │ │ │ │ the interface │
2248 │ │ │ │ name does not │
2249 │ │ │ │ reflect that. │
2250 │ │ │ │ Usually the user │
2251 │ │ │ │ would want to │
2252 │ │ │ │ configure a full │
2253 │ │ │ │ membership p-key │
2254 │ │ │ │ with 0x8000 flag │
2255 │ │ │ │ set. │
2256 ├───────────────┼────────────┼───────────────┼─────────────────────────────┤
2257 │parent │ string │ │ The interface name of the │
2258 │ │ │ │ parent device of this │
2259 │ │ │ │ device. Normally NULL, but │
2260 │ │ │ │ if the "p_key" property is │
2261 │ │ │ │ set, then you must specify │
2262 │ │ │ │ the base device by setting │
2263 │ │ │ │ either this property or │
2264 │ │ │ │ "mac-address". │
2265 ├───────────────┼────────────┼───────────────┼─────────────────────────────┤
2266 │transport-mode │ string │ │ The IP-over-InfiniBand │
2267 │ │ │ │ transport mode. Either │
2268 │ │ │ │ "datagram" or "connected". │
2269 └───────────────┴────────────┴───────────────┴─────────────────────────────┘
2270 ipv4 setting
2272 IPv4 Settings.
2273 ┌─────────────────────────────┬──────────────────┬───────────────┬────────────────────────────────────────┐
2275 │Key Name │ Value Type │ Default Value │ Value │
2276 │ │ │ │ Description │
2277 ├─────────────────────────────┼──────────────────┼───────────────┼────────────────────────────────────────┤
2278 │address-data │ array of vardict │ │ Array of IPv4 │
2279 │ │ │ │ addresses. Each │
2280 │ │ │ │ address │
2281 │ │ │ │ dictionary │
2282 │ │ │ │ contains at │
2283 │ │ │ │ least 'address' │
2284 │ │ │ │ and 'prefix' │
2285 │ │ │ │ entries, │
2286 │ │ │ │ containing the │
2287 │ │ │ │ IP address as a │
2288 │ │ │ │ string, and the │
2289 │ │ │ │ prefix length as │
2290 │ │ │ │ a uint32. │
2291 │ │ │ │ Additional │
2292 │ │ │ │ attributes may │
2293 │ │ │ │ also exist on │
2294 │ │ │ │ some addresses. │
2295 ├─────────────────────────────┼──────────────────┼───────────────┼────────────────────────────────────────┤
2296 │addresses │ array of array │ │ Deprecated in │
2297 │ │ of uint32 │ │ favor of the │
2298 │ │ │ │ 'address-data' │
2299 │ │ │ │ and 'gateway' │
2300 │ │ │ │ properties, but │
2301 │ │ │ │ this can be used │
2302 │ │ │ │ for │
2303 │ │ │ │ backward-compatibility │
2304 │ │ │ │ with older │
2305 │ │ │ │ daemons. Note │
2306 │ │ │ │ that if you send │
2307 │ │ │ │ this property │
2308 │ │ │ │ the daemon will │
2309 │ │ │ │ ignore │
2310 │ │ │ │ 'address-data' │
2311 │ │ │ │ and 'gateway'. │
2312 │ │ │ │ Array of IPv4 │
2313 │ │ │ │ address │
2314 │ │ │ │ structures. │
2315 │ │ │ │ Each IPv4 │
2316 │ │ │ │ address │
2317 │ │ │ │ structure is │
2318 │ │ │ │ composed of 3 │
2319 │ │ │ │ 32-bit values; │
2320 │ │ │ │ the first being │
2321 │ │ │ │ the IPv4 address │
2322 │ │ │ │ (network byte │
2323 │ │ │ │ order), the │
2324 │ │ │ │ second the │
2325 │ │ │ │ prefix (1 - 32), │
2326 │ │ │ │ and last the │
2327 │ │ │ │ IPv4 gateway │
2328 │ │ │ │ (network byte │
2329 │ │ │ │ order). The │
2330 │ │ │ │ gateway may be │
2331 │ │ │ │ left as 0 if no │
2332 │ │ │ │ gateway exists │
2333 │ │ │ │ for that subnet. │
2334 ├─────────────────────────────┼──────────────────┼───────────────┼────────────────────────────────────────┤
2335 │auto-route-ext-gw │ NMTernary │ │ VPN connections will │
2336 │ │ (int32) │ │ default to add the │
2337 │ │ │ │ route automatically │
2338 │ │ │ │ unless this setting is │
2339 │ │ │ │ set to FALSE. │
2340 │ │ │ │ │
2341 │ │ │ │ For other connection │
2342 │ │ │ │ types, adding such an │
2343 │ │ │ │ automatic route is │
2344 │ │ │ │ currently not │
2345 │ │ │ │ supported and setting │
2346 │ │ │ │ this to TRUE has no │
2347 │ │ │ │ effect. │
2348 ├─────────────────────────────┼──────────────────┼───────────────┼────────────────────────────────────────┤
2349 │dad-timeout │ int32 │ -1 │ Timeout in │
2350 │ │ │ │ milliseconds used to │
2351 │ │ │ │ check for the presence │
2352 │ │ │ │ of duplicate IP │
2353 │ │ │ │ addresses on the │
2354 │ │ │ │ network. If an │
2355 │ │ │ │ address conflict is │
2356 │ │ │ │ detected, the │
2357 │ │ │ │ activation will fail. │
2358 │ │ │ │ A zero value means │
2359 │ │ │ │ that no duplicate │
2360 │ │ │ │ address detection is │
2361 │ │ │ │ performed, -1 means │
2362 │ │ │ │ the default value │
2363 │ │ │ │ (either configuration │
2364 │ │ │ │ ipvx.dad-timeout │
2365 │ │ │ │ override or zero). A │
2366 │ │ │ │ value greater than │
2367 │ │ │ │ zero is a timeout in │
2368 │ │ │ │ milliseconds. │
2369 │ │ │ │ │
2370 │ │ │ │ The property is │
2371 │ │ │ │ currently implemented │
2372 │ │ │ │ only for IPv4. │
2373 ├─────────────────────────────┼──────────────────┼───────────────┼────────────────────────────────────────┤
2374 │dhcp-client-id │ string │ │ A string sent to the │
2375 │ │ │ │ DHCP server to │
2376 │ │ │ │ identify the local │
2377 │ │ │ │ machine which the DHCP │
2378 │ │ │ │ server may use to │
2379 │ │ │ │ customize the DHCP │
2380 │ │ │ │ lease and options. │
2381 │ │ │ │ When the property is a │
2382 │ │ │ │ hex string │
2383 │ │ │ │ ('aa:bb:cc') it is │
2384 │ │ │ │ interpreted as a │
2385 │ │ │ │ binary client ID, in │
2386 │ │ │ │ which case the first │
2387 │ │ │ │ byte is assumed to be │
2388 │ │ │ │ the 'type' field as │
2389 │ │ │ │ per RFC 2132 section │
2390 │ │ │ │ 9.14 and the remaining │
2391 │ │ │ │ bytes may be an │
2392 │ │ │ │ hardware address (e.g. │
2393 │ │ │ │ '01:xx:xx:xx:xx:xx:xx' │
2394 │ │ │ │ where 1 is the │
2395 │ │ │ │ Ethernet ARP type and │
2396 │ │ │ │ the rest is a MAC │
2397 │ │ │ │ address). If the │
2398 │ │ │ │ property is not a hex │
2399 │ │ │ │ string it is │
2400 │ │ │ │ considered as a │
2401 │ │ │ │ non-hardware-address │
2402 │ │ │ │ client ID and the │
2403 │ │ │ │ 'type' field is set to │
2404 │ │ │ │ 0. │
2405 │ │ │ │ │
2406 │ │ │ │ The special values │
2407 │ │ │ │ "mac" and "perm-mac" │
2408 │ │ │ │ are supported, which │
2409 │ │ │ │ use the current or │
2410 │ │ │ │ permanent MAC address │
2411 │ │ │ │ of the device to │
2412 │ │ │ │ generate a client │
2413 │ │ │ │ identifier with type │
2414 │ │ │ │ ethernet (01). │
2415 │ │ │ │ Currently, these │
2416 │ │ │ │ options only work for │
2417 │ │ │ │ ethernet type of │
2418 │ │ │ │ links. │
2419 │ │ │ │ │
2420 │ │ │ │ The special value │
2421 │ │ │ │ "ipv6-duid" uses the │
2422 │ │ │ │ DUID from │
2423 │ │ │ │ "ipv6.dhcp-duid" │
2424 │ │ │ │ property as an │
2425 │ │ │ │ RFC4361-compliant │
2426 │ │ │ │ client identifier. As │
2427 │ │ │ │ IAID it uses │
2428 │ │ │ │ "ipv4.dhcp-iaid" and │
2429 │ │ │ │ falls back to │
2430 │ │ │ │ "ipv6.dhcp-iaid" if │
2431 │ │ │ │ unset. │
2432 │ │ │ │ │
2433 │ │ │ │ The special value │
2434 │ │ │ │ "duid" generates a │
2435 │ │ │ │ RFC4361-compliant │
2436 │ │ │ │ client identifier │
2437 │ │ │ │ based on │
2438 │ │ │ │ "ipv4.dhcp-iaid" and │
2439 │ │ │ │ uses a DUID generated │
2440 │ │ │ │ by hashing │
2441 │ │ │ │ /etc/machine-id. │
2442 │ │ │ │ │
2443 │ │ │ │ The special value │
2444 │ │ │ │ "stable" is supported │
2445 │ │ │ │ to generate a type 0 │
2446 │ │ │ │ client identifier │
2447 │ │ │ │ based on the stable-id │
2448 │ │ │ │ (see │
2449 │ │ │ │ connection.stable-id) │
2450 │ │ │ │ and a per-host key. If │
2451 │ │ │ │ you set the stable-id, │
2452 │ │ │ │ you may want to │
2453 │ │ │ │ include the │
2454 │ │ │ │ "${DEVICE}" or │
2455 │ │ │ │ "${MAC}" specifier to │
2456 │ │ │ │ get a per-device key. │
2457 │ │ │ │ │
2458 │ │ │ │ If unset, a globally │
2459 │ │ │ │ configured default is │
2460 │ │ │ │ used. If still unset, │
2461 │ │ │ │ the default depends on │
2462 │ │ │ │ the DHCP plugin. │
2463 ├─────────────────────────────┼──────────────────┼───────────────┼────────────────────────────────────────┤
2464 │dhcp-fqdn │ string │ │ If the │
2465 │ │ │ │ "dhcp-send-hostname" │
2466 │ │ │ │ property is TRUE, then │
2467 │ │ │ │ the specified FQDN │
2468 │ │ │ │ will be sent to the │
2469 │ │ │ │ DHCP server when │
2470 │ │ │ │ acquiring a lease. │
2471 │ │ │ │ This property and │
2472 │ │ │ │ "dhcp-hostname" are │
2473 │ │ │ │ mutually exclusive and │
2474 │ │ │ │ cannot be set at the │
2475 │ │ │ │ same time. │
2476 ├─────────────────────────────┼──────────────────┼───────────────┼────────────────────────────────────────┤
2477 │dhcp-hostname │ string │ │ If the │
2478 │ │ │ │ "dhcp-send-hostname" │
2479 │ │ │ │ property is TRUE, then │
2480 │ │ │ │ the specified name │
2481 │ │ │ │ will be sent to the │
2482 │ │ │ │ DHCP server when │
2483 │ │ │ │ acquiring a lease. │
2484 │ │ │ │ This property and │
2485 │ │ │ │ "dhcp-fqdn" are │
2486 │ │ │ │ mutually exclusive and │
2487 │ │ │ │ cannot be set at the │
2488 │ │ │ │ same time. │
2489 ├─────────────────────────────┼──────────────────┼───────────────┼────────────────────────────────────────┤
2490 │dhcp-hostname-flags │ uint32 │ 0 │ Flags for the DHCP │
2491 │ │ │ │ hostname and FQDN. │
2492 │ │ │ │ │
2493 │ │ │ │ Currently, this │
2494 │ │ │ │ property only includes │
2495 │ │ │ │ flags to control the │
2496 │ │ │ │ FQDN flags set in the │
2497 │ │ │ │ DHCP FQDN option. │
2498 │ │ │ │ Supported FQDN flags │
2499 │ │ │ │ are │
2500 │ │ │ │ NM_DHCP_HOSTNAME_FLAG_FQDN_SERV_UPDATE │
2501 │ │ │ │ (0x1), │
2502 │ │ │ │ NM_DHCP_HOSTNAME_FLAG_FQDN_ENCODED │
2503 │ │ │ │ (0x2) and │
2504 │ │ │ │ NM_DHCP_HOSTNAME_FLAG_FQDN_NO_UPDATE │
2505 │ │ │ │ (0x4). When no FQDN │
2506 │ │ │ │ flag is set and │
2507 │ │ │ │ NM_DHCP_HOSTNAME_FLAG_FQDN_CLEAR_FLAGS │
2508 │ │ │ │ (0x8) is set, the DHCP │
2509 │ │ │ │ FQDN option will │
2510 │ │ │ │ contain no flag. │
2511 │ │ │ │ Otherwise, if no FQDN │
2512 │ │ │ │ flag is set and │
2513 │ │ │ │ NM_DHCP_HOSTNAME_FLAG_FQDN_CLEAR_FLAGS │
2514 │ │ │ │ (0x8) is not set, the │
2515 │ │ │ │ standard FQDN flags │
2516 │ │ │ │ are set in the │
2517 │ │ │ │ request: │
2518 │ │ │ │ NM_DHCP_HOSTNAME_FLAG_FQDN_SERV_UPDATE │
2519 │ │ │ │ (0x1), │
2520 │ │ │ │ NM_DHCP_HOSTNAME_FLAG_FQDN_ENCODED │
2521 │ │ │ │ (0x2) for IPv4 and │
2522 │ │ │ │ NM_DHCP_HOSTNAME_FLAG_FQDN_SERV_UPDATE │
2523 │ │ │ │ (0x1) for IPv6. │
2524 │ │ │ │ │
2525 │ │ │ │ When this property is │
2526 │ │ │ │ set to the default │
2527 │ │ │ │ value │
2528 │ │ │ │ NM_DHCP_HOSTNAME_FLAG_NONE │
2529 │ │ │ │ (0x0), a global │
2530 │ │ │ │ default is looked up │
2531 │ │ │ │ in NetworkManager │
2532 │ │ │ │ configuration. If that │
2533 │ │ │ │ value is unset or also │
2534 │ │ │ │ NM_DHCP_HOSTNAME_FLAG_NONE │
2535 │ │ │ │ (0x0), then the │
2536 │ │ │ │ standard FQDN flags │
2537 │ │ │ │ described above are │
2538 │ │ │ │ sent in the DHCP │
2539 │ │ │ │ requests. │
2540 ├─────────────────────────────┼──────────────────┼───────────────┼────────────────────────────────────────┤
2541 │dhcp-iaid │ string │ │ A string containing the "Identity │
2542 │ │ │ │ Association Identifier" (IAID) used by │
2543 │ │ │ │ the DHCP client. The string can be a │
2544 │ │ │ │ 32-bit number (either decimal, │
2545 │ │ │ │ hexadecimal or or as colon separated │
2546 │ │ │ │ hexadecimal numbers). Alternatively it │
2547 │ │ │ │ can be set to the special values │
2548 │ │ │ │ "mac", "perm-mac", "ifname" or │
2549 │ │ │ │ "stable". When set to "mac" (or │
2550 │ │ │ │ "perm-mac"), the last 4 bytes of the │
2551 │ │ │ │ current (or permanent) MAC address are │
2552 │ │ │ │ used as IAID. When set to "ifname", │
2553 │ │ │ │ the IAID is computed by hashing the │
2554 │ │ │ │ interface name. The special value │
2555 │ │ │ │ "stable" can be used to generate an │
2556 │ │ │ │ IAID based on the stable-id (see │
2557 │ │ │ │ connection.stable-id), a per-host key │
2558 │ │ │ │ and the interface name. When the │
2559 │ │ │ │ property is unset, the value from │
2560 │ │ │ │ global configuration is used; if no │
2561 │ │ │ │ global default is set then the IAID is │
2562 │ │ │ │ assumed to be "ifname". │
2563 │ │ │ │ │
2564 │ │ │ │ For DHCPv4, the IAID is only used with │
2565 │ │ │ │ "ipv4.dhcp-client-id" values "duid" │
2566 │ │ │ │ and "ipv6-duid" to generate the │
2567 │ │ │ │ client-id. │
2568 │ │ │ │ │
2569 │ │ │ │ For DHCPv6, note that at the moment │
2570 │ │ │ │ this property is only supported by the │
2571 │ │ │ │ "internal" DHCPv6 plugin. The │
2572 │ │ │ │ "dhclient" DHCPv6 plugin always │
2573 │ │ │ │ derives the IAID from the MAC address. │
2574 │ │ │ │ │
2575 │ │ │ │ The actually used DHCPv6 IAID for a │
2576 │ │ │ │ currently activated interface is │
2577 │ │ │ │ exposed in the lease information of │
2578 │ │ │ │ the device. │
2579 ├─────────────────────────────┼──────────────────┼───────────────┼────────────────────────────────────────┤
2580 │dhcp-reject-servers │ array of string │ │ Array of servers from which DHCP │
2581 │ │ │ │ offers must be rejected. This property │
2582 │ │ │ │ is useful to avoid getting a lease │
2583 │ │ │ │ from misconfigured or rogue servers. │
2584 │ │ │ │ │
2585 │ │ │ │ For DHCPv4, each element must be an │
2586 │ │ │ │ IPv4 address, optionally followed by a │
2587 │ │ │ │ slash and a prefix length (e.g. │
2588 │ │ │ │ "192.168.122.0/24"). │
2589 │ │ │ │ │
2590 │ │ │ │ This property is currently not │
2591 │ │ │ │ implemented for DHCPv6. │
2592 ├─────────────────────────────┼──────────────────┼───────────────┼────────────────────────────────────────┤
2593 │dhcp-send-hostname │ boolean │ TRUE │ If TRUE, a hostname is sent to the │
2594 │ │ │ │ DHCP server when acquiring a lease. │
2595 │ │ │ │ Some DHCP servers use this hostname to │
2596 │ │ │ │ update DNS databases, essentially │
2597 │ │ │ │ providing a static hostname for the │
2598 │ │ │ │ computer. If the "dhcp-hostname" │
2599 │ │ │ │ property is NULL and this property is │
2600 │ │ │ │ TRUE, the current persistent hostname │
2601 │ │ │ │ of the computer is sent. │
2602 ├─────────────────────────────┼──────────────────┼───────────────┼────────────────────────────────────────┤
2603 │dhcp-timeout │ int32 │ 0 │ A timeout for a DHCP transaction in │
2604 │ │ │ │ seconds. If zero (the default), a │
2605 │ │ │ │ globally configured default is used. │
2606 │ │ │ │ If still unspecified, a device │
2607 │ │ │ │ specific timeout is used (usually 45 │
2608 │ │ │ │ seconds). │
2609 │ │ │ │ │
2610 │ │ │ │ Set to 2147483647 (MAXINT32) for │
2611 │ │ │ │ infinity. │
2612 ├─────────────────────────────┼──────────────────┼───────────────┼────────────────────────────────────────┤
2613 │dhcp-vendor-class-identifier │ string │ │ The Vendor Class Identifier DHCP │
2614 │ │ │ │ option (60). Special characters in the │
2615 │ │ │ │ data string may be escaped using │
2616 │ │ │ │ C-style escapes, nevertheless this │
2617 │ │ │ │ property cannot contain nul bytes. If │
2618 │ │ │ │ the per-profile value is unspecified │
2619 │ │ │ │ (the default), a global connection │
2620 │ │ │ │ default gets consulted. If still │
2621 │ │ │ │ unspecified, the DHCP option is not │
2622 │ │ │ │ sent to the server. │
2623 ├─────────────────────────────┼──────────────────┼───────────────┼────────────────────────────────────────┤
2624 │dns │ array of uint32 │ │ Array of IP addresses of DNS servers │
2625 │ │ │ │ (as network-byte-order integers) │
2626 ├─────────────────────────────┼──────────────────┼───────────────┼────────────────────────────────────────┤
2627 │dns-data │ array of strings │ │ Array of DNS name servers. This │
2628 │ │ │ │ replaces the deprecated "dns" │
2629 │ │ │ │ property. Each name server can also │
2630 │ │ │ │ contain a DoT server name. │
2631 ├─────────────────────────────┼──────────────────┼───────────────┼────────────────────────────────────────┤
2632 │dns-options │ array of string │ │ Array of DNS options as described in │
2633 │ │ │ │ man 5 resolv.conf. │
2634 │ │ │ │ │
2635 │ │ │ │ NULL means that the options are unset │
2636 │ │ │ │ and left at the default. In this case │
2637 │ │ │ │ NetworkManager will use default │
2638 │ │ │ │ options. This is distinct from an │
2639 │ │ │ │ empty list of properties. │
2640 │ │ │ │ │
2641 │ │ │ │ The currently supported options are │
2642 │ │ │ │ "attempts", "debug", "edns0", "inet6", │
2643 │ │ │ │ "ip6-bytestring", "ip6-dotint", │
2644 │ │ │ │ "ndots", "no-aaaa", "no-check-names", │
2645 │ │ │ │ "no-ip6-dotint", "no-reload", │
2646 │ │ │ │ "no-tld-query", "rotate", │
2647 │ │ │ │ "single-request", │
2648 │ │ │ │ "single-request-reopen", "timeout", │
2649 │ │ │ │ "trust-ad", "use-vc". │
2650 │ │ │ │ │
2651 │ │ │ │ The "trust-ad" setting is only honored │
2652 │ │ │ │ if the profile contributes name │
2653 │ │ │ │ servers to resolv.conf, and if all │
2654 │ │ │ │ contributing profiles have "trust-ad" │
2655 │ │ │ │ enabled. │
2656 │ │ │ │ │
2657 │ │ │ │ When using a caching DNS plugin │
2658 │ │ │ │ (dnsmasq or systemd-resolved in │
2659 │ │ │ │ NetworkManager.conf) then "edns0" and │
2660 │ │ │ │ "trust-ad" are automatically added. │
2661 ├─────────────────────────────┼──────────────────┼───────────────┼────────────────────────────────────────┤
2662 │dns-priority │ int32 │ 0 │ DNS servers priority. │
2663 │ │ │ │ │
2664 │ │ │ │ The relative priority for DNS servers │
2665 │ │ │ │ specified by this setting. A lower │
2666 │ │ │ │ numerical value is better (higher │
2667 │ │ │ │ priority). │
2668 │ │ │ │ │
2669 │ │ │ │ Negative values have the special │
2670 │ │ │ │ effect of excluding other │
2671 │ │ │ │ configurations with a greater │
2672 │ │ │ │ numerical priority value; so in │
2673 │ │ │ │ presence of at least one negative │
2674 │ │ │ │ priority, only DNS servers from │
2675 │ │ │ │ connections with the lowest priority │
2676 │ │ │ │ value will be used. To avoid all DNS │
2677 │ │ │ │ leaks, set the priority of the profile │
2678 │ │ │ │ that should be used to the most │
2679 │ │ │ │ negative value of all active │
2680 │ │ │ │ connections profiles. │
2681 │ │ │ │ │
2682 │ │ │ │ Zero selects a globally configured │
2683 │ │ │ │ default value. If the latter is │
2684 │ │ │ │ missing or zero too, it defaults to 50 │
2685 │ │ │ │ for VPNs (including WireGuard) and 100 │
2686 │ │ │ │ for other connections. │
2687 │ │ │ │ │
2688 │ │ │ │ Note that the priority is to order DNS │
2689 │ │ │ │ settings for multiple active │
2690 │ │ │ │ connections. It does not disambiguate │
2691 │ │ │ │ multiple DNS servers within the same │
2692 │ │ │ │ connection profile. │
2693 │ │ │ │ │
2694 │ │ │ │ When multiple devices have │
2695 │ │ │ │ configurations with the same priority, │
2696 │ │ │ │ VPNs will be considered first, then │
2697 │ │ │ │ devices with the best (lowest metric) │
2698 │ │ │ │ default route and then all other │
2699 │ │ │ │ devices. │
2700 │ │ │ │ │
2701 │ │ │ │ When using dns=default, servers with │
2702 │ │ │ │ higher priority will be on top of │
2703 │ │ │ │ resolv.conf. To prioritize a given │
2704 │ │ │ │ server over another one within the │
2705 │ │ │ │ same connection, just specify them in │
2706 │ │ │ │ the desired order. Note that commonly │
2707 │ │ │ │ the resolver tries name servers in │
2708 │ │ │ │ /etc/resolv.conf in the order listed, │
2709 │ │ │ │ proceeding with the next server in the │
2710 │ │ │ │ list on failure. See for example the │
2711 │ │ │ │ "rotate" option of the dns-options │
2712 │ │ │ │ setting. If there are any negative DNS │
2713 │ │ │ │ priorities, then only name servers │
2714 │ │ │ │ from the devices with that lowest │
2715 │ │ │ │ priority will be considered. │
2716 │ │ │ │ │
2717 │ │ │ │ When using a DNS resolver that │
2718 │ │ │ │ supports Conditional Forwarding or │
2719 │ │ │ │ Split DNS (with dns=dnsmasq or │
2720 │ │ │ │ dns=systemd-resolved settings), each │
2721 │ │ │ │ connection is used to query domains in │
2722 │ │ │ │ its search list. The search domains │
2723 │ │ │ │ determine which name servers to ask, │
2724 │ │ │ │ and the DNS priority is used to │
2725 │ │ │ │ prioritize name servers based on the │
2726 │ │ │ │ domain. Queries for domains not │
2727 │ │ │ │ present in any search list are routed │
2728 │ │ │ │ through connections having the '~.' │
2729 │ │ │ │ special wildcard domain, which is │
2730 │ │ │ │ added automatically to connections │
2731 │ │ │ │ with the default route (or can be │
2732 │ │ │ │ added manually). When multiple │
2733 │ │ │ │ connections specify the same domain, │
2734 │ │ │ │ the one with the best priority (lowest │
2735 │ │ │ │ numerical value) wins. If a sub │
2736 │ │ │ │ domain is configured on another │
2737 │ │ │ │ interface it will be accepted │
2738 │ │ │ │ regardless the priority, unless parent │
2739 │ │ │ │ domain on the other interface has a │
2740 │ │ │ │ negative priority, which causes the │
2741 │ │ │ │ sub domain to be shadowed. With Split │
2742 │ │ │ │ DNS one can avoid undesired DNS leaks │
2743 │ │ │ │ by properly configuring DNS priorities │
2744 │ │ │ │ and the search domains, so that only │
2745 │ │ │ │ name servers of the desired interface │
2746 │ │ │ │ are configured. │
2747 ├─────────────────────────────┼──────────────────┼───────────────┼────────────────────────────────────────┤
2748 │dns-search │ array of string │ │ List of DNS search domains. Domains │
2749 │ │ │ │ starting with a tilde ('~') are │
2750 │ │ │ │ considered 'routing' domains and are │
2751 │ │ │ │ used only to decide the interface over │
2752 │ │ │ │ which a query must be forwarded; they │
2753 │ │ │ │ are not used to complete unqualified │
2754 │ │ │ │ host names. │
2755 │ │ │ │ │
2756 │ │ │ │ When using a DNS plugin that supports │
2757 │ │ │ │ Conditional Forwarding or Split DNS, │
2758 │ │ │ │ then the search domains specify which │
2759 │ │ │ │ name servers to query. This makes the │
2760 │ │ │ │ behavior different from running with │
2761 │ │ │ │ plain /etc/resolv.conf. For more │
2762 │ │ │ │ information see also the dns-priority │
2763 │ │ │ │ setting. │
2764 │ │ │ │ │
2765 │ │ │ │ When set on a profile that also │
2766 │ │ │ │ enabled DHCP, the DNS search list │
2767 │ │ │ │ received automatically (option 119 for │
2768 │ │ │ │ DHCPv4 and option 24 for DHCPv6) gets │
2769 │ │ │ │ merged with the manual list. This can │
2770 │ │ │ │ be prevented by setting │
2771 │ │ │ │ "ignore-auto-dns". Note that if no DNS │
2772 │ │ │ │ searches are configured, the fallback │
2773 │ │ │ │ will be derived from the domain from │
2774 │ │ │ │ DHCP (option 15). │
2775 ├─────────────────────────────┼──────────────────┼───────────────┼────────────────────────────────────────┤
2776 │gateway │ string │ │ The gateway associated with this │
2777 │ │ │ │ configuration. This is only meaningful │
2778 │ │ │ │ if "addresses" is also set. │
2779 │ │ │ │ │
2780 │ │ │ │ Setting the gateway causes │
2781 │ │ │ │ NetworkManager to configure a standard │
2782 │ │ │ │ default route with the gateway as next │
2783 │ │ │ │ hop. This is ignored if │
2784 │ │ │ │ "never-default" is set. An alternative │
2785 │ │ │ │ is to configure the default route │
2786 │ │ │ │ explicitly with a manual route and /0 │
2787 │ │ │ │ as prefix length. │
2788 │ │ │ │ │
2789 │ │ │ │ Note that the gateway usually │
2790 │ │ │ │ conflicts with routing that │
2791 │ │ │ │ NetworkManager configures for │
2792 │ │ │ │ WireGuard interfaces, so usually it │
2793 │ │ │ │ should not be set in that case. See │
2794 │ │ │ │ "ip4-auto-default-route". │
2795 ├─────────────────────────────┼──────────────────┼───────────────┼────────────────────────────────────────┤
2796 │ignore-auto-dns │ boolean │ FALSE │ When "method" is set to "auto" and │
2797 │ │ │ │ this property to TRUE, automatically │
2798 │ │ │ │ configured name servers and search │
2799 │ │ │ │ domains are ignored and only name │
2800 │ │ │ │ servers and search domains specified │
2801 │ │ │ │ in the "dns" and "dns-search" │
2802 │ │ │ │ properties, if any, are used. │
2803 ├─────────────────────────────┼──────────────────┼───────────────┼────────────────────────────────────────┤
2804 │ignore-auto-routes │ boolean │ FALSE │ When "method" is set to "auto" and │
2805 │ │ │ │ this property to TRUE, automatically │
2806 │ │ │ │ configured routes are ignored and only │
2807 │ │ │ │ routes specified in the "routes" │
2808 │ │ │ │ property, if any, are used. │
2809 ├─────────────────────────────┼──────────────────┼───────────────┼────────────────────────────────────────┤
2810 │link-local │ int32 │ 0 │ Enable and disable the IPv4 link-local │
2811 │ │ │ │ configuration independently of the │
2812 │ │ │ │ ipv4.method configuration. This allows │
2813 │ │ │ │ a link-local address (169.254.x.y/16) │
2814 │ │ │ │ to be obtained in addition to other │
2815 │ │ │ │ addresses, such as those manually │
2816 │ │ │ │ configured or obtained from a DHCP │
2817 │ │ │ │ server. │
2818 │ │ │ │ │
2819 │ │ │ │ When set to "auto", the value is │
2820 │ │ │ │ dependent on "ipv4.method". When set │
2821 │ │ │ │ to "default", it honors the global │
2822 │ │ │ │ connection default, before falling │
2823 │ │ │ │ back to "auto". Note that if │
2824 │ │ │ │ "ipv4.method" is "disabled", then link │
2825 │ │ │ │ local addressing is always disabled │
2826 │ │ │ │ too. The default is "default". │
2827 ├─────────────────────────────┼──────────────────┼───────────────┼────────────────────────────────────────┤
2828 │may-fail │ boolean │ TRUE │ If TRUE, allow overall network │
2829 │ │ │ │ configuration to proceed even if the │
2830 │ │ │ │ configuration specified by this │
2831 │ │ │ │ property times out. Note that at │
2832 │ │ │ │ least one IP configuration must │
2833 │ │ │ │ succeed or overall network │
2834 │ │ │ │ configuration will still fail. For │
2835 │ │ │ │ example, in IPv6-only networks, │
2836 │ │ │ │ setting this property to TRUE on the │
2837 │ │ │ │ NMSettingIP4Config allows the overall │
2838 │ │ │ │ network configuration to succeed if │
2839 │ │ │ │ IPv4 configuration fails but IPv6 │
2840 │ │ │ │ configuration completes successfully. │
2841 ├─────────────────────────────┼──────────────────┼───────────────┼────────────────────────────────────────┤
2842 │method │ string │ │ IP configuration method. │
2843 │ │ │ │ │
2844 │ │ │ │ NMSettingIP4Config and │
2845 │ │ │ │ NMSettingIP6Config both support │
2846 │ │ │ │ "disabled", "auto", "manual", and │
2847 │ │ │ │ "link-local". See the │
2848 │ │ │ │ subclass-specific documentation for │
2849 │ │ │ │ other values. │
2850 │ │ │ │ │
2851 │ │ │ │ In general, for the "auto" method, │
2852 │ │ │ │ properties such as "dns" and "routes" │
2853 │ │ │ │ specify information that is added on │
2854 │ │ │ │ to the information returned from │
2855 │ │ │ │ automatic configuration. The │
2856 │ │ │ │ "ignore-auto-routes" and │
2857 │ │ │ │ "ignore-auto-dns" properties modify │
2858 │ │ │ │ this behavior. │
2859 │ │ │ │ │
2860 │ │ │ │ For methods that imply no upstream │
2861 │ │ │ │ network, such as "shared" or │
2862 │ │ │ │ "link-local", these properties must be │
2863 │ │ │ │ empty. │
2864 │ │ │ │ │
2865 │ │ │ │ For IPv4 method "shared", the IP │
2866 │ │ │ │ subnet can be configured by adding one │
2867 │ │ │ │ manual IPv4 address or otherwise │
2868 │ │ │ │ 10.42.x.0/24 is chosen. Note that the │
2869 │ │ │ │ shared method must be configured on │
2870 │ │ │ │ the interface which shares the │
2871 │ │ │ │ internet to a subnet, not on the │
2872 │ │ │ │ uplink which is shared. │
2873 ├─────────────────────────────┼──────────────────┼───────────────┼────────────────────────────────────────┤
2874 │never-default │ boolean │ FALSE │ If TRUE, this connection will never be │
2875 │ │ │ │ the default connection for this IP │
2876 │ │ │ │ type, meaning it will never be │
2877 │ │ │ │ assigned the default route by │
2878 │ │ │ │ NetworkManager. │
2879 ├─────────────────────────────┼──────────────────┼───────────────┼────────────────────────────────────────┤
2880 │replace-local-rule │ NMTernary │ │ Connections will default to keep the │
2881 │ │ (int32) │ │ autogenerated priority 0 local rule │
2882 │ │ │ │ unless this setting is set to TRUE. │
2883 ├─────────────────────────────┼──────────────────┼───────────────┼────────────────────────────────────────┤
2884 │required-timeout │ int32 │ -1 │ The minimum time interval in │
2885 │ │ │ │ milliseconds for which dynamic IP │
2886 │ │ │ │ configuration should be tried before │
2887 │ │ │ │ the connection succeeds. │
2888 │ │ │ │ │
2889 │ │ │ │ This property is useful for example if │
2890 │ │ │ │ both IPv4 and IPv6 are enabled and are │
2891 │ │ │ │ allowed to fail. Normally the │
2892 │ │ │ │ connection succeeds as soon as one of │
2893 │ │ │ │ the two address families completes; by │
2894 │ │ │ │ setting a required timeout for e.g. │
2895 │ │ │ │ IPv4, one can ensure that even if IP6 │
2896 │ │ │ │ succeeds earlier than IPv4, │
2897 │ │ │ │ NetworkManager waits some time for │
2898 │ │ │ │ IPv4 before the connection becomes │
2899 │ │ │ │ active. │
2900 │ │ │ │ │
2901 │ │ │ │ Note that if "may-fail" is FALSE for │
2902 │ │ │ │ the same address family, this property │
2903 │ │ │ │ has no effect as NetworkManager needs │
2904 │ │ │ │ to wait for the full DHCP timeout. │
2905 │ │ │ │ │
2906 │ │ │ │ A zero value means that no required │
2907 │ │ │ │ timeout is present, -1 means the │
2908 │ │ │ │ default value (either configuration │
2909 │ │ │ │ ipvx.required-timeout override or │
2910 │ │ │ │ zero). │
2911 ├─────────────────────────────┼──────────────────┼───────────────┼────────────────────────────────────────┤
2912 │route-data │ array of vardict │ │ Array of IPv4 routes. Each route │
2913 │ │ │ │ dictionary contains at least 'dest' │
2914 │ │ │ │ and 'prefix' entries, containing the │
2915 │ │ │ │ destination IP address as a string, │
2916 │ │ │ │ and the prefix length as a uint32. │
2917 │ │ │ │ Most routes will also have a │
2918 │ │ │ │ 'next-hop' entry, containing the next │
2919 │ │ │ │ hop IP address as a string. If the │
2920 │ │ │ │ route has a 'metric' entry (containing │
2921 │ │ │ │ a uint32), that will be used as the │
2922 │ │ │ │ metric for the route (otherwise NM │
2923 │ │ │ │ will pick a default value appropriate │
2924 │ │ │ │ to the device). Additional attributes │
2925 │ │ │ │ may also exist on some routes. │
2926 ├─────────────────────────────┼──────────────────┼───────────────┼────────────────────────────────────────┤
2927 │route-metric │ int64 │ -1 │ The default metric for routes that │
2928 │ │ │ │ don't explicitly specify a metric. The │
2929 │ │ │ │ default value -1 means that the metric │
2930 │ │ │ │ is chosen automatically based on the │
2931 │ │ │ │ device type. The metric applies to │
2932 │ │ │ │ dynamic routes, manual (static) routes │
2933 │ │ │ │ that don't have an explicit metric │
2934 │ │ │ │ setting, address prefix routes, and │
2935 │ │ │ │ the default route. Note that for IPv6, │
2936 │ │ │ │ the kernel accepts zero (0) but │
2937 │ │ │ │ coerces it to 1024 (user default). │
2938 │ │ │ │ Hence, setting this property to zero │
2939 │ │ │ │ effectively mean setting it to 1024. │
2940 │ │ │ │ For IPv4, zero is a regular value for │
2941 │ │ │ │ the metric. │
2942 ├─────────────────────────────┼──────────────────┼───────────────┼────────────────────────────────────────┤
2943 │route-table │ uint32 │ 0 │ Enable policy routing (source routing) │
2944 │ │ │ │ and set the routing table used when │
2945 │ │ │ │ adding routes. │
2946 │ │ │ │ │
2947 │ │ │ │ This affects all routes, including │
2948 │ │ │ │ device-routes, IPv4LL, DHCP, SLAAC, │
2949 │ │ │ │ default-routes and static routes. But │
2950 │ │ │ │ note that static routes can │
2951 │ │ │ │ individually overwrite the setting by │
2952 │ │ │ │ explicitly specifying a non-zero │
2953 │ │ │ │ routing table. │
2954 │ │ │ │ │
2955 │ │ │ │ If the table setting is left at zero, │
2956 │ │ │ │ it is eligible to be overwritten via │
2957 │ │ │ │ global configuration. If the property │
2958 │ │ │ │ is zero even after applying the global │
2959 │ │ │ │ configuration value, policy routing is │
2960 │ │ │ │ disabled for the address family of │
2961 │ │ │ │ this connection. │
2962 │ │ │ │ │
2963 │ │ │ │ Policy routing disabled means that │
2964 │ │ │ │ NetworkManager will add all routes to │
2965 │ │ │ │ the main table (except static routes │
2966 │ │ │ │ that explicitly configure a different │
2967 │ │ │ │ table). Additionally, NetworkManager │
2968 │ │ │ │ will not delete any extraneous routes │
2969 │ │ │ │ from tables except the main table. │
2970 │ │ │ │ This is to preserve backward │
2971 │ │ │ │ compatibility for users who manage │
2972 │ │ │ │ routing tables outside of │
2973 │ │ │ │ NetworkManager. │
2974 ├─────────────────────────────┼──────────────────┼───────────────┼────────────────────────────────────────┤
2975 │routes │ array of array │ │ Deprecated in favor of the │
2976 │ │ of uint32 │ │ 'route-data' property, but this can be │
2977 │ │ │ │ used for backward-compatibility with │
2978 │ │ │ │ older daemons. Note that if you send │
2979 │ │ │ │ this property the daemon will ignore │
2980 │ │ │ │ 'route-data'. Array of IPv4 route │
2981 │ │ │ │ structures. Each IPv4 route structure │
2982 │ │ │ │ is composed of 4 32-bit values; the │
2983 │ │ │ │ first being the destination IPv4 │
2984 │ │ │ │ network or address (network byte │
2985 │ │ │ │ order), the second the destination │
2986 │ │ │ │ network or address prefix (1 - 32), │
2987 │ │ │ │ the third being the next-hop (network │
2988 │ │ │ │ byte order) if any, and the fourth │
2989 │ │ │ │ being the route metric. If the metric │
2990 │ │ │ │ is 0, NM will choose an appropriate │
2991 │ │ │ │ default metric for the device. (There │
2992 │ │ │ │ is no way to explicitly specify an │
2993 │ │ │ │ actual metric of 0 with this │
2994 │ │ │ │ property.) │
2995 ├─────────────────────────────┼──────────────────┼───────────────┼────────────────────────────────────────┤
2996 │routing-rules │ array of 'a{sv}' │ │ Array of dictionaries for routing │
2997 │ │ │ │ rules. Each routing rule supports the │
2998 │ │ │ │ following options: action (y), │
2999 │ │ │ │ dport-end (q), dport-start (q), family │
3000 │ │ │ │ (i), from (s), from-len (y), fwmark │
3001 │ │ │ │ (u), fwmask (u), iifname (s), invert │
3002 │ │ │ │ (b), ipproto (s), oifname (s), │
3003 │ │ │ │ priority (u), sport-end (q), │
3004 │ │ │ │ sport-start (q), supress-prefixlength │
3005 │ │ │ │ (i), table (u), to (s), tos (y), │
3006 │ │ │ │ to-len (y), range-end (u), range-start │
3007 │ │ │ │ (u). │
3008 └─────────────────────────────┴──────────────────┴───────────────┴────────────────────────────────────────┘
3009 ipv6 setting
3011 IPv6 Settings.
3012 ┌────────────────────┬───────────────────────────┬───────────────┬──────────────────────────────────────────────────────┐
3014 │Key Name │ Value Type │ Default Value │ Value │
3015 │ │ │ │ Description │
3016 ├────────────────────┼───────────────────────────┼───────────────┼──────────────────────────────────────────────────────┤
3017 │addr-gen-mode │ int32 │ 3 │ Configure method │
3018 │ │ │ │ for creating the │
3019 │ │ │ │ address for use │
3020 │ │ │ │ with RFC4862 │
3021 │ │ │ │ IPv6 Stateless │
3022 │ │ │ │ Address │
3023 │ │ │ │ Autoconfiguration. │
3024 │ │ │ │ The permitted │
3025 │ │ │ │ values are: │
3026 │ │ │ │ NM_SETTING_IP6_CONFIG_ADDR_GEN_MODE_EUI64 │
3027 │ │ │ │ (0), │
3028 │ │ │ │ NM_SETTING_IP6_CONFIG_ADDR_GEN_MODE_STABLE_PRIVACY │
3029 │ │ │ │ (1). │
3030 │ │ │ │ NM_SETTING_IP6_CONFIG_ADDR_GEN_MODE_DEFAULT_OR_EUI64 │
3031 │ │ │ │ (2) or │
3032 │ │ │ │ NM_SETTING_IP6_CONFIG_ADDR_GEN_MODE_DEFAULT │
3033 │ │ │ │ (3). │
3034 │ │ │ │ │
3035 │ │ │ │ If the property │
3036 │ │ │ │ is set to EUI64, │
3037 │ │ │ │ the addresses │
3038 │ │ │ │ will be │
3039 │ │ │ │ generated using │
3040 │ │ │ │ the interface │
3041 │ │ │ │ tokens derived │
3042 │ │ │ │ from hardware │
3043 │ │ │ │ address. This │
3044 │ │ │ │ makes the host │
3045 │ │ │ │ part of the │
3046 │ │ │ │ address to stay │
3047 │ │ │ │ constant, making │
3048 │ │ │ │ it possible to │
3049 │ │ │ │ track host's │
3050 │ │ │ │ presence when it │
3051 │ │ │ │ changes │
3052 │ │ │ │ networks. The │
3053 │ │ │ │ address changes │
3054 │ │ │ │ when the │
3055 │ │ │ │ interface │
3056 │ │ │ │ hardware is │
3057 │ │ │ │ replaced. │
3058 │ │ │ │ │
3059 │ │ │ │ The value of │
3060 │ │ │ │ stable-privacy │
3061 │ │ │ │ enables use of │
3062 │ │ │ │ cryptographically │
3063 │ │ │ │ secure hash of a │
3064 │ │ │ │ secret │
3065 │ │ │ │ host-specific │
3066 │ │ │ │ key along with │
3067 │ │ │ │ the connection's │
3068 │ │ │ │ stable-id and │
3069 │ │ │ │ the network │
3070 │ │ │ │ address as │
3071 │ │ │ │ specified by │
3072 │ │ │ │ RFC7217. This │
3073 │ │ │ │ makes it │
3074 │ │ │ │ impossible to │
3075 │ │ │ │ use the address │
3076 │ │ │ │ track host's │
3077 │ │ │ │ presence, and │
3078 │ │ │ │ makes the │
3079 │ │ │ │ address stable │
3080 │ │ │ │ when the network │
3081 │ │ │ │ interface │
3082 │ │ │ │ hardware is │
3083 │ │ │ │ replaced. │
3084 │ │ │ │ │
3085 │ │ │ │ The special │
3086 │ │ │ │ values "default" │
3087 │ │ │ │ and │
3088 │ │ │ │ "default-or-eui64" │
3089 │ │ │ │ will fallback to │
3090 │ │ │ │ the global │
3091 │ │ │ │ connection │
3092 │ │ │ │ default in as │
3093 │ │ │ │ documented in │
3094 │ │ │ │ NetworkManager.conf(5) │
3095 │ │ │ │ manual. If the │
3096 │ │ │ │ global default │
3097 │ │ │ │ is not │
3098 │ │ │ │ specified, the │
3099 │ │ │ │ fallback value │
3100 │ │ │ │ is │
3101 │ │ │ │ "stable-privacy" │
3102 │ │ │ │ or "eui64", │
3103 │ │ │ │ respectively. │
3104 │ │ │ │ │
3105 │ │ │ │ For libnm, the │
3106 │ │ │ │ property │
3107 │ │ │ │ defaults to │
3108 │ │ │ │ "default" since │
3109 │ │ │ │ 1.40. Previously │
3110 │ │ │ │ it defaulted to │
3111 │ │ │ │ "stable-privacy". │
3112 │ │ │ │ On D-Bus, the │
3113 │ │ │ │ absence of an │
3114 │ │ │ │ addr-gen-mode │
3115 │ │ │ │ setting equals │
3116 │ │ │ │ "default". For │
3117 │ │ │ │ keyfile plugin, │
3118 │ │ │ │ the absence of │
3119 │ │ │ │ the setting on │
3120 │ │ │ │ disk means │
3121 │ │ │ │ "default-or-eui64" │
3122 │ │ │ │ so that the │
3123 │ │ │ │ property doesn't │
3124 │ │ │ │ change on │
3125 │ │ │ │ upgrade from │
3126 │ │ │ │ older versions. │
3127 │ │ │ │ │
3128 │ │ │ │ Note that this │
3129 │ │ │ │ setting is │
3130 │ │ │ │ distinct from │
3131 │ │ │ │ the Privacy │
3132 │ │ │ │ Extensions as │
3133 │ │ │ │ configured by │
3134 │ │ │ │ "ip6-privacy" │
3135 │ │ │ │ property and it │
3136 │ │ │ │ does not affect │
3137 │ │ │ │ the temporary │
3138 │ │ │ │ addresses │
3139 │ │ │ │ configured with │
3140 │ │ │ │ this option. │
3141 ├────────────────────┼───────────────────────────┼───────────────┼──────────────────────────────────────────────────────┤
3142 │address-data │ array of vardict │ │ Array of IPv6 addresses. Each address dictionary │
3143 │ │ │ │ contains at least 'address' and 'prefix' entries, │
3144 │ │ │ │ containing the IP address as a string, and the │
3145 │ │ │ │ prefix length as a uint32. Additional attributes may │
3146 │ │ │ │ also exist on some addresses. │
3147 ├────────────────────┼───────────────────────────┼───────────────┼──────────────────────────────────────────────────────┤
3148 │addresses │ array of legacy │ │ Deprecated in favor of the 'address-data' and │
3149 │ │ IPv6 address │ │ 'gateway' properties, but this can be used for │
3150 │ │ struct │ │ backward-compatibility with older daemons. Note that │
3151 │ │ (a(ayuay)) │ │ if you send this property the daemon will ignore │
3152 │ │ │ │ 'address-data' and 'gateway'. Array of IPv6 address │
3153 │ │ │ │ structures. Each IPv6 address structure is composed │
3154 │ │ │ │ of an IPv6 address, a prefix length (0 - 128), and │
3155 │ │ │ │ an IPv6 gateway address. The gateway may be zeroed │
3156 │ │ │ │ out if no gateway exists for that subnet. │
3157 ├────────────────────┼───────────────────────────┼───────────────┼──────────────────────────────────────────────────────┤
3158 │auto-route-ext-gw │ NMTernary │ │ VPN connections will default to add the route │
3159 │ │ (int32) │ │ automatically unless this setting is set to FALSE. │
3160 │ │ │ │ │
3161 │ │ │ │ For other connection types, adding such an automatic │
3162 │ │ │ │ route is currently not supported and setting this to │
3163 │ │ │ │ TRUE has no effect. │
3164 ├────────────────────┼───────────────────────────┼───────────────┼──────────────────────────────────────────────────────┤
3165 │dad-timeout │ int32 │ -1 │ Timeout in milliseconds used to check for the │
3166 │ │ │ │ presence of duplicate IP addresses on the network. │
3167 │ │ │ │ If an address conflict is detected, the activation │
3168 │ │ │ │ will fail. A zero value means that no duplicate │
3169 │ │ │ │ address detection is performed, -1 means the default │
3170 │ │ │ │ value (either configuration ipvx.dad-timeout │
3171 │ │ │ │ override or zero). A value greater than zero is a │
3172 │ │ │ │ timeout in milliseconds. │
3173 │ │ │ │ │
3174 │ │ │ │ The property is currently implemented only for IPv4. │
3175 ├────────────────────┼───────────────────────────┼───────────────┼──────────────────────────────────────────────────────┤
3176 │dhcp-duid │ string │ │ A string containing the DHCPv6 Unique Identifier │
3177 │ │ │ │ (DUID) used by the dhcp client to identify itself to │
3178 │ │ │ │ DHCPv6 servers (RFC 3315). The DUID is carried in │
3179 │ │ │ │ the Client Identifier option. If the property is a │
3180 │ │ │ │ hex string ('aa:bb:cc') it is interpreted as a │
3181 │ │ │ │ binary DUID and filled as an opaque value in the │
3182 │ │ │ │ Client Identifier option. │
3183 │ │ │ │ │
3184 │ │ │ │ The special value "lease" will retrieve the DUID │
3185 │ │ │ │ previously used from the lease file belonging to the │
3186 │ │ │ │ connection. If no DUID is found and "dhclient" is │
3187 │ │ │ │ the configured dhcp client, the DUID is searched in │
3188 │ │ │ │ the system-wide dhclient lease file. If still no │
3189 │ │ │ │ DUID is found, or another dhcp client is used, a │
3190 │ │ │ │ global and permanent DUID-UUID (RFC 6355) will be │
3191 │ │ │ │ generated based on the machine-id. │
3192 │ │ │ │ │
3193 │ │ │ │ The special values "llt" and "ll" will generate a │
3194 │ │ │ │ DUID of type LLT or LL (see RFC 3315) based on the │
3195 │ │ │ │ current MAC address of the device. In order to try │
3196 │ │ │ │ providing a stable DUID-LLT, the time field will │
3197 │ │ │ │ contain a constant timestamp that is used globally │
3198 │ │ │ │ (for all profiles) and persisted to disk. │
3199 │ │ │ │ │
3200 │ │ │ │ The special values "stable-llt", "stable-ll" and │
3201 │ │ │ │ "stable-uuid" will generate a DUID of the │
3202 │ │ │ │ corresponding type, derived from the connection's │
3203 │ │ │ │ stable-id and a per-host unique key. You may want to │
3204 │ │ │ │ include the "${DEVICE}" or "${MAC}" specifier in the │
3205 │ │ │ │ stable-id, in case this profile gets activated on │
3206 │ │ │ │ multiple devices. So, the link-layer address of │
3207 │ │ │ │ "stable-ll" and "stable-llt" will be a generated │
3208 │ │ │ │ address derived from the stable id. The DUID-LLT │
3209 │ │ │ │ time value in the "stable-llt" option will be picked │
3210 │ │ │ │ among a static timespan of three years (the upper │
3211 │ │ │ │ bound of the interval is the same constant timestamp │
3212 │ │ │ │ used in "llt"). │
3213 │ │ │ │ │
3214 │ │ │ │ When the property is unset, the global value │
3215 │ │ │ │ provided for "ipv6.dhcp-duid" is used. If no global │
3216 │ │ │ │ value is provided, the default "lease" value is │
3217 │ │ │ │ assumed. │
3218 ├────────────────────┼───────────────────────────┼───────────────┼──────────────────────────────────────────────────────┤
3219 │dhcp-hostname │ string │ │ If the "dhcp-send-hostname" property is TRUE, then │
3220 │ │ │ │ the specified name will be sent to the DHCP server │
3221 │ │ │ │ when acquiring a lease. This property and │
3222 │ │ │ │ "dhcp-fqdn" are mutually exclusive and cannot be set │
3223 │ │ │ │ at the same time. │
3224 ├────────────────────┼───────────────────────────┼───────────────┼──────────────────────────────────────────────────────┤
3225 │dhcp-hostname-flags │ uint32 │ 0 │ Flags for the DHCP hostname and FQDN. │
3226 │ │ │ │ │
3227 │ │ │ │ Currently, this property only includes flags to │
3228 │ │ │ │ control the FQDN flags set in the DHCP FQDN option. │
3229 │ │ │ │ Supported FQDN flags are │
3230 │ │ │ │ NM_DHCP_HOSTNAME_FLAG_FQDN_SERV_UPDATE (0x1), │
3231 │ │ │ │ NM_DHCP_HOSTNAME_FLAG_FQDN_ENCODED (0x2) and │
3232 │ │ │ │ NM_DHCP_HOSTNAME_FLAG_FQDN_NO_UPDATE (0x4). When no │
3233 │ │ │ │ FQDN flag is set and │
3234 │ │ │ │ NM_DHCP_HOSTNAME_FLAG_FQDN_CLEAR_FLAGS (0x8) is set, │
3235 │ │ │ │ the DHCP FQDN option will contain no flag. │
3236 │ │ │ │ Otherwise, if no FQDN flag is set and │
3237 │ │ │ │ NM_DHCP_HOSTNAME_FLAG_FQDN_CLEAR_FLAGS (0x8) is not │
3238 │ │ │ │ set, the standard FQDN flags are set in the request: │
3239 │ │ │ │ NM_DHCP_HOSTNAME_FLAG_FQDN_SERV_UPDATE (0x1), │
3240 │ │ │ │ NM_DHCP_HOSTNAME_FLAG_FQDN_ENCODED (0x2) for IPv4 │
3241 │ │ │ │ and NM_DHCP_HOSTNAME_FLAG_FQDN_SERV_UPDATE (0x1) for │
3242 │ │ │ │ IPv6. │
3243 │ │ │ │ │
3244 │ │ │ │ When this property is set to the default value │
3245 │ │ │ │ NM_DHCP_HOSTNAME_FLAG_NONE (0x0), a global default │
3246 │ │ │ │ is looked up in NetworkManager configuration. If │
3247 │ │ │ │ that value is unset or also │
3248 │ │ │ │ NM_DHCP_HOSTNAME_FLAG_NONE (0x0), then the standard │
3249 │ │ │ │ FQDN flags described above are sent in the DHCP │
3250 │ │ │ │ requests. │
3251 ├────────────────────┼───────────────────────────┼───────────────┼──────────────────────────────────────────────────────┤
3252 │dhcp-iaid │ string │ │ A string containing the "Identity Association │
3253 │ │ │ │ Identifier" (IAID) used by the DHCP client. The │
3254 │ │ │ │ string can be a 32-bit number (either decimal, │
3255 │ │ │ │ hexadecimal or or as colon separated hexadecimal │
3256 │ │ │ │ numbers). Alternatively it can be set to the special │
3257 │ │ │ │ values "mac", "perm-mac", "ifname" or "stable". When │
3258 │ │ │ │ set to "mac" (or "perm-mac"), the last 4 bytes of │
3259 │ │ │ │ the current (or permanent) MAC address are used as │
3260 │ │ │ │ IAID. When set to "ifname", the IAID is computed by │
3261 │ │ │ │ hashing the interface name. The special value │
3262 │ │ │ │ "stable" can be used to generate an IAID based on │
3263 │ │ │ │ the stable-id (see connection.stable-id), a per-host │
3264 │ │ │ │ key and the interface name. When the property is │
3265 │ │ │ │ unset, the value from global configuration is used; │
3266 │ │ │ │ if no global default is set then the IAID is assumed │
3267 │ │ │ │ to be "ifname". │
3268 │ │ │ │ │
3269 │ │ │ │ For DHCPv4, the IAID is only used with │
3270 │ │ │ │ "ipv4.dhcp-client-id" values "duid" and "ipv6-duid" │
3271 │ │ │ │ to generate the client-id. │
3272 │ │ │ │ │
3273 │ │ │ │ For DHCPv6, note that at the moment this property is │
3274 │ │ │ │ only supported by the "internal" DHCPv6 plugin. The │
3275 │ │ │ │ "dhclient" DHCPv6 plugin always derives the IAID │
3276 │ │ │ │ from the MAC address. │
3277 │ │ │ │ │
3278 │ │ │ │ The actually used DHCPv6 IAID for a currently │
3279 │ │ │ │ activated interface is exposed in the lease │
3280 │ │ │ │ information of the device. │
3281 ├────────────────────┼───────────────────────────┼───────────────┼──────────────────────────────────────────────────────┤
3282 │dhcp-reject-servers │ array of string │ │ Array of servers from which DHCP offers must be │
3283 │ │ │ │ rejected. This property is useful to avoid getting a │
3284 │ │ │ │ lease from misconfigured or rogue servers. │
3285 │ │ │ │ │
3286 │ │ │ │ For DHCPv4, each element must be an IPv4 address, │
3287 │ │ │ │ optionally followed by a slash and a prefix length │
3288 │ │ │ │ (e.g. "192.168.122.0/24"). │
3289 │ │ │ │ │
3290 │ │ │ │ This property is currently not implemented for │
3291 │ │ │ │ DHCPv6. │
3292 ├────────────────────┼───────────────────────────┼───────────────┼──────────────────────────────────────────────────────┤
3293 │dhcp-send-hostname │ boolean │ TRUE │ If TRUE, a hostname is sent to the DHCP server when │
3294 │ │ │ │ acquiring a lease. Some DHCP servers use this │
3295 │ │ │ │ hostname to update DNS databases, essentially │
3296 │ │ │ │ providing a static hostname for the computer. If │
3297 │ │ │ │ the "dhcp-hostname" property is NULL and this │
3298 │ │ │ │ property is TRUE, the current persistent hostname of │
3299 │ │ │ │ the computer is sent. │
3300 ├────────────────────┼───────────────────────────┼───────────────┼──────────────────────────────────────────────────────┤
3301 │dhcp-timeout │ int32 │ 0 │ A timeout for a DHCP transaction in seconds. If zero │
3302 │ │ │ │ (the default), a globally configured default is │
3303 │ │ │ │ used. If still unspecified, a device specific │
3304 │ │ │ │ timeout is used (usually 45 seconds). │
3305 │ │ │ │ │
3306 │ │ │ │ Set to 2147483647 (MAXINT32) for infinity. │
3307 ├────────────────────┼───────────────────────────┼───────────────┼──────────────────────────────────────────────────────┤
3308 │dns │ array of byte │ │ Array of IP addresses of DNS servers (in network │
3309 │ │ array │ │ byte order) │
3310 ├────────────────────┼───────────────────────────┼───────────────┼──────────────────────────────────────────────────────┤
3311 │dns-data │ array of strings │ │ Array of DNS name servers. This replaces the │
3312 │ │ │ │ deprecated "dns" property. Each name server can also │
3313 │ │ │ │ contain a DoT server name. │
3314 ├────────────────────┼───────────────────────────┼───────────────┼──────────────────────────────────────────────────────┤
3315 │dns-options │ array of string │ │ Array of DNS options as described in man 5 │
3316 │ │ │ │ resolv.conf. │
3317 │ │ │ │ │
3318 │ │ │ │ NULL means that the options are unset and left at │
3319 │ │ │ │ the default. In this case NetworkManager will use │
3320 │ │ │ │ default options. This is distinct from an empty list │
3321 │ │ │ │ of properties. │
3322 │ │ │ │ │
3323 │ │ │ │ The currently supported options are "attempts", │
3324 │ │ │ │ "debug", "edns0", "inet6", "ip6-bytestring", │
3325 │ │ │ │ "ip6-dotint", "ndots", "no-aaaa", "no-check-names", │
3326 │ │ │ │ "no-ip6-dotint", "no-reload", "no-tld-query", │
3327 │ │ │ │ "rotate", "single-request", "single-request-reopen", │
3328 │ │ │ │ "timeout", "trust-ad", "use-vc". │
3329 │ │ │ │ │
3330 │ │ │ │ The "trust-ad" setting is only honored if the │
3331 │ │ │ │ profile contributes name servers to resolv.conf, and │
3332 │ │ │ │ if all contributing profiles have "trust-ad" │
3333 │ │ │ │ enabled. │
3334 │ │ │ │ │
3335 │ │ │ │ When using a caching DNS plugin (dnsmasq or │
3336 │ │ │ │ systemd-resolved in NetworkManager.conf) then │
3337 │ │ │ │ "edns0" and "trust-ad" are automatically added. │
3338 ├────────────────────┼───────────────────────────┼───────────────┼──────────────────────────────────────────────────────┤
3339 │dns-priority │ int32 │ 0 │ DNS servers priority. │
3340 │ │ │ │ │
3341 │ │ │ │ The relative priority for DNS servers specified by │
3342 │ │ │ │ this setting. A lower numerical value is better │
3343 │ │ │ │ (higher priority). │
3344 │ │ │ │ │
3345 │ │ │ │ Negative values have the special effect of excluding │
3346 │ │ │ │ other configurations with a greater numerical │
3347 │ │ │ │ priority value; so in presence of at least one │
3348 │ │ │ │ negative priority, only DNS servers from connections │
3349 │ │ │ │ with the lowest priority value will be used. To │
3350 │ │ │ │ avoid all DNS leaks, set the priority of the profile │
3351 │ │ │ │ that should be used to the most negative value of │
3352 │ │ │ │ all active connections profiles. │
3353 │ │ │ │ │
3354 │ │ │ │ Zero selects a globally configured default value. If │
3355 │ │ │ │ the latter is missing or zero too, it defaults to 50 │
3356 │ │ │ │ for VPNs (including WireGuard) and 100 for other │
3357 │ │ │ │ connections. │
3358 │ │ │ │ │
3359 │ │ │ │ Note that the priority is to order DNS settings for │
3360 │ │ │ │ multiple active connections. It does not │
3361 │ │ │ │ disambiguate multiple DNS servers within the same │
3362 │ │ │ │ connection profile. │
3363 │ │ │ │ │
3364 │ │ │ │ When multiple devices have configurations with the │
3365 │ │ │ │ same priority, VPNs will be considered first, then │
3366 │ │ │ │ devices with the best (lowest metric) default route │
3367 │ │ │ │ and then all other devices. │
3368 │ │ │ │ │
3369 │ │ │ │ When using dns=default, servers with higher priority │
3370 │ │ │ │ will be on top of resolv.conf. To prioritize a given │
3371 │ │ │ │ server over another one within the same connection, │
3372 │ │ │ │ just specify them in the desired order. Note that │
3373 │ │ │ │ commonly the resolver tries name servers in │
3374 │ │ │ │ /etc/resolv.conf in the order listed, proceeding │
3375 │ │ │ │ with the next server in the list on failure. See for │
3376 │ │ │ │ example the "rotate" option of the dns-options │
3377 │ │ │ │ setting. If there are any negative DNS priorities, │
3378 │ │ │ │ then only name servers from the devices with that │
3379 │ │ │ │ lowest priority will be considered. │
3380 │ │ │ │ │
3381 │ │ │ │ When using a DNS resolver that supports Conditional │
3382 │ │ │ │ Forwarding or Split DNS (with dns=dnsmasq or │
3383 │ │ │ │ dns=systemd-resolved settings), each connection is │
3384 │ │ │ │ used to query domains in its search list. The search │
3385 │ │ │ │ domains determine which name servers to ask, and the │
3386 │ │ │ │ DNS priority is used to prioritize name servers │
3387 │ │ │ │ based on the domain. Queries for domains not │
3388 │ │ │ │ present in any search list are routed through │
3389 │ │ │ │ connections having the '~.' special wildcard domain, │
3390 │ │ │ │ which is added automatically to connections with the │
3391 │ │ │ │ default route (or can be added manually). When │
3392 │ │ │ │ multiple connections specify the same domain, the │
3393 │ │ │ │ one with the best priority (lowest numerical value) │
3394 │ │ │ │ wins. If a sub domain is configured on another │
3395 │ │ │ │ interface it will be accepted regardless the │
3396 │ │ │ │ priority, unless parent domain on the other │
3397 │ │ │ │ interface has a negative priority, which causes the │
3398 │ │ │ │ sub domain to be shadowed. With Split DNS one can │
3399 │ │ │ │ avoid undesired DNS leaks by properly configuring │
3400 │ │ │ │ DNS priorities and the search domains, so that only │
3401 │ │ │ │ name servers of the desired interface are │
3402 │ │ │ │ configured. │
3403 ├────────────────────┼───────────────────────────┼───────────────┼──────────────────────────────────────────────────────┤
3404 │dns-search │ array of string │ │ List of DNS search domains. Domains starting with a │
3405 │ │ │ │ tilde ('~') are considered 'routing' domains and are │
3406 │ │ │ │ used only to decide the interface over which a query │
3407 │ │ │ │ must be forwarded; they are not used to complete │
3408 │ │ │ │ unqualified host names. │
3409 │ │ │ │ │
3410 │ │ │ │ When using a DNS plugin that supports Conditional │
3411 │ │ │ │ Forwarding or Split DNS, then the search domains │
3412 │ │ │ │ specify which name servers to query. This makes the │
3413 │ │ │ │ behavior different from running with plain │
3414 │ │ │ │ /etc/resolv.conf. For more information see also the │
3415 │ │ │ │ dns-priority setting. │
3416 │ │ │ │ │
3417 │ │ │ │ When set on a profile that also enabled DHCP, the │
3418 │ │ │ │ DNS search list received automatically (option 119 │
3419 │ │ │ │ for DHCPv4 and option 24 for DHCPv6) gets merged │
3420 │ │ │ │ with the manual list. This can be prevented by │
3421 │ │ │ │ setting "ignore-auto-dns". Note that if no DNS │
3422 │ │ │ │ searches are configured, the fallback will be │
3423 │ │ │ │ derived from the domain from DHCP (option 15). │
3424 ├────────────────────┼───────────────────────────┼───────────────┼──────────────────────────────────────────────────────┤
3425 │gateway │ string │ │ The gateway associated with this configuration. This │
3426 │ │ │ │ is only meaningful if "addresses" is also set. │
3427 │ │ │ │ │
3428 │ │ │ │ Setting the gateway causes NetworkManager to │
3429 │ │ │ │ configure a standard default route with the gateway │
3430 │ │ │ │ as next hop. This is ignored if "never-default" is │
3431 │ │ │ │ set. An alternative is to configure the default │
3432 │ │ │ │ route explicitly with a manual route and /0 as │
3433 │ │ │ │ prefix length. │
3434 │ │ │ │ │
3435 │ │ │ │ Note that the gateway usually conflicts with routing │
3436 │ │ │ │ that NetworkManager configures for WireGuard │
3437 │ │ │ │ interfaces, so usually it should not be set in that │
3438 │ │ │ │ case. See "ip4-auto-default-route". │
3439 ├────────────────────┼───────────────────────────┼───────────────┼──────────────────────────────────────────────────────┤
3440 │ignore-auto-dns │ boolean │ FALSE │ When "method" is set to "auto" and this property to │
3441 │ │ │ │ TRUE, automatically configured name servers and │
3442 │ │ │ │ search domains are ignored and only name servers and │
3443 │ │ │ │ search domains specified in the "dns" and │
3444 │ │ │ │ "dns-search" properties, if any, are used. │
3445 ├────────────────────┼───────────────────────────┼───────────────┼──────────────────────────────────────────────────────┤
3446 │ignore-auto-routes │ boolean │ FALSE │ When "method" is set to "auto" and this property to │
3447 │ │ │ │ TRUE, automatically configured routes are ignored │
3448 │ │ │ │ and only routes specified in the "routes" property, │
3449 │ │ │ │ if any, are used. │
3450 ├────────────────────┼───────────────────────────┼───────────────┼──────────────────────────────────────────────────────┤
3451 │ip6-privacy │ NMSettingIP6ConfigPrivacy │ │ Configure IPv6 Privacy Extensions for SLAAC, │
3452 │ │ (int32) │ │ described in RFC4941. If enabled, it makes the │
3453 │ │ │ │ kernel generate a temporary IPv6 address in addition │
3454 │ │ │ │ to the public one generated from MAC address via │
3455 │ │ │ │ modified EUI-64. This enhances privacy, but could │
3456 │ │ │ │ cause problems in some applications, on the other │
3457 │ │ │ │ hand. The permitted values are: -1: unknown, 0: │
3458 │ │ │ │ disabled, 1: enabled (prefer public address), 2: │
3459 │ │ │ │ enabled (prefer temporary addresses). │
3460 │ │ │ │ │
3461 │ │ │ │ Having a per-connection setting set to "-1" │
3462 │ │ │ │ (unknown) means fallback to global configuration │
3463 │ │ │ │ "ipv6.ip6-privacy". │
3464 │ │ │ │ │
3465 │ │ │ │ If also global configuration is unspecified or set │
3466 │ │ │ │ to "-1", fallback to read │
3467 │ │ │ │ "/proc/sys/net/ipv6/conf/default/use_tempaddr". │
3468 │ │ │ │ │
3469 │ │ │ │ Note that this setting is distinct from the Stable │
3470 │ │ │ │ Privacy addresses that can be enabled with the │
3471 │ │ │ │ "addr-gen-mode" property's "stable-privacy" setting │
3472 │ │ │ │ as another way of avoiding host tracking with IPv6 │
3473 │ │ │ │ addresses. │
3474 ├────────────────────┼───────────────────────────┼───────────────┼──────────────────────────────────────────────────────┤
3475 │may-fail │ boolean │ TRUE │ If TRUE, allow overall network configuration to │
3476 │ │ │ │ proceed even if the configuration specified by this │
3477 │ │ │ │ property times out. Note that at least one IP │
3478 │ │ │ │ configuration must succeed or overall network │
3479 │ │ │ │ configuration will still fail. For example, in │
3480 │ │ │ │ IPv6-only networks, setting this property to TRUE on │
3481 │ │ │ │ the NMSettingIP4Config allows the overall network │
3482 │ │ │ │ configuration to succeed if IPv4 configuration fails │
3483 │ │ │ │ but IPv6 configuration completes successfully. │
3484 ├────────────────────┼───────────────────────────┼───────────────┼──────────────────────────────────────────────────────┤
3485 │method │ string │ │ IP configuration method. │
3486 │ │ │ │ │
3487 │ │ │ │ NMSettingIP4Config and NMSettingIP6Config both │
3488 │ │ │ │ support "disabled", "auto", "manual", and │
3489 │ │ │ │ "link-local". See the subclass-specific │
3490 │ │ │ │ documentation for other values. │
3491 │ │ │ │ │
3492 │ │ │ │ In general, for the "auto" method, properties such │
3493 │ │ │ │ as "dns" and "routes" specify information that is │
3494 │ │ │ │ added on to the information returned from automatic │
3495 │ │ │ │ configuration. The "ignore-auto-routes" and │
3496 │ │ │ │ "ignore-auto-dns" properties modify this behavior. │
3497 │ │ │ │ │
3498 │ │ │ │ For methods that imply no upstream network, such as │
3499 │ │ │ │ "shared" or "link-local", these properties must be │
3500 │ │ │ │ empty. │
3501 │ │ │ │ │
3502 │ │ │ │ For IPv4 method "shared", the IP subnet can be │
3503 │ │ │ │ configured by adding one manual IPv4 address or │
3504 │ │ │ │ otherwise 10.42.x.0/24 is chosen. Note that the │
3505 │ │ │ │ shared method must be configured on the interface │
3506 │ │ │ │ which shares the internet to a subnet, not on the │
3507 │ │ │ │ uplink which is shared. │
3508 ├────────────────────┼───────────────────────────┼───────────────┼──────────────────────────────────────────────────────┤
3509 │mtu │ uint32 │ 0 │ Maximum transmission unit size, in bytes. If zero │
3510 │ │ │ │ (the default), the MTU is set automatically from │
3511 │ │ │ │ router advertisements or is left equal to the │
3512 │ │ │ │ link-layer MTU. If greater than the link-layer MTU, │
3513 │ │ │ │ or greater than zero but less than the minimum IPv6 │
3514 │ │ │ │ MTU of 1280, this value has no effect. │
3515 ├────────────────────┼───────────────────────────┼───────────────┼──────────────────────────────────────────────────────┤
3516 │never-default │ boolean │ FALSE │ If TRUE, this connection will never be the default │
3517 │ │ │ │ connection for this IP type, meaning it will never │
3518 │ │ │ │ be assigned the default route by NetworkManager. │
3519 ├────────────────────┼───────────────────────────┼───────────────┼──────────────────────────────────────────────────────┤
3520 │ra-timeout │ int32 │ 0 │ A timeout for waiting Router Advertisements in │
3521 │ │ │ │ seconds. If zero (the default), a globally │
3522 │ │ │ │ configured default is used. If still unspecified, │
3523 │ │ │ │ the timeout depends on the sysctl settings of the │
3524 │ │ │ │ device. │
3525 │ │ │ │ │
3526 │ │ │ │ Set to 2147483647 (MAXINT32) for infinity. │
3527 ├────────────────────┼───────────────────────────┼───────────────┼──────────────────────────────────────────────────────┤
3528 │replace-local-rule │ NMTernary (int32) │ │ Connections will default to keep the autogenerated │
3529 │ │ │ │ priority 0 local rule unless this setting is set to │
3530 │ │ │ │ TRUE. │
3531 ├────────────────────┼───────────────────────────┼───────────────┼──────────────────────────────────────────────────────┤
3532 │required-timeout │ int32 │ -1 │ The minimum time interval in milliseconds for which │
3533 │ │ │ │ dynamic IP configuration should be tried before the │
3534 │ │ │ │ connection succeeds. │
3535 │ │ │ │ │
3536 │ │ │ │ This property is useful for example if both IPv4 and │
3537 │ │ │ │ IPv6 are enabled and are allowed to fail. Normally │
3538 │ │ │ │ the connection succeeds as soon as one of the two │
3539 │ │ │ │ address families completes; by setting a required │
3540 │ │ │ │ timeout for e.g. IPv4, one can ensure that even if │
3541 │ │ │ │ IP6 succeeds earlier than IPv4, NetworkManager waits │
3542 │ │ │ │ some time for IPv4 before the connection becomes │
3543 │ │ │ │ active. │
3544 │ │ │ │ │
3545 │ │ │ │ Note that if "may-fail" is FALSE for the same │
3546 │ │ │ │ address family, this property has no effect as │
3547 │ │ │ │ NetworkManager needs to wait for the full DHCP │
3548 │ │ │ │ timeout. │
3549 │ │ │ │ │
3550 │ │ │ │ A zero value means that no required timeout is │
3551 │ │ │ │ present, -1 means the default value (either │
3552 │ │ │ │ configuration ipvx.required-timeout override or │
3553 │ │ │ │ zero). │
3554 ├────────────────────┼───────────────────────────┼───────────────┼──────────────────────────────────────────────────────┤
3555 │route-data │ array of vardict │ │ Array of IPv6 routes. Each route dictionary contains │
3556 │ │ │ │ at least 'dest' and 'prefix' entries, containing the │
3557 │ │ │ │ destination IP address as a string, and the prefix │
3558 │ │ │ │ length as a uint32. Most routes will also have a │
3559 │ │ │ │ 'next-hop' entry, containing the next hop IP address │
3560 │ │ │ │ as a string. If the route has a 'metric' entry │
3561 │ │ │ │ (containing a uint32), that will be used as the │
3562 │ │ │ │ metric for the route (otherwise NM will pick a │
3563 │ │ │ │ default value appropriate to the device). Additional │
3564 │ │ │ │ attributes may also exist on some routes. │
3565 ├────────────────────┼───────────────────────────┼───────────────┼──────────────────────────────────────────────────────┤
3566 │route-metric │ int64 │ -1 │ The default metric for routes that don't explicitly │
3567 │ │ │ │ specify a metric. The default value -1 means that │
3568 │ │ │ │ the metric is chosen automatically based on the │
3569 │ │ │ │ device type. The metric applies to dynamic routes, │
3570 │ │ │ │ manual (static) routes that don't have an explicit │
3571 │ │ │ │ metric setting, address prefix routes, and the │
3572 │ │ │ │ default route. Note that for IPv6, the kernel │
3573 │ │ │ │ accepts zero (0) but coerces it to 1024 (user │
3574 │ │ │ │ default). Hence, setting this property to zero │
3575 │ │ │ │ effectively mean setting it to 1024. For IPv4, zero │
3576 │ │ │ │ is a regular value for the metric. │
3577 ├────────────────────┼───────────────────────────┼───────────────┼──────────────────────────────────────────────────────┤
3578 │route-table │ uint32 │ 0 │ Enable policy routing (source routing) and set the │
3579 │ │ │ │ routing table used when adding routes. │
3580 │ │ │ │ │
3581 │ │ │ │ This affects all routes, including device-routes, │
3582 │ │ │ │ IPv4LL, DHCP, SLAAC, default-routes and static │
3583 │ │ │ │ routes. But note that static routes can individually │
3584 │ │ │ │ overwrite the setting by explicitly specifying a │
3585 │ │ │ │ non-zero routing table. │
3586 │ │ │ │ │
3587 │ │ │ │ If the table setting is left at zero, it is eligible │
3588 │ │ │ │ to be overwritten via global configuration. If the │
3589 │ │ │ │ property is zero even after applying the global │
3590 │ │ │ │ configuration value, policy routing is disabled for │
3591 │ │ │ │ the address family of this connection. │
3592 │ │ │ │ │
3593 │ │ │ │ Policy routing disabled means that NetworkManager │
3594 │ │ │ │ will add all routes to the main table (except static │
3595 │ │ │ │ routes that explicitly configure a different table). │
3596 │ │ │ │ Additionally, NetworkManager will not delete any │
3597 │ │ │ │ extraneous routes from tables except the main table. │
3598 │ │ │ │ This is to preserve backward compatibility for users │
3599 │ │ │ │ who manage routing tables outside of NetworkManager. │
3600 ├────────────────────┼───────────────────────────┼───────────────┼──────────────────────────────────────────────────────┤
3601 │routes │ array of legacy IPv6 │ │ Deprecated in favor of the 'route-data' property, │
3602 │ │ route struct (a(ayuayu)) │ │ but this can be used for backward-compatibility with │
3603 │ │ │ │ older daemons. Note that if you send this property │
3604 │ │ │ │ the daemon will ignore 'route-data'. Array of IPv6 │
3605 │ │ │ │ route structures. Each IPv6 route structure is │
3606 │ │ │ │ composed of an IPv6 address, a prefix length (0 - │
3607 │ │ │ │ 128), an IPv6 next hop address (which may be zeroed │
3608 │ │ │ │ out if there is no next hop), and a metric. If the │
3609 │ │ │ │ metric is 0, NM will choose an appropriate default │
3610 │ │ │ │ metric for the device. │
3611 ├────────────────────┼───────────────────────────┼───────────────┼──────────────────────────────────────────────────────┤
3612 │routing-rules │ array of 'a{sv}' │ │ Array of dictionaries for routing rules. Each │
3613 │ │ │ │ routing rule supports the following options: action │
3614 │ │ │ │ (y), dport-end (q), dport-start (q), family (i), │
3615 │ │ │ │ from (s), from-len (y), fwmark (u), fwmask (u), │
3616 │ │ │ │ iifname (s), invert (b), ipproto (s), oifname (s), │
3617 │ │ │ │ priority (u), sport-end (q), sport-start (q), │
3618 │ │ │ │ supress-prefixlength (i), table (u), to (s), tos │
3619 │ │ │ │ (y), to-len (y), range-end (u), range-start (u). │
3620 ├────────────────────┼───────────────────────────┼───────────────┼──────────────────────────────────────────────────────┤
3621 │token │ string │ │ Configure the token for │
3622 │ │ │ │ draft-chown-6man-tokenised-ipv6-identifiers-02 IPv6 │
3623 │ │ │ │ tokenized interface identifiers. Useful with eui64 │
3624 │ │ │ │ addr-gen-mode. │
3625 └────────────────────┴───────────────────────────┴───────────────┴──────────────────────────────────────────────────────┘
3626 ip-tunnel setting
3628 IP Tunneling Settings.
3629 ┌────────────────────┬────────────┬───────────────┬──────────────────────────────────────────┐
3631 │Key Name │ Value Type │ Default Value │ Value │
3632 │ │ │ │ Description │
3633 ├────────────────────┼────────────┼───────────────┼──────────────────────────────────────────┤
3634 │encapsulation-limit │ uint32 │ 0 │ How many │
3635 │ │ │ │ additional │
3636 │ │ │ │ levels of │
3637 │ │ │ │ encapsulation │
3638 │ │ │ │ are permitted to │
3639 │ │ │ │ be prepended to │
3640 │ │ │ │ packets. This │
3641 │ │ │ │ property applies │
3642 │ │ │ │ only to IPv6 │
3643 │ │ │ │ tunnels. To │
3644 │ │ │ │ disable this │
3645 │ │ │ │ option, add │
3646 │ │ │ │ NM_IP_TUNNEL_FLAG_IP6_IGN_ENCAP_LIMIT │
3647 │ │ │ │ (0x1) to │
3648 │ │ │ │ ip-tunnel flags. │
3649 ├────────────────────┼────────────┼───────────────┼──────────────────────────────────────────┤
3650 │flags │ uint32 │ 0 │ Tunnel flags. Currently, the │
3651 │ │ │ │ following values are supported: │
3652 │ │ │ │ NM_IP_TUNNEL_FLAG_IP6_IGN_ENCAP_LIMIT │
3653 │ │ │ │ (0x1), │
3654 │ │ │ │ NM_IP_TUNNEL_FLAG_IP6_USE_ORIG_TCLASS │
3655 │ │ │ │ (0x2), │
3656 │ │ │ │ NM_IP_TUNNEL_FLAG_IP6_USE_ORIG_FLOWLABEL │
3657 │ │ │ │ (0x4), NM_IP_TUNNEL_FLAG_IP6_MIP6_DEV │
3658 │ │ │ │ (0x8), │
3659 │ │ │ │ NM_IP_TUNNEL_FLAG_IP6_RCV_DSCP_COPY │
3660 │ │ │ │ (0x10), │
3661 │ │ │ │ NM_IP_TUNNEL_FLAG_IP6_USE_ORIG_FWMARK │
3662 │ │ │ │ (0x20). They are valid only for IPv6 │
3663 │ │ │ │ tunnels. │
3664 ├────────────────────┼────────────┼───────────────┼──────────────────────────────────────────┤
3665 │flow-label │ uint32 │ 0 │ The flow label to assign to tunnel │
3666 │ │ │ │ packets. This property applies only to │
3667 │ │ │ │ IPv6 tunnels. │
3668 ├────────────────────┼────────────┼───────────────┼──────────────────────────────────────────┤
3669 │fwmark │ uint32 │ 0 │ The fwmark value to assign to tunnel │
3670 │ │ │ │ packets. This property can be set to a │
3671 │ │ │ │ non zero value only on VTI and VTI6 │
3672 │ │ │ │ tunnels. │
3673 ├────────────────────┼────────────┼───────────────┼──────────────────────────────────────────┤
3674 │input-key │ string │ │ The key used for tunnel input packets; │
3675 │ │ │ │ the property is valid only for certain │
3676 │ │ │ │ tunnel modes (GRE, IP6GRE). If empty, no │
3677 │ │ │ │ key is used. │
3678 ├────────────────────┼────────────┼───────────────┼──────────────────────────────────────────┤
3679 │local │ string │ │ The local endpoint of the tunnel; the │
3680 │ │ │ │ value can be empty, otherwise it must │
3681 │ │ │ │ contain an IPv4 or IPv6 address. │
3682 ├────────────────────┼────────────┼───────────────┼──────────────────────────────────────────┤
3683 │mode │ uint32 │ 0 │ The tunneling mode, for example │
3684 │ │ │ │ NM_IP_TUNNEL_MODE_IPIP (1) or │
3685 │ │ │ │ NM_IP_TUNNEL_MODE_GRE (2). │
3686 ├────────────────────┼────────────┼───────────────┼──────────────────────────────────────────┤
3687 │mtu │ uint32 │ 0 │ If non-zero, only transmit packets of │
3688 │ │ │ │ the specified size or smaller, breaking │
3689 │ │ │ │ larger packets up into multiple │
3690 │ │ │ │ fragments. │
3691 ├────────────────────┼────────────┼───────────────┼──────────────────────────────────────────┤
3692 │output-key │ string │ │ The key used for tunnel output packets; │
3693 │ │ │ │ the property is valid only for certain │
3694 │ │ │ │ tunnel modes (GRE, IP6GRE). If empty, no │
3695 │ │ │ │ key is used. │
3696 ├────────────────────┼────────────┼───────────────┼──────────────────────────────────────────┤
3697 │parent │ string │ │ If given, specifies the parent interface │
3698 │ │ │ │ name or parent connection UUID the new │
3699 │ │ │ │ device will be bound to so that tunneled │
3700 │ │ │ │ packets will only be routed via that │
3701 │ │ │ │ interface. │
3702 ├────────────────────┼────────────┼───────────────┼──────────────────────────────────────────┤
3703 │path-mtu-discovery │ boolean │ TRUE │ Whether to enable Path MTU Discovery on │
3704 │ │ │ │ this tunnel. │
3705 ├────────────────────┼────────────┼───────────────┼──────────────────────────────────────────┤
3706 │remote │ string │ │ The remote endpoint of the tunnel; the │
3707 │ │ │ │ value must contain an IPv4 or IPv6 │
3708 │ │ │ │ address. │
3709 ├────────────────────┼────────────┼───────────────┼──────────────────────────────────────────┤
3710 │tos │ uint32 │ 0 │ The type of service (IPv4) or traffic │
3711 │ │ │ │ class (IPv6) field to be set on tunneled │
3712 │ │ │ │ packets. │
3713 ├────────────────────┼────────────┼───────────────┼──────────────────────────────────────────┤
3714 │ttl │ uint32 │ 0 │ The TTL to assign to tunneled packets. 0 │
3715 │ │ │ │ is a special value meaning that packets │
3716 │ │ │ │ inherit the TTL value. │
3717 └────────────────────┴────────────┴───────────────┴──────────────────────────────────────────┘
3718 macsec setting
3720 MACSec Settings.
3721 ┌──────────────┬──────────────────────┬───────────────┬───────────────────────────┐
3723 │Key Name │ Value Type │ Default Value │ Value │
3724 │ │ │ │ Description │
3725 ├──────────────┼──────────────────────┼───────────────┼───────────────────────────┤
3726 │encrypt │ boolean │ TRUE │ Whether the │
3727 │ │ │ │ transmitted │
3728 │ │ │ │ traffic must be │
3729 │ │ │ │ encrypted. │
3730 ├──────────────┼──────────────────────┼───────────────┼───────────────────────────┤
3731 │mka-cak │ string │ │ The pre-shared │
3732 │ │ │ │ CAK │
3733 │ │ │ │ (Connectivity │
3734 │ │ │ │ Association Key) │
3735 │ │ │ │ for MACsec Key │
3736 │ │ │ │ Agreement. Must │
3737 │ │ │ │ be a string of │
3738 │ │ │ │ 32 hexadecimal │
3739 │ │ │ │ characters. │
3740 ├──────────────┼──────────────────────┼───────────────┼───────────────────────────┤
3741 │mka-cak-flags │ NMSettingSecretFlags │ │ Flags indicating │
3742 │ │ (uint32) │ │ how to handle │
3743 │ │ │ │ the "mka-cak" │
3744 │ │ │ │ property. │
3745 ├──────────────┼──────────────────────┼───────────────┼───────────────────────────┤
3746 │mka-ckn │ string │ │ The pre-shared │
3747 │ │ │ │ CKN │
3748 │ │ │ │ (Connectivity-association │
3749 │ │ │ │ Key Name) for │
3750 │ │ │ │ MACsec Key │
3751 │ │ │ │ Agreement. Must │
3752 │ │ │ │ be a string of │
3753 │ │ │ │ hexadecimal │
3754 │ │ │ │ characters with │
3755 │ │ │ │ a even length │
3756 │ │ │ │ between 2 and │
3757 │ │ │ │ 64. │
3758 ├──────────────┼──────────────────────┼───────────────┼───────────────────────────┤
3759 │mode │ int32 │ 0 │ Specifies how the CAK │
3760 │ │ │ │ (Connectivity Association │
3761 │ │ │ │ Key) for MKA (MACsec Key │
3762 │ │ │ │ Agreement) is obtained. │
3763 ├──────────────┼──────────────────────┼───────────────┼───────────────────────────┤
3764 │parent │ string │ │ If given, specifies the │
3765 │ │ │ │ parent interface name or │
3766 │ │ │ │ parent connection UUID │
3767 │ │ │ │ from which this MACSEC │
3768 │ │ │ │ interface should be │
3769 │ │ │ │ created. If this │
3770 │ │ │ │ property is not │
3771 │ │ │ │ specified, the connection │
3772 │ │ │ │ must contain an │
3773 │ │ │ │ "802-3-ethernet" setting │
3774 │ │ │ │ with a "mac-address" │
3775 │ │ │ │ property. │
3776 ├──────────────┼──────────────────────┼───────────────┼───────────────────────────┤
3777 │port │ int32 │ 1 │ The port component of the │
3778 │ │ │ │ SCI (Secure Channel │
3779 │ │ │ │ Identifier), between 1 │
3780 │ │ │ │ and 65534. │
3781 ├──────────────┼──────────────────────┼───────────────┼───────────────────────────┤
3782 │send-sci │ boolean │ TRUE │ Specifies whether the SCI │
3783 │ │ │ │ (Secure Channel │
3784 │ │ │ │ Identifier) is included │
3785 │ │ │ │ in every packet. │
3786 ├──────────────┼──────────────────────┼───────────────┼───────────────────────────┤
3787 │validation │ int32 │ 2 │ Specifies the validation │
3788 │ │ │ │ mode for incoming frames. │
3789 └──────────────┴──────────────────────┴───────────────┴───────────────────────────┘
3790 macvlan setting
3792 MAC VLAN Settings.
3793 ┌────────────┬────────────┬───────────────┬──────────────────┐
3795 │Key Name │ Value Type │ Default Value │ Value │
3796 │ │ │ │ Description │
3797 ├────────────┼────────────┼───────────────┼──────────────────┤
3798 │mode │ uint32 │ 0 │ The macvlan │
3799 │ │ │ │ mode, which │
3800 │ │ │ │ specifies the │
3801 │ │ │ │ communication │
3802 │ │ │ │ mechanism │
3803 │ │ │ │ between multiple │
3804 │ │ │ │ macvlans on the │
3805 │ │ │ │ same lower │
3806 │ │ │ │ device. │
3807 ├────────────┼────────────┼───────────────┼──────────────────┤
3808 │parent │ string │ │ If given, │
3809 │ │ │ │ specifies the │
3810 │ │ │ │ parent interface │
3811 │ │ │ │ name or parent │
3812 │ │ │ │ connection UUID │
3813 │ │ │ │ from which this │
3814 │ │ │ │ MAC-VLAN │
3815 │ │ │ │ interface should │
3816 │ │ │ │ be created. If │
3817 │ │ │ │ this property is │
3818 │ │ │ │ not specified, │
3819 │ │ │ │ the connection │
3820 │ │ │ │ must contain an │
3821 │ │ │ │ "802-3-ethernet" │
3822 │ │ │ │ setting with a │
3823 │ │ │ │ "mac-address" │
3824 │ │ │ │ property. │
3825 ├────────────┼────────────┼───────────────┼──────────────────┤
3826 │promiscuous │ boolean │ TRUE │ Whether the │
3827 │ │ │ │ interface should │
3828 │ │ │ │ be put in │
3829 │ │ │ │ promiscuous │
3830 │ │ │ │ mode. │
3831 ├────────────┼────────────┼───────────────┼──────────────────┤
3832 │tap │ boolean │ FALSE │ Whether the │
3833 │ │ │ │ interface should │
3834 │ │ │ │ be a MACVTAP. │
3835 └────────────┴────────────┴───────────────┴──────────────────┘
3836 match setting
3838 Match settings.
3839 ┌────────────────────┬─────────────────┬───────────────┬───────────────────────────────────────┐
3841 │Key Name │ Value Type │ Default Value │ Value │
3842 │ │ │ │ Description │
3843 ├────────────────────┼─────────────────┼───────────────┼───────────────────────────────────────┤
3844 │driver │ array of string │ │ A list of driver │
3845 │ │ │ │ names to match. │
3846 │ │ │ │ Each element is │
3847 │ │ │ │ a shell wildcard │
3848 │ │ │ │ pattern. │
3849 │ │ │ │ │
3850 │ │ │ │ See │
3851 │ │ │ │ NMSettingMatch:interface-name │
3852 │ │ │ │ for how special │
3853 │ │ │ │ characters '|', │
3854 │ │ │ │ '&', '!' and │
3855 │ │ │ │ '\\' are used │
3856 │ │ │ │ for optional and │
3857 │ │ │ │ mandatory │
3858 │ │ │ │ matches and │
3859 │ │ │ │ inverting the │
3860 │ │ │ │ pattern. │
3861 ├────────────────────┼─────────────────┼───────────────┼───────────────────────────────────────┤
3862 │interface-name │ array of string │ │ A list of interface names to │
3863 │ │ │ │ match. Each element is a │
3864 │ │ │ │ shell wildcard pattern. │
3865 │ │ │ │ │
3866 │ │ │ │ An element can be prefixed │
3867 │ │ │ │ with a pipe symbol (|) or an │
3868 │ │ │ │ ampersand (&). The former │
3869 │ │ │ │ means that the element is │
3870 │ │ │ │ optional and the latter means │
3871 │ │ │ │ that it is mandatory. If │
3872 │ │ │ │ there are any optional │
3873 │ │ │ │ elements, than the match │
3874 │ │ │ │ evaluates to true if at least │
3875 │ │ │ │ one of the optional element │
3876 │ │ │ │ matches (logical OR). If │
3877 │ │ │ │ there are any mandatory │
3878 │ │ │ │ elements, then they all must │
3879 │ │ │ │ match (logical AND). By │
3880 │ │ │ │ default, an element is │
3881 │ │ │ │ optional. This means that an │
3882 │ │ │ │ element "foo" behaves the │
3883 │ │ │ │ same as "|foo". An element │
3884 │ │ │ │ can also be inverted with │
3885 │ │ │ │ exclamation mark (!) between │
3886 │ │ │ │ the pipe symbol (or the │
3887 │ │ │ │ ampersand) and before the │
3888 │ │ │ │ pattern. Note that "!foo" is │
3889 │ │ │ │ a shortcut for the mandatory │
3890 │ │ │ │ match "&!foo". Finally, a │
3891 │ │ │ │ backslash can be used at the │
3892 │ │ │ │ beginning of the element │
3893 │ │ │ │ (after the optional special │
3894 │ │ │ │ characters) to escape the │
3895 │ │ │ │ start of the pattern. For │
3896 │ │ │ │ example, "&\\!a" is an │
3897 │ │ │ │ mandatory match for literally │
3898 │ │ │ │ "!a". │
3899 ├────────────────────┼─────────────────┼───────────────┼───────────────────────────────────────┤
3900 │kernel-command-line │ array of string │ │ A list of kernel command line │
3901 │ │ │ │ arguments to match. This may │
3902 │ │ │ │ be used to check whether a │
3903 │ │ │ │ specific kernel command line │
3904 │ │ │ │ option is set (or unset, if │
3905 │ │ │ │ prefixed with the exclamation │
3906 │ │ │ │ mark). The argument must │
3907 │ │ │ │ either be a single word, or │
3908 │ │ │ │ an assignment (i.e. two │
3909 │ │ │ │ words, joined by "="). In the │
3910 │ │ │ │ former case the kernel │
3911 │ │ │ │ command line is searched for │
3912 │ │ │ │ the word appearing as is, or │
3913 │ │ │ │ as left hand side of an │
3914 │ │ │ │ assignment. In the latter │
3915 │ │ │ │ case, the exact assignment is │
3916 │ │ │ │ looked for with right and │
3917 │ │ │ │ left hand side matching. │
3918 │ │ │ │ Wildcard patterns are not │
3919 │ │ │ │ supported. │
3920 │ │ │ │ │
3921 │ │ │ │ See │
3922 │ │ │ │ NMSettingMatch:interface-name │
3923 │ │ │ │ for how special characters │
3924 │ │ │ │ '|', '&', '!' and '\\' are │
3925 │ │ │ │ used for optional and │
3926 │ │ │ │ mandatory matches and │
3927 │ │ │ │ inverting the match. │
3928 ├────────────────────┼─────────────────┼───────────────┼───────────────────────────────────────┤
3929 │path │ array of string │ │ A list of paths to match │
3930 │ │ │ │ against the ID_PATH udev │
3931 │ │ │ │ property of devices. ID_PATH │
3932 │ │ │ │ represents the topological │
3933 │ │ │ │ persistent path of a device. │
3934 │ │ │ │ It typically contains a │
3935 │ │ │ │ subsystem string (pci, usb, │
3936 │ │ │ │ platform, etc.) and a │
3937 │ │ │ │ subsystem-specific │
3938 │ │ │ │ identifier. │
3939 │ │ │ │ │
3940 │ │ │ │ For PCI devices the path has │
3941 │ │ │ │ the form │
3942 │ │ │ │ "pci-$domain:$bus:$device.$function", │
3943 │ │ │ │ where each variable is an │
3944 │ │ │ │ hexadecimal value; for │
3945 │ │ │ │ example "pci-0000:0a:00.0". │
3946 │ │ │ │ │
3947 │ │ │ │ The path of a device can be │
3948 │ │ │ │ obtained with "udevadm info │
3949 │ │ │ │ /sys/class/net/$dev | grep │
3950 │ │ │ │ ID_PATH=" or by looking at │
3951 │ │ │ │ the "path" property exported │
3952 │ │ │ │ by NetworkManager ("nmcli -f │
3953 │ │ │ │ general.path device show │
3954 │ │ │ │ $dev"). │
3955 │ │ │ │ │
3956 │ │ │ │ Each element of the list is a │
3957 │ │ │ │ shell wildcard pattern. │
3958 │ │ │ │ │
3959 │ │ │ │ See │
3960 │ │ │ │ NMSettingMatch:interface-name │
3961 │ │ │ │ for how special characters │
3962 │ │ │ │ '|', '&', '!' and '\\' are │
3963 │ │ │ │ used for optional and │
3964 │ │ │ │ mandatory matches and │
3965 │ │ │ │ inverting the pattern. │
3966 └────────────────────┴─────────────────┴───────────────┴───────────────────────────────────────┘
3967 802-11-olpc-mesh setting
3969 OLPC Wireless Mesh Settings.
3970 ┌─────────────────────┬────────────┬───────────────┬──────────────────┐
3972 │Key Name │ Value Type │ Default Value │ Value │
3973 │ │ │ │ Description │
3974 ├─────────────────────┼────────────┼───────────────┼──────────────────┤
3975 │channel │ uint32 │ 0 │ Channel on which │
3976 │ │ │ │ the mesh network │
3977 │ │ │ │ to join is │
3978 │ │ │ │ located. │
3979 ├─────────────────────┼────────────┼───────────────┼──────────────────┤
3980 │dhcp-anycast-address │ byte array │ │ Anycast DHCP MAC │
3981 │ │ │ │ address used │
3982 │ │ │ │ when requesting │
3983 │ │ │ │ an IP address │
3984 │ │ │ │ via DHCP. The │
3985 │ │ │ │ specific anycast │
3986 │ │ │ │ address used │
3987 │ │ │ │ determines which │
3988 │ │ │ │ DHCP server │
3989 │ │ │ │ class answers │
3990 │ │ │ │ the request. │
3991 │ │ │ │ │
3992 │ │ │ │ This is │
3993 │ │ │ │ currently only │
3994 │ │ │ │ implemented by │
3995 │ │ │ │ dhclient DHCP │
3996 │ │ │ │ plugin. │
3997 ├─────────────────────┼────────────┼───────────────┼──────────────────┤
3998 │ssid │ byte array │ │ SSID of the mesh │
3999 │ │ │ │ network to join. │
4000 └─────────────────────┴────────────┴───────────────┴──────────────────┘
4001 ovs-bridge setting
4003 OvsBridge Link Settings.
4004 ┌──────────────────────┬────────────┬───────────────┬──────────────────┐
4006 │Key Name │ Value Type │ Default Value │ Value │
4007 │ │ │ │ Description │
4008 ├──────────────────────┼────────────┼───────────────┼──────────────────┤
4009 │datapath-type │ string │ │ The data path │
4010 │ │ │ │ type. One of │
4011 │ │ │ │ "system", │
4012 │ │ │ │ "netdev" or │
4013 │ │ │ │ empty. │
4014 ├──────────────────────┼────────────┼───────────────┼──────────────────┤
4015 │fail-mode │ string │ │ The bridge │
4016 │ │ │ │ failure mode. │
4017 │ │ │ │ One of "secure", │
4018 │ │ │ │ "standalone" or │
4019 │ │ │ │ empty. │
4020 ├──────────────────────┼────────────┼───────────────┼──────────────────┤
4021 │mcast-snooping-enable │ boolean │ FALSE │ Enable or │
4022 │ │ │ │ disable │
4023 │ │ │ │ multicast │
4024 │ │ │ │ snooping. │
4025 ├──────────────────────┼────────────┼───────────────┼──────────────────┤
4026 │rstp-enable │ boolean │ FALSE │ Enable or │
4027 │ │ │ │ disable RSTP. │
4028 ├──────────────────────┼────────────┼───────────────┼──────────────────┤
4029 │stp-enable │ boolean │ FALSE │ Enable or │
4030 │ │ │ │ disable STP. │
4031 └──────────────────────┴────────────┴───────────────┴──────────────────┘
4032 ovs-dpdk setting
4034 OvsDpdk Link Settings.
4035 ┌───────────┬────────────┬───────────────┬──────────────────┐
4037 │Key Name │ Value Type │ Default Value │ Value │
4038 │ │ │ │ Description │
4039 ├───────────┼────────────┼───────────────┼──────────────────┤
4040 │devargs │ string │ │ Open vSwitch │
4041 │ │ │ │ DPDK device │
4042 │ │ │ │ arguments. │
4043 ├───────────┼────────────┼───────────────┼──────────────────┤
4044 │n-rxq │ uint32 │ 0 │ Open vSwitch │
4045 │ │ │ │ DPDK number of │
4046 │ │ │ │ rx queues. │
4047 │ │ │ │ Defaults to zero │
4048 │ │ │ │ which means to │
4049 │ │ │ │ leave the │
4050 │ │ │ │ parameter in OVS │
4051 │ │ │ │ unspecified and │
4052 │ │ │ │ effectively │
4053 │ │ │ │ configures one │
4054 │ │ │ │ queue. │
4055 ├───────────┼────────────┼───────────────┼──────────────────┤
4056 │n-rxq-desc │ uint32 │ 0 │ The rx queue │
4057 │ │ │ │ size (number of │
4058 │ │ │ │ rx descriptors) │
4059 │ │ │ │ for DPDK ports. │
4060 │ │ │ │ Must be zero or │
4061 │ │ │ │ a power of 2 │
4062 │ │ │ │ between 1 and │
4063 │ │ │ │ 4096, and │
4064 │ │ │ │ supported by the │
4065 │ │ │ │ hardware. │
4066 │ │ │ │ Defaults to zero │
4067 │ │ │ │ which means to │
4068 │ │ │ │ leave the │
4069 │ │ │ │ parameter in OVS │
4070 │ │ │ │ unspecified and │
4071 │ │ │ │ effectively │
4072 │ │ │ │ configures 2048 │
4073 │ │ │ │ descriptors. │
4074 ├───────────┼────────────┼───────────────┼──────────────────┤
4075 │n-txq-desc │ uint32 │ 0 │ The tx queue │
4076 │ │ │ │ size (number of │
4077 │ │ │ │ tx descriptors) │
4078 │ │ │ │ for DPDK ports. │
4079 │ │ │ │ Must be zero or │
4080 │ │ │ │ a power of 2 │
4081 │ │ │ │ between 1 and │
4082 │ │ │ │ 4096, and │
4083 │ │ │ │ supported by the │
4084 │ │ │ │ hardware. │
4085 │ │ │ │ Defaults to zero │
4086 │ │ │ │ which means to │
4087 │ │ │ │ leave the │
4088 │ │ │ │ parameter in OVS │
4089 │ │ │ │ unspecified and │
4090 │ │ │ │ effectively │
4091 │ │ │ │ configures 2048 │
4092 │ │ │ │ descriptors. │
4093 └───────────┴────────────┴───────────────┴──────────────────┘
4094 ovs-interface setting
4096 Open vSwitch Interface Settings.
4097 ┌───────────────┬────────────┬───────────────┬──────────────────┐
4099 │Key Name │ Value Type │ Default Value │ Value │
4100 │ │ │ │ Description │
4101 ├───────────────┼────────────┼───────────────┼──────────────────┤
4102 │ofport-request │ uint32 │ 0 │ Open vSwitch │
4103 │ │ │ │ openflow port │
4104 │ │ │ │ number. Defaults │
4105 │ │ │ │ to zero which │
4106 │ │ │ │ means that port │
4107 │ │ │ │ number will not │
4108 │ │ │ │ be specified and │
4109 │ │ │ │ it will be │
4110 │ │ │ │ chosen randomly │
4111 │ │ │ │ by ovs. OpenFlow │
4112 │ │ │ │ ports are the │
4113 │ │ │ │ network │
4114 │ │ │ │ interfaces for │
4115 │ │ │ │ passing packets │
4116 │ │ │ │ between OpenFlow │
4117 │ │ │ │ processing and │
4118 │ │ │ │ the rest of the │
4119 │ │ │ │ network. │
4120 │ │ │ │ OpenFlow │
4121 │ │ │ │ switches connect │
4122 │ │ │ │ logically to │
4123 │ │ │ │ each other via │
4124 │ │ │ │ their OpenFlow │
4125 │ │ │ │ ports. │
4126 ├───────────────┼────────────┼───────────────┼──────────────────┤
4127 │type │ string │ │ The interface │
4128 │ │ │ │ type. Either │
4129 │ │ │ │ "internal", │
4130 │ │ │ │ "system", │
4131 │ │ │ │ "patch", "dpdk", │
4132 │ │ │ │ or empty. │
4133 └───────────────┴────────────┴───────────────┴──────────────────┘
4134 ovs-patch setting
4136 OvsPatch Link Settings.
4137 ┌─────────┬────────────┬───────────────┬──────────────────┐
4139 │Key Name │ Value Type │ Default Value │ Value │
4140 │ │ │ │ Description │
4141 ├─────────┼────────────┼───────────────┼──────────────────┤
4142 │peer │ string │ │ Specifies the │
4143 │ │ │ │ name of the │
4144 │ │ │ │ interface for │
4145 │ │ │ │ the other side │
4146 │ │ │ │ of the patch. │
4147 │ │ │ │ The patch on the │
4148 │ │ │ │ other side must │
4149 │ │ │ │ also set this │
4150 │ │ │ │ interface as │
4151 │ │ │ │ peer. │
4152 └─────────┴────────────┴───────────────┴──────────────────┘
4153 ovs-port setting
4155 OvsPort Link Settings.
4156 ┌───────────────┬──────────────────┬───────────────┬────────────────────┐
4158 │Key Name │ Value Type │ Default Value │ Value │
4159 │ │ │ │ Description │
4160 ├───────────────┼──────────────────┼───────────────┼────────────────────┤
4161 │bond-downdelay │ uint32 │ 0 │ The time port │
4162 │ │ │ │ must be inactive │
4163 │ │ │ │ in order to be │
4164 │ │ │ │ considered down. │
4165 ├───────────────┼──────────────────┼───────────────┼────────────────────┤
4166 │bond-mode │ string │ │ Bonding mode. │
4167 │ │ │ │ One of │
4168 │ │ │ │ "active-backup", │
4169 │ │ │ │ "balance-slb", │
4170 │ │ │ │ or │
4171 │ │ │ │ "balance-tcp". │
4172 ├───────────────┼──────────────────┼───────────────┼────────────────────┤
4173 │bond-updelay │ uint32 │ 0 │ The time port │
4174 │ │ │ │ must be active │
4175 │ │ │ │ before it starts │
4176 │ │ │ │ forwarding │
4177 │ │ │ │ traffic. │
4178 ├───────────────┼──────────────────┼───────────────┼────────────────────┤
4179 │lacp │ string │ │ LACP mode. One │
4180 │ │ │ │ of "active", │
4181 │ │ │ │ "off", or │
4182 │ │ │ │ "passive". │
4183 ├───────────────┼──────────────────┼───────────────┼────────────────────┤
4184 │tag │ uint32 │ 0 │ The VLAN tag in │
4185 │ │ │ │ the range │
4186 │ │ │ │ 0-4095. │
4187 ├───────────────┼──────────────────┼───────────────┼────────────────────┤
4188 │trunks │ array of vardict │ │ A list of VLAN │
4189 │ │ │ │ ranges that this │
4190 │ │ │ │ port trunks. │
4191 │ │ │ │ │
4192 │ │ │ │ The property is │
4193 │ │ │ │ valid only for │
4194 │ │ │ │ ports with mode │
4195 │ │ │ │ "trunk", │
4196 │ │ │ │ "native-tagged", │
4197 │ │ │ │ or │
4198 │ │ │ │ "native-untagged │
4199 │ │ │ │ port". If it is │
4200 │ │ │ │ empty, the port │
4201 │ │ │ │ trunks all │
4202 │ │ │ │ VLANs. │
4203 ├───────────────┼──────────────────┼───────────────┼────────────────────┤
4204 │vlan-mode │ string │ │ The VLAN mode. │
4205 │ │ │ │ One of "access", │
4206 │ │ │ │ "native-tagged", │
4207 │ │ │ │ "native-untagged", │
4208 │ │ │ │ "trunk", │
4209 │ │ │ │ "dot1q-tunnel" │
4210 │ │ │ │ or unset. │
4211 └───────────────┴──────────────────┴───────────────┴────────────────────┘
4212 ppp setting
4214 Point-to-Point Protocol Settings.
4215 ┌──────────────────┬────────────┬───────────────┬─────────────────────┐
4217 │Key Name │ Value Type │ Default Value │ Value │
4218 │ │ │ │ Description │
4219 ├──────────────────┼────────────┼───────────────┼─────────────────────┤
4220 │baud │ uint32 │ 0 │ If non-zero, │
4221 │ │ │ │ instruct pppd to │
4222 │ │ │ │ set the serial │
4223 │ │ │ │ port to the │
4224 │ │ │ │ specified │
4225 │ │ │ │ baudrate. This │
4226 │ │ │ │ value should │
4227 │ │ │ │ normally be left │
4228 │ │ │ │ as 0 to │
4229 │ │ │ │ automatically │
4230 │ │ │ │ choose the │
4231 │ │ │ │ speed. │
4232 ├──────────────────┼────────────┼───────────────┼─────────────────────┤
4233 │crtscts │ boolean │ FALSE │ If TRUE, specify │
4234 │ │ │ │ that pppd should │
4235 │ │ │ │ set the serial │
4236 │ │ │ │ port to use │
4237 │ │ │ │ hardware flow │
4238 │ │ │ │ control with RTS │
4239 │ │ │ │ and CTS signals. │
4240 │ │ │ │ This value │
4241 │ │ │ │ should normally │
4242 │ │ │ │ be set to FALSE. │
4243 ├──────────────────┼────────────┼───────────────┼─────────────────────┤
4244 │lcp-echo-failure │ uint32 │ 0 │ If non-zero, │
4245 │ │ │ │ instruct pppd to │
4246 │ │ │ │ presume the │
4247 │ │ │ │ connection to │
4248 │ │ │ │ the peer has │
4249 │ │ │ │ failed if the │
4250 │ │ │ │ specified number │
4251 │ │ │ │ of LCP │
4252 │ │ │ │ echo-requests go │
4253 │ │ │ │ unanswered by │
4254 │ │ │ │ the peer. The │
4255 │ │ │ │ "lcp-echo-interval" │
4256 │ │ │ │ property must │
4257 │ │ │ │ also be set to a │
4258 │ │ │ │ non-zero value │
4259 │ │ │ │ if this property │
4260 │ │ │ │ is used. │
4261 ├──────────────────┼────────────┼───────────────┼─────────────────────┤
4262 │lcp-echo-interval │ uint32 │ 0 │ If non-zero, │
4263 │ │ │ │ instruct pppd to │
4264 │ │ │ │ send an LCP │
4265 │ │ │ │ echo-request frame │
4266 │ │ │ │ to the peer every n │
4267 │ │ │ │ seconds (where n is │
4268 │ │ │ │ the specified │
4269 │ │ │ │ value). Note that │
4270 │ │ │ │ some PPP peers will │
4271 │ │ │ │ respond to echo │
4272 │ │ │ │ requests and some │
4273 │ │ │ │ will not, and it is │
4274 │ │ │ │ not possible to │
4275 │ │ │ │ autodetect this. │
4276 ├──────────────────┼────────────┼───────────────┼─────────────────────┤
4277 │mppe-stateful │ boolean │ FALSE │ If TRUE, stateful │
4278 │ │ │ │ MPPE is used. See │
4279 │ │ │ │ pppd documentation │
4280 │ │ │ │ for more │
4281 │ │ │ │ information on │
4282 │ │ │ │ stateful MPPE. │
4283 ├──────────────────┼────────────┼───────────────┼─────────────────────┤
4284 │mru │ uint32 │ 0 │ If non-zero, │
4285 │ │ │ │ instruct pppd to │
4286 │ │ │ │ request that the │
4287 │ │ │ │ peer send packets │
4288 │ │ │ │ no larger than the │
4289 │ │ │ │ specified size. If │
4290 │ │ │ │ non-zero, the MRU │
4291 │ │ │ │ should be between │
4292 │ │ │ │ 128 and 16384. │
4293 ├──────────────────┼────────────┼───────────────┼─────────────────────┤
4294 │mtu │ uint32 │ 0 │ If non-zero, │
4295 │ │ │ │ instruct pppd to │
4296 │ │ │ │ send packets no │
4297 │ │ │ │ larger than the │
4298 │ │ │ │ specified size. │
4299 ├──────────────────┼────────────┼───────────────┼─────────────────────┤
4300 │no-vj-comp │ boolean │ FALSE │ If TRUE, Van │
4301 │ │ │ │ Jacobsen TCP header │
4302 │ │ │ │ compression will │
4303 │ │ │ │ not be requested. │
4304 ├──────────────────┼────────────┼───────────────┼─────────────────────┤
4305 │noauth │ boolean │ TRUE │ If TRUE, do not │
4306 │ │ │ │ require the other │
4307 │ │ │ │ side (usually the │
4308 │ │ │ │ PPP server) to │
4309 │ │ │ │ authenticate itself │
4310 │ │ │ │ to the client. If │
4311 │ │ │ │ FALSE, require │
4312 │ │ │ │ authentication from │
4313 │ │ │ │ the remote side. │
4314 │ │ │ │ In almost all │
4315 │ │ │ │ cases, this should │
4316 │ │ │ │ be TRUE. │
4317 ├──────────────────┼────────────┼───────────────┼─────────────────────┤
4318 │nobsdcomp │ boolean │ FALSE │ If TRUE, BSD │
4319 │ │ │ │ compression will │
4320 │ │ │ │ not be requested. │
4321 ├──────────────────┼────────────┼───────────────┼─────────────────────┤
4322 │nodeflate │ boolean │ FALSE │ If TRUE, "deflate" │
4323 │ │ │ │ compression will │
4324 │ │ │ │ not be requested. │
4325 ├──────────────────┼────────────┼───────────────┼─────────────────────┤
4326 │refuse-chap │ boolean │ FALSE │ If TRUE, the CHAP │
4327 │ │ │ │ authentication │
4328 │ │ │ │ method will not be │
4329 │ │ │ │ used. │
4330 ├──────────────────┼────────────┼───────────────┼─────────────────────┤
4331 │refuse-eap │ boolean │ FALSE │ If TRUE, the EAP │
4332 │ │ │ │ authentication │
4333 │ │ │ │ method will not be │
4334 │ │ │ │ used. │
4335 ├──────────────────┼────────────┼───────────────┼─────────────────────┤
4336 │refuse-mschap │ boolean │ FALSE │ If TRUE, the MSCHAP │
4337 │ │ │ │ authentication │
4338 │ │ │ │ method will not be │
4339 │ │ │ │ used. │
4340 ├──────────────────┼────────────┼───────────────┼─────────────────────┤
4341 │refuse-mschapv2 │ boolean │ FALSE │ If TRUE, the │
4342 │ │ │ │ MSCHAPv2 │
4343 │ │ │ │ authentication │
4344 │ │ │ │ method will not be │
4345 │ │ │ │ used. │
4346 ├──────────────────┼────────────┼───────────────┼─────────────────────┤
4347 │refuse-pap │ boolean │ FALSE │ If TRUE, the PAP │
4348 │ │ │ │ authentication │
4349 │ │ │ │ method will not be │
4350 │ │ │ │ used. │
4351 ├──────────────────┼────────────┼───────────────┼─────────────────────┤
4352 │require-mppe │ boolean │ FALSE │ If TRUE, MPPE │
4353 │ │ │ │ (Microsoft │
4354 │ │ │ │ Point-to-Point │
4355 │ │ │ │ Encryption) will be │
4356 │ │ │ │ required for the │
4357 │ │ │ │ PPP session. If │
4358 │ │ │ │ either 64-bit or │
4359 │ │ │ │ 128-bit MPPE is not │
4360 │ │ │ │ available the │
4361 │ │ │ │ session will fail. │
4362 │ │ │ │ Note that MPPE is │
4363 │ │ │ │ not used on mobile │
4364 │ │ │ │ broadband │
4365 │ │ │ │ connections. │
4366 ├──────────────────┼────────────┼───────────────┼─────────────────────┤
4367 │require-mppe-128 │ boolean │ FALSE │ If TRUE, 128-bit │
4368 │ │ │ │ MPPE (Microsoft │
4369 │ │ │ │ Point-to-Point │
4370 │ │ │ │ Encryption) will be │
4371 │ │ │ │ required for the │
4372 │ │ │ │ PPP session, and │
4373 │ │ │ │ the "require-mppe" │
4374 │ │ │ │ property must also │
4375 │ │ │ │ be set to TRUE. If │
4376 │ │ │ │ 128-bit MPPE is not │
4377 │ │ │ │ available the │
4378 │ │ │ │ session will fail. │
4379 └──────────────────┴────────────┴───────────────┴─────────────────────┘
4380 pppoe setting
4382 PPP-over-Ethernet Settings.
4383 ┌───────────────┬──────────────────────┬───────────────┬──────────────────────┐
4385 │Key Name │ Value Type │ Default Value │ Value │
4386 │ │ │ │ Description │
4387 ├───────────────┼──────────────────────┼───────────────┼──────────────────────┤
4388 │parent │ string │ │ If given, │
4389 │ │ │ │ specifies the │
4390 │ │ │ │ parent interface │
4391 │ │ │ │ name on which │
4392 │ │ │ │ this PPPoE │
4393 │ │ │ │ connection │
4394 │ │ │ │ should be │
4395 │ │ │ │ created. If │
4396 │ │ │ │ this property is │
4397 │ │ │ │ not specified, │
4398 │ │ │ │ the connection │
4399 │ │ │ │ is activated on │
4400 │ │ │ │ the interface │
4401 │ │ │ │ specified in │
4402 │ │ │ │ "interface-name" │
4403 │ │ │ │ of │
4404 │ │ │ │ NMSettingConnection. │
4405 ├───────────────┼──────────────────────┼───────────────┼──────────────────────┤
4406 │password │ string │ │ Password used to │
4407 │ │ │ │ authenticate with │
4408 │ │ │ │ the PPPoE service. │
4409 ├───────────────┼──────────────────────┼───────────────┼──────────────────────┤
4410 │password-flags │ NMSettingSecretFlags │ │ Flags indicating how │
4411 │ │ (uint32) │ │ to handle the │
4412 │ │ │ │ "password" property. │
4413 ├───────────────┼──────────────────────┼───────────────┼──────────────────────┤
4414 │service │ string │ │ If specified, │
4415 │ │ │ │ instruct PPPoE to │
4416 │ │ │ │ only initiate │
4417 │ │ │ │ sessions with access │
4418 │ │ │ │ concentrators that │
4419 │ │ │ │ provide the │
4420 │ │ │ │ specified service. │
4421 │ │ │ │ For most providers, │
4422 │ │ │ │ this should be left │
4423 │ │ │ │ blank. It is only │
4424 │ │ │ │ required if there │
4425 │ │ │ │ are multiple access │
4426 │ │ │ │ concentrators or a │
4427 │ │ │ │ specific service is │
4428 │ │ │ │ known to be │
4429 │ │ │ │ required. │
4430 ├───────────────┼──────────────────────┼───────────────┼──────────────────────┤
4431 │username │ string │ │ Username used to │
4432 │ │ │ │ authenticate with │
4433 │ │ │ │ the PPPoE service. │
4434 └───────────────┴──────────────────────┴───────────────┴──────────────────────┘
4435 proxy setting
4437 WWW Proxy Settings.
4438 ┌─────────────┬────────────┬───────────────┬──────────────────────────────┐
4440 │Key Name │ Value Type │ Default Value │ Value │
4441 │ │ │ │ Description │
4442 ├─────────────┼────────────┼───────────────┼──────────────────────────────┤
4443 │browser-only │ boolean │ FALSE │ Whether the │
4444 │ │ │ │ proxy │
4445 │ │ │ │ configuration is │
4446 │ │ │ │ for browser │
4447 │ │ │ │ only. │
4448 ├─────────────┼────────────┼───────────────┼──────────────────────────────┤
4449 │method │ int32 │ 0 │ Method for proxy │
4450 │ │ │ │ configuration, │
4451 │ │ │ │ Default is │
4452 │ │ │ │ NM_SETTING_PROXY_METHOD_NONE │
4453 │ │ │ │ (0) │
4454 ├─────────────┼────────────┼───────────────┼──────────────────────────────┤
4455 │pac-script │ string │ │ PAC script for the │
4456 │ │ │ │ connection. This is an UTF-8 │
4457 │ │ │ │ encoded javascript code that │
4458 │ │ │ │ defines a FindProxyForURL() │
4459 │ │ │ │ function. │
4460 ├─────────────┼────────────┼───────────────┼──────────────────────────────┤
4461 │pac-url │ string │ │ PAC URL for obtaining PAC │
4462 │ │ │ │ file. │
4463 └─────────────┴────────────┴───────────────┴──────────────────────────────┘
4464 serial setting
4466 Serial Link Settings.
4467 ┌───────────┬────────────┬───────────────┬──────────────────┐
4469 │Key Name │ Value Type │ Default Value │ Value │
4470 │ │ │ │ Description │
4471 ├───────────┼────────────┼───────────────┼──────────────────┤
4472 │baud │ uint32 │ 57600 │ Speed to use for │
4473 │ │ │ │ communication │
4474 │ │ │ │ over the serial │
4475 │ │ │ │ port. Note that │
4476 │ │ │ │ this value │
4477 │ │ │ │ usually has no │
4478 │ │ │ │ effect for │
4479 │ │ │ │ mobile broadband │
4480 │ │ │ │ modems as they │
4481 │ │ │ │ generally ignore │
4482 │ │ │ │ speed settings │
4483 │ │ │ │ and use the │
4484 │ │ │ │ highest │
4485 │ │ │ │ available speed. │
4486 ├───────────┼────────────┼───────────────┼──────────────────┤
4487 │bits │ uint32 │ 8 │ Byte-width of │
4488 │ │ │ │ the serial │
4489 │ │ │ │ communication. │
4490 │ │ │ │ The 8 in "8n1" │
4491 │ │ │ │ for example. │
4492 ├───────────┼────────────┼───────────────┼──────────────────┤
4493 │parity │ byte │ │ The connection │
4494 │ │ │ │ parity: 69 │
4495 │ │ │ │ (ASCII 'E') for │
4496 │ │ │ │ even parity, 111 │
4497 │ │ │ │ (ASCII 'o') for │
4498 │ │ │ │ odd, 110 (ASCII │
4499 │ │ │ │ 'n') for none. │
4500 ├───────────┼────────────┼───────────────┼──────────────────┤
4501 │send-delay │ uint64 │ 0 │ Time to delay │
4502 │ │ │ │ between each │
4503 │ │ │ │ byte sent to the │
4504 │ │ │ │ modem, in │
4505 │ │ │ │ microseconds. │
4506 ├───────────┼────────────┼───────────────┼──────────────────┤
4507 │stopbits │ uint32 │ 1 │ Number of stop │
4508 │ │ │ │ bits for │
4509 │ │ │ │ communication on │
4510 │ │ │ │ the serial port. │
4511 │ │ │ │ Either 1 or 2. │
4512 │ │ │ │ The 1 in "8n1" │
4513 │ │ │ │ for example. │
4514 └───────────┴────────────┴───────────────┴──────────────────┘
4515 sriov setting
4517 SR-IOV settings.
4518 ┌──────────────────┬──────────────────┬───────────────┬──────────────────────────┐
4520 │Key Name │ Value Type │ Default Value │ Value │
4521 │ │ │ │ Description │
4522 ├──────────────────┼──────────────────┼───────────────┼──────────────────────────┤
4523 │autoprobe-drivers │ NMTernary │ │ Whether to │
4524 │ │ (int32) │ │ autoprobe │
4525 │ │ │ │ virtual │
4526 │ │ │ │ functions by a │
4527 │ │ │ │ compatible │
4528 │ │ │ │ driver. │
4529 │ │ │ │ │
4530 │ │ │ │ If set to │
4531 │ │ │ │ NM_TERNARY_TRUE │
4532 │ │ │ │ (1), the kernel │
4533 │ │ │ │ will try to bind │
4534 │ │ │ │ VFs to a │
4535 │ │ │ │ compatible │
4536 │ │ │ │ driver and if │
4537 │ │ │ │ this succeeds a │
4538 │ │ │ │ new network │
4539 │ │ │ │ interface will │
4540 │ │ │ │ be instantiated │
4541 │ │ │ │ for each VF. │
4542 │ │ │ │ │
4543 │ │ │ │ If set to │
4544 │ │ │ │ NM_TERNARY_FALSE │
4545 │ │ │ │ (0), VFs will │
4546 │ │ │ │ not be claimed │
4547 │ │ │ │ and no network │
4548 │ │ │ │ interfaces will │
4549 │ │ │ │ be created for │
4550 │ │ │ │ them. │
4551 │ │ │ │ │
4552 │ │ │ │ When set to │
4553 │ │ │ │ NM_TERNARY_DEFAULT │
4554 │ │ │ │ (-1), the global │
4555 │ │ │ │ default is used; │
4556 │ │ │ │ in case the │
4557 │ │ │ │ global default │
4558 │ │ │ │ is unspecified │
4559 │ │ │ │ it is assumed to │
4560 │ │ │ │ be │
4561 │ │ │ │ NM_TERNARY_TRUE │
4562 │ │ │ │ (1). │
4563 ├──────────────────┼──────────────────┼───────────────┼──────────────────────────┤
4564 │total-vfs │ uint32 │ 0 │ The total number │
4565 │ │ │ │ of virtual │
4566 │ │ │ │ functions to │
4567 │ │ │ │ create. │
4568 │ │ │ │ │
4569 │ │ │ │ Note that when the │
4570 │ │ │ │ sriov setting is │
4571 │ │ │ │ present │
4572 │ │ │ │ NetworkManager │
4573 │ │ │ │ enforces the │
4574 │ │ │ │ number of virtual │
4575 │ │ │ │ functions on the │
4576 │ │ │ │ interface (also │
4577 │ │ │ │ when it is zero) │
4578 │ │ │ │ during activation │
4579 │ │ │ │ and resets it upon │
4580 │ │ │ │ deactivation. To │
4581 │ │ │ │ prevent any │
4582 │ │ │ │ changes to SR-IOV │
4583 │ │ │ │ parameters don't │
4584 │ │ │ │ add a sriov │
4585 │ │ │ │ setting to the │
4586 │ │ │ │ connection. │
4587 ├──────────────────┼──────────────────┼───────────────┼──────────────────────────┤
4588 │vfs │ array of vardict │ │ Array of virtual │
4589 │ │ │ │ function │
4590 │ │ │ │ descriptors. │
4591 │ │ │ │ │
4592 │ │ │ │ Each VF descriptor │
4593 │ │ │ │ is a dictionary │
4594 │ │ │ │ mapping attribute │
4595 │ │ │ │ names to GVariant │
4596 │ │ │ │ values. The │
4597 │ │ │ │ 'index' entry is │
4598 │ │ │ │ mandatory for each │
4599 │ │ │ │ VF. │
4600 │ │ │ │ │
4601 │ │ │ │ When represented │
4602 │ │ │ │ as string a VF is │
4603 │ │ │ │ in the form: │
4604 │ │ │ │ │
4605 │ │ │ │ "INDEX │
4606 │ │ │ │ [ATTR=VALUE[ │
4607 │ │ │ │ ATTR=VALUE]...]". │
4608 │ │ │ │ │
4609 │ │ │ │ for example: │
4610 │ │ │ │ │
4611 │ │ │ │ "2 │
4612 │ │ │ │ mac=00:11:22:33:44:55 │
4613 │ │ │ │ spoof-check=true". │
4614 │ │ │ │ │
4615 │ │ │ │ Multiple VFs can │
4616 │ │ │ │ be specified using │
4617 │ │ │ │ a comma as │
4618 │ │ │ │ separator. │
4619 │ │ │ │ Currently, the │
4620 │ │ │ │ following │
4621 │ │ │ │ attributes are │
4622 │ │ │ │ supported: mac, │
4623 │ │ │ │ spoof-check, │
4624 │ │ │ │ trust, │
4625 │ │ │ │ min-tx-rate, │
4626 │ │ │ │ max-tx-rate, │
4627 │ │ │ │ vlans. │
4628 │ │ │ │ │
4629 │ │ │ │ The "vlans" │
4630 │ │ │ │ attribute is │
4631 │ │ │ │ represented as a │
4632 │ │ │ │ semicolon-separated │
4633 │ │ │ │ list of VLAN │
4634 │ │ │ │ descriptors, where │
4635 │ │ │ │ each descriptor │
4636 │ │ │ │ has the form │
4637 │ │ │ │ │
4638 │ │ │ │ "ID[.PRIORITY[.PROTO]]". │
4639 │ │ │ │ │
4640 │ │ │ │ PROTO can be │
4641 │ │ │ │ either 'q' for │
4642 │ │ │ │ 802.1Q (the │
4643 │ │ │ │ default) or 'ad' │
4644 │ │ │ │ for 802.1ad. │
4645 └──────────────────┴──────────────────┴───────────────┴──────────────────────────┘
4646 tc setting
4648 Linux Traffic Control Settings.
4649 ┌─────────┬──────────────────┬───────────────┬──────────────────────────┐
4651 │Key Name │ Value Type │ Default Value │ Value │
4652 │ │ │ │ Description │
4653 ├─────────┼──────────────────┼───────────────┼──────────────────────────┤
4654 │qdiscs │ array of vardict │ │ Array of TC │
4655 │ │ │ │ queueing │
4656 │ │ │ │ disciplines. │
4657 │ │ │ │ │
4658 │ │ │ │ When the "tc" │
4659 │ │ │ │ setting is │
4660 │ │ │ │ present, qdiscs │
4661 │ │ │ │ from this │
4662 │ │ │ │ property are │
4663 │ │ │ │ applied upon │
4664 │ │ │ │ activation. If │
4665 │ │ │ │ the property is │
4666 │ │ │ │ empty, all │
4667 │ │ │ │ qdiscs are │
4668 │ │ │ │ removed and the │
4669 │ │ │ │ device will only │
4670 │ │ │ │ have the default │
4671 │ │ │ │ qdisc assigned │
4672 │ │ │ │ by kernel │
4673 │ │ │ │ according to the │
4674 │ │ │ │ "net.core.default_qdisc" │
4675 │ │ │ │ sysctl. │
4676 │ │ │ │ │
4677 │ │ │ │ If the "tc" │
4678 │ │ │ │ setting is not │
4679 │ │ │ │ present, │
4680 │ │ │ │ NetworkManager │
4681 │ │ │ │ doesn't touch │
4682 │ │ │ │ the qdiscs │
4683 │ │ │ │ present on the │
4684 │ │ │ │ interface. │
4685 ├─────────┼──────────────────┼───────────────┼──────────────────────────┤
4686 │tfilters │ array of vardict │ │ Array of TC traffic │
4687 │ │ │ │ filters. │
4688 │ │ │ │ │
4689 │ │ │ │ When the "tc" setting is │
4690 │ │ │ │ present, filters from │
4691 │ │ │ │ this property are │
4692 │ │ │ │ applied upon activation. │
4693 │ │ │ │ If the property is │
4694 │ │ │ │ empty, NetworkManager │
4695 │ │ │ │ removes all the filters. │
4696 │ │ │ │ │
4697 │ │ │ │ If the "tc" setting is │
4698 │ │ │ │ not present, │
4699 │ │ │ │ NetworkManager doesn't │
4700 │ │ │ │ touch the filters │
4701 │ │ │ │ present on the │
4702 │ │ │ │ interface. │
4703 └─────────┴──────────────────┴───────────────┴──────────────────────────┘
4704 team setting
4706 Teaming Settings.
4707 ┌────────────────────────────┬──────────────────┬───────────────┬──────────────────────────────┐
4709 │Key Name │ Value Type │ Default Value │ Value │
4710 │ │ │ │ Description │
4711 ├────────────────────────────┼──────────────────┼───────────────┼──────────────────────────────┤
4712 │config │ string │ │ The JSON │
4713 │ │ │ │ configuration │
4714 │ │ │ │ for the team │
4715 │ │ │ │ network │
4716 │ │ │ │ interface. The │
4717 │ │ │ │ property should │
4718 │ │ │ │ contain raw JSON │
4719 │ │ │ │ configuration │
4720 │ │ │ │ data suitable │
4721 │ │ │ │ for teamd, │
4722 │ │ │ │ because the │
4723 │ │ │ │ value is passed │
4724 │ │ │ │ directly to │
4725 │ │ │ │ teamd. If not │
4726 │ │ │ │ specified, the │
4727 │ │ │ │ default │
4728 │ │ │ │ configuration is │
4729 │ │ │ │ used. See man │
4730 │ │ │ │ teamd.conf for │
4731 │ │ │ │ the format │
4732 │ │ │ │ details. │
4733 ├────────────────────────────┼──────────────────┼───────────────┼──────────────────────────────┤
4734 │interface-name │ string │ │ Deprecated in │
4735 │ │ │ │ favor of │
4736 │ │ │ │ connection.interface-name, │
4737 │ │ │ │ but can be used │
4738 │ │ │ │ for │
4739 │ │ │ │ backward-compatibility │
4740 │ │ │ │ with older │
4741 │ │ │ │ daemons, to set │
4742 │ │ │ │ the team's │
4743 │ │ │ │ interface name. │
4744 ├────────────────────────────┼──────────────────┼───────────────┼──────────────────────────────┤
4745 │link-watchers │ array of vardict │ │ Link watchers │
4746 │ │ │ │ configuration for the │
4747 │ │ │ │ connection: each link │
4748 │ │ │ │ watcher is defined by a │
4749 │ │ │ │ dictionary, whose keys │
4750 │ │ │ │ depend upon the selected │
4751 │ │ │ │ link watcher. Available │
4752 │ │ │ │ link watchers are │
4753 │ │ │ │ 'ethtool', 'nsna_ping' and │
4754 │ │ │ │ 'arp_ping' and it is │
4755 │ │ │ │ specified in the │
4756 │ │ │ │ dictionary with the key │
4757 │ │ │ │ 'name'. Available keys │
4758 │ │ │ │ are: ethtool: │
4759 │ │ │ │ 'delay-up', 'delay-down', │
4760 │ │ │ │ 'init-wait'; nsna_ping: │
4761 │ │ │ │ 'init-wait', 'interval', │
4762 │ │ │ │ 'missed-max', │
4763 │ │ │ │ 'target-host'; arp_ping: │
4764 │ │ │ │ all the ones in nsna_ping │
4765 │ │ │ │ and 'source-host', │
4766 │ │ │ │ 'validate-active', │
4767 │ │ │ │ 'validate-inactive', │
4768 │ │ │ │ 'send-always'. See │
4769 │ │ │ │ teamd.conf man for more │
4770 │ │ │ │ details. │
4771 ├────────────────────────────┼──────────────────┼───────────────┼──────────────────────────────┤
4772 │mcast-rejoin-count │ int32 │ -1 │ Corresponds to the teamd │
4773 │ │ │ │ mcast_rejoin.count. │
4774 ├────────────────────────────┼──────────────────┼───────────────┼──────────────────────────────┤
4775 │mcast-rejoin-interval │ int32 │ -1 │ Corresponds to the teamd │
4776 │ │ │ │ mcast_rejoin.interval. │
4777 ├────────────────────────────┼──────────────────┼───────────────┼──────────────────────────────┤
4778 │notify-peers-count │ int32 │ -1 │ Corresponds to the teamd │
4779 │ │ │ │ notify_peers.count. │
4780 ├────────────────────────────┼──────────────────┼───────────────┼──────────────────────────────┤
4781 │notify-peers-interval │ int32 │ -1 │ Corresponds to the teamd │
4782 │ │ │ │ notify_peers.interval. │
4783 ├────────────────────────────┼──────────────────┼───────────────┼──────────────────────────────┤
4784 │runner │ string │ │ Corresponds to the teamd │
4785 │ │ │ │ runner.name. Permitted │
4786 │ │ │ │ values are: "roundrobin", │
4787 │ │ │ │ "broadcast", │
4788 │ │ │ │ "activebackup", │
4789 │ │ │ │ "loadbalance", "lacp", │
4790 │ │ │ │ "random". │
4791 ├────────────────────────────┼──────────────────┼───────────────┼──────────────────────────────┤
4792 │runner-active │ boolean │ TRUE │ Corresponds to the teamd │
4793 │ │ │ │ runner.active. │
4794 ├────────────────────────────┼──────────────────┼───────────────┼──────────────────────────────┤
4795 │runner-agg-select-policy │ string │ │ Corresponds to the teamd │
4796 │ │ │ │ runner.agg_select_policy. │
4797 ├────────────────────────────┼──────────────────┼───────────────┼──────────────────────────────┤
4798 │runner-fast-rate │ boolean │ FALSE │ Corresponds to the teamd │
4799 │ │ │ │ runner.fast_rate. │
4800 ├────────────────────────────┼──────────────────┼───────────────┼──────────────────────────────┤
4801 │runner-hwaddr-policy │ string │ │ Corresponds to the teamd │
4802 │ │ │ │ runner.hwaddr_policy. │
4803 ├────────────────────────────┼──────────────────┼───────────────┼──────────────────────────────┤
4804 │runner-min-ports │ int32 │ -1 │ Corresponds to the teamd │
4805 │ │ │ │ runner.min_ports. │
4806 ├────────────────────────────┼──────────────────┼───────────────┼──────────────────────────────┤
4807 │runner-sys-prio │ int32 │ -1 │ Corresponds to the teamd │
4808 │ │ │ │ runner.sys_prio. │
4809 ├────────────────────────────┼──────────────────┼───────────────┼──────────────────────────────┤
4810 │runner-tx-balancer │ string │ │ Corresponds to the teamd │
4811 │ │ │ │ runner.tx_balancer.name. │
4812 ├────────────────────────────┼──────────────────┼───────────────┼──────────────────────────────┤
4813 │runner-tx-balancer-interval │ int32 │ -1 │ Corresponds to the teamd │
4814 │ │ │ │ runner.tx_balancer.interval. │
4815 ├────────────────────────────┼──────────────────┼───────────────┼──────────────────────────────┤
4816 │runner-tx-hash │ array of string │ │ Corresponds to the teamd │
4817 │ │ │ │ runner.tx_hash. │
4818 └────────────────────────────┴──────────────────┴───────────────┴──────────────────────────────┘
4819 team-port setting
4821 Team Port Settings.
4822 ┌──────────────┬──────────────────┬───────────────┬─────────────────────────────┐
4824 │Key Name │ Value Type │ Default Value │ Value │
4825 │ │ │ │ Description │
4826 ├──────────────┼──────────────────┼───────────────┼─────────────────────────────┤
4827 │config │ string │ │ The JSON │
4828 │ │ │ │ configuration │
4829 │ │ │ │ for the team │
4830 │ │ │ │ port. The │
4831 │ │ │ │ property should │
4832 │ │ │ │ contain raw JSON │
4833 │ │ │ │ configuration │
4834 │ │ │ │ data suitable │
4835 │ │ │ │ for teamd, │
4836 │ │ │ │ because the │
4837 │ │ │ │ value is passed │
4838 │ │ │ │ directly to │
4839 │ │ │ │ teamd. If not │
4840 │ │ │ │ specified, the │
4841 │ │ │ │ default │
4842 │ │ │ │ configuration is │
4843 │ │ │ │ used. See man │
4844 │ │ │ │ teamd.conf for │
4845 │ │ │ │ the format │
4846 │ │ │ │ details. │
4847 ├──────────────┼──────────────────┼───────────────┼─────────────────────────────┤
4848 │lacp-key │ int32 │ -1 │ Corresponds to │
4849 │ │ │ │ the teamd │
4850 │ │ │ │ ports.PORTIFNAME.lacp_key. │
4851 ├──────────────┼──────────────────┼───────────────┼─────────────────────────────┤
4852 │lacp-prio │ int32 │ -1 │ Corresponds to the teamd │
4853 │ │ │ │ ports.PORTIFNAME.lacp_prio. │
4854 ├──────────────┼──────────────────┼───────────────┼─────────────────────────────┤
4855 │link-watchers │ array of vardict │ │ Link watchers configuration │
4856 │ │ │ │ for the connection: each │
4857 │ │ │ │ link watcher is defined by │
4858 │ │ │ │ a dictionary, whose keys │
4859 │ │ │ │ depend upon the selected │
4860 │ │ │ │ link watcher. Available │
4861 │ │ │ │ link watchers are │
4862 │ │ │ │ 'ethtool', 'nsna_ping' and │
4863 │ │ │ │ 'arp_ping' and it is │
4864 │ │ │ │ specified in the dictionary │
4865 │ │ │ │ with the key 'name'. │
4866 │ │ │ │ Available keys are: │
4867 │ │ │ │ ethtool: 'delay-up', │
4868 │ │ │ │ 'delay-down', 'init-wait'; │
4869 │ │ │ │ nsna_ping: 'init-wait', │
4870 │ │ │ │ 'interval', 'missed-max', │
4871 │ │ │ │ 'target-host'; arp_ping: │
4872 │ │ │ │ all the ones in nsna_ping │
4873 │ │ │ │ and 'source-host', │
4874 │ │ │ │ 'validate-active', │
4875 │ │ │ │ 'validate-inactive', │
4876 │ │ │ │ 'send-always'. See │
4877 │ │ │ │ teamd.conf man for more │
4878 │ │ │ │ details. │
4879 ├──────────────┼──────────────────┼───────────────┼─────────────────────────────┤
4880 │prio │ int32 │ 0 │ Corresponds to the teamd │
4881 │ │ │ │ ports.PORTIFNAME.prio. │
4882 ├──────────────┼──────────────────┼───────────────┼─────────────────────────────┤
4883 │queue-id │ int32 │ -1 │ Corresponds to the teamd │
4884 │ │ │ │ ports.PORTIFNAME.queue_id. │
4885 │ │ │ │ When set to -1 means the │
4886 │ │ │ │ parameter is skipped from │
4887 │ │ │ │ the json config. │
4888 ├──────────────┼──────────────────┼───────────────┼─────────────────────────────┤
4889 │sticky │ boolean │ FALSE │ Corresponds to the teamd │
4890 │ │ │ │ ports.PORTIFNAME.sticky. │
4891 └──────────────┴──────────────────┴───────────────┴─────────────────────────────┘
4892 tun setting
4894 Tunnel Settings.
4895 ┌────────────┬────────────┬───────────────┬─────────────────────────┐
4897 │Key Name │ Value Type │ Default Value │ Value │
4898 │ │ │ │ Description │
4899 ├────────────┼────────────┼───────────────┼─────────────────────────┤
4900 │group │ string │ │ The group ID │
4901 │ │ │ │ which will own │
4902 │ │ │ │ the device. If │
4903 │ │ │ │ set to NULL │
4904 │ │ │ │ everyone will be │
4905 │ │ │ │ able to use the │
4906 │ │ │ │ device. │
4907 ├────────────┼────────────┼───────────────┼─────────────────────────┤
4908 │mode │ uint32 │ 1 │ The operating │
4909 │ │ │ │ mode of the │
4910 │ │ │ │ virtual device. │
4911 │ │ │ │ Allowed values │
4912 │ │ │ │ are │
4913 │ │ │ │ NM_SETTING_TUN_MODE_TUN │
4914 │ │ │ │ (1) to create a │
4915 │ │ │ │ layer 3 device │
4916 │ │ │ │ and │
4917 │ │ │ │ NM_SETTING_TUN_MODE_TAP │
4918 │ │ │ │ (2) to create an │
4919 │ │ │ │ Ethernet-like │
4920 │ │ │ │ layer 2 one. │
4921 ├────────────┼────────────┼───────────────┼─────────────────────────┤
4922 │multi-queue │ boolean │ FALSE │ If the property is set │
4923 │ │ │ │ to TRUE, the interface │
4924 │ │ │ │ will support multiple │
4925 │ │ │ │ file descriptors │
4926 │ │ │ │ (queues) to parallelize │
4927 │ │ │ │ packet sending or │
4928 │ │ │ │ receiving. Otherwise, │
4929 │ │ │ │ the interface will only │
4930 │ │ │ │ support a single queue. │
4931 ├────────────┼────────────┼───────────────┼─────────────────────────┤
4932 │owner │ string │ │ The user ID which will │
4933 │ │ │ │ own the device. If set │
4934 │ │ │ │ to NULL everyone will │
4935 │ │ │ │ be able to use the │
4936 │ │ │ │ device. │
4937 ├────────────┼────────────┼───────────────┼─────────────────────────┤
4938 │pi │ boolean │ FALSE │ If TRUE the interface │
4939 │ │ │ │ will prepend a 4 byte │
4940 │ │ │ │ header describing the │
4941 │ │ │ │ physical interface to │
4942 │ │ │ │ the packets. │
4943 ├────────────┼────────────┼───────────────┼─────────────────────────┤
4944 │vnet-hdr │ boolean │ FALSE │ If TRUE the │
4945 │ │ │ │ IFF_VNET_HDR the tunnel │
4946 │ │ │ │ packets will include a │
4947 │ │ │ │ virtio network header. │
4948 └────────────┴────────────┴───────────────┴─────────────────────────┘
4949 user setting
4951 General User Profile Settings.
4952 ┌─────────┬────────────────┬───────────────┬──────────────────┐
4954 │Key Name │ Value Type │ Default Value │ Value │
4955 │ │ │ │ Description │
4956 ├─────────┼────────────────┼───────────────┼──────────────────┤
4957 │data │ dict of string │ {} │ A dictionary of │
4958 │ │ to string │ │ key/value pairs │
4959 │ │ │ │ with user data. │
4960 │ │ │ │ This data is │
4961 │ │ │ │ ignored by │
4962 │ │ │ │ NetworkManager │
4963 │ │ │ │ and can be used │
4964 │ │ │ │ at the users │
4965 │ │ │ │ discretion. The │
4966 │ │ │ │ keys only │
4967 │ │ │ │ support a strict │
4968 │ │ │ │ ascii format, │
4969 │ │ │ │ but the values │
4970 │ │ │ │ can be arbitrary │
4971 │ │ │ │ UTF8 strings up │
4972 │ │ │ │ to a certain │
4973 │ │ │ │ length. │
4974 └─────────┴────────────────┴───────────────┴──────────────────┘
4975 vlan setting
4977 VLAN Settings.
4978 ┌─────────────────────┬─────────────────┬───────────────┬───────────────────────────────┐
4980 │Key Name │ Value Type │ Default Value │ Value │
4981 │ │ │ │ Description │
4982 ├─────────────────────┼─────────────────┼───────────────┼───────────────────────────────┤
4983 │egress-priority-map │ array of string │ │ For outgoing │
4984 │ │ │ │ packets, a list │
4985 │ │ │ │ of mappings from │
4986 │ │ │ │ Linux SKB │
4987 │ │ │ │ priorities to │
4988 │ │ │ │ 802.1p │
4989 │ │ │ │ priorities. The │
4990 │ │ │ │ mapping is given │
4991 │ │ │ │ in the format │
4992 │ │ │ │ "from:to" where │
4993 │ │ │ │ both "from" and │
4994 │ │ │ │ "to" are │
4995 │ │ │ │ unsigned │
4996 │ │ │ │ integers, ie │
4997 │ │ │ │ "7:3". │
4998 ├─────────────────────┼─────────────────┼───────────────┼───────────────────────────────┤
4999 │flags │ NMVlanFlags │ │ One or more │
5000 │ │ (uint32) │ │ flags which │
5001 │ │ │ │ control the │
5002 │ │ │ │ behavior and │
5003 │ │ │ │ features of the │
5004 │ │ │ │ VLAN interface. │
5005 │ │ │ │ Flags include │
5006 │ │ │ │ NM_VLAN_FLAG_REORDER_HEADERS │
5007 │ │ │ │ (0x1) │
5008 │ │ │ │ (reordering of │
5009 │ │ │ │ output packet │
5010 │ │ │ │ headers), │
5011 │ │ │ │ NM_VLAN_FLAG_GVRP │
5012 │ │ │ │ (0x2) (use of │
5013 │ │ │ │ the GVRP │
5014 │ │ │ │ protocol), and │
5015 │ │ │ │ NM_VLAN_FLAG_LOOSE_BINDING │
5016 │ │ │ │ (0x4) (loose │
5017 │ │ │ │ binding of the │
5018 │ │ │ │ interface to its │
5019 │ │ │ │ master device's │
5020 │ │ │ │ operating │
5021 │ │ │ │ state). │
5022 │ │ │ │ NM_VLAN_FLAG_MVRP │
5023 │ │ │ │ (0x8) (use of │
5024 │ │ │ │ the MVRP │
5025 │ │ │ │ protocol). │
5026 │ │ │ │ │
5027 │ │ │ │ The default │
5028 │ │ │ │ value of this │
5029 │ │ │ │ property is │
5030 │ │ │ │ NM_VLAN_FLAG_REORDER_HEADERS, │
5031 │ │ │ │ but it used to │
5032 │ │ │ │ be 0. To │
5033 │ │ │ │ preserve │
5034 │ │ │ │ backward │
5035 │ │ │ │ compatibility, │
5036 │ │ │ │ the │
5037 │ │ │ │ default-value in │
5038 │ │ │ │ the D-Bus API │
5039 │ │ │ │ continues to be │
5040 │ │ │ │ 0 and a missing │
5041 │ │ │ │ property on │
5042 │ │ │ │ D-Bus is still │
5043 │ │ │ │ considered as 0. │
5044 ├─────────────────────┼─────────────────┼───────────────┼───────────────────────────────┤
5045 │id │ uint32 │ 0 │ The VLAN identifier that the │
5046 │ │ │ │ interface created by this │
5047 │ │ │ │ connection should be │
5048 │ │ │ │ assigned. The valid range is │
5049 │ │ │ │ from 0 to 4094, without the │
5050 │ │ │ │ reserved id 4095. │
5051 ├─────────────────────┼─────────────────┼───────────────┼───────────────────────────────┤
5052 │ingress-priority-map │ array of string │ │ For incoming packets, a list │
5053 │ │ │ │ of mappings from 802.1p │
5054 │ │ │ │ priorities to Linux SKB │
5055 │ │ │ │ priorities. The mapping is │
5056 │ │ │ │ given in the format "from:to" │
5057 │ │ │ │ where both "from" and "to" │
5058 │ │ │ │ are unsigned integers, ie │
5059 │ │ │ │ "7:3". │
5060 ├─────────────────────┼─────────────────┼───────────────┼───────────────────────────────┤
5061 │interface-name │ string │ │ Deprecated in favor of │
5062 │ │ │ │ connection.interface-name, │
5063 │ │ │ │ but can be used for │
5064 │ │ │ │ backward-compatibility with │
5065 │ │ │ │ older daemons, to set the │
5066 │ │ │ │ vlan's interface name. │
5067 ├─────────────────────┼─────────────────┼───────────────┼───────────────────────────────┤
5068 │parent │ string │ │ If given, specifies the │
5069 │ │ │ │ parent interface name or │
5070 │ │ │ │ parent connection UUID from │
5071 │ │ │ │ which this VLAN interface │
5072 │ │ │ │ should be created. If this │
5073 │ │ │ │ property is not specified, │
5074 │ │ │ │ the connection must contain │
5075 │ │ │ │ an "802-3-ethernet" setting │
5076 │ │ │ │ with a "mac-address" │
5077 │ │ │ │ property. │
5078 ├─────────────────────┼─────────────────┼───────────────┼───────────────────────────────┤
5079 │protocol │ string │ │ Specifies the VLAN protocol │
5080 │ │ │ │ to use for encapsulation. │
5081 │ │ │ │ │
5082 │ │ │ │ Supported values are: │
5083 │ │ │ │ '802.1Q', '802.1ad'. If not │
5084 │ │ │ │ specified the default value │
5085 │ │ │ │ is '802.1Q'. │
5086 └─────────────────────┴─────────────────┴───────────────┴───────────────────────────────┘
5087 vpn setting
5089 VPN Settings.
5090 ┌─────────────┬────────────────┬───────────────┬─────────────────────────────────────┐
5092 │Key Name │ Value Type │ Default Value │ Value │
5093 │ │ │ │ Description │
5094 ├─────────────┼────────────────┼───────────────┼─────────────────────────────────────┤
5095 │data │ dict of string │ {} │ Dictionary of │
5096 │ │ to string │ │ key/value pairs │
5097 │ │ │ │ of VPN plugin │
5098 │ │ │ │ specific data. │
5099 │ │ │ │ Both keys and │
5100 │ │ │ │ values must be │
5101 │ │ │ │ strings. │
5102 ├─────────────┼────────────────┼───────────────┼─────────────────────────────────────┤
5103 │persistent │ boolean │ FALSE │ If the VPN │
5104 │ │ │ │ service supports │
5105 │ │ │ │ persistence, and │
5106 │ │ │ │ this property is │
5107 │ │ │ │ TRUE, the VPN │
5108 │ │ │ │ will attempt to │
5109 │ │ │ │ stay connected │
5110 │ │ │ │ across link │
5111 │ │ │ │ changes and │
5112 │ │ │ │ outages, until │
5113 │ │ │ │ explicitly │
5114 │ │ │ │ disconnected. │
5115 ├─────────────┼────────────────┼───────────────┼─────────────────────────────────────┤
5116 │secrets │ dict of string │ {} │ Dictionary of │
5117 │ │ to string │ │ key/value pairs │
5118 │ │ │ │ of VPN plugin │
5119 │ │ │ │ specific secrets │
5120 │ │ │ │ like passwords │
5121 │ │ │ │ or private keys. │
5122 │ │ │ │ Both keys and │
5123 │ │ │ │ values must be │
5124 │ │ │ │ strings. │
5125 ├─────────────┼────────────────┼───────────────┼─────────────────────────────────────┤
5126 │service-type │ string │ │ D-Bus service │
5127 │ │ │ │ name of the VPN │
5128 │ │ │ │ plugin that this │
5129 │ │ │ │ setting uses to │
5130 │ │ │ │ connect to its │
5131 │ │ │ │ network. i.e. │
5132 │ │ │ │ org.freedesktop.NetworkManager.vpnc │
5133 │ │ │ │ for the vpnc │
5134 │ │ │ │ plugin. │
5135 ├─────────────┼────────────────┼───────────────┼─────────────────────────────────────┤
5136 │timeout │ uint32 │ 0 │ Timeout for the VPN service to │
5137 │ │ │ │ establish the connection. Some │
5138 │ │ │ │ services may take quite a long time │
5139 │ │ │ │ to connect. Value of 0 means a │
5140 │ │ │ │ default timeout, which is 60 │
5141 │ │ │ │ seconds (unless overridden by │
5142 │ │ │ │ vpn.timeout in configuration file). │
5143 │ │ │ │ Values greater than zero mean │
5144 │ │ │ │ timeout in seconds. │
5145 ├─────────────┼────────────────┼───────────────┼─────────────────────────────────────┤
5146 │user-name │ string │ │ If the VPN connection requires a │
5147 │ │ │ │ user name for authentication, that │
5148 │ │ │ │ name should be provided here. If │
5149 │ │ │ │ the connection is available to more │
5150 │ │ │ │ than one user, and the VPN requires │
5151 │ │ │ │ each user to supply a different │
5152 │ │ │ │ name, then leave this property │
5153 │ │ │ │ empty. If this property is empty, │
5154 │ │ │ │ NetworkManager will automatically │
5155 │ │ │ │ supply the username of the user │
5156 │ │ │ │ which requested the VPN connection. │
5157 └─────────────┴────────────────┴───────────────┴─────────────────────────────────────┘
5158 vrf setting
5160 VRF settings.
5161 ┌─────────┬────────────┬───────────────┬────────────────┐
5163 │Key Name │ Value Type │ Default Value │ Value │
5164 │ │ │ │ Description │
5165 ├─────────┼────────────┼───────────────┼────────────────┤
5166 │table │ uint32 │ 0 │ The routing │
5167 │ │ │ │ table for this │
5168 │ │ │ │ VRF. │
5169 └─────────┴────────────┴───────────────┴────────────────┘
5170 vxlan setting
5172 VXLAN Settings.
5173 ┌─────────────────┬────────────┬───────────────┬──────────────────┐
5175 │Key Name │ Value Type │ Default Value │ Value │
5176 │ │ │ │ Description │
5177 ├─────────────────┼────────────┼───────────────┼──────────────────┤
5178 │ageing │ uint32 │ 300 │ Specifies the │
5179 │ │ │ │ lifetime in │
5180 │ │ │ │ seconds of FDB │
5181 │ │ │ │ entries learnt │
5182 │ │ │ │ by the kernel. │
5183 ├─────────────────┼────────────┼───────────────┼──────────────────┤
5184 │destination-port │ uint32 │ 8472 │ Specifies the │
5185 │ │ │ │ UDP destination │
5186 │ │ │ │ port to │
5187 │ │ │ │ communicate to │
5188 │ │ │ │ the remote VXLAN │
5189 │ │ │ │ tunnel endpoint. │
5190 ├─────────────────┼────────────┼───────────────┼──────────────────┤
5191 │id │ uint32 │ 0 │ Specifies the │
5192 │ │ │ │ VXLAN Network │
5193 │ │ │ │ Identifier (or │
5194 │ │ │ │ VXLAN Segment │
5195 │ │ │ │ Identifier) to │
5196 │ │ │ │ use. │
5197 ├─────────────────┼────────────┼───────────────┼──────────────────┤
5198 │l2-miss │ boolean │ FALSE │ Specifies │
5199 │ │ │ │ whether netlink │
5200 │ │ │ │ LL ADDR miss │
5201 │ │ │ │ notifications │
5202 │ │ │ │ are generated. │
5203 ├─────────────────┼────────────┼───────────────┼──────────────────┤
5204 │l3-miss │ boolean │ FALSE │ Specifies │
5205 │ │ │ │ whether netlink │
5206 │ │ │ │ IP ADDR miss │
5207 │ │ │ │ notifications │
5208 │ │ │ │ are generated. │
5209 ├─────────────────┼────────────┼───────────────┼──────────────────┤
5210 │learning │ boolean │ TRUE │ Specifies │
5211 │ │ │ │ whether unknown │
5212 │ │ │ │ source link │
5213 │ │ │ │ layer addresses │
5214 │ │ │ │ and IP addresses │
5215 │ │ │ │ are entered into │
5216 │ │ │ │ the VXLAN device │
5217 │ │ │ │ forwarding │
5218 │ │ │ │ database. │
5219 ├─────────────────┼────────────┼───────────────┼──────────────────┤
5220 │limit │ uint32 │ 0 │ Specifies the │
5221 │ │ │ │ maximum number │
5222 │ │ │ │ of FDB entries. │
5223 │ │ │ │ A value of zero │
5224 │ │ │ │ means that the │
5225 │ │ │ │ kernel will │
5226 │ │ │ │ store unlimited │
5227 │ │ │ │ entries. │
5228 ├─────────────────┼────────────┼───────────────┼──────────────────┤
5229 │local │ string │ │ If given, │
5230 │ │ │ │ specifies the │
5231 │ │ │ │ source IP │
5232 │ │ │ │ address to use │
5233 │ │ │ │ in outgoing │
5234 │ │ │ │ packets. │
5235 ├─────────────────┼────────────┼───────────────┼──────────────────┤
5236 │parent │ string │ │ If given, │
5237 │ │ │ │ specifies the │
5238 │ │ │ │ parent interface │
5239 │ │ │ │ name or parent │
5240 │ │ │ │ connection UUID. │
5241 ├─────────────────┼────────────┼───────────────┼──────────────────┤
5242 │proxy │ boolean │ FALSE │ Specifies │
5243 │ │ │ │ whether ARP │
5244 │ │ │ │ proxy is turned │
5245 │ │ │ │ on. │
5246 ├─────────────────┼────────────┼───────────────┼──────────────────┤
5247 │remote │ string │ │ Specifies the │
5248 │ │ │ │ unicast │
5249 │ │ │ │ destination IP │
5250 │ │ │ │ address to use │
5251 │ │ │ │ in outgoing │
5252 │ │ │ │ packets when the │
5253 │ │ │ │ destination link │
5254 │ │ │ │ layer address is │
5255 │ │ │ │ not known in the │
5256 │ │ │ │ VXLAN device │
5257 │ │ │ │ forwarding │
5258 │ │ │ │ database, or the │
5259 │ │ │ │ multicast IP │
5260 │ │ │ │ address to join. │
5261 ├─────────────────┼────────────┼───────────────┼──────────────────┤
5262 │rsc │ boolean │ FALSE │ Specifies │
5263 │ │ │ │ whether route │
5264 │ │ │ │ short circuit is │
5265 │ │ │ │ turned on. │
5266 ├─────────────────┼────────────┼───────────────┼──────────────────┤
5267 │source-port-max │ uint32 │ 0 │ Specifies the │
5268 │ │ │ │ maximum UDP │
5269 │ │ │ │ source port to │
5270 │ │ │ │ communicate to │
5271 │ │ │ │ the remote VXLAN │
5272 │ │ │ │ tunnel endpoint. │
5273 ├─────────────────┼────────────┼───────────────┼──────────────────┤
5274 │source-port-min │ uint32 │ 0 │ Specifies the │
5275 │ │ │ │ minimum UDP │
5276 │ │ │ │ source port to │
5277 │ │ │ │ communicate to │
5278 │ │ │ │ the remote VXLAN │
5279 │ │ │ │ tunnel endpoint. │
5280 ├─────────────────┼────────────┼───────────────┼──────────────────┤
5281 │tos │ uint32 │ 0 │ Specifies the │
5282 │ │ │ │ TOS value to use │
5283 │ │ │ │ in outgoing │
5284 │ │ │ │ packets. │
5285 ├─────────────────┼────────────┼───────────────┼──────────────────┤
5286 │ttl │ uint32 │ 0 │ Specifies the │
5287 │ │ │ │ time-to-live │
5288 │ │ │ │ value to use in │
5289 │ │ │ │ outgoing │
5290 │ │ │ │ packets. │
5291 └─────────────────┴────────────┴───────────────┴──────────────────┘
5292 wifi-p2p setting
5294 Wi-Fi P2P Settings.
5295 ┌───────────┬────────────┬───────────────┬──────────────────┐
5297 │Key Name │ Value Type │ Default Value │ Value │
5298 │ │ │ │ Description │
5299 ├───────────┼────────────┼───────────────┼──────────────────┤
5300 │peer │ string │ │ The P2P device │
5301 │ │ │ │ that should be │
5302 │ │ │ │ connected to. │
5303 │ │ │ │ Currently, this │
5304 │ │ │ │ is the only way │
5305 │ │ │ │ to create or │
5306 │ │ │ │ join a group. │
5307 ├───────────┼────────────┼───────────────┼──────────────────┤
5308 │wfd-ies │ byte array │ │ The Wi-Fi │
5309 │ │ │ │ Display (WFD) │
5310 │ │ │ │ Information │
5311 │ │ │ │ Elements (IEs) │
5312 │ │ │ │ to set. │
5313 │ │ │ │ │
5314 │ │ │ │ Wi-Fi Display │
5315 │ │ │ │ requires a │
5316 │ │ │ │ protocol │
5317 │ │ │ │ specific │
5318 │ │ │ │ information │
5319 │ │ │ │ element to be │
5320 │ │ │ │ set in certain │
5321 │ │ │ │ Wi-Fi frames. │
5322 │ │ │ │ These can be │
5323 │ │ │ │ specified here │
5324 │ │ │ │ for the purpose │
5325 │ │ │ │ of establishing │
5326 │ │ │ │ a connection. │
5327 │ │ │ │ This setting is │
5328 │ │ │ │ only useful when │
5329 │ │ │ │ implementing a │
5330 │ │ │ │ Wi-Fi Display │
5331 │ │ │ │ client. │
5332 ├───────────┼────────────┼───────────────┼──────────────────┤
5333 │wps-method │ uint32 │ 0 │ Flags indicating │
5334 │ │ │ │ which mode of │
5335 │ │ │ │ WPS is to be │
5336 │ │ │ │ used. │
5337 │ │ │ │ │
5338 │ │ │ │ There's little │
5339 │ │ │ │ point in │
5340 │ │ │ │ changing the │
5341 │ │ │ │ default setting │
5342 │ │ │ │ as │
5343 │ │ │ │ NetworkManager │
5344 │ │ │ │ will │
5345 │ │ │ │ automatically │
5346 │ │ │ │ determine the │
5347 │ │ │ │ best method to │
5348 │ │ │ │ use. │
5349 └───────────┴────────────┴───────────────┴──────────────────┘
5350 wimax setting
5352 WiMax Settings.
5353 ┌─────────────┬────────────┬───────────────┬──────────────────┐
5355 │Key Name │ Value Type │ Default Value │ Value │
5356 │ │ │ │ Description │
5357 ├─────────────┼────────────┼───────────────┼──────────────────┤
5358 │mac-address │ byte array │ │ If specified, │
5359 │ │ │ │ this connection │
5360 │ │ │ │ will only apply │
5361 │ │ │ │ to the WiMAX │
5362 │ │ │ │ device whose MAC │
5363 │ │ │ │ address matches. │
5364 │ │ │ │ This property │
5365 │ │ │ │ does not change │
5366 │ │ │ │ the MAC address │
5367 │ │ │ │ of the device │
5368 │ │ │ │ (known as MAC │
5369 │ │ │ │ spoofing). │
5370 │ │ │ │ │
5371 │ │ │ │ This property is │
5372 │ │ │ │ deprecated since │
5373 │ │ │ │ version │
5374 │ │ │ │ 1.2.WiMAX is no │
5375 │ │ │ │ longer │
5376 │ │ │ │ supported. │
5377 ├─────────────┼────────────┼───────────────┼──────────────────┤
5378 │network-name │ string │ │ Network Service │
5379 │ │ │ │ Provider (NSP) │
5380 │ │ │ │ name of the │
5381 │ │ │ │ WiMAX network │
5382 │ │ │ │ this connection │
5383 │ │ │ │ should use. │
5384 │ │ │ │ │
5385 │ │ │ │ This property is │
5386 │ │ │ │ deprecated since │
5387 │ │ │ │ version │
5388 │ │ │ │ 1.2.WiMAX is no │
5389 │ │ │ │ longer │
5390 │ │ │ │ supported. │
5391 └─────────────┴────────────┴───────────────┴──────────────────┘
5392 802-3-ethernet setting
5394 Wired Ethernet Settings.
5395 ┌──────────────────────────┬─────────────────┬───────────────┬────────────────────────────────────────┐
5397 │Key Name │ Value Type │ Default Value │ Value │
5398 │ │ │ │ Description │
5399 ├──────────────────────────┼─────────────────┼───────────────┼────────────────────────────────────────┤
5400 │accept-all-mac-addresses │ NMTernary │ │ When TRUE, setup │
5401 │ │ (int32) │ │ the interface to │
5402 │ │ │ │ accept packets │
5403 │ │ │ │ for all MAC │
5404 │ │ │ │ addresses. This │
5405 │ │ │ │ is enabling the │
5406 │ │ │ │ kernel interface │
5407 │ │ │ │ flag │
5408 │ │ │ │ IFF_PROMISC. │
5409 │ │ │ │ When FALSE, the │
5410 │ │ │ │ interface will │
5411 │ │ │ │ only accept the │
5412 │ │ │ │ packets with the │
5413 │ │ │ │ interface │
5414 │ │ │ │ destination mac │
5415 │ │ │ │ address or │
5416 │ │ │ │ broadcast. │
5417 ├──────────────────────────┼─────────────────┼───────────────┼────────────────────────────────────────┤
5418 │assigned-mac-address │ string │ │ The new field │
5419 │ │ │ │ for the cloned │
5420 │ │ │ │ MAC address. It │
5421 │ │ │ │ can be either a │
5422 │ │ │ │ hardware address │
5423 │ │ │ │ in ASCII │
5424 │ │ │ │ representation, │
5425 │ │ │ │ or one of the │
5426 │ │ │ │ special values │
5427 │ │ │ │ "preserve", │
5428 │ │ │ │ "permanent", │
5429 │ │ │ │ "random" or │
5430 │ │ │ │ "stable". This │
5431 │ │ │ │ field replaces │
5432 │ │ │ │ the deprecated │
5433 │ │ │ │ "cloned-mac-address" │
5434 │ │ │ │ on D-Bus, which │
5435 │ │ │ │ can only contain │
5436 │ │ │ │ explicit │
5437 │ │ │ │ hardware │
5438 │ │ │ │ addresses. Note │
5439 │ │ │ │ that this │
5440 │ │ │ │ property only │
5441 │ │ │ │ exists in D-Bus │
5442 │ │ │ │ API. libnm and │
5443 │ │ │ │ nmcli continue │
5444 │ │ │ │ to call this │
5445 │ │ │ │ property │
5446 │ │ │ │ "cloned-mac-address". │
5447 ├──────────────────────────┼─────────────────┼───────────────┼────────────────────────────────────────┤
5448 │auto-negotiate │ boolean │ FALSE │ When TRUE, enforce │
5449 │ │ │ │ auto-negotiation of │
5450 │ │ │ │ speed and duplex │
5451 │ │ │ │ mode. If "speed" and │
5452 │ │ │ │ "duplex" properties │
5453 │ │ │ │ are both specified, │
5454 │ │ │ │ only that single mode │
5455 │ │ │ │ will be advertised │
5456 │ │ │ │ and accepted during │
5457 │ │ │ │ the link │
5458 │ │ │ │ auto-negotiation │
5459 │ │ │ │ process: this works │
5460 │ │ │ │ only for BASE-T 802.3 │
5461 │ │ │ │ specifications and is │
5462 │ │ │ │ useful for enforcing │
5463 │ │ │ │ gigabits modes, as in │
5464 │ │ │ │ these cases link │
5465 │ │ │ │ negotiation is │
5466 │ │ │ │ mandatory. When │
5467 │ │ │ │ FALSE, "speed" and │
5468 │ │ │ │ "duplex" properties │
5469 │ │ │ │ should be both set or │
5470 │ │ │ │ link configuration │
5471 │ │ │ │ will be skipped. │
5472 ├──────────────────────────┼─────────────────┼───────────────┼────────────────────────────────────────┤
5473 │cloned-mac-address │ byte array │ │ This D-Bus field is │
5474 │ │ │ │ deprecated in favor │
5475 │ │ │ │ of │
5476 │ │ │ │ "assigned-mac-address" │
5477 │ │ │ │ which is more │
5478 │ │ │ │ flexible and allows │
5479 │ │ │ │ specifying special │
5480 │ │ │ │ variants like │
5481 │ │ │ │ "random". For libnm │
5482 │ │ │ │ and nmcli, this field │
5483 │ │ │ │ is called │
5484 │ │ │ │ "cloned-mac-address". │
5485 ├──────────────────────────┼─────────────────┼───────────────┼────────────────────────────────────────┤
5486 │duplex │ string │ │ When a value is set, │
5487 │ │ │ │ either "half" or │
5488 │ │ │ │ "full", configures the │
5489 │ │ │ │ device to use the │
5490 │ │ │ │ specified duplex mode. │
5491 │ │ │ │ If "auto-negotiate" is │
5492 │ │ │ │ "yes" the specified │
5493 │ │ │ │ duplex mode will be │
5494 │ │ │ │ the only one │
5495 │ │ │ │ advertised during link │
5496 │ │ │ │ negotiation: this │
5497 │ │ │ │ works only for BASE-T │
5498 │ │ │ │ 802.3 specifications │
5499 │ │ │ │ and is useful for │
5500 │ │ │ │ enforcing gigabits │
5501 │ │ │ │ modes, as in these │
5502 │ │ │ │ cases link negotiation │
5503 │ │ │ │ is mandatory. If the │
5504 │ │ │ │ value is unset (the │
5505 │ │ │ │ default), the link │
5506 │ │ │ │ configuration will be │
5507 │ │ │ │ either skipped (if │
5508 │ │ │ │ "auto-negotiate" is │
5509 │ │ │ │ "no", the default) or │
5510 │ │ │ │ will be │
5511 │ │ │ │ auto-negotiated (if │
5512 │ │ │ │ "auto-negotiate" is │
5513 │ │ │ │ "yes") and the local │
5514 │ │ │ │ device will advertise │
5515 │ │ │ │ all the supported │
5516 │ │ │ │ duplex modes. Must be │
5517 │ │ │ │ set together with the │
5518 │ │ │ │ "speed" property if │
5519 │ │ │ │ specified. Before │
5520 │ │ │ │ specifying a duplex │
5521 │ │ │ │ mode be sure your │
5522 │ │ │ │ device supports it. │
5523 ├──────────────────────────┼─────────────────┼───────────────┼────────────────────────────────────────┤
5524 │generate-mac-address-mask │ string │ │ With │
5525 │ │ │ │ "cloned-mac-address" │
5526 │ │ │ │ setting "random" or │
5527 │ │ │ │ "stable", by default │
5528 │ │ │ │ all bits of the MAC │
5529 │ │ │ │ address are scrambled │
5530 │ │ │ │ and a │
5531 │ │ │ │ locally-administered, │
5532 │ │ │ │ unicast MAC address is │
5533 │ │ │ │ created. This property │
5534 │ │ │ │ allows to specify that │
5535 │ │ │ │ certain bits are │
5536 │ │ │ │ fixed. Note that the │
5537 │ │ │ │ least significant bit │
5538 │ │ │ │ of the first MAC │
5539 │ │ │ │ address will always be │
5540 │ │ │ │ unset to create a │
5541 │ │ │ │ unicast MAC address. │
5542 │ │ │ │ │
5543 │ │ │ │ If the property is │
5544 │ │ │ │ NULL, it is eligible │
5545 │ │ │ │ to be overwritten by a │
5546 │ │ │ │ default connection │
5547 │ │ │ │ setting. If the value │
5548 │ │ │ │ is still NULL or an │
5549 │ │ │ │ empty string, the │
5550 │ │ │ │ default is to create a │
5551 │ │ │ │ locally-administered, │
5552 │ │ │ │ unicast MAC address. │
5553 │ │ │ │ │
5554 │ │ │ │ If the value contains │
5555 │ │ │ │ one MAC address, this │
5556 │ │ │ │ address is used as │
5557 │ │ │ │ mask. The set bits of │
5558 │ │ │ │ the mask are to be │
5559 │ │ │ │ filled with the │
5560 │ │ │ │ current MAC address of │
5561 │ │ │ │ the device, while the │
5562 │ │ │ │ unset bits are subject │
5563 │ │ │ │ to randomization. │
5564 │ │ │ │ Setting │
5565 │ │ │ │ "FE:FF:FF:00:00:00" │
5566 │ │ │ │ means to preserve the │
5567 │ │ │ │ OUI of the current MAC │
5568 │ │ │ │ address and only │
5569 │ │ │ │ randomize the lower 3 │
5570 │ │ │ │ bytes using the │
5571 │ │ │ │ "random" or "stable" │
5572 │ │ │ │ algorithm. │
5573 │ │ │ │ │
5574 │ │ │ │ If the value contains │
5575 │ │ │ │ one additional MAC │
5576 │ │ │ │ address after the │
5577 │ │ │ │ mask, this address is │
5578 │ │ │ │ used instead of the │
5579 │ │ │ │ current MAC address to │
5580 │ │ │ │ fill the bits that │
5581 │ │ │ │ shall not be │
5582 │ │ │ │ randomized. For │
5583 │ │ │ │ example, a value of │
5584 │ │ │ │ "FE:FF:FF:00:00:00 │
5585 │ │ │ │ 68:F7:28:00:00:00" │
5586 │ │ │ │ will set the OUI of │
5587 │ │ │ │ the MAC address to │
5588 │ │ │ │ 68:F7:28, while the │
5589 │ │ │ │ lower bits are │
5590 │ │ │ │ randomized. A value of │
5591 │ │ │ │ "02:00:00:00:00:00 │
5592 │ │ │ │ 00:00:00:00:00:00" │
5593 │ │ │ │ will create a fully │
5594 │ │ │ │ scrambled │
5595 │ │ │ │ globally-administered, │
5596 │ │ │ │ burned-in MAC address. │
5597 │ │ │ │ │
5598 │ │ │ │ If the value contains │
5599 │ │ │ │ more than one │
5600 │ │ │ │ additional MAC │
5601 │ │ │ │ addresses, one of them │
5602 │ │ │ │ is chosen randomly. │
5603 │ │ │ │ For example, │
5604 │ │ │ │ "02:00:00:00:00:00 │
5605 │ │ │ │ 00:00:00:00:00:00 │
5606 │ │ │ │ 02:00:00:00:00:00" │
5607 │ │ │ │ will create a fully │
5608 │ │ │ │ scrambled MAC address, │
5609 │ │ │ │ randomly locally or │
5610 │ │ │ │ globally administered. │
5611 ├──────────────────────────┼─────────────────┼───────────────┼────────────────────────────────────────┤
5612 │mac-address │ byte array │ │ If specified, this │
5613 │ │ │ │ connection will only │
5614 │ │ │ │ apply to the Ethernet │
5615 │ │ │ │ device whose permanent │
5616 │ │ │ │ MAC address matches. │
5617 │ │ │ │ This property does not │
5618 │ │ │ │ change the MAC address │
5619 │ │ │ │ of the device (i.e. │
5620 │ │ │ │ MAC spoofing). │
5621 ├──────────────────────────┼─────────────────┼───────────────┼────────────────────────────────────────┤
5622 │mac-address-blacklist │ array of string │ │ If specified, this │
5623 │ │ │ │ connection will never │
5624 │ │ │ │ apply to the Ethernet │
5625 │ │ │ │ device whose permanent │
5626 │ │ │ │ MAC address matches an │
5627 │ │ │ │ address in the list. │
5628 │ │ │ │ Each MAC address is in │
5629 │ │ │ │ the standard │
5630 │ │ │ │ hex-digits-and-colons │
5631 │ │ │ │ notation │
5632 │ │ │ │ (00:11:22:33:44:55). │
5633 ├──────────────────────────┼─────────────────┼───────────────┼────────────────────────────────────────┤
5634 │mtu │ uint32 │ 0 │ If non-zero, only │
5635 │ │ │ │ transmit packets of │
5636 │ │ │ │ the specified size or │
5637 │ │ │ │ smaller, breaking │
5638 │ │ │ │ larger packets up into │
5639 │ │ │ │ multiple Ethernet │
5640 │ │ │ │ frames. │
5641 ├──────────────────────────┼─────────────────┼───────────────┼────────────────────────────────────────┤
5642 │port │ string │ │ Specific port type to │
5643 │ │ │ │ use if the device │
5644 │ │ │ │ supports multiple │
5645 │ │ │ │ attachment methods. │
5646 │ │ │ │ One of "tp" (Twisted │
5647 │ │ │ │ Pair), "aui" │
5648 │ │ │ │ (Attachment Unit │
5649 │ │ │ │ Interface), "bnc" │
5650 │ │ │ │ (Thin Ethernet) or │
5651 │ │ │ │ "mii" (Media │
5652 │ │ │ │ Independent │
5653 │ │ │ │ Interface). If the │
5654 │ │ │ │ device supports only │
5655 │ │ │ │ one port type, this │
5656 │ │ │ │ setting is ignored. │
5657 ├──────────────────────────┼─────────────────┼───────────────┼────────────────────────────────────────┤
5658 │s390-nettype │ string │ │ s390 network device │
5659 │ │ │ │ type; one of "qeth", │
5660 │ │ │ │ "lcs", or "ctc", │
5661 │ │ │ │ representing the │
5662 │ │ │ │ different types of │
5663 │ │ │ │ virtual network │
5664 │ │ │ │ devices available on │
5665 │ │ │ │ s390 systems. │
5666 ├──────────────────────────┼─────────────────┼───────────────┼────────────────────────────────────────┤
5667 │s390-options │ dict of string │ {} │ Dictionary of │
5668 │ │ to string │ │ key/value pairs of │
5669 │ │ │ │ s390-specific device │
5670 │ │ │ │ options. Both keys │
5671 │ │ │ │ and values must be │
5672 │ │ │ │ strings. Allowed keys │
5673 │ │ │ │ include "portno", │
5674 │ │ │ │ "layer2", "portname", │
5675 │ │ │ │ "protocol", among │
5676 │ │ │ │ others. Key names │
5677 │ │ │ │ must contain only │
5678 │ │ │ │ alphanumeric │
5679 │ │ │ │ characters (ie, │
5680 │ │ │ │ [a-zA-Z0-9]). │
5681 │ │ │ │ │
5682 │ │ │ │ Currently, │
5683 │ │ │ │ NetworkManager itself │
5684 │ │ │ │ does nothing with this │
5685 │ │ │ │ information. However, │
5686 │ │ │ │ s390utils ships a udev │
5687 │ │ │ │ rule which parses this │
5688 │ │ │ │ information and │
5689 │ │ │ │ applies it to the │
5690 │ │ │ │ interface. │
5691 ├──────────────────────────┼─────────────────┼───────────────┼────────────────────────────────────────┤
5692 │s390-subchannels │ array of string │ │ Identifies specific │
5693 │ │ │ │ subchannels that this │
5694 │ │ │ │ network device uses │
5695 │ │ │ │ for communication with │
5696 │ │ │ │ z/VM or s390 host. │
5697 │ │ │ │ Like the "mac-address" │
5698 │ │ │ │ property for non-z/VM │
5699 │ │ │ │ devices, this property │
5700 │ │ │ │ can be used to ensure │
5701 │ │ │ │ this connection only │
5702 │ │ │ │ applies to the network │
5703 │ │ │ │ device that uses these │
5704 │ │ │ │ subchannels. The list │
5705 │ │ │ │ should contain exactly │
5706 │ │ │ │ 3 strings, and each │
5707 │ │ │ │ string may only be │
5708 │ │ │ │ composed of │
5709 │ │ │ │ hexadecimal characters │
5710 │ │ │ │ and the period (.) │
5711 │ │ │ │ character. │
5712 ├──────────────────────────┼─────────────────┼───────────────┼────────────────────────────────────────┤
5713 │speed │ uint32 │ 0 │ When a value greater │
5714 │ │ │ │ than 0 is set, │
5715 │ │ │ │ configures the device │
5716 │ │ │ │ to use the specified │
5717 │ │ │ │ speed. If │
5718 │ │ │ │ "auto-negotiate" is │
5719 │ │ │ │ "yes" the specified │
5720 │ │ │ │ speed will be the only │
5721 │ │ │ │ one advertised during │
5722 │ │ │ │ link negotiation: this │
5723 │ │ │ │ works only for BASE-T │
5724 │ │ │ │ 802.3 specifications │
5725 │ │ │ │ and is useful for │
5726 │ │ │ │ enforcing gigabit │
5727 │ │ │ │ speeds, as in this │
5728 │ │ │ │ case link negotiation │
5729 │ │ │ │ is mandatory. If the │
5730 │ │ │ │ value is unset (0, the │
5731 │ │ │ │ default), the link │
5732 │ │ │ │ configuration will be │
5733 │ │ │ │ either skipped (if │
5734 │ │ │ │ "auto-negotiate" is │
5735 │ │ │ │ "no", the default) or │
5736 │ │ │ │ will be │
5737 │ │ │ │ auto-negotiated (if │
5738 │ │ │ │ "auto-negotiate" is │
5739 │ │ │ │ "yes") and the local │
5740 │ │ │ │ device will advertise │
5741 │ │ │ │ all the supported │
5742 │ │ │ │ speeds. In Mbit/s, ie │
5743 │ │ │ │ 100 == 100Mbit/s. Must │
5744 │ │ │ │ be set together with │
5745 │ │ │ │ the "duplex" property │
5746 │ │ │ │ when non-zero. Before │
5747 │ │ │ │ specifying a speed │
5748 │ │ │ │ value be sure your │
5749 │ │ │ │ device supports it. │
5750 ├──────────────────────────┼─────────────────┼───────────────┼────────────────────────────────────────┤
5751 │wake-on-lan │ uint32 │ 1 │ The │
5752 │ │ │ │ NMSettingWiredWakeOnLan │
5753 │ │ │ │ options to enable. Not │
5754 │ │ │ │ all devices support │
5755 │ │ │ │ all options. May be │
5756 │ │ │ │ any combination of │
5757 │ │ │ │ NM_SETTING_WIRED_WAKE_ON_LAN_PHY │
5758 │ │ │ │ (0x2), │
5759 │ │ │ │ NM_SETTING_WIRED_WAKE_ON_LAN_UNICAST │
5760 │ │ │ │ (0x4), │
5761 │ │ │ │ NM_SETTING_WIRED_WAKE_ON_LAN_MULTICAST │
5762 │ │ │ │ (0x8), │
5763 │ │ │ │ NM_SETTING_WIRED_WAKE_ON_LAN_BROADCAST │
5764 │ │ │ │ (0x10), │
5765 │ │ │ │ NM_SETTING_WIRED_WAKE_ON_LAN_ARP │
5766 │ │ │ │ (0x20), │
5767 │ │ │ │ NM_SETTING_WIRED_WAKE_ON_LAN_MAGIC │
5768 │ │ │ │ (0x40) or the special │
5769 │ │ │ │ values │
5770 │ │ │ │ NM_SETTING_WIRED_WAKE_ON_LAN_DEFAULT │
5771 │ │ │ │ (0x1) (to use global │
5772 │ │ │ │ settings) and │
5773 │ │ │ │ NM_SETTING_WIRED_WAKE_ON_LAN_IGNORE │
5774 │ │ │ │ (0x8000) (to disable │
5775 │ │ │ │ management of │
5776 │ │ │ │ Wake-on-LAN in │
5777 │ │ │ │ NetworkManager). │
5778 ├──────────────────────────┼─────────────────┼───────────────┼────────────────────────────────────────┤
5779 │wake-on-lan-password │ string │ │ If specified, the password used with │
5780 │ │ │ │ magic-packet-based Wake-on-LAN, │
5781 │ │ │ │ represented as an Ethernet MAC │
5782 │ │ │ │ address. If NULL, no password will be │
5783 │ │ │ │ required. │
5784 └──────────────────────────┴─────────────────┴───────────────┴────────────────────────────────────────┘
5785 wireguard setting
5787 WireGuard Settings.
5788 ┌───────────────────────┬──────────────────────┬───────────────┬──────────────────────────┐
5790 │Key Name │ Value Type │ Default Value │ Value │
5791 │ │ │ │ Description │
5792 ├───────────────────────┼──────────────────────┼───────────────┼──────────────────────────┤
5793 │fwmark │ uint32 │ 0 │ The use of │
5794 │ │ │ │ fwmark is │
5795 │ │ │ │ optional and is │
5796 │ │ │ │ by default off. │
5797 │ │ │ │ Setting it to 0 │
5798 │ │ │ │ disables it. │
5799 │ │ │ │ Otherwise, it is │
5800 │ │ │ │ a 32-bit fwmark │
5801 │ │ │ │ for outgoing │
5802 │ │ │ │ packets. │
5803 │ │ │ │ │
5804 │ │ │ │ Note that │
5805 │ │ │ │ "ip4-auto-default-route" │
5806 │ │ │ │ or │
5807 │ │ │ │ "ip6-auto-default-route" │
5808 │ │ │ │ enabled, implies │
5809 │ │ │ │ to automatically │
5810 │ │ │ │ choose a fwmark. │
5811 ├───────────────────────┼──────────────────────┼───────────────┼──────────────────────────┤
5812 │ip4-auto-default-route │ NMTernary │ │ Whether to enable │
5813 │ │ (int32) │ │ special handling of the │
5814 │ │ │ │ IPv4 default route. If │
5815 │ │ │ │ enabled, the IPv4 │
5816 │ │ │ │ default route from │
5817 │ │ │ │ wireguard.peer-routes │
5818 │ │ │ │ will be placed to a │
5819 │ │ │ │ dedicated routing-table │
5820 │ │ │ │ and two policy routing │
5821 │ │ │ │ rules will be added. The │
5822 │ │ │ │ fwmark number is also │
5823 │ │ │ │ used as routing-table │
5824 │ │ │ │ for the default-route, │
5825 │ │ │ │ and if fwmark is zero, │
5826 │ │ │ │ an unused fwmark/table │
5827 │ │ │ │ is chosen automatically. │
5828 │ │ │ │ This corresponds to what │
5829 │ │ │ │ wg-quick does with │
5830 │ │ │ │ Table=auto and what │
5831 │ │ │ │ WireGuard calls │
5832 │ │ │ │ "Improved Rule-based │
5833 │ │ │ │ Routing". │
5834 │ │ │ │ │
5835 │ │ │ │ Note that for this │
5836 │ │ │ │ automatism to work, you │
5837 │ │ │ │ usually don't want to │
5838 │ │ │ │ set ipv4.gateway, │
5839 │ │ │ │ because that will result │
5840 │ │ │ │ in a conflicting default │
5841 │ │ │ │ route. │
5842 │ │ │ │ │
5843 │ │ │ │ Leaving this at the │
5844 │ │ │ │ default will enable this │
5845 │ │ │ │ option automatically if │
5846 │ │ │ │ ipv4.never-default is │
5847 │ │ │ │ not set and there are │
5848 │ │ │ │ any peers that use a │
5849 │ │ │ │ default-route as │
5850 │ │ │ │ allowed-ips. Since this │
5851 │ │ │ │ automatism only makes │
5852 │ │ │ │ sense if you also have a │
5853 │ │ │ │ peer with an /0 │
5854 │ │ │ │ allowed-ips, it is │
5855 │ │ │ │ usually not necessary to │
5856 │ │ │ │ enable this explicitly. │
5857 │ │ │ │ However, you can disable │
5858 │ │ │ │ it if you want to │
5859 │ │ │ │ configure your own │
5860 │ │ │ │ routing and rules. │
5861 ├───────────────────────┼──────────────────────┼───────────────┼──────────────────────────┤
5862 │ip6-auto-default-route │ NMTernary │ │ Like │
5863 │ │ (int32) │ │ ip4-auto-default-route, │
5864 │ │ │ │ but for the IPv6 default │
5865 │ │ │ │ route. │
5866 ├───────────────────────┼──────────────────────┼───────────────┼──────────────────────────┤
5867 │listen-port │ uint32 │ 0 │ The listen-port. If │
5868 │ │ │ │ listen-port is not │
5869 │ │ │ │ specified, the port will │
5870 │ │ │ │ be chosen randomly when │
5871 │ │ │ │ the interface comes up. │
5872 ├───────────────────────┼──────────────────────┼───────────────┼──────────────────────────┤
5873 │mtu │ uint32 │ 0 │ If non-zero, only │
5874 │ │ │ │ transmit packets of the │
5875 │ │ │ │ specified size or │
5876 │ │ │ │ smaller, breaking larger │
5877 │ │ │ │ packets up into multiple │
5878 │ │ │ │ fragments. │
5879 │ │ │ │ │
5880 │ │ │ │ If zero a default MTU is │
5881 │ │ │ │ used. Note that contrary │
5882 │ │ │ │ to wg-quick's MTU │
5883 │ │ │ │ setting, this does not │
5884 │ │ │ │ take into account the │
5885 │ │ │ │ current routes at the │
5886 │ │ │ │ time of activation. │
5887 ├───────────────────────┼──────────────────────┼───────────────┼──────────────────────────┤
5888 │peer-routes │ boolean │ TRUE │ Whether to automatically │
5889 │ │ │ │ add routes for the │
5890 │ │ │ │ AllowedIPs ranges of the │
5891 │ │ │ │ peers. If TRUE (the │
5892 │ │ │ │ default), NetworkManager │
5893 │ │ │ │ will automatically add │
5894 │ │ │ │ routes in the routing │
5895 │ │ │ │ tables according to │
5896 │ │ │ │ ipv4.route-table and │
5897 │ │ │ │ ipv6.route-table. │
5898 │ │ │ │ Usually you want this │
5899 │ │ │ │ automatism enabled. If │
5900 │ │ │ │ FALSE, no such routes │
5901 │ │ │ │ are added automatically. │
5902 │ │ │ │ In this case, the user │
5903 │ │ │ │ may want to configure │
5904 │ │ │ │ static routes in │
5905 │ │ │ │ ipv4.routes and │
5906 │ │ │ │ ipv6.routes, │
5907 │ │ │ │ respectively. │
5908 │ │ │ │ │
5909 │ │ │ │ Note that if the peer's │
5910 │ │ │ │ AllowedIPs is │
5911 │ │ │ │ "0.0.0.0/0" or "::/0" │
5912 │ │ │ │ and the profile's │
5913 │ │ │ │ ipv4.never-default or │
5914 │ │ │ │ ipv6.never-default │
5915 │ │ │ │ setting is enabled, the │
5916 │ │ │ │ peer route for this peer │
5917 │ │ │ │ won't be added │
5918 │ │ │ │ automatically. │
5919 ├───────────────────────┼──────────────────────┼───────────────┼──────────────────────────┤
5920 │peers │ array of 'a{sv}' │ │ Array of dictionaries │
5921 │ │ │ │ for the WireGuard peers. │
5922 ├───────────────────────┼──────────────────────┼───────────────┼──────────────────────────┤
5923 │private-key │ string │ │ The 256 bit private-key │
5924 │ │ │ │ in base64 encoding. │
5925 ├───────────────────────┼──────────────────────┼───────────────┼──────────────────────────┤
5926 │private-key-flags │ NMSettingSecretFlags │ │ Flags indicating how to │
5927 │ │ (uint32) │ │ handle the "private-key" │
5928 │ │ │ │ property. │
5929 └───────────────────────┴──────────────────────┴───────────────┴──────────────────────────┘
5930 802-11-wireless setting
5932 Wi-Fi Settings.
5933 ┌──────────────────────────┬─────────────────┬───────────────┬───────────────────────────────────────────────────────┐
5935 │Key Name │ Value Type │ Default Value │ Value │
5936 │ │ │ │ Description │
5937 ├──────────────────────────┼─────────────────┼───────────────┼───────────────────────────────────────────────────────┤
5938 │ap-isolation │ NMTernary │ │ Configures AP │
5939 │ │ (int32) │ │ isolation, which │
5940 │ │ │ │ prevents │
5941 │ │ │ │ communication │
5942 │ │ │ │ between wireless │
5943 │ │ │ │ devices │
5944 │ │ │ │ connected to │
5945 │ │ │ │ this AP. This │
5946 │ │ │ │ property can be │
5947 │ │ │ │ set to a value │
5948 │ │ │ │ different from │
5949 │ │ │ │ NM_TERNARY_DEFAULT │
5950 │ │ │ │ (-1) only when │
5951 │ │ │ │ the interface is │
5952 │ │ │ │ configured in AP │
5953 │ │ │ │ mode. │
5954 │ │ │ │ │
5955 │ │ │ │ If set to │
5956 │ │ │ │ NM_TERNARY_TRUE │
5957 │ │ │ │ (1), devices are │
5958 │ │ │ │ not able to │
5959 │ │ │ │ communicate with │
5960 │ │ │ │ each other. This │
5961 │ │ │ │ increases │
5962 │ │ │ │ security because │
5963 │ │ │ │ it protects │
5964 │ │ │ │ devices against │
5965 │ │ │ │ attacks from │
5966 │ │ │ │ other clients in │
5967 │ │ │ │ the network. At │
5968 │ │ │ │ the same time, │
5969 │ │ │ │ it prevents │
5970 │ │ │ │ devices to │
5971 │ │ │ │ access resources │
5972 │ │ │ │ on the same │
5973 │ │ │ │ wireless │
5974 │ │ │ │ networks as file │
5975 │ │ │ │ shares, │
5976 │ │ │ │ printers, etc. │
5977 │ │ │ │ │
5978 │ │ │ │ If set to │
5979 │ │ │ │ NM_TERNARY_FALSE │
5980 │ │ │ │ (0), devices can │
5981 │ │ │ │ talk to each │
5982 │ │ │ │ other. │
5983 │ │ │ │ │
5984 │ │ │ │ When set to │
5985 │ │ │ │ NM_TERNARY_DEFAULT │
5986 │ │ │ │ (-1), the global │
5987 │ │ │ │ default is used; │
5988 │ │ │ │ in case the │
5989 │ │ │ │ global default │
5990 │ │ │ │ is unspecified │
5991 │ │ │ │ it is assumed to │
5992 │ │ │ │ be │
5993 │ │ │ │ NM_TERNARY_FALSE │
5994 │ │ │ │ (0). │
5995 ├──────────────────────────┼─────────────────┼───────────────┼───────────────────────────────────────────────────────┤
5996 │assigned-mac-address │ string │ │ The new field for │
5997 │ │ │ │ the cloned MAC │
5998 │ │ │ │ address. It can be │
5999 │ │ │ │ either a hardware │
6000 │ │ │ │ address in ASCII │
6001 │ │ │ │ representation, or │
6002 │ │ │ │ one of the special │
6003 │ │ │ │ values "preserve", │
6004 │ │ │ │ "permanent", │
6005 │ │ │ │ "random" or │
6006 │ │ │ │ "stable". This │
6007 │ │ │ │ field replaces the │
6008 │ │ │ │ deprecated │
6009 │ │ │ │ "cloned-mac-address" │
6010 │ │ │ │ on D-Bus, which │
6011 │ │ │ │ can only contain │
6012 │ │ │ │ explicit hardware │
6013 │ │ │ │ addresses. Note │
6014 │ │ │ │ that this property │
6015 │ │ │ │ only exists in │
6016 │ │ │ │ D-Bus API. libnm │
6017 │ │ │ │ and nmcli continue │
6018 │ │ │ │ to call this │
6019 │ │ │ │ property │
6020 │ │ │ │ "cloned-mac-address". │
6021 ├──────────────────────────┼─────────────────┼───────────────┼───────────────────────────────────────────────────────┤
6022 │band │ string │ │ 802.11 frequency band │
6023 │ │ │ │ of the network. One │
6024 │ │ │ │ of "a" for 5GHz │
6025 │ │ │ │ 802.11a or "bg" for │
6026 │ │ │ │ 2.4GHz 802.11. This │
6027 │ │ │ │ will lock │
6028 │ │ │ │ associations to the │
6029 │ │ │ │ Wi-Fi network to the │
6030 │ │ │ │ specific band, i.e. │
6031 │ │ │ │ if "a" is specified, │
6032 │ │ │ │ the device will not │
6033 │ │ │ │ associate with the │
6034 │ │ │ │ same network in the │
6035 │ │ │ │ 2.4GHz band even if │
6036 │ │ │ │ the network's │
6037 │ │ │ │ settings are │
6038 │ │ │ │ compatible. This │
6039 │ │ │ │ setting depends on │
6040 │ │ │ │ specific driver │
6041 │ │ │ │ capability and may │
6042 │ │ │ │ not work with all │
6043 │ │ │ │ drivers. │
6044 ├──────────────────────────┼─────────────────┼───────────────┼───────────────────────────────────────────────────────┤
6045 │bssid │ byte array │ │ If specified, directs │
6046 │ │ │ │ the device to only │
6047 │ │ │ │ associate with the │
6048 │ │ │ │ given access point. │
6049 │ │ │ │ This capability is │
6050 │ │ │ │ highly driver │
6051 │ │ │ │ dependent and not │
6052 │ │ │ │ supported by all │
6053 │ │ │ │ devices. Note: this │
6054 │ │ │ │ property does not │
6055 │ │ │ │ control the BSSID │
6056 │ │ │ │ used when creating an │
6057 │ │ │ │ Ad-Hoc network and is │
6058 │ │ │ │ unlikely to in the │
6059 │ │ │ │ future. │
6060 │ │ │ │ │
6061 │ │ │ │ Locking a client │
6062 │ │ │ │ profile to a certain │
6063 │ │ │ │ BSSID will prevent │
6064 │ │ │ │ roaming and also │
6065 │ │ │ │ disable background │
6066 │ │ │ │ scanning. That can be │
6067 │ │ │ │ useful, if there is │
6068 │ │ │ │ only one access point │
6069 │ │ │ │ for the SSID. │
6070 ├──────────────────────────┼─────────────────┼───────────────┼───────────────────────────────────────────────────────┤
6071 │channel │ uint32 │ 0 │ Wireless channel to │
6072 │ │ │ │ use for the Wi-Fi │
6073 │ │ │ │ connection. The │
6074 │ │ │ │ device will only join │
6075 │ │ │ │ (or create for Ad-Hoc │
6076 │ │ │ │ networks) a Wi-Fi │
6077 │ │ │ │ network on the │
6078 │ │ │ │ specified channel. │
6079 │ │ │ │ Because channel │
6080 │ │ │ │ numbers overlap │
6081 │ │ │ │ between bands, this │
6082 │ │ │ │ property also │
6083 │ │ │ │ requires the "band" │
6084 │ │ │ │ property to be set. │
6085 ├──────────────────────────┼─────────────────┼───────────────┼───────────────────────────────────────────────────────┤
6086 │cloned-mac-address │ byte array │ │ This D-Bus field is │
6087 │ │ │ │ deprecated in favor │
6088 │ │ │ │ of │
6089 │ │ │ │ "assigned-mac-address" │
6090 │ │ │ │ which is more │
6091 │ │ │ │ flexible and allows │
6092 │ │ │ │ specifying special │
6093 │ │ │ │ variants like │
6094 │ │ │ │ "random". For libnm │
6095 │ │ │ │ and nmcli, this field │
6096 │ │ │ │ is called │
6097 │ │ │ │ "cloned-mac-address". │
6098 ├──────────────────────────┼─────────────────┼───────────────┼───────────────────────────────────────────────────────┤
6099 │generate-mac-address-mask │ string │ │ With │
6100 │ │ │ │ "cloned-mac-address" │
6101 │ │ │ │ setting "random" or │
6102 │ │ │ │ "stable", by default │
6103 │ │ │ │ all bits of the MAC │
6104 │ │ │ │ address are scrambled │
6105 │ │ │ │ and a │
6106 │ │ │ │ locally-administered, │
6107 │ │ │ │ unicast MAC address is │
6108 │ │ │ │ created. This property │
6109 │ │ │ │ allows to specify that │
6110 │ │ │ │ certain bits are │
6111 │ │ │ │ fixed. Note that the │
6112 │ │ │ │ least significant bit │
6113 │ │ │ │ of the first MAC │
6114 │ │ │ │ address will always be │
6115 │ │ │ │ unset to create a │
6116 │ │ │ │ unicast MAC address. │
6117 │ │ │ │ │
6118 │ │ │ │ If the property is │
6119 │ │ │ │ NULL, it is eligible │
6120 │ │ │ │ to be overwritten by a │
6121 │ │ │ │ default connection │
6122 │ │ │ │ setting. If the value │
6123 │ │ │ │ is still NULL or an │
6124 │ │ │ │ empty string, the │
6125 │ │ │ │ default is to create a │
6126 │ │ │ │ locally-administered, │
6127 │ │ │ │ unicast MAC address. │
6128 │ │ │ │ │
6129 │ │ │ │ If the value contains │
6130 │ │ │ │ one MAC address, this │
6131 │ │ │ │ address is used as │
6132 │ │ │ │ mask. The set bits of │
6133 │ │ │ │ the mask are to be │
6134 │ │ │ │ filled with the │
6135 │ │ │ │ current MAC address of │
6136 │ │ │ │ the device, while the │
6137 │ │ │ │ unset bits are subject │
6138 │ │ │ │ to randomization. │
6139 │ │ │ │ Setting │
6140 │ │ │ │ "FE:FF:FF:00:00:00" │
6141 │ │ │ │ means to preserve the │
6142 │ │ │ │ OUI of the current MAC │
6143 │ │ │ │ address and only │
6144 │ │ │ │ randomize the lower 3 │
6145 │ │ │ │ bytes using the │
6146 │ │ │ │ "random" or "stable" │
6147 │ │ │ │ algorithm. │
6148 │ │ │ │ │
6149 │ │ │ │ If the value contains │
6150 │ │ │ │ one additional MAC │
6151 │ │ │ │ address after the │
6152 │ │ │ │ mask, this address is │
6153 │ │ │ │ used instead of the │
6154 │ │ │ │ current MAC address to │
6155 │ │ │ │ fill the bits that │
6156 │ │ │ │ shall not be │
6157 │ │ │ │ randomized. For │
6158 │ │ │ │ example, a value of │
6159 │ │ │ │ "FE:FF:FF:00:00:00 │
6160 │ │ │ │ 68:F7:28:00:00:00" │
6161 │ │ │ │ will set the OUI of │
6162 │ │ │ │ the MAC address to │
6163 │ │ │ │ 68:F7:28, while the │
6164 │ │ │ │ lower bits are │
6165 │ │ │ │ randomized. A value of │
6166 │ │ │ │ "02:00:00:00:00:00 │
6167 │ │ │ │ 00:00:00:00:00:00" │
6168 │ │ │ │ will create a fully │
6169 │ │ │ │ scrambled │
6170 │ │ │ │ globally-administered, │
6171 │ │ │ │ burned-in MAC address. │
6172 │ │ │ │ │
6173 │ │ │ │ If the value contains │
6174 │ │ │ │ more than one │
6175 │ │ │ │ additional MAC │
6176 │ │ │ │ addresses, one of them │
6177 │ │ │ │ is chosen randomly. │
6178 │ │ │ │ For example, │
6179 │ │ │ │ "02:00:00:00:00:00 │
6180 │ │ │ │ 00:00:00:00:00:00 │
6181 │ │ │ │ 02:00:00:00:00:00" │
6182 │ │ │ │ will create a fully │
6183 │ │ │ │ scrambled MAC address, │
6184 │ │ │ │ randomly locally or │
6185 │ │ │ │ globally administered. │
6186 ├──────────────────────────┼─────────────────┼───────────────┼───────────────────────────────────────────────────────┤
6187 │hidden │ boolean │ FALSE │ If TRUE, indicates │
6188 │ │ │ │ that the network is a │
6189 │ │ │ │ non-broadcasting │
6190 │ │ │ │ network that hides its │
6191 │ │ │ │ SSID. This works both │
6192 │ │ │ │ in infrastructure and │
6193 │ │ │ │ AP mode. │
6194 │ │ │ │ │
6195 │ │ │ │ In infrastructure │
6196 │ │ │ │ mode, various │
6197 │ │ │ │ workarounds are used │
6198 │ │ │ │ for a more reliable │
6199 │ │ │ │ discovery of hidden │
6200 │ │ │ │ networks, such as │
6201 │ │ │ │ probe-scanning the │
6202 │ │ │ │ SSID. However, these │
6203 │ │ │ │ workarounds expose │
6204 │ │ │ │ inherent insecurities │
6205 │ │ │ │ with hidden SSID │
6206 │ │ │ │ networks, and thus │
6207 │ │ │ │ hidden SSID networks │
6208 │ │ │ │ should be used with │
6209 │ │ │ │ caution. │
6210 │ │ │ │ │
6211 │ │ │ │ In AP mode, the │
6212 │ │ │ │ created network does │
6213 │ │ │ │ not broadcast its │
6214 │ │ │ │ SSID. │
6215 │ │ │ │ │
6216 │ │ │ │ Note that marking the │
6217 │ │ │ │ network as hidden may │
6218 │ │ │ │ be a privacy issue for │
6219 │ │ │ │ you (in infrastructure │
6220 │ │ │ │ mode) or client │
6221 │ │ │ │ stations (in AP mode), │
6222 │ │ │ │ as the explicit │
6223 │ │ │ │ probe-scans are │
6224 │ │ │ │ distinctly │
6225 │ │ │ │ recognizable on the │
6226 │ │ │ │ air. │
6227 ├──────────────────────────┼─────────────────┼───────────────┼───────────────────────────────────────────────────────┤
6228 │mac-address │ byte array │ │ If specified, this │
6229 │ │ │ │ connection will only │
6230 │ │ │ │ apply to the Wi-Fi │
6231 │ │ │ │ device whose permanent │
6232 │ │ │ │ MAC address matches. │
6233 │ │ │ │ This property does not │
6234 │ │ │ │ change the MAC address │
6235 │ │ │ │ of the device (i.e. │
6236 │ │ │ │ MAC spoofing). │
6237 ├──────────────────────────┼─────────────────┼───────────────┼───────────────────────────────────────────────────────┤
6238 │mac-address-blacklist │ array of string │ │ A list of permanent │
6239 │ │ │ │ MAC addresses of Wi-Fi │
6240 │ │ │ │ devices to which this │
6241 │ │ │ │ connection should │
6242 │ │ │ │ never apply. Each MAC │
6243 │ │ │ │ address should be │
6244 │ │ │ │ given in the standard │
6245 │ │ │ │ hex-digits-and-colons │
6246 │ │ │ │ notation (eg │
6247 │ │ │ │ "00:11:22:33:44:55"). │
6248 ├──────────────────────────┼─────────────────┼───────────────┼───────────────────────────────────────────────────────┤
6249 │mac-address-randomization │ uint32 │ 0 │ One of │
6250 │ │ │ │ NM_SETTING_MAC_RANDOMIZATION_DEFAULT │
6251 │ │ │ │ (0) (never randomize │
6252 │ │ │ │ unless the user has │
6253 │ │ │ │ set a global default │
6254 │ │ │ │ to randomize and the │
6255 │ │ │ │ supplicant supports │
6256 │ │ │ │ randomization), │
6257 │ │ │ │ NM_SETTING_MAC_RANDOMIZATION_NEVER │
6258 │ │ │ │ (1) (never randomize │
6259 │ │ │ │ the MAC address), or │
6260 │ │ │ │ NM_SETTING_MAC_RANDOMIZATION_ALWAYS │
6261 │ │ │ │ (2) (always randomize │
6262 │ │ │ │ the MAC address). │
6263 │ │ │ │ │
6264 │ │ │ │ This property is │
6265 │ │ │ │ deprecated since │
6266 │ │ │ │ version 1.4.Use the │
6267 │ │ │ │ "cloned-mac-address" │
6268 │ │ │ │ property instead. │
6269 ├──────────────────────────┼─────────────────┼───────────────┼───────────────────────────────────────────────────────┤
6270 │mode │ string │ │ Wi-Fi network mode; one of │
6271 │ │ │ │ "infrastructure", "mesh", "adhoc" or │
6272 │ │ │ │ "ap". If blank, infrastructure is │
6273 │ │ │ │ assumed. │
6274 ├──────────────────────────┼─────────────────┼───────────────┼───────────────────────────────────────────────────────┤
6275 │mtu │ uint32 │ 0 │ If non-zero, only transmit packets │
6276 │ │ │ │ of the specified size or smaller, │
6277 │ │ │ │ breaking larger packets up into │
6278 │ │ │ │ multiple Ethernet frames. │
6279 ├──────────────────────────┼─────────────────┼───────────────┼───────────────────────────────────────────────────────┤
6280 │powersave │ uint32 │ 0 │ One of │
6281 │ │ │ │ NM_SETTING_WIRELESS_POWERSAVE_DISABLE │
6282 │ │ │ │ (2) (disable Wi-Fi power saving), │
6283 │ │ │ │ NM_SETTING_WIRELESS_POWERSAVE_ENABLE │
6284 │ │ │ │ (3) (enable Wi-Fi power saving), │
6285 │ │ │ │ NM_SETTING_WIRELESS_POWERSAVE_IGNORE │
6286 │ │ │ │ (1) (don't touch currently configure │
6287 │ │ │ │ setting) or │
6288 │ │ │ │ NM_SETTING_WIRELESS_POWERSAVE_DEFAULT │
6289 │ │ │ │ (0) (use the globally configured │
6290 │ │ │ │ value). All other values are │
6291 │ │ │ │ reserved. │
6292 ├──────────────────────────┼─────────────────┼───────────────┼───────────────────────────────────────────────────────┤
6293 │rate │ uint32 │ 0 │ If non-zero, directs the device to │
6294 │ │ │ │ only use the specified bitrate for │
6295 │ │ │ │ communication with the access point. │
6296 │ │ │ │ Units are in Kb/s, ie 5500 = 5.5 │
6297 │ │ │ │ Mbit/s. This property is highly │
6298 │ │ │ │ driver dependent and not all devices │
6299 │ │ │ │ support setting a static bitrate. │
6300 ├──────────────────────────┼─────────────────┼───────────────┼───────────────────────────────────────────────────────┤
6301 │security │ │ │ This property is deprecated, but can │
6302 │ │ │ │ be set to the value │
6303 │ │ │ │ '802-11-wireless-security' when a │
6304 │ │ │ │ wireless security setting is also │
6305 │ │ │ │ present in the connection dictionary, │
6306 │ │ │ │ for compatibility with very old │
6307 │ │ │ │ NetworkManager daemons. │
6308 ├──────────────────────────┼─────────────────┼───────────────┼───────────────────────────────────────────────────────┤
6309 │seen-bssids │ array of string │ │ A list of BSSIDs (each BSSID │
6310 │ │ │ │ formatted as a MAC address like │
6311 │ │ │ │ "00:11:22:33:44:55") that have been │
6312 │ │ │ │ detected as part of the Wi-Fi │
6313 │ │ │ │ network. NetworkManager internally │
6314 │ │ │ │ tracks previously seen BSSIDs. The │
6315 │ │ │ │ property is only meant for reading │
6316 │ │ │ │ and reflects the BSSID list of │
6317 │ │ │ │ NetworkManager. The changes you make │
6318 │ │ │ │ to this property will not be │
6319 │ │ │ │ preserved. │
6320 ├──────────────────────────┼─────────────────┼───────────────┼───────────────────────────────────────────────────────┤
6321 │ssid │ byte array │ │ SSID of the Wi-Fi network. Must be │
6322 │ │ │ │ specified. │
6323 ├──────────────────────────┼─────────────────┼───────────────┼───────────────────────────────────────────────────────┤
6324 │tx-power │ uint32 │ 0 │ If non-zero, directs the device to │
6325 │ │ │ │ use the specified transmit power. │
6326 │ │ │ │ Units are dBm. This property is │
6327 │ │ │ │ highly driver dependent and not all │
6328 │ │ │ │ devices support setting a static │
6329 │ │ │ │ transmit power. │
6330 ├──────────────────────────┼─────────────────┼───────────────┼───────────────────────────────────────────────────────┤
6331 │wake-on-wlan │ uint32 │ 1 │ The NMSettingWirelessWakeOnWLan │
6332 │ │ │ │ options to enable. Not all devices │
6333 │ │ │ │ support all options. May be any │
6334 │ │ │ │ combination of │
6335 │ │ │ │ NM_SETTING_WIRELESS_WAKE_ON_WLAN_ANY │
6336 │ │ │ │ (0x2), │
6337 │ │ │ │ NM_SETTING_WIRELESS_WAKE_ON_WLAN_DISCONNECT │
6338 │ │ │ │ (0x4), │
6339 │ │ │ │ NM_SETTING_WIRELESS_WAKE_ON_WLAN_MAGIC │
6340 │ │ │ │ (0x8), │
6341 │ │ │ │ NM_SETTING_WIRELESS_WAKE_ON_WLAN_GTK_REKEY_FAILURE │
6342 │ │ │ │ (0x10), │
6343 │ │ │ │ NM_SETTING_WIRELESS_WAKE_ON_WLAN_EAP_IDENTITY_REQUEST │
6344 │ │ │ │ (0x20), │
6345 │ │ │ │ NM_SETTING_WIRELESS_WAKE_ON_WLAN_4WAY_HANDSHAKE │
6346 │ │ │ │ (0x40), │
6347 │ │ │ │ NM_SETTING_WIRELESS_WAKE_ON_WLAN_RFKILL_RELEASE │
6348 │ │ │ │ (0x80), │
6349 │ │ │ │ NM_SETTING_WIRELESS_WAKE_ON_WLAN_TCP │
6350 │ │ │ │ (0x100) or the special values │
6351 │ │ │ │ NM_SETTING_WIRELESS_WAKE_ON_WLAN_DEFAULT │
6352 │ │ │ │ (0x1) (to use global settings) and │
6353 │ │ │ │ NM_SETTING_WIRELESS_WAKE_ON_WLAN_IGNORE │
6354 │ │ │ │ (0x8000) (to disable management of │
6355 │ │ │ │ Wake-on-LAN in NetworkManager). │
6356 └──────────────────────────┴─────────────────┴───────────────┴───────────────────────────────────────────────────────┘
6357 802-11-wireless-security setting
6359 Wi-Fi Security Settings.
6360 ┌────────────────────┬──────────────────────┬───────────────┬────────────────────────────────────────────┐
6362 │Key Name │ Value Type │ Default Value │ Value │
6363 │ │ │ │ Description │
6364 ├────────────────────┼──────────────────────┼───────────────┼────────────────────────────────────────────┤
6365 │auth-alg │ string │ │ When WEP is used │
6366 │ │ │ │ (ie, key-mgmt = │
6367 │ │ │ │ "none" or │
6368 │ │ │ │ "ieee8021x") │
6369 │ │ │ │ indicate the │
6370 │ │ │ │ 802.11 │
6371 │ │ │ │ authentication │
6372 │ │ │ │ algorithm │
6373 │ │ │ │ required by the │
6374 │ │ │ │ AP here. One of │
6375 │ │ │ │ "open" for Open │
6376 │ │ │ │ System, "shared" │
6377 │ │ │ │ for Shared Key, │
6378 │ │ │ │ or "leap" for │
6379 │ │ │ │ Cisco LEAP. │
6380 │ │ │ │ When using Cisco │
6381 │ │ │ │ LEAP (ie, │
6382 │ │ │ │ key-mgmt = │
6383 │ │ │ │ "ieee8021x" and │
6384 │ │ │ │ auth-alg = │
6385 │ │ │ │ "leap") the │
6386 │ │ │ │ "leap-username" │
6387 │ │ │ │ and │
6388 │ │ │ │ "leap-password" │
6389 │ │ │ │ properties must │
6390 │ │ │ │ be specified. │
6391 ├────────────────────┼──────────────────────┼───────────────┼────────────────────────────────────────────┤
6392 │fils │ int32 │ 0 │ Indicates │
6393 │ │ │ │ whether Fast │
6394 │ │ │ │ Initial Link │
6395 │ │ │ │ Setup (802.11ai) │
6396 │ │ │ │ must be enabled │
6397 │ │ │ │ for the │
6398 │ │ │ │ connection. One │
6399 │ │ │ │ of │
6400 │ │ │ │ NM_SETTING_WIRELESS_SECURITY_FILS_DEFAULT │
6401 │ │ │ │ (0) (use global │
6402 │ │ │ │ default value), │
6403 │ │ │ │ NM_SETTING_WIRELESS_SECURITY_FILS_DISABLE │
6404 │ │ │ │ (1) (disable │
6405 │ │ │ │ FILS), │
6406 │ │ │ │ NM_SETTING_WIRELESS_SECURITY_FILS_OPTIONAL │
6407 │ │ │ │ (2) (enable FILS │
6408 │ │ │ │ if the │
6409 │ │ │ │ supplicant and │
6410 │ │ │ │ the access point │
6411 │ │ │ │ support it) or │
6412 │ │ │ │ NM_SETTING_WIRELESS_SECURITY_FILS_REQUIRED │
6413 │ │ │ │ (3) (enable FILS │
6414 │ │ │ │ and fail if not │
6415 │ │ │ │ supported). │
6416 │ │ │ │ When set to │
6417 │ │ │ │ NM_SETTING_WIRELESS_SECURITY_FILS_DEFAULT │
6418 │ │ │ │ (0) and no │
6419 │ │ │ │ global default │
6420 │ │ │ │ is set, FILS │
6421 │ │ │ │ will be │
6422 │ │ │ │ optionally │
6423 │ │ │ │ enabled. │
6424 ├────────────────────┼──────────────────────┼───────────────┼────────────────────────────────────────────┤
6425 │group │ array of string │ │ A list of group/broadcast encryption │
6426 │ │ │ │ algorithms which prevents connections to │
6427 │ │ │ │ Wi-Fi networks that do not utilize one of │
6428 │ │ │ │ the algorithms in the list. For maximum │
6429 │ │ │ │ compatibility leave this property empty. │
6430 │ │ │ │ Each list element may be one of "wep40", │
6431 │ │ │ │ "wep104", "tkip", or "ccmp". │
6432 ├────────────────────┼──────────────────────┼───────────────┼────────────────────────────────────────────┤
6433 │key-mgmt │ string │ │ Key management used for the connection. │
6434 │ │ │ │ One of "none" (WEP or no password │
6435 │ │ │ │ protection), "ieee8021x" (Dynamic WEP), │
6436 │ │ │ │ "owe" (Opportunistic Wireless Encryption), │
6437 │ │ │ │ "wpa-psk" (WPA2 + WPA3 personal), "sae" │
6438 │ │ │ │ (WPA3 personal only), "wpa-eap" (WPA2 + │
6439 │ │ │ │ WPA3 enterprise) or "wpa-eap-suite-b-192" │
6440 │ │ │ │ (WPA3 enterprise only). │
6441 │ │ │ │ │
6442 │ │ │ │ This property must be set for any Wi-Fi │
6443 │ │ │ │ connection that uses security. │
6444 ├────────────────────┼──────────────────────┼───────────────┼────────────────────────────────────────────┤
6445 │leap-password │ string │ │ The login password for legacy LEAP │
6446 │ │ │ │ connections (ie, key-mgmt = "ieee8021x" │
6447 │ │ │ │ and auth-alg = "leap"). │
6448 ├────────────────────┼──────────────────────┼───────────────┼────────────────────────────────────────────┤
6449 │leap-password-flags │ NMSettingSecretFlags │ │ Flags indicating how to handle the │
6450 │ │ (uint32) │ │ "leap-password" property. │
6451 ├────────────────────┼──────────────────────┼───────────────┼────────────────────────────────────────────┤
6452 │leap-username │ string │ │ The login username for legacy LEAP │
6453 │ │ │ │ connections (ie, key-mgmt = "ieee8021x" │
6454 │ │ │ │ and auth-alg = "leap"). │
6455 ├────────────────────┼──────────────────────┼───────────────┼────────────────────────────────────────────┤
6456 │pairwise │ array of string │ │ A list of pairwise encryption algorithms │
6457 │ │ │ │ which prevents connections to Wi-Fi │
6458 │ │ │ │ networks that do not utilize one of the │
6459 │ │ │ │ algorithms in the list. For maximum │
6460 │ │ │ │ compatibility leave this property empty. │
6461 │ │ │ │ Each list element may be one of "tkip" or │
6462 │ │ │ │ "ccmp". │
6463 ├────────────────────┼──────────────────────┼───────────────┼────────────────────────────────────────────┤
6464 │pmf │ int32 │ 0 │ Indicates whether Protected Management │
6465 │ │ │ │ Frames (802.11w) must be enabled for the │
6466 │ │ │ │ connection. One of │
6467 │ │ │ │ NM_SETTING_WIRELESS_SECURITY_PMF_DEFAULT │
6468 │ │ │ │ (0) (use global default value), │
6469 │ │ │ │ NM_SETTING_WIRELESS_SECURITY_PMF_DISABLE │
6470 │ │ │ │ (1) (disable PMF), │
6471 │ │ │ │ NM_SETTING_WIRELESS_SECURITY_PMF_OPTIONAL │
6472 │ │ │ │ (2) (enable PMF if the supplicant and the │
6473 │ │ │ │ access point support it) or │
6474 │ │ │ │ NM_SETTING_WIRELESS_SECURITY_PMF_REQUIRED │
6475 │ │ │ │ (3) (enable PMF and fail if not │
6476 │ │ │ │ supported). When set to │
6477 │ │ │ │ NM_SETTING_WIRELESS_SECURITY_PMF_DEFAULT │
6478 │ │ │ │ (0) and no global default is set, PMF will │
6479 │ │ │ │ be optionally enabled. │
6480 ├────────────────────┼──────────────────────┼───────────────┼────────────────────────────────────────────┤
6481 │proto │ array of string │ │ List of strings specifying the allowed WPA │
6482 │ │ │ │ protocol versions to use. Each element may │
6483 │ │ │ │ be one "wpa" (allow WPA) or "rsn" (allow │
6484 │ │ │ │ WPA2/RSN). If not specified, both WPA and │
6485 │ │ │ │ RSN connections are allowed. │
6486 ├────────────────────┼──────────────────────┼───────────────┼────────────────────────────────────────────┤
6487 │psk │ string │ │ Pre-Shared-Key for WPA networks. For │
6488 │ │ │ │ WPA-PSK, it's either an ASCII passphrase │
6489 │ │ │ │ of 8 to 63 characters that is (as │
6490 │ │ │ │ specified in the 802.11i standard) hashed │
6491 │ │ │ │ to derive the actual key, or the key in │
6492 │ │ │ │ form of 64 hexadecimal character. The │
6493 │ │ │ │ WPA3-Personal networks use a passphrase of │
6494 │ │ │ │ any length for SAE authentication. │
6495 ├────────────────────┼──────────────────────┼───────────────┼────────────────────────────────────────────┤
6496 │psk-flags │ NMSettingSecretFlags │ │ Flags indicating how to handle the "psk" │
6497 │ │ (uint32) │ │ property. │
6498 ├────────────────────┼──────────────────────┼───────────────┼────────────────────────────────────────────┤
6499 │wep-key-flags │ NMSettingSecretFlags │ │ Flags indicating how to handle the │
6500 │ │ (uint32) │ │ "wep-key0", "wep-key1", "wep-key2", and │
6501 │ │ │ │ "wep-key3" properties. │
6502 ├────────────────────┼──────────────────────┼───────────────┼────────────────────────────────────────────┤
6503 │wep-key-type │ NMWepKeyType │ │ Controls the interpretation of WEP keys. │
6504 │ │ (uint32) │ │ Allowed values are NM_WEP_KEY_TYPE_KEY │
6505 │ │ │ │ (1), in which case the key is either a 10- │
6506 │ │ │ │ or 26-character hexadecimal string, or a │
6507 │ │ │ │ 5- or 13-character ASCII password; or │
6508 │ │ │ │ NM_WEP_KEY_TYPE_PASSPHRASE (2), in which │
6509 │ │ │ │ case the passphrase is provided as a │
6510 │ │ │ │ string and will be hashed using the │
6511 │ │ │ │ de-facto MD5 method to derive the actual │
6512 │ │ │ │ WEP key. │
6513 ├────────────────────┼──────────────────────┼───────────────┼────────────────────────────────────────────┤
6514 │wep-key0 │ string │ │ Index 0 WEP key. This is the WEP key used │
6515 │ │ │ │ in most networks. See the "wep-key-type" │
6516 │ │ │ │ property for a description of how this key │
6517 │ │ │ │ is interpreted. │
6518 ├────────────────────┼──────────────────────┼───────────────┼────────────────────────────────────────────┤
6519 │wep-key1 │ string │ │ Index 1 WEP key. This WEP index is not │
6520 │ │ │ │ used by most networks. See the │
6521 │ │ │ │ "wep-key-type" property for a description │
6522 │ │ │ │ of how this key is interpreted. │
6523 ├────────────────────┼──────────────────────┼───────────────┼────────────────────────────────────────────┤
6524 │wep-key2 │ string │ │ Index 2 WEP key. This WEP index is not │
6525 │ │ │ │ used by most networks. See the │
6526 │ │ │ │ "wep-key-type" property for a description │
6527 │ │ │ │ of how this key is interpreted. │
6528 ├────────────────────┼──────────────────────┼───────────────┼────────────────────────────────────────────┤
6529 │wep-key3 │ string │ │ Index 3 WEP key. This WEP index is not │
6530 │ │ │ │ used by most networks. See the │
6531 │ │ │ │ "wep-key-type" property for a description │
6532 │ │ │ │ of how this key is interpreted. │
6533 ├────────────────────┼──────────────────────┼───────────────┼────────────────────────────────────────────┤
6534 │wep-tx-keyidx │ uint32 │ 0 │ When static WEP is used (ie, key-mgmt = │
6535 │ │ │ │ "none") and a non-default WEP key index is │
6536 │ │ │ │ used by the AP, put that WEP key index │
6537 │ │ │ │ here. Valid values are 0 (default key) │
6538 │ │ │ │ through 3. Note that some consumer access │
6539 │ │ │ │ points (like the Linksys WRT54G) number │
6540 │ │ │ │ the keys 1 - 4. │
6541 ├────────────────────┼──────────────────────┼───────────────┼────────────────────────────────────────────┤
6542 │wps-method │ uint32 │ 0 │ Flags indicating which mode of WPS is to │
6543 │ │ │ │ be used if any. │
6544 │ │ │ │ │
6545 │ │ │ │ There's little point in changing the │
6546 │ │ │ │ default setting as NetworkManager will │
6547 │ │ │ │ automatically determine whether it's │
6548 │ │ │ │ feasible to start WPS enrollment from the │
6549 │ │ │ │ Access Point capabilities. │
6550 │ │ │ │ │
6551 │ │ │ │ WPS can be disabled by setting this │
6552 │ │ │ │ property to a value of 1. │
6553 └────────────────────┴──────────────────────┴───────────────┴────────────────────────────────────────────┘
6554 wpan setting
6556 IEEE 802.15.4 (WPAN) MAC Settings.
6557 ┌──────────────┬────────────┬───────────────┬──────────────────┐
6559 │Key Name │ Value Type │ Default Value │ Value │
6560 │ │ │ │ Description │
6561 ├──────────────┼────────────┼───────────────┼──────────────────┤
6562 │channel │ int32 │ -1 │ IEEE 802.15.4 │
6563 │ │ │ │ channel. A │
6564 │ │ │ │ positive integer │
6565 │ │ │ │ or -1, meaning │
6566 │ │ │ │ "do not set, use │
6567 │ │ │ │ whatever the │
6568 │ │ │ │ device is │
6569 │ │ │ │ already set to". │
6570 ├──────────────┼────────────┼───────────────┼──────────────────┤
6571 │mac-address │ string │ │ If specified, │
6572 │ │ │ │ this connection │
6573 │ │ │ │ will only apply │
6574 │ │ │ │ to the IEEE │
6575 │ │ │ │ 802.15.4 (WPAN) │
6576 │ │ │ │ MAC layer device │
6577 │ │ │ │ whose permanent │
6578 │ │ │ │ MAC address │
6579 │ │ │ │ matches. │
6580 ├──────────────┼────────────┼───────────────┼──────────────────┤
6581 │page │ int32 │ -1 │ IEEE 802.15.4 │
6582 │ │ │ │ channel page. A │
6583 │ │ │ │ positive integer │
6584 │ │ │ │ or -1, meaning │
6585 │ │ │ │ "do not set, use │
6586 │ │ │ │ whatever the │
6587 │ │ │ │ device is │
6588 │ │ │ │ already set to". │
6589 ├──────────────┼────────────┼───────────────┼──────────────────┤
6590 │pan-id │ uint32 │ 65535 │ IEEE 802.15.4 │
6591 │ │ │ │ Personal Area │
6592 │ │ │ │ Network (PAN) │
6593 │ │ │ │ identifier. │
6594 ├──────────────┼────────────┼───────────────┼──────────────────┤
6595 │short-address │ uint32 │ 65535 │ Short IEEE │
6596 │ │ │ │ 802.15.4 address │
6597 │ │ │ │ to be used │
6598 │ │ │ │ within a │
6599 │ │ │ │ restricted │
6600 │ │ │ │ environment. │
6601 └──────────────┴────────────┴───────────────┴──────────────────┘
6602 bond-port setting
6604 Bond Port Settings.
6605 ┌─────────┬────────────┬───────────────┬──────────────────┐
6607 │Key Name │ Value Type │ Default Value │ Value │
6608 │ │ │ │ Description │
6609 ├─────────┼────────────┼───────────────┼──────────────────┤
6610 │prio │ int32 │ 0 │ The port │
6611 │ │ │ │ priority for │
6612 │ │ │ │ bond active port │
6613 │ │ │ │ re-selection │
6614 │ │ │ │ during failover. │
6615 │ │ │ │ A higher number │
6616 │ │ │ │ means a higher │
6617 │ │ │ │ priority in │
6618 │ │ │ │ selection. The │
6619 │ │ │ │ primary port has │
6620 │ │ │ │ the highest │
6621 │ │ │ │ priority. This │
6622 │ │ │ │ option is only │
6623 │ │ │ │ compatible with │
6624 │ │ │ │ active-backup, │
6625 │ │ │ │ balance-tlb and │
6626 │ │ │ │ balance-alb │
6627 │ │ │ │ modes. │
6628 ├─────────┼────────────┼───────────────┼──────────────────┤
6629 │queue-id │ uint32 │ 0 │ The queue ID of │
6630 │ │ │ │ this bond port. │
6631 │ │ │ │ The maximum │
6632 │ │ │ │ value of queue │
6633 │ │ │ │ ID is the number │
6634 │ │ │ │ of TX queues │
6635 │ │ │ │ currently active │
6636 │ │ │ │ in device. │
6637 └─────────┴────────────┴───────────────┴──────────────────┘
6638 hostname setting
6640 Hostname settings.
6641 ┌──────────────────┬────────────┬───────────────┬────────────────────┐
6643 │Key Name │ Value Type │ Default Value │ Value │
6644 │ │ │ │ Description │
6645 ├──────────────────┼────────────┼───────────────┼────────────────────┤
6646 │from-dhcp │ NMTernary │ │ Whether the │
6647 │ │ (int32) │ │ system hostname │
6648 │ │ │ │ can be │
6649 │ │ │ │ determined from │
6650 │ │ │ │ DHCP on this │
6651 │ │ │ │ connection. │
6652 │ │ │ │ │
6653 │ │ │ │ When set to │
6654 │ │ │ │ NM_TERNARY_DEFAULT │
6655 │ │ │ │ (-1), the value │
6656 │ │ │ │ from global │
6657 │ │ │ │ configuration is │
6658 │ │ │ │ used. If the │
6659 │ │ │ │ property doesn't │
6660 │ │ │ │ have a value in │
6661 │ │ │ │ the global │
6662 │ │ │ │ configuration, │
6663 │ │ │ │ NetworkManager │
6664 │ │ │ │ assumes the │
6665 │ │ │ │ value to be │
6666 │ │ │ │ NM_TERNARY_TRUE │
6667 │ │ │ │ (1). │
6668 ├──────────────────┼────────────┼───────────────┼────────────────────┤
6669 │from-dns-lookup │ NMTernary │ │ Whether the system │
6670 │ │ (int32) │ │ hostname can be │
6671 │ │ │ │ determined from │
6672 │ │ │ │ reverse DNS lookup │
6673 │ │ │ │ of addresses on │
6674 │ │ │ │ this device. │
6675 │ │ │ │ │
6676 │ │ │ │ When set to │
6677 │ │ │ │ NM_TERNARY_DEFAULT │
6678 │ │ │ │ (-1), the value │
6679 │ │ │ │ from global │
6680 │ │ │ │ configuration is │
6681 │ │ │ │ used. If the │
6682 │ │ │ │ property doesn't │
6683 │ │ │ │ have a value in │
6684 │ │ │ │ the global │
6685 │ │ │ │ configuration, │
6686 │ │ │ │ NetworkManager │
6687 │ │ │ │ assumes the value │
6688 │ │ │ │ to be │
6689 │ │ │ │ NM_TERNARY_TRUE │
6690 │ │ │ │ (1). │
6691 ├──────────────────┼────────────┼───────────────┼────────────────────┤
6692 │only-from-default │ NMTernary │ │ If set to │
6693 │ │ (int32) │ │ NM_TERNARY_TRUE │
6694 │ │ │ │ (1), │
6695 │ │ │ │ NetworkManager │
6696 │ │ │ │ attempts to get │
6697 │ │ │ │ the hostname via │
6698 │ │ │ │ DHCPv4/DHCPv6 or │
6699 │ │ │ │ reverse DNS lookup │
6700 │ │ │ │ on this device │
6701 │ │ │ │ only when the │
6702 │ │ │ │ device has the │
6703 │ │ │ │ default route for │
6704 │ │ │ │ the given address │
6705 │ │ │ │ family │
6706 │ │ │ │ (IPv4/IPv6). │
6707 │ │ │ │ │
6708 │ │ │ │ If set to │
6709 │ │ │ │ NM_TERNARY_FALSE │
6710 │ │ │ │ (0), the hostname │
6711 │ │ │ │ can be set from │
6712 │ │ │ │ this device even │
6713 │ │ │ │ if it doesn't have │
6714 │ │ │ │ the default route. │
6715 │ │ │ │ │
6716 │ │ │ │ When set to │
6717 │ │ │ │ NM_TERNARY_DEFAULT │
6718 │ │ │ │ (-1), the value │
6719 │ │ │ │ from global │
6720 │ │ │ │ configuration is │
6721 │ │ │ │ used. If the │
6722 │ │ │ │ property doesn't │
6723 │ │ │ │ have a value in │
6724 │ │ │ │ the global │
6725 │ │ │ │ configuration, │
6726 │ │ │ │ NetworkManager │
6727 │ │ │ │ assumes the value │
6728 │ │ │ │ to be │
6729 │ │ │ │ NM_TERNARY_FALSE │
6730 │ │ │ │ (0). │
6731 ├──────────────────┼────────────┼───────────────┼────────────────────┤
6732 │priority │ int32 │ 0 │ The relative │
6733 │ │ │ │ priority of this │
6734 │ │ │ │ connection to │
6735 │ │ │ │ determine the │
6736 │ │ │ │ system hostname. A │
6737 │ │ │ │ lower numerical │
6738 │ │ │ │ value is better │
6739 │ │ │ │ (higher priority). │
6740 │ │ │ │ A connection with │
6741 │ │ │ │ higher priority is │
6742 │ │ │ │ considered before │
6743 │ │ │ │ connections with │
6744 │ │ │ │ lower priority. │
6745 │ │ │ │ │
6746 │ │ │ │ If the value is │
6747 │ │ │ │ zero, it can be │
6748 │ │ │ │ overridden by a │
6749 │ │ │ │ global value from │
6750 │ │ │ │ NetworkManager │
6751 │ │ │ │ configuration. If │
6752 │ │ │ │ the property │
6753 │ │ │ │ doesn't have a │
6754 │ │ │ │ value in the │
6755 │ │ │ │ global │
6756 │ │ │ │ configuration, the │
6757 │ │ │ │ value is assumed │
6758 │ │ │ │ to be 100. │
6759 │ │ │ │ │
6760 │ │ │ │ Negative values │
6761 │ │ │ │ have the special │
6762 │ │ │ │ effect of │
6763 │ │ │ │ excluding other │
6764 │ │ │ │ connections with a │
6765 │ │ │ │ greater numerical │
6766 │ │ │ │ priority value; so │
6767 │ │ │ │ in presence of at │
6768 │ │ │ │ least one negative │
6769 │ │ │ │ priority, only │
6770 │ │ │ │ connections with │
6771 │ │ │ │ the lowest │
6772 │ │ │ │ priority value │
6773 │ │ │ │ will be used to │
6774 │ │ │ │ determine the │
6775 │ │ │ │ hostname. │
6776 └──────────────────┴────────────┴───────────────┴────────────────────┘
6777 loopback setting
6779 Loopback Link Settings.
6780 ┌─────────┬────────────┬───────────────┬──────────────────┐
6782 │Key Name │ Value Type │ Default Value │ Value │
6783 │ │ │ │ Description │
6784 ├─────────┼────────────┼───────────────┼──────────────────┤
6785 │mtu │ uint32 │ 0 │ If non-zero, │
6786 │ │ │ │ only transmit │
6787 │ │ │ │ packets of the │
6788 │ │ │ │ specified size │
6789 │ │ │ │ or smaller, │
6790 │ │ │ │ breaking larger │
6791 │ │ │ │ packets up into │
6792 │ │ │ │ multiple │
6793 │ │ │ │ Ethernet frames. │
6794 └─────────┴────────────┴───────────────┴──────────────────┘
6795 ovs-external-ids setting
6797 OVS External IDs Settings.
6798 ┌─────────┬────────────────┬───────────────┬──────────────────┐
6800 │Key Name │ Value Type │ Default Value │ Value │
6801 │ │ │ │ Description │
6802 ├─────────┼────────────────┼───────────────┼──────────────────┤
6803 │data │ dict of string │ {} │ A dictionary of │
6804 │ │ to string │ │ key/value pairs │
6805 │ │ │ │ with │
6806 │ │ │ │ external-ids for │
6807 │ │ │ │ OVS. │
6808 └─────────┴────────────────┴───────────────┴──────────────────┘
6809 ovs-other-config setting
6811 OVS Other Config Settings.
6812 ┌─────────┬────────────────┬───────────────┬────────────────────────┐
6814 │Key Name │ Value Type │ Default Value │ Value │
6815 │ │ │ │ Description │
6816 ├─────────┼────────────────┼───────────────┼────────────────────────┤
6817 │data │ dict of string │ {} │ A dictionary of │
6818 │ │ to string │ │ key/value pairs │
6819 │ │ │ │ with │
6820 │ │ │ │ other_config │
6821 │ │ │ │ settings for │
6822 │ │ │ │ OVS. See also │
6823 │ │ │ │ "other_config" │
6824 │ │ │ │ in the │
6825 │ │ │ │ "ovs-vswitchd.conf.db" │
6826 │ │ │ │ manual for the │
6827 │ │ │ │ keys that OVS │
6828 │ │ │ │ supports. │
6829 └─────────┴────────────────┴───────────────┴────────────────────────┘
6830 veth setting
6832 Veth Settings.
6833 ┌─────────┬────────────┬───────────────┬────────────────┐
6835 │Key Name │ Value Type │ Default Value │ Value │
6836 │ │ │ │ Description │
6837 ├─────────┼────────────┼───────────────┼────────────────┤
6838 │peer │ string │ │ This property │
6839 │ │ │ │ specifies the │
6840 │ │ │ │ peer interface │
6841 │ │ │ │ name of the │
6842 │ │ │ │ veth. This │
6843 │ │ │ │ property is │
6844 │ │ │ │ mandatory. │
6845 └─────────┴────────────┴───────────────┴────────────────┘
6846 Secret flag types:
6848 Each password or secret property in a setting has an associated flags
6849 property that describes how to handle that secret. The flags property
6850 is a bitfield that contains zero or more of the following values
6851 logically OR-ed together.
6852 • 0x0 (none) - the system is responsible for providing and storing
6854 this secret. This may be required so that secrets are already
6855 available before the user logs in. It also commonly means that the
6856 secret will be stored in plain text on disk, accessible to root
6857 only. For example via the keyfile settings plugin as described in
6858 the "PLUGINS" section in NetworkManager.conf(5).
6859 • 0x1 (agent-owned) - a user-session secret agent is responsible for
6861 providing and storing this secret; when it is required, agents will
6862 be asked to provide it.
6863 • 0x2 (not-saved) - this secret should not be saved but should be
6865 requested from the user each time it is required. This flag should
6866 be used for One-Time-Pad secrets, PIN codes from hardware tokens,
6867 or if the user simply does not want to save the secret.
6868 • 0x4 (not-required) - in some situations it cannot be automatically
6870 determined that a secret is required or not. This flag hints that
6871 the secret is not required and should not be requested from the
6872 user.
6873
6875 /etc/NetworkManager/system-connections or distro plugin-specific
6876 location
6877
6879 nm-settings-nmcli(5), nm-settings-keyfile(5), NetworkManager(8),
6880 nmcli(1), nmcli-examples(7), NetworkManager.conf(5)
6881NetworkManager 1.42.8 NM-SETTINGS-DBUS(5)