Debian Codegraph @

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

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