Debian Codegraph @

upstream/debian-unstable/man5/systemd.network.5

raw
1 '\" t
2 .TH "SYSTEMD\&.NETWORK" "5" "" "systemd 261~rc3" "systemd.network"
3 .\" -----------------------------------------------------------------
4 .\" * Define some portability stuff
5 .\" -----------------------------------------------------------------
6 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
7 .\" http://bugs.debian.org/507673
8 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
9 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
10 .ie \n(.g .ds Aq \(aq
11 .el .ds Aq '
12 .\" -----------------------------------------------------------------
13 .\" * set default formatting
14 .\" -----------------------------------------------------------------
15 .\" disable hyphenation
16 .nh
17 .\" disable justification (adjust text to left margin only)
18 .ad l
19 .\" -----------------------------------------------------------------
20 .\" * MAIN CONTENT STARTS HERE *
21 .\" -----------------------------------------------------------------
22 .SH "NAME"
23 systemd.network \- Network configuration
24 .SH "SYNOPSIS"
25 .PP
26 \fInetwork\fR\&.network
27 .SH "DESCRIPTION"
28 .PP
29 A plain ini\-style text file that encodes network configuration for matching network interfaces, used by
30 \fBsystemd-networkd\fR(8)\&. See
31 \fBsystemd.syntax\fR(7)
32 for a general description of the syntax\&.
33 .PP
34 The main network file must have the extension
35 \&.network; other extensions are ignored\&. Networks are applied to links whenever the links appear\&.
36 .PP
37 Note that not all settings and configurations can be made with
38 \&.network
39 files, and that it may be necessary to use
40 \fBsystemd.link\fR(5)) or
41 \fBsystemd.netdev\fR(5)) files in conjunction with
42 \&.network
43 files when working with physical and virtual network devices respectively\&.
44 .PP
45 The
46 \&.network
47 files are read from the files located in the system network directories
48 /usr/lib/systemd/network
49 and
50 /usr/local/lib/systemd/network
51 \&\s-2\u[1]\d\s+2, the volatile runtime network directory
52 /run/systemd/network
53 and the local administration network directory
54 /etc/systemd/network\&. All configuration files are collectively sorted and processed in alphanumeric order, regardless of the directories in which they live\&. However, files with identical filenames replace each other\&. It is recommended that each filename is prefixed with a number smaller than
55 "70"
56 (e\&.g\&.
57 10\-eth0\&.network)\&. Otherwise, the default
58 \&.network
59 files or those generated by
60 \fBsystemd-network-generator.service\fR(8)
61 may take precedence over user configured files\&. Files in
62 /etc/
63 have the highest priority, files in
64 /run/
65 take precedence over files with the same name under
66 /usr/\&. This can be used to override a system\-supplied configuration file with a local file if needed\&. As a special case, an empty file (file size 0) or symlink with the same name pointing to
67 /dev/null
68 disables the configuration file entirely (it is "masked")\&.
69 .PP
70 Along with the network file
71 foo\&.network, a "drop\-in" directory
72 foo\&.network\&.d/
73 may exist\&. All files with the suffix
74 "\&.conf"
75 from this directory will be merged in the alphanumeric order and parsed after the main file itself has been parsed\&. This is useful to alter or add configuration settings, without having to modify the main configuration file\&. Each drop\-in file must have appropriate section headers\&.
76 .PP
77 In addition to
78 /etc/systemd/network, drop\-in
79 "\&.d"
80 directories can be placed in
81 /usr/lib/systemd/network
82 or
83 /run/systemd/network
84 directories\&. Drop\-in files in
85 /etc/
86 take precedence over those in
87 /run/
88 which in turn take precedence over those in
89 /usr/lib/\&. Drop\-in files under any of these directories take precedence over the main network file wherever located\&.
90 .SH "[MATCH] SECTION OPTIONS"
91 .PP
92 The network file contains a [Match] section, which determines if a given network file may be applied to a given interface; and a [Network] section specifying how the interface should be configured\&. The first (in alphanumeric order) of the network files that matches a given interface is applied, all later files are ignored, even if they match as well\&.
93 .PP
94 Note that any network interfaces that have the
95 \fIID_NET_MANAGED_BY=\fR
96 udev property set will never be matched by any \&.network files \(en unless the property\*(Aqs value is the string
97 "io\&.systemd\&.Network"
98 \(en even if the [Match] section would otherwise match\&. This may be used to exclude specific network interfaces from
99 \fBsystemd-networkd\fR(8)\*(Aqs management, while keeping the [Match] section generic\&. The
100 \fIID_NET_MANAGED_BY=\fR
101 property thus declares intended
102 \fIownership\fR
103 of the device, and permits ensuring that concurrent network management implementations do not compete for management of specific devices\&.
104 .PP
105 A network file is said to match a network interface if all matches specified by the [Match] section are satisfied\&. When a network file does not contain valid settings in [Match] section, then the file will match all interfaces and
106 \fBsystemd\-networkd\fR
107 warns about that\&. Hint: to avoid the warning and to make it clear that all interfaces shall be matched, add the following:
108 .sp
109 .if n \{\
110 .RS 4
111 .\}
112 .nf
113 Name=*
114 .fi
115 .if n \{\
116 .RE
117 .\}
118 .sp
119 The following keys are accepted:
120 .PP
121 \fIMACAddress=\fR
122 .RS 4
123 A whitespace\-separated list of hardware addresses\&. The acceptable formats are:
124 .PP
125 \fBcolon\-delimited hexadecimal\fR
126 .RS 4
127 Each field must be one byte\&. E\&.g\&.
128 "12:34:56:78:90:ab"
129 or
130 "AA:BB:CC:DD:EE:FF"\&.
131 .sp
132 Added in version 250\&.
133 .RE
134 .PP
135 \fBhyphen\-delimited hexadecimal\fR
136 .RS 4
137 Each field must be one byte\&. E\&.g\&.
138 "12\-34\-56\-78\-90\-ab"
139 or
140 "AA\-BB\-CC\-DD\-EE\-FF"\&.
141 .sp
142 Added in version 250\&.
143 .RE
144 .PP
145 \fBdot\-delimited hexadecimal\fR
146 .RS 4
147 Each field must be two bytes\&. E\&.g\&.
148 "1234\&.5678\&.90ab"
149 or
150 "AABB\&.CCDD\&.EEFF"\&.
151 .sp
152 Added in version 250\&.
153 .RE
154 .PP
155 \fBIPv4 address format\fR
156 .RS 4
157 E\&.g\&.
158 "127\&.0\&.0\&.1"
159 or
160 "192\&.168\&.0\&.1"\&.
161 .sp
162 Added in version 250\&.
163 .RE
164 .PP
165 \fBIPv6 address format\fR
166 .RS 4
167 E\&.g\&.
168 "2001:0db8:85a3::8a2e:0370:7334"
169 or
170 "::1"\&.
171 .sp
172 Added in version 250\&.
173 .RE
174 .sp
175 The total length of each MAC address must be 4 (for IPv4 tunnel), 6 (for Ethernet), 16 (for IPv6 tunnel), or 20 (for InfiniBand)\&. This option may appear more than once, in which case the lists are merged\&. If the empty string is assigned to this option, the list of hardware addresses defined prior to this is reset\&. Defaults to unset\&.
176 .sp
177 Added in version 211\&.
178 .RE
179 .PP
180 \fIPermanentMACAddress=\fR
181 .RS 4
182 A whitespace\-separated list of hardware\*(Aqs permanent addresses\&. While
183 \fIMACAddress=\fR
184 matches the device\*(Aqs current MAC address, this matches the device\*(Aqs permanent MAC address, which may be different from the current one\&. Use full colon\-, hyphen\- or dot\-delimited hexadecimal, or IPv4 or IPv6 address format\&. This option may appear more than once, in which case the lists are merged\&. If the empty string is assigned to this option, the list of hardware addresses defined prior to this is reset\&. Defaults to unset\&.
185 .sp
186 Added in version 245\&.
187 .RE
188 .PP
189 \fIPath=\fR
190 .RS 4
191 A whitespace\-separated list of shell\-style globs matching the persistent path, as exposed by the udev property
192 \fIID_PATH\fR\&.
193 .sp
194 Added in version 211\&.
195 .RE
196 .PP
197 \fIDriver=\fR
198 .RS 4
199 A whitespace\-separated list of shell\-style globs matching the driver currently bound to the device, as exposed by the udev property
200 \fIID_NET_DRIVER\fR
201 of its parent device, or if that is not set, the driver as exposed by
202 \fBethtool \-i\fR
203 of the device itself\&. If the list is prefixed with a "!", the test is inverted\&.
204 .sp
205 Added in version 211\&.
206 .RE
207 .PP
208 \fIType=\fR
209 .RS 4
210 A whitespace\-separated list of shell\-style globs matching the device type, as exposed by
211 \fBnetworkctl list\fR\&. If the list is prefixed with a "!", the test is inverted\&. Some valid values are
212 "ether",
213 "loopback",
214 "wlan",
215 "wwan"\&. Valid types are named either from the udev
216 "DEVTYPE"
217 attribute, or
218 "ARPHRD_"
219 macros in
220 linux/if_arp\&.h, so this is not comprehensive\&.
221 .sp
222 Added in version 211\&.
223 .RE
224 .PP
225 \fIKind=\fR
226 .RS 4
227 A whitespace\-separated list of shell\-style globs matching the device kind, as exposed by
228 \fBnetworkctl status \fR\fB\fIINTERFACE\fR\fR
229 or
230 \fBip \-d link show \fR\fB\fIINTERFACE\fR\fR\&. If the list is prefixed with a "!", the test is inverted\&. Some valid values are
231 "bond",
232 "bridge",
233 "gre",
234 "tun",
235 "veth"\&. Valid kinds are given by netlink\*(Aqs
236 "IFLA_INFO_KIND"
237 attribute, so this is not comprehensive\&.
238 .sp
239 Added in version 251\&.
240 .RE
241 .PP
242 \fIProperty=\fR
243 .RS 4
244 A whitespace\-separated list of udev property names with their values after equals sign ("=")\&. If multiple properties are specified, the test results are ANDed\&. If the list is prefixed with a "!", the test is inverted\&. If a value contains white spaces, then please quote whole key and value pair\&. If a value contains quotation, then please escape the quotation with
245 "\e"\&.
246 .sp
247 Example: if a \&.link file has the following:
248 .sp
249 .if n \{\
250 .RS 4
251 .\}
252 .nf
253 Property=ID_MODEL_ID=9999 "ID_VENDOR_FROM_DATABASE=vendor name" "KEY=with \e"quotation\e""
254 .fi
255 .if n \{\
256 .RE
257 .\}
258 .sp
259 then, the \&.link file matches only when an interface has all the above three properties\&.
260 .sp
261 Added in version 243\&.
262 .RE
263 .PP
264 \fIName=\fR
265 .RS 4
266 A whitespace\-separated list of shell\-style globs matching the device name, as exposed by the udev property
267 "INTERFACE", or device\*(Aqs alternative names\&. If the list is prefixed with a "!", the test is inverted\&.
268 .sp
269 Added in version 211\&.
270 .RE
271 .PP
272 \fIWLANInterfaceType=\fR
273 .RS 4
274 A whitespace\-separated list of wireless network type\&. Supported values are
275 "ad\-hoc",
276 "station",
277 "ap",
278 "ap\-vlan",
279 "wds",
280 "monitor",
281 "mesh\-point",
282 "p2p\-client",
283 "p2p\-go",
284 "p2p\-device",
285 "ocb", and
286 "nan"\&. If the list is prefixed with a "!", the test is inverted\&.
287 .sp
288 Added in version 244\&.
289 .RE
290 .PP
291 \fISSID=\fR
292 .RS 4
293 A whitespace\-separated list of shell\-style globs matching the SSID of the currently connected wireless LAN\&. If the list is prefixed with a "!", the test is inverted\&.
294 .sp
295 Added in version 244\&.
296 .RE
297 .PP
298 \fIBSSID=\fR
299 .RS 4
300 A whitespace\-separated list of hardware address of the currently connected wireless LAN\&. Use full colon\-, hyphen\- or dot\-delimited hexadecimal\&. See the example in
301 \fIMACAddress=\fR\&. This option may appear more than once, in which case the lists are merged\&. If the empty string is assigned to this option, the list is reset\&.
302 .sp
303 Added in version 244\&.
304 .RE
305 .PP
306 \fIHost=\fR
307 .RS 4
308 Matches against the hostname or machine ID of the host\&. See
309 \fIConditionHost=\fR
310 in
311 \fBsystemd.unit\fR(5)
312 for details\&. When prefixed with an exclamation mark ("!"), the result is negated\&. If an empty string is assigned, the previously assigned value is cleared\&.
313 .sp
314 Added in version 211\&.
315 .RE
316 .PP
317 \fIVirtualization=\fR
318 .RS 4
319 Checks whether the system is executed in a virtualized environment and optionally test whether it is a specific implementation\&. See
320 \fIConditionVirtualization=\fR
321 in
322 \fBsystemd.unit\fR(5)
323 for details\&. When prefixed with an exclamation mark ("!"), the result is negated\&. If an empty string is assigned, the previously assigned value is cleared\&.
324 .sp
325 Added in version 211\&.
326 .RE
327 .PP
328 \fIKernelCommandLine=\fR
329 .RS 4
330 Checks whether a specific kernel command line option is set\&. See
331 \fIConditionKernelCommandLine=\fR
332 in
333 \fBsystemd.unit\fR(5)
334 for details\&. When prefixed with an exclamation mark ("!"), the result is negated\&. If an empty string is assigned, the previously assigned value is cleared\&.
335 .sp
336 Added in version 211\&.
337 .RE
338 .PP
339 \fIKernelVersion=\fR
340 .RS 4
341 Checks whether the kernel version (as reported by
342 \fBuname \-r\fR) matches a certain expression\&. See
343 \fIConditionKernelVersion=\fR
344 in
345 \fBsystemd.unit\fR(5)
346 for details\&. When prefixed with an exclamation mark ("!"), the result is negated\&. If an empty string is assigned, the previously assigned value is cleared\&.
347 .sp
348 Added in version 237\&.
349 .RE
350 .PP
351 \fIVersion=\fR
352 .RS 4
353 Checks whether a software version matches a certain expression\&. See
354 \fIConditionVersion=\fR
355 in
356 \fBsystemd.unit\fR(5)
357 for details\&. When prefixed with an exclamation mark ("!"), the result is negated\&. If an empty string is assigned, the previously assigned value is cleared\&.
358 .sp
359 Added in version 258\&.
360 .RE
361 .PP
362 \fICredential=\fR
363 .RS 4
364 Checks whether the specified credential was passed to the
365 systemd\-udevd\&.service
366 service\&. See
367 \m[blue]\fBSystem and Service Credentials\fR\m[]\&\s-2\u[2]\d\s+2
368 for details\&. When prefixed with an exclamation mark ("!"), the result is negated\&. If an empty string is assigned, the previously assigned value is cleared\&.
369 .sp
370 Added in version 252\&.
371 .RE
372 .PP
373 \fIArchitecture=\fR
374 .RS 4
375 Checks whether the system is running on a specific architecture\&. See
376 \fIConditionArchitecture=\fR
377 in
378 \fBsystemd.unit\fR(5)
379 for details\&. When prefixed with an exclamation mark ("!"), the result is negated\&. If an empty string is assigned, the previously assigned value is cleared\&.
380 .sp
381 Added in version 211\&.
382 .RE
383 .PP
384 \fIFirmware=\fR
385 .RS 4
386 Checks whether the system is running on a machine with the specified firmware\&. See
387 \fIConditionFirmware=\fR
388 in
389 \fBsystemd.unit\fR(5)
390 for details\&. When prefixed with an exclamation mark ("!"), the result is negated\&. If an empty string is assigned, the previously assigned value is cleared\&.
391 .sp
392 Added in version 249\&.
393 .RE
394 .SH "[LINK] SECTION OPTIONS"
395 .PP
396 The [Link] section accepts the following keys:
397 .PP
398 \fIMACAddress=\fR
399 .RS 4
400 The hardware address to set for the device\&.
401 .sp
402 Added in version 218\&.
403 .RE
404 .PP
405 \fIMTUBytes=\fR
406 .RS 4
407 The maximum transmission unit in bytes to set for the device\&. The usual suffixes K, M, G, are supported and are understood to the base of 1024\&.
408 .sp
409 Note that if IPv6 is enabled on the interface, and the MTU is chosen below 1280 (the minimum MTU for IPv6) it will automatically be increased to this value\&.
410 .sp
411 Added in version 218\&.
412 .RE
413 .PP
414 \fIARP=\fR
415 .RS 4
416 Takes a boolean\&. If set to true, the IPv4 ARP (low\-level Address Resolution Protocol) and IPv6 NDP (Neighbor Discovery Protocol) for this interface are enabled\&. For example, disabling ARP is useful when creating multiple MACVLAN or VLAN virtual interfaces atop a single lower\-level physical interface, which will then only serve as a link/"bridge" device aggregating traffic to the same physical link and not participate in the network otherwise\&. Defaults to unset, and enabled when the IPv4 link\-local addressing is enabled in
417 \fILinkLocalAddressing=\fR
418 or an IPv4 address with
419 \fIDuplicateAddressDetection=\fR
420 enabled is requested\&. Otherwise, the kernel\*(Aqs default will be used\&.
421 .sp
422 Added in version 232\&.
423 .RE
424 .PP
425 \fIMulticast=\fR
426 .RS 4
427 Takes a boolean\&. If set to true, the multicast flag on the device is enabled\&. Defaults to unset and the flag is unchanged\&. When disabled,
428 \fIIPv6AcceptRA=\fR
429 and
430 \fIIPv6SendRA=\fR
431 cannot be enabled\&.
432 .sp
433 Added in version 239\&.
434 .RE
435 .PP
436 \fIAllMulticast=\fR
437 .RS 4
438 Takes a boolean\&. If set to true, the driver retrieves all multicast packets from the network\&. This happens when multicast routing is enabled\&. Defaults to unset\&.
439 .sp
440 Added in version 239\&.
441 .RE
442 .PP
443 \fIPromiscuous=\fR
444 .RS 4
445 Takes a boolean\&. If set to true, promiscuous mode of the interface is enabled\&. Defaults to unset\&.
446 .sp
447 If this is set to false for the underlying link of a
448 "passthru"
449 mode MACVLAN/MACVTAP, the virtual interface will be created with the
450 "nopromisc"
451 flag set\&.
452 .sp
453 Added in version 248\&.
454 .RE
455 .PP
456 \fIUnmanaged=\fR
457 .RS 4
458 Takes a boolean\&. When
459 "yes", no attempts are made to bring up or configure matching links, equivalent to when there are no matching network files\&. Defaults to
460 "no"\&.
461 .sp
462 This is useful for preventing later matching network files from interfering with certain interfaces that are fully controlled by other applications\&.
463 .sp
464 Added in version 233\&.
465 .RE
466 .PP
467 \fIGroup=\fR
468 .RS 4
469 Link groups are similar to port ranges found in managed switches\&. When network interfaces are added to a numbered group, operations on all the interfaces from that group can be performed at once\&. Takes an unsigned integer in the range 0\&...2147483647\&. Defaults to unset\&.
470 .sp
471 Added in version 246\&.
472 .RE
473 .PP
474 \fIRequiredForOnline=\fR
475 .RS 4
476 Takes a boolean, a minimum operational state (e\&.g\&.,
477 "carrier"), or a range of operational state separated with a colon (e\&.g\&.,
478 "degraded:routable")\&. Please see
479 \fBnetworkctl\fR(1)
480 for possible operational states\&. When
481 "yes", the network is deemed required when determining whether the system is online (including when running
482 \fBsystemd\-networkd\-wait\-online\fR)\&. When
483 "no", the network is ignored when determining the online state\&. When a minimum operational state and an optional maximum operational state are set,
484 \fBsystemd\-networkd\-wait\-online\fR
485 deems that the interface is online when the operational state is in the specified range\&.
486 .sp
487 Defaults to
488 "yes"
489 when
490 \fIActivationPolicy=\fR
491 is not set, or set to
492 "up",
493 "always\-up", or
494 "bound"\&. Defaults to
495 "no"
496 when
497 \fIActivationPolicy=\fR
498 is set to
499 "manual"
500 or
501 "down"\&. This is forced to
502 "no"
503 when
504 \fIActivationPolicy=\fR
505 is set to
506 "always\-down"\&.
507 .sp
508 The network will be brought up normally (as configured by
509 \fIActivationPolicy=\fR), but in the event that there is no address being assigned by DHCP or the cable is not plugged in, the link will simply remain offline and be skipped automatically by
510 \fBsystemd\-networkd\-wait\-online\fR
511 if
512 "RequiredForOnline=no"\&.
513 .sp
514 The boolean value
515 "yes"
516 is translated as follows;
517 .PP
518 \fBCAN devices\fR
519 .RS 4
520 "carrier",
521 .sp
522 Added in version 256\&.
523 .RE
524 .PP
525 \fBMaster devices, e\&.g\&. bond or bridge\fR
526 .RS 4
527 "degraded\-carrier"
528 with
529 \fIRequiredFamilyForOnline=any\fR,
530 .sp
531 Added in version 256\&.
532 .RE
533 .PP
534 \fBBonding port interfaces\fR
535 .RS 4
536 "enslaved",
537 .sp
538 Added in version 256\&.
539 .RE
540 .PP
541 \fBOther interfaces\fR
542 .RS 4
543 "degraded"\&.
544 .sp
545 Added in version 236\&.
546 .RE
547 .sp
548 This setting can be overridden by the command line option for
549 \fBsystemd\-networkd\-wait\-online\fR\&. See
550 \fBsystemd-networkd-wait-online.service\fR(8)
551 for more details\&.
552 .sp
553 Added in version 236\&.
554 .RE
555 .PP
556 \fIRequiredFamilyForOnline=\fR
557 .RS 4
558 Takes an address family\&. When specified, an IP address in the given family is deemed required when determining whether the link is online (including when running
559 \fBsystemd\-networkd\-wait\-online\fR)\&. Takes one of
560 "ipv4",
561 "ipv6",
562 "both", or
563 "any"\&. Defaults to
564 "no"\&. Note that this option has no effect if
565 "RequiredForOnline=no"\&.
566 .sp
567 Added in version 249\&.
568 .RE
569 .PP
570 \fIActivationPolicy=\fR
571 .RS 4
572 Specifies the policy for
573 \fBsystemd\-networkd\fR
574 managing the link administrative state\&. Specifically, this controls how
575 \fBsystemd\-networkd\fR
576 changes the network device\*(Aqs
577 "IFF_UP"
578 flag, which is sometimes controlled by system administrators by running e\&.g\&.,
579 \fBip link set dev eth0 up\fR
580 or
581 \fBip link set dev eth0 down\fR, and can also be changed with
582 \fBnetworkctl up eth0\fR
583 or
584 \fBnetworkctl down eth0\fR\&.
585 .sp
586 Takes one of
587 "up",
588 "always\-up",
589 "manual",
590 "always\-down",
591 "down", or
592 "bound"\&. When
593 "manual",
594 \fBsystemd\-networkd\fR
595 will not change the link\*(Aqs admin state automatically; the system administrator must bring the interface up or down manually, as desired\&. When
596 "up"
597 (the default) or
598 "always\-up", or
599 "down"
600 or
601 "always\-down",
602 \fBsystemd\-networkd\fR
603 will set the link up or down, respectively, when the interface is (re)configured\&. When
604 "always\-up"
605 or
606 "always\-down",
607 \fBsystemd\-networkd\fR
608 will set the link up or down, respectively, any time
609 \fBsystemd\-networkd\fR
610 detects a change in the administrative state\&. When
611 \fIBindCarrier=\fR
612 is also set, this is automatically set to
613 "bound"
614 and any other value is ignored\&.
615 .sp
616 When the policy is set to
617 "down"
618 or
619 "manual", the default value of
620 \fIRequiredForOnline=\fR
621 is
622 "no"\&. When the policy is set to
623 "always\-down", the value of
624 \fIRequiredForOnline=\fR
625 forced to
626 "no"\&.
627 .sp
628 The administrative state is not the same as the carrier state, so using
629 "always\-up"
630 does not mean the link will never lose carrier\&. The link carrier depends on both the administrative state as well as the network device\*(Aqs physical connection\&. However, to avoid reconfiguration failures, when using
631 "always\-up",
632 \fIIgnoreCarrierLoss=\fR
633 is forced to true\&.
634 .sp
635 Added in version 248\&.
636 .RE
637 .SH "[SR\-IOV] SECTION OPTIONS"
638 .PP
639 SR\-IOV provides the ability to partition a single physical PCI resource into virtual PCI functions which can then be e\&.g\&. injected into a VM\&. In the case of network VFs, SR\-IOV reduces latency and CPU utilisation for north\-south network traffic (that is, traffic with endpoints outside the host machine), by allowing traffic to bypass the host machine\(cqs network stack\&.
640 .PP
641 The presence of an [SR\-IOV] section in a \&.link file will cause the creation and configuration of the specified virtual function\&. Within a \&.network file, the specified virtual function will be configured, but must already exist\&. Specify several [SR\-IOV] sections to configure several SR\-IOVs\&.
642 .PP
643 The [SR\-IOV] section accepts the following keys\&.
644 .PP
645 \fIVirtualFunction=\fR
646 .RS 4
647 Specifies a Virtual Function (VF), lightweight PCIe function designed solely to move data in and out\&. Takes an integer in the range 0\&...2147483646\&. This option is compulsory\&.
648 .sp
649 Added in version 251\&.
650 .RE
651 .PP
652 \fIVLANId=\fR
653 .RS 4
654 Specifies VLAN ID of the virtual function\&. Takes an integer in the range 1\&...4095\&.
655 .sp
656 Added in version 251\&.
657 .RE
658 .PP
659 \fIQualityOfService=\fR
660 .RS 4
661 Specifies quality of service of the virtual function\&. Takes an integer in the range 1\&...4294967294\&.
662 .sp
663 Added in version 251\&.
664 .RE
665 .PP
666 \fIVLANProtocol=\fR
667 .RS 4
668 Specifies VLAN protocol of the virtual function\&. Takes
669 "802\&.1Q"
670 or
671 "802\&.1ad"\&.
672 .sp
673 Added in version 251\&.
674 .RE
675 .PP
676 \fIMACSpoofCheck=\fR
677 .RS 4
678 Takes a boolean\&. Controls the MAC spoof checking\&. When unset, the kernel\*(Aqs default will be used\&.
679 .sp
680 Added in version 251\&.
681 .RE
682 .PP
683 \fIQueryReceiveSideScaling=\fR
684 .RS 4
685 Takes a boolean\&. Toggle the ability of querying the receive side scaling (RSS) configuration of the virtual function (VF)\&. The VF RSS information like RSS hash key may be considered sensitive on some devices where this information is shared between VF and the physical function (PF)\&. When unset, the kernel\*(Aqs default will be used\&.
686 .sp
687 Added in version 251\&.
688 .RE
689 .PP
690 \fITrust=\fR
691 .RS 4
692 Takes a boolean\&. Allows one to set trust mode of the virtual function (VF)\&. When set, VF users can set a specific feature which may impact security and/or performance\&. When unset, the kernel\*(Aqs default will be used\&.
693 .sp
694 Added in version 251\&.
695 .RE
696 .PP
697 \fILinkState=\fR
698 .RS 4
699 Allows one to set the link state of the virtual function (VF)\&. Takes a boolean or a special value
700 "auto"\&. Setting to
701 "auto"
702 means a reflection of the physical function (PF) link state,
703 "yes"
704 lets the VF to communicate with other VFs on this host even if the PF link state is down,
705 "no"
706 causes the hardware to drop any packets sent by the VF\&. When unset, the kernel\*(Aqs default will be used\&.
707 .sp
708 Added in version 251\&.
709 .RE
710 .PP
711 \fIMACAddress=\fR
712 .RS 4
713 Specifies the MAC address for the virtual function\&.
714 .sp
715 Added in version 251\&.
716 .RE
717 .SH "[NETWORK] SECTION OPTIONS"
718 .PP
719 The [Network] section accepts the following keys:
720 .PP
721 \fIDescription=\fR
722 .RS 4
723 A description of the device\&. This is only used for presentation purposes\&.
724 .sp
725 Added in version 211\&.
726 .RE
727 .PP
728 \fIDHCP=\fR
729 .RS 4
730 Enables DHCPv4 and/or DHCPv6 client support\&. Accepts
731 "yes",
732 "no",
733 "ipv4", or
734 "ipv6"\&. Defaults to
735 "no"\&.
736 .sp
737 Note that DHCPv6 will by default be triggered by Router Advertisements, if reception is enabled, regardless of this parameter\&. By explicitly enabling DHCPv6 support here, the DHCPv6 client will be started in the mode specified by the
738 \fIWithoutRA=\fR
739 setting in the [DHCPv6] section, regardless of the presence of routers on the link, or what flags the routers pass\&. See
740 \fIIPv6AcceptRA=\fR\&.
741 .sp
742 Furthermore, note that by default the domain name specified through DHCP is not used for name resolution\&. See option
743 \fBUseDomains=\fR
744 below\&.
745 .sp
746 See the [DHCPv4] or [DHCPv6] sections below for further configuration options for the DHCP client support\&.
747 .sp
748 Added in version 211\&.
749 .RE
750 .PP
751 \fIDHCPRelay=\fR
752 .RS 4
753 Takes one of
754 "upstream"
755 or
756 "downstream"\&. When specified, the host acts as a DHCP relay agent\&. When set to
757 "upstream", the interface behaves as an upstream interface of the DHCP relay agent\&. When set to
758 "downstream", the interface behaves as a downstream interface of the DHCP relay agent\&. To make the DHCP relay agent work, at least one upstream interface and one downstream interface must be configured on the host\&. This requires
759 \fIServerAddress=\fR
760 in the [DHCPRelay] section to be configured in
761 networkd\&.conf\&. If
762 \fIServerAddress=\fR
763 is not configured, this setting is ignored\&. See
764 \fBnetworkd.conf\fR(5)
765 for more details about
766 \fIServerAddress=\fR
767 and other host\-wide settings\&. Also, further per\-interface settings can be configured in the [DHCPRelay] section described below\&. Defaults to unset, and the interface is not used for DHCP relay forwarding\&.
768 .sp
769 Added in version 261\&.
770 .RE
771 .PP
772 \fIDHCPServer=\fR
773 .RS 4
774 Takes a boolean\&. If set to
775 "yes", DHCPv4 server will be started\&. Defaults to
776 "no"\&. Further settings for the DHCP server may be set in the [DHCPServer] section described below\&.
777 .sp
778 Even if this is enabled, the DHCP server will not be started automatically and wait for the persistent storage being ready to load/save leases in the storage, unless
779 \fIPersistLeases=no/runtime\fR
780 is specified in the [DHCPServer] section\&. It will be started after
781 systemd\-networkd\-persistent\-storage\&.service
782 is started, which calls
783 \fBnetworkctl persistent\-storage yes\fR\&. See
784 \fBnetworkctl\fR(1)
785 for more details\&.
786 .sp
787 Added in version 215\&.
788 .RE
789 .PP
790 \fILinkLocalAddressing=\fR
791 .RS 4
792 Enables link\-local address autoconfiguration\&. Accepts a boolean,
793 \fBipv4\fR, and
794 \fBipv6\fR\&. An IPv6 link\-local address is configured when
795 \fByes\fR
796 or
797 \fBipv6\fR\&. An IPv4 link\-local address is configured when
798 \fByes\fR
799 or
800 \fBipv4\fR
801 and when DHCPv4 autoconfiguration has been unsuccessful for some time\&. (IPv4 link\-local address autoconfiguration will usually happen in parallel with repeated attempts to acquire a DHCPv4 lease)\&.
802 .sp
803 Defaults to
804 \fBno\fR
805 when
806 \fIKeepMaster=\fR
807 or
808 \fIBridge=\fR
809 is set or when the specified
810 \fIMACVLAN=\fR/\fIMACVTAP=\fR
811 has
812 \fIMode=passthru\fR, or
813 \fBipv6\fR
814 otherwise\&.
815 .sp
816 When IPv4 link\-local addressing is enabled,
817 \fIARP=\fR
818 is enabled unless if it is explicitly configured\&.
819 .sp
820 Added in version 219\&.
821 .RE
822 .PP
823 \fIIPv6LinkLocalAddressGenerationMode=\fR
824 .RS 4
825 Specifies how IPv6 link\-local address is generated\&. Takes one of
826 "eui64",
827 "none",
828 "stable\-privacy"
829 and
830 "random"\&. When unset,
831 "stable\-privacy"
832 is used if
833 \fIIPv6StableSecretAddress=\fR
834 is specified, and if not,
835 "eui64"
836 is used\&. Note that if
837 \fILinkLocalAddressing=\fR
838 is
839 "no"
840 or
841 "ipv4", then
842 \fIIPv6LinkLocalAddressGenerationMode=\fR
843 will be ignored\&. Also, even if
844 \fILinkLocalAddressing=\fR
845 is
846 "yes"
847 or
848 "ipv6", setting
849 \fIIPv6LinkLocalAddressGenerationMode=none\fR
850 disables to configure an IPv6 link\-local address\&.
851 .sp
852 Added in version 246\&.
853 .RE
854 .PP
855 \fIIPv6StableSecretAddress=\fR
856 .RS 4
857 Takes an IPv6 address\&. The specified address will be used as a stable secret for generating IPv6 link\-local address\&. If this setting is specified, and
858 \fIIPv6LinkLocalAddressGenerationMode=\fR
859 is unset, then
860 \fIIPv6LinkLocalAddressGenerationMode=stable\-privacy\fR
861 is implied\&. If this setting is not specified, and
862 "stable\-privacy"
863 is set to
864 \fIIPv6LinkLocalAddressGenerationMode=\fR, then a stable secret address will be generated from the local machine ID and the interface name\&.
865 .sp
866 Added in version 249\&.
867 .RE
868 .PP
869 \fIIPv4LLStartAddress=\fR
870 .RS 4
871 Specifies the first IPv4 link\-local address to try\&. Takes an IPv4 address for example 169\&.254\&.1\&.2, from the link\-local address range: 169\&.254\&.0\&.0/16 except for 169\&.254\&.0\&.0/24 and 169\&.254\&.255\&.0/24\&. This setting may be useful if the device should always have the same address as long as there is no address conflict\&. When unset, a random address will be automatically selected\&. Defaults to unset\&.
872 .sp
873 Added in version 252\&.
874 .RE
875 .PP
876 \fIIPv4LLRoute=\fR
877 .RS 4
878 Takes a boolean\&. If set to true, sets up the route needed for non\-IPv4LL hosts to communicate with IPv4LL\-only hosts\&. Defaults to false\&.
879 .sp
880 Added in version 216\&.
881 .RE
882 .PP
883 \fIDefaultRouteOnDevice=\fR
884 .RS 4
885 Takes a boolean\&. If set to true, sets up the IPv4 default route bound to the interface\&. Defaults to false\&. This is useful when creating routes on point\-to\-point interfaces\&. This is equivalent to e\&.g\&. the following,
886 .sp
887 .if n \{\
888 .RS 4
889 .\}
890 .nf
891 ip route add default dev veth99
892 .fi
893 .if n \{\
894 .RE
895 .\}
896 .sp
897 or,
898 .sp
899 .if n \{\
900 .RS 4
901 .\}
902 .nf
903 [Route]
904 Gateway=0\&.0\&.0\&.0
905 .fi
906 .if n \{\
907 .RE
908 .\}
909 .sp
910 Currently, there are no way to specify e\&.g\&., the table for the route configured by this setting\&. To configure the default route with such an additional property, please use the following instead:
911 .sp
912 .if n \{\
913 .RS 4
914 .\}
915 .nf
916 [Route]
917 Gateway=0\&.0\&.0\&.0
918 Table=1234
919 .fi
920 .if n \{\
921 .RE
922 .\}
923 .sp
924 If you\*(Aqd like to create an IPv6 default route bound to the interface, please use the following:
925 .sp
926 .if n \{\
927 .RS 4
928 .\}
929 .nf
930 [Route]
931 Gateway=::
932 Table=1234
933 .fi
934 .if n \{\
935 .RE
936 .\}
937 .sp
938 Added in version 243\&.
939 .RE
940 .PP
941 \fILLMNR=\fR
942 .RS 4
943 Takes a boolean or
944 "resolve"\&. When true, enables
945 \m[blue]\fBLink\-Local Multicast Name Resolution\fR\m[]\&\s-2\u[3]\d\s+2
946 on the link\&. When set to
947 "resolve", only resolution is enabled, but not host registration and announcement\&. Defaults to true\&. This setting is read by
948 \fBsystemd-resolved.service\fR(8)\&.
949 .sp
950 Added in version 216\&.
951 .RE
952 .PP
953 \fIMulticastDNS=\fR
954 .RS 4
955 Takes a boolean or
956 "resolve"\&. When true, enables
957 \m[blue]\fBMulticast DNS\fR\m[]\&\s-2\u[4]\d\s+2
958 support on the link\&. When set to
959 "resolve", only resolution is enabled, but not host or service registration and announcement\&. Defaults to false\&. This setting is read by
960 \fBsystemd-resolved.service\fR(8)\&.
961 .sp
962 Added in version 229\&.
963 .RE
964 .PP
965 \fIDNSOverTLS=\fR
966 .RS 4
967 Takes a boolean or
968 "opportunistic"\&. When true, enables
969 \m[blue]\fBDNS\-over\-TLS\fR\m[]\&\s-2\u[5]\d\s+2
970 support on the link\&. When set to
971 "opportunistic", compatibility with non\-DNS\-over\-TLS servers is increased, by automatically turning off DNS\-over\-TLS servers in this case\&. This option defines a per\-interface setting for
972 \fBresolved.conf\fR(5)\*(Aqs global
973 \fIDNSOverTLS=\fR
974 option\&. Defaults to unset, and the global setting will be used\&. This setting is read by
975 \fBsystemd-resolved.service\fR(8)\&.
976 .sp
977 Added in version 239\&.
978 .RE
979 .PP
980 \fIDNSSEC=\fR
981 .RS 4
982 Takes a boolean or
983 "allow\-downgrade"\&. When true, enables
984 \m[blue]\fBDNSSEC\fR\m[]\&\s-2\u[6]\d\s+2
985 DNS validation support on the link\&. When set to
986 "allow\-downgrade", compatibility with non\-DNSSEC capable networks is increased, by automatically turning off DNSSEC in this case\&. This option defines a per\-interface setting for
987 \fBresolved.conf\fR(5)\*(Aqs global
988 \fIDNSSEC=\fR
989 option\&. Defaults to unset, and the global setting will be used\&. This setting is read by
990 \fBsystemd-resolved.service\fR(8)\&.
991 .sp
992 Added in version 229\&.
993 .RE
994 .PP
995 \fIDNSSECNegativeTrustAnchors=\fR
996 .RS 4
997 A space\-separated list of DNSSEC negative trust anchor domains\&. If specified and DNSSEC is enabled, look\-ups done via the interface\*(Aqs DNS server will be subject to the list of negative trust anchors, and not require authentication for the specified domains, or anything below it\&. Use this to disable DNSSEC authentication for specific private domains, that cannot be proven valid using the Internet DNS hierarchy\&. Defaults to the empty list\&. This setting is read by
998 \fBsystemd-resolved.service\fR(8)\&.
999 .sp
1000 Added in version 229\&.
1001 .RE
1002 .PP
1003 \fILLDP=\fR
1004 .RS 4
1005 Controls support for Ethernet LLDP packet reception\&. LLDP is a link\-layer protocol commonly implemented on professional routers and bridges which announces which physical port a system is connected to, as well as other related data\&. Accepts a boolean or the special value
1006 "routers\-only"\&. When true, incoming LLDP packets are accepted and a database of all LLDP neighbors maintained\&. If
1007 "routers\-only"
1008 is set only LLDP data of various types of routers is collected and LLDP data about other types of devices ignored (such as stations, telephones and others)\&. If false, LLDP reception is disabled\&. Defaults to
1009 "routers\-only"\&. Use
1010 \fBnetworkctl\fR(1)
1011 to query the collected neighbor data\&. LLDP is only available on Ethernet links\&. See
1012 \fIEmitLLDP=\fR
1013 below for enabling LLDP packet emission from the local system\&.
1014 .sp
1015 Added in version 219\&.
1016 .RE
1017 .PP
1018 \fIEmitLLDP=\fR
1019 .RS 4
1020 Controls support for Ethernet LLDP packet emission\&. Accepts a boolean parameter or the special values
1021 "nearest\-bridge",
1022 "non\-tpmr\-bridge"
1023 and
1024 "customer\-bridge"\&. Defaults to false, which turns off LLDP packet emission\&. If not false, a short LLDP packet with information about the local system is sent out in regular intervals on the link\&. The LLDP packet will contain information about the local hostname, the local machine ID (as stored in
1025 \fBmachine-id\fR(5)) and the local interface name, as well as the pretty hostname of the system (as set in
1026 \fBmachine-info\fR(5))\&. LLDP emission is only available on Ethernet links\&. Note that this setting passes data suitable for identification of host to the network and should thus not be enabled on untrusted networks, where such identification data should not be made available\&. Use this option to permit other systems to identify on which interfaces they are connected to this system\&. The three special values control propagation of the LLDP packets\&. The
1027 "nearest\-bridge"
1028 setting permits propagation only to the nearest connected bridge,
1029 "non\-tpmr\-bridge"
1030 permits propagation across Two\-Port MAC Relays, but not any other bridges, and
1031 "customer\-bridge"
1032 permits propagation until a customer bridge is reached\&. For details about these concepts, see
1033 \m[blue]\fBIEEE 802\&.1AB\-2016\fR\m[]\&\s-2\u[7]\d\s+2\&. Note that configuring this setting to true is equivalent to
1034 "nearest\-bridge", the recommended and most restricted level of propagation\&. See
1035 \fILLDP=\fR
1036 above for an option to enable LLDP reception\&.
1037 .sp
1038 Added in version 230\&.
1039 .RE
1040 .PP
1041 \fIBindCarrier=\fR
1042 .RS 4
1043 A link name or a list of link names\&. When set, controls the behavior of the current link\&. When all links in the list are in an operational down state, the current link is brought down\&. When at least one link has carrier, the current interface is brought up\&.
1044 .sp
1045 This forces
1046 \fIActivationPolicy=\fR
1047 to be set to
1048 "bound"\&.
1049 .sp
1050 Added in version 220\&.
1051 .RE
1052 .PP
1053 \fIAddress=\fR
1054 .RS 4
1055 A static IPv4 or IPv6 address and its prefix length, separated by a
1056 "/"
1057 character\&. Specify this key more than once to configure several addresses\&. The format of the address must be as described in
1058 \fBinet_pton\fR(3)\&. This is a short\-hand for an [Address] section only containing an Address key (see below)\&. This option may be specified more than once\&.
1059 .sp
1060 If the specified address is
1061 "0\&.0\&.0\&.0"
1062 (for IPv4) or
1063 "::"
1064 (for IPv6), a new address range of the requested size is automatically allocated from a system\-wide pool of unused ranges\&. Note that the prefix length must be equal or larger than 8 for IPv4, and 64 for IPv6\&. The allocated range is checked against all current network interfaces and all known network configuration files to avoid address range conflicts\&. The default system\-wide pool consists of 192\&.168\&.0\&.0/16, 172\&.16\&.0\&.0/12 and 10\&.0\&.0\&.0/8 for IPv4, and fd00::/8 for IPv6\&. This functionality is useful to manage a large number of dynamically created network interfaces with the same network configuration and automatic address range assignment\&.
1065 .sp
1066 If an IPv4 link\-local address (169\&.254\&.0\&.0/16) is specified, IPv4 Address Conflict Detection (\m[blue]\fBRFC 5227\fR\m[]\&\s-2\u[8]\d\s+2) is enabled for the address\&. To assign an IPv4 link\-local address without IPv4 Address Conflict Detection, please use [Address] section to configure the address and disable
1067 \fIDuplicateAddressDetection=\fR\&.
1068 .sp
1069 .if n \{\
1070 .RS 4
1071 .\}
1072 .nf
1073 [Address]
1074 Address=169\&.254\&.10\&.1/24
1075 DuplicateAddressDetection=none
1076 .fi
1077 .if n \{\
1078 .RE
1079 .\}
1080 .sp
1081 If an empty string is specified, then the all previous assignments in both [Network] and [Address] sections are cleared\&.
1082 .sp
1083 Added in version 211\&.
1084 .RE
1085 .PP
1086 \fIGateway=\fR
1087 .RS 4
1088 The gateway address, which must be in the format described in
1089 \fBinet_pton\fR(3)\&. This is a short\-hand for a [Route] section only containing a
1090 \fIGateway=\fR
1091 key\&. This option may be specified more than once\&.
1092 .sp
1093 If an empty string is specified, then the all previous assignments in both [Network] and [Route] sections are cleared\&.
1094 .sp
1095 Added in version 211\&.
1096 .RE
1097 .PP
1098 \fIDNS=\fR
1099 .RS 4
1100 A DNS server address, which must be in the format described in
1101 \fBinet_pton\fR(3)\&. This option may be specified more than once\&. Each address can optionally take a port number separated with
1102 ":", a network interface name or index separated with
1103 "%", and a Server Name Indication (SNI) separated with
1104 "#"\&. When IPv6 address is specified with a port number, then the address must be in the square brackets\&. That is, the acceptable full formats are
1105 "111\&.222\&.333\&.444:9953%ifname#example\&.com"
1106 for IPv4 and
1107 "[1111:2222::3333]:9953%ifname#example\&.com"
1108 for IPv6\&. If an empty string is assigned, then the all previous assignments are cleared\&. This setting is read by
1109 \fBsystemd-resolved.service\fR(8)\&.
1110 .sp
1111 Added in version 211\&.
1112 .RE
1113 .PP
1114 \fIUseDomains=\fR
1115 .RS 4
1116 Specifies the protocol\-independent default value for the same settings in [IPv6AcceptRA], [DHCPv4], and [DHCPv6] sections below\&. Takes a boolean, or the special value
1117 \fBroute\fR\&. See also the same setting in [DHCPv4] below\&. Defaults to unset\&.
1118 .sp
1119 Added in version 256\&.
1120 .RE
1121 .PP
1122 \fIDomains=\fR
1123 .RS 4
1124 A whitespace\-separated list of domains which should be resolved using the DNS servers on this link\&. Each item in the list should be a domain name, optionally prefixed with a tilde ("~")\&. The domains with the prefix are called "routing\-only domains"\&. The domains without the prefix are called "search domains" and are first used as search suffixes for extending single\-label hostnames (hostnames containing no dots) to become fully qualified domain names (FQDNs)\&. If a single\-label hostname is resolved on this interface, each of the specified search domains are appended to it in turn, converting it into a fully qualified domain name, until one of them may be successfully resolved\&.
1125 .sp
1126 Both "search" and "routing\-only" domains are used for routing of DNS queries: look\-ups for hostnames ending in those domains (hence also single label names, if any "search domains" are listed), are routed to the DNS servers configured for this interface\&. The domain routing logic is particularly useful on multi\-homed hosts with DNS servers serving particular private DNS zones on each interface\&.
1127 .sp
1128 The "routing\-only" domain
1129 "~\&."
1130 (the tilde indicating definition of a routing domain, the dot referring to the DNS root domain which is the implied suffix of all valid DNS names) has special effect\&. It causes all DNS traffic which does not match another configured domain routing entry to be routed to DNS servers specified for this interface\&. This setting is useful to prefer a certain set of DNS servers if a link on which they are connected is available\&.
1131 .sp
1132 This setting is read by
1133 \fBsystemd-resolved.service\fR(8)\&. "Search domains" correspond to the
1134 \fIdomain\fR
1135 and
1136 \fIsearch\fR
1137 entries in
1138 \fBresolv.conf\fR(5)\&. Domain name routing has no equivalent in the traditional glibc API, which has no concept of domain name servers limited to a specific link\&.
1139 .sp
1140 Added in version 216\&.
1141 .RE
1142 .PP
1143 \fIDNSDefaultRoute=\fR
1144 .RS 4
1145 Takes a boolean argument\&. If true, this link\*(Aqs configured DNS servers are used for resolving domain names that do not match any link\*(Aqs configured
1146 \fIDomains=\fR
1147 setting\&. If false, this link\*(Aqs configured DNS servers are never used for such domains, and are exclusively used for resolving names that match at least one of the domains configured on this link\&. If not specified, defaults to an automatic mode: queries not matching any link\*(Aqs configured domains will be routed to this link if it has no routing\-only domains configured\&.
1148 .sp
1149 Added in version 240\&.
1150 .RE
1151 .PP
1152 \fINTP=\fR
1153 .RS 4
1154 An NTP server address (either an IP address, or a hostname)\&. This option may be specified more than once\&. This setting is read by
1155 \fBsystemd-timesyncd.service\fR(8)\&.
1156 .sp
1157 Added in version 216\&.
1158 .RE
1159 .PP
1160 \fIIPv4Forwarding=\fR
1161 .RS 4
1162 Configures IPv4 packet forwarding for the interface\&. Takes a boolean value\&. This controls the
1163 net\&.ipv4\&.conf\&.\fIINTERFACE\fR\&.forwarding
1164 sysctl option of the network interface\&. See
1165 \m[blue]\fBIP Sysctl\fR\m[]\&\s-2\u[9]\d\s+2
1166 for more details about the sysctl option\&. Defaults to true if
1167 \fIIPMasquerade=\fR
1168 is enabled for IPv4, otherwise the value specified to the same setting in
1169 \fBnetworkd.conf\fR(5)
1170 will be used\&. If none of them are specified, the sysctl option will not be changed\&.
1171 .sp
1172 To control the global setting, use the same setting in
1173 \fBnetworkd.conf\fR(5)\&.
1174 .sp
1175 Added in version 256\&.
1176 .RE
1177 .PP
1178 \fIIPv6Forwarding=\fR
1179 .RS 4
1180 Configures interface\-specific host/router behaviour\&. Takes a boolean value\&. This controls the
1181 net\&.ipv6\&.conf\&.\fIINTERFACE\fR\&.forwarding
1182 sysctl option of the network interface\&. See
1183 \m[blue]\fBIP Sysctl\fR\m[]\&\s-2\u[9]\d\s+2
1184 for more details about the sysctl option\&. Defaults to true if
1185 \fIIPMasquerade=\fR
1186 is enabled for IPv6 or
1187 \fIIPv6SendRA=\fR
1188 is enabled, otherwise the value specified to the same setting in
1189 \fBnetworkd.conf\fR(5)
1190 will be used\&. If none of them are specified, the sysctl option will not be changed\&.
1191 .sp
1192 To control the global setting, use the same setting in
1193 \fBnetworkd.conf\fR(5)\&.
1194 .sp
1195 Note, unlike
1196 \fIIPv4Forwarding=\fR, enabling per\-interface
1197 \fIIPv6Forwarding=\fR
1198 on two or more interfaces
1199 \fIDOES NOT\fR
1200 make IPv6 packets forwarded within the interfaces\&. This setting just controls the per\-interface sysctl value, and the sysctl value is not directly correlated to whether packets are forwarded\&. To ensure IPv6 packets forwarded, the global setting in
1201 \fBnetworkd.conf\fR(5)
1202 needs to be enabled\&.
1203 .sp
1204 Added in version 256\&.
1205 .RE
1206 .PP
1207 \fIIPMasquerade=\fR
1208 .RS 4
1209 Configures IP masquerading for the network interface\&. If enabled, packets forwarded from the network interface will appear as coming from the local host\&. Typically, this should be enabled on the downstream interface of routers\&. Takes one of
1210 "ipv4",
1211 "ipv6",
1212 "both", or
1213 "no"\&. Defaults to
1214 "no"\&. Note that any positive boolean values such as
1215 "yes"
1216 or
1217 "true"
1218 are now deprecated\&. Please use one of the values above\&. Specifying
1219 "ipv4"
1220 or
1221 "both"
1222 implies
1223 \fIIPv4Forwarding=\fR
1224 settings in both \&.network file for this interface and the global
1225 \fBnetworkd.conf\fR(5)
1226 unless they are explicitly specified\&. Similarly for
1227 \fIIPv6Forwarding=\fR
1228 when
1229 "ipv6"
1230 or
1231 "both"
1232 is specified\&. See
1233 \fIIPv4Forwarding=\fR/\fIIPv6Forwarding=\fR
1234 in the above for the per\-link settings, and
1235 \fBnetworkd.conf\fR(5)
1236 for the global settings\&.
1237 .sp
1238 Added in version 219\&.
1239 .RE
1240 .PP
1241 \fIIPv6PrivacyExtensions=\fR
1242 .RS 4
1243 Configures use of stateless temporary addresses that change over time (see
1244 \m[blue]\fBRFC 4941\fR\m[]\&\s-2\u[10]\d\s+2, Privacy Extensions for Stateless Address Autoconfiguration in IPv6)\&. Takes a boolean or the special values
1245 "prefer\-public"
1246 and
1247 "kernel"\&. When true, enables the privacy extensions and prefers temporary addresses over public addresses\&. When
1248 "prefer\-public", enables the privacy extensions, but prefers public addresses over temporary addresses\&. When false, the privacy extensions remain disabled\&. When
1249 "kernel", the kernel\*(Aqs default setting will be left in place\&. When unspecified, the value specified in the same setting in
1250 \fBnetworkd.conf\fR(5), which defaults to
1251 "no", will be used\&.
1252 .sp
1253 Added in version 222\&.
1254 .RE
1255 .PP
1256 \fIIPv6AcceptRA=\fR
1257 .RS 4
1258 Takes a boolean\&. Controls IPv6 Router Advertisement (RA) reception support for the interface\&. If true, RAs are accepted; if false, RAs are ignored\&. When RAs are accepted, they may trigger the start of the DHCPv6 client if the relevant flags are set in the RA data, or if no routers are found on the link\&.
1259 .sp
1260 This cannot be enabled on devices aggregated in a bond device, or when IPv6 link\-local addressing (see
1261 \fILinkLocalAddressing=\fR) or multicasting (see
1262 \fIMulticast=\fR) is disabled\&. Note, multicasting is disabled by default for some configurations, e\&.g\&. bridge ports\&. Hence, in that case
1263 \fIMulticast=\fR
1264 needs to be explicitly enabled to make this feature usable\&. When
1265 \fIIPv6SendRA=\fR,
1266 \fIIPv6Forwarding=\fR, or
1267 \fIIPMasquerade=\fR
1268 is enabled, this feature is disabled by default, but can be overridden by explicitly enabling this setting\&. Note,
1269 \fIIPv6Forwarding=\fR
1270 may be indirectly enabled when the global setting with the same name is enabled, or when
1271 \fIIPMasquerade=\fR
1272 is enabled on
1273 \fIany other interfaces\fR\&. See also
1274 \fIIPv6Forwarding=\fR
1275 and
1276 \fIIPMasquerade=\fR
1277 for more details\&. Enabled by default otherwise\&.
1278 .sp
1279 Further settings for the IPv6 RA support may be configured in the [IPv6AcceptRA] section, see below\&.
1280 .sp
1281 Also see
1282 \m[blue]\fBIP Sysctl\fR\m[]\&\s-2\u[9]\d\s+2
1283 in the kernel documentation regarding
1284 "accept_ra", but note that systemd\*(Aqs setting of
1285 \fB1\fR
1286 (i\&.e\&. true) corresponds to kernel\*(Aqs setting of
1287 \fB2\fR\&.
1288 .sp
1289 Note that kernel\*(Aqs implementation of the IPv6 RA protocol is always disabled, regardless of this setting\&. If this option is enabled, a userspace implementation of the IPv6 RA protocol is used, and the kernel\*(Aqs own implementation remains disabled, since
1290 \fBsystemd\-networkd\fR
1291 needs to know all details supplied in the advertisements, and these are not available from the kernel if the kernel\*(Aqs own implementation is used\&.
1292 .sp
1293 Added in version 231\&.
1294 .RE
1295 .PP
1296 \fIIPv6DuplicateAddressDetection=\fR
1297 .RS 4
1298 Configures the amount of IPv6 Duplicate Address Detection (DAD) probes to send\&. When unset, the kernel\*(Aqs default will be used\&.
1299 .sp
1300 Added in version 228\&.
1301 .RE
1302 .PP
1303 \fIIPv6HopLimit=\fR
1304 .RS 4
1305 Configures IPv6 Hop Limit\&. Takes an integer in the range 1\&...255\&. For each router that forwards the packet, the hop limit is decremented by 1\&. When the hop limit field reaches zero, the packet is discarded\&. When unset, the kernel\*(Aqs default will be used\&.
1306 .sp
1307 Added in version 228\&.
1308 .RE
1309 .PP
1310 \fIIPv6RetransmissionTimeSec=\fR
1311 .RS 4
1312 Configures IPv6 Retransmission Time\&. The time between retransmitted Neighbor Solicitation messages\&. Used by address resolution and the Neighbor Unreachability Detection algorithm\&. A value of zero is ignored and the kernel\*(Aqs current value will be used\&. Defaults to unset, and the kernel\*(Aqs current value will be used\&.
1313 .sp
1314 Added in version 256\&.
1315 .RE
1316 .PP
1317 \fIIPv4DuplicateAddressDetectionTimeoutSec=\fR
1318 .RS 4
1319 Configures the maximum timeout for IPv4 Duplicate Address Detection (RFC 5227)\&. Must be a value between 1 millisecond and 60 seconds\&. If set, Duplicate Address Detection takes a randomized time between 57% (4/7) and 100% of the given value\&. If unset, defaults to 200 milliseconds\&.
1320 .sp
1321 Added in version 258\&.
1322 .RE
1323 .PP
1324 \fIIPv4ReversePathFilter=\fR
1325 .RS 4
1326 Configure IPv4 Reverse Path Filtering\&. If enabled, when an IPv4 packet is received, the machine will first check whether the
1327 \fIsource\fR
1328 of the packet would be routed through the interface it came in\&. If there is no route to the source on that interface, the machine will drop the packet\&. Takes one of
1329 "no",
1330 "strict", or
1331 "loose"\&. When
1332 "no", no source validation will be done\&. When
1333 "strict", each incoming packet is tested against the FIB and if the incoming interface is not the best reverse path, the packet check will fail\&. By default, failed packets are discarded\&. When
1334 "loose", each incoming packet\*(Aqs source address is tested against the FIB\&. The packet is dropped only if the source address is not reachable via any interface on that router\&. See
1335 \m[blue]\fBRFC 3704\fR\m[]\&\s-2\u[11]\d\s+2\&. When unset, the kernel\*(Aqs default will be used\&.
1336 .sp
1337 Added in version 255\&.
1338 .RE
1339 .PP
1340 \fIMulticastIGMPVersion=\fR
1341 .RS 4
1342 Configures IPv4 Multicast IGMP Version to be used, and controls the value of
1343 /proc/sys/net/ipv4/conf/\fIINTERFACE\fR/force_igmp_version\&. Takes one of
1344 "no",
1345 "v1",
1346 "v2", or
1347 "v3"\&. When
1348 "no", no enforcement of an IGMP version is applied\&. IGMPv1/v2 fallbacks are allowed, and
1349 \fBsystemd\-networkd\fR
1350 will return to IGMPv3 mode after all IGMPv1/v2 Querier Present timers have expired\&. When
1351 "v1", use of IGMP version 1 is enforced\&. An IGMPv1 report will be returned even if IGMPv2/v3 queries are received\&. When
1352 "v2", use of IGMP version 2 is enforced\&. An IGMPv2 report will be returned if an IGMPv2/v3 query is received\&.
1353 \fBsystemd\-networkd\fR
1354 will fall back to IGMPv1 if an IGMPv1 query is received\&. When
1355 "v3", use of IGMP version 3 is enforced, and the response is the same as with
1356 "no"\&. Defaults to unset \(em the sysctl is not set\&.
1357 .sp
1358 Added in version 257\&.
1359 .RE
1360 .PP
1361 \fIIPv4AcceptLocal=\fR
1362 .RS 4
1363 Takes a boolean\&. Accept packets with local source addresses\&. In combination with suitable routing, this can be used to direct packets between two local interfaces over the wire and have them accepted properly\&. When unset, the kernel\*(Aqs default will be used\&.
1364 .sp
1365 Added in version 246\&.
1366 .RE
1367 .PP
1368 \fIIPv4RouteLocalnet=\fR
1369 .RS 4
1370 Takes a boolean\&. When true, the kernel does not consider loopback addresses as martian source or destination while routing\&. This enables the use of 127\&.0\&.0\&.0/8 for local routing purposes\&. When unset, the kernel\*(Aqs default will be used\&.
1371 .sp
1372 Added in version 248\&.
1373 .RE
1374 .PP
1375 \fIIPv4SrcValidMark=\fR
1376 .RS 4
1377 Takes a boolean\&. When enabled, the packet\*(Aqs firewall mark (fwmark) is included in the reverse path filter route lookup for source address validation on this interface\&. This is particularly useful for policy routing setups where packets may arrive with source addresses that are only valid in routing tables selected by their fwmark\&. When unset, the kernel\*(Aqs default will be used\&.
1378 .sp
1379 Added in version 261\&.
1380 .RE
1381 .PP
1382 \fIIPv4ProxyARP=\fR
1383 .RS 4
1384 Takes a boolean\&. Configures proxy ARP for IPv4\&. Proxy ARP is the technique in which one host, usually a router, answers ARP requests intended for another machine\&. By "faking" its identity, the router accepts responsibility for routing packets to the "real" destination\&. See
1385 \m[blue]\fBRFC 1027\fR\m[]\&\s-2\u[11]\d\s+2\&. When unset, the kernel\*(Aqs default will be used\&.
1386 .sp
1387 Added in version 233\&.
1388 .RE
1389 .PP
1390 \fIIPv4ProxyARPPrivateVLAN=\fR
1391 .RS 4
1392 Takes a boolean\&. Configures proxy ARP private VLAN for IPv4, also known as VLAN aggregation, private VLAN, source\-port filtering, port\-isolation, or MAC\-forced forwarding\&.
1393 .sp
1394 This variant of the ARP proxy technique will allow the ARP proxy to reply back to the same interface\&.
1395 .sp
1396 See
1397 \m[blue]\fBRFC 3069\fR\m[]\&\s-2\u[12]\d\s+2\&. When unset, the kernel\*(Aqs default will be used\&.
1398 .sp
1399 Added in version 256\&.
1400 .RE
1401 .PP
1402 \fIIPv6ProxyNDP=\fR
1403 .RS 4
1404 Takes a boolean\&. Configures proxy NDP for IPv6\&. Proxy NDP (Neighbor Discovery Protocol) is a technique for IPv6 to allow routing of addresses to a different destination when peers expect them to be present on a certain physical link\&. In this case, a router answers Neighbour Advertisement messages intended for another machine by offering its own MAC address as destination\&. Unlike proxy ARP for IPv4, it is not enabled globally, but will only send Neighbour Advertisement messages for addresses in the IPv6 neighbor proxy table, which can also be shown by
1405 \fBip \-6 neighbour show proxy\fR\&.
1406 \fBsystemd\-networkd\fR
1407 will control the per\-interface `proxy_ndp` switch for each configured interface depending on this option\&. When unset, the kernel\*(Aqs default will be used\&.
1408 .sp
1409 Added in version 234\&.
1410 .RE
1411 .PP
1412 \fIIPv6ProxyNDPAddress=\fR
1413 .RS 4
1414 An IPv6 address, for which Neighbour Advertisement messages will be proxied\&. This option may be specified more than once\&.
1415 \fBsystemd\-networkd\fR
1416 will add the
1417 \fIIPv6ProxyNDPAddress=\fR
1418 entries to the kernel\*(Aqs IPv6 neighbor proxy table\&. This setting implies
1419 \fIIPv6ProxyNDP=yes\fR
1420 but has no effect if
1421 \fIIPv6ProxyNDP=\fR
1422 has been set to false\&. When unset, the kernel\*(Aqs default will be used\&.
1423 .sp
1424 Added in version 233\&.
1425 .RE
1426 .PP
1427 \fIIPv6SendRA=\fR
1428 .RS 4
1429 Whether to enable or disable Router Advertisement sending on a link\&. Takes a boolean value\&. When enabled, prefixes configured in [IPv6Prefix] sections and routes configured in the [IPv6RoutePrefix] sections are distributed as defined in the [IPv6SendRA] section\&. If
1430 \fIDHCPPrefixDelegation=\fR
1431 is enabled, then the delegated prefixes are also distributed\&. See
1432 \fIDHCPPrefixDelegation=\fR
1433 setting and the [IPv6SendRA], [IPv6Prefix], [IPv6RoutePrefix], and [DHCPPrefixDelegation] sections for more configuration options\&.
1434 .sp
1435 If enabled,
1436 \fIIPv6Forwarding=\fR
1437 on this interface is also enabled, unless the setting is explicitly specified\&. See
1438 \fIIPv6Forwarding=\fR
1439 in the above for more details\&.
1440 .sp
1441 Added in version 247\&.
1442 .RE
1443 .PP
1444 \fIDHCPPrefixDelegation=\fR
1445 .RS 4
1446 Takes a boolean value\&. When enabled, requests subnet prefixes on another link via the DHCPv6 protocol or via the 6RD option in the DHCPv4 protocol\&. An address within each delegated prefix will be assigned, and the prefixes will be announced through IPv6 Router Advertisement if
1447 \fIIPv6SendRA=\fR
1448 is enabled\&. This behaviour can be configured in the [DHCPPrefixDelegation] section\&. Defaults to disabled\&.
1449 .sp
1450 Added in version 250\&.
1451 .RE
1452 .PP
1453 \fIIPv6MTUBytes=\fR
1454 .RS 4
1455 Configures IPv6 maximum transmission unit (MTU)\&. An integer greater than or equal to 1280 bytes\&. When unset, the kernel\*(Aqs default will be used\&.
1456 .sp
1457 Added in version 239\&.
1458 .RE
1459 .PP
1460 \fIMPLSRouting=\fR
1461 .RS 4
1462 Control whether Multi\-protocol Label Switching (MPLS) routing is enabled on this interface\&. This configures
1463 /proc/sys/net/mpls/conf/\fIINTERFACE\fR/input\&. Takes a boolean\&. Defaults to unset, and the kernel\*(Aqs default will be used\&.
1464 .sp
1465 Note,
1466 \fBsystemd\-networkd\fR
1467 does
1468 \fInot\fR
1469 load any required kernel modules for MPLS\&. To enable the feature,
1470 mpls_router
1471 kernel module must be loaded before
1472 systemd\-networkd\&.service
1473 is started\&. Consider adding the kernel module to
1474 \fBmodules-load.d\fR(5)\&.
1475 .sp
1476 Added in version 258\&.
1477 .RE
1478 .PP
1479 \fIKeepMaster=\fR
1480 .RS 4
1481 Takes a boolean value\&. When enabled, the current master interface index will not be changed, and
1482 \fIBatmanAdvanced=\fR,
1483 \fIBond=\fR,
1484 \fIBridge=\fR, and
1485 \fIVRF=\fR
1486 settings are ignored\&. This may be useful when a netdev with a master interface is created by another program, e\&.g\&.
1487 \fBsystemd-nspawn\fR(1)\&. Defaults to false\&.
1488 .sp
1489 Added in version 250\&.
1490 .RE
1491 .PP
1492 \fIBatmanAdvanced=\fR, \fIBond=\fR, \fIBridge=\fR, \fIVRF=\fR
1493 .RS 4
1494 The name of the B\&.A\&.T\&.M\&.A\&.N\&. Advanced, bond, bridge, or VRF interface to add the link to\&. See
1495 \fBsystemd.netdev\fR(5)\&.
1496 .sp
1497 Added in version 211\&.
1498 .RE
1499 .PP
1500 \fIIPoIB=\fR, \fIIPVLAN=\fR, \fIIPVTAP=\fR, \fIMACsec=\fR, \fIMACVLAN=\fR, \fIMACVTAP=\fR, \fITunnel=\fR, \fIVLAN=\fR, \fIVXLAN=\fR, \fIXfrm=\fR
1501 .RS 4
1502 The name of an IPoIB, IPVLAN, IPVTAP, MACsec, MACVLAN, MACVTAP, tunnel, VLAN, VXLAN, or Xfrm to be created on the link\&. See
1503 \fBsystemd.netdev\fR(5)\&. This option may be specified more than once\&.
1504 .sp
1505 Added in version 211\&.
1506 .RE
1507 .PP
1508 \fIActiveSlave=\fR
1509 .RS 4
1510 Takes a boolean\&. Specifies the new active slave\&. The
1511 "ActiveSlave="
1512 option is only valid for following modes:
1513 "active\-backup",
1514 "balance\-alb", and
1515 "balance\-tlb"\&. Defaults to false\&.
1516 .sp
1517 Added in version 235\&.
1518 .RE
1519 .PP
1520 \fIPrimarySlave=\fR
1521 .RS 4
1522 Takes a boolean\&. Specifies which slave is the primary device\&. The specified device will always be the active slave while it is available\&. Only when the primary is off\-line will alternate devices be used\&. This is useful when one slave is preferred over another, e\&.g\&. when one slave has higher throughput than another\&. The
1523 "PrimarySlave="
1524 option is only valid for following modes:
1525 "active\-backup",
1526 "balance\-alb", and
1527 "balance\-tlb"\&. Defaults to false\&.
1528 .sp
1529 Added in version 235\&.
1530 .RE
1531 .PP
1532 \fIConfigureWithoutCarrier=\fR
1533 .RS 4
1534 Takes a boolean\&. Allows
1535 \fBsystemd\-networkd\fR
1536 to configure a specific link even if it has no carrier\&. Defaults to false\&. If enabled, and the
1537 \fIIgnoreCarrierLoss=\fR
1538 setting is not explicitly set, then it is enabled as well\&.
1539 .sp
1540 With this enabled, to make the interface enter the
1541 "configured"
1542 state, which is required to make
1543 \fBsystemd\-networkd\-wait\-online\fR
1544 work properly for the interface, all dynamic address configuration mechanisms like
1545 \fIDHCP=\fR
1546 and
1547 \fIIPv6AcceptRA=\fR
1548 (which is enabled by default in most cases) need to be disabled\&. Also,
1549 \fIDuplicateAddressDetection=\fR
1550 (which is enabled by default for IPv4 link\-local addresses and all IPv6 addresses) needs to be disabled for all static address configurations\&. Otherwise, without carrier, the interface will be stuck in the
1551 "configuring"
1552 state, and
1553 \fBsystemd\-networkd\-wait\-online\fR
1554 for the interface will timeout\&. Also, it is recommended to set
1555 \fIRequiredForOnline=no\-carrier\fR
1556 to make
1557 \fBsystemd\-networkd\-wait\-online\fR
1558 work for the interface\&.
1559 .sp
1560 Added in version 235\&.
1561 .RE
1562 .PP
1563 \fIIgnoreCarrierLoss=\fR
1564 .RS 4
1565 Takes a boolean or a timespan\&. When true,
1566 \fBsystemd\-networkd\fR
1567 retains both the static and dynamic configuration of the interface even if its carrier is lost\&. When false,
1568 \fBsystemd\-networkd\fR
1569 drops both the static and dynamic configuration of the interface\&. When a timespan is specified,
1570 \fBsystemd\-networkd\fR
1571 waits for the specified timespan, and ignores the carrier loss if the link regain its carrier within the timespan\&. Setting 0 seconds is equivalent to
1572 "no", and
1573 "infinite"
1574 is equivalent to
1575 "yes"\&.
1576 .sp
1577 Setting a finite timespan may be useful when e\&.g\&. in the following cases:
1578 .sp
1579 .RS 4
1580 .ie n \{\
1581 \h'-04'\(bu\h'+03'\c
1582 .\}
1583 .el \{\
1584 .sp -1
1585 .IP \(bu 2.3
1586 .\}
1587 A wireless interface connecting to a network which has multiple access points with the same SSID\&.
1588 .RE
1589 .sp
1590 .RS 4
1591 .ie n \{\
1592 \h'-04'\(bu\h'+03'\c
1593 .\}
1594 .el \{\
1595 .sp -1
1596 .IP \(bu 2.3
1597 .\}
1598 Enslaving a wireless interface to a bond interface, which may disconnect from the connected access point and causes its carrier to be lost\&.
1599 .RE
1600 .sp
1601 .RS 4
1602 .ie n \{\
1603 \h'-04'\(bu\h'+03'\c
1604 .\}
1605 .el \{\
1606 .sp -1
1607 .IP \(bu 2.3
1608 .\}
1609 The driver of the interface resets when the MTU is changed\&.
1610 .RE
1611 .sp
1612 When
1613 \fIBond=\fR
1614 is specified to a wireless interface, defaults to 3 seconds\&. When the DHCPv4 client is enabled and
1615 \fIUseMTU=\fR
1616 in the [DHCPv4] section enabled, defaults to 5 seconds\&. Otherwise, defaults to the value specified with
1617 \fIConfigureWithoutCarrier=\fR\&. When
1618 \fIActivationPolicy=\fR
1619 is set to
1620 "always\-up", this is forced to
1621 "yes", and ignored any user specified values\&.
1622 .sp
1623 Added in version 242\&.
1624 .RE
1625 .PP
1626 \fIKeepConfiguration=\fR
1627 .RS 4
1628 Takes a boolean or one of
1629 "static",
1630 "dynamic\-on\-stop", and
1631 "dynamic"\&. When
1632 "static",
1633 \fBsystemd\-networkd\fR
1634 will not drop statically configured addresses and routes on starting up process\&. When
1635 "dynamic\-on\-stop", the dynamically configured addresses and routes, such as DHCPv4, DHCPv6, SLAAC, and IPv4 link\-local address, will not be dropped when
1636 \fBsystemd\-networkd\fR
1637 is being stopped\&. When
1638 "dynamic", the dynamically configured addresses and routes will never be dropped, and the lifetime of DHCPv4 leases will be ignored\&. This is contrary to the DHCP specification, but may be the best choice if, e\&.g\&., the root filesystem relies on this connection\&. The setting
1639 "dynamic"
1640 implies
1641 "dynamic\-on\-stop", and
1642 "yes"
1643 implies
1644 "dynamic"
1645 and
1646 "static"\&. Defaults to
1647 "dynamic\-on\-stop"
1648 when
1649 \fBsystemd\-networkd\fR
1650 is running in initrd,
1651 "yes"
1652 when the root filesystem is a network filesystem, and
1653 "no"
1654 otherwise\&.
1655 .sp
1656 Added in version 257\&.
1657 .RE
1658 .SH "[ADDRESS] SECTION OPTIONS"
1659 .PP
1660 An [Address] section accepts the following keys\&. Specify several [Address] sections to configure several addresses\&.
1661 .PP
1662 \fIAddress=\fR
1663 .RS 4
1664 As in the [Network] section\&. This setting is mandatory\&. Each [Address] section can contain one
1665 \fIAddress=\fR
1666 setting\&.
1667 .sp
1668 Added in version 211\&.
1669 .RE
1670 .PP
1671 \fIPeer=\fR
1672 .RS 4
1673 The peer address in a point\-to\-point connection\&. Accepts the same format as the
1674 \fIAddress=\fR
1675 setting\&.
1676 .sp
1677 Added in version 216\&.
1678 .RE
1679 .PP
1680 \fIBroadcast=\fR
1681 .RS 4
1682 Takes an IPv4 address or boolean value\&. The address must be in the format described in
1683 \fBinet_pton\fR(3)\&. If set to true, then the IPv4 broadcast address will be derived from the
1684 \fIAddress=\fR
1685 setting\&. If set to false, then the broadcast address will not be set\&. Defaults to true, except for wireguard interfaces, where it defaults to false\&.
1686 .sp
1687 Added in version 211\&.
1688 .RE
1689 .PP
1690 \fILabel=\fR
1691 .RS 4
1692 Specifies the label for the IPv4 address\&. The label must be a 7\-bit ASCII string with a length of 1\&...15 characters\&. Defaults to unset\&.
1693 .sp
1694 Added in version 211\&.
1695 .RE
1696 .PP
1697 \fIPreferredLifetime=\fR
1698 .RS 4
1699 Allows the default "preferred lifetime" of the address to be overridden\&. Only three settings are accepted:
1700 "forever",
1701 "infinity", which is the default and means that the address never expires, and
1702 "0", which means that the address is considered immediately "expired" and will not be used, unless explicitly requested\&. A setting of
1703 \fBPreferredLifetime=0\fR
1704 is useful for addresses which are added to be used only by a specific application, which is then configured to use them explicitly\&.
1705 .sp
1706 Added in version 230\&.
1707 .RE
1708 .PP
1709 \fIScope=\fR
1710 .RS 4
1711 The scope of the address, which can be
1712 "global"
1713 (valid everywhere on the network, even through a gateway),
1714 "link"
1715 (only valid on this device, will not traverse a gateway) or
1716 "host"
1717 (only valid within the device itself, e\&.g\&. 127\&.0\&.0\&.1) or an integer in the range 0\&...255\&. Defaults to
1718 "global"\&. IPv4 only \- IPv6 scope is automatically assigned by the kernel and cannot be set manually\&.
1719 .sp
1720 Added in version 235\&.
1721 .RE
1722 .PP
1723 \fIRouteMetric=\fR
1724 .RS 4
1725 The metric of the prefix route, which is pointing to the subnet of the configured IP address, taking the configured prefix length into account\&. Takes an unsigned integer in the range 0\&...4294967295\&. When unset or set to 0, the kernel\*(Aqs default value is used\&. This setting will be ignored when
1726 \fIAddPrefixRoute=\fR
1727 is false\&.
1728 .sp
1729 Added in version 246\&.
1730 .RE
1731 .PP
1732 \fIHomeAddress=\fR
1733 .RS 4
1734 Takes a boolean\&. Designates this address the "home address" as defined in
1735 \m[blue]\fBRFC 6275\fR\m[]\&\s-2\u[13]\d\s+2\&. Supported only on IPv6\&. Defaults to false\&.
1736 .sp
1737 Added in version 232\&.
1738 .RE
1739 .PP
1740 \fIDuplicateAddressDetection=\fR
1741 .RS 4
1742 Takes one of
1743 "ipv4",
1744 "ipv6",
1745 "both", or
1746 "none"\&. When
1747 "ipv4", performs IPv4 Address Conflict Detection\&. See
1748 \m[blue]\fBRFC 5227\fR\m[]\&\s-2\u[8]\d\s+2\&. When
1749 "ipv6", performs IPv6 Duplicate Address Detection\&. See
1750 \m[blue]\fBRFC 4862\fR\m[]\&\s-2\u[14]\d\s+2\&. Defaults to
1751 "ipv4"
1752 for IPv4 link\-local addresses (169\&.254\&.0\&.0/16),
1753 "ipv6"
1754 for IPv6 addresses, and
1755 "none"
1756 otherwise\&.
1757 .sp
1758 When enabled, regardless implicitly or not,
1759 \fIARP=\fR
1760 is enabled unless it is explicitly configured\&.
1761 .sp
1762 Added in version 232\&.
1763 .RE
1764 .PP
1765 \fIManageTemporaryAddress=\fR
1766 .RS 4
1767 Takes a boolean\&. If true the kernel manage temporary addresses created from this one as template on behalf of Privacy Extensions
1768 \m[blue]\fBRFC 3041\fR\m[]\&\s-2\u[15]\d\s+2\&. For this to become active, the use_tempaddr sysctl setting has to be set to a value greater than zero\&. The given address needs to have a prefix length of 64\&. This flag allows using privacy extensions in a manually configured network, just like if stateless auto\-configuration was active\&. Defaults to false\&.
1769 .sp
1770 Added in version 232\&.
1771 .RE
1772 .PP
1773 \fIAddPrefixRoute=\fR
1774 .RS 4
1775 Takes a boolean\&. When true, the prefix route for the address is automatically added\&. Defaults to true\&.
1776 .sp
1777 Added in version 245\&.
1778 .RE
1779 .PP
1780 \fIAutoJoin=\fR
1781 .RS 4
1782 Takes a boolean\&. Joining multicast group on ethernet level via
1783 \fBip maddr\fR
1784 command would not work if we have an Ethernet switch that does IGMP snooping since the switch would not replicate multicast packets on ports that did not have IGMP reports for the multicast addresses\&. Linux vxlan interfaces created via
1785 \fBip link add vxlan\fR
1786 or
1787 \fBsystemd\-networkd\fR\*(Aqs netdev kind vxlan have the group option that enables them to do the required join\&. By extending
1788 \fBip address\fR
1789 command with option
1790 "autojoin"
1791 we can get similar functionality for openvswitch (OVS) vxlan interfaces as well as other tunneling mechanisms that need to receive multicast traffic\&. Defaults to
1792 "no"\&.
1793 .sp
1794 Added in version 232\&.
1795 .RE
1796 .PP
1797 \fINetLabel=\fR\fIlabel\fR
1798 .RS 4
1799 This setting provides a method for integrating static and dynamic network configuration into Linux
1800 \m[blue]\fBNetLabel\fR\m[]\&\s-2\u[16]\d\s+2
1801 subsystem rules, used by
1802 \m[blue]\fBLinux Security Modules (LSMs)\fR\m[]\&\s-2\u[17]\d\s+2
1803 for network access control\&. The label, with suitable LSM rules, can be used to control connectivity of (for example) a service with peers in the local network\&. At least with SELinux, only the ingress can be controlled but not egress\&. The benefit of using this setting is that it may be possible to apply interface independent part of NetLabel configuration at very early stage of system boot sequence, at the time when the network interfaces are not available yet, with
1804 \fBnetlabelctl\fR(8), and the per\-interface configuration with
1805 \fBsystemd\-networkd\fR
1806 once the interfaces appear later\&. Currently this feature is only implemented for SELinux\&.
1807 .sp
1808 The option expects a single NetLabel label\&. The label must conform to lexicographic restrictions of LSM labels\&. When an interface is configured with IP addresses, the addresses and subnetwork masks will be appended to the
1809 \m[blue]\fBNetLabel Fallback Peer Labeling\fR\m[]\&\s-2\u[18]\d\s+2
1810 rules\&. They will be removed when the interface is deconfigured\&. Failures to manage the labels will be ignored\&.
1811 .if n \{\
1812 .sp
1813 .\}
1814 .RS 4
1815 .it 1 an-trap
1816 .nr an-no-space-flag 1
1817 .nr an-break-flag 1
1818 .br
1819 .ps +1
1820 \fBWarning\fR
1821 .ps -1
1822 .br
1823 Once labeling is enabled for network traffic, a lot of LSM access control points in Linux networking stack go from dormant to active\&. Care should be taken to avoid getting into a situation where for example remote connectivity is broken, when the security policy has not been updated to consider LSM per\-packet access controls and no rules would allow any network traffic\&. Also note that additional configuration with
1824 \fBnetlabelctl\fR(8)
1825 is needed\&.
1826 .sp .5v
1827 .RE
1828 Example:
1829 .sp
1830 .if n \{\
1831 .RS 4
1832 .\}
1833 .nf
1834 [Address]
1835 NetLabel=system_u:object_r:localnet_peer_t:s0
1836 .fi
1837 .if n \{\
1838 .RE
1839 .\}
1840 .sp
1841 With the example rules applying for interface
1842 "eth0", when the interface is configured with an IPv4 address of 10\&.0\&.0\&.123/8,
1843 \fBsystemd\-networkd\fR
1844 performs the equivalent of
1845 \fBnetlabelctl\fR
1846 operation
1847 .sp
1848 .if n \{\
1849 .RS 4
1850 .\}
1851 .nf
1852 netlabelctl unlbl add interface eth0 address:10\&.0\&.0\&.0/8 label:system_u:object_r:localnet_peer_t:s0
1853 .fi
1854 .if n \{\
1855 .RE
1856 .\}
1857 .sp
1858 and the reverse operation when the IPv4 address is deconfigured\&. The configuration can be used with LSM rules; in case of SELinux to allow a SELinux domain to receive data from objects of SELinux
1859 "peer"
1860 class\&. For example:
1861 .sp
1862 .if n \{\
1863 .RS 4
1864 .\}
1865 .nf
1866 type localnet_peer_t;
1867 allow my_server_t localnet_peer_t:peer recv;
1868 .fi
1869 .if n \{\
1870 .RE
1871 .\}
1872 .sp
1873 The effect of the above configuration and rules (in absence of other rules as may be the case) is to only allow
1874 "my_server_t"
1875 (and nothing else) to receive data from local subnet 10\&.0\&.0\&.0/8 of interface
1876 "eth0"\&.
1877 .sp
1878 Added in version 252\&.
1879 .RE
1880 .PP
1881 \fINFTSet=\fR\fIsource\fR:\fIfamily\fR:\fItable\fR:\fIset\fR
1882 .RS 4
1883 This setting provides a method for integrating network configuration into firewall rules with
1884 \m[blue]\fBNFT\fR\m[]\&\s-2\u[19]\d\s+2
1885 sets\&. The benefit of using the setting is that static network configuration (or dynamically obtained network addresses, see similar directives in other sections) can be used in firewall rules with the indirection of NFT set types\&. For example, access could be granted for hosts in the local subnetwork only\&. Firewall rules using IP address of an interface are also instantly updated when the network configuration changes, for example via DHCP\&.
1886 .sp
1887 This option expects a whitespace separated list of NFT set definitions\&. Each definition consists of a colon\-separated tuple of source type (one of
1888 "address",
1889 "prefix"
1890 or
1891 "ifindex"), NFT address family (one of
1892 "arp",
1893 "bridge",
1894 "inet",
1895 "ip",
1896 "ip6", or
1897 "netdev"), table name and set name\&. The names of tables and sets must conform to lexicographic restrictions of NFT table names\&. The type of the element used in the NFT filter must match the type implied by the directive ("address",
1898 "prefix"
1899 or
1900 "ifindex") and address type (IPv4 or IPv6) as shown in the table below\&.
1901 .sp
1902 .it 1 an-trap
1903 .nr an-no-space-flag 1
1904 .nr an-break-flag 1
1905 .br
1906 .B Table\ \&1.\ \&Defined \fIsource type\fR values
1907 .TS
1908 allbox tab(:);
1909 lB lB lB.
1910 T{
1911 Source type
1912 T}:T{
1913 Description
1914 T}:T{
1915 Corresponding NFT type name
1916 T}
1917 .T&
1918 l l l
1919 l l l
1920 l l l.
1921 T{
1922 "address"
1923 T}:T{
1924 host IP address
1925 T}:T{
1926 "ipv4_addr" or "ipv6_addr"
1927 T}
1928 T{
1929 "prefix"
1930 T}:T{
1931 network prefix
1932 T}:T{
1933 "ipv4_addr" or "ipv6_addr", with "flags interval"
1934 T}
1935 T{
1936 "ifindex"
1937 T}:T{
1938 interface index
1939 T}:T{
1940 "iface_index"
1941 T}
1942 .TE
1943 .sp 1
1944 When an interface is configured with IP addresses, the addresses, subnetwork masks or interface index will be appended to the NFT sets\&. The information will be removed when the interface is deconfigured\&.
1945 \fBsystemd\-networkd\fR
1946 only inserts elements to (or removes from) the sets, so the related NFT rules, tables and sets must be prepared elsewhere in advance\&. Failures to manage the sets will be ignored\&.
1947 .sp
1948 Example:
1949 .sp
1950 .if n \{\
1951 .RS 4
1952 .\}
1953 .nf
1954 [Address]
1955 NFTSet=prefix:netdev:filter:eth_ipv4_prefix
1956 .fi
1957 .if n \{\
1958 .RE
1959 .\}
1960 .sp
1961 Corresponding NFT rules:
1962 .sp
1963 .if n \{\
1964 .RS 4
1965 .\}
1966 .nf
1967 table netdev filter {
1968 set eth_ipv4_prefix {
1969 type ipv4_addr
1970 flags interval
1971 }
1972 chain eth_ingress {
1973 type filter hook ingress device "eth0" priority filter; policy drop;
1974 ip daddr != @eth_ipv4_prefix drop
1975 accept
1976 }
1977 }
1978 .fi
1979 .if n \{\
1980 .RE
1981 .\}
1982 .sp
1983 Added in version 255\&.
1984 .RE
1985 .SH "[NEIGHBOR] SECTION OPTIONS"
1986 .PP
1987 A [Neighbor] section accepts the following keys\&. The neighbor section adds a permanent, static entry to the neighbor table (IPv6) or ARP table (IPv4) for the given hardware address on the links matched for the network\&. Specify several [Neighbor] sections to configure several static neighbors\&.
1988 .PP
1989 \fIAddress=\fR
1990 .RS 4
1991 The IP address of the neighbor\&.
1992 .sp
1993 Added in version 240\&.
1994 .RE
1995 .PP
1996 \fILinkLayerAddress=\fR
1997 .RS 4
1998 The link layer address (MAC address or IP address) of the neighbor\&.
1999 .sp
2000 Added in version 243\&.
2001 .RE
2002 .SH "[IPV6ADDRESSLABEL] SECTION OPTIONS"
2003 .PP
2004 An [IPv6AddressLabel] section accepts the following keys\&. Specify several [IPv6AddressLabel] sections to configure several address labels\&. IPv6 address labels are used for address selection\&. See
2005 \m[blue]\fBRFC 3484\fR\m[]\&\s-2\u[20]\d\s+2\&. Precedence is managed by userspace, and only the label itself is stored in the kernel\&.
2006 .PP
2007 \fILabel=\fR
2008 .RS 4
2009 The label for the prefix\&. Takes an unsigned integer in the range 0\&...4294967294 (0xfffffffe)\&. 4294967295 (0xffffffff) is reserved\&. This setting is mandatory\&.
2010 .sp
2011 Added in version 234\&.
2012 .RE
2013 .PP
2014 \fIPrefix=\fR
2015 .RS 4
2016 Takes an IPv6 address with a prefix length, separated by a slash
2017 "/"
2018 character\&. This setting is mandatory\&.
2019 .sp
2020 Added in version 234\&.
2021 .RE
2022 .SH "[ROUTINGPOLICYRULE] SECTION OPTIONS"
2023 .PP
2024 An [RoutingPolicyRule] section accepts the following settings\&. Specify several [RoutingPolicyRule] sections to configure several rules\&.
2025 .PP
2026 \fITypeOfService=\fR
2027 .RS 4
2028 This specifies the Type of Service (ToS) field of packets to match; it takes an unsigned integer in the range 0\&...255\&. The field can be used to specify precedence (the first 3 bits) and ToS (the next 3 bits)\&. The field can be also used to specify Differentiated Services Code Point (DSCP) (the first 6 bits) and Explicit Congestion Notification (ECN) (the last 2 bits)\&. See
2029 \m[blue]\fBType of Service\fR\m[]\&\s-2\u[21]\d\s+2
2030 and
2031 \m[blue]\fBDifferentiated services\fR\m[]\&\s-2\u[22]\d\s+2
2032 for more details\&.
2033 .sp
2034 Added in version 235\&.
2035 .RE
2036 .PP
2037 \fIFrom=\fR
2038 .RS 4
2039 Specifies the source address prefix to match\&. Possibly followed by a slash and the prefix length\&.
2040 .sp
2041 Added in version 235\&.
2042 .RE
2043 .PP
2044 \fITo=\fR
2045 .RS 4
2046 Specifies the destination address prefix to match\&. Possibly followed by a slash and the prefix length\&.
2047 .sp
2048 Added in version 235\&.
2049 .RE
2050 .PP
2051 \fIFirewallMark=\fR
2052 .RS 4
2053 Specifies the iptables firewall mark value to match (a number in the range 0\&...4294967295)\&. Optionally, the firewall mask (also a number between 0\&...4294967295) can be suffixed with a slash ("/"), e\&.g\&.,
2054 "7/255"\&. When the mark value is non\-zero and no mask is explicitly specified, all bits of the mark are compared\&.
2055 .sp
2056 Added in version 235\&.
2057 .RE
2058 .PP
2059 \fITable=\fR
2060 .RS 4
2061 Specifies the routing table identifier to look up if the rule selector matches\&. Takes one of predefined names
2062 "default",
2063 "main", and
2064 "local", and names defined in
2065 \fIRouteTable=\fR
2066 in
2067 \fBnetworkd.conf\fR(5), or a number between 1 and 4294967295\&. Defaults to
2068 "main"\&. Ignored if
2069 \fIL3MasterDevice=\fR
2070 is true\&.
2071 .sp
2072 Added in version 235\&.
2073 .RE
2074 .PP
2075 \fIPriority=\fR
2076 .RS 4
2077 Specifies the priority of this rule\&.
2078 \fIPriority=\fR
2079 is an integer in the range 0\&...4294967295\&. Higher number means lower priority, and rules get processed in order of increasing number\&. Defaults to unset, and the kernel will pick a value dynamically\&.
2080 .sp
2081 Added in version 235\&.
2082 .RE
2083 .PP
2084 \fIGoTo=\fR
2085 .RS 4
2086 Specifies the target priority used by the
2087 "goto"
2088 type of rule\&. Takes an integer in the range 1\&...4294967295\&. This must be larger than the priority of the rule specified in
2089 \fIPriority=\fR\&. When specified,
2090 \fIType=goto\fR
2091 is implied\&. This is mandatory when
2092 \fIType=goto\fR\&.
2093 .sp
2094 Added in version 257\&.
2095 .RE
2096 .PP
2097 \fIIncomingInterface=\fR
2098 .RS 4
2099 Specifies incoming device to match\&. If the interface is loopback, the rule only matches packets originating from this host\&.
2100 .sp
2101 Added in version 236\&.
2102 .RE
2103 .PP
2104 \fIOutgoingInterface=\fR
2105 .RS 4
2106 Specifies the outgoing device to match\&. The outgoing interface is only available for packets originating from local sockets that are bound to a device\&.
2107 .sp
2108 Added in version 236\&.
2109 .RE
2110 .PP
2111 \fIL3MasterDevice=\fR
2112 .RS 4
2113 Takes a boolean\&. Specifies whether the rule is to direct lookups to the tables associated with level 3 master devices (also known as Virtual Routing and Forwarding or VRF devices)\&. For further details see
2114 \m[blue]\fBVirtual Routing and Forwarding (VRF)\fR\m[]\&\s-2\u[23]\d\s+2\&. Defaults to false\&.
2115 .sp
2116 Added in version 256\&.
2117 .RE
2118 .PP
2119 \fISourcePort=\fR
2120 .RS 4
2121 Specifies the source IP port or IP port range match in forwarding information base (FIB) rules\&. A port range is specified by the lower and upper port separated by a dash\&. Defaults to unset\&.
2122 .sp
2123 Added in version 240\&.
2124 .RE
2125 .PP
2126 \fIDestinationPort=\fR
2127 .RS 4
2128 Specifies the destination IP port or IP port range match in forwarding information base (FIB) rules\&. A port range is specified by the lower and upper port separated by a dash\&. Defaults to unset\&.
2129 .sp
2130 Added in version 240\&.
2131 .RE
2132 .PP
2133 \fIIPProtocol=\fR
2134 .RS 4
2135 Specifies the IP protocol to match in forwarding information base (FIB) rules\&. Takes IP protocol name such as
2136 "tcp",
2137 "udp"
2138 or
2139 "sctp", or IP protocol number such as
2140 "6"
2141 for
2142 "tcp"
2143 or
2144 "17"
2145 for
2146 "udp"\&. Defaults to unset\&.
2147 .sp
2148 Added in version 240\&.
2149 .RE
2150 .PP
2151 \fIInvertRule=\fR
2152 .RS 4
2153 A boolean\&. Specifies whether the rule is to be inverted\&. Defaults to false\&.
2154 .sp
2155 Added in version 240\&.
2156 .RE
2157 .PP
2158 \fIFamily=\fR
2159 .RS 4
2160 Takes a special value
2161 "ipv4",
2162 "ipv6", or
2163 "both"\&. By default, the address family is determined by the address specified in
2164 \fITo=\fR
2165 or
2166 \fIFrom=\fR\&. If neither
2167 \fITo=\fR
2168 nor
2169 \fIFrom=\fR
2170 are specified, then defaults to
2171 "ipv4"\&.
2172 .sp
2173 Added in version 243\&.
2174 .RE
2175 .PP
2176 \fIUser=\fR
2177 .RS 4
2178 Takes a username, a user ID, or a range of user IDs separated by a dash\&. Defaults to unset\&.
2179 .sp
2180 Added in version 245\&.
2181 .RE
2182 .PP
2183 \fISuppressPrefixLength=\fR
2184 .RS 4
2185 Takes a number
2186 \fIN\fR
2187 in the range 0\&...128 and rejects routing decisions that have a prefix length of
2188 \fIN\fR
2189 or less\&. Defaults to unset\&.
2190 .sp
2191 Added in version 245\&.
2192 .RE
2193 .PP
2194 \fISuppressInterfaceGroup=\fR
2195 .RS 4
2196 Takes an integer in the range 0\&...2147483647 and rejects routing decisions that have an interface with the same group id\&. It has the same meaning as
2197 \fBsuppress_ifgroup\fR
2198 in
2199 \fBip rule\fR\&. Defaults to unset\&.
2200 .sp
2201 Added in version 250\&.
2202 .RE
2203 .PP
2204 \fIType=\fR
2205 .RS 4
2206 Specifies Routing Policy Database (RPDB) rule type\&. Takes one of
2207 "table",
2208 "goto",
2209 "nop",
2210 "blackhole",
2211 "unreachable", or
2212 "prohibit"\&. When
2213 "goto", the target priority must be specified in
2214 \fIGoTo=\fR\&. Defaults to
2215 "table"\&.
2216 .sp
2217 Added in version 248\&.
2218 .RE
2219 .SH "[NEXTHOP] SECTION OPTIONS"
2220 .PP
2221 The [NextHop] section is used to manipulate entries in the kernel\*(Aqs "nexthop" tables\&. The [NextHop] section accepts the following settings\&. Specify several [NextHop] sections to configure several hops\&.
2222 .PP
2223 \fIId=\fR
2224 .RS 4
2225 The id of the next hop\&. Takes an integer in the range 1\&...4294967295\&. This is mandatory if
2226 \fIManageForeignNextHops=no\fR
2227 is specified in
2228 \fBnetworkd.conf\fR(5)\&. Otherwise, if unspecified, an unused ID will be automatically picked\&.
2229 .sp
2230 Added in version 244\&.
2231 .RE
2232 .PP
2233 \fIGateway=\fR
2234 .RS 4
2235 As in the [Network] section\&.
2236 .sp
2237 Added in version 244\&.
2238 .RE
2239 .PP
2240 \fIFamily=\fR
2241 .RS 4
2242 Takes one of the special values
2243 "ipv4"
2244 or
2245 "ipv6"\&. By default, the family is determined by the address specified in
2246 \fIGateway=\fR\&. If
2247 \fIGateway=\fR
2248 is not specified, then defaults to
2249 "ipv4"\&.
2250 .sp
2251 Added in version 248\&.
2252 .RE
2253 .PP
2254 \fIOnLink=\fR
2255 .RS 4
2256 Takes a boolean\&. If set to true, the kernel does not have to check if the gateway is reachable directly by the current machine (i\&.e\&., attached to the local network), so that we can insert the nexthop in the kernel table without it being complained about\&. Defaults to
2257 "no"\&.
2258 .sp
2259 Added in version 248\&.
2260 .RE
2261 .PP
2262 \fIBlackhole=\fR
2263 .RS 4
2264 Takes a boolean\&. If enabled, packets to the corresponding routes are discarded silently, and
2265 \fIGateway=\fR
2266 cannot be specified\&. Defaults to
2267 "no"\&.
2268 .sp
2269 Added in version 248\&.
2270 .RE
2271 .PP
2272 \fIGroup=\fR
2273 .RS 4
2274 Takes a whitespace separated list of nexthop IDs\&. Each ID must be in the range 1\&...4294967295\&. Optionally, each nexthop ID can take a weight after a colon ("\fIid\fR[:\fIweight\fR]")\&. The weight must be in the range 1\&...255\&. If the weight is not specified, then it is assumed that the weight is 1\&. This setting cannot be specified with
2275 \fIGateway=\fR,
2276 \fIFamily=\fR,
2277 \fIBlackhole=\fR\&. This setting can be specified multiple times\&. If an empty string is assigned, then the all previous assignments are cleared\&. Defaults to unset\&.
2278 .sp
2279 Added in version 249\&.
2280 .RE
2281 .SH "[ROUTE] SECTION OPTIONS"
2282 .PP
2283 The [Route] section accepts the following settings\&. Specify several [Route] sections to configure several routes\&.
2284 .PP
2285 \fIGateway=\fR
2286 .RS 4
2287 Takes the gateway address or the special values
2288 "_dhcp4"
2289 and
2290 "_ipv6ra"\&. If
2291 "_dhcp4"
2292 or
2293 "_ipv6ra"
2294 is set, then the gateway address provided by DHCPv4 or IPv6 RA is used\&. When"_dhcp4", the acquired DHCPv4 address will be used as the preferred source address of the route, unless it is explicitly configured in
2295 \fIPreferredSource=\fR\&.
2296 .sp
2297 Added in version 211\&.
2298 .RE
2299 .PP
2300 \fIGatewayOnLink=\fR
2301 .RS 4
2302 Takes a boolean\&. If set to true, the kernel does not have to check if the gateway is reachable directly by the current machine (i\&.e\&., attached to the local network), so that we can insert the route in the kernel table without it being complained about\&. Defaults to
2303 "no"\&.
2304 .sp
2305 Added in version 234\&.
2306 .RE
2307 .PP
2308 \fIDestination=\fR
2309 .RS 4
2310 The destination prefix of the route\&. Possibly followed by a slash and the prefix length\&. If omitted, a full\-length host route is assumed\&.
2311 .sp
2312 Added in version 211\&.
2313 .RE
2314 .PP
2315 \fISource=\fR
2316 .RS 4
2317 The source prefix of the route\&. Possibly followed by a slash and the prefix length\&. If omitted, a full\-length host route is assumed\&.
2318 .sp
2319 Added in version 218\&.
2320 .RE
2321 .PP
2322 \fIMetric=\fR
2323 .RS 4
2324 The metric of the route\&. Takes an unsigned integer in the range 0\&...4294967295\&. Defaults to unset, and the kernel\*(Aqs default will be used\&.
2325 .sp
2326 Added in version 216\&.
2327 .RE
2328 .PP
2329 \fIIPv6Preference=\fR
2330 .RS 4
2331 Specifies the route preference as defined in
2332 \m[blue]\fBRFC 4191\fR\m[]\&\s-2\u[24]\d\s+2
2333 for Router Discovery messages\&. Which can be one of
2334 "low"
2335 the route has a lowest priority,
2336 "medium"
2337 the route has a default priority or
2338 "high"
2339 the route has a highest priority\&.
2340 .sp
2341 Added in version 234\&.
2342 .RE
2343 .PP
2344 \fIScope=\fR
2345 .RS 4
2346 The scope of the IPv4 route, which can be
2347 "global",
2348 "site",
2349 "link",
2350 "host", or
2351 "nowhere":
2352 .sp
2353 .RS 4
2354 .ie n \{\
2355 \h'-04'\(bu\h'+03'\c
2356 .\}
2357 .el \{\
2358 .sp -1
2359 .IP \(bu 2.3
2360 .\}
2361 "global"
2362 means the route can reach hosts more than one hop away\&.
2363 .RE
2364 .sp
2365 .RS 4
2366 .ie n \{\
2367 \h'-04'\(bu\h'+03'\c
2368 .\}
2369 .el \{\
2370 .sp -1
2371 .IP \(bu 2.3
2372 .\}
2373 "site"
2374 means an interior route in the local autonomous system\&.
2375 .RE
2376 .sp
2377 .RS 4
2378 .ie n \{\
2379 \h'-04'\(bu\h'+03'\c
2380 .\}
2381 .el \{\
2382 .sp -1
2383 .IP \(bu 2.3
2384 .\}
2385 "link"
2386 means the route can only reach hosts on the local network (one hop away)\&.
2387 .RE
2388 .sp
2389 .RS 4
2390 .ie n \{\
2391 \h'-04'\(bu\h'+03'\c
2392 .\}
2393 .el \{\
2394 .sp -1
2395 .IP \(bu 2.3
2396 .\}
2397 "host"
2398 means the route will not leave the local machine (used for internal addresses like 127\&.0\&.0\&.1)\&.
2399 .RE
2400 .sp
2401 .RS 4
2402 .ie n \{\
2403 \h'-04'\(bu\h'+03'\c
2404 .\}
2405 .el \{\
2406 .sp -1
2407 .IP \(bu 2.3
2408 .\}
2409 "nowhere"
2410 means the destination does not exist\&.
2411 .RE
2412 .sp
2413 For IPv4 route, defaults to
2414 "host"
2415 if
2416 \fIType=\fR
2417 is
2418 "local"
2419 or
2420 "nat", and
2421 "link"
2422 if
2423 \fIType=\fR
2424 is
2425 "broadcast",
2426 "multicast",
2427 "anycast", or
2428 "unicast"\&. In other cases, defaults to
2429 "global"\&. The value is not used for IPv6\&.
2430 .sp
2431 Added in version 219\&.
2432 .RE
2433 .PP
2434 \fIPreferredSource=\fR
2435 .RS 4
2436 The preferred source address of the route\&. Takes
2437 "no"
2438 or an address in the format described in
2439 \fBinet_pton\fR(3)\&. If
2440 \fIGateway=_dhcp4\fR
2441 is specified, defaults to the acquired DHCPv4 address\&. Otherwise, defaults to unset\&. The value
2442 "no"
2443 may be useful to configure a route with
2444 \fIGateway=_dhcp4\fR
2445 without setting preferred source route address\&.
2446 .sp
2447 Added in version 227\&.
2448 .RE
2449 .PP
2450 \fITable=\fR
2451 .RS 4
2452 The table identifier for the route\&. Takes one of predefined names
2453 "default",
2454 "main", and
2455 "local", and names defined in
2456 \fIRouteTable=\fR
2457 in
2458 \fBnetworkd.conf\fR(5), or a number between 1 and 4294967295\&. The table can be retrieved using
2459 \fBip route show table \fR\fB\fInum\fR\fR\&. If unset and
2460 \fIType=\fR
2461 is
2462 "local",
2463 "broadcast",
2464 "anycast", or
2465 "nat", then
2466 "local"
2467 is used\&. In other cases, defaults to
2468 "main"\&.
2469 .sp
2470 Added in version 230\&.
2471 .RE
2472 .PP
2473 \fIHopLimit=\fR
2474 .RS 4
2475 Configures per route hop limit\&. Takes an integer in the range 1\&...255\&. See also
2476 \fIIPv6HopLimit=\fR\&.
2477 .sp
2478 Added in version 255\&.
2479 .RE
2480 .PP
2481 \fIProtocol=\fR
2482 .RS 4
2483 The protocol identifier for the route\&. Takes a number between 0 and 255 or the special values
2484 "kernel",
2485 "boot",
2486 "static",
2487 "ra"
2488 and
2489 "dhcp"\&. Defaults to
2490 "static"\&.
2491 .sp
2492 Added in version 234\&.
2493 .RE
2494 .PP
2495 \fIType=\fR
2496 .RS 4
2497 Specifies the type for the route\&. Takes one of
2498 "unicast",
2499 "local",
2500 "broadcast",
2501 "anycast",
2502 "multicast",
2503 "blackhole",
2504 "unreachable",
2505 "prohibit",
2506 "throw",
2507 "nat", and
2508 "xresolve"\&. If
2509 "unicast", a regular route is defined, i\&.e\&. a route indicating the path to take to a destination network address\&. If
2510 "blackhole", packets to the defined route are discarded silently\&. If
2511 "unreachable", packets to the defined route are discarded and the ICMP message "Host Unreachable" is generated\&. If
2512 "prohibit", packets to the defined route are discarded and the ICMP message "Communication Administratively Prohibited" is generated\&. If
2513 "throw", route lookup in the current routing table will fail and the route selection process will return to Routing Policy Database (RPDB)\&. Defaults to
2514 "unicast"\&.
2515 .sp
2516 Added in version 235\&.
2517 .RE
2518 .PP
2519 \fIInitialCongestionWindow=\fR
2520 .RS 4
2521 The TCP initial congestion window is used during the start of a TCP connection\&. During the start of a TCP session, when a client requests a resource, the server\*(Aqs initial congestion window determines how many packets will be sent during the initial burst of data without waiting for acknowledgement\&. Takes a number between 1 and 1023\&. Note that 100 is considered an extremely large value for this option\&. When unset, the kernel\*(Aqs default (typically 10) will be used\&.
2522 .sp
2523 Added in version 237\&.
2524 .RE
2525 .PP
2526 \fIInitialAdvertisedReceiveWindow=\fR
2527 .RS 4
2528 The TCP initial advertised receive window is the amount of receive data (in bytes) that can initially be buffered at one time on a connection\&. The sending host can send only that amount of data before waiting for an acknowledgment and window update from the receiving host\&. Takes a number between 1 and 1023\&. Note that 100 is considered an extremely large value for this option\&. When unset, the kernel\*(Aqs default will be used\&.
2529 .sp
2530 Added in version 237\&.
2531 .RE
2532 .PP
2533 \fIQuickAck=\fR
2534 .RS 4
2535 Takes a boolean\&. When true, the TCP quick ACK mode for the route is enabled\&. When unset, the kernel\*(Aqs default will be used\&.
2536 .sp
2537 Added in version 237\&.
2538 .RE
2539 .PP
2540 \fIFastOpenNoCookie=\fR
2541 .RS 4
2542 Takes a boolean\&. When true enables TCP fastopen without a cookie on a per\-route basis\&. When unset, the kernel\*(Aqs default will be used\&.
2543 .sp
2544 Added in version 243\&.
2545 .RE
2546 .PP
2547 \fIMTUBytes=\fR
2548 .RS 4
2549 The maximum transmission unit in bytes to set for the route\&. The usual suffixes K, M, G, are supported and are understood to the base of 1024\&.
2550 .sp
2551 Added in version 239\&.
2552 .RE
2553 .PP
2554 \fITCPAdvertisedMaximumSegmentSize=\fR
2555 .RS 4
2556 Specifies the Path MSS (in bytes) hints given on TCP layer\&. The usual suffixes K, M, G, are supported and are understood to the base of 1024\&. An unsigned integer in the range 1\&...4294967294\&. When unset, the kernel\*(Aqs default will be used\&.
2557 .sp
2558 Added in version 248\&.
2559 .RE
2560 .PP
2561 \fITCPCongestionControlAlgorithm=\fR
2562 .RS 4
2563 Specifies the TCP congestion control algorithm for the route\&. Takes a name of the algorithm, e\&.g\&.
2564 "bbr",
2565 "dctcp", or
2566 "vegas"\&. When unset, the kernel\*(Aqs default will be used\&.
2567 .sp
2568 Added in version 252\&.
2569 .RE
2570 .PP
2571 \fITCPRetransmissionTimeoutSec=\fR
2572 .RS 4
2573 Specifies the TCP Retransmission Timeout (RTO) for the route\&. Takes time values in seconds\&. This value specifies the timeout of an alive TCP connection, when retransmissions remain unacknowledged\&. When unset, the kernel\*(Aqs default will be used\&.
2574 .sp
2575 Added in version 255\&.
2576 .RE
2577 .PP
2578 \fIMultiPathRoute=\fR
2579 .RS 4
2580 Configures multipath route\&. Multipath routing is the technique of using multiple alternative paths through a network\&. Takes a gateway address and/or a network interface name or index (prefixed with
2581 "@")\&. At least one of these must be specified\&. Optionally, a weight in 1\&.\&.256 can be specified, separated with whitespace\&. This setting can be specified multiple times\&. If an empty string is assigned, then all previous assignments are cleared\&.
2582 .sp
2583 Examples:
2584 .sp
2585 .if n \{\
2586 .RS 4
2587 .\}
2588 .nf
2589 MultiPathRoute=10\&.0\&.0\&.1@eth0 20
2590 MultiPathRoute=192\&.168\&.1\&.1 50
2591 MultiPathRoute=@wg0 15
2592 MultiPathRoute=2001:db8::1@eth0
2593 .fi
2594 .if n \{\
2595 .RE
2596 .\}
2597 .sp
2598 Added in version 245\&.
2599 .RE
2600 .PP
2601 \fINextHop=\fR
2602 .RS 4
2603 Specifies the nexthop id\&. Takes an unsigned integer in the range 1\&...4294967295\&. If set, the corresponding [NextHop] section must be configured\&. Defaults to unset\&.
2604 .sp
2605 Added in version 248\&.
2606 .RE
2607 .SH "[DHCPV4] SECTION OPTIONS"
2608 .PP
2609 The [DHCPv4] section configures the DHCPv4 client, if it is enabled with the
2610 \fIDHCP=\fR
2611 setting described above:
2612 .PP
2613 \fIRequestAddress=\fR
2614 .RS 4
2615 Takes an IPv4 address\&. When specified, the Requested IP Address option (option code 50) is added with it to the initial DHCPDISCOVER message sent by the DHCP client\&. Defaults to unset, and an already assigned dynamic address to the interface is automatically picked\&.
2616 .sp
2617 Added in version 255\&.
2618 .RE
2619 .PP
2620 \fISendHostname=\fR
2621 .RS 4
2622 When true (the default), the machine\*(Aqs hostname (or the value specified with
2623 \fIHostname=\fR, described below) will be sent to the DHCP server\&. Note that the hostname must consist only of 7\-bit ASCII lower\-case characters and no spaces, and be formatted as a valid DNS domain name\&. A single\-label hostname is sent as DHCP option 12 (Host Name,
2624 \m[blue]\fBRFC 2132\fR\m[]\&\s-2\u[25]\d\s+2); a multi\-label hostname (FQDN) is sent instead as DHCP option 81 (Client FQDN,
2625 \m[blue]\fBRFC 4702\fR\m[]\&\s-2\u[26]\d\s+2)\&. Otherwise, the hostname is not sent even if this option is true\&.
2626 .sp
2627 Added in version 215\&.
2628 .RE
2629 .PP
2630 \fIHostname=\fR
2631 .RS 4
2632 Use this value for the hostname which is sent to the DHCP server, instead of machine\*(Aqs hostname\&. Note that the specified hostname must consist only of 7\-bit ASCII lower\-case characters and no spaces, and be formatted as a valid DNS domain name\&. Multi\-label hostnames (FQDNs) are acceptable; see
2633 \fISendHostname=\fR
2634 above for details\&.
2635 .sp
2636 Added in version 223\&.
2637 .RE
2638 .PP
2639 \fIMUDURL=\fR
2640 .RS 4
2641 When configured, the specified Manufacturer Usage Description (MUD) URL will be sent to the DHCPv4 server\&. Takes a URL of length up to 255 characters\&. A superficial verification that the string is a valid URL will be performed\&. DHCPv4 clients are intended to have at most one MUD URL associated with them\&. See
2642 \m[blue]\fBRFC 8520\fR\m[]\&\s-2\u[27]\d\s+2\&.
2643 .sp
2644 MUD is an embedded software standard defined by the IETF that allows IoT device makers to advertise device specifications, including the intended communication patterns for their device when it connects to the network\&. The network can then use this to author a context\-specific access policy, so the device functions only within those parameters\&.
2645 .sp
2646 Added in version 246\&.
2647 .RE
2648 .PP
2649 \fIClientIdentifier=\fR
2650 .RS 4
2651 The DHCPv4 client identifier to use\&. Takes one of
2652 \fBmac\fR
2653 or
2654 \fBduid\fR\&. If set to
2655 \fBmac\fR, the MAC address of the link is used\&. If set to
2656 \fBduid\fR, an RFC4361\-compliant Client ID, which is the combination of IAID and DUID, is used\&. IAID can be configured by
2657 \fIIAID=\fR\&. DUID can be configured by
2658 \fIDUIDType=\fR
2659 and
2660 \fIDUIDRawData=\fR\&. When
2661 \fIAnonymize=\fR
2662 is enabled,
2663 \fBmac\fR
2664 is unconditionally used and the specified value will be ignored\&. When unspecified, the value specified in the same setting in
2665 \fBnetworkd.conf\fR(5)
2666 will be used\&.
2667 .sp
2668 Added in version 220\&.
2669 .RE
2670 .PP
2671 \fIVendorClassIdentifier=\fR
2672 .RS 4
2673 The vendor class identifier used to identify vendor type and configuration\&.
2674 .sp
2675 Added in version 216\&.
2676 .RE
2677 .PP
2678 \fIUserClass=\fR
2679 .RS 4
2680 A DHCPv4 client can use UserClass option to identify the type or category of user or applications it represents\&. The information contained in this option is a string that represents the user class of which the client is a member\&. Each class sets an identifying string of information to be used by the DHCP service to classify clients\&. Takes a whitespace\-separated list of strings\&.
2681 .sp
2682 Added in version 239\&.
2683 .RE
2684 .PP
2685 \fIDUIDType=\fR
2686 .RS 4
2687 Override the global
2688 \fIDUIDType=\fR
2689 setting for this network\&. See
2690 \fBnetworkd.conf\fR(5)
2691 for a description of possible values\&.
2692 .sp
2693 Added in version 230\&.
2694 .RE
2695 .PP
2696 \fIDUIDRawData=\fR
2697 .RS 4
2698 Override the global
2699 \fIDUIDRawData=\fR
2700 setting for this network\&. See
2701 \fBnetworkd.conf\fR(5)
2702 for a description of possible values\&.
2703 .sp
2704 Added in version 230\&.
2705 .RE
2706 .PP
2707 \fIIAID=\fR
2708 .RS 4
2709 The DHCP Identity Association Identifier (IAID) for the interface, a 32\-bit unsigned integer\&.
2710 .sp
2711 Added in version 230\&.
2712 .RE
2713 .PP
2714 \fIRapidCommit=\fR
2715 .RS 4
2716 Takes a boolean\&. The DHCPv4 client can obtain configuration parameters from a DHCPv4 server through a rapid two\-message exchange (discover and ack)\&. When the rapid commit option is set by both the DHCPv4 client and the DHCPv4 server, the two\-message exchange is used\&. Otherwise, the four\-message exchange (discover, offer, request, and ack) is used\&. The two\-message exchange provides faster client configuration\&. See
2717 \m[blue]\fBRFC 4039\fR\m[]\&\s-2\u[28]\d\s+2
2718 for details\&. Defaults to true when
2719 \fIAnonymize=no\fR
2720 and neither
2721 \fIAllowList=\fR
2722 nor
2723 \fIDenyList=\fR
2724 is specified, and false otherwise\&.
2725 .sp
2726 Added in version 255\&.
2727 .RE
2728 .PP
2729 \fIAnonymize=\fR
2730 .RS 4
2731 Takes a boolean\&. When true, the options sent to the DHCP server will follow the
2732 \m[blue]\fBRFC 7844\fR\m[]\&\s-2\u[29]\d\s+2
2733 (Anonymity Profiles for DHCP Clients) to minimize disclosure of identifying information\&. Defaults to false\&.
2734 .sp
2735 This option should only be set to true when
2736 \fIMACAddressPolicy=\fR
2737 is set to
2738 \fBrandom\fR
2739 (see
2740 \fBsystemd.link\fR(5))\&.
2741 .sp
2742 When true,
2743 \fIClientIdentifier=mac\fR,
2744 \fIRapidCommit=no\fR,
2745 \fISendHostname=no\fR,
2746 \fIUse6RD=no\fR,
2747 \fIUseCaptivePortal=no\fR,
2748 \fIUseMTU=no\fR,
2749 \fIUseNTP=no\fR,
2750 \fIUseSIP=no\fR, and
2751 \fIUseTimezone=no\fR
2752 are implied and these settings in the \&.network file are silently ignored\&. Also,
2753 \fIHostname=\fR,
2754 \fIMUDURL=\fR,
2755 \fIRequestAddress=\fR,
2756 \fIRequestOptions=\fR,
2757 \fISendOption=\fR,
2758 \fISendVendorOption=\fR,
2759 \fIUserClass=\fR, and
2760 \fIVendorClassIdentifier=\fR
2761 are silently ignored\&.
2762 .sp
2763 With this option enabled DHCP requests will mimic those generated by Microsoft Windows, in order to reduce the ability to fingerprint and recognize installations\&. This means DHCP request sizes will grow and lease data will be more comprehensive than normally, though most of the requested data is not actually used\&.
2764 .sp
2765 Added in version 235\&.
2766 .RE
2767 .PP
2768 \fIRequestOptions=\fR
2769 .RS 4
2770 Sets request options to be sent to the server in the DHCPv4 request options list\&. A whitespace\-separated list of integers in the range 1\&...254\&. Defaults to unset\&.
2771 .sp
2772 Added in version 244\&.
2773 .RE
2774 .PP
2775 \fISendOption=\fR
2776 .RS 4
2777 Send an arbitrary raw option in the DHCPv4 request\&. Takes a DHCP option number, data type and data separated with a colon ("\fIoption\fR:\fItype\fR:\fIvalue\fR")\&. The option number must be an integer in the range 1\&...254\&. The type takes one of
2778 "uint8",
2779 "uint16",
2780 "uint32",
2781 "ipv4address", or
2782 "string"\&. Special characters in the data string may be escaped using
2783 \m[blue]\fBC\-style escapes\fR\m[]\&\s-2\u[30]\d\s+2\&. This setting can be specified multiple times\&. If an empty string is specified, then all options specified earlier are cleared\&. Defaults to unset\&.
2784 .sp
2785 Added in version 244\&.
2786 .RE
2787 .PP
2788 \fISendVendorOption=\fR
2789 .RS 4
2790 Send an arbitrary vendor option in the DHCPv4 request\&. Takes a DHCP option number, data type and data separated with a colon ("\fIoption\fR:\fItype\fR:\fIvalue\fR")\&. The option number must be an integer in the range 1\&...254\&. The type takes one of
2791 "uint8",
2792 "uint16",
2793 "uint32",
2794 "ipv4address", or
2795 "string"\&. Special characters in the data string may be escaped using
2796 \m[blue]\fBC\-style escapes\fR\m[]\&\s-2\u[30]\d\s+2\&. This setting can be specified multiple times\&. If an empty string is specified, then all options specified earlier are cleared\&. Defaults to unset\&.
2797 .sp
2798 Added in version 246\&.
2799 .RE
2800 .PP
2801 \fIIPServiceType=\fR
2802 .RS 4
2803 Takes one of the special values
2804 "none",
2805 "CS6", or
2806 "CS4"\&. When
2807 "none"
2808 no IP service type is set to the packet sent from the DHCPv4 client\&. When
2809 "CS6"
2810 (network control) or
2811 "CS4"
2812 (realtime), the corresponding service type will be set\&. Defaults to
2813 "CS6"\&.
2814 .sp
2815 Added in version 244\&.
2816 .RE
2817 .PP
2818 \fISocketPriority=\fR
2819 .RS 4
2820 The Linux socket option
2821 \fBSO_PRIORITY\fR
2822 applied to the raw IP socket used for initial DHCPv4 messages\&. Unset by default\&. Usual values range from 0 to 6\&. More details about
2823 \fBSO_PRIORITY\fR
2824 socket option in
2825 \fBsocket\fR(7)\&. Can be used in conjunction with [VLAN] section
2826 \fIEgressQOSMaps=\fR
2827 setting of \&.netdev file to set the 802\&.1Q VLAN ethernet tagged header priority, see
2828 \fBsystemd.netdev\fR(5)\&.
2829 .sp
2830 Added in version 253\&.
2831 .RE
2832 .PP
2833 \fIBOOTP=\fR
2834 .RS 4
2835 Takes a boolean\&. When enabled, the DHCPv4 client will be configured to communicate with BOOTP servers, rather than with DHCP servers\&. Defaults to off\&.
2836 .sp
2837 Added in version 258\&.
2838 .RE
2839 .PP
2840 \fILabel=\fR
2841 .RS 4
2842 Specifies the label for the IPv4 address received from the DHCP server\&. The label must be a 7\-bit ASCII string with a length of 1\&...15 characters\&. Defaults to unset\&.
2843 .sp
2844 Added in version 250\&.
2845 .RE
2846 .PP
2847 \fIUseDNS=\fR
2848 .RS 4
2849 When true (the default), the DNS servers received from the DHCP server will be used\&.
2850 .sp
2851 This corresponds to the
2852 \fBnameserver\fR
2853 option in
2854 \fBresolv.conf\fR(5)\&.
2855 .sp
2856 Added in version 211\&.
2857 .RE
2858 .PP
2859 \fIRoutesToDNS=\fR
2860 .RS 4
2861 When true, the routes to the DNS servers received from the DHCP server will be configured\&. When
2862 \fIUseDNS=\fR
2863 is disabled, this setting is ignored\&. Defaults to true\&.
2864 .sp
2865 Added in version 243\&.
2866 .RE
2867 .PP
2868 \fIUseNTP=\fR
2869 .RS 4
2870 When true (the default), the NTP servers received from the DHCP server will be used by
2871 systemd\-timesyncd\&.service\&.
2872 .sp
2873 Added in version 220\&.
2874 .RE
2875 .PP
2876 \fIRoutesToNTP=\fR
2877 .RS 4
2878 When true, the routes to the NTP servers received from the DHCP server will be configured\&. When
2879 \fIUseNTP=\fR
2880 is disabled, this setting is ignored\&. Defaults to true\&.
2881 .sp
2882 Added in version 249\&.
2883 .RE
2884 .PP
2885 \fIUseSIP=\fR
2886 .RS 4
2887 When true (the default), the SIP servers received from the DHCP server will be collected and made available to client programs\&.
2888 .sp
2889 Added in version 244\&.
2890 .RE
2891 .PP
2892 \fIUseCaptivePortal=\fR
2893 .RS 4
2894 When true (the default), the captive portal advertised by the DHCP server will be recorded and made available to client programs and displayed in the
2895 \fBnetworkctl\fR(1)
2896 status output per\-link\&.
2897 .sp
2898 Added in version 254\&.
2899 .RE
2900 .PP
2901 \fIUseDNR=\fR
2902 .RS 4
2903 When true, designated resolvers advertised by the DHCP server will be used as encrypted DNS servers\&. See
2904 \m[blue]\fBRFC 9463\fR\m[]\&\s-2\u[31]\d\s+2\&.
2905 .sp
2906 Defaults to unset, and the value for
2907 \fIUseDNS=\fR
2908 will be used\&.
2909 .sp
2910 Added in version 257\&.
2911 .RE
2912 .PP
2913 \fIUseMTU=\fR
2914 .RS 4
2915 When true, the interface maximum transmission unit from the DHCP server will be used on the current link\&. If
2916 \fIMTUBytes=\fR
2917 is set, then this setting is ignored\&. Defaults to false\&.
2918 .sp
2919 Note, some drivers will reset the interfaces if the MTU is changed\&. For such interfaces, please try to use
2920 \fIIgnoreCarrierLoss=\fR
2921 with a short timespan, e\&.g\&.
2922 "3 seconds"\&.
2923 .sp
2924 Added in version 211\&.
2925 .RE
2926 .PP
2927 \fIUseHostname=\fR
2928 .RS 4
2929 When true (the default), the hostname received from the DHCP server will be set as the transient hostname of the system\&.
2930 .sp
2931 Added in version 211\&.
2932 .RE
2933 .PP
2934 \fIUseDomains=\fR
2935 .RS 4
2936 Takes a boolean, or the special value
2937 \fBroute\fR\&. When true, the domain name received from the DHCP server will be used as DNS search domain over this link, similarly to the effect of the
2938 \fBDomains=\fR
2939 setting\&. If set to
2940 \fBroute\fR, the domain name received from the DHCP server will be used for routing DNS queries only, but not for searching, similarly to the effect of the
2941 \fBDomains=\fR
2942 setting when the argument is prefixed with
2943 "~"\&.
2944 .sp
2945 When unspecified, the value specified in the same setting in the [Network] section will be used\&. When it is unspecified, the value specified in the same setting in the [DHCPv4] section in
2946 \fBnetworkd.conf\fR(5)
2947 will be used\&. When it is unspecified, the value specified in the same setting in the [Network] section in
2948 \fBnetworkd.conf\fR(5)
2949 will be used\&. When none of them are specified, defaults to
2950 "no"\&.
2951 .sp
2952 It is recommended to enable this option only on trusted networks, as setting this affects resolution of all hostnames, in particular of single\-label names\&. It is generally safer to use the supplied domain only as routing domain, rather than as search domain, in order to not have it affect local resolution of single\-label names\&.
2953 .sp
2954 When set to true, this setting corresponds to the
2955 \fBdomain\fR
2956 option in
2957 \fBresolv.conf\fR(5)\&.
2958 .sp
2959 Added in version 216\&.
2960 .RE
2961 .PP
2962 \fIUseRoutes=\fR
2963 .RS 4
2964 When true (the default), the static routes will be requested from the DHCP server and added to the routing table with a metric of 1024, and a scope of
2965 \fBglobal\fR,
2966 \fBlink\fR
2967 or
2968 \fBhost\fR, depending on the route\*(Aqs destination and gateway\&. If the destination is on the local host, e\&.g\&., 127\&.x\&.x\&.x, or the same as the link\*(Aqs own address, the scope will be set to
2969 \fBhost\fR\&. Otherwise, if the gateway is null (a direct route), a
2970 \fBlink\fR
2971 scope will be used\&. For anything else, scope defaults to
2972 \fBglobal\fR\&.
2973 .sp
2974 Added in version 215\&.
2975 .RE
2976 .PP
2977 \fIRouteMetric=\fR
2978 .RS 4
2979 Set the routing metric for routes specified by the DHCP server (including the prefix route added for the specified prefix)\&. Takes an unsigned integer in the range 0\&...4294967295\&. Defaults to 1024\&.
2980 .sp
2981 Added in version 217\&.
2982 .RE
2983 .PP
2984 \fIRouteTable=\fR\fI\fInum\fR\fR
2985 .RS 4
2986 The table identifier for DHCP routes\&. Takes one of predefined names
2987 "default",
2988 "main", and
2989 "local", and names defined in
2990 \fIRouteTable=\fR
2991 in
2992 \fBnetworkd.conf\fR(5), or a number between 1\&...4294967295\&.
2993 .sp
2994 When used in combination with
2995 \fIVRF=\fR, the VRF\*(Aqs routing table is used when this parameter is not specified\&.
2996 .sp
2997 Added in version 232\&.
2998 .RE
2999 .PP
3000 \fIRouteMTUBytes=\fR
3001 .RS 4
3002 Specifies the MTU for the DHCP routes\&. Please see the [Route] section for further details\&.
3003 .sp
3004 Added in version 245\&.
3005 .RE
3006 .PP
3007 \fIQuickAck=\fR
3008 .RS 4
3009 Takes a boolean\&. When true, the TCP quick ACK mode is enabled for the routes configured by the acquired DHCPv4 lease\&. When unset, the kernel\*(Aqs default will be used\&.
3010 .sp
3011 Added in version 253\&.
3012 .RE
3013 .PP
3014 \fIInitialCongestionWindow=\fR
3015 .RS 4
3016 As in the [Route] section\&.
3017 .sp
3018 Added in version 255\&.
3019 .RE
3020 .PP
3021 \fIInitialAdvertisedReceiveWindow=\fR
3022 .RS 4
3023 As in the [Route] section\&.
3024 .sp
3025 Added in version 255\&.
3026 .RE
3027 .PP
3028 \fIUseGateway=\fR
3029 .RS 4
3030 When true, and the DHCP server provides a Router option, the default gateway based on the router address will be configured\&. Defaults to unset, and the value specified with
3031 \fIUseRoutes=\fR
3032 will be used\&.
3033 .sp
3034 Note, when the server provides both the Router and Classless Static Routes option, and
3035 \fIUseRoutes=\fR
3036 is enabled, the Router option is always ignored regardless of this setting\&. See
3037 \m[blue]\fBRFC 3442\fR\m[]\&\s-2\u[32]\d\s+2\&.
3038 .sp
3039 Added in version 246\&.
3040 .RE
3041 .PP
3042 \fIUseTimezone=\fR
3043 .RS 4
3044 When true, the timezone received from the DHCP server will be set as timezone of the local system\&. Defaults to false\&.
3045 .sp
3046 Added in version 226\&.
3047 .RE
3048 .PP
3049 \fIUse6RD=\fR
3050 .RS 4
3051 When true, subnets of the received IPv6 prefix are assigned to downstream interfaces which enables
3052 \fIDHCPPrefixDelegation=\fR\&. See also
3053 \fIDHCPPrefixDelegation=\fR
3054 in the [Network] section, the [DHCPPrefixDelegation] section, and
3055 \m[blue]\fBRFC 5969\fR\m[]\&\s-2\u[33]\d\s+2\&. Defaults to false\&.
3056 .sp
3057 Added in version 250\&.
3058 .RE
3059 .PP
3060 \fIUnassignedSubnetPolicy=\fR
3061 .RS 4
3062 Takes
3063 "none", or one of the reject types:
3064 "unreachable",
3065 "prohibit",
3066 "blackhole", or
3067 "throw"\&. If a reject type is specified, the reject route corresponding to the acquired 6RD prefix will be configured\&. For example, when
3068 "unreachable",
3069 .sp
3070 .if n \{\
3071 .RS 4
3072 .\}
3073 .nf
3074 unreachable 2001:db8::/56 dev lo proto dhcp metric 1024 pref medium
3075 .fi
3076 .if n \{\
3077 .RE
3078 .\}
3079 .sp
3080 will be configured\&. See
3081 \m[blue]\fBRFC 7084\fR\m[]\&\s-2\u[34]\d\s+2\&. If
3082 "none"
3083 is specified, such route will not be configured\&. This may be useful when custom firewall rules that handle packets for unassigned subnets will be configured\&. Defaults to
3084 "unreachable"\&.
3085 .sp
3086 Added in version 257\&.
3087 .RE
3088 .PP
3089 \fIIPv6OnlyMode=\fR
3090 .RS 4
3091 When true, the DHCPv4 configuration will be delayed by the timespan provided by the DHCP server and skip to configure dynamic IPv4 network connectivity if IPv6 connectivity is provided within the timespan\&. See
3092 \m[blue]\fBRFC 8925\fR\m[]\&\s-2\u[35]\d\s+2\&. Defaults to false\&.
3093 .sp
3094 Added in version 255\&.
3095 .RE
3096 .PP
3097 \fIFallbackLeaseLifetimeSec=\fR
3098 .RS 4
3099 Allows one to set DHCPv4 lease lifetime when DHCPv4 server does not send the lease lifetime\&. Takes one of
3100 "forever"
3101 or
3102 "infinity"\&. If specified, the acquired address never expires\&. Defaults to unset\&.
3103 .sp
3104 Added in version 246\&.
3105 .RE
3106 .PP
3107 \fIRequestBroadcast=\fR
3108 .RS 4
3109 Request the server to use broadcast messages before the IP address has been configured\&. This is necessary for devices that cannot receive RAW packets, or that cannot receive packets at all before an IP address has been configured\&. On the other hand, this must not be enabled on networks where broadcasts are filtered out\&.
3110 .sp
3111 Added in version 216\&.
3112 .RE
3113 .PP
3114 \fIMaxAttempts=\fR
3115 .RS 4
3116 Specifies how many times the DHCPv4 client configuration should be attempted\&. Takes a number or
3117 "infinity"\&. Defaults to
3118 "infinity"\&. Note that the time between retries is increased exponentially, up to approximately one per minute, so the network will not be overloaded even if this number is high\&. The default is suitable in most circumstances\&.
3119 .sp
3120 Added in version 243\&.
3121 .RE
3122 .PP
3123 \fIListenPort=\fR
3124 .RS 4
3125 Set the port from which the DHCP client packets originate\&.
3126 .sp
3127 Added in version 233\&.
3128 .RE
3129 .PP
3130 \fIServerPort=\fR
3131 .RS 4
3132 Set the port on which the DHCP server is listening\&.
3133 .sp
3134 Added in version 256\&.
3135 .RE
3136 .PP
3137 \fIDenyList=\fR
3138 .RS 4
3139 A whitespace\-separated list of IPv4 addresses\&. Each address can optionally take a prefix length after
3140 "/"\&. DHCP offers from servers in the list are rejected\&. Note that if
3141 \fIAllowList=\fR
3142 is configured then
3143 \fIDenyList=\fR
3144 is ignored\&.
3145 .sp
3146 Note that this filters only DHCP offers, so the filtering might not work when
3147 \fIRapidCommit=\fR
3148 is enabled\&. See also
3149 \fIRapidCommit=\fR
3150 above\&.
3151 .sp
3152 Added in version 246\&.
3153 .RE
3154 .PP
3155 \fIAllowList=\fR
3156 .RS 4
3157 A whitespace\-separated list of IPv4 addresses\&. Each address can optionally take a prefix length after
3158 "/"\&. DHCP offers from servers in the list are accepted\&.
3159 .sp
3160 Note that this filters only DHCP offers, so the filtering might not work when
3161 \fIRapidCommit=\fR
3162 is enabled\&. See also
3163 \fIRapidCommit=\fR
3164 above\&.
3165 .sp
3166 Added in version 246\&.
3167 .RE
3168 .PP
3169 \fISendRelease=\fR
3170 .RS 4
3171 When true, the DHCPv4 client sends a DHCP release packet when it stops\&. Defaults to true\&.
3172 .sp
3173 Added in version 243\&.
3174 .RE
3175 .PP
3176 \fISendDecline=\fR
3177 .RS 4
3178 A boolean\&. When true,
3179 \fBsystemd\-networkd\fR
3180 performs IPv4 Duplicate Address Detection to the acquired address by the DHCPv4 client\&. If duplicate is detected, the DHCPv4 client rejects the address by sending a
3181 \fBDHCPDECLINE\fR
3182 packet to the DHCP server, and tries to obtain an IP address again\&. See
3183 \m[blue]\fBRFC 5227\fR\m[]\&\s-2\u[8]\d\s+2\&. Defaults to false\&.
3184 .sp
3185 Added in version 245\&.
3186 .RE
3187 .PP
3188 \fINetLabel=\fR
3189 .RS 4
3190 This applies the NetLabel for the addresses received with DHCP, like
3191 \fINetLabel=\fR
3192 in [Address] section applies it to statically configured addresses\&. See
3193 \fINetLabel=\fR
3194 in [Address] section for more details\&.
3195 .sp
3196 Added in version 252\&.
3197 .RE
3198 .PP
3199 \fINFTSet=\fR
3200 .RS 4
3201 This applies the NFT set for the network configuration received with DHCP, like
3202 \fINFTSet=\fR
3203 in [Address] section applies it to static configuration\&. See
3204 \fINFTSet=\fR
3205 in [Address] section for more details\&. For
3206 "address"
3207 or
3208 "prefix"
3209 source types, the type of the element used in the NFT filter must be
3210 "ipv4_addr"\&.
3211 .sp
3212 Added in version 255\&.
3213 .RE
3214 .SH "[DHCPV6] SECTION OPTIONS"
3215 .PP
3216 The [DHCPv6] section configures the DHCPv6 client, if it is enabled with the
3217 \fIDHCP=\fR
3218 setting described above, or invoked by the IPv6 Router Advertisement:
3219 .PP
3220 \fIMUDURL=\fR, \fIIAID=\fR, \fIDUIDType=\fR, \fIDUIDRawData=\fR, \fIRequestOptions=\fR
3221 .RS 4
3222 As in the [DHCPv4] section\&.
3223 .sp
3224 Added in version 246\&.
3225 .RE
3226 .PP
3227 \fISendOption=\fR
3228 .RS 4
3229 As in the [DHCPv4] section, however because DHCPv6 uses 16\-bit fields to store option numbers, the option number is an integer in the range 1\&...65536\&.
3230 .sp
3231 Added in version 246\&.
3232 .RE
3233 .PP
3234 \fISendVendorOption=\fR
3235 .RS 4
3236 Send an arbitrary vendor option in the DHCPv6 request\&. Takes an enterprise identifier, DHCP option number, data type, and data separated with a colon ("\fIenterprise identifier\fR:\fIoption\fR:\fItype\fR:\fIvalue\fR")\&. Enterprise identifier is an unsigned integer in the range 1\&...4294967294\&. The option number must be an integer in the range 1\&...254\&. Data type takes one of
3237 "uint8",
3238 "uint16",
3239 "uint32",
3240 "ipv4address",
3241 "ipv6address", or
3242 "string"\&. Special characters in the data string may be escaped using
3243 \m[blue]\fBC\-style escapes\fR\m[]\&\s-2\u[30]\d\s+2\&. This setting can be specified multiple times\&. If an empty string is specified, then all options specified earlier are cleared\&. Defaults to unset\&.
3244 .sp
3245 Added in version 246\&.
3246 .RE
3247 .PP
3248 \fIUserClass=\fR
3249 .RS 4
3250 A DHCPv6 client can use User Class option to identify the type or category of user or applications it represents\&. The information contained in this option is a string that represents the user class of which the client is a member\&. Each class sets an identifying string of information to be used by the DHCP service to classify clients\&. Special characters in the data string may be escaped using
3251 \m[blue]\fBC\-style escapes\fR\m[]\&\s-2\u[30]\d\s+2\&. This setting can be specified multiple times\&. If an empty string is specified, then all options specified earlier are cleared\&. Takes a whitespace\-separated list of strings\&. Note that currently
3252 \fBNUL\fR
3253 bytes are not allowed\&.
3254 .sp
3255 Added in version 246\&.
3256 .RE
3257 .PP
3258 \fIVendorClass=\fR
3259 .RS 4
3260 A DHCPv6 client can use VendorClass option to identify the vendor that manufactured the hardware on which the client is running\&. The information contained in the data area of this option is contained in one or more opaque fields that identify details of the hardware configuration\&. Takes a whitespace\-separated list of strings\&.
3261 .sp
3262 Added in version 246\&.
3263 .RE
3264 .PP
3265 \fIPrefixDelegationHint=\fR
3266 .RS 4
3267 Takes an IPv6 address with prefix length in the same format as the
3268 \fIAddress=\fR
3269 in the [Network] section\&. The DHCPv6 client will include a prefix hint in the DHCPv6 solicitation sent to the server\&. The prefix length must be in the range 1\&...128\&. Defaults to unset\&.
3270 .sp
3271 Added in version 244\&.
3272 .RE
3273 .PP
3274 \fIUnassignedSubnetPolicy=\fR
3275 .RS 4
3276 Takes
3277 "none"
3278 or one of the reject types:
3279 "unreachable",
3280 "prohibit",
3281 "blackhole", or
3282 "throw"\&. If a reject type is specified, the reject route corresponding to the delegated prefix will be configured\&. For example, when
3283 "unreachable",
3284 .sp
3285 .if n \{\
3286 .RS 4
3287 .\}
3288 .nf
3289 unreachable 2001:db8::/56 dev lo proto dhcp metric 1024 pref medium
3290 .fi
3291 .if n \{\
3292 .RE
3293 .\}
3294 .sp
3295 will be configured\&. See
3296 \m[blue]\fBRFC 7084\fR\m[]\&\s-2\u[34]\d\s+2\&. If
3297 "none"
3298 is specified, such route will not be configured\&. This may be useful when custom firewall rules that handle packets for unassigned subnets will be configured\&. Defaults to
3299 "unreachable"\&.
3300 .sp
3301 Added in version 257\&.
3302 .RE
3303 .PP
3304 \fIRouteTable=\fR\fI\fInum\fR\fR
3305 .RS 4
3306 The table identifier for routes installed by the DHCPv6 client, e\&.g\&. unreachable routes for delegated prefixes\&. Takes one of the predefined names
3307 "default",
3308 "main", and
3309 "local", names defined in
3310 \fIRouteTable=\fR
3311 in
3312 \fBnetworkd.conf\fR(5), or a number between 1\&...4294967295\&.
3313 .sp
3314 When used in combination with
3315 \fIVRF=\fR, the VRF\*(Aqs routing table is used when this parameter is not specified\&.
3316 .sp
3317 Added in version 261\&.
3318 .RE
3319 .PP
3320 \fIRapidCommit=\fR
3321 .RS 4
3322 Takes a boolean\&. The DHCPv6 client can obtain configuration parameters from a DHCPv6 server through a rapid two\-message exchange (solicit and reply)\&. When the rapid commit option is set by both the DHCPv6 client and the DHCPv6 server, the two\-message exchange is used\&. Otherwise, the four\-message exchange (solicit, advertise, request, and reply) is used\&. The two\-message exchange provides faster client configuration\&. See
3323 \m[blue]\fBRFC 3315\fR\m[]\&\s-2\u[36]\d\s+2
3324 for details\&. Defaults to true, and the two\-message exchange will be used if the server support it\&.
3325 .sp
3326 Added in version 252\&.
3327 .RE
3328 .PP
3329 \fISendHostname=\fR
3330 .RS 4
3331 When true (the default), the machine\*(Aqs hostname (or the value specified with
3332 \fIHostname=\fR, described below) will be sent to the DHCPv6 server\&. Note that the hostname must consist only of 7\-bit ASCII lower\-case characters and no spaces or dots, and be formatted as a valid DNS domain name\&. Otherwise, the hostname is not sent even if this option is true\&.
3333 .sp
3334 Added in version 255\&.
3335 .RE
3336 .PP
3337 \fIHostname=\fR
3338 .RS 4
3339 Use this value for the hostname which is sent to the DHCPv6 server, instead of machine\*(Aqs hostname\&. Note that the specified hostname must consist only of 7\-bit ASCII lower\-case characters and no spaces or dots, and be formatted as a valid DNS domain name\&.
3340 .sp
3341 Added in version 255\&.
3342 .RE
3343 .PP
3344 \fIUseAddress=\fR
3345 .RS 4
3346 When true (the default), the IP addresses provided by the DHCPv6 server will be assigned\&.
3347 .sp
3348 Added in version 248\&.
3349 .RE
3350 .PP
3351 \fIUseCaptivePortal=\fR
3352 .RS 4
3353 When true (the default), the captive portal advertised by the DHCPv6 server will be recorded and made available to client programs and displayed in the
3354 \fBnetworkctl\fR(1)
3355 status output per\-link\&.
3356 .sp
3357 Added in version 254\&.
3358 .RE
3359 .PP
3360 \fIUseDelegatedPrefix=\fR
3361 .RS 4
3362 When true (the default), the client will request the DHCPv6 server to delegate prefixes\&. If the server provides prefixes to be delegated, then subnets of the prefixes are assigned to the interfaces that have
3363 \fIDHCPPrefixDelegation=yes\fR\&. See also the
3364 \fIDHCPPrefixDelegation=\fR
3365 setting in the [Network] section, settings in the [DHCPPrefixDelegation] section, and
3366 \m[blue]\fBRFC 8415\fR\m[]\&\s-2\u[37]\d\s+2\&.
3367 .sp
3368 Added in version 250\&.
3369 .RE
3370 .PP
3371 \fIUseDNS=\fR, \fIUseDNR=\fR, \fIUseNTP=\fR, \fIUseSIP=\fR, \fIUseHostname=\fR, \fIUseDomains=\fR, \fINetLabel=\fR, \fISendRelease=\fR
3372 .RS 4
3373 As in the [DHCPv4] section\&.
3374 .sp
3375 Added in version 243\&.
3376 .RE
3377 .PP
3378 \fINFTSet=\fR
3379 .RS 4
3380 This applies the NFT set for the network configuration received with DHCP, like
3381 \fINFTSet=\fR
3382 in [Address] section applies it to static configuration\&. See
3383 \fINFTSet=\fR
3384 in [Address] section for more details\&. For
3385 "address"
3386 or
3387 "prefix"
3388 source types, the type of the element used in the NFT filter must be
3389 "ipv6_addr"\&.
3390 .sp
3391 Added in version 255\&.
3392 .RE
3393 .PP
3394 \fIWithoutRA=\fR
3395 .RS 4
3396 Allows DHCPv6 client to start without router advertisements\*(Aqs
3397 "managed"
3398 or
3399 "other configuration"
3400 flag\&. Takes one of
3401 "no",
3402 "solicit", or
3403 "information\-request"\&. If this is not specified,
3404 "solicit"
3405 is used when
3406 \fIDHCPPrefixDelegation=\fR
3407 is enabled and
3408 \fIUplinkInterface=:self\fR
3409 is specified in the [DHCPPrefixDelegation] section\&. Otherwise, defaults to
3410 "no", and the DHCPv6 client will be started when an RA is received\&. See also the
3411 \fIDHCPv6Client=\fR
3412 setting in the [IPv6AcceptRA] section\&.
3413 .sp
3414 Added in version 246\&.
3415 .RE
3416 .SH "[DHCPPREFIXDELEGATION] SECTION OPTIONS"
3417 .PP
3418 The [DHCPPrefixDelegation] section configures subnet prefixes of the delegated prefixes acquired by a DHCPv6 client or by a DHCPv4 client through the 6RD option on another interface\&. The settings in this section are used only when the
3419 \fIDHCPPrefixDelegation=\fR
3420 setting in the [Network] section is enabled\&.
3421 .PP
3422 \fIUplinkInterface=\fR
3423 .RS 4
3424 Specifies the name or the index of the uplink interface, or one of the special values
3425 ":self"
3426 and
3427 ":auto"\&. When
3428 ":self", the interface itself is considered the uplink interface, and
3429 \fIWithoutRA=solicit\fR
3430 is implied if the setting is not explicitly specified\&. When
3431 ":auto", the first link which acquired prefixes to be delegated from the DHCPv6 or DHCPv4 server is selected\&. Defaults to
3432 ":auto"\&.
3433 .sp
3434 Added in version 250\&.
3435 .RE
3436 .PP
3437 \fISubnetId=\fR
3438 .RS 4
3439 Configure a specific subnet ID on the interface from a (previously) received prefix delegation\&. You can either set "auto" (the default) or a specific subnet ID (as defined in
3440 \m[blue]\fBRFC 4291\fR\m[]\&\s-2\u[38]\d\s+2, section 2\&.5\&.4), in which case the allowed value is hexadecimal, from 0 to 0x7fffffffffffffff inclusive\&.
3441 .sp
3442 Added in version 246\&.
3443 .RE
3444 .PP
3445 \fIAnnounce=\fR
3446 .RS 4
3447 Takes a boolean\&. When enabled, and
3448 \fIIPv6SendRA=\fR
3449 in [Network] section is enabled, the delegated prefixes are distributed through the IPv6 Router Advertisement\&. This setting will be ignored when the
3450 \fIDHCPPrefixDelegation=\fR
3451 setting is enabled on the upstream interface\&. Defaults to yes\&.
3452 .sp
3453 Added in version 247\&.
3454 .RE
3455 .PP
3456 \fIAssign=\fR
3457 .RS 4
3458 Takes a boolean\&. Specifies whether to add an address from the delegated prefixes which are received from the WAN interface by the DHCPv6 Prefix Delegation\&. When true (on LAN interface), the EUI\-64 algorithm will be used by default to form an interface identifier from the delegated prefixes\&. See also
3459 \fIToken=\fR
3460 setting below\&. Defaults to yes\&.
3461 .sp
3462 Added in version 246\&.
3463 .RE
3464 .PP
3465 \fIToken=\fR
3466 .RS 4
3467 Specifies an optional address generation mode for assigning an address in each delegated prefix\&. This accepts the same syntax as
3468 \fIToken=\fR
3469 in the [IPv6AcceptRA] section\&. If
3470 \fIAssign=\fR
3471 is set to false, then this setting will be ignored\&. Defaults to unset, which means the EUI\-64 algorithm will be used\&.
3472 .sp
3473 Added in version 246\&.
3474 .RE
3475 .PP
3476 \fIManageTemporaryAddress=\fR
3477 .RS 4
3478 As in the [Address] section, but defaults to true\&.
3479 .sp
3480 Added in version 248\&.
3481 .RE
3482 .PP
3483 \fIRouteMetric=\fR
3484 .RS 4
3485 The metric of the route to the delegated prefix subnet\&. Takes an unsigned integer in the range 0\&...4294967295\&. When set to 0, the kernel\*(Aqs default value is used\&. Defaults to 256\&.
3486 .sp
3487 Added in version 249\&.
3488 .RE
3489 .PP
3490 \fINetLabel=\fR
3491 .RS 4
3492 This applies the NetLabel for the addresses received with DHCP, like
3493 \fINetLabel=\fR
3494 in [Address] section applies it to statically configured addresses\&. See
3495 \fINetLabel=\fR
3496 in [Address] section for more details\&.
3497 .sp
3498 Added in version 252\&.
3499 .RE
3500 .PP
3501 \fINFTSet=\fR
3502 .RS 4
3503 This applies the NFT set for the network configuration received with DHCP, like
3504 \fINFTSet=\fR
3505 in [Address] section applies it to static configuration\&. See
3506 \fINFTSet=\fR
3507 in [Address] section for more details\&. For
3508 "address"
3509 or
3510 "prefix"
3511 source types, the type of the element used in the NFT filter must be
3512 "ipv6_addr"\&.
3513 .sp
3514 Added in version 255\&.
3515 .RE
3516 .SH "[IPV6ACCEPTRA] SECTION OPTIONS"
3517 .PP
3518 The [IPv6AcceptRA] section configures the IPv6 Router Advertisement (RA) client, if it is enabled with the
3519 \fIIPv6AcceptRA=\fR
3520 setting described above:
3521 .PP
3522 \fIUseRedirect=\fR
3523 .RS 4
3524 When true (the default), Redirect message sent by the current first\-hop router will be accepted, and routes to redirected nodes will be configured\&.
3525 .sp
3526 Added in version 256\&.
3527 .RE
3528 .PP
3529 \fIToken=\fR
3530 .RS 4
3531 Specifies an optional address generation mode for the Stateless Address Autoconfiguration (SLAAC)\&. The following values are supported:
3532 .PP
3533 \fBeui64\fR
3534 .RS 4
3535 The EUI\-64 algorithm will be used to generate an address for that prefix\&. Only supported by Ethernet or InfiniBand interfaces\&.
3536 .sp
3537 Added in version 250\&.
3538 .RE
3539 .PP
3540 \fBstatic:\fR\fB\fIADDRESS\fR\fR
3541 .RS 4
3542 An IPv6 address must be specified after a colon (":"), and the lower bits of the supplied address are combined with the upper bits of a prefix received in a Router Advertisement (RA) message to form a complete address\&. Note that if multiple prefixes are received in an RA message, or in multiple RA messages, addresses will be formed from each of them using the supplied address\&. This mode implements SLAAC but uses a static interface identifier instead of an identifier generated by using the EUI\-64 algorithm\&. Because the interface identifier is static, if Duplicate Address Detection detects that the computed address is a duplicate (in use by another node on the link), then this mode will fail to provide an address for that prefix\&. If an IPv6 address without
3543 "static"
3544 is specified, then
3545 "static"
3546 mode is assumed\&.
3547 .sp
3548 Added in version 250\&.
3549 .RE
3550 .PP
3551 \fBprefixstable[:\fR\fB\fIADDRESS\fR\fR\fB][,\fR\fB\fIUUID\fR\fR\fB]\fR
3552 .RS 4
3553 The algorithm specified in
3554 \m[blue]\fBRFC 7217\fR\m[]\&\s-2\u[39]\d\s+2
3555 will be used to generate interface identifiers\&. This mode can optionally take an IPv6 address separated with a colon (":")\&. If an IPv6 address is specified, then an interface identifier is generated only when a prefix received in an RA message matches the supplied address\&.
3556 .sp
3557 This mode can also optionally take a non\-null UUID in the format which
3558 \fBsd_id128_from_string()\fR
3559 accepts, e\&.g\&.
3560 "86b123b969ba4b7eb8b3d8605123525a"
3561 or
3562 "86b123b9\-69ba\-4b7e\-b8b3\-d8605123525a"\&. If a UUID is specified, the value is used as the secret key to generate interface identifiers\&. If not specified, then an application specific ID generated with the system\*(Aqs machine\-ID will be used as the secret key\&. See
3563 \fBsd-id128\fR(3),
3564 \fBsd_id128_from_string\fR(3), and
3565 \fBsd_id128_get_machine\fR(3)\&.
3566 .sp
3567 Note that the
3568 "prefixstable"
3569 algorithm uses both the interface name and MAC address as input to the hash to compute the interface identifier, so if either of those are changed the resulting interface identifier (and address) will be changed, even if the prefix received in the RA message has not been changed\&.
3570 .sp
3571 Added in version 250\&.
3572 .RE
3573 .sp
3574 If no address generation mode is specified (which is the default), or a received prefix does not match any of the addresses provided in
3575 "prefixstable"
3576 mode, then the EUI\-64 algorithm will be used for Ethernet or InfiniBand interfaces, otherwise
3577 "prefixstable"
3578 will be used to form an interface identifier for that prefix\&.
3579 .sp
3580 This setting can be specified multiple times\&. If an empty string is assigned, then the all previous assignments are cleared\&.
3581 .sp
3582 Examples:
3583 .sp
3584 .if n \{\
3585 .RS 4
3586 .\}
3587 .nf
3588 Token=eui64
3589 Token=::1a:2b:3c:4d
3590 Token=static:::1a:2b:3c:4d
3591 Token=prefixstable
3592 Token=prefixstable:2002:da8:1::
3593 .fi
3594 .if n \{\
3595 .RE
3596 .\}
3597 .sp
3598 Added in version 250\&.
3599 .RE
3600 .PP
3601 \fIUseDNS=\fR
3602 .RS 4
3603 When true (the default), the DNS servers received in the Router Advertisement will be used\&.
3604 .sp
3605 This corresponds to the
3606 \fBnameserver\fR
3607 option in
3608 \fBresolv.conf\fR(5)\&.
3609 .sp
3610 Added in version 231\&.
3611 .RE
3612 .PP
3613 \fIUseDNR=\fR
3614 .RS 4
3615 When true, the DNR servers received in the Router Advertisement will be used\&. Defaults to the value of
3616 \fBUseDNS=\fR\&.
3617 .sp
3618 Added in version 257\&.
3619 .RE
3620 .PP
3621 \fIUseDomains=\fR
3622 .RS 4
3623 Takes a boolean, or the special value
3624 "route"\&. When true, the domain name received via IPv6 Router Advertisement (RA) will be used as DNS search domain over this link, similarly to the effect of the
3625 \fBDomains=\fR
3626 setting\&. If set to
3627 "route", the domain name received via IPv6 RA will be used for routing DNS queries only, but not for searching, similarly to the effect of the
3628 \fBDomains=\fR
3629 setting when the argument is prefixed with
3630 "~"\&. Defaults to false\&.
3631 .sp
3632 It is recommended to enable this option only on trusted networks, as setting this affects resolution of all hostnames, in particular of single\-label names\&. It is generally safer to use the supplied domain only as routing domain, rather than as search domain, in order to not have it affect local resolution of single\-label names\&.
3633 .sp
3634 When set to true, this setting corresponds to the
3635 \fBdomain\fR
3636 option in
3637 \fBresolv.conf\fR(5)\&.
3638 .sp
3639 Added in version 231\&.
3640 .RE
3641 .PP
3642 \fIRouteTable=\fR\fI\fInum\fR\fR
3643 .RS 4
3644 The table identifier for the routes received in the Router Advertisement\&. Takes one of predefined names
3645 "default",
3646 "main", and
3647 "local", and names defined in
3648 \fIRouteTable=\fR
3649 in
3650 \fBnetworkd.conf\fR(5), or a number between 1\&...4294967295\&.
3651 .sp
3652 When used in combination with
3653 \fIVRF=\fR, the VRF\*(Aqs routing table is used when this parameter is not specified\&.
3654 .sp
3655 Added in version 232\&.
3656 .RE
3657 .PP
3658 \fIRouteMetric=\fR
3659 .RS 4
3660 Set the routing metric for the routes received in the Router Advertisement\&. Takes an unsigned integer in the range 0\&...4294967295, or three unsigned integer separated with
3661 ":", in that case the first one is used when the router preference is high, the second is for medium preference, and the last is for low preference ("\fIhigh\fR:\fImedium\fR:\fIlow\fR")\&. Defaults to
3662 "512:1024:2048"\&.
3663 .sp
3664 Added in version 249\&.
3665 .RE
3666 .PP
3667 \fIQuickAck=\fR
3668 .RS 4
3669 Takes a boolean\&. When true, the TCP quick ACK mode is enabled for the routes configured by the received RAs\&. When unset, the kernel\*(Aqs default will be used\&.
3670 .sp
3671 Added in version 253\&.
3672 .RE
3673 .PP
3674 \fIUseMTU=\fR
3675 .RS 4
3676 Takes a boolean\&. When true, the MTU received in the Router Advertisement will be used\&. Defaults to true\&.
3677 .sp
3678 Added in version 250\&.
3679 .RE
3680 .PP
3681 \fIUseHopLimit=\fR
3682 .RS 4
3683 Takes a boolean\&. When true, the hop limit received in the Router Advertisement will be set to routes configured based on the advertisement\&. See also
3684 \fIIPv6HopLimit=\fR\&. Defaults to true\&.
3685 .sp
3686 Added in version 255\&.
3687 .RE
3688 .PP
3689 \fIUseReachableTime=\fR
3690 .RS 4
3691 Takes a boolean\&. When true, the reachable time received in the Router Advertisement will be set on the interface receiving the advertisement\&. It is used as the base timespan of the validity of a neighbor entry\&. Defaults to true\&.
3692 .sp
3693 Added in version 256\&.
3694 .RE
3695 .PP
3696 \fIUseRetransmissionTime=\fR
3697 .RS 4
3698 Takes a boolean\&. When true, the retransmission time received in the Router Advertisement will be set on the interface receiving the advertisement\&. It is used as the time between retransmissions of Neighbor Solicitation messages to a neighbor when resolving the address or when probing the reachability of a neighbor\&. Defaults to true\&.
3699 .sp
3700 Added in version 256\&.
3701 .RE
3702 .PP
3703 \fIUseGateway=\fR
3704 .RS 4
3705 When true (the default), the router address will be configured as the default gateway\&.
3706 .sp
3707 Added in version 250\&.
3708 .RE
3709 .PP
3710 \fIUseRoutePrefix=\fR
3711 .RS 4
3712 When true (the default), the routes corresponding to the route prefixes received in the Router Advertisement will be configured\&.
3713 .sp
3714 Added in version 250\&.
3715 .RE
3716 .PP
3717 \fIUseCaptivePortal=\fR
3718 .RS 4
3719 When true (the default), the captive portal received in the Router Advertisement will be recorded and made available to client programs and displayed in the
3720 \fBnetworkctl\fR(1)
3721 status output per\-link\&.
3722 .sp
3723 Added in version 254\&.
3724 .RE
3725 .PP
3726 \fIUsePREF64=\fR
3727 .RS 4
3728 When true, the IPv6 PREF64 (or NAT64) prefixes received in the Router Advertisement will be recorded and made available to client programs and displayed in the
3729 \fBnetworkctl\fR(1)
3730 status output per\-link\&. See
3731 \m[blue]\fBRFC 8781\fR\m[]\&\s-2\u[40]\d\s+2\&. Defaults to false\&.
3732 .sp
3733 Added in version 255\&.
3734 .RE
3735 .PP
3736 \fIUseAutonomousPrefix=\fR
3737 .RS 4
3738 When true (the default), the autonomous prefix received in the Router Advertisement will be used and take precedence over any statically configured ones\&.
3739 .sp
3740 Added in version 242\&.
3741 .RE
3742 .PP
3743 \fIUseOnLinkPrefix=\fR
3744 .RS 4
3745 When true (the default), the onlink prefix received in the Router Advertisement will be used and takes precedence over any statically configured ones\&.
3746 .sp
3747 Added in version 242\&.
3748 .RE
3749 .PP
3750 \fIRouterDenyList=\fR
3751 .RS 4
3752 A whitespace\-separated list of IPv6 router addresses\&. Each address can optionally take a prefix length after
3753 "/"\&. Any information advertised by the listed router is ignored\&.
3754 .sp
3755 Added in version 248\&.
3756 .RE
3757 .PP
3758 \fIRouterAllowList=\fR
3759 .RS 4
3760 A whitespace\-separated list of IPv6 router addresses\&. Each address can optionally take a prefix length after
3761 "/"\&. Only information advertised by the listed router is accepted\&. Note that if
3762 \fIRouterAllowList=\fR
3763 is configured then
3764 \fIRouterDenyList=\fR
3765 is ignored\&.
3766 .sp
3767 Added in version 248\&.
3768 .RE
3769 .PP
3770 \fIPrefixDenyList=\fR
3771 .RS 4
3772 A whitespace\-separated list of IPv6 prefixes\&. Each prefix can optionally take its prefix length after
3773 "/"\&. IPv6 prefixes supplied via router advertisements in the list are ignored\&.
3774 .sp
3775 Added in version 248\&.
3776 .RE
3777 .PP
3778 \fIPrefixAllowList=\fR
3779 .RS 4
3780 A whitespace\-separated list of IPv6 prefixes\&. Each prefix can optionally take its prefix length after
3781 "/"\&. IPv6 prefixes supplied via router advertisements in the list are allowed\&. Note that if
3782 \fIPrefixAllowList=\fR
3783 is configured then
3784 \fIPrefixDenyList=\fR
3785 is ignored\&.
3786 .sp
3787 Added in version 248\&.
3788 .RE
3789 .PP
3790 \fIRouteDenyList=\fR
3791 .RS 4
3792 A whitespace\-separated list of IPv6 route prefixes\&. Each prefix can optionally take its prefix length after
3793 "/"\&. IPv6 route prefixes supplied via router advertisements in the list are ignored\&.
3794 .sp
3795 Added in version 248\&.
3796 .RE
3797 .PP
3798 \fIRouteAllowList=\fR
3799 .RS 4
3800 A whitespace\-separated list of IPv6 route prefixes\&. Each prefix can optionally take its prefix length after
3801 "/"\&. IPv6 route prefixes supplied via router advertisements in the list are allowed\&. Note that if
3802 \fIRouteAllowList=\fR
3803 is configured then
3804 \fIRouteDenyList=\fR
3805 is ignored\&.
3806 .sp
3807 Added in version 248\&.
3808 .RE
3809 .PP
3810 \fIDHCPv6Client=\fR
3811 .RS 4
3812 Takes a boolean, or the special value
3813 "always"\&. When true, the DHCPv6 client will be started in
3814 "solicit"
3815 mode if the RA has the
3816 "managed"
3817 flag or
3818 "information\-request"
3819 mode if the RA lacks the
3820 "managed"
3821 flag but has the
3822 "other configuration"
3823 flag\&. If set to
3824 "always", the DHCPv6 client will be started in
3825 "solicit"
3826 mode when an RA is received, even if neither the
3827 "managed"
3828 nor the
3829 "other configuration"
3830 flag is set in the RA\&. This will be ignored when
3831 \fIWithoutRA=\fR
3832 in the [DHCPv6] section is enabled, or
3833 \fIUplinkInterface=:self\fR
3834 in the [DHCPPrefixDelegation] section is specified\&. Defaults to true\&.
3835 .sp
3836 Added in version 246\&.
3837 .RE
3838 .PP
3839 \fINetLabel=\fR
3840 .RS 4
3841 This applies the NetLabel for the addresses received with RA, like
3842 \fINetLabel=\fR
3843 in [Address] section applies it to statically configured addresses\&. See
3844 \fINetLabel=\fR
3845 in [Address] section for more details\&.
3846 .sp
3847 Added in version 252\&.
3848 .RE
3849 .PP
3850 \fINFTSet=\fR
3851 .RS 4
3852 This applies the NFT set for the network configuration received with RA, like
3853 \fINFTSet=\fR
3854 in [Address] section applies it to static configuration\&. See
3855 \fINFTSet=\fR
3856 in [Address] section for more details\&. For
3857 "address"
3858 or
3859 "prefix"
3860 source types, the type of the element used in the NFT filter must be
3861 "ipv6_addr"\&.
3862 .sp
3863 Added in version 255\&.
3864 .RE
3865 .SH "[DHCPRELAY] SECTION OPTIONS"
3866 .PP
3867 The [DHCPRelay] section contains per\-interface settings for the DHCP relay agent\&. The settings in this section are only used when
3868 \fIDHCPRelay=\fR
3869 in the [Network] section is configured\&.
3870 .PP
3871 \fIAgentAddress=\fR
3872 .RS 4
3873 Takes an IPv4 address\&. The specified address is used as the source IP address of packets forwarded to the upstream DHCP server\&. The address may also be used for the Server Identifier Override sub\-option and the Link Selection sub\-option in the Relay Agent Information option appended to DHCP messages forwarded to the upstream DHCP server\&. This setting applies to both upstream and downstream interfaces\&. Defaults to unset\&. If unset, a statically configured IPv4 address in the \&.network file is selected automatically\&. When multiple static IPv4 addresses are configured, it is recommended to specify this setting explicitly\&.
3874 .sp
3875 Added in version 261\&.
3876 .RE
3877 .PP
3878 \fIGatewayAddress=\fR
3879 .RS 4
3880 Takes an IPv4 address\&. The specified address is set to the
3881 "giaddr"
3882 field of the DHCP message header when the DHCP message is forwarded to the upstream DHCP server\&. This is used only when
3883 \fIDHCPRelay=downstream\fR, and ignored otherwise\&. Defaults to unset, and the same address specified with
3884 \fIAgentAddress=\fR
3885 will be used\&.
3886 .sp
3887 Added in version 261\&.
3888 .RE
3889 .PP
3890 \fICircuitId=\fR
3891 .RS 4
3892 Specifies the circuit ID of the downstream interface\&. This is set as the Circuit ID sub\-option in the Relay Agent Information option in the forwarded DHCP message\&. Takes a data type and data separated with a colon ("\fItype\fR:\fIvalue\fR")\&. The type takes one of
3893 "uint8",
3894 "uint16",
3895 "uint32",
3896 "ipv4address",
3897 "ipv6address", or
3898 "string"\&. Special characters in the data string may be escaped using
3899 \m[blue]\fBC\-style escapes\fR\m[]\&\s-2\u[30]\d\s+2\&. This is used only when
3900 \fIDHCPRelay=downstream\fR, and ignored otherwise\&. If unset, the name of the interface will be used\&.
3901 .sp
3902 Added in version 261\&.
3903 .RE
3904 .PP
3905 \fIVirtualSubnetSelection=\fR
3906 .RS 4
3907 Specifies a unique identifier used by the DHCP server to select the downstream subnet independently of giaddr\&. This value is used as the Virtual Subnet Selection sub\-option in the Relay Agent Information option in the forwarded DHCP message\&. Takes a value in the same format as
3908 \fICircuitId=\fR\&. This is used only when
3909 \fIDHCPRelay=downstream\fR, and ignored otherwise\&. Defaults to unset, and the sub\-option is not set\&.
3910 .sp
3911 Added in version 261\&.
3912 .RE
3913 .PP
3914 \fIExtraOption=\fR
3915 .RS 4
3916 Specifies an extra sub\-option in the Relay Agent Information option, which is appended to DHCP messages forwarded to the upstream DHCP server\&. Takes a sub\-option code, data type, and data separated with a colon ("\fIcode\fR:\fItype\fR:\fIvalue\fR")\&. The code is an integer in 1\&...254\&. See
3917 \fICircuitId=\fR
3918 in the above for the acceptable type and data\&. This setting can be specified multiple times\&. When an empty string is specified, all previous assignments are cleared\&. This is used only when
3919 \fIDHCPRelay=downstream\fR, and ignored otherwise\&. Defaults to unset, and no extra sub\-option will be appended\&.
3920 .sp
3921 Added in version 261\&.
3922 .RE
3923 .PP
3924 \fIInterfacePriority=\fR
3925 .RS 4
3926 Specifies the priority of the upstream interface\&. Takes an integer value\&. When the host has multiple upstream interfaces, the upstream interface with the highest (largest) priority will be used for forwarding DHCP messages to the upstream DHCP server\&. When multiple interfaces have the same priority, which interface is used is unspecified\&. This is used only when
3927 \fIDHCPRelay=upstream\fR, and ignored otherwise\&. Defaults to zero\&.
3928 .sp
3929 Added in version 261\&.
3930 .RE
3931 .SH "[DHCPSERVER] SECTION OPTIONS"
3932 .PP
3933 The [DHCPServer] section contains settings for the DHCP server, if enabled via the
3934 \fIDHCPServer=\fR
3935 option described above:
3936 .PP
3937 \fIServerAddress=\fR
3938 .RS 4
3939 Specifies the server address for the DHCP server\&. Takes an IPv4 address with prefix length separated with a slash, e\&.g\&.
3940 "192\&.168\&.0\&.1/24"\&. Defaults to unset, and one of static IPv4 addresses configured in [Network] or [Address] section will be automatically selected\&. This setting may be useful when the interface on which the DHCP server is running has multiple static IPv4 addresses\&.
3941 .sp
3942 This implies
3943 \fIAddress=\fR
3944 in [Network] or [Address] section with the same address and prefix length\&. That is,
3945 .sp
3946 .if n \{\
3947 .RS 4
3948 .\}
3949 .nf
3950 [Network]
3951 DHCPServer=yes
3952 Address=192\&.168\&.0\&.1/24
3953 Address=192\&.168\&.0\&.2/24
3954 [DHCPServer]
3955 ServerAddress=192\&.168\&.0\&.1/24
3956 .fi
3957 .if n \{\
3958 .RE
3959 .\}
3960 .sp
3961 or
3962 .sp
3963 .if n \{\
3964 .RS 4
3965 .\}
3966 .nf
3967 [Network]
3968 DHCPServer=yes
3969 [Address]
3970 Address=192\&.168\&.0\&.1/24
3971 [Address]
3972 Address=192\&.168\&.0\&.2/24
3973 [DHCPServer]
3974 ServerAddress=192\&.168\&.0\&.1/24
3975 .fi
3976 .if n \{\
3977 .RE
3978 .\}
3979 .sp
3980 are equivalent to the following:
3981 .sp
3982 .if n \{\
3983 .RS 4
3984 .\}
3985 .nf
3986 [Network]
3987 DHCPServer=yes
3988 Address=192\&.168\&.0\&.2/24
3989 [DHCPServer]
3990 ServerAddress=192\&.168\&.0\&.1/24
3991 .fi
3992 .if n \{\
3993 .RE
3994 .\}
3995 .sp
3996 Since version 255, like the
3997 \fIAddress=\fR
3998 setting in [Network] or [Address] section, this also supports a null address, e\&.g\&.
3999 "0\&.0\&.0\&.0/24", and an unused address will be automatically selected\&. For more details about the automatic address selection, see
4000 \fIAddress=\fR
4001 setting in [Network] section in the above\&.
4002 .sp
4003 Added in version 249\&.
4004 .RE
4005 .PP
4006 \fIPoolOffset=\fR, \fIPoolSize=\fR
4007 .RS 4
4008 Configures the pool of addresses to hand out\&. The pool is a contiguous sequence of IP addresses in the subnet configured for the server address, which does not include the subnet nor the broadcast address\&.
4009 \fIPoolOffset=\fR
4010 takes the offset of the pool from the start of subnet, or zero to use the default value\&.
4011 \fIPoolSize=\fR
4012 takes the number of IP addresses in the pool or zero to use the default value\&. By default, the pool starts at the first address after the subnet address and takes up the rest of the subnet, excluding the broadcast address\&. If the pool includes the server address (the default), this is reserved and not handed out to clients\&.
4013 .sp
4014 Added in version 226\&.
4015 .RE
4016 .PP
4017 \fIDefaultLeaseTimeSec=\fR, \fIMaxLeaseTimeSec=\fR
4018 .RS 4
4019 Control the default and maximum DHCP lease time to pass to clients\&. These settings take time values in seconds or another common time unit, depending on the suffix\&. The default lease time is used for clients that did not ask for a specific lease time\&. If a client asks for a lease time longer than the maximum lease time, it is automatically shortened to the specified time\&. The default lease time defaults to 1h, the maximum lease time to 12h\&. Shorter lease times are beneficial if the configuration data in DHCP leases changes frequently and clients shall learn the new settings with shorter latencies\&. Longer lease times reduce the generated DHCP network traffic\&.
4020 .sp
4021 Added in version 226\&.
4022 .RE
4023 .PP
4024 \fIUplinkInterface=\fR
4025 .RS 4
4026 Specifies the name or the index of the uplink interface, or one of the special values
4027 ":none"
4028 and
4029 ":auto"\&. When emitting DNS, NTP, or SIP servers is enabled but no servers are specified, the servers configured in the uplink interface will be emitted\&. When
4030 ":auto", the link which has a default gateway with the highest priority will be automatically selected\&. When
4031 ":none", no uplink interface will be selected\&. Defaults to
4032 ":auto"\&.
4033 .sp
4034 Added in version 249\&.
4035 .RE
4036 .PP
4037 \fIEmitDNS=\fR, \fIDNS=\fR
4038 .RS 4
4039 \fIEmitDNS=\fR
4040 takes a boolean\&. Configures whether the DHCP leases handed out to clients shall contain DNS server information\&. Defaults to
4041 "yes"\&. The DNS servers to pass to clients may be configured with the
4042 \fIDNS=\fR
4043 option, which takes a list of IPv4 addresses, or special value
4044 "_server_address"
4045 which will be converted to the address used by the DHCP server\&.
4046 .sp
4047 If the
4048 \fIEmitDNS=\fR
4049 option is enabled but no servers configured, the servers are automatically propagated from an "uplink" interface that has appropriate servers set\&. The "uplink" interface is determined by the default route of the system with the highest priority\&. Note that this information is acquired at the time the lease is handed out, and does not take uplink interfaces into account that acquire DNS server information at a later point\&. If no suitable uplink interface is found the DNS server data from
4050 /etc/resolv\&.conf
4051 is used\&. Also, note that the leases are not refreshed if the uplink network configuration changes\&. To ensure clients regularly acquire the most current uplink DNS server information, it is thus advisable to shorten the DHCP lease time via
4052 \fIMaxLeaseTimeSec=\fR
4053 described above\&.
4054 .sp
4055 This setting can be specified multiple times\&. If an empty string is specified, then all DNS servers specified earlier are cleared\&.
4056 .sp
4057 Added in version 226\&.
4058 .RE
4059 .PP
4060 \fIEmitNTP=\fR, \fINTP=\fR, \fIEmitSIP=\fR, \fISIP=\fR, \fIEmitPOP3=\fR, \fIPOP3=\fR, \fIEmitSMTP=\fR, \fISMTP=\fR, \fIEmitLPR=\fR, \fILPR=\fR
4061 .RS 4
4062 Similar to the
4063 \fIEmitDNS=\fR
4064 and
4065 \fIDNS=\fR
4066 settings described above, these settings configure whether and what server information for the indicate protocol shall be emitted as part of the DHCP lease\&. The same syntax, propagation semantics and defaults apply as for
4067 \fIEmitDNS=\fR
4068 and
4069 \fIDNS=\fR\&.
4070 .sp
4071 Added in version 226\&.
4072 .RE
4073 .PP
4074 \fIEmitRouter=\fR, \fIRouter=\fR
4075 .RS 4
4076 The
4077 \fIEmitRouter=\fR
4078 setting takes a boolean value, and configures whether the DHCP lease should contain the router option\&. The
4079 \fIRouter=\fR
4080 setting takes an IPv4 address, and configures the router address to be emitted\&. When the
4081 \fIRouter=\fR
4082 setting is not specified, then the server address will be used for the router option\&. When the
4083 \fIEmitRouter=\fR
4084 setting is disabled, the
4085 \fIRouter=\fR
4086 setting will be ignored\&. The
4087 \fIEmitRouter=\fR
4088 setting defaults to true, and the
4089 \fIRouter=\fR
4090 setting defaults to unset\&.
4091 .sp
4092 Added in version 230\&.
4093 .RE
4094 .PP
4095 \fIEmitTimezone=\fR, \fITimezone=\fR
4096 .RS 4
4097 Takes a boolean\&. Configures whether the DHCP leases handed out to clients shall contain timezone information\&. Defaults to
4098 "yes"\&. The
4099 \fITimezone=\fR
4100 setting takes a timezone string (such as
4101 "Europe/Berlin"
4102 or
4103 "UTC") to pass to clients\&. If no explicit timezone is set, the system timezone of the local host is propagated, as determined by the
4104 /etc/localtime
4105 symlink\&.
4106 .sp
4107 Added in version 226\&.
4108 .RE
4109 .PP
4110 \fIEmitDomain=\fR
4111 .RS 4
4112 Takes a boolean\&. Configures whether the DHCP leases handed out to clients shall contain domain name information (DHCP option 15)\&. Defaults to
4113 "no"\&.
4114 .sp
4115 Added in version 259\&.
4116 .RE
4117 .PP
4118 \fIDomain=\fR
4119 .RS 4
4120 Takes a domain name (such as
4121 "example\&.com") to pass to DHCP clients\&. This configures the DNS default domain for DHCP clients\&. When set, DHCP clients will use this as their DNS search domain\&.
4122 .sp
4123 When
4124 \fIEmitDomain=yes\fR
4125 is set but
4126 \fIDomain=\fR
4127 is not configured, the domain name will be automatically derived from the system\*(Aqs fully qualified hostname\&. For example, if the system\*(Aqs hostname is
4128 "host\&.example\&.com", the domain
4129 "example\&.com"
4130 will be sent to clients\&. If the system\*(Aqs hostname does not contain a domain part (e\&.g\&., hostname is just
4131 "host"), no domain name will be sent to DHCP clients\&. When empty or unset, defaults to no domain name\&.
4132 .sp
4133 Added in version 259\&.
4134 .RE
4135 .PP
4136 \fIBootServerAddress=\fR
4137 .RS 4
4138 Takes an IPv4 address of the boot server used by e\&.g\&. PXE boot systems\&. When specified, this address is sent in the
4139 \fBsiaddr\fR
4140 field of the DHCP message header\&. See
4141 \m[blue]\fBRFC 2131\fR\m[]\&\s-2\u[41]\d\s+2
4142 for more details\&. Defaults to unset\&.
4143 .sp
4144 Added in version 251\&.
4145 .RE
4146 .PP
4147 \fIBootServerName=\fR
4148 .RS 4
4149 Takes a name of the boot server used by e\&.g\&. PXE boot systems\&. When specified, this name is sent in the DHCP option 66 ("TFTP server name")\&. See
4150 \m[blue]\fBRFC 2132\fR\m[]\&\s-2\u[42]\d\s+2
4151 for more details\&. Defaults to unset\&.
4152 .sp
4153 Note that typically setting one of
4154 \fIBootServerName=\fR
4155 or
4156 \fIBootServerAddress=\fR
4157 is sufficient, but both can be set too, if desired\&.
4158 .sp
4159 Added in version 251\&.
4160 .RE
4161 .PP
4162 \fIBootFilename=\fR
4163 .RS 4
4164 Takes a path or URL to a file loaded by e\&.g\&. a PXE boot loader\&. When specified, this path is sent in the DHCP option 67 ("Bootfile name")\&. See
4165 \m[blue]\fBRFC 2132\fR\m[]\&\s-2\u[42]\d\s+2
4166 for more details\&. Defaults to unset\&.
4167 .sp
4168 Added in version 251\&.
4169 .RE
4170 .PP
4171 \fIIPv6OnlyPreferredSec=\fR
4172 .RS 4
4173 Takes a timespan\&. Controls the
4174 \m[blue]\fBRFC 8925\fR\m[]\&\s-2\u[35]\d\s+2
4175 IPv6\-Only Preferred option\&. Specifies the DHCPv4 option to indicate that a host supports an IPv6\-only mode and is willing to forgo obtaining an IPv4 address if the network provides IPv6 connectivity\&. Defaults to unset, and not send the option\&. The minimum allowed value is 300 seconds\&.
4176 .sp
4177 Added in version 255\&.
4178 .RE
4179 .PP
4180 \fISendOption=\fR
4181 .RS 4
4182 Send a raw option with value via DHCPv4 server\&. Takes a DHCP option number, data type and data ("\fIoption\fR:\fItype\fR:\fIvalue\fR")\&. The option number is an integer in the range 1\&...254\&. The type takes one of
4183 "uint8",
4184 "uint16",
4185 "uint32",
4186 "ipv4address",
4187 "ipv6address", or
4188 "string"\&. Special characters in the data string may be escaped using
4189 \m[blue]\fBC\-style escapes\fR\m[]\&\s-2\u[30]\d\s+2\&. This setting can be specified multiple times\&. If an empty string is specified, then all options specified earlier are cleared\&. Defaults to unset\&.
4190 .sp
4191 Added in version 244\&.
4192 .RE
4193 .PP
4194 \fISendVendorOption=\fR
4195 .RS 4
4196 Send a vendor option with value via DHCPv4 server\&. Takes a DHCP option number, data type and data ("\fIoption\fR:\fItype\fR:\fIvalue\fR")\&. The option number is an integer in the range 1\&...254\&. The type takes one of
4197 "uint8",
4198 "uint16",
4199 "uint32",
4200 "ipv4address", or
4201 "string"\&. Special characters in the data string may be escaped using
4202 \m[blue]\fBC\-style escapes\fR\m[]\&\s-2\u[30]\d\s+2\&. This setting can be specified multiple times\&. If an empty string is specified, then all options specified earlier are cleared\&. Defaults to unset\&.
4203 .sp
4204 Added in version 246\&.
4205 .RE
4206 .PP
4207 \fIRapidCommit=\fR
4208 .RS 4
4209 Takes a boolean\&. When true, the server supports
4210 \m[blue]\fBRFC 4039\fR\m[]\&\s-2\u[43]\d\s+2\&. When a client sends a DHCPDISCOVER message with the Rapid Commit option to the server, then the server will reply with a DHCPACK message to the client, instead of DHCPOFFER\&. Defaults to true\&.
4211 .sp
4212 Added in version 255\&.
4213 .RE
4214 .PP
4215 \fIPersistLeases=\fR
4216 .RS 4
4217 Takes a boolean or special value
4218 "runtime"\&. When
4219 "yes", the DHCP server will load and save leases in the persistent storage\&. When
4220 "runtime", the DHCP server will load and save leases in the runtime storage, hence bound leases will be lost when the runtime storage is cleared by e\&.g\&. by calling
4221 \fBsystemctl clean systemd\-networkd\&.service\fR
4222 or the system is rebooted\&. When
4223 "no", the DHCP server will neither load nor save leases in the persistent storage, hence bound leases will be lost when the interface is reconfigured e\&.g\&. by
4224 \fBnetworkctl reconfigure\fR, or
4225 \fBsystemd-networkd.service\fR(8)
4226 is restarted\&. Using
4227 "runtime"
4228 and
4229 "no"
4230 may cause address conflict on the network after the leases are lost\&. So, please take an extra care when disable this setting\&. When unspecified, the value specified in the same setting in
4231 \fBnetworkd.conf\fR(5), which defaults to
4232 "yes", will be used\&.
4233 .sp
4234 Added in version 256\&.
4235 .RE
4236 .PP
4237 \fILocalLeaseDomain=\fR
4238 .RS 4
4239 Takes a DNS domain name as argument\&. If specified,
4240 \fBsystemd-networkd.service\fR(8)
4241 will integrate with
4242 \fBsystemd-resolved.service\fR(8)
4243 and ensure that the hostnames associated with each handed out DHCP lease may be resolved to the IP addresses of the lease\&. The hostnames are suffixed with the specified domain name\&.
4244 .sp
4245 Note that this purely about hostname resolution on the local system, i\&.e\&. from programs with access to the same
4246 systemd\-resolved
4247 instances via D\-Bus IPC, Varlink IPC, or the local DNS stub\&.
4248 .sp
4249 Added in version 259\&.
4250 .RE
4251 .SH "[DHCPSERVERSTATICLEASE] SECTION OPTIONS"
4252 .PP
4253 The
4254 "[DHCPServerStaticLease]"
4255 section configures a static DHCP lease to assign a fixed IPv4 address to a specific device based on its MAC address\&. This section can be specified multiple times\&.
4256 .PP
4257 \fIMACAddress=\fR
4258 .RS 4
4259 The hardware address of a device to match\&. This key is mandatory\&.
4260 .sp
4261 Added in version 249\&.
4262 .RE
4263 .PP
4264 \fIAddress=\fR
4265 .RS 4
4266 The IPv4 address that should be assigned to the device that was matched with
4267 \fIMACAddress=\fR\&. This key is mandatory\&.
4268 .sp
4269 Added in version 249\&.
4270 .RE
4271 .PP
4272 \fIHostname=\fR
4273 .RS 4
4274 The hostname to send to the client in DHCP replies\&. This can be either a simple hostname (e\&.g\&.,
4275 "mydevice") or a fully qualified domain name (e\&.g\&.,
4276 "mydevice\&.example\&.com"), following RFC 1123 naming conventions\&. Each label can be up to 63 characters, with a total maximum length of 253 characters for FQDNs\&. When this option is set, the DHCP server will include the hostname in DHCP replies (both OFFER and ACK) to the client with the matched MAC address\&.
4277 .sp
4278 The server automatically selects the appropriate DHCP option based on the hostname format: simple hostnames (single DNS label) are sent via option 12 (Host Name) per RFC 2132, while FQDNs with multiple labels are sent via option 81 (Client FQDN) per RFC 4702 using DNS wire format encoding\&. The configured hostname is sent unconditionally, any hostname requested by the client in its DHCP message is ignored\&.
4279 .sp
4280 Added in version 259\&.
4281 .RE
4282 .SH "[IPV6SENDRA] SECTION OPTIONS"
4283 .PP
4284 The [IPv6SendRA] section contains settings for sending IPv6 Router Advertisements and whether to act as a router, if enabled via the
4285 \fIIPv6SendRA=\fR
4286 option described above\&. IPv6 network prefixes or routes are defined with one or more [IPv6Prefix] or [IPv6RoutePrefix] sections\&.
4287 .PP
4288 \fIManaged=\fR, \fIOtherInformation=\fR
4289 .RS 4
4290 Takes a boolean\&. Controls whether a DHCPv6 server is used to acquire IPv6 addresses on the network link when
4291 \fIManaged=\fR
4292 is set to
4293 "true"
4294 or if only additional network information can be obtained via DHCPv6 for the network link when
4295 \fIOtherInformation=\fR
4296 is set to
4297 "true"\&. Both settings default to
4298 "false", which means that a DHCPv6 server is not being used\&.
4299 .sp
4300 Added in version 235\&.
4301 .RE
4302 .PP
4303 \fIRouterLifetimeSec=\fR
4304 .RS 4
4305 Takes a timespan\&. Configures the IPv6 router lifetime in seconds\&. The value must be 0 seconds, or between 4 seconds and 9000 seconds\&. When set to 0, the host is not acting as a router\&. Defaults to 1800 seconds (30 minutes)\&.
4306 .sp
4307 Added in version 235\&.
4308 .RE
4309 .PP
4310 \fIReachableTimeSec=\fR
4311 .RS 4
4312 Configures the time, used in the Neighbor Unreachability Detection algorithm, for which clients can assume a neighbor is reachable after having received a reachability confirmation\&. Takes a time span in the range 0\&...4294967295 ms\&. When 0, clients will handle it as if the value was not specified\&. Defaults to 0\&.
4313 .sp
4314 Added in version 256\&.
4315 .RE
4316 .PP
4317 \fIRetransmitSec=\fR
4318 .RS 4
4319 Configures the time, used in the Neighbor Unreachability Detection algorithm, for which clients can use as retransmit time on address resolution and the Neighbor Unreachability Detection algorithm\&. Takes a time span in the range 0\&...4294967295 ms\&. When 0, clients will handle it as if the value wasn\*(Aqt specified\&. Defaults to 0\&.
4320 .sp
4321 Added in version 255\&.
4322 .RE
4323 .PP
4324 \fIRouterPreference=\fR
4325 .RS 4
4326 Configures IPv6 router preference if
4327 \fIRouterLifetimeSec=\fR
4328 is non\-zero\&. Valid values are
4329 "high",
4330 "medium"
4331 and
4332 "low", with
4333 "normal"
4334 and
4335 "default"
4336 added as synonyms for
4337 "medium"
4338 just to make configuration easier\&. See
4339 \m[blue]\fBRFC 4191\fR\m[]\&\s-2\u[24]\d\s+2
4340 for details\&. Defaults to
4341 "medium"\&.
4342 .sp
4343 Added in version 235\&.
4344 .RE
4345 .PP
4346 \fIHopLimit=\fR
4347 .RS 4
4348 Configures hop limit\&. Takes an integer in the range 0\&...255\&. See also
4349 \fIIPv6HopLimit=\fR\&.
4350 .sp
4351 Added in version 255\&.
4352 .RE
4353 .PP
4354 \fIUplinkInterface=\fR
4355 .RS 4
4356 Specifies the name or the index of the uplink interface, or one of the special values
4357 ":none"
4358 and
4359 ":auto"\&. When emitting DNS servers or search domains is enabled but no servers are specified, the servers configured in the uplink interface will be emitted\&. When
4360 ":auto", the value specified to the same setting in the [DHCPPrefixDelegation] section will be used if
4361 \fIDHCPPrefixDelegation=\fR
4362 is enabled, otherwise the link which has a default gateway with the highest priority will be automatically selected\&. When
4363 ":none", no uplink interface will be selected\&. Defaults to
4364 ":auto"\&.
4365 .sp
4366 Added in version 250\&.
4367 .RE
4368 .PP
4369 \fIEmitDNS=\fR, \fIDNS=\fR
4370 .RS 4
4371 \fIDNS=\fR
4372 specifies a list of recursive DNS server IPv6 addresses that are distributed via Router Advertisement messages when
4373 \fIEmitDNS=\fR
4374 is true\&.
4375 \fIDNS=\fR
4376 also takes special value
4377 "_link_local"; in that case the IPv6 link\-local address is distributed\&. If
4378 \fIDNS=\fR
4379 is empty, DNS servers are read from the [Network] section\&. If the [Network] section does not contain any DNS servers either, DNS servers from the uplink interface specified in
4380 \fIUplinkInterface=\fR
4381 will be used\&. When
4382 \fIEmitDNS=\fR
4383 is false, no DNS server information is sent in Router Advertisement messages\&.
4384 \fIEmitDNS=\fR
4385 defaults to true\&.
4386 .sp
4387 Added in version 235\&.
4388 .RE
4389 .PP
4390 \fIEmitDomains=\fR, \fIDomains=\fR
4391 .RS 4
4392 A list of DNS search domains distributed via Router Advertisement messages when
4393 \fIEmitDomains=\fR
4394 is true\&. If
4395 \fIDomains=\fR
4396 is empty, DNS search domains are read from the [Network] section\&. If the [Network] section does not contain any DNS search domains either, DNS search domains from the uplink interface specified in
4397 \fIUplinkInterface=\fR
4398 will be used\&. When
4399 \fIEmitDomains=\fR
4400 is false, no DNS search domain information is sent in Router Advertisement messages\&.
4401 \fIEmitDomains=\fR
4402 defaults to true\&.
4403 .sp
4404 Added in version 235\&.
4405 .RE
4406 .PP
4407 \fIDNSLifetimeSec=\fR
4408 .RS 4
4409 Lifetime in seconds for the DNS server addresses listed in
4410 \fIDNS=\fR
4411 and search domains listed in
4412 \fIDomains=\fR\&. Defaults to 3600 seconds (one hour)\&.
4413 .sp
4414 Added in version 235\&.
4415 .RE
4416 .PP
4417 \fIHomeAgent=\fR
4418 .RS 4
4419 Takes a boolean\&. Specifies that IPv6 router advertisements indicate to hosts that the router acts as a Home Agent and includes a Home Agent option\&. Defaults to false\&. See
4420 \m[blue]\fBRFC 6275\fR\m[]\&\s-2\u[13]\d\s+2
4421 for further details\&.
4422 .sp
4423 Added in version 255\&.
4424 .RE
4425 .PP
4426 \fIHomeAgentLifetimeSec=\fR
4427 .RS 4
4428 Takes a timespan\&. Specifies the lifetime of the Home Agent\&. An integer, the default unit is seconds, in the range 1\&...65535\&. Defaults to the value set to
4429 \fIRouterLifetimeSec=\fR\&.
4430 .sp
4431 Added in version 255\&.
4432 .RE
4433 .PP
4434 \fIHomeAgentPreference=\fR
4435 .RS 4
4436 Configures IPv6 Home Agent preference\&. Takes an integer in the range 0\&...65535\&. Defaults to 0\&.
4437 .sp
4438 Added in version 255\&.
4439 .RE
4440 .SH "[IPV6PREFIX] SECTION OPTIONS"
4441 .PP
4442 One or more [IPv6Prefix] sections contain the IPv6 prefixes that are announced via Router Advertisements\&. See
4443 \m[blue]\fBRFC 4861\fR\m[]\&\s-2\u[44]\d\s+2
4444 for further details\&.
4445 .PP
4446 \fIAddressAutoconfiguration=\fR, \fIOnLink=\fR
4447 .RS 4
4448 Takes a boolean to specify whether IPv6 addresses can be autoconfigured with this prefix and whether the prefix can be used for onlink determination\&. Both settings default to
4449 "true"
4450 in order to ease configuration\&.
4451 .sp
4452 Added in version 235\&.
4453 .RE
4454 .PP
4455 \fIPrefix=\fR
4456 .RS 4
4457 The IPv6 prefix that is to be distributed to hosts\&. Similarly to configuring static IPv6 addresses, the setting is configured as an IPv6 prefix and its prefix length, separated by a
4458 "/"
4459 character\&. Use multiple [IPv6Prefix] sections to configure multiple IPv6 prefixes since prefix lifetimes, address autoconfiguration and onlink status may differ from one prefix to another\&.
4460 .sp
4461 Added in version 235\&.
4462 .RE
4463 .PP
4464 \fIPreferredLifetimeSec=\fR, \fIValidLifetimeSec=\fR
4465 .RS 4
4466 Preferred and valid lifetimes for the prefix measured in seconds\&.
4467 \fIPreferredLifetimeSec=\fR
4468 defaults to 1800 seconds (30 minutes) and
4469 \fIValidLifetimeSec=\fR
4470 defaults to 3600 seconds (one hour)\&.
4471 .sp
4472 Added in version 235\&.
4473 .RE
4474 .PP
4475 \fIAssign=\fR
4476 .RS 4
4477 Takes a boolean\&. When true, adds an address from the prefix\&. Default to false\&.
4478 .sp
4479 Added in version 246\&.
4480 .RE
4481 .PP
4482 \fIToken=\fR
4483 .RS 4
4484 Specifies an optional address generation mode for assigning an address in each prefix\&. This accepts the same syntax as
4485 \fIToken=\fR
4486 in the [IPv6AcceptRA] section\&. If
4487 \fIAssign=\fR
4488 is set to false, then this setting will be ignored\&. Defaults to unset, which means the EUI\-64 algorithm will be used\&.
4489 .sp
4490 Added in version 250\&.
4491 .RE
4492 .PP
4493 \fIRouteMetric=\fR
4494 .RS 4
4495 The metric of the prefix route\&. Takes an unsigned integer in the range 0\&...4294967295\&. When unset or set to 0, the kernel\*(Aqs default value is used\&. This setting is ignored when
4496 \fIAssign=\fR
4497 is false\&.
4498 .sp
4499 Added in version 249\&.
4500 .RE
4501 .SH "[IPV6ROUTEPREFIX] SECTION OPTIONS"
4502 .PP
4503 One or more [IPv6RoutePrefix] sections contain the IPv6 prefix routes that are announced via Router Advertisements\&. See
4504 \m[blue]\fBRFC 4191\fR\m[]\&\s-2\u[24]\d\s+2
4505 for further details\&.
4506 .PP
4507 \fIRoute=\fR
4508 .RS 4
4509 The IPv6 route that is to be distributed to hosts\&. Similarly to configuring static IPv6 routes, the setting is configured as an IPv6 prefix routes and its prefix route length, separated by a
4510 "/"
4511 character\&. Use multiple [IPv6RoutePrefix] sections to configure multiple IPv6 prefix routes\&.
4512 .sp
4513 Added in version 244\&.
4514 .RE
4515 .PP
4516 \fILifetimeSec=\fR
4517 .RS 4
4518 Lifetime for the route prefix measured in seconds\&.
4519 \fILifetimeSec=\fR
4520 defaults to 3600 seconds (one hour)\&.
4521 .sp
4522 Added in version 244\&.
4523 .RE
4524 .PP
4525 \fIPreference=\fR
4526 .RS 4
4527 Specifies the preference of the route option\&. Takes one of
4528 "high",
4529 "medium", or
4530 "low"\&. Defaults to
4531 "medium"\&.
4532 .sp
4533 Added in version 258\&.
4534 .RE
4535 .SH "[IPV6PREF64PREFIX] SECTION OPTIONS"
4536 .PP
4537 One or more [IPv6PREF64Prefix] sections contain the IPv6 PREF64 (or NAT64) prefixes that are announced via Router Advertisements\&. See
4538 \m[blue]\fBRFC 8781\fR\m[]\&\s-2\u[40]\d\s+2
4539 for further details\&.
4540 .PP
4541 \fIPrefix=\fR
4542 .RS 4
4543 The IPv6 PREF64 (or NAT64) prefix that is to be distributed to hosts\&. The setting holds an IPv6 prefix that should be set up for NAT64 translation (PLAT) to allow 464XLAT on the network segment\&. Use multiple [IPv6PREF64Prefix] sections to configure multiple IPv6 prefixes since prefix lifetime may differ from one prefix to another\&. The prefix is an address with a prefix length, separated by a slash
4544 "/"
4545 character\&. Valid NAT64 prefix length are 96, 64, 56, 48, 40, and 32 bits\&.
4546 .sp
4547 Added in version 255\&.
4548 .RE
4549 .PP
4550 \fILifetimeSec=\fR
4551 .RS 4
4552 Lifetime for the prefix measured in seconds\&. Should be greater than or equal to
4553 \fIRouterLifetimeSec=\fR\&.
4554 \fILifetimeSec=\fR
4555 defaults to 1800 seconds\&.
4556 .sp
4557 Added in version 255\&.
4558 .RE
4559 .SH "[BRIDGE] SECTION OPTIONS"
4560 .PP
4561 The [Bridge] section accepts the following keys:
4562 .PP
4563 \fIUnicastFlood=\fR
4564 .RS 4
4565 Takes a boolean\&. Controls whether the bridge should flood traffic for which an FDB entry is missing and the destination is unknown through this port\&. When unset, the kernel\*(Aqs default will be used\&.
4566 .sp
4567 Added in version 223\&.
4568 .RE
4569 .PP
4570 \fIMulticastFlood=\fR
4571 .RS 4
4572 Takes a boolean\&. Controls whether the bridge should flood traffic for which an MDB entry is missing and the destination is unknown through this port\&. When unset, the kernel\*(Aqs default will be used\&.
4573 .sp
4574 Added in version 242\&.
4575 .RE
4576 .PP
4577 \fIMulticastToUnicast=\fR
4578 .RS 4
4579 Takes a boolean\&. Multicast to unicast works on top of the multicast snooping feature of the bridge\&. Which means unicast copies are only delivered to hosts which are interested in it\&. When unset, the kernel\*(Aqs default will be used\&.
4580 .sp
4581 Added in version 240\&.
4582 .RE
4583 .PP
4584 \fINeighborSuppression=\fR
4585 .RS 4
4586 Takes a boolean\&. Configures whether ARP and ND neighbor suppression is enabled for this port\&. When unset, the kernel\*(Aqs default will be used\&.
4587 .sp
4588 Added in version 242\&.
4589 .RE
4590 .PP
4591 \fILearning=\fR
4592 .RS 4
4593 Takes a boolean\&. Configures whether MAC address learning is enabled for this port\&. When unset, the kernel\*(Aqs default will be used\&.
4594 .sp
4595 Added in version 242\&.
4596 .RE
4597 .PP
4598 \fIHairPin=\fR
4599 .RS 4
4600 Takes a boolean\&. Configures whether traffic may be sent back out of the port on which it was received\&. When this flag is false, then the bridge will not forward traffic back out of the receiving port\&. When unset, the kernel\*(Aqs default will be used\&.
4601 .sp
4602 Added in version 223\&.
4603 .RE
4604 .PP
4605 \fIIsolated=\fR
4606 .RS 4
4607 Takes a boolean\&. Configures whether this port is isolated or not\&. Within a bridge, isolated ports can only communicate with non\-isolated ports\&. When set to true, this port can only communicate with other ports whose Isolated setting is false\&. When set to false, this port can communicate with any other ports\&. When unset, the kernel\*(Aqs default will be used\&.
4608 .sp
4609 Added in version 251\&.
4610 .RE
4611 .PP
4612 \fIUseBPDU=\fR
4613 .RS 4
4614 Takes a boolean\&. Configures whether STP Bridge Protocol Data Units will be processed by the bridge port\&. When unset, the kernel\*(Aqs default will be used\&.
4615 .sp
4616 Added in version 223\&.
4617 .RE
4618 .PP
4619 \fIFastLeave=\fR
4620 .RS 4
4621 Takes a boolean\&. This flag allows the bridge to immediately stop multicast traffic on a port that receives an IGMP Leave message\&. It is only used with IGMP snooping if enabled on the bridge\&. When unset, the kernel\*(Aqs default will be used\&.
4622 .sp
4623 Added in version 223\&.
4624 .RE
4625 .PP
4626 \fIAllowPortToBeRoot=\fR
4627 .RS 4
4628 Takes a boolean\&. Configures whether a given port is allowed to become a root port\&. Only used when STP is enabled on the bridge\&. When unset, the kernel\*(Aqs default will be used\&.
4629 .sp
4630 Added in version 223\&.
4631 .RE
4632 .PP
4633 \fIProxyARP=\fR
4634 .RS 4
4635 Takes a boolean\&. Configures whether proxy ARP to be enabled on this port\&. When unset, the kernel\*(Aqs default will be used\&.
4636 .sp
4637 Added in version 243\&.
4638 .RE
4639 .PP
4640 \fIProxyARPWiFi=\fR
4641 .RS 4
4642 Takes a boolean\&. Configures whether proxy ARP to be enabled on this port which meets extended requirements by IEEE 802\&.11 and Hotspot 2\&.0 specifications\&. When unset, the kernel\*(Aqs default will be used\&.
4643 .sp
4644 Added in version 243\&.
4645 .RE
4646 .PP
4647 \fIMulticastRouter=\fR
4648 .RS 4
4649 Configures this port for having multicast routers attached\&. A port with a multicast router will receive all multicast traffic\&. Takes one of
4650 "no"
4651 to disable multicast routers on this port,
4652 "query"
4653 to let the system detect the presence of routers,
4654 "permanent"
4655 to permanently enable multicast traffic forwarding on this port, or
4656 "temporary"
4657 to enable multicast routers temporarily on this port, not depending on incoming queries\&. When unset, the kernel\*(Aqs default will be used\&.
4658 .sp
4659 Added in version 243\&.
4660 .RE
4661 .PP
4662 \fICost=\fR
4663 .RS 4
4664 Sets the "cost" of sending packets of this interface\&. Each port in a bridge may have a different speed and the cost is used to decide which link to use\&. Faster interfaces should have lower costs\&. It is an integer value between 1 and 65535\&.
4665 .sp
4666 Added in version 218\&.
4667 .RE
4668 .PP
4669 \fIPriority=\fR
4670 .RS 4
4671 Sets the "priority" of sending packets on this interface\&. Each port in a bridge may have a different priority which is used to decide which link to use\&. Lower value means higher priority\&. It is an integer value between 0 to 63\&.
4672 \fBsystemd\-networkd\fR
4673 does not set any default, meaning the kernel default value of 32 is used\&.
4674 .sp
4675 Added in version 234\&.
4676 .RE
4677 .PP
4678 \fILocked=\fR, \fIMACAuthenticationBypass=\fR
4679 .RS 4
4680 Takes a boolean\&. Configures whether the port is "locked" and does not allow traffic forwarded until fully authenticated, e\&.g\&. via 802\&.1x\&. When unset, the kernel\*(Aqs default will be used\&.
4681 .sp
4682 Added in version 258\&.
4683 Takes a boolean\&. Configures whether a locked port has "MAC Authentication Bypass" enabled and creates newly learned fdb entries in a "locked" state\&. User space can authenticate these entries by clearing the locked flag\&. Requires Learning to be enabled\&. When unset, the kernel\*(Aqs default will be used\&.
4684 .sp
4685 Added in version 258\&.
4686 .RE
4687 .PP
4688 \fIVLANTunnel=\fR
4689 .RS 4
4690 Takes a boolean\&. Configures whether vlan tunnel mode is to be enabled on this port\&. When unset, the kernel\*(Aqs default will be used\&.
4691 .sp
4692 Added in version 258\&.
4693 .RE
4694 .SH "[BRIDGEFDB] SECTION OPTIONS"
4695 .PP
4696 The [BridgeFDB] section manages the forwarding database table of a port and accepts the following keys\&. Specify several [BridgeFDB] sections to configure several static MAC table entries\&.
4697 .PP
4698 \fIMACAddress=\fR
4699 .RS 4
4700 As in the [Network] section\&. This key is mandatory\&.
4701 .sp
4702 Added in version 219\&.
4703 .RE
4704 .PP
4705 \fIDestination=\fR
4706 .RS 4
4707 Takes an IP address of the destination VXLAN tunnel endpoint\&.
4708 .sp
4709 Added in version 243\&.
4710 .RE
4711 .PP
4712 \fIVLANId=\fR
4713 .RS 4
4714 The VLAN ID for the new static MAC table entry\&. If omitted, no VLAN ID information is appended to the new static MAC table entry\&.
4715 .sp
4716 Added in version 219\&.
4717 .RE
4718 .PP
4719 \fIVNI=\fR
4720 .RS 4
4721 The VXLAN Network Identifier (or VXLAN Segment ID) to use to connect to the remote VXLAN tunnel endpoint\&. Takes a number in the range 1\&...16777215\&. Defaults to unset\&.
4722 .sp
4723 Added in version 243\&.
4724 .RE
4725 .PP
4726 \fIAssociatedWith=\fR
4727 .RS 4
4728 Specifies where the address is associated with\&. Takes one of
4729 "use",
4730 "self",
4731 "master"
4732 or
4733 "router"\&.
4734 "use"
4735 means the address is in use\&. User space can use this option to indicate to the kernel that the fdb entry is in use\&.
4736 "self"
4737 means the address is associated with the port drivers fdb\&. Usually hardware\&.
4738 "master"
4739 means the address is associated with master devices fdb\&.
4740 "router"
4741 means the destination address is associated with a router\&. Note that it is valid if the referenced device is a VXLAN type device and has route shortcircuit enabled\&. Defaults to
4742 "self"\&.
4743 .sp
4744 Added in version 243\&.
4745 .RE
4746 .PP
4747 \fIOutgoingInterface=\fR
4748 .RS 4
4749 Specifies the name or index of the outgoing interface for the VXLAN device driver to reach the remote VXLAN tunnel endpoint\&. Defaults to unset\&.
4750 .sp
4751 Added in version 249\&.
4752 .RE
4753 .SH "[BRIDGEMDB] SECTION OPTIONS"
4754 .PP
4755 The [BridgeMDB] section manages the multicast membership entries forwarding database table of a port and accepts the following keys\&. Specify several [BridgeMDB] sections to configure several permanent multicast membership entries\&.
4756 .PP
4757 \fIMulticastGroupAddress=\fR
4758 .RS 4
4759 Specifies the IPv4, IPv6, or L2 MAC multicast group address to add\&. This setting is mandatory\&.
4760 .sp
4761 Added in version 247\&.
4762 .RE
4763 .PP
4764 \fIVLANId=\fR
4765 .RS 4
4766 The VLAN ID for the new entry\&. Valid ranges are 0 (no VLAN) to 4094\&. Optional, defaults to 0\&.
4767 .sp
4768 Added in version 247\&.
4769 .RE
4770 .SH "[LLDP] SECTION OPTIONS"
4771 .PP
4772 The [LLDP] section manages the Link Layer Discovery Protocol (LLDP) and accepts the following keys:
4773 .PP
4774 \fIMUDURL=\fR
4775 .RS 4
4776 When configured, the specified Manufacturer Usage Descriptions (MUD) URL will be sent in LLDP packets\&. The syntax and semantics are the same as for
4777 \fIMUDURL=\fR
4778 in the [DHCPv4] section described above\&.
4779 .sp
4780 The MUD URLs received via LLDP packets are saved and can be read using the
4781 \fBsd_lldp_neighbor_get_mud_url()\fR
4782 function\&.
4783 .sp
4784 Added in version 246\&.
4785 .RE
4786 .SH "[CAN] SECTION OPTIONS"
4787 .PP
4788 The [CAN] section manages the Controller Area Network (CAN bus) and accepts the following keys:
4789 .PP
4790 \fIBitRate=\fR
4791 .RS 4
4792 The bitrate of CAN device in bits per second\&. The usual SI prefixes (K, M) with the base of 1000 can be used here\&. Takes a number in the range 1\&...4294967295\&.
4793 .sp
4794 Added in version 239\&.
4795 .RE
4796 .PP
4797 \fISamplePoint=\fR
4798 .RS 4
4799 Optional sample point in percent with one decimal (e\&.g\&.
4800 "75%",
4801 "87\&.5%") or permille (e\&.g\&.
4802 "875โ€ฐ")\&. This will be ignored when
4803 \fIBitRate=\fR
4804 is unspecified\&.
4805 .sp
4806 Added in version 239\&.
4807 .RE
4808 .PP
4809 \fITimeQuantaNSec=\fR, \fIPropagationSegment=\fR, \fIPhaseBufferSegment1=\fR, \fIPhaseBufferSegment2=\fR, \fISyncJumpWidth=\fR
4810 .RS 4
4811 Specifies the time quanta, propagation segment, phase buffer segment 1 and 2, and the synchronization jump width, which allow one to define the CAN bit\-timing in a hardware independent format as proposed by the Bosch CAN 2\&.0 Specification\&.
4812 \fITimeQuantaNSec=\fR
4813 takes a timespan in nanoseconds\&.
4814 \fIPropagationSegment=\fR,
4815 \fIPhaseBufferSegment1=\fR,
4816 \fIPhaseBufferSegment2=\fR, and
4817 \fISyncJumpWidth=\fR
4818 take number of time quantum specified in
4819 \fITimeQuantaNSec=\fR
4820 and must be an unsigned integer in the range 0\&...4294967295\&. These settings except for
4821 \fISyncJumpWidth=\fR
4822 will be ignored when
4823 \fIBitRate=\fR
4824 is specified\&.
4825 .sp
4826 Added in version 250\&.
4827 .RE
4828 .PP
4829 \fIDataBitRate=\fR, \fIDataSamplePoint=\fR
4830 .RS 4
4831 The bitrate and sample point for the data phase, if CAN\-FD is used\&. These settings are analogous to the
4832 \fIBitRate=\fR
4833 and
4834 \fISamplePoint=\fR
4835 keys\&.
4836 .sp
4837 Added in version 246\&.
4838 .RE
4839 .PP
4840 \fIDataTimeQuantaNSec=\fR, \fIDataPropagationSegment=\fR, \fIDataPhaseBufferSegment1=\fR, \fIDataPhaseBufferSegment2=\fR, \fIDataSyncJumpWidth=\fR
4841 .RS 4
4842 Specifies the time quanta, propagation segment, phase buffer segment 1 and 2, and the synchronization jump width for the data phase, if CAN\-FD is used\&. These settings are analogous to the
4843 \fITimeQuantaNSec=\fR
4844 or related settings\&.
4845 .sp
4846 Added in version 250\&.
4847 .RE
4848 .PP
4849 \fIFDMode=\fR
4850 .RS 4
4851 Takes a boolean\&. When
4852 "yes", CAN\-FD mode is enabled for the interface\&. Note, that a bitrate and optional sample point should also be set for the CAN\-FD data phase using the
4853 \fIDataBitRate=\fR
4854 and
4855 \fIDataSamplePoint=\fR
4856 keys, or
4857 \fIDataTimeQuanta=\fR
4858 and related settings\&.
4859 .sp
4860 Added in version 246\&.
4861 .RE
4862 .PP
4863 \fIFDNonISO=\fR
4864 .RS 4
4865 Takes a boolean\&. When
4866 "yes", non\-ISO CAN\-FD mode is enabled for the interface\&. When unset, the kernel\*(Aqs default will be used\&.
4867 .sp
4868 Added in version 246\&.
4869 .RE
4870 .PP
4871 \fIRestartSec=\fR
4872 .RS 4
4873 Automatic restart delay time\&. If set to a non\-zero value, a restart of the CAN controller will be triggered automatically in case of a bus\-off condition after the specified delay time\&. Subsecond delays can be specified using decimals (e\&.g\&.
4874 "0\&.1s") or a
4875 "ms"
4876 or
4877 "us"
4878 postfix\&. Using
4879 "infinity"
4880 or
4881 "0"
4882 will turn the automatic restart off\&. By default, automatic restart is disabled\&.
4883 .sp
4884 Added in version 239\&.
4885 .RE
4886 .PP
4887 \fITermination=\fR
4888 .RS 4
4889 Takes a boolean or a termination resistor value in ohm in the range 0\&...65535\&. When
4890 "yes", the termination resistor is set to 120 ohm\&. When
4891 "no"
4892 or
4893 "0"
4894 is set, the termination resistor is disabled\&. When unset, the kernel\*(Aqs default will be used\&.
4895 .sp
4896 Added in version 246\&.
4897 .RE
4898 .PP
4899 \fITripleSampling=\fR
4900 .RS 4
4901 Takes a boolean\&. When
4902 "yes", three samples (instead of one) are used to determine the value of a received bit by majority rule\&. When unset, the kernel\*(Aqs default will be used\&.
4903 .sp
4904 Added in version 242\&.
4905 .RE
4906 .PP
4907 \fIBusErrorReporting=\fR
4908 .RS 4
4909 Takes a boolean\&. When
4910 "yes", reporting of CAN bus errors is activated (those include single bit, frame format, and bit stuffing errors, unable to send dominant bit, unable to send recessive bit, bus overload, active error announcement, error occurred on transmission)\&. When unset, the kernel\*(Aqs default will be used\&. Note: in case of a CAN bus with a single CAN device, sending a CAN frame may result in a huge number of CAN bus errors\&.
4911 .sp
4912 Added in version 248\&.
4913 .RE
4914 .PP
4915 \fIListenOnly=\fR
4916 .RS 4
4917 Takes a boolean\&. When
4918 "yes", listen\-only mode is enabled\&. When the interface is in listen\-only mode, the interface neither transmit CAN frames nor send ACK bit\&. Listen\-only mode is important to debug CAN networks without interfering with the communication or acknowledge the CAN frame\&. When unset, the kernel\*(Aqs default will be used\&.
4919 .sp
4920 Added in version 246\&.
4921 .RE
4922 .PP
4923 \fILoopback=\fR
4924 .RS 4
4925 Takes a boolean\&. When
4926 "yes", loopback mode is enabled\&. When the loopback mode is enabled, the interface treats messages transmitted by itself as received messages\&. The loopback mode is important to debug CAN networks\&. When unset, the kernel\*(Aqs default will be used\&.
4927 .sp
4928 Added in version 250\&.
4929 .RE
4930 .PP
4931 \fIOneShot=\fR
4932 .RS 4
4933 Takes a boolean\&. When
4934 "yes", one\-shot mode is enabled\&. When unset, the kernel\*(Aqs default will be used\&.
4935 .sp
4936 Added in version 250\&.
4937 .RE
4938 .PP
4939 \fIPresumeACK=\fR
4940 .RS 4
4941 Takes a boolean\&. When
4942 "yes", the interface will ignore missing CAN ACKs\&. When unset, the kernel\*(Aqs default will be used\&.
4943 .sp
4944 Added in version 250\&.
4945 .RE
4946 .PP
4947 \fIClassicDataLengthCode=\fR
4948 .RS 4
4949 Takes a boolean\&. When
4950 "yes", the interface will handle the 4bit data length code (DLC)\&. When unset, the kernel\*(Aqs default will be used\&.
4951 .sp
4952 Added in version 250\&.
4953 .RE
4954 .SH "[IPOIB] SECTION OPTIONS"
4955 .PP
4956 The [IPoIB] section manages the IP over Infiniband and accepts the following keys:
4957 .PP
4958 \fIMode=\fR
4959 .RS 4
4960 Takes one of the special values
4961 "datagram"
4962 or
4963 "connected"\&. Defaults to unset, and the kernel\*(Aqs default is used\&.
4964 .sp
4965 When
4966 "datagram", the Infiniband unreliable datagram (UD) transport is used, and so the interface MTU is equal to the IB L2 MTU minus the IPoIB encapsulation header (4 bytes)\&. For example, in a typical IB fabric with a 2K MTU, the IPoIB MTU will be 2048 \- 4 = 2044 bytes\&.
4967 .sp
4968 When
4969 "connected", the Infiniband reliable connected (RC) transport is used\&. Connected mode takes advantage of the connected nature of the IB transport and allows an MTU up to the maximal IP packet size of 64K, which reduces the number of IP packets needed for handling large UDP datagrams, TCP segments, etc and increases the performance for large messages\&.
4970 .sp
4971 Added in version 250\&.
4972 .RE
4973 .PP
4974 \fIIgnoreUserspaceMulticastGroups=\fR
4975 .RS 4
4976 Takes a boolean value\&. When true, the kernel ignores multicast groups handled by userspace\&. Defaults to unset, and the kernel\*(Aqs default is used\&.
4977 .sp
4978 Added in version 250\&.
4979 .RE
4980 .SH "[QDISC] SECTION OPTIONS"
4981 .PP
4982 The [QDisc] section manages the traffic control queueing discipline (qdisc)\&.
4983 .PP
4984 \fIParent=\fR
4985 .RS 4
4986 Specifies the parent Queueing Discipline (qdisc)\&. Takes one of
4987 "clsact"
4988 or
4989 "ingress"\&. This is mandatory\&.
4990 .sp
4991 Added in version 244\&.
4992 .RE
4993 .PP
4994 \fIHandle=\fR
4995 .RS 4
4996 Configures the major number of unique identifier of the qdisc, known as the handle\&. Takes a hexadecimal number in the range 0x1\(en0xffff\&. Defaults to unset\&.
4997 .RE
4998 .SH "[NETWORKEMULATOR] SECTION OPTIONS"
4999 .PP
5000 The [NetworkEmulator] section manages the queueing discipline (qdisc) of the network emulator\&. It can be used to configure the kernel packet scheduler and simulate packet delay and loss for UDP or TCP applications, or limit the bandwidth usage of a particular service to simulate internet connections\&.
5001 .PP
5002 \fIParent=\fR
5003 .RS 4
5004 Configures the parent Queueing Discipline (qdisc)\&. Takes one of
5005 "root",
5006 "clsact",
5007 "ingress"
5008 or a class identifier\&. The class identifier is specified as the major and minor numbers in hexadecimal in the range 0x1\(en0xffff separated with a colon ("major:minor")\&. Defaults to
5009 "root"\&.
5010 .RE
5011 .PP
5012 \fIHandle=\fR
5013 .RS 4
5014 Configures the major number of unique identifier of the qdisc, known as the handle\&. Takes a hexadecimal number in the range 0x1\(en0xffff\&. Defaults to unset\&.
5015 .RE
5016 .PP
5017 \fIDelaySec=\fR
5018 .RS 4
5019 Specifies the fixed amount of delay to be added to all packets going out of the interface\&. Defaults to unset\&.
5020 .sp
5021 Added in version 245\&.
5022 .RE
5023 .PP
5024 \fIDelayJitterSec=\fR
5025 .RS 4
5026 Specifies the chosen delay to be added to the packets outgoing to the network interface\&. Defaults to unset\&.
5027 .sp
5028 Added in version 245\&.
5029 .RE
5030 .PP
5031 \fIPacketLimit=\fR
5032 .RS 4
5033 Specifies the maximum number of packets the qdisc may hold queued at a time\&. An unsigned integer in the range 0\&...4294967294\&. Defaults to 1000\&.
5034 .sp
5035 Added in version 245\&.
5036 .RE
5037 .PP
5038 \fILossRate=\fR
5039 .RS 4
5040 Specifies an independent loss probability to be added to the packets outgoing from the network interface\&. Takes a percentage value, suffixed with "%"\&. Defaults to unset\&.
5041 .sp
5042 Added in version 245\&.
5043 .RE
5044 .PP
5045 \fIDuplicateRate=\fR
5046 .RS 4
5047 Specifies that the chosen percent of packets is duplicated before queuing them\&. Takes a percentage value, suffixed with "%"\&. Defaults to unset\&.
5048 .sp
5049 Added in version 245\&.
5050 .RE
5051 .SH "[TOKENBUCKETFILTER] SECTION OPTIONS"
5052 .PP
5053 The [TokenBucketFilter] section manages the queueing discipline (qdisc) of token bucket filter (tbf)\&.
5054 .PP
5055 \fIParent=\fR
5056 .RS 4
5057 Configures the parent Queueing Discipline (qdisc)\&. Takes one of
5058 "root",
5059 "clsact",
5060 "ingress"
5061 or a class identifier\&. The class identifier is specified as the major and minor numbers in hexadecimal in the range 0x1\(en0xffff separated with a colon ("major:minor")\&. Defaults to
5062 "root"\&.
5063 .RE
5064 .PP
5065 \fIHandle=\fR
5066 .RS 4
5067 Configures the major number of unique identifier of the qdisc, known as the handle\&. Takes a hexadecimal number in the range 0x1\(en0xffff\&. Defaults to unset\&.
5068 .RE
5069 .PP
5070 \fILatencySec=\fR
5071 .RS 4
5072 Specifies the latency parameter, which specifies the maximum amount of time a packet can sit in the Token Bucket Filter (TBF)\&. Defaults to unset\&.
5073 .sp
5074 Added in version 245\&.
5075 .RE
5076 .PP
5077 \fILimitBytes=\fR
5078 .RS 4
5079 Takes the number of bytes that can be queued waiting for tokens to become available\&. When the size is suffixed with K, M, or G, it is parsed as Kilobytes, Megabytes, or Gigabytes, respectively, to the base of 1024\&. Defaults to unset\&.
5080 .sp
5081 Added in version 246\&.
5082 .RE
5083 .PP
5084 \fIBurstBytes=\fR
5085 .RS 4
5086 Specifies the size of the bucket\&. This is the maximum amount of bytes that tokens can be available for instantaneous transfer\&. When the size is suffixed with K, M, or G, it is parsed as Kilobytes, Megabytes, or Gigabytes, respectively, to the base of 1024\&. Defaults to unset\&.
5087 .sp
5088 Added in version 246\&.
5089 .RE
5090 .PP
5091 \fIRate=\fR
5092 .RS 4
5093 Specifies the device specific bandwidth\&. When suffixed with K, M, or G, the specified bandwidth is parsed as Kilobits, Megabits, or Gigabits, respectively, to the base of 1000\&. Defaults to unset\&.
5094 .sp
5095 Added in version 245\&.
5096 .RE
5097 .PP
5098 \fIMPUBytes=\fR
5099 .RS 4
5100 The Minimum Packet Unit (MPU) determines the minimal token usage (specified in bytes) for a packet\&. When suffixed with K, M, or G, the specified size is parsed as Kilobytes, Megabytes, or Gigabytes, respectively, to the base of 1024\&. Defaults to zero\&.
5101 .sp
5102 Added in version 245\&.
5103 .RE
5104 .PP
5105 \fIPeakRate=\fR
5106 .RS 4
5107 Takes the maximum depletion rate of the bucket\&. When suffixed with K, M, or G, the specified size is parsed as Kilobits, Megabits, or Gigabits, respectively, to the base of 1000\&. Defaults to unset\&.
5108 .sp
5109 Added in version 245\&.
5110 .RE
5111 .PP
5112 \fIMTUBytes=\fR
5113 .RS 4
5114 Specifies the size of the peakrate bucket\&. When suffixed with K, M, or G, the specified size is parsed as Kilobytes, Megabytes, or Gigabytes, respectively, to the base of 1024\&. Defaults to unset\&.
5115 .sp
5116 Added in version 245\&.
5117 .RE
5118 .SH "[PIE] SECTION OPTIONS"
5119 .PP
5120 The [PIE] section manages the queueing discipline (qdisc) of Proportional Integral controller\-Enhanced (PIE)\&.
5121 .PP
5122 \fIParent=\fR
5123 .RS 4
5124 Configures the parent Queueing Discipline (qdisc)\&. Takes one of
5125 "root",
5126 "clsact",
5127 "ingress"
5128 or a class identifier\&. The class identifier is specified as the major and minor numbers in hexadecimal in the range 0x1\(en0xffff separated with a colon ("major:minor")\&. Defaults to
5129 "root"\&.
5130 .RE
5131 .PP
5132 \fIHandle=\fR
5133 .RS 4
5134 Configures the major number of unique identifier of the qdisc, known as the handle\&. Takes a hexadecimal number in the range 0x1\(en0xffff\&. Defaults to unset\&.
5135 .RE
5136 .PP
5137 \fIPacketLimit=\fR
5138 .RS 4
5139 Specifies the hard limit on the queue size in number of packets\&. When this limit is reached, incoming packets are dropped\&. An unsigned integer in the range 1\&...4294967294\&. Defaults to unset and kernel\*(Aqs default is used\&.
5140 .sp
5141 Added in version 246\&.
5142 .RE
5143 .SH "[FLOWQUEUEPIE] SECTION OPTIONS"
5144 .PP
5145 The
5146 "[FlowQueuePIE]"
5147 section manages the queueing discipline (qdisc) of Flow Queue Proportional Integral controller\-Enhanced (fq_pie)\&.
5148 .PP
5149 \fIParent=\fR
5150 .RS 4
5151 Configures the parent Queueing Discipline (qdisc)\&. Takes one of
5152 "root",
5153 "clsact",
5154 "ingress"
5155 or a class identifier\&. The class identifier is specified as the major and minor numbers in hexadecimal in the range 0x1\(en0xffff separated with a colon ("major:minor")\&. Defaults to
5156 "root"\&.
5157 .RE
5158 .PP
5159 \fIHandle=\fR
5160 .RS 4
5161 Configures the major number of unique identifier of the qdisc, known as the handle\&. Takes a hexadecimal number in the range 0x1\(en0xffff\&. Defaults to unset\&.
5162 .RE
5163 .PP
5164 \fIPacketLimit=\fR
5165 .RS 4
5166 Specifies the hard limit on the queue size in number of packets\&. When this limit is reached, incoming packets are dropped\&. An unsigned integer ranges 1 to 4294967294\&. Defaults to unset and kernel\*(Aqs default is used\&.
5167 .sp
5168 Added in version 247\&.
5169 .RE
5170 .SH "[STOCHASTICFAIRBLUE] SECTION OPTIONS"
5171 .PP
5172 The [StochasticFairBlue] section manages the queueing discipline (qdisc) of stochastic fair blue (sfb)\&.
5173 .PP
5174 \fIParent=\fR
5175 .RS 4
5176 Configures the parent Queueing Discipline (qdisc)\&. Takes one of
5177 "root",
5178 "clsact",
5179 "ingress"
5180 or a class identifier\&. The class identifier is specified as the major and minor numbers in hexadecimal in the range 0x1\(en0xffff separated with a colon ("major:minor")\&. Defaults to
5181 "root"\&.
5182 .RE
5183 .PP
5184 \fIHandle=\fR
5185 .RS 4
5186 Configures the major number of unique identifier of the qdisc, known as the handle\&. Takes a hexadecimal number in the range 0x1\(en0xffff\&. Defaults to unset\&.
5187 .RE
5188 .PP
5189 \fIPacketLimit=\fR
5190 .RS 4
5191 Specifies the hard limit on the queue size in number of packets\&. When this limit is reached, incoming packets are dropped\&. An unsigned integer in the range 0\&...4294967294\&. Defaults to unset and kernel\*(Aqs default is used\&.
5192 .sp
5193 Added in version 246\&.
5194 .RE
5195 .SH "[STOCHASTICFAIRNESSQUEUEING] SECTION OPTIONS"
5196 .PP
5197 The [StochasticFairnessQueueing] section manages the queueing discipline (qdisc) of stochastic fairness queueing (sfq)\&.
5198 .PP
5199 \fIParent=\fR
5200 .RS 4
5201 Configures the parent Queueing Discipline (qdisc)\&. Takes one of
5202 "root",
5203 "clsact",
5204 "ingress"
5205 or a class identifier\&. The class identifier is specified as the major and minor numbers in hexadecimal in the range 0x1\(en0xffff separated with a colon ("major:minor")\&. Defaults to
5206 "root"\&.
5207 .RE
5208 .PP
5209 \fIHandle=\fR
5210 .RS 4
5211 Configures the major number of unique identifier of the qdisc, known as the handle\&. Takes a hexadecimal number in the range 0x1\(en0xffff\&. Defaults to unset\&.
5212 .RE
5213 .PP
5214 \fIPerturbPeriodSec=\fR
5215 .RS 4
5216 Specifies the interval in seconds for queue algorithm perturbation\&. Defaults to unset\&.
5217 .sp
5218 Added in version 245\&.
5219 .RE
5220 .SH "[BFIFO] SECTION OPTIONS"
5221 .PP
5222 The [BFIFO] section manages the queueing discipline (qdisc) of Byte limited Packet First In First Out (bfifo)\&.
5223 .PP
5224 \fIParent=\fR
5225 .RS 4
5226 Configures the parent Queueing Discipline (qdisc)\&. Takes one of
5227 "root",
5228 "clsact",
5229 "ingress"
5230 or a class identifier\&. The class identifier is specified as the major and minor numbers in hexadecimal in the range 0x1\(en0xffff separated with a colon ("major:minor")\&. Defaults to
5231 "root"\&.
5232 .RE
5233 .PP
5234 \fIHandle=\fR
5235 .RS 4
5236 Configures the major number of unique identifier of the qdisc, known as the handle\&. Takes a hexadecimal number in the range 0x1\(en0xffff\&. Defaults to unset\&.
5237 .RE
5238 .PP
5239 \fILimitBytes=\fR
5240 .RS 4
5241 Specifies the hard limit in bytes on the FIFO buffer size\&. The size limit prevents overflow in case the kernel is unable to dequeue packets as quickly as it receives them\&. When this limit is reached, incoming packets are dropped\&. When suffixed with K, M, or G, the specified size is parsed as Kilobytes, Megabytes, or Gigabytes, respectively, to the base of 1024\&. Defaults to unset and kernel default is used\&.
5242 .sp
5243 Added in version 246\&.
5244 .RE
5245 .SH "[PFIFO] SECTION OPTIONS"
5246 .PP
5247 The [PFIFO] section manages the queueing discipline (qdisc) of Packet First In First Out (pfifo)\&.
5248 .PP
5249 \fIParent=\fR
5250 .RS 4
5251 Configures the parent Queueing Discipline (qdisc)\&. Takes one of
5252 "root",
5253 "clsact",
5254 "ingress"
5255 or a class identifier\&. The class identifier is specified as the major and minor numbers in hexadecimal in the range 0x1\(en0xffff separated with a colon ("major:minor")\&. Defaults to
5256 "root"\&.
5257 .RE
5258 .PP
5259 \fIHandle=\fR
5260 .RS 4
5261 Configures the major number of unique identifier of the qdisc, known as the handle\&. Takes a hexadecimal number in the range 0x1\(en0xffff\&. Defaults to unset\&.
5262 .RE
5263 .PP
5264 \fIPacketLimit=\fR
5265 .RS 4
5266 Specifies the hard limit on the number of packets in the FIFO queue\&. The size limit prevents overflow in case the kernel is unable to dequeue packets as quickly as it receives them\&. When this limit is reached, incoming packets are dropped\&. An unsigned integer in the range 0\&...4294967294\&. Defaults to unset and kernel\*(Aqs default is used\&.
5267 .sp
5268 Added in version 246\&.
5269 .RE
5270 .SH "[PFIFOHEADDROP] SECTION OPTIONS"
5271 .PP
5272 The [PFIFOHeadDrop] section manages the queueing discipline (qdisc) of Packet First In First Out Head Drop (pfifo_head_drop)\&.
5273 .PP
5274 \fIParent=\fR
5275 .RS 4
5276 Configures the parent Queueing Discipline (qdisc)\&. Takes one of
5277 "root",
5278 "clsact",
5279 "ingress"
5280 or a class identifier\&. The class identifier is specified as the major and minor numbers in hexadecimal in the range 0x1\(en0xffff separated with a colon ("major:minor")\&. Defaults to
5281 "root"\&.
5282 .RE
5283 .PP
5284 \fIHandle=\fR
5285 .RS 4
5286 Configures the major number of unique identifier of the qdisc, known as the handle\&. Takes a hexadecimal number in the range 0x1\(en0xffff\&. Defaults to unset\&.
5287 .RE
5288 .PP
5289 \fIPacketLimit=\fR
5290 .RS 4
5291 As in [PFIFO] section\&.
5292 .sp
5293 Added in version 246\&.
5294 .RE
5295 .SH "[PFIFOFAST] SECTION OPTIONS"
5296 .PP
5297 The [PFIFOFast] section manages the queueing discipline (qdisc) of Packet First In First Out Fast (pfifo_fast)\&.
5298 .PP
5299 \fIParent=\fR
5300 .RS 4
5301 Configures the parent Queueing Discipline (qdisc)\&. Takes one of
5302 "root",
5303 "clsact",
5304 "ingress"
5305 or a class identifier\&. The class identifier is specified as the major and minor numbers in hexadecimal in the range 0x1\(en0xffff separated with a colon ("major:minor")\&. Defaults to
5306 "root"\&.
5307 .RE
5308 .PP
5309 \fIHandle=\fR
5310 .RS 4
5311 Configures the major number of unique identifier of the qdisc, known as the handle\&. Takes a hexadecimal number in the range 0x1\(en0xffff\&. Defaults to unset\&.
5312 .RE
5313 .SH "[CAKE] SECTION OPTIONS"
5314 .PP
5315 The [CAKE] section manages the queueing discipline (qdisc) of Common Applications Kept Enhanced (CAKE)\&.
5316 .PP
5317 \fIParent=\fR
5318 .RS 4
5319 Configures the parent Queueing Discipline (qdisc)\&. Takes one of
5320 "root",
5321 "clsact",
5322 "ingress"
5323 or a class identifier\&. The class identifier is specified as the major and minor numbers in hexadecimal in the range 0x1\(en0xffff separated with a colon ("major:minor")\&. Defaults to
5324 "root"\&.
5325 .RE
5326 .PP
5327 \fIHandle=\fR
5328 .RS 4
5329 Configures the major number of unique identifier of the qdisc, known as the handle\&. Takes a hexadecimal number in the range 0x1\(en0xffff\&. Defaults to unset\&.
5330 .RE
5331 .PP
5332 \fIBandwidth=\fR
5333 .RS 4
5334 Specifies the shaper bandwidth\&. When suffixed with K, M, or G, the specified size is parsed as Kilobits, Megabits, or Gigabits, respectively, to the base of 1000\&. Defaults to unset and kernel\*(Aqs default is used\&.
5335 .sp
5336 Added in version 246\&.
5337 .RE
5338 .PP
5339 \fIAutoRateIngress=\fR
5340 .RS 4
5341 Takes a boolean value\&. Enables automatic capacity estimation based on traffic arriving at this qdisc\&. This is most likely to be useful with cellular links, which tend to change quality randomly\&. If this setting is enabled, the
5342 \fIBandwidth=\fR
5343 setting is used as an initial estimate\&. Defaults to unset, and the kernel\*(Aqs default is used\&.
5344 .sp
5345 Added in version 250\&.
5346 .RE
5347 .PP
5348 \fIOverheadBytes=\fR
5349 .RS 4
5350 Specifies that bytes to be addeded to the size of each packet\&. Bytes may be negative\&. Takes an integer in the range \-64\&...256\&. Defaults to unset and kernel\*(Aqs default is used\&.
5351 .sp
5352 Added in version 246\&.
5353 .RE
5354 .PP
5355 \fIMPUBytes=\fR
5356 .RS 4
5357 Rounds each packet (including overhead) up to the specified bytes\&. Takes an integer in the range 1\&...256\&. Defaults to unset and kernel\*(Aqs default is used\&.
5358 .sp
5359 Added in version 250\&.
5360 .RE
5361 .PP
5362 \fICompensationMode=\fR
5363 .RS 4
5364 Takes one of
5365 "none",
5366 "atm", or
5367 "ptm"\&. Specifies the compensation mode for overhead calculation\&. When
5368 "none", no compensation is taken into account\&. When
5369 "atm", enables the compensation for ATM cell framing, which is normally found on ADSL links\&. When
5370 "ptm", enables the compensation for PTM encoding, which is normally found on VDSL2 links and uses a 64b/65b encoding scheme\&. Defaults to unset and the kernel\*(Aqs default is used\&.
5371 .sp
5372 Added in version 250\&.
5373 .RE
5374 .PP
5375 \fIUseRawPacketSize=\fR
5376 .RS 4
5377 Takes a boolean value\&. When true, the packet size reported by the Linux kernel will be used, instead of the underlying IP packet size\&. Defaults to unset, and the kernel\*(Aqs default is used\&.
5378 .sp
5379 Added in version 250\&.
5380 .RE
5381 .PP
5382 \fIFlowIsolationMode=\fR
5383 .RS 4
5384 CAKE places packets from different flows into different queues, then packets from each queue are delivered fairly\&. This specifies whether the fairness is based on source address, destination address, individual flows, or any combination of those\&. The available values are:
5385 .PP
5386 \fBnone\fR
5387 .RS 4
5388 The flow isolation is disabled, and all traffic passes through a single queue\&.
5389 .sp
5390 Added in version 250\&.
5391 .RE
5392 .PP
5393 \fBsrc\-host\fR
5394 .RS 4
5395 Flows are defined only by source address\&. Equivalent to the
5396 "srchost"
5397 option for
5398 \fBtc qdisc\fR
5399 command\&. See also
5400 \fBtc-cake\fR(8)\&.
5401 .sp
5402 Added in version 250\&.
5403 .RE
5404 .PP
5405 \fBdst\-host\fR
5406 .RS 4
5407 Flows are defined only by destination address\&. Equivalent to the
5408 "dsthost"
5409 option for
5410 \fBtc qdisc\fR
5411 command\&. See also
5412 \fBtc-cake\fR(8)\&.
5413 .sp
5414 Added in version 250\&.
5415 .RE
5416 .PP
5417 \fBhosts\fR
5418 .RS 4
5419 Flows are defined by source\-destination host pairs\&. Equivalent to the same option for
5420 \fBtc qdisc\fR
5421 command\&. See also
5422 \fBtc-cake\fR(8)\&.
5423 .sp
5424 Added in version 250\&.
5425 .RE
5426 .PP
5427 \fBflows\fR
5428 .RS 4
5429 Flows are defined by the entire 5\-tuple of source address, destination address, transport protocol, source port and destination port\&. Equivalent to the same option for
5430 \fBtc qdisc\fR
5431 command\&. See also
5432 \fBtc-cake\fR(8)\&.
5433 .sp
5434 Added in version 250\&.
5435 .RE
5436 .PP
5437 \fBdual\-src\-host\fR
5438 .RS 4
5439 Flows are defined by the 5\-tuple (see
5440 "flows"
5441 in the above), and fairness is applied first over source addresses, then over individual flows\&. Equivalent to the
5442 "dual\-srchost"
5443 option for
5444 \fBtc qdisc\fR
5445 command\&. See also
5446 \fBtc-cake\fR(8)\&.
5447 .sp
5448 Added in version 250\&.
5449 .RE
5450 .PP
5451 \fBdual\-dst\-host\fR
5452 .RS 4
5453 Flows are defined by the 5\-tuple (see
5454 "flows"
5455 in the above), and fairness is applied first over destination addresses, then over individual flows\&. Equivalent to the
5456 "dual\-dsthost"
5457 option for
5458 \fBtc qdisc\fR
5459 command\&. See also
5460 \fBtc-cake\fR(8)\&.
5461 .sp
5462 Added in version 250\&.
5463 .RE
5464 .PP
5465 \fBtriple\fR
5466 .RS 4
5467 Flows are defined by the 5\-tuple (see
5468 "flows"), and fairness is applied over source and destination addresses, and also over individual flows\&. Equivalent to the
5469 "triple\-isolate"
5470 option for
5471 \fBtc qdisc\fR
5472 command\&. See also
5473 \fBtc-cake\fR(8)\&.
5474 .sp
5475 Added in version 250\&.
5476 .RE
5477 .sp
5478 Defaults to unset and the kernel\*(Aqs default is used\&.
5479 .sp
5480 Added in version 250\&.
5481 .RE
5482 .PP
5483 \fINAT=\fR
5484 .RS 4
5485 Takes a boolean value\&. When true, CAKE performs a NAT lookup before applying flow\-isolation rules, to determine the true addresses and port numbers of the packet, to improve fairness between hosts inside the NAT\&. This has no practical effect when
5486 \fIFlowIsolationMode=\fR
5487 is
5488 "none"
5489 or
5490 "flows", or if NAT is performed on a different host\&. Defaults to unset, and the kernel\*(Aqs default is used\&.
5491 .sp
5492 Added in version 250\&.
5493 .RE
5494 .PP
5495 \fIPriorityQueueingPreset=\fR
5496 .RS 4
5497 CAKE divides traffic into
5498 "tins", and each tin has its own independent set of flow\-isolation queues, bandwidth threshold, and priority\&. This specifies the preset of tin profiles\&. The available values are:
5499 .PP
5500 \fBbesteffort\fR
5501 .RS 4
5502 Disables priority queueing by placing all traffic in one tin\&.
5503 .sp
5504 Added in version 250\&.
5505 .RE
5506 .PP
5507 \fBprecedence\fR
5508 .RS 4
5509 Enables priority queueing based on the legacy interpretation of TOS
5510 "Precedence"
5511 field\&. Use of this preset on the modern Internet is firmly discouraged\&.
5512 .sp
5513 Added in version 250\&.
5514 .RE
5515 .PP
5516 \fBdiffserv8\fR
5517 .RS 4
5518 Enables priority queueing based on the Differentiated Service ("DiffServ") field with eight tins: Background Traffic, High Throughput, Best Effort, Video Streaming, Low Latency Transactions, Interactive Shell, Minimum Latency, and Network Control\&.
5519 .sp
5520 Added in version 250\&.
5521 .RE
5522 .PP
5523 \fBdiffserv4\fR
5524 .RS 4
5525 Enables priority queueing based on the Differentiated Service ("DiffServ") field with four tins: Background Traffic, Best Effort, Streaming Media, and Latency Sensitive\&.
5526 .sp
5527 Added in version 250\&.
5528 .RE
5529 .PP
5530 \fBdiffserv3\fR
5531 .RS 4
5532 Enables priority queueing based on the Differentiated Service ("DiffServ") field with three tins: Background Traffic, Best Effort, and Latency Sensitive\&.
5533 .sp
5534 Added in version 250\&.
5535 .RE
5536 .sp
5537 Defaults to unset, and the kernel\*(Aqs default is used\&.
5538 .sp
5539 Added in version 250\&.
5540 .RE
5541 .PP
5542 \fIFirewallMark=\fR
5543 .RS 4
5544 Takes an integer in the range 1\&...4294967295\&. When specified, firewall\-mark\-based overriding of CAKE\*(Aqs tin selection is enabled\&. Defaults to unset, and the kernel\*(Aqs default is used\&.
5545 .sp
5546 Added in version 250\&.
5547 .RE
5548 .PP
5549 \fIWash=\fR
5550 .RS 4
5551 Takes a boolean value\&. When true, CAKE clears the DSCP fields, except for ECN bits, of any packet passing through CAKE\&. Defaults to unset, and the kernel\*(Aqs default is used\&.
5552 .sp
5553 Added in version 250\&.
5554 .RE
5555 .PP
5556 \fISplitGSO=\fR
5557 .RS 4
5558 Takes a boolean value\&. When true, CAKE will split General Segmentation Offload (GSO) super\-packets into their on\-the\-wire components and dequeue them individually\&. Defaults to unset, and the kernel\*(Aqs default is used\&.
5559 .sp
5560 Added in version 250\&.
5561 .RE
5562 .PP
5563 \fIRTTSec=\fR
5564 .RS 4
5565 Specifies the RTT for the filter\&. Takes a timespan\&. Typical values are e\&.g\&. 100us for extremely high\-performance 10GigE+ networks like datacentre, 1ms for non\-WiFi LAN connections, 100ms for typical internet connections\&. Defaults to unset, and the kernel\*(Aqs default will be used\&.
5566 .sp
5567 Added in version 253\&.
5568 .RE
5569 .PP
5570 \fIAckFilter=\fR
5571 .RS 4
5572 Takes a boolean value, or special value
5573 "aggressive"\&. If enabled, ACKs in each flow are queued and redundant ACKs to the upstream are dropped\&. If yes, the filter will always keep at least two redundant ACKs in the queue, while in
5574 "aggressive"
5575 mode, it will filter down to a single ACK\&. This may improve download throughput on links with very asymmetrical rate limits\&. Defaults to unset, and the kernel\*(Aqs default will be used\&.
5576 .sp
5577 Added in version 253\&.
5578 .RE
5579 .SH "[CONTROLLEDDELAY] SECTION OPTIONS"
5580 .PP
5581 The [ControlledDelay] section manages the queueing discipline (qdisc) of controlled delay (CoDel)\&.
5582 .PP
5583 \fIParent=\fR
5584 .RS 4
5585 Configures the parent Queueing Discipline (qdisc)\&. Takes one of
5586 "root",
5587 "clsact",
5588 "ingress"
5589 or a class identifier\&. The class identifier is specified as the major and minor numbers in hexadecimal in the range 0x1\(en0xffff separated with a colon ("major:minor")\&. Defaults to
5590 "root"\&.
5591 .RE
5592 .PP
5593 \fIHandle=\fR
5594 .RS 4
5595 Configures the major number of unique identifier of the qdisc, known as the handle\&. Takes a hexadecimal number in the range 0x1\(en0xffff\&. Defaults to unset\&.
5596 .RE
5597 .PP
5598 \fIPacketLimit=\fR
5599 .RS 4
5600 Specifies the hard limit on the queue size in number of packets\&. When this limit is reached, incoming packets are dropped\&. An unsigned integer in the range 0\&...4294967294\&. Defaults to unset and kernel\*(Aqs default is used\&.
5601 .sp
5602 Added in version 245\&.
5603 .RE
5604 .PP
5605 \fITargetSec=\fR
5606 .RS 4
5607 Takes a timespan\&. Specifies the acceptable minimum standing/persistent queue delay\&. Defaults to unset and kernel\*(Aqs default is used\&.
5608 .sp
5609 Added in version 245\&.
5610 .RE
5611 .PP
5612 \fIIntervalSec=\fR
5613 .RS 4
5614 Takes a timespan\&. This is used to ensure that the measured minimum delay does not become too stale\&. Defaults to unset and kernel\*(Aqs default is used\&.
5615 .sp
5616 Added in version 245\&.
5617 .RE
5618 .PP
5619 \fIECN=\fR
5620 .RS 4
5621 Takes a boolean\&. This can be used to mark packets instead of dropping them\&. Defaults to unset and kernel\*(Aqs default is used\&.
5622 .sp
5623 Added in version 245\&.
5624 .RE
5625 .PP
5626 \fICEThresholdSec=\fR
5627 .RS 4
5628 Takes a timespan\&. This sets a threshold above which all packets are marked with ECN Congestion Experienced (CE)\&. Defaults to unset and kernel\*(Aqs default is used\&.
5629 .sp
5630 Added in version 245\&.
5631 .RE
5632 .SH "[DEFICITROUNDROBINSCHEDULER] SECTION OPTIONS"
5633 .PP
5634 The [DeficitRoundRobinScheduler] section manages the queueing discipline (qdisc) of Deficit Round Robin Scheduler (DRR)\&.
5635 .PP
5636 \fIParent=\fR
5637 .RS 4
5638 Configures the parent Queueing Discipline (qdisc)\&. Takes one of
5639 "root",
5640 "clsact",
5641 "ingress"
5642 or a class identifier\&. The class identifier is specified as the major and minor numbers in hexadecimal in the range 0x1\(en0xffff separated with a colon ("major:minor")\&. Defaults to
5643 "root"\&.
5644 .RE
5645 .PP
5646 \fIHandle=\fR
5647 .RS 4
5648 Configures the major number of unique identifier of the qdisc, known as the handle\&. Takes a hexadecimal number in the range 0x1\(en0xffff\&. Defaults to unset\&.
5649 .RE
5650 .SH "[DEFICITROUNDROBINSCHEDULERCLASS] SECTION OPTIONS"
5651 .PP
5652 The [DeficitRoundRobinSchedulerClass] section manages the traffic control class of Deficit Round Robin Scheduler (DRR)\&.
5653 .PP
5654 \fIParent=\fR
5655 .RS 4
5656 Configures the parent Queueing Discipline (qdisc)\&. Takes one of
5657 "root", or a qdisc identifier\&. The qdisc identifier is specified as the major and minor numbers in hexadecimal in the range 0x1\(en0xffff separated with a colon ("major:minor")\&. Defaults to
5658 "root"\&.
5659 .RE
5660 .PP
5661 \fIClassId=\fR
5662 .RS 4
5663 Configures the unique identifier of the class\&. It is specified as the major and minor numbers in hexadecimal in the range 0x1\(en0xffff separated with a colon ("major:minor")\&. Defaults to unset\&.
5664 .RE
5665 .PP
5666 \fIQuantumBytes=\fR
5667 .RS 4
5668 Specifies the amount of bytes a flow is allowed to dequeue before the scheduler moves to the next class\&. When suffixed with K, M, or G, the specified size is parsed as Kilobytes, Megabytes, or Gigabytes, respectively, to the base of 1024\&. Defaults to the MTU of the interface\&.
5669 .sp
5670 Added in version 246\&.
5671 .RE
5672 .SH "[ENHANCEDTRANSMISSIONSELECTION] SECTION OPTIONS"
5673 .PP
5674 The [EnhancedTransmissionSelection] section manages the queueing discipline (qdisc) of Enhanced Transmission Selection (ETS)\&.
5675 .PP
5676 \fIParent=\fR
5677 .RS 4
5678 Configures the parent Queueing Discipline (qdisc)\&. Takes one of
5679 "root",
5680 "clsact",
5681 "ingress"
5682 or a class identifier\&. The class identifier is specified as the major and minor numbers in hexadecimal in the range 0x1\(en0xffff separated with a colon ("major:minor")\&. Defaults to
5683 "root"\&.
5684 .RE
5685 .PP
5686 \fIHandle=\fR
5687 .RS 4
5688 Configures the major number of unique identifier of the qdisc, known as the handle\&. Takes a hexadecimal number in the range 0x1\(en0xffff\&. Defaults to unset\&.
5689 .RE
5690 .PP
5691 \fIBands=\fR
5692 .RS 4
5693 Specifies the number of bands\&. An unsigned integer in the range 1\&...16\&. This value has to be at least large enough to cover the strict bands specified through the
5694 \fIStrictBands=\fR
5695 and bandwidth\-sharing bands specified in
5696 \fIQuantumBytes=\fR\&.
5697 .sp
5698 Added in version 246\&.
5699 .RE
5700 .PP
5701 \fIStrictBands=\fR
5702 .RS 4
5703 Specifies the number of bands that should be created in strict mode\&. An unsigned integer in the range 1\&...16\&.
5704 .sp
5705 Added in version 246\&.
5706 .RE
5707 .PP
5708 \fIQuantumBytes=\fR
5709 .RS 4
5710 Specifies the white\-space separated list of quantum used in band\-sharing bands\&. When suffixed with K, M, or G, the specified size is parsed as Kilobytes, Megabytes, or Gigabytes, respectively, to the base of 1024\&. This setting can be specified multiple times\&. If an empty string is assigned, then the all previous assignments are cleared\&.
5711 .sp
5712 Added in version 246\&.
5713 .RE
5714 .PP
5715 \fIPriorityMap=\fR
5716 .RS 4
5717 The priority map maps the priority of a packet to a band\&. The argument is a whitespace separated list of numbers\&. The first number indicates which band the packets with priority 0 should be put to, the second is for priority 1, and so on\&. There can be up to 16 numbers in the list\&. If there are fewer, the default band that traffic with one of the unmentioned priorities goes to is the last one\&. Each band number must be in the range 0\&...255\&. This setting can be specified multiple times\&. If an empty string is assigned, then the all previous assignments are cleared\&.
5718 .sp
5719 Added in version 246\&.
5720 .RE
5721 .SH "[GENERICRANDOMEARLYDETECTION] SECTION OPTIONS"
5722 .PP
5723 The [GenericRandomEarlyDetection] section manages the queueing discipline (qdisc) of Generic Random Early Detection (GRED)\&.
5724 .PP
5725 \fIParent=\fR
5726 .RS 4
5727 Configures the parent Queueing Discipline (qdisc)\&. Takes one of
5728 "root",
5729 "clsact",
5730 "ingress"
5731 or a class identifier\&. The class identifier is specified as the major and minor numbers in hexadecimal in the range 0x1\(en0xffff separated with a colon ("major:minor")\&. Defaults to
5732 "root"\&.
5733 .RE
5734 .PP
5735 \fIHandle=\fR
5736 .RS 4
5737 Configures the major number of unique identifier of the qdisc, known as the handle\&. Takes a hexadecimal number in the range 0x1\(en0xffff\&. Defaults to unset\&.
5738 .RE
5739 .PP
5740 \fIVirtualQueues=\fR
5741 .RS 4
5742 Specifies the number of virtual queues\&. Takes an integer in the range 1\&...16\&. Defaults to unset and kernel\*(Aqs default is used\&.
5743 .sp
5744 Added in version 246\&.
5745 .RE
5746 .PP
5747 \fIDefaultVirtualQueue=\fR
5748 .RS 4
5749 Specifies the number of default virtual queue\&. This must be less than
5750 \fIVirtualQueue=\fR\&. Defaults to unset and kernel\*(Aqs default is used\&.
5751 .sp
5752 Added in version 246\&.
5753 .RE
5754 .PP
5755 \fIGenericRIO=\fR
5756 .RS 4
5757 Takes a boolean\&. It turns on the RIO\-like buffering scheme\&. Defaults to unset and kernel\*(Aqs default is used\&.
5758 .sp
5759 Added in version 246\&.
5760 .RE
5761 .SH "[FAIRQUEUEINGCONTROLLEDDELAY] SECTION OPTIONS"
5762 .PP
5763 The [FairQueueingControlledDelay] section manages the queueing discipline (qdisc) of fair queuing controlled delay (FQ\-CoDel)\&.
5764 .PP
5765 \fIParent=\fR
5766 .RS 4
5767 Configures the parent Queueing Discipline (qdisc)\&. Takes one of
5768 "root",
5769 "clsact",
5770 "ingress"
5771 or a class identifier\&. The class identifier is specified as the major and minor numbers in hexadecimal in the range 0x1\(en0xffff separated with a colon ("major:minor")\&. Defaults to
5772 "root"\&.
5773 .RE
5774 .PP
5775 \fIHandle=\fR
5776 .RS 4
5777 Configures the major number of unique identifier of the qdisc, known as the handle\&. Takes a hexadecimal number in the range 0x1\(en0xffff\&. Defaults to unset\&.
5778 .RE
5779 .PP
5780 \fIPacketLimit=\fR
5781 .RS 4
5782 Specifies the hard limit on the real queue size\&. When this limit is reached, incoming packets are dropped\&. Defaults to unset and kernel\*(Aqs default is used\&.
5783 .sp
5784 Added in version 245\&.
5785 .RE
5786 .PP
5787 \fIMemoryLimitBytes=\fR
5788 .RS 4
5789 Specifies the limit on the total number of bytes that can be queued in this FQ\-CoDel instance\&. When suffixed with K, M, or G, the specified size is parsed as Kilobytes, Megabytes, or Gigabytes, respectively, to the base of 1024\&. Defaults to unset and kernel\*(Aqs default is used\&.
5790 .sp
5791 Added in version 246\&.
5792 .RE
5793 .PP
5794 \fIFlows=\fR
5795 .RS 4
5796 Specifies the number of flows into which the incoming packets are classified\&. Defaults to unset and kernel\*(Aqs default is used\&.
5797 .sp
5798 Added in version 245\&.
5799 .RE
5800 .PP
5801 \fITargetSec=\fR
5802 .RS 4
5803 Takes a timespan\&. Specifies the acceptable minimum standing/persistent queue delay\&. Defaults to unset and kernel\*(Aqs default is used\&.
5804 .sp
5805 Added in version 245\&.
5806 .RE
5807 .PP
5808 \fIIntervalSec=\fR
5809 .RS 4
5810 Takes a timespan\&. This is used to ensure that the measured minimum delay does not become too stale\&. Defaults to unset and kernel\*(Aqs default is used\&.
5811 .sp
5812 Added in version 245\&.
5813 .RE
5814 .PP
5815 \fIQuantumBytes=\fR
5816 .RS 4
5817 Specifies the number of bytes used as the "deficit" in the fair queuing algorithm timespan\&. When suffixed with K, M, or G, the specified size is parsed as Kilobytes, Megabytes, or Gigabytes, respectively, to the base of 1024\&. Defaults to unset and kernel\*(Aqs default is used\&.
5818 .sp
5819 Added in version 246\&.
5820 .RE
5821 .PP
5822 \fIECN=\fR
5823 .RS 4
5824 Takes a boolean\&. This can be used to mark packets instead of dropping them\&. Defaults to unset and kernel\*(Aqs default is used\&.
5825 .sp
5826 Added in version 245\&.
5827 .RE
5828 .PP
5829 \fICEThresholdSec=\fR
5830 .RS 4
5831 Takes a timespan\&. This sets a threshold above which all packets are marked with ECN Congestion Experienced (CE)\&. Defaults to unset and kernel\*(Aqs default is used\&.
5832 .sp
5833 Added in version 245\&.
5834 .RE
5835 .SH "[FAIRQUEUEING] SECTION OPTIONS"
5836 .PP
5837 The [FairQueueing] section manages the queueing discipline (qdisc) of fair queue traffic policing (FQ)\&.
5838 .PP
5839 \fIParent=\fR
5840 .RS 4
5841 Configures the parent Queueing Discipline (qdisc)\&. Takes one of
5842 "root",
5843 "clsact",
5844 "ingress"
5845 or a class identifier\&. The class identifier is specified as the major and minor numbers in hexadecimal in the range 0x1\(en0xffff separated with a colon ("major:minor")\&. Defaults to
5846 "root"\&.
5847 .RE
5848 .PP
5849 \fIHandle=\fR
5850 .RS 4
5851 Configures the major number of unique identifier of the qdisc, known as the handle\&. Takes a hexadecimal number in the range 0x1\(en0xffff\&. Defaults to unset\&.
5852 .RE
5853 .PP
5854 \fIPacketLimit=\fR
5855 .RS 4
5856 Specifies the hard limit on the real queue size\&. When this limit is reached, incoming packets are dropped\&. Defaults to unset and kernel\*(Aqs default is used\&.
5857 .sp
5858 Added in version 245\&.
5859 .RE
5860 .PP
5861 \fIFlowLimit=\fR
5862 .RS 4
5863 Specifies the hard limit on the maximum number of packets queued per flow\&. Defaults to unset and kernel\*(Aqs default is used\&.
5864 .sp
5865 Added in version 245\&.
5866 .RE
5867 .PP
5868 \fIQuantumBytes=\fR
5869 .RS 4
5870 Specifies the credit per dequeue RR round, i\&.e\&. the amount of bytes a flow is allowed to dequeue at once\&. When suffixed with K, M, or G, the specified size is parsed as Kilobytes, Megabytes, or Gigabytes, respectively, to the base of 1024\&. Defaults to unset and kernel\*(Aqs default is used\&.
5871 .sp
5872 Added in version 246\&.
5873 .RE
5874 .PP
5875 \fIInitialQuantumBytes=\fR
5876 .RS 4
5877 Specifies the initial sending rate credit, i\&.e\&. the amount of bytes a new flow is allowed to dequeue initially\&. When suffixed with K, M, or G, the specified size is parsed as Kilobytes, Megabytes, or Gigabytes, respectively, to the base of 1024\&. Defaults to unset and kernel\*(Aqs default is used\&.
5878 .sp
5879 Added in version 245\&.
5880 .RE
5881 .PP
5882 \fIMaximumRate=\fR
5883 .RS 4
5884 Specifies the maximum sending rate of a flow\&. When suffixed with K, M, or G, the specified size is parsed as Kilobits, Megabits, or Gigabits, respectively, to the base of 1000\&. Defaults to unset and kernel\*(Aqs default is used\&.
5885 .sp
5886 Added in version 245\&.
5887 .RE
5888 .PP
5889 \fIBuckets=\fR
5890 .RS 4
5891 Specifies the size of the hash table used for flow lookups\&. Defaults to unset and kernel\*(Aqs default is used\&.
5892 .sp
5893 Added in version 245\&.
5894 .RE
5895 .PP
5896 \fIOrphanMask=\fR
5897 .RS 4
5898 Takes an unsigned integer\&. For packets not owned by a socket, fq is able to mask a part of hash and reduce number of buckets associated with the traffic\&. Defaults to unset and kernel\*(Aqs default is used\&.
5899 .sp
5900 Added in version 245\&.
5901 .RE
5902 .PP
5903 \fIPacing=\fR
5904 .RS 4
5905 Takes a boolean, and enables or disables flow pacing\&. Defaults to unset and kernel\*(Aqs default is used\&.
5906 .sp
5907 Added in version 245\&.
5908 .RE
5909 .PP
5910 \fICEThresholdSec=\fR
5911 .RS 4
5912 Takes a timespan\&. This sets a threshold above which all packets are marked with ECN Congestion Experienced (CE)\&. Defaults to unset and kernel\*(Aqs default is used\&.
5913 .sp
5914 Added in version 245\&.
5915 .RE
5916 .SH "[TRIVIALLINKEQUALIZER] SECTION OPTIONS"
5917 .PP
5918 The [TrivialLinkEqualizer] section manages the queueing discipline (qdisc) of trivial link equalizer (teql)\&.
5919 .PP
5920 \fIParent=\fR
5921 .RS 4
5922 Configures the parent Queueing Discipline (qdisc)\&. Takes one of
5923 "root",
5924 "clsact",
5925 "ingress"
5926 or a class identifier\&. The class identifier is specified as the major and minor numbers in hexadecimal in the range 0x1\(en0xffff separated with a colon ("major:minor")\&. Defaults to
5927 "root"\&.
5928 .RE
5929 .PP
5930 \fIHandle=\fR
5931 .RS 4
5932 Configures the major number of unique identifier of the qdisc, known as the handle\&. Takes a hexadecimal number in the range 0x1\(en0xffff\&. Defaults to unset\&.
5933 .RE
5934 .PP
5935 \fIId=\fR
5936 .RS 4
5937 Specifies the interface ID
5938 "N"
5939 of teql\&. Defaults to
5940 "0"\&. Note that when teql is used, currently, the module
5941 \fBsch_teql\fR
5942 with
5943 \fBmax_equalizers=N+1\fR
5944 option must be loaded before
5945 \fBsystemd\-networkd\fR
5946 is started\&.
5947 .sp
5948 Added in version 245\&.
5949 .RE
5950 .SH "[HIERARCHYTOKENBUCKET] SECTION OPTIONS"
5951 .PP
5952 The [HierarchyTokenBucket] section manages the queueing discipline (qdisc) of hierarchy token bucket (htb)\&.
5953 .PP
5954 \fIParent=\fR
5955 .RS 4
5956 Configures the parent Queueing Discipline (qdisc)\&. Takes one of
5957 "root",
5958 "clsact",
5959 "ingress"
5960 or a class identifier\&. The class identifier is specified as the major and minor numbers in hexadecimal in the range 0x1\(en0xffff separated with a colon ("major:minor")\&. Defaults to
5961 "root"\&.
5962 .RE
5963 .PP
5964 \fIHandle=\fR
5965 .RS 4
5966 Configures the major number of unique identifier of the qdisc, known as the handle\&. Takes a hexadecimal number in the range 0x1\(en0xffff\&. Defaults to unset\&.
5967 .RE
5968 .PP
5969 \fIDefaultClass=\fR
5970 .RS 4
5971 Takes the minor id in hexadecimal of the default class\&. Unclassified traffic gets sent to the class\&. Defaults to unset\&.
5972 .sp
5973 Added in version 246\&.
5974 .RE
5975 .PP
5976 \fIRateToQuantum=\fR
5977 .RS 4
5978 Takes an unsigned integer\&. The DRR quantums are calculated by dividing the value configured in
5979 \fIRate=\fR
5980 by
5981 \fIRateToQuantum=\fR\&.
5982 .sp
5983 Added in version 246\&.
5984 .RE
5985 .SH "[HIERARCHYTOKENBUCKETCLASS] SECTION OPTIONS"
5986 .PP
5987 The [HierarchyTokenBucketClass] section manages the traffic control class of hierarchy token bucket (htb)\&.
5988 .PP
5989 \fIParent=\fR
5990 .RS 4
5991 Configures the parent Queueing Discipline (qdisc)\&. Takes one of
5992 "root", or a qdisc identifier\&. The qdisc identifier is specified as the major and minor numbers in hexadecimal in the range 0x1\(en0xffff separated with a colon ("major:minor")\&. Defaults to
5993 "root"\&.
5994 .RE
5995 .PP
5996 \fIClassId=\fR
5997 .RS 4
5998 Configures the unique identifier of the class\&. It is specified as the major and minor numbers in hexadecimal in the range 0x1\(en0xffff separated with a colon ("major:minor")\&. Defaults to unset\&.
5999 .RE
6000 .PP
6001 \fIPriority=\fR
6002 .RS 4
6003 Specifies the priority of the class\&. In the round\-robin process, classes with the lowest priority field are tried for packets first\&.
6004 .sp
6005 Added in version 246\&.
6006 .RE
6007 .PP
6008 \fIQuantumBytes=\fR
6009 .RS 4
6010 Specifies how many bytes to serve from leaf at once\&. When suffixed with K, M, or G, the specified size is parsed as Kilobytes, Megabytes, or Gigabytes, respectively, to the base of 1024\&.
6011 .sp
6012 Added in version 246\&.
6013 .RE
6014 .PP
6015 \fIMTUBytes=\fR
6016 .RS 4
6017 Specifies the maximum packet size we create\&. When suffixed with K, M, or G, the specified size is parsed as Kilobytes, Megabytes, or Gigabytes, respectively, to the base of 1024\&.
6018 .sp
6019 Added in version 246\&.
6020 .RE
6021 .PP
6022 \fIOverheadBytes=\fR
6023 .RS 4
6024 Takes an unsigned integer which specifies per\-packet size overhead used in rate computations\&. When suffixed with K, M, or G, the specified size is parsed as Kilobytes, Megabytes, or Gigabytes, respectively, to the base of 1024\&.
6025 .sp
6026 Added in version 246\&.
6027 .RE
6028 .PP
6029 \fIRate=\fR
6030 .RS 4
6031 Specifies the maximum rate this class and all its children are guaranteed\&. When suffixed with K, M, or G, the specified size is parsed as Kilobits, Megabits, or Gigabits, respectively, to the base of 1000\&. This setting is mandatory\&.
6032 .sp
6033 Added in version 246\&.
6034 .RE
6035 .PP
6036 \fICeilRate=\fR
6037 .RS 4
6038 Specifies the maximum rate at which a class can send, if its parent has bandwidth to spare\&. When suffixed with K, M, or G, the specified size is parsed as Kilobits, Megabits, or Gigabits, respectively, to the base of 1000\&. When unset, the value specified with
6039 \fIRate=\fR
6040 is used\&.
6041 .sp
6042 Added in version 246\&.
6043 .RE
6044 .PP
6045 \fIBufferBytes=\fR
6046 .RS 4
6047 Specifies the maximum bytes burst which can be accumulated during idle period\&. When suffixed with K, M, or G, the specified size is parsed as Kilobytes, Megabytes, or Gigabytes, respectively, to the base of 1024\&.
6048 .sp
6049 Added in version 246\&.
6050 .RE
6051 .PP
6052 \fICeilBufferBytes=\fR
6053 .RS 4
6054 Specifies the maximum bytes burst for ceil which can be accumulated during idle period\&. When suffixed with K, M, or G, the specified size is parsed as Kilobytes, Megabytes, or Gigabytes, respectively, to the base of 1024\&.
6055 .sp
6056 Added in version 246\&.
6057 .RE
6058 .SH "[CLASSFULMULTIQUEUEING] SECTION OPTIONS"
6059 .PP
6060 The [ClassfulMultiQueueing] section manages the queueing discipline (qdisc) of Classful Multi Queueing (mq)\&.
6061 .PP
6062 \fIParent=\fR
6063 .RS 4
6064 Configures the parent Queueing Discipline (qdisc)\&. Takes one of
6065 "root",
6066 "clsact",
6067 "ingress"
6068 or a class identifier\&. The class identifier is specified as the major and minor numbers in hexadecimal in the range 0x1\(en0xffff separated with a colon ("major:minor")\&. Defaults to
6069 "root"\&.
6070 .RE
6071 .PP
6072 \fIHandle=\fR
6073 .RS 4
6074 Configures the major number of unique identifier of the qdisc, known as the handle\&. Takes a hexadecimal number in the range 0x1\(en0xffff\&. Defaults to unset\&.
6075 .RE
6076 .SH "[BANDMULTIQUEUEING] SECTION OPTIONS"
6077 .PP
6078 The [BandMultiQueueing] section manages the queueing discipline (qdisc) of Band Multi Queueing (multiq)\&.
6079 .PP
6080 \fIParent=\fR
6081 .RS 4
6082 Configures the parent Queueing Discipline (qdisc)\&. Takes one of
6083 "root",
6084 "clsact",
6085 "ingress"
6086 or a class identifier\&. The class identifier is specified as the major and minor numbers in hexadecimal in the range 0x1\(en0xffff separated with a colon ("major:minor")\&. Defaults to
6087 "root"\&.
6088 .RE
6089 .PP
6090 \fIHandle=\fR
6091 .RS 4
6092 Configures the major number of unique identifier of the qdisc, known as the handle\&. Takes a hexadecimal number in the range 0x1\(en0xffff\&. Defaults to unset\&.
6093 .RE
6094 .SH "[HEAVYHITTERFILTER] SECTION OPTIONS"
6095 .PP
6096 The [HeavyHitterFilter] section manages the queueing discipline (qdisc) of Heavy Hitter Filter (hhf)\&.
6097 .PP
6098 \fIParent=\fR
6099 .RS 4
6100 Configures the parent Queueing Discipline (qdisc)\&. Takes one of
6101 "root",
6102 "clsact",
6103 "ingress"
6104 or a class identifier\&. The class identifier is specified as the major and minor numbers in hexadecimal in the range 0x1\(en0xffff separated with a colon ("major:minor")\&. Defaults to
6105 "root"\&.
6106 .RE
6107 .PP
6108 \fIHandle=\fR
6109 .RS 4
6110 Configures the major number of unique identifier of the qdisc, known as the handle\&. Takes a hexadecimal number in the range 0x1\(en0xffff\&. Defaults to unset\&.
6111 .RE
6112 .PP
6113 \fIPacketLimit=\fR
6114 .RS 4
6115 Specifies the hard limit on the queue size in number of packets\&. When this limit is reached, incoming packets are dropped\&. An unsigned integer in the range 0\&...4294967294\&. Defaults to unset and kernel\*(Aqs default is used\&.
6116 .sp
6117 Added in version 246\&.
6118 .RE
6119 .SH "[QUICKFAIRQUEUEING] SECTION OPTIONS"
6120 .PP
6121 The [QuickFairQueueing] section manages the queueing discipline (qdisc) of Quick Fair Queueing (QFQ)\&.
6122 .PP
6123 \fIParent=\fR
6124 .RS 4
6125 Configures the parent Queueing Discipline (qdisc)\&. Takes one of
6126 "root",
6127 "clsact",
6128 "ingress"
6129 or a class identifier\&. The class identifier is specified as the major and minor numbers in hexadecimal in the range 0x1\(en0xffff separated with a colon ("major:minor")\&. Defaults to
6130 "root"\&.
6131 .RE
6132 .PP
6133 \fIHandle=\fR
6134 .RS 4
6135 Configures the major number of unique identifier of the qdisc, known as the handle\&. Takes a hexadecimal number in the range 0x1\(en0xffff\&. Defaults to unset\&.
6136 .RE
6137 .SH "[QUICKFAIRQUEUEINGCLASS] SECTION OPTIONS"
6138 .PP
6139 The [QuickFairQueueingClass] section manages the traffic control class of Quick Fair Queueing (qfq)\&.
6140 .PP
6141 \fIParent=\fR
6142 .RS 4
6143 Configures the parent Queueing Discipline (qdisc)\&. Takes one of
6144 "root", or a qdisc identifier\&. The qdisc identifier is specified as the major and minor numbers in hexadecimal in the range 0x1\(en0xffff separated with a colon ("major:minor")\&. Defaults to
6145 "root"\&.
6146 .RE
6147 .PP
6148 \fIClassId=\fR
6149 .RS 4
6150 Configures the unique identifier of the class\&. It is specified as the major and minor numbers in hexadecimal in the range 0x1\(en0xffff separated with a colon ("major:minor")\&. Defaults to unset\&.
6151 .RE
6152 .PP
6153 \fIWeight=\fR
6154 .RS 4
6155 Specifies the weight of the class\&. Takes an integer in the range 1\&...1023\&. Defaults to unset in which case the kernel default is used\&.
6156 .sp
6157 Added in version 246\&.
6158 .RE
6159 .PP
6160 \fIMaxPacketBytes=\fR
6161 .RS 4
6162 Specifies the maximum packet size in bytes for the class\&. When suffixed with K, M, or G, the specified size is parsed as Kilobytes, Megabytes, or Gigabytes, respectively, to the base of 1024\&. When unset, the kernel default is used\&.
6163 .sp
6164 Added in version 246\&.
6165 .RE
6166 .SH "[BRIDGEVLAN] SECTION OPTIONS"
6167 .PP
6168 The [BridgeVLAN] section manages the VLAN ID configuration of a bridge master or enslaved device\&. To make the settings in this section take an effect,
6169 \fIVLANFiltering=\fR
6170 option has to be enabled on the bridge master, see the [Bridge] section in
6171 \fBsystemd.netdev\fR(5), and each enslaved device needs to define the relevant VLAN IDs in its own [BridgeVLAN] section, which it has in common with the bridge master\&. All assigned VLAN IDs on the interface that are not configured in the \&.network file will be removed\&. If VLAN IDs on an interface need to be managed by other tools, then the settings in this section cannot be used in the matching \&.network file and
6172 \fIVLANFiltering=\fR
6173 needs to be disabled on the bridge master\&.
6174 .PP
6175 \fIVLAN=\fR
6176 .RS 4
6177 The VLAN ID allowed on the port\&. This can be either a single ID or a range M\-N\&. Takes an integer in the range 1\&...4094\&. This setting can be specified multiple times\&. If an empty string is assigned, then the all previous assignments are cleared\&.
6178 .sp
6179 Added in version 231\&.
6180 .RE
6181 .PP
6182 \fIEgressUntagged=\fR
6183 .RS 4
6184 The VLAN ID specified here will be used to untag frames on egress\&. Configuring
6185 \fIEgressUntagged=\fR
6186 implicates the use of
6187 \fIVLAN=\fR
6188 above and will enable the VLAN ID for ingress as well\&. This can be either a single ID or a range M\-N\&. This setting can be specified multiple times\&. If an empty string is assigned, then the all previous assignments are cleared\&.
6189 .sp
6190 Added in version 231\&.
6191 .RE
6192 .PP
6193 \fIPVID=\fR
6194 .RS 4
6195 The port VLAN ID specified here is assigned to all untagged frames at ingress\&. Takes an VLAN ID or negative boolean value (e\&.g\&.
6196 "no")\&. When false, the currently assigned port VLAN ID will be dropped\&. Configuring
6197 \fIPVID=\fR
6198 implicates the use of
6199 \fIVLAN=\fR
6200 setting in the above and will enable the VLAN ID for ingress as well\&. Defaults to unset, and will keep the assigned port VLAN ID if exists\&.
6201 .sp
6202 Added in version 231\&.
6203 .RE
6204 .SH "[MOBILENETWORK] SECTION OPTIONS"
6205 .PP
6206 This section configures the default setting of the ModemManager integration\&. See
6207 \m[blue]\fB\%https://modemmanager.org/docs/modemmanager/\fR\m[]
6208 for more information about ModemManager\&.
6209 .PP
6210 Regardless of the [MobileNetwork] section settings consider using the following for LTE modems (take into account that LTE modems do not typically support LLDP because LLDP is a Layer 2 protocol for Ethernet networks and an LTE modem connects to a cellular network, not a local Ethernet LAN):
6211 .sp
6212 .if n \{\
6213 .RS 4
6214 .\}
6215 .nf
6216 [Network]
6217 LLDP=no
6218 LinkLocalAddressing=no
6219 IPv6AcceptRA=no
6220
6221 .fi
6222 .if n \{\
6223 .RE
6224 .\}
6225 .PP
6226 The following options are available in the [MobileNetwork] section:
6227 .PP
6228 \fIAPN=\fR
6229 .RS 4
6230 An Access Point Name (APN) is the name of a gateway between a mobile network (GSM, GPRS, 3G, 4G and 5G) and another computer network\&. Required in 3GPP\&. Defaults to unset and no attempt to establish the connection is made\&.
6231 .sp
6232 Added in version 260\&.
6233 .RE
6234 .PP
6235 \fIAllowedAuthenticationMechanisms=\fR
6236 .RS 4
6237 Authentication method to use\&. Specifies the white\-space separated list of
6238 "none",
6239 "pap",
6240 "chap",
6241 "mschap",
6242 "mschapv2", or
6243 "eap"
6244 methods\&. Optional in 3GPP\&. Defaults to unset and an automatically picked authentication method will be used\&.
6245 .sp
6246 Added in version 260\&.
6247 .RE
6248 .PP
6249 \fIUser=\fR
6250 .RS 4
6251 User name (if any) required by the network\&. Optional in 3GPP\&. Defaults to unset\&.
6252 .sp
6253 Added in version 260\&.
6254 .RE
6255 .PP
6256 \fIPassword=\fR
6257 .RS 4
6258 Password (if any) required by the network\&. Optional in 3GPP\&. Defaults to unset\&.
6259 .sp
6260 Added in version 260\&.
6261 .RE
6262 .PP
6263 \fIIPFamily=\fR
6264 .RS 4
6265 Addressing type\&. Takes one of
6266 "ipv4",
6267 "ipv6",
6268 "both", or
6269 "any"\&. Optional in 3GPP and CDMA\&. Defaults to unset and automatically selected\&.
6270 .sp
6271 Added in version 260\&.
6272 .RE
6273 .PP
6274 \fIAllowRoaming=\fR
6275 .RS 4
6276 A boolean\&. When true, connection is allowed during roaming\&. When false, connection is not allowed during roaming\&. Optional in 3GPP\&. Defaults to
6277 "yes"\&.
6278 .sp
6279 Added in version 260\&.
6280 .RE
6281 .PP
6282 \fIPIN=\fR
6283 .RS 4
6284 SIM\-PIN unlock code\&. Defaults to unset\&.
6285 .sp
6286 Added in version 260\&.
6287 .RE
6288 .PP
6289 \fIOperatorId=\fR
6290 .RS 4
6291 ETSI MCC\-MNC of a network to force registration\&. Defaults to unset\&.
6292 .sp
6293 Added in version 260\&.
6294 .RE
6295 .PP
6296 \fIRouteMetric=\fR
6297 .RS 4
6298 Set the routing metric for routes specified by the mobile network (including the prefix route added for the specified prefix)\&. Takes an unsigned integer in the range 0\&...4294967295\&. When unset or set to 0, the kernel\*(Aqs default value will be used\&.
6299 .sp
6300 Added in version 260\&.
6301 .RE
6302 .PP
6303 \fIUseGateway=\fR
6304 .RS 4
6305 When true (the default), the router address will be configured as the default gateway\&.
6306 .sp
6307 Added in version 260\&.
6308 .RE
6309 .SH "EXAMPLES"
6310 .PP
6311 \fBExample\ \&1.\ \&Static network configuration\fR
6312 .sp
6313 .if n \{\
6314 .RS 4
6315 .\}
6316 .nf
6317 # /etc/systemd/network/50\-static\&.network
6318 [Match]
6319 Name=enp2s0
6320
6321 [Network]
6322 Address=192\&.168\&.0\&.15/24
6323 Gateway=192\&.168\&.0\&.1
6324 .fi
6325 .if n \{\
6326 .RE
6327 .\}
6328 .PP
6329 This brings interface
6330 "enp2s0"
6331 up with a static address\&. The specified gateway will be used for a default route\&.
6332 .PP
6333 \fBExample\ \&2.\ \&DHCP on ethernet links\fR
6334 .sp
6335 .if n \{\
6336 .RS 4
6337 .\}
6338 .nf
6339 # /etc/systemd/network/60\-dhcp\&.network
6340 [Match]
6341 Name=en*
6342
6343 [Network]
6344 DHCP=yes
6345 .fi
6346 .if n \{\
6347 .RE
6348 .\}
6349 .PP
6350 This will enable DHCPv4 and DHCPv6 on all interfaces with names starting with
6351 "en"
6352 (i\&.e\&. ethernet interfaces)\&.
6353 .PP
6354 \fBExample\ \&3.\ \&IPv6 Prefix Delegation (DHCPv6 PD)\fR
6355 .sp
6356 .if n \{\
6357 .RS 4
6358 .\}
6359 .nf
6360 # /etc/systemd/network/55\-dhcpv6\-pd\-upstream\&.network
6361 [Match]
6362 Name=enp1s0
6363
6364 [Network]
6365 DHCP=ipv6
6366
6367 # The lines below are optional, to also assign an address in the delegated prefix
6368 # to the upstream interface\&. Uncomment the lines below if necessary\&.
6369 #[Network]
6370 #DHCPPrefixDelegation=yes
6371 #[DHCPPrefixDelegation]
6372 #UplinkInterface=:self
6373 #SubnetId=0
6374 #Announce=no
6375
6376 # If the upstream network does not provides any Router Advertisement (RA) messages,
6377 # then uncomment the lines below to make the DHCPv6 client forcibly started in the
6378 # managed mode\&.
6379 #[Network]
6380 #IPv6AcceptRA=no
6381 #[DHCPv6]
6382 #WithoutRA=solicit
6383
6384 # If the upstream network provides Router Advertisement (RA) messages with the
6385 # Managed bit unset, then uncomment the lines below to make the DHCPv6 client
6386 # forcibly started in the managed mode when an RA is received\&.
6387 #[DHCPv6]
6388 #UseAddress=no
6389 #[IPv6AcceptRA]
6390 #DHCPv6Client=always
6391 .fi
6392 .if n \{\
6393 .RE
6394 .\}
6395 .sp
6396 .if n \{\
6397 .RS 4
6398 .\}
6399 .nf
6400 # /etc/systemd/network/55\-dhcpv6\-pd\-downstream\&.network
6401 [Match]
6402 Name=enp2s0
6403
6404 [Network]
6405 DHCPPrefixDelegation=yes
6406 IPv6SendRA=yes
6407
6408 # It is expected that the host is acting as a router\&. So, usually it is not
6409 # necessary to receive Router Advertisement from other hosts in the downstream network\&.
6410 IPv6AcceptRA=no
6411
6412 [DHCPPrefixDelegation]
6413 UplinkInterface=enp1s0
6414 SubnetId=1
6415 Announce=yes
6416 .fi
6417 .if n \{\
6418 .RE
6419 .\}
6420 .PP
6421 This will enable DHCPv6\-PD on the interface enp1s0 as an upstream interface where the DHCPv6 client is running and enp2s0 as a downstream interface where the prefix is delegated to\&. The delegated prefixes are distributed by IPv6 Router Advertisement on the downstream network\&.
6422 .PP
6423 \fBExample\ \&4.\ \&IPv6 Prefix Delegation (DHCPv4 6RD)\fR
6424 .sp
6425 .if n \{\
6426 .RS 4
6427 .\}
6428 .nf
6429 # /etc/systemd/network/55\-dhcpv4\-6rd\-upstream\&.network
6430 [Match]
6431 Name=enp1s0
6432
6433 [Network]
6434 DHCP=ipv4
6435
6436 # When DHCPv4\-6RD is used, the upstream network does not support IPv6\&.
6437 # Hence, it is not necessary to wait for Router Advertisement, which is enabled by default\&.
6438 IPv6AcceptRA=no
6439
6440 [DHCPv4]
6441 Use6RD=yes
6442 .fi
6443 .if n \{\
6444 .RE
6445 .\}
6446 .sp
6447 .if n \{\
6448 .RS 4
6449 .\}
6450 .nf
6451 # /etc/systemd/network/55\-dhcpv4\-6rd\-downstream\&.network
6452 [Match]
6453 Name=enp2s0
6454
6455 [Network]
6456 DHCPPrefixDelegation=yes
6457 IPv6SendRA=yes
6458
6459 # It is expected that the host is acting as a router\&. So, usually it is not
6460 # necessary to receive Router Advertisement from other hosts in the downstream network\&.
6461 IPv6AcceptRA=no
6462
6463 [DHCPPrefixDelegation]
6464 UplinkInterface=enp1s0
6465 SubnetId=1
6466 Announce=yes
6467 .fi
6468 .if n \{\
6469 .RE
6470 .\}
6471 .PP
6472 This will enable DHCPv4\-6RD on the interface enp1s0 as an upstream interface where the DHCPv4 client is running and enp2s0 as a downstream interface where the prefix is delegated to\&. The delegated prefixes are distributed by IPv6 Router Advertisement on the downstream network\&.
6473 .PP
6474 \fBExample\ \&5.\ \&A bridge with two enslaved links\fR
6475 .sp
6476 .if n \{\
6477 .RS 4
6478 .\}
6479 .nf
6480 # /etc/systemd/network/25\-bridge\-static\&.netdev
6481 [NetDev]
6482 Name=bridge0
6483 Kind=bridge
6484 .fi
6485 .if n \{\
6486 .RE
6487 .\}
6488 .sp
6489 .if n \{\
6490 .RS 4
6491 .\}
6492 .nf
6493 # /etc/systemd/network/25\-bridge\-static\&.network
6494 [Match]
6495 Name=bridge0
6496
6497 [Network]
6498 Address=192\&.168\&.0\&.15/24
6499 Gateway=192\&.168\&.0\&.1
6500 DNS=192\&.168\&.0\&.1
6501 .fi
6502 .if n \{\
6503 .RE
6504 .\}
6505 .sp
6506 .if n \{\
6507 .RS 4
6508 .\}
6509 .nf
6510 # /etc/systemd/network/25\-bridge\-slave\-interface\-1\&.network
6511 [Match]
6512 Name=enp2s0
6513
6514 [Network]
6515 Bridge=bridge0
6516 .fi
6517 .if n \{\
6518 .RE
6519 .\}
6520 .sp
6521 .if n \{\
6522 .RS 4
6523 .\}
6524 .nf
6525 # /etc/systemd/network/25\-bridge\-slave\-interface\-2\&.network
6526 [Match]
6527 Name=wlp3s0
6528
6529 [Network]
6530 Bridge=bridge0
6531 .fi
6532 .if n \{\
6533 .RE
6534 .\}
6535 .PP
6536 This creates a bridge and attaches devices
6537 "enp2s0"
6538 and
6539 "wlp3s0"
6540 to it\&. The bridge will have the specified static address and network assigned, and a default route via the specified gateway will be added\&. The specified DNS server will be added to the global list of DNS resolvers\&.
6541 .PP
6542 \fBExample\ \&6.\ \&Bridge port with VLAN forwarding\fR
6543 .sp
6544 .if n \{\
6545 .RS 4
6546 .\}
6547 .nf
6548 # /etc/systemd/network/25\-bridge\-slave\-interface\-1\&.network
6549 [Match]
6550 Name=enp2s0
6551
6552 [Network]
6553 Bridge=bridge0
6554
6555 [BridgeVLAN]
6556 VLAN=1\-32
6557 PVID=42
6558 EgressUntagged=42
6559
6560 [BridgeVLAN]
6561 VLAN=100\-299
6562
6563 [BridgeVLAN]
6564 EgressUntagged=300\-400
6565 .fi
6566 .if n \{\
6567 .RE
6568 .\}
6569 .PP
6570 This overrides the configuration specified in the previous example for the interface
6571 "enp2s0", and enables VLAN on that bridge port\&. VLAN IDs 1\-32, 42, 100\-400 will be allowed\&. Packets tagged with VLAN IDs 42, 300\-400 will be untagged when they leave on this interface\&. Untagged packets which arrive on this interface will be assigned VLAN ID 42\&.
6572 .PP
6573 \fBExample\ \&7.\ \&Various tunnels\fR
6574 .sp
6575 .if n \{\
6576 .RS 4
6577 .\}
6578 .nf
6579 /etc/systemd/network/25\-tunnels\&.network
6580 [Match]
6581 Name=ens1
6582
6583 [Network]
6584 Tunnel=ipip\-tun
6585 Tunnel=sit\-tun
6586 Tunnel=gre\-tun
6587 Tunnel=vti\-tun
6588 .fi
6589 .if n \{\
6590 .RE
6591 .\}
6592 .sp
6593 .if n \{\
6594 .RS 4
6595 .\}
6596 .nf
6597 /etc/systemd/network/25\-tunnel\-ipip\&.netdev
6598 [NetDev]
6599 Name=ipip\-tun
6600 Kind=ipip
6601 .fi
6602 .if n \{\
6603 .RE
6604 .\}
6605 .sp
6606 .if n \{\
6607 .RS 4
6608 .\}
6609 .nf
6610 /etc/systemd/network/25\-tunnel\-sit\&.netdev
6611 [NetDev]
6612 Name=sit\-tun
6613 Kind=sit
6614 .fi
6615 .if n \{\
6616 .RE
6617 .\}
6618 .sp
6619 .if n \{\
6620 .RS 4
6621 .\}
6622 .nf
6623 /etc/systemd/network/25\-tunnel\-gre\&.netdev
6624 [NetDev]
6625 Name=gre\-tun
6626 Kind=gre
6627 .fi
6628 .if n \{\
6629 .RE
6630 .\}
6631 .sp
6632 .if n \{\
6633 .RS 4
6634 .\}
6635 .nf
6636 /etc/systemd/network/25\-tunnel\-vti\&.netdev
6637 [NetDev]
6638 Name=vti\-tun
6639 Kind=vti
6640 .fi
6641 .if n \{\
6642 .RE
6643 .\}
6644 .PP
6645 This will bring interface
6646 "ens1"
6647 up and create an IPIP tunnel, a SIT tunnel, a GRE tunnel, and a VTI tunnel using it\&.
6648 .PP
6649 \fBExample\ \&8.\ \&A bond device\fR
6650 .sp
6651 .if n \{\
6652 .RS 4
6653 .\}
6654 .nf
6655 # /etc/systemd/network/30\-bond1\&.network
6656 [Match]
6657 Name=bond1
6658
6659 [Network]
6660 DHCP=ipv6
6661 .fi
6662 .if n \{\
6663 .RE
6664 .\}
6665 .sp
6666 .if n \{\
6667 .RS 4
6668 .\}
6669 .nf
6670 # /etc/systemd/network/30\-bond1\&.netdev
6671 [NetDev]
6672 Name=bond1
6673 Kind=bond
6674 .fi
6675 .if n \{\
6676 .RE
6677 .\}
6678 .sp
6679 .if n \{\
6680 .RS 4
6681 .\}
6682 .nf
6683 # /etc/systemd/network/30\-bond1\-dev1\&.network
6684 [Match]
6685 MACAddress=52:54:00:e9:64:41
6686
6687 [Network]
6688 Bond=bond1
6689 .fi
6690 .if n \{\
6691 .RE
6692 .\}
6693 .sp
6694 .if n \{\
6695 .RS 4
6696 .\}
6697 .nf
6698 # /etc/systemd/network/30\-bond1\-dev2\&.network
6699 [Match]
6700 MACAddress=52:54:00:e9:64:42
6701
6702 [Network]
6703 Bond=bond1
6704 .fi
6705 .if n \{\
6706 .RE
6707 .\}
6708 .PP
6709 This will create a bond device
6710 "bond1"
6711 and enslave the two devices with MAC addresses 52:54:00:e9:64:41 and 52:54:00:e9:64:42 to it\&. IPv6 DHCP will be used to acquire an address\&.
6712 .PP
6713 \fBExample\ \&9.\ \&Virtual Routing and Forwarding (VRF)\fR
6714 .PP
6715 Add the
6716 "bond1"
6717 interface to the VRF master interface
6718 "vrf1"\&. This will redirect routes generated on this interface to be within the routing table defined during VRF creation\&. For kernels before 4\&.8 traffic will not be redirected towards the VRFs routing table unless specific ip\-rules are added\&.
6719 .sp
6720 .if n \{\
6721 .RS 4
6722 .\}
6723 .nf
6724 # /etc/systemd/network/25\-vrf\&.network
6725 [Match]
6726 Name=bond1
6727
6728 [Network]
6729 VRF=vrf1
6730 .fi
6731 .if n \{\
6732 .RE
6733 .\}
6734 .PP
6735 \fBExample\ \&10.\ \&MacVTap\fR
6736 .PP
6737 This brings up a network interface
6738 "macvtap\-test"
6739 and attaches it to
6740 "enp0s25"\&.
6741 .sp
6742 .if n \{\
6743 .RS 4
6744 .\}
6745 .nf
6746 # /usr/lib/systemd/network/25\-macvtap\&.network
6747 [Match]
6748 Name=enp0s25
6749
6750 [Network]
6751 MACVTAP=macvtap\-test
6752 .fi
6753 .if n \{\
6754 .RE
6755 .\}
6756 .PP
6757 \fBExample\ \&11.\ \&A Xfrm interface with physical underlying device\&.\fR
6758 .sp
6759 .if n \{\
6760 .RS 4
6761 .\}
6762 .nf
6763 # /etc/systemd/network/27\-xfrm\&.netdev
6764 [NetDev]
6765 Name=xfrm0
6766 Kind=xfrm
6767
6768 [Xfrm]
6769 InterfaceId=7
6770 .fi
6771 .if n \{\
6772 .RE
6773 .\}
6774 .sp
6775 .if n \{\
6776 .RS 4
6777 .\}
6778 .nf
6779 # /etc/systemd/network/27\-eth0\&.network
6780 [Match]
6781 Name=eth0
6782
6783 [Network]
6784 Xfrm=xfrm0
6785 .fi
6786 .if n \{\
6787 .RE
6788 .\}
6789 .PP
6790 This creates a
6791 "xfrm0"
6792 interface and binds it to the
6793 "eth0"
6794 device\&. This allows hardware based ipsec offloading to the
6795 "eth0"
6796 nic\&. If offloading is not needed, xfrm interfaces can be assigned to the
6797 "lo"
6798 device\&.
6799 .PP
6800 \fBExample\ \&12.\ \&Connecting to a cellular network with ModemManager\fR
6801 .sp
6802 .if n \{\
6803 .RS 4
6804 .\}
6805 .nf
6806 # /etc/systemd/network/27\-wwan0\&.network
6807 [Match]
6808 Name=wwan0
6809
6810 [Network]
6811 LLDP=no
6812 LinkLocalAddressing=no
6813 IPv6AcceptRA=no
6814
6815 [MobileNetwork]
6816 APN=internet
6817 AllowedAuthenticationMechanisms=none pap chap
6818 User=user
6819 Password=pass
6820 IPFamily=both
6821 AllowRoaming=no
6822 PIN=1111
6823 OperatorId=25503
6824 RouteMetric=30
6825 UseGateway=yes
6826 .fi
6827 .if n \{\
6828 .RE
6829 .\}
6830 .PP
6831 This connects a cellular modem to a broadband network matched with the network interface
6832 "wwan0", with APN name
6833 "internet", allowed authentication
6834 "none",
6835 "pcap", or
6836 "chap", user name
6837 "user", their password
6838 "pass", allows both IPv4 and IPv6, does not allow roaming, SIM card pin unlock code
6839 "1111", only allows connecting to operator with MCC
6840 "25503", and sets up a default gateway with route metric of 30\&.
6841 .SH "SEE ALSO"
6842 .PP
6843 \fBsystemd\fR(1), \fBsystemd-networkd.service\fR(8), \fBsystemd.link\fR(5), \fBsystemd.netdev\fR(5), \fBsystemd-network-generator.service\fR(8), \fBsystemd-resolved.service\fR(8)
6844 .SH "NOTES"
6845 .IP " 1." 4
6846 ๐Ÿ’ฃ๐Ÿ’ฅ๐Ÿงจ๐Ÿ’ฅ๐Ÿ’ฅ๐Ÿ’ฃ Please note that those configuration files must be available at all times. If
6847 /usr/local/
6848 is a separate partition, it may not be available during early boot, and must not be used for configuration.
6849 .IP " 2." 4
6850 System and Service Credentials
6851 .RS 4
6852 \%https://systemd.io/CREDENTIALS
6853 .RE
6854 .IP " 3." 4
6855 Link-Local Multicast Name Resolution
6856 .RS 4
6857 \%https://tools.ietf.org/html/rfc4795
6858 .RE
6859 .IP " 4." 4
6860 Multicast DNS
6861 .RS 4
6862 \%https://tools.ietf.org/html/rfc6762
6863 .RE
6864 .IP " 5." 4
6865 DNS-over-TLS
6866 .RS 4
6867 \%https://tools.ietf.org/html/rfc7858
6868 .RE
6869 .IP " 6." 4
6870 DNSSEC
6871 .RS 4
6872 \%https://tools.ietf.org/html/rfc4033
6873 .RE
6874 .IP " 7." 4
6875 IEEE 802.1AB-2016
6876 .RS 4
6877 \%https://standards.ieee.org/findstds/standard/802.1AB-2016.html
6878 .RE
6879 .IP " 8." 4
6880 RFC 5227
6881 .RS 4
6882 \%https://tools.ietf.org/html/rfc5227
6883 .RE
6884 .IP " 9." 4
6885 IP Sysctl
6886 .RS 4
6887 \%https://docs.kernel.org/networking/ip-sysctl.html
6888 .RE
6889 .IP "10." 4
6890 RFC 4941
6891 .RS 4
6892 \%https://tools.ietf.org/html/rfc4941
6893 .RE
6894 .IP "11." 4
6895 RFC 3704
6896 .RS 4
6897 \%https://tools.ietf.org/html/rfc1027
6898 .RE
6899 .IP "12." 4
6900 RFC 3069
6901 .RS 4
6902 \%https://tools.ietf.org/html/rfc3069
6903 .RE
6904 .IP "13." 4
6905 RFC 6275
6906 .RS 4
6907 \%https://tools.ietf.org/html/rfc6275
6908 .RE
6909 .IP "14." 4
6910 RFC 4862
6911 .RS 4
6912 \%https://tools.ietf.org/html/rfc4862
6913 .RE
6914 .IP "15." 4
6915 RFC 3041
6916 .RS 4
6917 \%https://tools.ietf.org/html/rfc3041
6918 .RE
6919 .IP "16." 4
6920 NetLabel
6921 .RS 4
6922 \%https://docs.kernel.org/netlabel/index.html
6923 .RE
6924 .IP "17." 4
6925 Linux Security Modules (LSMs)
6926 .RS 4
6927 \%https://en.wikipedia.org/wiki/Linux_Security_Modules
6928 .RE
6929 .IP "18." 4
6930 NetLabel Fallback Peer Labeling
6931 .RS 4
6932 \%https://github.com/SELinuxProject/selinux-notebook/blob/main/src/network_support.md
6933 .RE
6934 .IP "19." 4
6935 NFT
6936 .RS 4
6937 \%https://netfilter.org/projects/nftables/index.html
6938 .RE
6939 .IP "20." 4
6940 RFC 3484
6941 .RS 4
6942 \%https://tools.ietf.org/html/rfc3484
6943 .RE
6944 .IP "21." 4
6945 Type of Service
6946 .RS 4
6947 \%https://en.wikipedia.org/wiki/Type_of_service
6948 .RE
6949 .IP "22." 4
6950 Differentiated services
6951 .RS 4
6952 \%https://en.wikipedia.org/wiki/Differentiated_services
6953 .RE
6954 .IP "23." 4
6955 Virtual Routing and Forwarding (VRF)
6956 .RS 4
6957 \%https://docs.kernel.org/networking/vrf.html
6958 .RE
6959 .IP "24." 4
6960 RFC 4191
6961 .RS 4
6962 \%https://tools.ietf.org/html/rfc4191
6963 .RE
6964 .IP "25." 4
6965 RFC 2132
6966 .RS 4
6967 \%https://tools.ietf.org/html/rfc2132
6968 .RE
6969 .IP "26." 4
6970 RFC 4702
6971 .RS 4
6972 \%https://tools.ietf.org/html/rfc4702
6973 .RE
6974 .IP "27." 4
6975 RFC 8520
6976 .RS 4
6977 \%https://tools.ietf.org/html/rfc8520
6978 .RE
6979 .IP "28." 4
6980 RFC 4039
6981 .RS 4
6982 \%https://tools.ietf.org/html/rfc4039
6983 .RE
6984 .IP "29." 4
6985 RFC 7844
6986 .RS 4
6987 \%https://tools.ietf.org/html/rfc7844
6988 .RE
6989 .IP "30." 4
6990 C-style escapes
6991 .RS 4
6992 \%https://en.wikipedia.org/wiki/Escape_sequences_in_C#Table_of_escape_sequences
6993 .RE
6994 .IP "31." 4
6995 RFC 9463
6996 .RS 4
6997 \%https://datatracker.ietf.org/doc/html/rfc9463
6998 .RE
6999 .IP "32." 4
7000 RFC 3442
7001 .RS 4
7002 \%https://datatracker.ietf.org/doc/html/rfc3442
7003 .RE
7004 .IP "33." 4
7005 RFC 5969
7006 .RS 4
7007 \%https://tools.ietf.org/html/rfc5969
7008 .RE
7009 .IP "34." 4
7010 RFC 7084
7011 .RS 4
7012 \%https://datatracker.ietf.org/doc/html/rfc7084
7013 .RE
7014 .IP "35." 4
7015 RFC 8925
7016 .RS 4
7017 \%https://tools.ietf.org/html/rfc8925
7018 .RE
7019 .IP "36." 4
7020 RFC 3315
7021 .RS 4
7022 \%https://tools.ietf.org/html/rfc3315#section-17.2.1
7023 .RE
7024 .IP "37." 4
7025 RFC 8415
7026 .RS 4
7027 \%https://www.rfc-editor.org/rfc/rfc8415.html#section-6.3
7028 .RE
7029 .IP "38." 4
7030 RFC 4291
7031 .RS 4
7032 \%https://tools.ietf.org/html/rfc4291#section-2.5.4
7033 .RE
7034 .IP "39." 4
7035 RFC 7217
7036 .RS 4
7037 \%https://tools.ietf.org/html/rfc7217
7038 .RE
7039 .IP "40." 4
7040 RFC 8781
7041 .RS 4
7042 \%https://tools.ietf.org/html/rfc8781
7043 .RE
7044 .IP "41." 4
7045 RFC 2131
7046 .RS 4
7047 \%https://www.rfc-editor.org/rfc/rfc2131.html
7048 .RE
7049 .IP "42." 4
7050 RFC 2132
7051 .RS 4
7052 \%https://www.rfc-editor.org/rfc/rfc2132.html
7053 .RE
7054 .IP "43." 4
7055 RFC 4039
7056 .RS 4
7057 \%https://datatracker.ietf.org/doc/html/rfc4039
7058 .RE
7059 .IP "44." 4
7060 RFC 4861
7061 .RS 4
7062 \%https://tools.ietf.org/html/rfc4861
7063 .RE