Debian Codegraph @

upstream/mageia-cauldron/man5/systemd.network.5

raw
1 '\" t
2 .TH "SYSTEMD\&.NETWORK" "5" "" "systemd 258.7" "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 configurad 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 lexical 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 lexical 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\fI\fIaddress\fR\fR\fI[@\fR\fI\fIname\fR\fR\fI] [\fR\fI\fIweight\fR\fR\fI]\fR
2553 .RS 4
2554 Configures multipath route\&. Multipath routing is the technique of using multiple alternative paths through a network\&. Takes gateway address\&. Optionally, takes a network interface name or index separated with
2555 "@", and a weight in 1\&.\&.256 for this multipath route separated with whitespace\&. This setting can be specified multiple times\&. If an empty string is assigned, then the all previous assignments are cleared\&.
2556 .sp
2557 Added in version 245\&.
2558 .RE
2559 .PP
2560 \fINextHop=\fR
2561 .RS 4
2562 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\&.
2563 .sp
2564 Added in version 248\&.
2565 .RE
2566 .SH "[DHCPV4] SECTION OPTIONS"
2567 .PP
2568 The [DHCPv4] section configures the DHCPv4 client, if it is enabled with the
2569 \fIDHCP=\fR
2570 setting described above:
2571 .PP
2572 \fIRequestAddress=\fR
2573 .RS 4
2574 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\&.
2575 .sp
2576 Added in version 255\&.
2577 .RE
2578 .PP
2579 \fISendHostname=\fR
2580 .RS 4
2581 When true (the default), the machine\*(Aqs hostname (or the value specified with
2582 \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,
2583 \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,
2584 \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\&.
2585 .sp
2586 Added in version 215\&.
2587 .RE
2588 .PP
2589 \fIHostname=\fR
2590 .RS 4
2591 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
2592 \fISendHostname=\fR
2593 above for details\&.
2594 .sp
2595 Added in version 223\&.
2596 .RE
2597 .PP
2598 \fIMUDURL=\fR
2599 .RS 4
2600 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
2601 \m[blue]\fBRFC 8520\fR\m[]\&\s-2\u[27]\d\s+2\&.
2602 .sp
2603 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\&.
2604 .sp
2605 Added in version 246\&.
2606 .RE
2607 .PP
2608 \fIClientIdentifier=\fR
2609 .RS 4
2610 The DHCPv4 client identifier to use\&. Takes one of
2611 \fBmac\fR
2612 or
2613 \fBduid\fR\&. If set to
2614 \fBmac\fR, the MAC address of the link is used\&. If set to
2615 \fBduid\fR, an RFC4361\-compliant Client ID, which is the combination of IAID and DUID, is used\&. IAID can be configured by
2616 \fIIAID=\fR\&. DUID can be configured by
2617 \fIDUIDType=\fR
2618 and
2619 \fIDUIDRawData=\fR\&. When
2620 \fIAnonymize=\fR
2621 is enabled,
2622 \fBmac\fR
2623 is unconditionally used and the specified value will be ignored\&. When unspecified, the value specified in the same setting in
2624 \fBnetworkd.conf\fR(5)
2625 will be used\&.
2626 .sp
2627 Added in version 220\&.
2628 .RE
2629 .PP
2630 \fIVendorClassIdentifier=\fR
2631 .RS 4
2632 The vendor class identifier used to identify vendor type and configuration\&.
2633 .sp
2634 Added in version 216\&.
2635 .RE
2636 .PP
2637 \fIUserClass=\fR
2638 .RS 4
2639 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\&.
2640 .sp
2641 Added in version 239\&.
2642 .RE
2643 .PP
2644 \fIDUIDType=\fR
2645 .RS 4
2646 Override the global
2647 \fIDUIDType=\fR
2648 setting for this network\&. See
2649 \fBnetworkd.conf\fR(5)
2650 for a description of possible values\&.
2651 .sp
2652 Added in version 230\&.
2653 .RE
2654 .PP
2655 \fIDUIDRawData=\fR
2656 .RS 4
2657 Override the global
2658 \fIDUIDRawData=\fR
2659 setting for this network\&. See
2660 \fBnetworkd.conf\fR(5)
2661 for a description of possible values\&.
2662 .sp
2663 Added in version 230\&.
2664 .RE
2665 .PP
2666 \fIIAID=\fR
2667 .RS 4
2668 The DHCP Identity Association Identifier (IAID) for the interface, a 32\-bit unsigned integer\&.
2669 .sp
2670 Added in version 230\&.
2671 .RE
2672 .PP
2673 \fIRapidCommit=\fR
2674 .RS 4
2675 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
2676 \m[blue]\fBRFC 4039\fR\m[]\&\s-2\u[28]\d\s+2
2677 for details\&. Defaults to true when
2678 \fIAnonymize=no\fR
2679 and neither
2680 \fIAllowList=\fR
2681 nor
2682 \fIDenyList=\fR
2683 is specified, and false otherwise\&.
2684 .sp
2685 Added in version 255\&.
2686 .RE
2687 .PP
2688 \fIAnonymize=\fR
2689 .RS 4
2690 Takes a boolean\&. When true, the options sent to the DHCP server will follow the
2691 \m[blue]\fBRFC 7844\fR\m[]\&\s-2\u[29]\d\s+2
2692 (Anonymity Profiles for DHCP Clients) to minimize disclosure of identifying information\&. Defaults to false\&.
2693 .sp
2694 This option should only be set to true when
2695 \fIMACAddressPolicy=\fR
2696 is set to
2697 \fBrandom\fR
2698 (see
2699 \fBsystemd.link\fR(5))\&.
2700 .sp
2701 When true,
2702 \fIClientIdentifier=mac\fR,
2703 \fIRapidCommit=no\fR,
2704 \fISendHostname=no\fR,
2705 \fIUse6RD=no\fR,
2706 \fIUseCaptivePortal=no\fR,
2707 \fIUseMTU=no\fR,
2708 \fIUseNTP=no\fR,
2709 \fIUseSIP=no\fR, and
2710 \fIUseTimezone=no\fR
2711 are implied and these settings in the \&.network file are silently ignored\&. Also,
2712 \fIHostname=\fR,
2713 \fIMUDURL=\fR,
2714 \fIRequestAddress=\fR,
2715 \fIRequestOptions=\fR,
2716 \fISendOption=\fR,
2717 \fISendVendorOption=\fR,
2718 \fIUserClass=\fR, and
2719 \fIVendorClassIdentifier=\fR
2720 are silently ignored\&.
2721 .sp
2722 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\&.
2723 .sp
2724 Added in version 235\&.
2725 .RE
2726 .PP
2727 \fIRequestOptions=\fR
2728 .RS 4
2729 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\&.
2730 .sp
2731 Added in version 244\&.
2732 .RE
2733 .PP
2734 \fISendOption=\fR
2735 .RS 4
2736 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
2737 "uint8",
2738 "uint16",
2739 "uint32",
2740 "ipv4address", or
2741 "string"\&. Special characters in the data string may be escaped using
2742 \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\&.
2743 .sp
2744 Added in version 244\&.
2745 .RE
2746 .PP
2747 \fISendVendorOption=\fR
2748 .RS 4
2749 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
2750 "uint8",
2751 "uint16",
2752 "uint32",
2753 "ipv4address", or
2754 "string"\&. Special characters in the data string may be escaped using
2755 \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\&.
2756 .sp
2757 Added in version 246\&.
2758 .RE
2759 .PP
2760 \fIIPServiceType=\fR
2761 .RS 4
2762 Takes one of the special values
2763 "none",
2764 "CS6", or
2765 "CS4"\&. When
2766 "none"
2767 no IP service type is set to the packet sent from the DHCPv4 client\&. When
2768 "CS6"
2769 (network control) or
2770 "CS4"
2771 (realtime), the corresponding service type will be set\&. Defaults to
2772 "CS6"\&.
2773 .sp
2774 Added in version 244\&.
2775 .RE
2776 .PP
2777 \fISocketPriority=\fR
2778 .RS 4
2779 The Linux socket option
2780 \fBSO_PRIORITY\fR
2781 applied to the raw IP socket used for initial DHCPv4 messages\&. Unset by default\&. Usual values range from 0 to 6\&. More details about
2782 \fBSO_PRIORITY\fR
2783 socket option in
2784 \fBsocket\fR(7)\&. Can be used in conjunction with [VLAN] section
2785 \fIEgressQOSMaps=\fR
2786 setting of \&.netdev file to set the 802\&.1Q VLAN ethernet tagged header priority, see
2787 \fBsystemd.netdev\fR(5)\&.
2788 .sp
2789 Added in version 253\&.
2790 .RE
2791 .PP
2792 \fIBOOTP=\fR
2793 .RS 4
2794 Takes a boolean\&. When enabled, the DHCPv4 client will be configured to communicate with BOOTP servers, rather than with DHCP servers\&. Defaults to off\&.
2795 .sp
2796 Added in version 258\&.
2797 .RE
2798 .PP
2799 \fILabel=\fR
2800 .RS 4
2801 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\&.
2802 .sp
2803 Added in version 250\&.
2804 .RE
2805 .PP
2806 \fIUseDNS=\fR
2807 .RS 4
2808 When true (the default), the DNS servers received from the DHCP server will be used\&.
2809 .sp
2810 This corresponds to the
2811 \fBnameserver\fR
2812 option in
2813 \fBresolv.conf\fR(5)\&.
2814 .sp
2815 Added in version 211\&.
2816 .RE
2817 .PP
2818 \fIRoutesToDNS=\fR
2819 .RS 4
2820 When true, the routes to the DNS servers received from the DHCP server will be configured\&. When
2821 \fIUseDNS=\fR
2822 is disabled, this setting is ignored\&. Defaults to true\&.
2823 .sp
2824 Added in version 243\&.
2825 .RE
2826 .PP
2827 \fIUseNTP=\fR
2828 .RS 4
2829 When true (the default), the NTP servers received from the DHCP server will be used by
2830 systemd\-timesyncd\&.service\&.
2831 .sp
2832 Added in version 220\&.
2833 .RE
2834 .PP
2835 \fIRoutesToNTP=\fR
2836 .RS 4
2837 When true, the routes to the NTP servers received from the DHCP server will be configured\&. When
2838 \fIUseNTP=\fR
2839 is disabled, this setting is ignored\&. Defaults to true\&.
2840 .sp
2841 Added in version 249\&.
2842 .RE
2843 .PP
2844 \fIUseSIP=\fR
2845 .RS 4
2846 When true (the default), the SIP servers received from the DHCP server will be collected and made available to client programs\&.
2847 .sp
2848 Added in version 244\&.
2849 .RE
2850 .PP
2851 \fIUseCaptivePortal=\fR
2852 .RS 4
2853 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
2854 \fBnetworkctl\fR(1)
2855 status output per\-link\&.
2856 .sp
2857 Added in version 254\&.
2858 .RE
2859 .PP
2860 \fIUseDNR=\fR
2861 .RS 4
2862 When true, designated resolvers advertised by the DHCP server will be used as encrypted DNS servers\&. See
2863 \m[blue]\fBRFC 9463\fR\m[]\&\s-2\u[31]\d\s+2\&.
2864 .sp
2865 Defaults to unset, and the value for
2866 \fIUseDNS=\fR
2867 will be used\&.
2868 .sp
2869 Added in version 257\&.
2870 .RE
2871 .PP
2872 \fIUseMTU=\fR
2873 .RS 4
2874 When true, the interface maximum transmission unit from the DHCP server will be used on the current link\&. If
2875 \fIMTUBytes=\fR
2876 is set, then this setting is ignored\&. Defaults to false\&.
2877 .sp
2878 Note, some drivers will reset the interfaces if the MTU is changed\&. For such interfaces, please try to use
2879 \fIIgnoreCarrierLoss=\fR
2880 with a short timespan, e\&.g\&.
2881 "3 seconds"\&.
2882 .sp
2883 Added in version 211\&.
2884 .RE
2885 .PP
2886 \fIUseHostname=\fR
2887 .RS 4
2888 When true (the default), the hostname received from the DHCP server will be set as the transient hostname of the system\&.
2889 .sp
2890 Added in version 211\&.
2891 .RE
2892 .PP
2893 \fIUseDomains=\fR
2894 .RS 4
2895 Takes a boolean, or the special value
2896 \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
2897 \fBDomains=\fR
2898 setting\&. If set to
2899 \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
2900 \fBDomains=\fR
2901 setting when the argument is prefixed with
2902 "~"\&.
2903 .sp
2904 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
2905 \fBnetworkd.conf\fR(5)
2906 will be used\&. When it is unspecified, the value specified in the same setting in the [Network] section in
2907 \fBnetworkd.conf\fR(5)
2908 will be used\&. When none of them are specified, defaults to
2909 "no"\&.
2910 .sp
2911 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\&.
2912 .sp
2913 When set to true, this setting corresponds to the
2914 \fBdomain\fR
2915 option in
2916 \fBresolv.conf\fR(5)\&.
2917 .sp
2918 Added in version 216\&.
2919 .RE
2920 .PP
2921 \fIUseRoutes=\fR
2922 .RS 4
2923 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
2924 \fBglobal\fR,
2925 \fBlink\fR
2926 or
2927 \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
2928 \fBhost\fR\&. Otherwise, if the gateway is null (a direct route), a
2929 \fBlink\fR
2930 scope will be used\&. For anything else, scope defaults to
2931 \fBglobal\fR\&.
2932 .sp
2933 Added in version 215\&.
2934 .RE
2935 .PP
2936 \fIRouteMetric=\fR
2937 .RS 4
2938 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\&.
2939 .sp
2940 Added in version 217\&.
2941 .RE
2942 .PP
2943 \fIRouteTable=\fR\fI\fInum\fR\fR
2944 .RS 4
2945 The table identifier for DHCP routes\&. Takes one of predefined names
2946 "default",
2947 "main", and
2948 "local", and names defined in
2949 \fIRouteTable=\fR
2950 in
2951 \fBnetworkd.conf\fR(5), or a number between 1\&...4294967295\&.
2952 .sp
2953 When used in combination with
2954 \fIVRF=\fR, the VRF\*(Aqs routing table is used when this parameter is not specified\&.
2955 .sp
2956 Added in version 232\&.
2957 .RE
2958 .PP
2959 \fIRouteMTUBytes=\fR
2960 .RS 4
2961 Specifies the MTU for the DHCP routes\&. Please see the [Route] section for further details\&.
2962 .sp
2963 Added in version 245\&.
2964 .RE
2965 .PP
2966 \fIQuickAck=\fR
2967 .RS 4
2968 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\&.
2969 .sp
2970 Added in version 253\&.
2971 .RE
2972 .PP
2973 \fIInitialCongestionWindow=\fR
2974 .RS 4
2975 As in the [Route] section\&.
2976 .sp
2977 Added in version 255\&.
2978 .RE
2979 .PP
2980 \fIInitialAdvertisedReceiveWindow=\fR
2981 .RS 4
2982 As in the [Route] section\&.
2983 .sp
2984 Added in version 255\&.
2985 .RE
2986 .PP
2987 \fIUseGateway=\fR
2988 .RS 4
2989 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
2990 \fIUseRoutes=\fR
2991 will be used\&.
2992 .sp
2993 Note, when the server provides both the Router and Classless Static Routes option, and
2994 \fIUseRoutes=\fR
2995 is enabled, the Router option is always ignored regardless of this setting\&. See
2996 \m[blue]\fBRFC 3442\fR\m[]\&\s-2\u[32]\d\s+2\&.
2997 .sp
2998 Added in version 246\&.
2999 .RE
3000 .PP
3001 \fIUseTimezone=\fR
3002 .RS 4
3003 When true, the timezone received from the DHCP server will be set as timezone of the local system\&. Defaults to false\&.
3004 .sp
3005 Added in version 226\&.
3006 .RE
3007 .PP
3008 \fIUse6RD=\fR
3009 .RS 4
3010 When true, subnets of the received IPv6 prefix are assigned to downstream interfaces which enables
3011 \fIDHCPPrefixDelegation=\fR\&. See also
3012 \fIDHCPPrefixDelegation=\fR
3013 in the [Network] section, the [DHCPPrefixDelegation] section, and
3014 \m[blue]\fBRFC 5969\fR\m[]\&\s-2\u[33]\d\s+2\&. Defaults to false\&.
3015 .sp
3016 Added in version 250\&.
3017 .RE
3018 .PP
3019 \fIUnassignedSubnetPolicy=\fR
3020 .RS 4
3021 Takes
3022 "none", or one of the reject types:
3023 "unreachable",
3024 "prohibit",
3025 "blackhole", or
3026 "throw"\&. If a reject type is specified, the reject route corresponding to the acquired 6RD prefix will be configured\&. For example, when
3027 "unreachable",
3028 .sp
3029 .if n \{\
3030 .RS 4
3031 .\}
3032 .nf
3033 unreachable 2001:db8::/56 dev lo proto dhcp metric 1024 pref medium
3034 .fi
3035 .if n \{\
3036 .RE
3037 .\}
3038 .sp
3039 will be configured\&. See
3040 \m[blue]\fBRFC 7084\fR\m[]\&\s-2\u[34]\d\s+2\&. If
3041 "none"
3042 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
3043 "unreachable"\&.
3044 .sp
3045 Added in version 257\&.
3046 .RE
3047 .PP
3048 \fIIPv6OnlyMode=\fR
3049 .RS 4
3050 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
3051 \m[blue]\fBRFC 8925\fR\m[]\&\s-2\u[35]\d\s+2\&. Defaults to false\&.
3052 .sp
3053 Added in version 255\&.
3054 .RE
3055 .PP
3056 \fIFallbackLeaseLifetimeSec=\fR
3057 .RS 4
3058 Allows one to set DHCPv4 lease lifetime when DHCPv4 server does not send the lease lifetime\&. Takes one of
3059 "forever"
3060 or
3061 "infinity"\&. If specified, the acquired address never expires\&. Defaults to unset\&.
3062 .sp
3063 Added in version 246\&.
3064 .RE
3065 .PP
3066 \fIRequestBroadcast=\fR
3067 .RS 4
3068 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\&.
3069 .sp
3070 Added in version 216\&.
3071 .RE
3072 .PP
3073 \fIMaxAttempts=\fR
3074 .RS 4
3075 Specifies how many times the DHCPv4 client configuration should be attempted\&. Takes a number or
3076 "infinity"\&. Defaults to
3077 "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\&.
3078 .sp
3079 Added in version 243\&.
3080 .RE
3081 .PP
3082 \fIListenPort=\fR
3083 .RS 4
3084 Set the port from which the DHCP client packets originate\&.
3085 .sp
3086 Added in version 233\&.
3087 .RE
3088 .PP
3089 \fIServerPort=\fR
3090 .RS 4
3091 Set the port on which the DHCP server is listening\&.
3092 .sp
3093 Added in version 256\&.
3094 .RE
3095 .PP
3096 \fIDenyList=\fR
3097 .RS 4
3098 A whitespace\-separated list of IPv4 addresses\&. Each address can optionally take a prefix length after
3099 "/"\&. DHCP offers from servers in the list are rejected\&. Note that if
3100 \fIAllowList=\fR
3101 is configured then
3102 \fIDenyList=\fR
3103 is ignored\&.
3104 .sp
3105 Note that this filters only DHCP offers, so the filtering might not work when
3106 \fIRapidCommit=\fR
3107 is enabled\&. See also
3108 \fIRapidCommit=\fR
3109 above\&.
3110 .sp
3111 Added in version 246\&.
3112 .RE
3113 .PP
3114 \fIAllowList=\fR
3115 .RS 4
3116 A whitespace\-separated list of IPv4 addresses\&. Each address can optionally take a prefix length after
3117 "/"\&. DHCP offers from servers in the list are accepted\&.
3118 .sp
3119 Note that this filters only DHCP offers, so the filtering might not work when
3120 \fIRapidCommit=\fR
3121 is enabled\&. See also
3122 \fIRapidCommit=\fR
3123 above\&.
3124 .sp
3125 Added in version 246\&.
3126 .RE
3127 .PP
3128 \fISendRelease=\fR
3129 .RS 4
3130 When true, the DHCPv4 client sends a DHCP release packet when it stops\&. Defaults to true\&.
3131 .sp
3132 Added in version 243\&.
3133 .RE
3134 .PP
3135 \fISendDecline=\fR
3136 .RS 4
3137 A boolean\&. When true,
3138 \fBsystemd\-networkd\fR
3139 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
3140 \fBDHCPDECLINE\fR
3141 packet to the DHCP server, and tries to obtain an IP address again\&. See
3142 \m[blue]\fBRFC 5227\fR\m[]\&\s-2\u[8]\d\s+2\&. Defaults to false\&.
3143 .sp
3144 Added in version 245\&.
3145 .RE
3146 .PP
3147 \fINetLabel=\fR
3148 .RS 4
3149 This applies the NetLabel for the addresses received with DHCP, like
3150 \fINetLabel=\fR
3151 in [Address] section applies it to statically configured addresses\&. See
3152 \fINetLabel=\fR
3153 in [Address] section for more details\&.
3154 .sp
3155 Added in version 252\&.
3156 .RE
3157 .PP
3158 \fINFTSet=\fR
3159 .RS 4
3160 This applies the NFT set for the network configuration received with DHCP, like
3161 \fINFTSet=\fR
3162 in [Address] section applies it to static configuration\&. See
3163 \fINFTSet=\fR
3164 in [Address] section for more details\&. For
3165 "address"
3166 or
3167 "prefix"
3168 source types, the type of the element used in the NFT filter must be
3169 "ipv4_addr"\&.
3170 .sp
3171 Added in version 255\&.
3172 .RE
3173 .SH "[DHCPV6] SECTION OPTIONS"
3174 .PP
3175 The [DHCPv6] section configures the DHCPv6 client, if it is enabled with the
3176 \fIDHCP=\fR
3177 setting described above, or invoked by the IPv6 Router Advertisement:
3178 .PP
3179 \fIMUDURL=\fR, \fIIAID=\fR, \fIDUIDType=\fR, \fIDUIDRawData=\fR, \fIRequestOptions=\fR
3180 .RS 4
3181 As in the [DHCPv4] section\&.
3182 .sp
3183 Added in version 246\&.
3184 .RE
3185 .PP
3186 \fISendOption=\fR
3187 .RS 4
3188 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\&.
3189 .sp
3190 Added in version 246\&.
3191 .RE
3192 .PP
3193 \fISendVendorOption=\fR
3194 .RS 4
3195 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
3196 "uint8",
3197 "uint16",
3198 "uint32",
3199 "ipv4address",
3200 "ipv6address", or
3201 "string"\&. Special characters in the data string may be escaped using
3202 \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\&.
3203 .sp
3204 Added in version 246\&.
3205 .RE
3206 .PP
3207 \fIUserClass=\fR
3208 .RS 4
3209 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
3210 \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
3211 \fBNUL\fR
3212 bytes are not allowed\&.
3213 .sp
3214 Added in version 246\&.
3215 .RE
3216 .PP
3217 \fIVendorClass=\fR
3218 .RS 4
3219 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\&.
3220 .sp
3221 Added in version 246\&.
3222 .RE
3223 .PP
3224 \fIPrefixDelegationHint=\fR
3225 .RS 4
3226 Takes an IPv6 address with prefix length in the same format as the
3227 \fIAddress=\fR
3228 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\&.
3229 .sp
3230 Added in version 244\&.
3231 .RE
3232 .PP
3233 \fIUnassignedSubnetPolicy=\fR
3234 .RS 4
3235 Takes
3236 "none"
3237 or one of the reject types:
3238 "unreachable",
3239 "prohibit",
3240 "blackhole", or
3241 "throw"\&. If a reject type is specified, the reject route corresponding to the delegated prefix will be configured\&. For example, when
3242 "unreachable",
3243 .sp
3244 .if n \{\
3245 .RS 4
3246 .\}
3247 .nf
3248 unreachable 2001:db8::/56 dev lo proto dhcp metric 1024 pref medium
3249 .fi
3250 .if n \{\
3251 .RE
3252 .\}
3253 .sp
3254 will be configured\&. See
3255 \m[blue]\fBRFC 7084\fR\m[]\&\s-2\u[34]\d\s+2\&. If
3256 "none"
3257 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
3258 "unreachable"\&.
3259 .sp
3260 Added in version 257\&.
3261 .RE
3262 .PP
3263 \fIRapidCommit=\fR
3264 .RS 4
3265 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
3266 \m[blue]\fBRFC 3315\fR\m[]\&\s-2\u[36]\d\s+2
3267 for details\&. Defaults to true, and the two\-message exchange will be used if the server support it\&.
3268 .sp
3269 Added in version 252\&.
3270 .RE
3271 .PP
3272 \fISendHostname=\fR
3273 .RS 4
3274 When true (the default), the machine\*(Aqs hostname (or the value specified with
3275 \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\&.
3276 .sp
3277 Added in version 255\&.
3278 .RE
3279 .PP
3280 \fIHostname=\fR
3281 .RS 4
3282 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\&.
3283 .sp
3284 Added in version 255\&.
3285 .RE
3286 .PP
3287 \fIUseAddress=\fR
3288 .RS 4
3289 When true (the default), the IP addresses provided by the DHCPv6 server will be assigned\&.
3290 .sp
3291 Added in version 248\&.
3292 .RE
3293 .PP
3294 \fIUseCaptivePortal=\fR
3295 .RS 4
3296 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
3297 \fBnetworkctl\fR(1)
3298 status output per\-link\&.
3299 .sp
3300 Added in version 254\&.
3301 .RE
3302 .PP
3303 \fIUseDelegatedPrefix=\fR
3304 .RS 4
3305 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
3306 \fIDHCPPrefixDelegation=yes\fR\&. See also the
3307 \fIDHCPPrefixDelegation=\fR
3308 setting in the [Network] section, settings in the [DHCPPrefixDelegation] section, and
3309 \m[blue]\fBRFC 8415\fR\m[]\&\s-2\u[37]\d\s+2\&.
3310 .sp
3311 Added in version 250\&.
3312 .RE
3313 .PP
3314 \fIUseDNS=\fR, \fIUseDNR=\fR, \fIUseNTP=\fR, \fIUseSIP=\fR, \fIUseHostname=\fR, \fIUseDomains=\fR, \fINetLabel=\fR, \fISendRelease=\fR
3315 .RS 4
3316 As in the [DHCPv4] section\&.
3317 .sp
3318 Added in version 243\&.
3319 .RE
3320 .PP
3321 \fINFTSet=\fR
3322 .RS 4
3323 This applies the NFT set for the network configuration received with DHCP, like
3324 \fINFTSet=\fR
3325 in [Address] section applies it to static configuration\&. See
3326 \fINFTSet=\fR
3327 in [Address] section for more details\&. For
3328 "address"
3329 or
3330 "prefix"
3331 source types, the type of the element used in the NFT filter must be
3332 "ipv6_addr"\&.
3333 .sp
3334 Added in version 255\&.
3335 .RE
3336 .PP
3337 \fIWithoutRA=\fR
3338 .RS 4
3339 Allows DHCPv6 client to start without router advertisements\*(Aqs
3340 "managed"
3341 or
3342 "other configuration"
3343 flag\&. Takes one of
3344 "no",
3345 "solicit", or
3346 "information\-request"\&. If this is not specified,
3347 "solicit"
3348 is used when
3349 \fIDHCPPrefixDelegation=\fR
3350 is enabled and
3351 \fIUplinkInterface=:self\fR
3352 is specified in the [DHCPPrefixDelegation] section\&. Otherwise, defaults to
3353 "no", and the DHCPv6 client will be started when an RA is received\&. See also the
3354 \fIDHCPv6Client=\fR
3355 setting in the [IPv6AcceptRA] section\&.
3356 .sp
3357 Added in version 246\&.
3358 .RE
3359 .SH "[DHCPPREFIXDELEGATION] SECTION OPTIONS"
3360 .PP
3361 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
3362 \fIDHCPPrefixDelegation=\fR
3363 setting in the [Network] section is enabled\&.
3364 .PP
3365 \fIUplinkInterface=\fR
3366 .RS 4
3367 Specifies the name or the index of the uplink interface, or one of the special values
3368 ":self"
3369 and
3370 ":auto"\&. When
3371 ":self", the interface itself is considered the uplink interface, and
3372 \fIWithoutRA=solicit\fR
3373 is implied if the setting is not explicitly specified\&. When
3374 ":auto", the first link which acquired prefixes to be delegated from the DHCPv6 or DHCPv4 server is selected\&. Defaults to
3375 ":auto"\&.
3376 .sp
3377 Added in version 250\&.
3378 .RE
3379 .PP
3380 \fISubnetId=\fR
3381 .RS 4
3382 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
3383 \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\&.
3384 .sp
3385 Added in version 246\&.
3386 .RE
3387 .PP
3388 \fIAnnounce=\fR
3389 .RS 4
3390 Takes a boolean\&. When enabled, and
3391 \fIIPv6SendRA=\fR
3392 in [Network] section is enabled, the delegated prefixes are distributed through the IPv6 Router Advertisement\&. This setting will be ignored when the
3393 \fIDHCPPrefixDelegation=\fR
3394 setting is enabled on the upstream interface\&. Defaults to yes\&.
3395 .sp
3396 Added in version 247\&.
3397 .RE
3398 .PP
3399 \fIAssign=\fR
3400 .RS 4
3401 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
3402 \fIToken=\fR
3403 setting below\&. Defaults to yes\&.
3404 .sp
3405 Added in version 246\&.
3406 .RE
3407 .PP
3408 \fIToken=\fR
3409 .RS 4
3410 Specifies an optional address generation mode for assigning an address in each delegated prefix\&. This accepts the same syntax as
3411 \fIToken=\fR
3412 in the [IPv6AcceptRA] section\&. If
3413 \fIAssign=\fR
3414 is set to false, then this setting will be ignored\&. Defaults to unset, which means the EUI\-64 algorithm will be used\&.
3415 .sp
3416 Added in version 246\&.
3417 .RE
3418 .PP
3419 \fIManageTemporaryAddress=\fR
3420 .RS 4
3421 As in the [Address] section, but defaults to true\&.
3422 .sp
3423 Added in version 248\&.
3424 .RE
3425 .PP
3426 \fIRouteMetric=\fR
3427 .RS 4
3428 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\&.
3429 .sp
3430 Added in version 249\&.
3431 .RE
3432 .PP
3433 \fINetLabel=\fR
3434 .RS 4
3435 This applies the NetLabel for the addresses received with DHCP, like
3436 \fINetLabel=\fR
3437 in [Address] section applies it to statically configured addresses\&. See
3438 \fINetLabel=\fR
3439 in [Address] section for more details\&.
3440 .sp
3441 Added in version 252\&.
3442 .RE
3443 .PP
3444 \fINFTSet=\fR
3445 .RS 4
3446 This applies the NFT set for the network configuration received with DHCP, like
3447 \fINFTSet=\fR
3448 in [Address] section applies it to static configuration\&. See
3449 \fINFTSet=\fR
3450 in [Address] section for more details\&. For
3451 "address"
3452 or
3453 "prefix"
3454 source types, the type of the element used in the NFT filter must be
3455 "ipv6_addr"\&.
3456 .sp
3457 Added in version 255\&.
3458 .RE
3459 .SH "[IPV6ACCEPTRA] SECTION OPTIONS"
3460 .PP
3461 The [IPv6AcceptRA] section configures the IPv6 Router Advertisement (RA) client, if it is enabled with the
3462 \fIIPv6AcceptRA=\fR
3463 setting described above:
3464 .PP
3465 \fIUseRedirect=\fR
3466 .RS 4
3467 When true (the default), Redirect message sent by the current first\-hop router will be accepted, and routes to redirected nodes will be configured\&.
3468 .sp
3469 Added in version 256\&.
3470 .RE
3471 .PP
3472 \fIToken=\fR
3473 .RS 4
3474 Specifies an optional address generation mode for the Stateless Address Autoconfiguration (SLAAC)\&. The following values are supported:
3475 .PP
3476 \fBeui64\fR
3477 .RS 4
3478 The EUI\-64 algorithm will be used to generate an address for that prefix\&. Only supported by Ethernet or InfiniBand interfaces\&.
3479 .sp
3480 Added in version 250\&.
3481 .RE
3482 .PP
3483 \fBstatic:\fR\fB\fIADDRESS\fR\fR
3484 .RS 4
3485 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
3486 "static"
3487 mode is assumed\&.
3488 .sp
3489 Added in version 250\&.
3490 .RE
3491 .PP
3492 \fBprefixstable[:\fR\fB\fIADDRESS\fR\fR\fB][,\fR\fB\fIUUID\fR\fR\fB]\fR
3493 .RS 4
3494 The algorithm specified in
3495 \m[blue]\fBRFC 7217\fR\m[]\&\s-2\u[39]\d\s+2
3496 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\&.
3497 .sp
3498 This mode can also optionally take a non\-null UUID in the format which
3499 \fBsd_id128_from_string()\fR
3500 accepts, e\&.g\&.
3501 "86b123b969ba4b7eb8b3d8605123525a"
3502 or
3503 "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
3504 \fBsd-id128\fR(3),
3505 \fBsd_id128_from_string\fR(3), and
3506 \fBsd_id128_get_machine\fR(3)\&.
3507 .sp
3508 Note that the
3509 "prefixstable"
3510 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\&.
3511 .sp
3512 Added in version 250\&.
3513 .RE
3514 .sp
3515 If no address generation mode is specified (which is the default), or a received prefix does not match any of the addresses provided in
3516 "prefixstable"
3517 mode, then the EUI\-64 algorithm will be used for Ethernet or InfiniBand interfaces, otherwise
3518 "prefixstable"
3519 will be used to form an interface identifier for that prefix\&.
3520 .sp
3521 This setting can be specified multiple times\&. If an empty string is assigned, then the all previous assignments are cleared\&.
3522 .sp
3523 Examples:
3524 .sp
3525 .if n \{\
3526 .RS 4
3527 .\}
3528 .nf
3529 Token=eui64
3530 Token=::1a:2b:3c:4d
3531 Token=static:::1a:2b:3c:4d
3532 Token=prefixstable
3533 Token=prefixstable:2002:da8:1::
3534 .fi
3535 .if n \{\
3536 .RE
3537 .\}
3538 .sp
3539 Added in version 250\&.
3540 .RE
3541 .PP
3542 \fIUseDNS=\fR
3543 .RS 4
3544 When true (the default), the DNS servers received in the Router Advertisement will be used\&.
3545 .sp
3546 This corresponds to the
3547 \fBnameserver\fR
3548 option in
3549 \fBresolv.conf\fR(5)\&.
3550 .sp
3551 Added in version 231\&.
3552 .RE
3553 .PP
3554 \fIUseDNR=\fR
3555 .RS 4
3556 When true, the DNR servers received in the Router Advertisement will be used\&. Defaults to the value of
3557 \fBUseDNS=\fR\&.
3558 .sp
3559 Added in version 257\&.
3560 .RE
3561 .PP
3562 \fIUseDomains=\fR
3563 .RS 4
3564 Takes a boolean, or the special value
3565 "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
3566 \fBDomains=\fR
3567 setting\&. If set to
3568 "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
3569 \fBDomains=\fR
3570 setting when the argument is prefixed with
3571 "~"\&. Defaults to false\&.
3572 .sp
3573 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\&.
3574 .sp
3575 When set to true, this setting corresponds to the
3576 \fBdomain\fR
3577 option in
3578 \fBresolv.conf\fR(5)\&.
3579 .sp
3580 Added in version 231\&.
3581 .RE
3582 .PP
3583 \fIRouteTable=\fR\fI\fInum\fR\fR
3584 .RS 4
3585 The table identifier for the routes received in the Router Advertisement\&. Takes one of predefined names
3586 "default",
3587 "main", and
3588 "local", and names defined in
3589 \fIRouteTable=\fR
3590 in
3591 \fBnetworkd.conf\fR(5), or a number between 1\&...4294967295\&.
3592 .sp
3593 When used in combination with
3594 \fIVRF=\fR, the VRF\*(Aqs routing table is used when this parameter is not specified\&.
3595 .sp
3596 Added in version 232\&.
3597 .RE
3598 .PP
3599 \fIRouteMetric=\fR
3600 .RS 4
3601 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
3602 ":", 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
3603 "512:1024:2048"\&.
3604 .sp
3605 Added in version 249\&.
3606 .RE
3607 .PP
3608 \fIQuickAck=\fR
3609 .RS 4
3610 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\&.
3611 .sp
3612 Added in version 253\&.
3613 .RE
3614 .PP
3615 \fIUseMTU=\fR
3616 .RS 4
3617 Takes a boolean\&. When true, the MTU received in the Router Advertisement will be used\&. Defaults to true\&.
3618 .sp
3619 Added in version 250\&.
3620 .RE
3621 .PP
3622 \fIUseHopLimit=\fR
3623 .RS 4
3624 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
3625 \fIIPv6HopLimit=\fR\&. Defaults to true\&.
3626 .sp
3627 Added in version 255\&.
3628 .RE
3629 .PP
3630 \fIUseReachableTime=\fR
3631 .RS 4
3632 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\&.
3633 .sp
3634 Added in version 256\&.
3635 .RE
3636 .PP
3637 \fIUseRetransmissionTime=\fR
3638 .RS 4
3639 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\&.
3640 .sp
3641 Added in version 256\&.
3642 .RE
3643 .PP
3644 \fIUseGateway=\fR
3645 .RS 4
3646 When true (the default), the router address will be configured as the default gateway\&.
3647 .sp
3648 Added in version 250\&.
3649 .RE
3650 .PP
3651 \fIUseRoutePrefix=\fR
3652 .RS 4
3653 When true (the default), the routes corresponding to the route prefixes received in the Router Advertisement will be configured\&.
3654 .sp
3655 Added in version 250\&.
3656 .RE
3657 .PP
3658 \fIUseCaptivePortal=\fR
3659 .RS 4
3660 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
3661 \fBnetworkctl\fR(1)
3662 status output per\-link\&.
3663 .sp
3664 Added in version 254\&.
3665 .RE
3666 .PP
3667 \fIUsePREF64=\fR
3668 .RS 4
3669 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
3670 \fBnetworkctl\fR(1)
3671 status output per\-link\&. See
3672 \m[blue]\fBRFC 8781\fR\m[]\&\s-2\u[40]\d\s+2\&. Defaults to false\&.
3673 .sp
3674 Added in version 255\&.
3675 .RE
3676 .PP
3677 \fIUseAutonomousPrefix=\fR
3678 .RS 4
3679 When true (the default), the autonomous prefix received in the Router Advertisement will be used and take precedence over any statically configured ones\&.
3680 .sp
3681 Added in version 242\&.
3682 .RE
3683 .PP
3684 \fIUseOnLinkPrefix=\fR
3685 .RS 4
3686 When true (the default), the onlink prefix received in the Router Advertisement will be used and takes precedence over any statically configured ones\&.
3687 .sp
3688 Added in version 242\&.
3689 .RE
3690 .PP
3691 \fIRouterDenyList=\fR
3692 .RS 4
3693 A whitespace\-separated list of IPv6 router addresses\&. Each address can optionally take a prefix length after
3694 "/"\&. Any information advertised by the listed router is ignored\&.
3695 .sp
3696 Added in version 248\&.
3697 .RE
3698 .PP
3699 \fIRouterAllowList=\fR
3700 .RS 4
3701 A whitespace\-separated list of IPv6 router addresses\&. Each address can optionally take a prefix length after
3702 "/"\&. Only information advertised by the listed router is accepted\&. Note that if
3703 \fIRouterAllowList=\fR
3704 is configured then
3705 \fIRouterDenyList=\fR
3706 is ignored\&.
3707 .sp
3708 Added in version 248\&.
3709 .RE
3710 .PP
3711 \fIPrefixDenyList=\fR
3712 .RS 4
3713 A whitespace\-separated list of IPv6 prefixes\&. Each prefix can optionally take its prefix length after
3714 "/"\&. IPv6 prefixes supplied via router advertisements in the list are ignored\&.
3715 .sp
3716 Added in version 248\&.
3717 .RE
3718 .PP
3719 \fIPrefixAllowList=\fR
3720 .RS 4
3721 A whitespace\-separated list of IPv6 prefixes\&. Each prefix can optionally take its prefix length after
3722 "/"\&. IPv6 prefixes supplied via router advertisements in the list are allowed\&. Note that if
3723 \fIPrefixAllowList=\fR
3724 is configured then
3725 \fIPrefixDenyList=\fR
3726 is ignored\&.
3727 .sp
3728 Added in version 248\&.
3729 .RE
3730 .PP
3731 \fIRouteDenyList=\fR
3732 .RS 4
3733 A whitespace\-separated list of IPv6 route prefixes\&. Each prefix can optionally take its prefix length after
3734 "/"\&. IPv6 route prefixes supplied via router advertisements in the list are ignored\&.
3735 .sp
3736 Added in version 248\&.
3737 .RE
3738 .PP
3739 \fIRouteAllowList=\fR
3740 .RS 4
3741 A whitespace\-separated list of IPv6 route prefixes\&. Each prefix can optionally take its prefix length after
3742 "/"\&. IPv6 route prefixes supplied via router advertisements in the list are allowed\&. Note that if
3743 \fIRouteAllowList=\fR
3744 is configured then
3745 \fIRouteDenyList=\fR
3746 is ignored\&.
3747 .sp
3748 Added in version 248\&.
3749 .RE
3750 .PP
3751 \fIDHCPv6Client=\fR
3752 .RS 4
3753 Takes a boolean, or the special value
3754 "always"\&. When true, the DHCPv6 client will be started in
3755 "solicit"
3756 mode if the RA has the
3757 "managed"
3758 flag or
3759 "information\-request"
3760 mode if the RA lacks the
3761 "managed"
3762 flag but has the
3763 "other configuration"
3764 flag\&. If set to
3765 "always", the DHCPv6 client will be started in
3766 "solicit"
3767 mode when an RA is received, even if neither the
3768 "managed"
3769 nor the
3770 "other configuration"
3771 flag is set in the RA\&. This will be ignored when
3772 \fIWithoutRA=\fR
3773 in the [DHCPv6] section is enabled, or
3774 \fIUplinkInterface=:self\fR
3775 in the [DHCPPrefixDelegation] section is specified\&. Defaults to true\&.
3776 .sp
3777 Added in version 246\&.
3778 .RE
3779 .PP
3780 \fINetLabel=\fR
3781 .RS 4
3782 This applies the NetLabel for the addresses received with RA, like
3783 \fINetLabel=\fR
3784 in [Address] section applies it to statically configured addresses\&. See
3785 \fINetLabel=\fR
3786 in [Address] section for more details\&.
3787 .sp
3788 Added in version 252\&.
3789 .RE
3790 .PP
3791 \fINFTSet=\fR
3792 .RS 4
3793 This applies the NFT set for the network configuration received with RA, like
3794 \fINFTSet=\fR
3795 in [Address] section applies it to static configuration\&. See
3796 \fINFTSet=\fR
3797 in [Address] section for more details\&. For
3798 "address"
3799 or
3800 "prefix"
3801 source types, the type of the element used in the NFT filter must be
3802 "ipv6_addr"\&.
3803 .sp
3804 Added in version 255\&.
3805 .RE
3806 .SH "[DHCPSERVER] SECTION OPTIONS"
3807 .PP
3808 The [DHCPServer] section contains settings for the DHCP server, if enabled via the
3809 \fIDHCPServer=\fR
3810 option described above:
3811 .PP
3812 \fIServerAddress=\fR
3813 .RS 4
3814 Specifies the server address for the DHCP server\&. Takes an IPv4 address with prefix length separated with a slash, e\&.g\&.
3815 "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\&.
3816 .sp
3817 This implies
3818 \fIAddress=\fR
3819 in [Network] or [Address] section with the same address and prefix length\&. That is,
3820 .sp
3821 .if n \{\
3822 .RS 4
3823 .\}
3824 .nf
3825 [Network]
3826 DHCPServer=yes
3827 Address=192\&.168\&.0\&.1/24
3828 Address=192\&.168\&.0\&.2/24
3829 [DHCPServer]
3830 ServerAddress=192\&.168\&.0\&.1/24
3831 .fi
3832 .if n \{\
3833 .RE
3834 .\}
3835 .sp
3836 or
3837 .sp
3838 .if n \{\
3839 .RS 4
3840 .\}
3841 .nf
3842 [Network]
3843 DHCPServer=yes
3844 [Address]
3845 Address=192\&.168\&.0\&.1/24
3846 [Address]
3847 Address=192\&.168\&.0\&.2/24
3848 [DHCPServer]
3849 ServerAddress=192\&.168\&.0\&.1/24
3850 .fi
3851 .if n \{\
3852 .RE
3853 .\}
3854 .sp
3855 are equivalent to the following:
3856 .sp
3857 .if n \{\
3858 .RS 4
3859 .\}
3860 .nf
3861 [Network]
3862 DHCPServer=yes
3863 Address=192\&.168\&.0\&.2/24
3864 [DHCPServer]
3865 ServerAddress=192\&.168\&.0\&.1/24
3866 .fi
3867 .if n \{\
3868 .RE
3869 .\}
3870 .sp
3871 Since version 255, like the
3872 \fIAddress=\fR
3873 setting in [Network] or [Address] section, this also supports a null address, e\&.g\&.
3874 "0\&.0\&.0\&.0/24", and an unused address will be automatically selected\&. For more details about the automatic address selection, see
3875 \fIAddress=\fR
3876 setting in [Network] section in the above\&.
3877 .sp
3878 Added in version 249\&.
3879 .RE
3880 .PP
3881 \fIPoolOffset=\fR, \fIPoolSize=\fR
3882 .RS 4
3883 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\&.
3884 \fIPoolOffset=\fR
3885 takes the offset of the pool from the start of subnet, or zero to use the default value\&.
3886 \fIPoolSize=\fR
3887 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\&.
3888 .sp
3889 Added in version 226\&.
3890 .RE
3891 .PP
3892 \fIDefaultLeaseTimeSec=\fR, \fIMaxLeaseTimeSec=\fR
3893 .RS 4
3894 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\&.
3895 .sp
3896 Added in version 226\&.
3897 .RE
3898 .PP
3899 \fIUplinkInterface=\fR
3900 .RS 4
3901 Specifies the name or the index of the uplink interface, or one of the special values
3902 ":none"
3903 and
3904 ":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
3905 ":auto", the link which has a default gateway with the highest priority will be automatically selected\&. When
3906 ":none", no uplink interface will be selected\&. Defaults to
3907 ":auto"\&.
3908 .sp
3909 Added in version 249\&.
3910 .RE
3911 .PP
3912 \fIEmitDNS=\fR, \fIDNS=\fR
3913 .RS 4
3914 \fIEmitDNS=\fR
3915 takes a boolean\&. Configures whether the DHCP leases handed out to clients shall contain DNS server information\&. Defaults to
3916 "yes"\&. The DNS servers to pass to clients may be configured with the
3917 \fIDNS=\fR
3918 option, which takes a list of IPv4 addresses, or special value
3919 "_server_address"
3920 which will be converted to the address used by the DHCP server\&.
3921 .sp
3922 If the
3923 \fIEmitDNS=\fR
3924 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
3925 /etc/resolv\&.conf
3926 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
3927 \fIMaxLeaseTimeSec=\fR
3928 described above\&.
3929 .sp
3930 This setting can be specified multiple times\&. If an empty string is specified, then all DNS servers specified earlier are cleared\&.
3931 .sp
3932 Added in version 226\&.
3933 .RE
3934 .PP
3935 \fIEmitNTP=\fR, \fINTP=\fR, \fIEmitSIP=\fR, \fISIP=\fR, \fIEmitPOP3=\fR, \fIPOP3=\fR, \fIEmitSMTP=\fR, \fISMTP=\fR, \fIEmitLPR=\fR, \fILPR=\fR
3936 .RS 4
3937 Similar to the
3938 \fIEmitDNS=\fR
3939 and
3940 \fIDNS=\fR
3941 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
3942 \fIEmitDNS=\fR
3943 and
3944 \fIDNS=\fR\&.
3945 .sp
3946 Added in version 226\&.
3947 .RE
3948 .PP
3949 \fIEmitRouter=\fR, \fIRouter=\fR
3950 .RS 4
3951 The
3952 \fIEmitRouter=\fR
3953 setting takes a boolean value, and configures whether the DHCP lease should contain the router option\&. The
3954 \fIRouter=\fR
3955 setting takes an IPv4 address, and configures the router address to be emitted\&. When the
3956 \fIRouter=\fR
3957 setting is not specified, then the server address will be used for the router option\&. When the
3958 \fIEmitRouter=\fR
3959 setting is disabled, the
3960 \fIRouter=\fR
3961 setting will be ignored\&. The
3962 \fIEmitRouter=\fR
3963 setting defaults to true, and the
3964 \fIRouter=\fR
3965 setting defaults to unset\&.
3966 .sp
3967 Added in version 230\&.
3968 .RE
3969 .PP
3970 \fIEmitTimezone=\fR, \fITimezone=\fR
3971 .RS 4
3972 Takes a boolean\&. Configures whether the DHCP leases handed out to clients shall contain timezone information\&. Defaults to
3973 "yes"\&. The
3974 \fITimezone=\fR
3975 setting takes a timezone string (such as
3976 "Europe/Berlin"
3977 or
3978 "UTC") to pass to clients\&. If no explicit timezone is set, the system timezone of the local host is propagated, as determined by the
3979 /etc/localtime
3980 symlink\&.
3981 .sp
3982 Added in version 226\&.
3983 .RE
3984 .PP
3985 \fIBootServerAddress=\fR
3986 .RS 4
3987 Takes an IPv4 address of the boot server used by e\&.g\&. PXE boot systems\&. When specified, this address is sent in the
3988 \fBsiaddr\fR
3989 field of the DHCP message header\&. See
3990 \m[blue]\fBRFC 2131\fR\m[]\&\s-2\u[41]\d\s+2
3991 for more details\&. Defaults to unset\&.
3992 .sp
3993 Added in version 251\&.
3994 .RE
3995 .PP
3996 \fIBootServerName=\fR
3997 .RS 4
3998 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
3999 \m[blue]\fBRFC 2132\fR\m[]\&\s-2\u[42]\d\s+2
4000 for more details\&. Defaults to unset\&.
4001 .sp
4002 Note that typically setting one of
4003 \fIBootServerName=\fR
4004 or
4005 \fIBootServerAddress=\fR
4006 is sufficient, but both can be set too, if desired\&.
4007 .sp
4008 Added in version 251\&.
4009 .RE
4010 .PP
4011 \fIBootFilename=\fR
4012 .RS 4
4013 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
4014 \m[blue]\fBRFC 2132\fR\m[]\&\s-2\u[42]\d\s+2
4015 for more details\&. Defaults to unset\&.
4016 .sp
4017 Added in version 251\&.
4018 .RE
4019 .PP
4020 \fIIPv6OnlyPreferredSec=\fR
4021 .RS 4
4022 Takes a timespan\&. Controls the
4023 \m[blue]\fBRFC 8925\fR\m[]\&\s-2\u[35]\d\s+2
4024 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\&.
4025 .sp
4026 Added in version 255\&.
4027 .RE
4028 .PP
4029 \fISendOption=\fR
4030 .RS 4
4031 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
4032 "uint8",
4033 "uint16",
4034 "uint32",
4035 "ipv4address",
4036 "ipv6address", or
4037 "string"\&. Special characters in the data string may be escaped using
4038 \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\&.
4039 .sp
4040 Added in version 244\&.
4041 .RE
4042 .PP
4043 \fISendVendorOption=\fR
4044 .RS 4
4045 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
4046 "uint8",
4047 "uint16",
4048 "uint32",
4049 "ipv4address", or
4050 "string"\&. Special characters in the data string may be escaped using
4051 \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\&.
4052 .sp
4053 Added in version 246\&.
4054 .RE
4055 .PP
4056 \fIBindToInterface=\fR
4057 .RS 4
4058 Takes a boolean value\&. When
4059 "yes", DHCP server socket will be bound to its network interface and all socket communication will be restricted to this interface\&. Defaults to
4060 "yes", except if
4061 \fIRelayTarget=\fR
4062 is used (see below), in which case it defaults to
4063 "no"\&.
4064 .sp
4065 Added in version 249\&.
4066 .RE
4067 .PP
4068 \fIRelayTarget=\fR
4069 .RS 4
4070 Takes an IPv4 address, which must be in the format described in
4071 \fBinet_pton\fR(3)\&. Turns this DHCP server into a DHCP relay agent\&. See
4072 \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\&.
4073 .sp
4074 Added in version 249\&.
4075 .RE
4076 .PP
4077 \fIRelayAgentCircuitId=\fR
4078 .RS 4
4079 Specifies value for Agent Circuit ID suboption of Relay Agent Information option\&. Takes a string, which must be in the format
4080 "string:\fIvalue\fR", where
4081 "\fIvalue\fR"
4082 should be replaced with the value of the suboption\&. Defaults to unset (means no Agent Circuit ID suboption is generated)\&. Ignored if
4083 \fIRelayTarget=\fR
4084 is not specified\&.
4085 .sp
4086 Added in version 249\&.
4087 .RE
4088 .PP
4089 \fIRelayAgentRemoteId=\fR
4090 .RS 4
4091 Specifies value for Agent Remote ID suboption of Relay Agent Information option\&. Takes a string, which must be in the format
4092 "string:\fIvalue\fR", where
4093 "\fIvalue\fR"
4094 should be replaced with the value of the suboption\&. Defaults to unset (means no Agent Remote ID suboption is generated)\&. Ignored if
4095 \fIRelayTarget=\fR
4096 is not specified\&.
4097 .sp
4098 Added in version 249\&.
4099 .RE
4100 .PP
4101 \fIRapidCommit=\fR
4102 .RS 4
4103 Takes a boolean\&. When true, the server supports
4104 \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\&.
4105 .sp
4106 Added in version 255\&.
4107 .RE
4108 .PP
4109 \fIPersistLeases=\fR
4110 .RS 4
4111 Takes a boolean or special value
4112 "runtime"\&. When
4113 "yes", the DHCP server will load and save leases in the persistent storage\&. When
4114 "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
4115 \fBsystemctl clean systemd\-networkd\&.service\fR
4116 or the system is rebooted\&. When
4117 "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
4118 \fBnetworkctl reconfigure\fR, or
4119 \fBsystemd-networkd.service\fR(8)
4120 is restarted\&. Using
4121 "runtime"
4122 and
4123 "no"
4124 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
4125 \fBnetworkd.conf\fR(5), which defaults to
4126 "yes", will be used\&.
4127 .sp
4128 When
4129 \fIRelayTarget=\fR
4130 is specified, this setting will be ignored and no leases will be saved, as there will be no bound lease on the server\&.
4131 .sp
4132 Added in version 256\&.
4133 .RE
4134 .SH "[DHCPSERVERSTATICLEASE] SECTION OPTIONS"
4135 .PP
4136 The
4137 "[DHCPServerStaticLease]"
4138 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\&.
4139 .PP
4140 \fIMACAddress=\fR
4141 .RS 4
4142 The hardware address of a device to match\&. This key is mandatory\&.
4143 .sp
4144 Added in version 249\&.
4145 .RE
4146 .PP
4147 \fIAddress=\fR
4148 .RS 4
4149 The IPv4 address that should be assigned to the device that was matched with
4150 \fIMACAddress=\fR\&. This key is mandatory\&.
4151 .sp
4152 Added in version 249\&.
4153 .RE
4154 .SH "[IPV6SENDRA] SECTION OPTIONS"
4155 .PP
4156 The [IPv6SendRA] section contains settings for sending IPv6 Router Advertisements and whether to act as a router, if enabled via the
4157 \fIIPv6SendRA=\fR
4158 option described above\&. IPv6 network prefixes or routes are defined with one or more [IPv6Prefix] or [IPv6RoutePrefix] sections\&.
4159 .PP
4160 \fIManaged=\fR, \fIOtherInformation=\fR
4161 .RS 4
4162 Takes a boolean\&. Controls whether a DHCPv6 server is used to acquire IPv6 addresses on the network link when
4163 \fIManaged=\fR
4164 is set to
4165 "true"
4166 or if only additional network information can be obtained via DHCPv6 for the network link when
4167 \fIOtherInformation=\fR
4168 is set to
4169 "true"\&. Both settings default to
4170 "false", which means that a DHCPv6 server is not being used\&.
4171 .sp
4172 Added in version 235\&.
4173 .RE
4174 .PP
4175 \fIRouterLifetimeSec=\fR
4176 .RS 4
4177 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)\&.
4178 .sp
4179 Added in version 235\&.
4180 .RE
4181 .PP
4182 \fIReachableTimeSec=\fR
4183 .RS 4
4184 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\&.
4185 .sp
4186 Added in version 256\&.
4187 .RE
4188 .PP
4189 \fIRetransmitSec=\fR
4190 .RS 4
4191 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\&.
4192 .sp
4193 Added in version 255\&.
4194 .RE
4195 .PP
4196 \fIRouterPreference=\fR
4197 .RS 4
4198 Configures IPv6 router preference if
4199 \fIRouterLifetimeSec=\fR
4200 is non\-zero\&. Valid values are
4201 "high",
4202 "medium"
4203 and
4204 "low", with
4205 "normal"
4206 and
4207 "default"
4208 added as synonyms for
4209 "medium"
4210 just to make configuration easier\&. See
4211 \m[blue]\fBRFC 4191\fR\m[]\&\s-2\u[24]\d\s+2
4212 for details\&. Defaults to
4213 "medium"\&.
4214 .sp
4215 Added in version 235\&.
4216 .RE
4217 .PP
4218 \fIHopLimit=\fR
4219 .RS 4
4220 Configures hop limit\&. Takes an integer in the range 0\&...255\&. See also
4221 \fIIPv6HopLimit=\fR\&.
4222 .sp
4223 Added in version 255\&.
4224 .RE
4225 .PP
4226 \fIUplinkInterface=\fR
4227 .RS 4
4228 Specifies the name or the index of the uplink interface, or one of the special values
4229 ":none"
4230 and
4231 ":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
4232 ":auto", the value specified to the same setting in the [DHCPPrefixDelegation] section will be used if
4233 \fIDHCPPrefixDelegation=\fR
4234 is enabled, otherwise the link which has a default gateway with the highest priority will be automatically selected\&. When
4235 ":none", no uplink interface will be selected\&. Defaults to
4236 ":auto"\&.
4237 .sp
4238 Added in version 250\&.
4239 .RE
4240 .PP
4241 \fIEmitDNS=\fR, \fIDNS=\fR
4242 .RS 4
4243 \fIDNS=\fR
4244 specifies a list of recursive DNS server IPv6 addresses that are distributed via Router Advertisement messages when
4245 \fIEmitDNS=\fR
4246 is true\&.
4247 \fIDNS=\fR
4248 also takes special value
4249 "_link_local"; in that case the IPv6 link\-local address is distributed\&. If
4250 \fIDNS=\fR
4251 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
4252 \fIUplinkInterface=\fR
4253 will be used\&. When
4254 \fIEmitDNS=\fR
4255 is false, no DNS server information is sent in Router Advertisement messages\&.
4256 \fIEmitDNS=\fR
4257 defaults to true\&.
4258 .sp
4259 Added in version 235\&.
4260 .RE
4261 .PP
4262 \fIEmitDomains=\fR, \fIDomains=\fR
4263 .RS 4
4264 A list of DNS search domains distributed via Router Advertisement messages when
4265 \fIEmitDomains=\fR
4266 is true\&. If
4267 \fIDomains=\fR
4268 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
4269 \fIUplinkInterface=\fR
4270 will be used\&. When
4271 \fIEmitDomains=\fR
4272 is false, no DNS search domain information is sent in Router Advertisement messages\&.
4273 \fIEmitDomains=\fR
4274 defaults to true\&.
4275 .sp
4276 Added in version 235\&.
4277 .RE
4278 .PP
4279 \fIDNSLifetimeSec=\fR
4280 .RS 4
4281 Lifetime in seconds for the DNS server addresses listed in
4282 \fIDNS=\fR
4283 and search domains listed in
4284 \fIDomains=\fR\&. Defaults to 3600 seconds (one hour)\&.
4285 .sp
4286 Added in version 235\&.
4287 .RE
4288 .PP
4289 \fIHomeAgent=\fR
4290 .RS 4
4291 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
4292 \m[blue]\fBRFC 6275\fR\m[]\&\s-2\u[13]\d\s+2
4293 for further details\&.
4294 .sp
4295 Added in version 255\&.
4296 .RE
4297 .PP
4298 \fIHomeAgentLifetimeSec=\fR
4299 .RS 4
4300 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
4301 \fIRouterLifetimeSec=\fR\&.
4302 .sp
4303 Added in version 255\&.
4304 .RE
4305 .PP
4306 \fIHomeAgentPreference=\fR
4307 .RS 4
4308 Configures IPv6 Home Agent preference\&. Takes an integer in the range 0\&...65535\&. Defaults to 0\&.
4309 .sp
4310 Added in version 255\&.
4311 .RE
4312 .SH "[IPV6PREFIX] SECTION OPTIONS"
4313 .PP
4314 One or more [IPv6Prefix] sections contain the IPv6 prefixes that are announced via Router Advertisements\&. See
4315 \m[blue]\fBRFC 4861\fR\m[]\&\s-2\u[45]\d\s+2
4316 for further details\&.
4317 .PP
4318 \fIAddressAutoconfiguration=\fR, \fIOnLink=\fR
4319 .RS 4
4320 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
4321 "true"
4322 in order to ease configuration\&.
4323 .sp
4324 Added in version 235\&.
4325 .RE
4326 .PP
4327 \fIPrefix=\fR
4328 .RS 4
4329 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
4330 "/"
4331 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\&.
4332 .sp
4333 Added in version 235\&.
4334 .RE
4335 .PP
4336 \fIPreferredLifetimeSec=\fR, \fIValidLifetimeSec=\fR
4337 .RS 4
4338 Preferred and valid lifetimes for the prefix measured in seconds\&.
4339 \fIPreferredLifetimeSec=\fR
4340 defaults to 1800 seconds (30 minutes) and
4341 \fIValidLifetimeSec=\fR
4342 defaults to 3600 seconds (one hour)\&.
4343 .sp
4344 Added in version 235\&.
4345 .RE
4346 .PP
4347 \fIAssign=\fR
4348 .RS 4
4349 Takes a boolean\&. When true, adds an address from the prefix\&. Default to false\&.
4350 .sp
4351 Added in version 246\&.
4352 .RE
4353 .PP
4354 \fIToken=\fR
4355 .RS 4
4356 Specifies an optional address generation mode for assigning an address in each prefix\&. This accepts the same syntax as
4357 \fIToken=\fR
4358 in the [IPv6AcceptRA] section\&. If
4359 \fIAssign=\fR
4360 is set to false, then this setting will be ignored\&. Defaults to unset, which means the EUI\-64 algorithm will be used\&.
4361 .sp
4362 Added in version 250\&.
4363 .RE
4364 .PP
4365 \fIRouteMetric=\fR
4366 .RS 4
4367 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
4368 \fIAssign=\fR
4369 is false\&.
4370 .sp
4371 Added in version 249\&.
4372 .RE
4373 .SH "[IPV6ROUTEPREFIX] SECTION OPTIONS"
4374 .PP
4375 One or more [IPv6RoutePrefix] sections contain the IPv6 prefix routes that are announced via Router Advertisements\&. See
4376 \m[blue]\fBRFC 4191\fR\m[]\&\s-2\u[24]\d\s+2
4377 for further details\&.
4378 .PP
4379 \fIRoute=\fR
4380 .RS 4
4381 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
4382 "/"
4383 character\&. Use multiple [IPv6RoutePrefix] sections to configure multiple IPv6 prefix routes\&.
4384 .sp
4385 Added in version 244\&.
4386 .RE
4387 .PP
4388 \fILifetimeSec=\fR
4389 .RS 4
4390 Lifetime for the route prefix measured in seconds\&.
4391 \fILifetimeSec=\fR
4392 defaults to 3600 seconds (one hour)\&.
4393 .sp
4394 Added in version 244\&.
4395 .RE
4396 .PP
4397 \fIPreference=\fR
4398 .RS 4
4399 Specifies the preference of the route option\&. Takes one of
4400 "high",
4401 "medium", or
4402 "low"\&. Defaults to
4403 "medium"\&.
4404 .sp
4405 Added in version 258\&.
4406 .RE
4407 .SH "[IPV6PREF64PREFIX] SECTION OPTIONS"
4408 .PP
4409 One or more [IPv6PREF64Prefix] sections contain the IPv6 PREF64 (or NAT64) prefixes that are announced via Router Advertisements\&. See
4410 \m[blue]\fBRFC 8781\fR\m[]\&\s-2\u[40]\d\s+2
4411 for further details\&.
4412 .PP
4413 \fIPrefix=\fR
4414 .RS 4
4415 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
4416 "/"
4417 character\&. Valid NAT64 prefix length are 96, 64, 56, 48, 40, and 32 bits\&.
4418 .sp
4419 Added in version 255\&.
4420 .RE
4421 .PP
4422 \fILifetimeSec=\fR
4423 .RS 4
4424 Lifetime for the prefix measured in seconds\&. Should be greater than or equal to
4425 \fIRouterLifetimeSec=\fR\&.
4426 \fILifetimeSec=\fR
4427 defaults to 1800 seconds\&.
4428 .sp
4429 Added in version 255\&.
4430 .RE
4431 .SH "[BRIDGE] SECTION OPTIONS"
4432 .PP
4433 The [Bridge] section accepts the following keys:
4434 .PP
4435 \fIUnicastFlood=\fR
4436 .RS 4
4437 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\&.
4438 .sp
4439 Added in version 223\&.
4440 .RE
4441 .PP
4442 \fIMulticastFlood=\fR
4443 .RS 4
4444 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\&.
4445 .sp
4446 Added in version 242\&.
4447 .RE
4448 .PP
4449 \fIMulticastToUnicast=\fR
4450 .RS 4
4451 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\&.
4452 .sp
4453 Added in version 240\&.
4454 .RE
4455 .PP
4456 \fINeighborSuppression=\fR
4457 .RS 4
4458 Takes a boolean\&. Configures whether ARP and ND neighbor suppression is enabled for this port\&. When unset, the kernel\*(Aqs default will be used\&.
4459 .sp
4460 Added in version 242\&.
4461 .RE
4462 .PP
4463 \fILearning=\fR
4464 .RS 4
4465 Takes a boolean\&. Configures whether MAC address learning is enabled for this port\&. When unset, the kernel\*(Aqs default will be used\&.
4466 .sp
4467 Added in version 242\&.
4468 .RE
4469 .PP
4470 \fIHairPin=\fR
4471 .RS 4
4472 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\&.
4473 .sp
4474 Added in version 223\&.
4475 .RE
4476 .PP
4477 \fIIsolated=\fR
4478 .RS 4
4479 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\&.
4480 .sp
4481 Added in version 251\&.
4482 .RE
4483 .PP
4484 \fIUseBPDU=\fR
4485 .RS 4
4486 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\&.
4487 .sp
4488 Added in version 223\&.
4489 .RE
4490 .PP
4491 \fIFastLeave=\fR
4492 .RS 4
4493 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\&.
4494 .sp
4495 Added in version 223\&.
4496 .RE
4497 .PP
4498 \fIAllowPortToBeRoot=\fR
4499 .RS 4
4500 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\&.
4501 .sp
4502 Added in version 223\&.
4503 .RE
4504 .PP
4505 \fIProxyARP=\fR
4506 .RS 4
4507 Takes a boolean\&. Configures whether proxy ARP to be enabled on this port\&. When unset, the kernel\*(Aqs default will be used\&.
4508 .sp
4509 Added in version 243\&.
4510 .RE
4511 .PP
4512 \fIProxyARPWiFi=\fR
4513 .RS 4
4514 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\&.
4515 .sp
4516 Added in version 243\&.
4517 .RE
4518 .PP
4519 \fIMulticastRouter=\fR
4520 .RS 4
4521 Configures this port for having multicast routers attached\&. A port with a multicast router will receive all multicast traffic\&. Takes one of
4522 "no"
4523 to disable multicast routers on this port,
4524 "query"
4525 to let the system detect the presence of routers,
4526 "permanent"
4527 to permanently enable multicast traffic forwarding on this port, or
4528 "temporary"
4529 to enable multicast routers temporarily on this port, not depending on incoming queries\&. When unset, the kernel\*(Aqs default will be used\&.
4530 .sp
4531 Added in version 243\&.
4532 .RE
4533 .PP
4534 \fICost=\fR
4535 .RS 4
4536 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\&.
4537 .sp
4538 Added in version 218\&.
4539 .RE
4540 .PP
4541 \fIPriority=\fR
4542 .RS 4
4543 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\&.
4544 \fBsystemd\-networkd\fR
4545 does not set any default, meaning the kernel default value of 32 is used\&.
4546 .sp
4547 Added in version 234\&.
4548 .RE
4549 .PP
4550 \fILocked=\fR, \fIMACAuthenticationBypass=\fR
4551 .RS 4
4552 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\&.
4553 .sp
4554 Added in version 258\&.
4555 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\&.
4556 .sp
4557 Added in version 258\&.
4558 .RE
4559 .PP
4560 \fIVLANTunnel=\fR
4561 .RS 4
4562 Takes a boolean\&. Configures whether vlan tunnel mode is to be enabled on this port\&. When unset, the kernel\*(Aqs default will be used\&.
4563 .sp
4564 Added in version 258\&.
4565 .RE
4566 .SH "[BRIDGEFDB] SECTION OPTIONS"
4567 .PP
4568 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\&.
4569 .PP
4570 \fIMACAddress=\fR
4571 .RS 4
4572 As in the [Network] section\&. This key is mandatory\&.
4573 .sp
4574 Added in version 219\&.
4575 .RE
4576 .PP
4577 \fIDestination=\fR
4578 .RS 4
4579 Takes an IP address of the destination VXLAN tunnel endpoint\&.
4580 .sp
4581 Added in version 243\&.
4582 .RE
4583 .PP
4584 \fIVLANId=\fR
4585 .RS 4
4586 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\&.
4587 .sp
4588 Added in version 219\&.
4589 .RE
4590 .PP
4591 \fIVNI=\fR
4592 .RS 4
4593 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\&.
4594 .sp
4595 Added in version 243\&.
4596 .RE
4597 .PP
4598 \fIAssociatedWith=\fR
4599 .RS 4
4600 Specifies where the address is associated with\&. Takes one of
4601 "use",
4602 "self",
4603 "master"
4604 or
4605 "router"\&.
4606 "use"
4607 means the address is in use\&. User space can use this option to indicate to the kernel that the fdb entry is in use\&.
4608 "self"
4609 means the address is associated with the port drivers fdb\&. Usually hardware\&.
4610 "master"
4611 means the address is associated with master devices fdb\&.
4612 "router"
4613 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
4614 "self"\&.
4615 .sp
4616 Added in version 243\&.
4617 .RE
4618 .PP
4619 \fIOutgoingInterface=\fR
4620 .RS 4
4621 Specifies the name or index of the outgoing interface for the VXLAN device driver to reach the remote VXLAN tunnel endpoint\&. Defaults to unset\&.
4622 .sp
4623 Added in version 249\&.
4624 .RE
4625 .SH "[BRIDGEMDB] SECTION OPTIONS"
4626 .PP
4627 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\&.
4628 .PP
4629 \fIMulticastGroupAddress=\fR
4630 .RS 4
4631 Specifies the IPv4, IPv6, or L2 MAC multicast group address to add\&. This setting is mandatory\&.
4632 .sp
4633 Added in version 247\&.
4634 .RE
4635 .PP
4636 \fIVLANId=\fR
4637 .RS 4
4638 The VLAN ID for the new entry\&. Valid ranges are 0 (no VLAN) to 4094\&. Optional, defaults to 0\&.
4639 .sp
4640 Added in version 247\&.
4641 .RE
4642 .SH "[LLDP] SECTION OPTIONS"
4643 .PP
4644 The [LLDP] section manages the Link Layer Discovery Protocol (LLDP) and accepts the following keys:
4645 .PP
4646 \fIMUDURL=\fR
4647 .RS 4
4648 When configured, the specified Manufacturer Usage Descriptions (MUD) URL will be sent in LLDP packets\&. The syntax and semantics are the same as for
4649 \fIMUDURL=\fR
4650 in the [DHCPv4] section described above\&.
4651 .sp
4652 The MUD URLs received via LLDP packets are saved and can be read using the
4653 \fBsd_lldp_neighbor_get_mud_url()\fR
4654 function\&.
4655 .sp
4656 Added in version 246\&.
4657 .RE
4658 .SH "[CAN] SECTION OPTIONS"
4659 .PP
4660 The [CAN] section manages the Controller Area Network (CAN bus) and accepts the following keys:
4661 .PP
4662 \fIBitRate=\fR
4663 .RS 4
4664 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\&.
4665 .sp
4666 Added in version 239\&.
4667 .RE
4668 .PP
4669 \fISamplePoint=\fR
4670 .RS 4
4671 Optional sample point in percent with one decimal (e\&.g\&.
4672 "75%",
4673 "87\&.5%") or permille (e\&.g\&.
4674 "875โ€ฐ")\&. This will be ignored when
4675 \fIBitRate=\fR
4676 is unspecified\&.
4677 .sp
4678 Added in version 239\&.
4679 .RE
4680 .PP
4681 \fITimeQuantaNSec=\fR, \fIPropagationSegment=\fR, \fIPhaseBufferSegment1=\fR, \fIPhaseBufferSegment2=\fR, \fISyncJumpWidth=\fR
4682 .RS 4
4683 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\&.
4684 \fITimeQuantaNSec=\fR
4685 takes a timespan in nanoseconds\&.
4686 \fIPropagationSegment=\fR,
4687 \fIPhaseBufferSegment1=\fR,
4688 \fIPhaseBufferSegment2=\fR, and
4689 \fISyncJumpWidth=\fR
4690 take number of time quantum specified in
4691 \fITimeQuantaNSec=\fR
4692 and must be an unsigned integer in the range 0\&...4294967295\&. These settings except for
4693 \fISyncJumpWidth=\fR
4694 will be ignored when
4695 \fIBitRate=\fR
4696 is specified\&.
4697 .sp
4698 Added in version 250\&.
4699 .RE
4700 .PP
4701 \fIDataBitRate=\fR, \fIDataSamplePoint=\fR
4702 .RS 4
4703 The bitrate and sample point for the data phase, if CAN\-FD is used\&. These settings are analogous to the
4704 \fIBitRate=\fR
4705 and
4706 \fISamplePoint=\fR
4707 keys\&.
4708 .sp
4709 Added in version 246\&.
4710 .RE
4711 .PP
4712 \fIDataTimeQuantaNSec=\fR, \fIDataPropagationSegment=\fR, \fIDataPhaseBufferSegment1=\fR, \fIDataPhaseBufferSegment2=\fR, \fIDataSyncJumpWidth=\fR
4713 .RS 4
4714 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
4715 \fITimeQuantaNSec=\fR
4716 or related settings\&.
4717 .sp
4718 Added in version 250\&.
4719 .RE
4720 .PP
4721 \fIFDMode=\fR
4722 .RS 4
4723 Takes a boolean\&. When
4724 "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
4725 \fIDataBitRate=\fR
4726 and
4727 \fIDataSamplePoint=\fR
4728 keys, or
4729 \fIDataTimeQuanta=\fR
4730 and related settings\&.
4731 .sp
4732 Added in version 246\&.
4733 .RE
4734 .PP
4735 \fIFDNonISO=\fR
4736 .RS 4
4737 Takes a boolean\&. When
4738 "yes", non\-ISO CAN\-FD mode is enabled for the interface\&. When unset, the kernel\*(Aqs default will be used\&.
4739 .sp
4740 Added in version 246\&.
4741 .RE
4742 .PP
4743 \fIRestartSec=\fR
4744 .RS 4
4745 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\&.
4746 "0\&.1s") or a
4747 "ms"
4748 or
4749 "us"
4750 postfix\&. Using
4751 "infinity"
4752 or
4753 "0"
4754 will turn the automatic restart off\&. By default, automatic restart is disabled\&.
4755 .sp
4756 Added in version 239\&.
4757 .RE
4758 .PP
4759 \fITermination=\fR
4760 .RS 4
4761 Takes a boolean or a termination resistor value in ohm in the range 0\&...65535\&. When
4762 "yes", the termination resistor is set to 120 ohm\&. When
4763 "no"
4764 or
4765 "0"
4766 is set, the termination resistor is disabled\&. When unset, the kernel\*(Aqs default will be used\&.
4767 .sp
4768 Added in version 246\&.
4769 .RE
4770 .PP
4771 \fITripleSampling=\fR
4772 .RS 4
4773 Takes a boolean\&. When
4774 "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\&.
4775 .sp
4776 Added in version 242\&.
4777 .RE
4778 .PP
4779 \fIBusErrorReporting=\fR
4780 .RS 4
4781 Takes a boolean\&. When
4782 "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\&.
4783 .sp
4784 Added in version 248\&.
4785 .RE
4786 .PP
4787 \fIListenOnly=\fR
4788 .RS 4
4789 Takes a boolean\&. When
4790 "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\&.
4791 .sp
4792 Added in version 246\&.
4793 .RE
4794 .PP
4795 \fILoopback=\fR
4796 .RS 4
4797 Takes a boolean\&. When
4798 "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\&.
4799 .sp
4800 Added in version 250\&.
4801 .RE
4802 .PP
4803 \fIOneShot=\fR
4804 .RS 4
4805 Takes a boolean\&. When
4806 "yes", one\-shot mode is enabled\&. When unset, the kernel\*(Aqs default will be used\&.
4807 .sp
4808 Added in version 250\&.
4809 .RE
4810 .PP
4811 \fIPresumeACK=\fR
4812 .RS 4
4813 Takes a boolean\&. When
4814 "yes", the interface will ignore missing CAN ACKs\&. When unset, the kernel\*(Aqs default will be used\&.
4815 .sp
4816 Added in version 250\&.
4817 .RE
4818 .PP
4819 \fIClassicDataLengthCode=\fR
4820 .RS 4
4821 Takes a boolean\&. When
4822 "yes", the interface will handle the 4bit data length code (DLC)\&. When unset, the kernel\*(Aqs default will be used\&.
4823 .sp
4824 Added in version 250\&.
4825 .RE
4826 .SH "[IPOIB] SECTION OPTIONS"
4827 .PP
4828 The [IPoIB] section manages the IP over Infiniband and accepts the following keys:
4829 .PP
4830 \fIMode=\fR
4831 .RS 4
4832 Takes one of the special values
4833 "datagram"
4834 or
4835 "connected"\&. Defaults to unset, and the kernel\*(Aqs default is used\&.
4836 .sp
4837 When
4838 "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\&.
4839 .sp
4840 When
4841 "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\&.
4842 .sp
4843 Added in version 250\&.
4844 .RE
4845 .PP
4846 \fIIgnoreUserspaceMulticastGroups=\fR
4847 .RS 4
4848 Takes a boolean value\&. When true, the kernel ignores multicast groups handled by userspace\&. Defaults to unset, and the kernel\*(Aqs default is used\&.
4849 .sp
4850 Added in version 250\&.
4851 .RE
4852 .SH "[QDISC] SECTION OPTIONS"
4853 .PP
4854 The [QDisc] section manages the traffic control queueing discipline (qdisc)\&.
4855 .PP
4856 \fIParent=\fR
4857 .RS 4
4858 Specifies the parent Queueing Discipline (qdisc)\&. Takes one of
4859 "clsact"
4860 or
4861 "ingress"\&. This is mandatory\&.
4862 .sp
4863 Added in version 244\&.
4864 .RE
4865 .PP
4866 \fIHandle=\fR
4867 .RS 4
4868 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\&.
4869 .RE
4870 .SH "[NETWORKEMULATOR] SECTION OPTIONS"
4871 .PP
4872 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\&.
4873 .PP
4874 \fIParent=\fR
4875 .RS 4
4876 Configures the parent Queueing Discipline (qdisc)\&. Takes one of
4877 "root",
4878 "clsact",
4879 "ingress"
4880 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
4881 "root"\&.
4882 .RE
4883 .PP
4884 \fIHandle=\fR
4885 .RS 4
4886 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\&.
4887 .RE
4888 .PP
4889 \fIDelaySec=\fR
4890 .RS 4
4891 Specifies the fixed amount of delay to be added to all packets going out of the interface\&. Defaults to unset\&.
4892 .sp
4893 Added in version 245\&.
4894 .RE
4895 .PP
4896 \fIDelayJitterSec=\fR
4897 .RS 4
4898 Specifies the chosen delay to be added to the packets outgoing to the network interface\&. Defaults to unset\&.
4899 .sp
4900 Added in version 245\&.
4901 .RE
4902 .PP
4903 \fIPacketLimit=\fR
4904 .RS 4
4905 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\&.
4906 .sp
4907 Added in version 245\&.
4908 .RE
4909 .PP
4910 \fILossRate=\fR
4911 .RS 4
4912 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\&.
4913 .sp
4914 Added in version 245\&.
4915 .RE
4916 .PP
4917 \fIDuplicateRate=\fR
4918 .RS 4
4919 Specifies that the chosen percent of packets is duplicated before queuing them\&. Takes a percentage value, suffixed with "%"\&. Defaults to unset\&.
4920 .sp
4921 Added in version 245\&.
4922 .RE
4923 .SH "[TOKENBUCKETFILTER] SECTION OPTIONS"
4924 .PP
4925 The [TokenBucketFilter] section manages the queueing discipline (qdisc) of token bucket filter (tbf)\&.
4926 .PP
4927 \fIParent=\fR
4928 .RS 4
4929 Configures the parent Queueing Discipline (qdisc)\&. Takes one of
4930 "root",
4931 "clsact",
4932 "ingress"
4933 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
4934 "root"\&.
4935 .RE
4936 .PP
4937 \fIHandle=\fR
4938 .RS 4
4939 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\&.
4940 .RE
4941 .PP
4942 \fILatencySec=\fR
4943 .RS 4
4944 Specifies the latency parameter, which specifies the maximum amount of time a packet can sit in the Token Bucket Filter (TBF)\&. Defaults to unset\&.
4945 .sp
4946 Added in version 245\&.
4947 .RE
4948 .PP
4949 \fILimitBytes=\fR
4950 .RS 4
4951 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\&.
4952 .sp
4953 Added in version 246\&.
4954 .RE
4955 .PP
4956 \fIBurstBytes=\fR
4957 .RS 4
4958 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\&.
4959 .sp
4960 Added in version 246\&.
4961 .RE
4962 .PP
4963 \fIRate=\fR
4964 .RS 4
4965 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\&.
4966 .sp
4967 Added in version 245\&.
4968 .RE
4969 .PP
4970 \fIMPUBytes=\fR
4971 .RS 4
4972 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\&.
4973 .sp
4974 Added in version 245\&.
4975 .RE
4976 .PP
4977 \fIPeakRate=\fR
4978 .RS 4
4979 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\&.
4980 .sp
4981 Added in version 245\&.
4982 .RE
4983 .PP
4984 \fIMTUBytes=\fR
4985 .RS 4
4986 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\&.
4987 .sp
4988 Added in version 245\&.
4989 .RE
4990 .SH "[PIE] SECTION OPTIONS"
4991 .PP
4992 The [PIE] section manages the queueing discipline (qdisc) of Proportional Integral controller\-Enhanced (PIE)\&.
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 \fIPacketLimit=\fR
5010 .RS 4
5011 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\&.
5012 .sp
5013 Added in version 246\&.
5014 .RE
5015 .SH "[FLOWQUEUEPIE] SECTION OPTIONS"
5016 .PP
5017 The
5018 "[FlowQueuePIE]"
5019 section manages the queueing discipline (qdisc) of Flow Queue Proportional Integral controller\-Enhanced (fq_pie)\&.
5020 .PP
5021 \fIParent=\fR
5022 .RS 4
5023 Configures the parent Queueing Discipline (qdisc)\&. Takes one of
5024 "root",
5025 "clsact",
5026 "ingress"
5027 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
5028 "root"\&.
5029 .RE
5030 .PP
5031 \fIHandle=\fR
5032 .RS 4
5033 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\&.
5034 .RE
5035 .PP
5036 \fIPacketLimit=\fR
5037 .RS 4
5038 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\&.
5039 .sp
5040 Added in version 247\&.
5041 .RE
5042 .SH "[STOCHASTICFAIRBLUE] SECTION OPTIONS"
5043 .PP
5044 The [StochasticFairBlue] section manages the queueing discipline (qdisc) of stochastic fair blue (sfb)\&.
5045 .PP
5046 \fIParent=\fR
5047 .RS 4
5048 Configures the parent Queueing Discipline (qdisc)\&. Takes one of
5049 "root",
5050 "clsact",
5051 "ingress"
5052 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
5053 "root"\&.
5054 .RE
5055 .PP
5056 \fIHandle=\fR
5057 .RS 4
5058 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\&.
5059 .RE
5060 .PP
5061 \fIPacketLimit=\fR
5062 .RS 4
5063 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\&.
5064 .sp
5065 Added in version 246\&.
5066 .RE
5067 .SH "[STOCHASTICFAIRNESSQUEUEING] SECTION OPTIONS"
5068 .PP
5069 The [StochasticFairnessQueueing] section manages the queueing discipline (qdisc) of stochastic fairness queueing (sfq)\&.
5070 .PP
5071 \fIParent=\fR
5072 .RS 4
5073 Configures the parent Queueing Discipline (qdisc)\&. Takes one of
5074 "root",
5075 "clsact",
5076 "ingress"
5077 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
5078 "root"\&.
5079 .RE
5080 .PP
5081 \fIHandle=\fR
5082 .RS 4
5083 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\&.
5084 .RE
5085 .PP
5086 \fIPerturbPeriodSec=\fR
5087 .RS 4
5088 Specifies the interval in seconds for queue algorithm perturbation\&. Defaults to unset\&.
5089 .sp
5090 Added in version 245\&.
5091 .RE
5092 .SH "[BFIFO] SECTION OPTIONS"
5093 .PP
5094 The [BFIFO] section manages the queueing discipline (qdisc) of Byte limited Packet First In First Out (bfifo)\&.
5095 .PP
5096 \fIParent=\fR
5097 .RS 4
5098 Configures the parent Queueing Discipline (qdisc)\&. Takes one of
5099 "root",
5100 "clsact",
5101 "ingress"
5102 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
5103 "root"\&.
5104 .RE
5105 .PP
5106 \fIHandle=\fR
5107 .RS 4
5108 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\&.
5109 .RE
5110 .PP
5111 \fILimitBytes=\fR
5112 .RS 4
5113 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\&.
5114 .sp
5115 Added in version 246\&.
5116 .RE
5117 .SH "[PFIFO] SECTION OPTIONS"
5118 .PP
5119 The [PFIFO] section manages the queueing discipline (qdisc) of Packet First In First Out (pfifo)\&.
5120 .PP
5121 \fIParent=\fR
5122 .RS 4
5123 Configures the parent Queueing Discipline (qdisc)\&. Takes one of
5124 "root",
5125 "clsact",
5126 "ingress"
5127 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
5128 "root"\&.
5129 .RE
5130 .PP
5131 \fIHandle=\fR
5132 .RS 4
5133 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\&.
5134 .RE
5135 .PP
5136 \fIPacketLimit=\fR
5137 .RS 4
5138 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\&.
5139 .sp
5140 Added in version 246\&.
5141 .RE
5142 .SH "[PFIFOHEADDROP] SECTION OPTIONS"
5143 .PP
5144 The [PFIFOHeadDrop] section manages the queueing discipline (qdisc) of Packet First In First Out Head Drop (pfifo_head_drop)\&.
5145 .PP
5146 \fIParent=\fR
5147 .RS 4
5148 Configures the parent Queueing Discipline (qdisc)\&. Takes one of
5149 "root",
5150 "clsact",
5151 "ingress"
5152 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
5153 "root"\&.
5154 .RE
5155 .PP
5156 \fIHandle=\fR
5157 .RS 4
5158 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\&.
5159 .RE
5160 .PP
5161 \fIPacketLimit=\fR
5162 .RS 4
5163 As in [PFIFO] section\&.
5164 .sp
5165 Added in version 246\&.
5166 .RE
5167 .SH "[PFIFOFAST] SECTION OPTIONS"
5168 .PP
5169 The [PFIFOFast] section manages the queueing discipline (qdisc) of Packet First In First Out Fast (pfifo_fast)\&.
5170 .PP
5171 \fIParent=\fR
5172 .RS 4
5173 Configures the parent Queueing Discipline (qdisc)\&. Takes one of
5174 "root",
5175 "clsact",
5176 "ingress"
5177 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
5178 "root"\&.
5179 .RE
5180 .PP
5181 \fIHandle=\fR
5182 .RS 4
5183 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\&.
5184 .RE
5185 .SH "[CAKE] SECTION OPTIONS"
5186 .PP
5187 The [CAKE] section manages the queueing discipline (qdisc) of Common Applications Kept Enhanced (CAKE)\&.
5188 .PP
5189 \fIParent=\fR
5190 .RS 4
5191 Configures the parent Queueing Discipline (qdisc)\&. Takes one of
5192 "root",
5193 "clsact",
5194 "ingress"
5195 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
5196 "root"\&.
5197 .RE
5198 .PP
5199 \fIHandle=\fR
5200 .RS 4
5201 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\&.
5202 .RE
5203 .PP
5204 \fIBandwidth=\fR
5205 .RS 4
5206 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\&.
5207 .sp
5208 Added in version 246\&.
5209 .RE
5210 .PP
5211 \fIAutoRateIngress=\fR
5212 .RS 4
5213 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
5214 \fIBandwidth=\fR
5215 setting is used as an initial estimate\&. Defaults to unset, and the kernel\*(Aqs default is used\&.
5216 .sp
5217 Added in version 250\&.
5218 .RE
5219 .PP
5220 \fIOverheadBytes=\fR
5221 .RS 4
5222 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\&.
5223 .sp
5224 Added in version 246\&.
5225 .RE
5226 .PP
5227 \fIMPUBytes=\fR
5228 .RS 4
5229 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\&.
5230 .sp
5231 Added in version 250\&.
5232 .RE
5233 .PP
5234 \fICompensationMode=\fR
5235 .RS 4
5236 Takes one of
5237 "none",
5238 "atm", or
5239 "ptm"\&. Specifies the compensation mode for overhead calculation\&. When
5240 "none", no compensation is taken into account\&. When
5241 "atm", enables the compensation for ATM cell framing, which is normally found on ADSL links\&. When
5242 "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\&.
5243 .sp
5244 Added in version 250\&.
5245 .RE
5246 .PP
5247 \fIUseRawPacketSize=\fR
5248 .RS 4
5249 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\&.
5250 .sp
5251 Added in version 250\&.
5252 .RE
5253 .PP
5254 \fIFlowIsolationMode=\fR
5255 .RS 4
5256 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:
5257 .PP
5258 \fBnone\fR
5259 .RS 4
5260 The flow isolation is disabled, and all traffic passes through a single queue\&.
5261 .sp
5262 Added in version 250\&.
5263 .RE
5264 .PP
5265 \fBsrc\-host\fR
5266 .RS 4
5267 Flows are defined only by source address\&. Equivalent to the
5268 "srchost"
5269 option for
5270 \fBtc qdisc\fR
5271 command\&. See also
5272 \fBtc-cake\fR(8)\&.
5273 .sp
5274 Added in version 250\&.
5275 .RE
5276 .PP
5277 \fBdst\-host\fR
5278 .RS 4
5279 Flows are defined only by destination address\&. Equivalent to the
5280 "dsthost"
5281 option for
5282 \fBtc qdisc\fR
5283 command\&. See also
5284 \fBtc-cake\fR(8)\&.
5285 .sp
5286 Added in version 250\&.
5287 .RE
5288 .PP
5289 \fBhosts\fR
5290 .RS 4
5291 Flows are defined by source\-destination host pairs\&. Equivalent to the same option for
5292 \fBtc qdisc\fR
5293 command\&. See also
5294 \fBtc-cake\fR(8)\&.
5295 .sp
5296 Added in version 250\&.
5297 .RE
5298 .PP
5299 \fBflows\fR
5300 .RS 4
5301 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
5302 \fBtc qdisc\fR
5303 command\&. See also
5304 \fBtc-cake\fR(8)\&.
5305 .sp
5306 Added in version 250\&.
5307 .RE
5308 .PP
5309 \fBdual\-src\-host\fR
5310 .RS 4
5311 Flows are defined by the 5\-tuple (see
5312 "flows"
5313 in the above), and fairness is applied first over source addresses, then over individual flows\&. Equivalent to the
5314 "dual\-srchost"
5315 option for
5316 \fBtc qdisc\fR
5317 command\&. See also
5318 \fBtc-cake\fR(8)\&.
5319 .sp
5320 Added in version 250\&.
5321 .RE
5322 .PP
5323 \fBdual\-dst\-host\fR
5324 .RS 4
5325 Flows are defined by the 5\-tuple (see
5326 "flows"
5327 in the above), and fairness is applied first over destination addresses, then over individual flows\&. Equivalent to the
5328 "dual\-dsthost"
5329 option for
5330 \fBtc qdisc\fR
5331 command\&. See also
5332 \fBtc-cake\fR(8)\&.
5333 .sp
5334 Added in version 250\&.
5335 .RE
5336 .PP
5337 \fBtriple\fR
5338 .RS 4
5339 Flows are defined by the 5\-tuple (see
5340 "flows"), and fairness is applied over source and destination addresses, and also over individual flows\&. Equivalent to the
5341 "triple\-isolate"
5342 option for
5343 \fBtc qdisc\fR
5344 command\&. See also
5345 \fBtc-cake\fR(8)\&.
5346 .sp
5347 Added in version 250\&.
5348 .RE
5349 .sp
5350 Defaults to unset and the kernel\*(Aqs default is used\&.
5351 .sp
5352 Added in version 250\&.
5353 .RE
5354 .PP
5355 \fINAT=\fR
5356 .RS 4
5357 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
5358 \fIFlowIsolationMode=\fR
5359 is
5360 "none"
5361 or
5362 "flows", or if NAT is performed on a different host\&. Defaults to unset, and the kernel\*(Aqs default is used\&.
5363 .sp
5364 Added in version 250\&.
5365 .RE
5366 .PP
5367 \fIPriorityQueueingPreset=\fR
5368 .RS 4
5369 CAKE divides traffic into
5370 "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:
5371 .PP
5372 \fBbesteffort\fR
5373 .RS 4
5374 Disables priority queueing by placing all traffic in one tin\&.
5375 .sp
5376 Added in version 250\&.
5377 .RE
5378 .PP
5379 \fBprecedence\fR
5380 .RS 4
5381 Enables priority queueing based on the legacy interpretation of TOS
5382 "Precedence"
5383 field\&. Use of this preset on the modern Internet is firmly discouraged\&.
5384 .sp
5385 Added in version 250\&.
5386 .RE
5387 .PP
5388 \fBdiffserv8\fR
5389 .RS 4
5390 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\&.
5391 .sp
5392 Added in version 250\&.
5393 .RE
5394 .PP
5395 \fBdiffserv4\fR
5396 .RS 4
5397 Enables priority queueing based on the Differentiated Service ("DiffServ") field with four tins: Background Traffic, Best Effort, Streaming Media, and Latency Sensitive\&.
5398 .sp
5399 Added in version 250\&.
5400 .RE
5401 .PP
5402 \fBdiffserv3\fR
5403 .RS 4
5404 Enables priority queueing based on the Differentiated Service ("DiffServ") field with three tins: Background Traffic, Best Effort, and Latency Sensitive\&.
5405 .sp
5406 Added in version 250\&.
5407 .RE
5408 .sp
5409 Defaults to unset, and the kernel\*(Aqs default is used\&.
5410 .sp
5411 Added in version 250\&.
5412 .RE
5413 .PP
5414 \fIFirewallMark=\fR
5415 .RS 4
5416 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\&.
5417 .sp
5418 Added in version 250\&.
5419 .RE
5420 .PP
5421 \fIWash=\fR
5422 .RS 4
5423 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\&.
5424 .sp
5425 Added in version 250\&.
5426 .RE
5427 .PP
5428 \fISplitGSO=\fR
5429 .RS 4
5430 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\&.
5431 .sp
5432 Added in version 250\&.
5433 .RE
5434 .PP
5435 \fIRTTSec=\fR
5436 .RS 4
5437 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\&.
5438 .sp
5439 Added in version 253\&.
5440 .RE
5441 .PP
5442 \fIAckFilter=\fR
5443 .RS 4
5444 Takes a boolean value, or special value
5445 "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
5446 "aggressive"
5447 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\&.
5448 .sp
5449 Added in version 253\&.
5450 .RE
5451 .SH "[CONTROLLEDDELAY] SECTION OPTIONS"
5452 .PP
5453 The [ControlledDelay] section manages the queueing discipline (qdisc) of controlled delay (CoDel)\&.
5454 .PP
5455 \fIParent=\fR
5456 .RS 4
5457 Configures the parent Queueing Discipline (qdisc)\&. Takes one of
5458 "root",
5459 "clsact",
5460 "ingress"
5461 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
5462 "root"\&.
5463 .RE
5464 .PP
5465 \fIHandle=\fR
5466 .RS 4
5467 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\&.
5468 .RE
5469 .PP
5470 \fIPacketLimit=\fR
5471 .RS 4
5472 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\&.
5473 .sp
5474 Added in version 245\&.
5475 .RE
5476 .PP
5477 \fITargetSec=\fR
5478 .RS 4
5479 Takes a timespan\&. Specifies the acceptable minimum standing/persistent queue delay\&. Defaults to unset and kernel\*(Aqs default is used\&.
5480 .sp
5481 Added in version 245\&.
5482 .RE
5483 .PP
5484 \fIIntervalSec=\fR
5485 .RS 4
5486 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\&.
5487 .sp
5488 Added in version 245\&.
5489 .RE
5490 .PP
5491 \fIECN=\fR
5492 .RS 4
5493 Takes a boolean\&. This can be used to mark packets instead of dropping them\&. Defaults to unset and kernel\*(Aqs default is used\&.
5494 .sp
5495 Added in version 245\&.
5496 .RE
5497 .PP
5498 \fICEThresholdSec=\fR
5499 .RS 4
5500 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\&.
5501 .sp
5502 Added in version 245\&.
5503 .RE
5504 .SH "[DEFICITROUNDROBINSCHEDULER] SECTION OPTIONS"
5505 .PP
5506 The [DeficitRoundRobinScheduler] section manages the queueing discipline (qdisc) of Deficit Round Robin Scheduler (DRR)\&.
5507 .PP
5508 \fIParent=\fR
5509 .RS 4
5510 Configures the parent Queueing Discipline (qdisc)\&. Takes one of
5511 "root",
5512 "clsact",
5513 "ingress"
5514 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
5515 "root"\&.
5516 .RE
5517 .PP
5518 \fIHandle=\fR
5519 .RS 4
5520 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\&.
5521 .RE
5522 .SH "[DEFICITROUNDROBINSCHEDULERCLASS] SECTION OPTIONS"
5523 .PP
5524 The [DeficitRoundRobinSchedulerClass] section manages the traffic control class of Deficit Round Robin Scheduler (DRR)\&.
5525 .PP
5526 \fIParent=\fR
5527 .RS 4
5528 Configures the parent Queueing Discipline (qdisc)\&. Takes one of
5529 "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
5530 "root"\&.
5531 .RE
5532 .PP
5533 \fIClassId=\fR
5534 .RS 4
5535 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\&.
5536 .RE
5537 .PP
5538 \fIQuantumBytes=\fR
5539 .RS 4
5540 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\&.
5541 .sp
5542 Added in version 246\&.
5543 .RE
5544 .SH "[ENHANCEDTRANSMISSIONSELECTION] SECTION OPTIONS"
5545 .PP
5546 The [EnhancedTransmissionSelection] section manages the queueing discipline (qdisc) of Enhanced Transmission Selection (ETS)\&.
5547 .PP
5548 \fIParent=\fR
5549 .RS 4
5550 Configures the parent Queueing Discipline (qdisc)\&. Takes one of
5551 "root",
5552 "clsact",
5553 "ingress"
5554 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
5555 "root"\&.
5556 .RE
5557 .PP
5558 \fIHandle=\fR
5559 .RS 4
5560 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\&.
5561 .RE
5562 .PP
5563 \fIBands=\fR
5564 .RS 4
5565 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
5566 \fIStrictBands=\fR
5567 and bandwidth\-sharing bands specified in
5568 \fIQuantumBytes=\fR\&.
5569 .sp
5570 Added in version 246\&.
5571 .RE
5572 .PP
5573 \fIStrictBands=\fR
5574 .RS 4
5575 Specifies the number of bands that should be created in strict mode\&. An unsigned integer in the range 1\&...16\&.
5576 .sp
5577 Added in version 246\&.
5578 .RE
5579 .PP
5580 \fIQuantumBytes=\fR
5581 .RS 4
5582 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\&.
5583 .sp
5584 Added in version 246\&.
5585 .RE
5586 .PP
5587 \fIPriorityMap=\fR
5588 .RS 4
5589 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\&.
5590 .sp
5591 Added in version 246\&.
5592 .RE
5593 .SH "[GENERICRANDOMEARLYDETECTION] SECTION OPTIONS"
5594 .PP
5595 The [GenericRandomEarlyDetection] section manages the queueing discipline (qdisc) of Generic Random Early Detection (GRED)\&.
5596 .PP
5597 \fIParent=\fR
5598 .RS 4
5599 Configures the parent Queueing Discipline (qdisc)\&. Takes one of
5600 "root",
5601 "clsact",
5602 "ingress"
5603 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
5604 "root"\&.
5605 .RE
5606 .PP
5607 \fIHandle=\fR
5608 .RS 4
5609 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\&.
5610 .RE
5611 .PP
5612 \fIVirtualQueues=\fR
5613 .RS 4
5614 Specifies the number of virtual queues\&. Takes an integer in the range 1\&...16\&. Defaults to unset and kernel\*(Aqs default is used\&.
5615 .sp
5616 Added in version 246\&.
5617 .RE
5618 .PP
5619 \fIDefaultVirtualQueue=\fR
5620 .RS 4
5621 Specifies the number of default virtual queue\&. This must be less than
5622 \fIVirtualQueue=\fR\&. Defaults to unset and kernel\*(Aqs default is used\&.
5623 .sp
5624 Added in version 246\&.
5625 .RE
5626 .PP
5627 \fIGenericRIO=\fR
5628 .RS 4
5629 Takes a boolean\&. It turns on the RIO\-like buffering scheme\&. Defaults to unset and kernel\*(Aqs default is used\&.
5630 .sp
5631 Added in version 246\&.
5632 .RE
5633 .SH "[FAIRQUEUEINGCONTROLLEDDELAY] SECTION OPTIONS"
5634 .PP
5635 The [FairQueueingControlledDelay] section manages the queueing discipline (qdisc) of fair queuing controlled delay (FQ\-CoDel)\&.
5636 .PP
5637 \fIParent=\fR
5638 .RS 4
5639 Configures the parent Queueing Discipline (qdisc)\&. Takes one of
5640 "root",
5641 "clsact",
5642 "ingress"
5643 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
5644 "root"\&.
5645 .RE
5646 .PP
5647 \fIHandle=\fR
5648 .RS 4
5649 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\&.
5650 .RE
5651 .PP
5652 \fIPacketLimit=\fR
5653 .RS 4
5654 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\&.
5655 .sp
5656 Added in version 245\&.
5657 .RE
5658 .PP
5659 \fIMemoryLimitBytes=\fR
5660 .RS 4
5661 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\&.
5662 .sp
5663 Added in version 246\&.
5664 .RE
5665 .PP
5666 \fIFlows=\fR
5667 .RS 4
5668 Specifies the number of flows into which the incoming packets are classified\&. Defaults to unset and kernel\*(Aqs default is used\&.
5669 .sp
5670 Added in version 245\&.
5671 .RE
5672 .PP
5673 \fITargetSec=\fR
5674 .RS 4
5675 Takes a timespan\&. Specifies the acceptable minimum standing/persistent queue delay\&. Defaults to unset and kernel\*(Aqs default is used\&.
5676 .sp
5677 Added in version 245\&.
5678 .RE
5679 .PP
5680 \fIIntervalSec=\fR
5681 .RS 4
5682 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\&.
5683 .sp
5684 Added in version 245\&.
5685 .RE
5686 .PP
5687 \fIQuantumBytes=\fR
5688 .RS 4
5689 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\&.
5690 .sp
5691 Added in version 246\&.
5692 .RE
5693 .PP
5694 \fIECN=\fR
5695 .RS 4
5696 Takes a boolean\&. This can be used to mark packets instead of dropping them\&. Defaults to unset and kernel\*(Aqs default is used\&.
5697 .sp
5698 Added in version 245\&.
5699 .RE
5700 .PP
5701 \fICEThresholdSec=\fR
5702 .RS 4
5703 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\&.
5704 .sp
5705 Added in version 245\&.
5706 .RE
5707 .SH "[FAIRQUEUEING] SECTION OPTIONS"
5708 .PP
5709 The [FairQueueing] section manages the queueing discipline (qdisc) of fair queue traffic policing (FQ)\&.
5710 .PP
5711 \fIParent=\fR
5712 .RS 4
5713 Configures the parent Queueing Discipline (qdisc)\&. Takes one of
5714 "root",
5715 "clsact",
5716 "ingress"
5717 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
5718 "root"\&.
5719 .RE
5720 .PP
5721 \fIHandle=\fR
5722 .RS 4
5723 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\&.
5724 .RE
5725 .PP
5726 \fIPacketLimit=\fR
5727 .RS 4
5728 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\&.
5729 .sp
5730 Added in version 245\&.
5731 .RE
5732 .PP
5733 \fIFlowLimit=\fR
5734 .RS 4
5735 Specifies the hard limit on the maximum number of packets queued per flow\&. Defaults to unset and kernel\*(Aqs default is used\&.
5736 .sp
5737 Added in version 245\&.
5738 .RE
5739 .PP
5740 \fIQuantumBytes=\fR
5741 .RS 4
5742 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\&.
5743 .sp
5744 Added in version 246\&.
5745 .RE
5746 .PP
5747 \fIInitialQuantumBytes=\fR
5748 .RS 4
5749 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\&.
5750 .sp
5751 Added in version 245\&.
5752 .RE
5753 .PP
5754 \fIMaximumRate=\fR
5755 .RS 4
5756 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\&.
5757 .sp
5758 Added in version 245\&.
5759 .RE
5760 .PP
5761 \fIBuckets=\fR
5762 .RS 4
5763 Specifies the size of the hash table used for flow lookups\&. Defaults to unset and kernel\*(Aqs default is used\&.
5764 .sp
5765 Added in version 245\&.
5766 .RE
5767 .PP
5768 \fIOrphanMask=\fR
5769 .RS 4
5770 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\&.
5771 .sp
5772 Added in version 245\&.
5773 .RE
5774 .PP
5775 \fIPacing=\fR
5776 .RS 4
5777 Takes a boolean, and enables or disables flow pacing\&. Defaults to unset and kernel\*(Aqs default is used\&.
5778 .sp
5779 Added in version 245\&.
5780 .RE
5781 .PP
5782 \fICEThresholdSec=\fR
5783 .RS 4
5784 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\&.
5785 .sp
5786 Added in version 245\&.
5787 .RE
5788 .SH "[TRIVIALLINKEQUALIZER] SECTION OPTIONS"
5789 .PP
5790 The [TrivialLinkEqualizer] section manages the queueing discipline (qdisc) of trivial link equalizer (teql)\&.
5791 .PP
5792 \fIParent=\fR
5793 .RS 4
5794 Configures the parent Queueing Discipline (qdisc)\&. Takes one of
5795 "root",
5796 "clsact",
5797 "ingress"
5798 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
5799 "root"\&.
5800 .RE
5801 .PP
5802 \fIHandle=\fR
5803 .RS 4
5804 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\&.
5805 .RE
5806 .PP
5807 \fIId=\fR
5808 .RS 4
5809 Specifies the interface ID
5810 "N"
5811 of teql\&. Defaults to
5812 "0"\&. Note that when teql is used, currently, the module
5813 \fBsch_teql\fR
5814 with
5815 \fBmax_equalizers=N+1\fR
5816 option must be loaded before
5817 \fBsystemd\-networkd\fR
5818 is started\&.
5819 .sp
5820 Added in version 245\&.
5821 .RE
5822 .SH "[HIERARCHYTOKENBUCKET] SECTION OPTIONS"
5823 .PP
5824 The [HierarchyTokenBucket] section manages the queueing discipline (qdisc) of hierarchy token bucket (htb)\&.
5825 .PP
5826 \fIParent=\fR
5827 .RS 4
5828 Configures the parent Queueing Discipline (qdisc)\&. Takes one of
5829 "root",
5830 "clsact",
5831 "ingress"
5832 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
5833 "root"\&.
5834 .RE
5835 .PP
5836 \fIHandle=\fR
5837 .RS 4
5838 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\&.
5839 .RE
5840 .PP
5841 \fIDefaultClass=\fR
5842 .RS 4
5843 Takes the minor id in hexadecimal of the default class\&. Unclassified traffic gets sent to the class\&. Defaults to unset\&.
5844 .sp
5845 Added in version 246\&.
5846 .RE
5847 .PP
5848 \fIRateToQuantum=\fR
5849 .RS 4
5850 Takes an unsigned integer\&. The DRR quantums are calculated by dividing the value configured in
5851 \fIRate=\fR
5852 by
5853 \fIRateToQuantum=\fR\&.
5854 .sp
5855 Added in version 246\&.
5856 .RE
5857 .SH "[HIERARCHYTOKENBUCKETCLASS] SECTION OPTIONS"
5858 .PP
5859 The [HierarchyTokenBucketClass] section manages the traffic control class of hierarchy token bucket (htb)\&.
5860 .PP
5861 \fIParent=\fR
5862 .RS 4
5863 Configures the parent Queueing Discipline (qdisc)\&. Takes one of
5864 "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
5865 "root"\&.
5866 .RE
5867 .PP
5868 \fIClassId=\fR
5869 .RS 4
5870 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\&.
5871 .RE
5872 .PP
5873 \fIPriority=\fR
5874 .RS 4
5875 Specifies the priority of the class\&. In the round\-robin process, classes with the lowest priority field are tried for packets first\&.
5876 .sp
5877 Added in version 246\&.
5878 .RE
5879 .PP
5880 \fIQuantumBytes=\fR
5881 .RS 4
5882 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\&.
5883 .sp
5884 Added in version 246\&.
5885 .RE
5886 .PP
5887 \fIMTUBytes=\fR
5888 .RS 4
5889 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\&.
5890 .sp
5891 Added in version 246\&.
5892 .RE
5893 .PP
5894 \fIOverheadBytes=\fR
5895 .RS 4
5896 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\&.
5897 .sp
5898 Added in version 246\&.
5899 .RE
5900 .PP
5901 \fIRate=\fR
5902 .RS 4
5903 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\&.
5904 .sp
5905 Added in version 246\&.
5906 .RE
5907 .PP
5908 \fICeilRate=\fR
5909 .RS 4
5910 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
5911 \fIRate=\fR
5912 is used\&.
5913 .sp
5914 Added in version 246\&.
5915 .RE
5916 .PP
5917 \fIBufferBytes=\fR
5918 .RS 4
5919 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\&.
5920 .sp
5921 Added in version 246\&.
5922 .RE
5923 .PP
5924 \fICeilBufferBytes=\fR
5925 .RS 4
5926 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\&.
5927 .sp
5928 Added in version 246\&.
5929 .RE
5930 .SH "[CLASSFULMULTIQUEUEING] SECTION OPTIONS"
5931 .PP
5932 The [ClassfulMultiQueueing] section manages the queueing discipline (qdisc) of Classful Multi Queueing (mq)\&.
5933 .PP
5934 \fIParent=\fR
5935 .RS 4
5936 Configures the parent Queueing Discipline (qdisc)\&. Takes one of
5937 "root",
5938 "clsact",
5939 "ingress"
5940 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
5941 "root"\&.
5942 .RE
5943 .PP
5944 \fIHandle=\fR
5945 .RS 4
5946 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\&.
5947 .RE
5948 .SH "[BANDMULTIQUEUEING] SECTION OPTIONS"
5949 .PP
5950 The [BandMultiQueueing] section manages the queueing discipline (qdisc) of Band Multi Queueing (multiq)\&.
5951 .PP
5952 \fIParent=\fR
5953 .RS 4
5954 Configures the parent Queueing Discipline (qdisc)\&. Takes one of
5955 "root",
5956 "clsact",
5957 "ingress"
5958 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
5959 "root"\&.
5960 .RE
5961 .PP
5962 \fIHandle=\fR
5963 .RS 4
5964 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\&.
5965 .RE
5966 .SH "[HEAVYHITTERFILTER] SECTION OPTIONS"
5967 .PP
5968 The [HeavyHitterFilter] section manages the queueing discipline (qdisc) of Heavy Hitter Filter (hhf)\&.
5969 .PP
5970 \fIParent=\fR
5971 .RS 4
5972 Configures the parent Queueing Discipline (qdisc)\&. Takes one of
5973 "root",
5974 "clsact",
5975 "ingress"
5976 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
5977 "root"\&.
5978 .RE
5979 .PP
5980 \fIHandle=\fR
5981 .RS 4
5982 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\&.
5983 .RE
5984 .PP
5985 \fIPacketLimit=\fR
5986 .RS 4
5987 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\&.
5988 .sp
5989 Added in version 246\&.
5990 .RE
5991 .SH "[QUICKFAIRQUEUEING] SECTION OPTIONS"
5992 .PP
5993 The [QuickFairQueueing] section manages the queueing discipline (qdisc) of Quick Fair Queueing (QFQ)\&.
5994 .PP
5995 \fIParent=\fR
5996 .RS 4
5997 Configures the parent Queueing Discipline (qdisc)\&. Takes one of
5998 "root",
5999 "clsact",
6000 "ingress"
6001 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
6002 "root"\&.
6003 .RE
6004 .PP
6005 \fIHandle=\fR
6006 .RS 4
6007 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\&.
6008 .RE
6009 .SH "[QUICKFAIRQUEUEINGCLASS] SECTION OPTIONS"
6010 .PP
6011 The [QuickFairQueueingClass] section manages the traffic control class of Quick Fair Queueing (qfq)\&.
6012 .PP
6013 \fIParent=\fR
6014 .RS 4
6015 Configures the parent Queueing Discipline (qdisc)\&. Takes one of
6016 "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
6017 "root"\&.
6018 .RE
6019 .PP
6020 \fIClassId=\fR
6021 .RS 4
6022 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\&.
6023 .RE
6024 .PP
6025 \fIWeight=\fR
6026 .RS 4
6027 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\&.
6028 .sp
6029 Added in version 246\&.
6030 .RE
6031 .PP
6032 \fIMaxPacketBytes=\fR
6033 .RS 4
6034 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\&.
6035 .sp
6036 Added in version 246\&.
6037 .RE
6038 .SH "[BRIDGEVLAN] SECTION OPTIONS"
6039 .PP
6040 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,
6041 \fIVLANFiltering=\fR
6042 option has to be enabled on the bridge master, see the [Bridge] section in
6043 \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
6044 \fIVLANFiltering=\fR
6045 needs to be disabled on the bridge master\&.
6046 .PP
6047 \fIVLAN=\fR
6048 .RS 4
6049 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\&.
6050 .sp
6051 Added in version 231\&.
6052 .RE
6053 .PP
6054 \fIEgressUntagged=\fR
6055 .RS 4
6056 The VLAN ID specified here will be used to untag frames on egress\&. Configuring
6057 \fIEgressUntagged=\fR
6058 implicates the use of
6059 \fIVLAN=\fR
6060 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\&.
6061 .sp
6062 Added in version 231\&.
6063 .RE
6064 .PP
6065 \fIPVID=\fR
6066 .RS 4
6067 The port VLAN ID specified here is assigned to all untagged frames at ingress\&. Takes an VLAN ID or negative boolean value (e\&.g\&.
6068 "no")\&. When false, the currently assigned port VLAN ID will be dropped\&. Configuring
6069 \fIPVID=\fR
6070 implicates the use of
6071 \fIVLAN=\fR
6072 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\&.
6073 .sp
6074 Added in version 231\&.
6075 .RE
6076 .SH "EXAMPLES"
6077 .PP
6078 \fBExample\ \&1.\ \&Static network configuration\fR
6079 .sp
6080 .if n \{\
6081 .RS 4
6082 .\}
6083 .nf
6084 # /etc/systemd/network/50\-static\&.network
6085 [Match]
6086 Name=enp2s0
6087
6088 [Network]
6089 Address=192\&.168\&.0\&.15/24
6090 Gateway=192\&.168\&.0\&.1
6091 .fi
6092 .if n \{\
6093 .RE
6094 .\}
6095 .PP
6096 This brings interface
6097 "enp2s0"
6098 up with a static address\&. The specified gateway will be used for a default route\&.
6099 .PP
6100 \fBExample\ \&2.\ \&DHCP on ethernet links\fR
6101 .sp
6102 .if n \{\
6103 .RS 4
6104 .\}
6105 .nf
6106 # /etc/systemd/network/60\-dhcp\&.network
6107 [Match]
6108 Name=en*
6109
6110 [Network]
6111 DHCP=yes
6112 .fi
6113 .if n \{\
6114 .RE
6115 .\}
6116 .PP
6117 This will enable DHCPv4 and DHCPv6 on all interfaces with names starting with
6118 "en"
6119 (i\&.e\&. ethernet interfaces)\&.
6120 .PP
6121 \fBExample\ \&3.\ \&IPv6 Prefix Delegation (DHCPv6 PD)\fR
6122 .sp
6123 .if n \{\
6124 .RS 4
6125 .\}
6126 .nf
6127 # /etc/systemd/network/55\-dhcpv6\-pd\-upstream\&.network
6128 [Match]
6129 Name=enp1s0
6130
6131 [Network]
6132 DHCP=ipv6
6133
6134 # The lines below are optional, to also assign an address in the delegated prefix
6135 # to the upstream interface\&. Uncomment the lines below if necessary\&.
6136 #[Network]
6137 #DHCPPrefixDelegation=yes
6138 #[DHCPPrefixDelegation]
6139 #UplinkInterface=:self
6140 #SubnetId=0
6141 #Announce=no
6142
6143 # If the upstream network does not provides any Router Advertisement (RA) messages,
6144 # then uncomment the lines below to make the DHCPv6 client forcibly started in the
6145 # managed mode\&.
6146 #[Network]
6147 #IPv6AcceptRA=no
6148 #[DHCPv6]
6149 #WithoutRA=solicit
6150
6151 # If the upstream network provides Router Advertisement (RA) messages with the
6152 # Managed bit unset, then uncomment the lines below to make the DHCPv6 client
6153 # forcibly started in the managed mode when an RA is received\&.
6154 #[DHCPv6]
6155 #UseAddress=no
6156 #[IPv6AcceptRA]
6157 #DHCPv6Client=always
6158 .fi
6159 .if n \{\
6160 .RE
6161 .\}
6162 .sp
6163 .if n \{\
6164 .RS 4
6165 .\}
6166 .nf
6167 # /etc/systemd/network/55\-dhcpv6\-pd\-downstream\&.network
6168 [Match]
6169 Name=enp2s0
6170
6171 [Network]
6172 DHCPPrefixDelegation=yes
6173 IPv6SendRA=yes
6174
6175 # It is expected that the host is acting as a router\&. So, usually it is not
6176 # necessary to receive Router Advertisement from other hosts in the downstream network\&.
6177 IPv6AcceptRA=no
6178
6179 [DHCPPrefixDelegation]
6180 UplinkInterface=enp1s0
6181 SubnetId=1
6182 Announce=yes
6183 .fi
6184 .if n \{\
6185 .RE
6186 .\}
6187 .PP
6188 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\&.
6189 .PP
6190 \fBExample\ \&4.\ \&IPv6 Prefix Delegation (DHCPv4 6RD)\fR
6191 .sp
6192 .if n \{\
6193 .RS 4
6194 .\}
6195 .nf
6196 # /etc/systemd/network/55\-dhcpv4\-6rd\-upstream\&.network
6197 [Match]
6198 Name=enp1s0
6199
6200 [Network]
6201 DHCP=ipv4
6202
6203 # When DHCPv4\-6RD is used, the upstream network does not support IPv6\&.
6204 # Hence, it is not necessary to wait for Router Advertisement, which is enabled by default\&.
6205 IPv6AcceptRA=no
6206
6207 [DHCPv4]
6208 Use6RD=yes
6209 .fi
6210 .if n \{\
6211 .RE
6212 .\}
6213 .sp
6214 .if n \{\
6215 .RS 4
6216 .\}
6217 .nf
6218 # /etc/systemd/network/55\-dhcpv4\-6rd\-downstream\&.network
6219 [Match]
6220 Name=enp2s0
6221
6222 [Network]
6223 DHCPPrefixDelegation=yes
6224 IPv6SendRA=yes
6225
6226 # It is expected that the host is acting as a router\&. So, usually it is not
6227 # necessary to receive Router Advertisement from other hosts in the downstream network\&.
6228 IPv6AcceptRA=no
6229
6230 [DHCPPrefixDelegation]
6231 UplinkInterface=enp1s0
6232 SubnetId=1
6233 Announce=yes
6234 .fi
6235 .if n \{\
6236 .RE
6237 .\}
6238 .PP
6239 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\&.
6240 .PP
6241 \fBExample\ \&5.\ \&A bridge with two enslaved links\fR
6242 .sp
6243 .if n \{\
6244 .RS 4
6245 .\}
6246 .nf
6247 # /etc/systemd/network/25\-bridge\-static\&.netdev
6248 [NetDev]
6249 Name=bridge0
6250 Kind=bridge
6251 .fi
6252 .if n \{\
6253 .RE
6254 .\}
6255 .sp
6256 .if n \{\
6257 .RS 4
6258 .\}
6259 .nf
6260 # /etc/systemd/network/25\-bridge\-static\&.network
6261 [Match]
6262 Name=bridge0
6263
6264 [Network]
6265 Address=192\&.168\&.0\&.15/24
6266 Gateway=192\&.168\&.0\&.1
6267 DNS=192\&.168\&.0\&.1
6268 .fi
6269 .if n \{\
6270 .RE
6271 .\}
6272 .sp
6273 .if n \{\
6274 .RS 4
6275 .\}
6276 .nf
6277 # /etc/systemd/network/25\-bridge\-slave\-interface\-1\&.network
6278 [Match]
6279 Name=enp2s0
6280
6281 [Network]
6282 Bridge=bridge0
6283 .fi
6284 .if n \{\
6285 .RE
6286 .\}
6287 .sp
6288 .if n \{\
6289 .RS 4
6290 .\}
6291 .nf
6292 # /etc/systemd/network/25\-bridge\-slave\-interface\-2\&.network
6293 [Match]
6294 Name=wlp3s0
6295
6296 [Network]
6297 Bridge=bridge0
6298 .fi
6299 .if n \{\
6300 .RE
6301 .\}
6302 .PP
6303 This creates a bridge and attaches devices
6304 "enp2s0"
6305 and
6306 "wlp3s0"
6307 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\&.
6308 .PP
6309 \fBExample\ \&6.\ \&Bridge port with VLAN forwarding\fR
6310 .sp
6311 .if n \{\
6312 .RS 4
6313 .\}
6314 .nf
6315 # /etc/systemd/network/25\-bridge\-slave\-interface\-1\&.network
6316 [Match]
6317 Name=enp2s0
6318
6319 [Network]
6320 Bridge=bridge0
6321
6322 [BridgeVLAN]
6323 VLAN=1\-32
6324 PVID=42
6325 EgressUntagged=42
6326
6327 [BridgeVLAN]
6328 VLAN=100\-299
6329
6330 [BridgeVLAN]
6331 EgressUntagged=300\-400
6332 .fi
6333 .if n \{\
6334 .RE
6335 .\}
6336 .PP
6337 This overrides the configuration specified in the previous example for the interface
6338 "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\&.
6339 .PP
6340 \fBExample\ \&7.\ \&Various tunnels\fR
6341 .sp
6342 .if n \{\
6343 .RS 4
6344 .\}
6345 .nf
6346 /etc/systemd/network/25\-tunnels\&.network
6347 [Match]
6348 Name=ens1
6349
6350 [Network]
6351 Tunnel=ipip\-tun
6352 Tunnel=sit\-tun
6353 Tunnel=gre\-tun
6354 Tunnel=vti\-tun
6355 .fi
6356 .if n \{\
6357 .RE
6358 .\}
6359 .sp
6360 .if n \{\
6361 .RS 4
6362 .\}
6363 .nf
6364 /etc/systemd/network/25\-tunnel\-ipip\&.netdev
6365 [NetDev]
6366 Name=ipip\-tun
6367 Kind=ipip
6368 .fi
6369 .if n \{\
6370 .RE
6371 .\}
6372 .sp
6373 .if n \{\
6374 .RS 4
6375 .\}
6376 .nf
6377 /etc/systemd/network/25\-tunnel\-sit\&.netdev
6378 [NetDev]
6379 Name=sit\-tun
6380 Kind=sit
6381 .fi
6382 .if n \{\
6383 .RE
6384 .\}
6385 .sp
6386 .if n \{\
6387 .RS 4
6388 .\}
6389 .nf
6390 /etc/systemd/network/25\-tunnel\-gre\&.netdev
6391 [NetDev]
6392 Name=gre\-tun
6393 Kind=gre
6394 .fi
6395 .if n \{\
6396 .RE
6397 .\}
6398 .sp
6399 .if n \{\
6400 .RS 4
6401 .\}
6402 .nf
6403 /etc/systemd/network/25\-tunnel\-vti\&.netdev
6404 [NetDev]
6405 Name=vti\-tun
6406 Kind=vti
6407 .fi
6408 .if n \{\
6409 .RE
6410 .\}
6411 .PP
6412 This will bring interface
6413 "ens1"
6414 up and create an IPIP tunnel, a SIT tunnel, a GRE tunnel, and a VTI tunnel using it\&.
6415 .PP
6416 \fBExample\ \&8.\ \&A bond device\fR
6417 .sp
6418 .if n \{\
6419 .RS 4
6420 .\}
6421 .nf
6422 # /etc/systemd/network/30\-bond1\&.network
6423 [Match]
6424 Name=bond1
6425
6426 [Network]
6427 DHCP=ipv6
6428 .fi
6429 .if n \{\
6430 .RE
6431 .\}
6432 .sp
6433 .if n \{\
6434 .RS 4
6435 .\}
6436 .nf
6437 # /etc/systemd/network/30\-bond1\&.netdev
6438 [NetDev]
6439 Name=bond1
6440 Kind=bond
6441 .fi
6442 .if n \{\
6443 .RE
6444 .\}
6445 .sp
6446 .if n \{\
6447 .RS 4
6448 .\}
6449 .nf
6450 # /etc/systemd/network/30\-bond1\-dev1\&.network
6451 [Match]
6452 MACAddress=52:54:00:e9:64:41
6453
6454 [Network]
6455 Bond=bond1
6456 .fi
6457 .if n \{\
6458 .RE
6459 .\}
6460 .sp
6461 .if n \{\
6462 .RS 4
6463 .\}
6464 .nf
6465 # /etc/systemd/network/30\-bond1\-dev2\&.network
6466 [Match]
6467 MACAddress=52:54:00:e9:64:42
6468
6469 [Network]
6470 Bond=bond1
6471 .fi
6472 .if n \{\
6473 .RE
6474 .\}
6475 .PP
6476 This will create a bond device
6477 "bond1"
6478 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\&.
6479 .PP
6480 \fBExample\ \&9.\ \&Virtual Routing and Forwarding (VRF)\fR
6481 .PP
6482 Add the
6483 "bond1"
6484 interface to the VRF master interface
6485 "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\&.
6486 .sp
6487 .if n \{\
6488 .RS 4
6489 .\}
6490 .nf
6491 # /etc/systemd/network/25\-vrf\&.network
6492 [Match]
6493 Name=bond1
6494
6495 [Network]
6496 VRF=vrf1
6497 .fi
6498 .if n \{\
6499 .RE
6500 .\}
6501 .PP
6502 \fBExample\ \&10.\ \&MacVTap\fR
6503 .PP
6504 This brings up a network interface
6505 "macvtap\-test"
6506 and attaches it to
6507 "enp0s25"\&.
6508 .sp
6509 .if n \{\
6510 .RS 4
6511 .\}
6512 .nf
6513 # /usr/lib/systemd/network/25\-macvtap\&.network
6514 [Match]
6515 Name=enp0s25
6516
6517 [Network]
6518 MACVTAP=macvtap\-test
6519 .fi
6520 .if n \{\
6521 .RE
6522 .\}
6523 .PP
6524 \fBExample\ \&11.\ \&A Xfrm interface with physical underlying device\&.\fR
6525 .sp
6526 .if n \{\
6527 .RS 4
6528 .\}
6529 .nf
6530 # /etc/systemd/network/27\-xfrm\&.netdev
6531 [NetDev]
6532 Name=xfrm0
6533 Kind=xfrm
6534
6535 [Xfrm]
6536 InterfaceId=7
6537 .fi
6538 .if n \{\
6539 .RE
6540 .\}
6541 .sp
6542 .if n \{\
6543 .RS 4
6544 .\}
6545 .nf
6546 # /etc/systemd/network/27\-eth0\&.network
6547 [Match]
6548 Name=eth0
6549
6550 [Network]
6551 Xfrm=xfrm0
6552 .fi
6553 .if n \{\
6554 .RE
6555 .\}
6556 .PP
6557 This creates a
6558 "xfrm0"
6559 interface and binds it to the
6560 "eth0"
6561 device\&. This allows hardware based ipsec offloading to the
6562 "eth0"
6563 nic\&. If offloading is not needed, xfrm interfaces can be assigned to the
6564 "lo"
6565 device\&.
6566 .SH "SEE ALSO"
6567 .PP
6568 \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)
6569 .SH "NOTES"
6570 .IP " 1." 4
6571 ๐Ÿ’ฃ๐Ÿ’ฅ๐Ÿงจ๐Ÿ’ฅ๐Ÿ’ฅ๐Ÿ’ฃ Please note that those configuration files must be available at all times. If
6572 /usr/local/
6573 is a separate partition, it may not be available during early boot, and must not be used for configuration.
6574 .IP " 2." 4
6575 System and Service Credentials
6576 .RS 4
6577 \%https://systemd.io/CREDENTIALS
6578 .RE
6579 .IP " 3." 4
6580 Link-Local Multicast Name Resolution
6581 .RS 4
6582 \%https://tools.ietf.org/html/rfc4795
6583 .RE
6584 .IP " 4." 4
6585 Multicast DNS
6586 .RS 4
6587 \%https://tools.ietf.org/html/rfc6762
6588 .RE
6589 .IP " 5." 4
6590 DNS-over-TLS
6591 .RS 4
6592 \%https://tools.ietf.org/html/rfc7858
6593 .RE
6594 .IP " 6." 4
6595 DNSSEC
6596 .RS 4
6597 \%https://tools.ietf.org/html/rfc4033
6598 .RE
6599 .IP " 7." 4
6600 IEEE 802.1AB-2016
6601 .RS 4
6602 \%https://standards.ieee.org/findstds/standard/802.1AB-2016.html
6603 .RE
6604 .IP " 8." 4
6605 RFC 5227
6606 .RS 4
6607 \%https://tools.ietf.org/html/rfc5227
6608 .RE
6609 .IP " 9." 4
6610 IP Sysctl
6611 .RS 4
6612 \%https://docs.kernel.org/networking/ip-sysctl.html
6613 .RE
6614 .IP "10." 4
6615 RFC 4941
6616 .RS 4
6617 \%https://tools.ietf.org/html/rfc4941
6618 .RE
6619 .IP "11." 4
6620 RFC 3704
6621 .RS 4
6622 \%https://tools.ietf.org/html/rfc1027
6623 .RE
6624 .IP "12." 4
6625 RFC 3069
6626 .RS 4
6627 \%https://tools.ietf.org/html/rfc3069
6628 .RE
6629 .IP "13." 4
6630 RFC 6275
6631 .RS 4
6632 \%https://tools.ietf.org/html/rfc6275
6633 .RE
6634 .IP "14." 4
6635 RFC 4862
6636 .RS 4
6637 \%https://tools.ietf.org/html/rfc4862
6638 .RE
6639 .IP "15." 4
6640 RFC 3041
6641 .RS 4
6642 \%https://tools.ietf.org/html/rfc3041
6643 .RE
6644 .IP "16." 4
6645 NetLabel
6646 .RS 4
6647 \%https://docs.kernel.org/netlabel/index.html
6648 .RE
6649 .IP "17." 4
6650 Linux Security Modules (LSMs)
6651 .RS 4
6652 \%https://en.wikipedia.org/wiki/Linux_Security_Modules
6653 .RE
6654 .IP "18." 4
6655 NetLabel Fallback Peer Labeling
6656 .RS 4
6657 \%https://github.com/SELinuxProject/selinux-notebook/blob/main/src/network_support.md
6658 .RE
6659 .IP "19." 4
6660 NFT
6661 .RS 4
6662 \%https://netfilter.org/projects/nftables/index.html
6663 .RE
6664 .IP "20." 4
6665 RFC 3484
6666 .RS 4
6667 \%https://tools.ietf.org/html/rfc3484
6668 .RE
6669 .IP "21." 4
6670 Type of Service
6671 .RS 4
6672 \%https://en.wikipedia.org/wiki/Type_of_service
6673 .RE
6674 .IP "22." 4
6675 Differentiated services
6676 .RS 4
6677 \%https://en.wikipedia.org/wiki/Differentiated_services
6678 .RE
6679 .IP "23." 4
6680 Virtual Routing and Forwarding (VRF)
6681 .RS 4
6682 \%https://docs.kernel.org/networking/vrf.html
6683 .RE
6684 .IP "24." 4
6685 RFC 4191
6686 .RS 4
6687 \%https://tools.ietf.org/html/rfc4191
6688 .RE
6689 .IP "25." 4
6690 RFC 2132
6691 .RS 4
6692 \%https://tools.ietf.org/html/rfc2132
6693 .RE
6694 .IP "26." 4
6695 RFC 4702
6696 .RS 4
6697 \%https://tools.ietf.org/html/rfc4702
6698 .RE
6699 .IP "27." 4
6700 RFC 8520
6701 .RS 4
6702 \%https://tools.ietf.org/html/rfc8520
6703 .RE
6704 .IP "28." 4
6705 RFC 4039
6706 .RS 4
6707 \%https://tools.ietf.org/html/rfc4039
6708 .RE
6709 .IP "29." 4
6710 RFC 7844
6711 .RS 4
6712 \%https://tools.ietf.org/html/rfc7844
6713 .RE
6714 .IP "30." 4
6715 C-style escapes
6716 .RS 4
6717 \%https://en.wikipedia.org/wiki/Escape_sequences_in_C#Table_of_escape_sequences
6718 .RE
6719 .IP "31." 4
6720 RFC 9463
6721 .RS 4
6722 \%https://datatracker.ietf.org/doc/html/rfc9463
6723 .RE
6724 .IP "32." 4
6725 RFC 3442
6726 .RS 4
6727 \%https://datatracker.ietf.org/doc/html/rfc3442
6728 .RE
6729 .IP "33." 4
6730 RFC 5969
6731 .RS 4
6732 \%https://tools.ietf.org/html/rfc5969
6733 .RE
6734 .IP "34." 4
6735 RFC 7084
6736 .RS 4
6737 \%https://datatracker.ietf.org/doc/html/rfc7084
6738 .RE
6739 .IP "35." 4
6740 RFC 8925
6741 .RS 4
6742 \%https://tools.ietf.org/html/rfc8925
6743 .RE
6744 .IP "36." 4
6745 RFC 3315
6746 .RS 4
6747 \%https://tools.ietf.org/html/rfc3315#section-17.2.1
6748 .RE
6749 .IP "37." 4
6750 RFC 8415
6751 .RS 4
6752 \%https://www.rfc-editor.org/rfc/rfc8415.html#section-6.3
6753 .RE
6754 .IP "38." 4
6755 RFC 4291
6756 .RS 4
6757 \%https://tools.ietf.org/html/rfc4291#section-2.5.4
6758 .RE
6759 .IP "39." 4
6760 RFC 7217
6761 .RS 4
6762 \%https://tools.ietf.org/html/rfc7217
6763 .RE
6764 .IP "40." 4
6765 RFC 8781
6766 .RS 4
6767 \%https://tools.ietf.org/html/rfc8781
6768 .RE
6769 .IP "41." 4
6770 RFC 2131
6771 .RS 4
6772 \%https://www.rfc-editor.org/rfc/rfc2131.html
6773 .RE
6774 .IP "42." 4
6775 RFC 2132
6776 .RS 4
6777 \%https://www.rfc-editor.org/rfc/rfc2132.html
6778 .RE
6779 .IP "43." 4
6780 RFC 1542
6781 .RS 4
6782 \%https://tools.ietf.org/html/rfc1542
6783 .RE
6784 .IP "44." 4
6785 RFC 4039
6786 .RS 4
6787 \%https://datatracker.ietf.org/doc/html/rfc4039
6788 .RE
6789 .IP "45." 4
6790 RFC 4861
6791 .RS 4
6792 \%https://tools.ietf.org/html/rfc4861
6793 .RE