Debian Codegraph @

upstream/opensuse-tumbleweed/man5/systemd.network.5

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