]> git.ipfire.org Git - thirdparty/systemd.git/blob - man/systemd.network.xml
Merge pull request #29023 from pelaufer/dhcp-prefix-dbus
[thirdparty/systemd.git] / man / systemd.network.xml
1 <?xml version='1.0'?>
2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3 "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
4 <!-- SPDX-License-Identifier: LGPL-2.1-or-later -->
5
6 <refentry id="systemd.network" conditional='ENABLE_NETWORKD'
7 xmlns:xi="http://www.w3.org/2001/XInclude">
8
9 <refentryinfo>
10 <title>systemd.network</title>
11 <productname>systemd</productname>
12 </refentryinfo>
13
14 <refmeta>
15 <refentrytitle>systemd.network</refentrytitle>
16 <manvolnum>5</manvolnum>
17 </refmeta>
18
19 <refnamediv>
20 <refname>systemd.network</refname>
21 <refpurpose>Network configuration</refpurpose>
22 </refnamediv>
23
24 <refsynopsisdiv>
25 <para><filename><replaceable>network</replaceable>.network</filename></para>
26 </refsynopsisdiv>
27
28 <refsect1>
29 <title>Description</title>
30
31 <para>A plain ini-style text file that encodes network configuration for matching network
32 interfaces, used by
33 <citerefentry><refentrytitle>systemd-networkd</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
34 See <citerefentry><refentrytitle>systemd.syntax</refentrytitle><manvolnum>7</manvolnum></citerefentry>
35 for a general description of the syntax.</para>
36
37 <para>The main network file must have the extension <filename>.network</filename>; other
38 extensions are ignored. Networks are applied to links whenever the links appear.</para>
39
40 <para>The <filename>.network</filename> files are read from the files located in the system network
41 directories <filename>/usr/lib/systemd/network</filename> and
42 <filename>/usr/local/lib/systemd/network</filename>, the volatile runtime network directory
43 <filename>/run/systemd/network</filename> and the local administration network directory
44 <filename>/etc/systemd/network</filename>. All configuration files are collectively sorted and
45 processed in alphanumeric order, regardless of the directories in which they live. However, files
46 with identical filenames replace each other. It is recommended that each filename is prefixed with
47 a number (e.g. <filename>10-eth0.network</filename>). Otherwise, the default
48 <filename>.network</filename> files or those generated by
49 <citerefentry><refentrytitle>systemd-network-generator.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>
50 may take precedence over user configured files. Files in <filename>/etc/</filename> have the highest
51 priority, files in <filename>/run/</filename> take precedence over files with the same name under
52 <filename>/usr/</filename>. This can be used to override a system-supplied configuration file with
53 a local file if needed. As a special case, an empty file (file size 0) or symlink with the same
54 name pointing to <filename>/dev/null</filename> disables the configuration file entirely (it is
55 "masked").</para>
56
57 <para>Along with the network file <filename>foo.network</filename>, a "drop-in" directory
58 <filename>foo.network.d/</filename> may exist. All files with the suffix
59 <literal>.conf</literal> from this directory will be merged in the alphanumeric order and parsed
60 after the main file itself has been parsed. This is useful to alter or add configuration settings,
61 without having to modify the main configuration file. Each drop-in file must have appropriate
62 section headers.</para>
63
64 <para>In addition to <filename>/etc/systemd/network</filename>, drop-in <literal>.d</literal>
65 directories can be placed in <filename>/usr/lib/systemd/network</filename> or
66 <filename>/run/systemd/network</filename> directories. Drop-in files in
67 <filename>/etc/</filename> take precedence over those in <filename>/run/</filename> which in turn
68 take precedence over those in <filename>/usr/lib/</filename>. Drop-in files under any of these
69 directories take precedence over the main network file wherever located.</para>
70 </refsect1>
71
72 <refsect1>
73 <title>[Match] Section Options</title>
74
75 <para>The network file contains a [Match] section, which determines if a given network file may
76 be applied to a given interface; and a [Network] section specifying how the interface should be
77 configured. The first (in alphanumeric order) of the network files that matches a given interface
78 is applied, all later files are ignored, even if they match as well.</para>
79
80 <para>A network file is said to match a network interface if all matches specified by the [Match]
81 section are satisfied. When a network file does not contain valid settings in [Match] section, then
82 the file will match all interfaces and <command>systemd-networkd</command> warns about that. Hint:
83 to avoid the warning and to make it clear that all interfaces shall be matched, add the following:
84 <programlisting>Name=*</programlisting> The following keys are accepted:</para>
85
86 <variablelist class='network-directives'>
87 <xi:include href="systemd.link.xml" xpointer="mac-address" />
88 <xi:include href="systemd.link.xml" xpointer="permanent-mac-address" />
89 <xi:include href="systemd.link.xml" xpointer="path" />
90 <xi:include href="systemd.link.xml" xpointer="driver" />
91 <xi:include href="systemd.link.xml" xpointer="type" />
92 <xi:include href="systemd.link.xml" xpointer="kind" />
93 <xi:include href="systemd.link.xml" xpointer="property" />
94
95 <varlistentry>
96 <term><varname>Name=</varname></term>
97 <listitem>
98 <para>A whitespace-separated list of shell-style globs matching the device name, as exposed
99 by the udev property <literal>INTERFACE</literal>, or device's alternative names. If the
100 list is prefixed with a "!", the test is inverted.</para>
101 </listitem>
102 </varlistentry>
103
104 <varlistentry>
105 <term><varname>WLANInterfaceType=</varname></term>
106 <listitem>
107 <para>A whitespace-separated list of wireless network type. Supported values are
108 <literal>ad-hoc</literal>, <literal>station</literal>, <literal>ap</literal>,
109 <literal>ap-vlan</literal>, <literal>wds</literal>, <literal>monitor</literal>,
110 <literal>mesh-point</literal>, <literal>p2p-client</literal>, <literal>p2p-go</literal>,
111 <literal>p2p-device</literal>, <literal>ocb</literal>, and <literal>nan</literal>. If the
112 list is prefixed with a "!", the test is inverted. </para>
113
114 <xi:include href="version-info.xml" xpointer="v244"/>
115 </listitem>
116 </varlistentry>
117
118 <varlistentry>
119 <term><varname>SSID=</varname></term>
120 <listitem>
121 <para>A whitespace-separated list of shell-style globs matching the SSID of the currently
122 connected wireless LAN. If the list is prefixed with a "!", the test is inverted.</para>
123
124 <xi:include href="version-info.xml" xpointer="v244"/>
125 </listitem>
126 </varlistentry>
127
128 <varlistentry>
129 <term><varname>BSSID=</varname></term>
130 <listitem>
131 <para>A whitespace-separated list of hardware address of the currently connected wireless
132 LAN. Use full colon-, hyphen- or dot-delimited hexadecimal. See the example in
133 <varname>MACAddress=</varname>. This option may appear more than once, in which case the
134 lists are merged. If the empty string is assigned to this option, the list is reset.</para>
135
136 <xi:include href="version-info.xml" xpointer="v244"/>
137 </listitem>
138 </varlistentry>
139
140 <xi:include href="systemd.link.xml" xpointer="host" />
141 <xi:include href="systemd.link.xml" xpointer="virtualization" />
142 <xi:include href="systemd.link.xml" xpointer="kernel-command-line" />
143 <xi:include href="systemd.link.xml" xpointer="kernel-version" />
144 <xi:include href="systemd.link.xml" xpointer="credential" />
145 <xi:include href="systemd.link.xml" xpointer="architecture" />
146 <xi:include href="systemd.link.xml" xpointer="firmware" />
147 </variablelist>
148 </refsect1>
149
150 <refsect1>
151 <title>[Link] Section Options</title>
152
153 <para>The [Link] section accepts the following keys:</para>
154
155 <variablelist class='network-directives'>
156 <varlistentry>
157 <term><varname>MACAddress=</varname></term>
158 <listitem>
159 <para>The hardware address to set for the device.</para>
160 </listitem>
161 </varlistentry>
162
163 <varlistentry>
164 <term><varname>MTUBytes=</varname></term>
165 <listitem>
166 <para>The maximum transmission unit in bytes to set for the device. The usual suffixes K, M,
167 G, are supported and are understood to the base of 1024.</para>
168 <para>Note that if IPv6 is enabled on the interface, and the MTU is chosen below 1280 (the
169 minimum MTU for IPv6) it will automatically be increased to this value.</para>
170
171 <xi:include href="version-info.xml" xpointer="v218"/>
172 </listitem>
173 </varlistentry>
174
175 <varlistentry>
176 <term><varname>ARP=</varname></term>
177 <listitem>
178 <para>Takes a boolean. If set to true, the ARP (low-level Address Resolution Protocol)
179 for this interface is enabled. When unset, the kernel's default will be used.</para>
180 <para> For example, disabling ARP is useful when creating multiple MACVLAN or VLAN virtual
181 interfaces atop a single lower-level physical interface, which will then only serve as a
182 link/"bridge" device aggregating traffic to the same physical link and not participate in
183 the network otherwise. Defaults to unset.</para>
184
185 <xi:include href="version-info.xml" xpointer="v232"/>
186 </listitem>
187 </varlistentry>
188
189 <varlistentry>
190 <term><varname>Multicast=</varname></term>
191 <listitem>
192 <para>Takes a boolean. If set to true, the multicast flag on the device is enabled. Defaults
193 to unset.</para>
194
195 <xi:include href="version-info.xml" xpointer="v239"/>
196 </listitem>
197 </varlistentry>
198
199 <varlistentry>
200 <term><varname>AllMulticast=</varname></term>
201 <listitem>
202 <para>Takes a boolean. If set to true, the driver retrieves all multicast packets from the
203 network. This happens when multicast routing is enabled. Defaults to unset.</para>
204
205 <xi:include href="version-info.xml" xpointer="v239"/>
206 </listitem>
207 </varlistentry>
208
209 <varlistentry>
210 <term><varname>Promiscuous=</varname></term>
211 <listitem>
212 <para>Takes a boolean. If set to true, promiscuous mode of the interface is enabled. Defaults
213 to unset.</para>
214 <para>If this is set to false for the underlying link of a <literal>passthru</literal> mode
215 MACVLAN/MACVTAP, the virtual interface will be created with the <literal>nopromisc</literal>
216 flag set.</para>
217
218 <xi:include href="version-info.xml" xpointer="v248"/>
219 </listitem>
220 </varlistentry>
221
222 <varlistentry>
223 <term><varname>Unmanaged=</varname></term>
224 <listitem>
225 <para>Takes a boolean. When <literal>yes</literal>, no attempts are made to bring up or
226 configure matching links, equivalent to when there are no matching network files. Defaults to
227 <literal>no</literal>.</para>
228 <para>This is useful for preventing later matching network files from interfering with
229 certain interfaces that are fully controlled by other applications.</para>
230
231 <xi:include href="version-info.xml" xpointer="v233"/>
232 </listitem>
233 </varlistentry>
234
235 <varlistentry>
236 <term><varname>Group=</varname></term>
237 <listitem>
238 <para>Link groups are similar to port ranges found in managed switches. When network
239 interfaces are added to a numbered group, operations on all the interfaces from that group
240 can be performed at once. Takes an unsigned integer in the range 0…2147483647. Defaults to
241 unset.</para>
242
243 <xi:include href="version-info.xml" xpointer="v246"/>
244 </listitem>
245 </varlistentry>
246
247 <varlistentry>
248 <term><varname>RequiredForOnline=</varname></term>
249 <listitem>
250 <para>Takes a boolean or a minimum operational state and an optional maximum operational
251 state. Please see
252 <citerefentry><refentrytitle>networkctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>
253 for possible operational states. When <literal>yes</literal>, the network is deemed required
254 when determining whether the system is online (including when running
255 <command>systemd-networkd-wait-online</command>). When <literal>no</literal>, the network is
256 ignored when determining the online state. When a minimum operational state and an optional
257 maximum operational state are set, <literal>yes</literal> is implied, and this controls the
258 minimum and maximum operational state required for the network interface to be considered
259 online.</para>
260
261 <para>Defaults to <literal>yes</literal> when <varname>ActivationPolicy=</varname> is not
262 set, or set to <literal>up</literal>, <literal>always-up</literal>, or
263 <literal>bound</literal>. Defaults to <literal>no</literal> when
264 <varname>ActivationPolicy=</varname> is set to <literal>manual</literal> or
265 <literal>down</literal>. This is forced to <literal>no</literal> when
266 <varname>ActivationPolicy=</varname> is set to <literal>always-down</literal>.</para>
267
268 <para>The network will be brought up normally (as configured by
269 <varname>ActivationPolicy=</varname>), but in the event that there is no address being
270 assigned by DHCP or the cable is not plugged in, the link will simply remain offline and be
271 skipped automatically by <command>systemd-networkd-wait-online</command> if
272 <literal>RequiredForOnline=no</literal>.</para>
273
274 <xi:include href="version-info.xml" xpointer="v236"/>
275 </listitem>
276 </varlistentry>
277
278 <varlistentry>
279 <term><varname>RequiredFamilyForOnline=</varname></term>
280 <listitem>
281 <para>Takes an address family. When specified, an IP address in the given family is deemed
282 required when determining whether the link is online (including when running
283 <command>systemd-networkd-wait-online</command>). Takes one of <literal>ipv4</literal>,
284 <literal>ipv6</literal>, <literal>both</literal>, or <literal>any</literal>. Defaults to
285 <literal>any</literal>. Note that this option has no effect if
286 <literal>RequiredForOnline=no</literal>, or if <literal>RequiredForOnline=</literal>
287 specifies a minimum operational state below <literal>degraded</literal>.</para>
288
289 <xi:include href="version-info.xml" xpointer="v249"/>
290 </listitem>
291 </varlistentry>
292
293 <varlistentry>
294 <term><varname>ActivationPolicy=</varname></term>
295 <listitem>
296 <para>Specifies the policy for <command>systemd-networkd</command> managing the link
297 administrative state. Specifically, this controls how <command>systemd-networkd</command>
298 changes the network device's <literal>IFF_UP</literal> flag, which is sometimes
299 controlled by system administrators by running e.g.,
300 <command>ip link set dev eth0 up</command> or <command>ip link set dev eth0 down</command>,
301 and can also be changed with <command>networkctl up eth0</command> or
302 <command>networkctl down eth0</command>.</para>
303
304 <para>Takes one of <literal>up</literal>, <literal>always-up</literal>,
305 <literal>manual</literal>, <literal>always-down</literal>, <literal>down</literal>,
306 or <literal>bound</literal>. When <literal>manual</literal>,
307 <command>systemd-networkd</command> will not change the link's admin state automatically;
308 the system administrator must bring the interface up or down manually, as desired. When
309 <literal>up</literal> (the default) or <literal>always-up</literal>, or
310 <literal>down</literal> or <literal>always-down</literal>,
311 <command>systemd-networkd</command> will set the link up or down, respectively, when the
312 interface is (re)configured. When <literal>always-up</literal> or
313 <literal>always-down</literal>, <command>systemd-networkd</command> will set the link up or
314 down, respectively, any time <command>systemd-networkd</command> detects a change in the
315 administrative state. When <varname>BindCarrier=</varname> is also set, this is automatically
316 set to <literal>bound</literal> and any other value is ignored.</para>
317
318 <para>When the policy is set to <literal>down</literal> or <literal>manual</literal>, the
319 default value of <varname>RequiredForOnline=</varname> is <literal>no</literal>. When the
320 policy is set to <literal>always-down</literal>, the value of
321 <varname>RequiredForOnline=</varname> forced to <literal>no</literal>.</para>
322
323 <para>The administrative state is not the same as the carrier state, so using
324 <literal>always-up</literal> does not mean the link will never lose carrier. The link carrier
325 depends on both the administrative state as well as the network device's physical connection.
326 However, to avoid reconfiguration failures, when using <literal>always-up</literal>,
327 <varname>IgnoreCarrierLoss=</varname> is forced to true.</para>
328
329 <xi:include href="version-info.xml" xpointer="v248"/>
330 </listitem>
331 </varlistentry>
332 </variablelist>
333 </refsect1>
334
335 <xi:include href="systemd.link.xml" xpointer="sr-iov" />
336
337 <refsect1>
338 <title>[Network] Section Options</title>
339
340 <para>The [Network] section accepts the following keys:</para>
341
342 <variablelist class='network-directives'>
343 <varlistentry>
344 <term><varname>Description=</varname></term>
345 <listitem>
346 <para>A description of the device. This is only used for presentation purposes.</para>
347 </listitem>
348 </varlistentry>
349
350 <varlistentry>
351 <term><varname>DHCP=</varname></term>
352 <listitem>
353 <para>Enables DHCPv4 and/or DHCPv6 client support. Accepts <literal>yes</literal>,
354 <literal>no</literal>, <literal>ipv4</literal>, or <literal>ipv6</literal>. Defaults to
355 <literal>no</literal>.</para>
356
357 <para>Note that DHCPv6 will by default be triggered by Router Advertisements, if reception is
358 enabled, regardless of this parameter. By explicitly enabling DHCPv6 support here, the DHCPv6
359 client will be started in the mode specified by the <varname>WithoutRA=</varname> setting in the
360 [DHCPv6] section, regardless of the presence of routers on the link, or what flags the routers
361 pass. See <varname>IPv6AcceptRA=</varname>.</para>
362
363 <para>Furthermore, note that by default the domain name specified through DHCP is not used
364 for name resolution. See option <option>UseDomains=</option> below.</para>
365
366 <para>See the [DHCPv4] or [DHCPv6] sections below for further configuration options for the
367 DHCP client support.</para>
368 </listitem>
369 </varlistentry>
370
371 <varlistentry>
372 <term><varname>DHCPServer=</varname></term>
373 <listitem>
374 <para>Takes a boolean. If set to <literal>yes</literal>, DHCPv4 server will be started.
375 Defaults to <literal>no</literal>. Further settings for the DHCP server may be set in the
376 [DHCPServer] section described below.</para>
377
378 <xi:include href="version-info.xml" xpointer="v215"/>
379 </listitem>
380 </varlistentry>
381
382 <varlistentry>
383 <term><varname>LinkLocalAddressing=</varname></term>
384 <listitem>
385 <para>Enables link-local address autoconfiguration. Accepts <option>yes</option>,
386 <option>no</option>, <option>ipv4</option>, and <option>ipv6</option>. An IPv6 link-local
387 address is configured when <option>yes</option> or <option>ipv6</option>. An IPv4 link-local
388 address is configured when <option>yes</option> or <option>ipv4</option> and when DHCPv4
389 autoconfiguration has been unsuccessful for some time. (IPv4 link-local address
390 autoconfiguration will usually happen in parallel with repeated attempts to acquire a DHCPv4
391 lease).</para>
392
393 <para>Defaults to <option>no</option> when <varname>KeepMaster=</varname> or
394 <varname>Bridge=</varname> is set or when the specified
395 <varname>MACVLAN=</varname>/<varname>MACVTAP=</varname> has <varname>Mode=passthru</varname>,
396 or <option>ipv6</option> otherwise.</para>
397
398 <xi:include href="version-info.xml" xpointer="v219"/>
399 </listitem>
400 </varlistentry>
401
402 <varlistentry>
403 <term><varname>IPv6LinkLocalAddressGenerationMode=</varname></term>
404 <listitem>
405 <para>Specifies how IPv6 link-local address is generated. Takes one of
406 <literal>eui64</literal>, <literal>none</literal>, <literal>stable-privacy</literal> and
407 <literal>random</literal>. When unset, <literal>stable-privacy</literal> is used if
408 <varname>IPv6StableSecretAddress=</varname> is specified, and if not,
409 <literal>eui64</literal> is used. Note that if <varname>LinkLocalAddressing=</varname> is
410 <literal>no</literal> or <literal>ipv4</literal>, then
411 <varname>IPv6LinkLocalAddressGenerationMode=</varname> will be ignored. Also, even if
412 <varname>LinkLocalAddressing=</varname> is <literal>yes</literal> or <literal>ipv6</literal>,
413 setting <varname>IPv6LinkLocalAddressGenerationMode=none</varname>
414 disables to configure an IPv6 link-local address.</para>
415
416 <xi:include href="version-info.xml" xpointer="v246"/>
417 </listitem>
418 </varlistentry>
419
420 <varlistentry>
421 <term><varname>IPv6StableSecretAddress=</varname></term>
422 <listitem>
423 <para>Takes an IPv6 address. The specified address will be used as a stable secret for
424 generating IPv6 link-local address. If this setting is specified, and
425 <varname>IPv6LinkLocalAddressGenerationMode=</varname> is unset, then
426 <varname>IPv6LinkLocalAddressGenerationMode=stable-privacy</varname> is implied.
427 If this setting is not specified, and <literal>stable-privacy</literal> is set to
428 <varname>IPv6LinkLocalAddressGenerationMode=</varname>,
429 then a stable secret address will be generated from the local machine ID and the interface
430 name.</para>
431
432 <xi:include href="version-info.xml" xpointer="v249"/>
433 </listitem>
434 </varlistentry>
435
436 <varlistentry>
437 <term><varname>IPv4LLStartAddress=</varname></term>
438 <listitem>
439 <para>Specifies the first IPv4 link-local address to try. Takes an IPv4 address for example
440 169.254.1.2, from the link-local address range: 169.254.0.0/16 except for 169.254.0.0/24 and
441 169.254.255.0/24. This setting may be useful if the device should always have the same address
442 as long as there is no address conflict. When unset, a random address will be automatically
443 selected. Defaults to unset.</para>
444
445 <xi:include href="version-info.xml" xpointer="v252"/>
446 </listitem>
447 </varlistentry>
448
449 <varlistentry>
450 <term><varname>IPv4LLRoute=</varname></term>
451 <listitem>
452 <para>Takes a boolean. If set to true, sets up the route needed for non-IPv4LL hosts to
453 communicate with IPv4LL-only hosts. Defaults to false.</para>
454
455 <xi:include href="version-info.xml" xpointer="v216"/>
456 </listitem>
457 </varlistentry>
458
459 <varlistentry>
460 <term><varname>DefaultRouteOnDevice=</varname></term>
461 <listitem>
462 <para>Takes a boolean. If set to true, sets up the IPv4 default route bound to the interface.
463 Defaults to false. This is useful when creating routes on point-to-point interfaces. This is
464 equivalent to e.g. the following,
465 <programlisting>ip route add default dev veth99</programlisting>
466 or,
467 <programlisting>[Route]
468 Gateway=0.0.0.0</programlisting></para>
469 <para>Currently, there are no way to specify e.g., the table for the route configured by this
470 setting. To configure the default route with such an additional property, please use the
471 following instead:
472 <programlisting>[Route]
473 Gateway=0.0.0.0
474 Table=1234</programlisting></para>
475 <para>If you'd like to create an IPv6 default route bound to the interface, please use the
476 following:
477 <programlisting>[Route]
478 Gateway=::
479 Table=1234</programlisting></para>
480
481 <xi:include href="version-info.xml" xpointer="v243"/>
482 </listitem>
483 </varlistentry>
484
485 <varlistentry>
486 <term><varname>LLMNR=</varname></term>
487 <listitem>
488 <para>Takes a boolean or <literal>resolve</literal>. When true, enables
489 <ulink url="https://tools.ietf.org/html/rfc4795">Link-Local Multicast Name Resolution</ulink>
490 on the link. When set to <literal>resolve</literal>, only resolution is enabled, but not host
491 registration and announcement. Defaults to true. This setting is read by
492 <citerefentry><refentrytitle>systemd-resolved.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
493 </para>
494
495 <xi:include href="version-info.xml" xpointer="v216"/>
496 </listitem>
497 </varlistentry>
498
499 <varlistentry>
500 <term><varname>MulticastDNS=</varname></term>
501 <listitem>
502 <para>Takes a boolean or <literal>resolve</literal>. When true, enables
503 <ulink url="https://tools.ietf.org/html/rfc6762">Multicast DNS</ulink> support on the link.
504 When set to <literal>resolve</literal>, only resolution is enabled, but not host or service
505 registration and announcement. Defaults to false. This setting is read by
506 <citerefentry><refentrytitle>systemd-resolved.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
507 </para>
508
509 <xi:include href="version-info.xml" xpointer="v229"/>
510 </listitem>
511 </varlistentry>
512
513 <varlistentry>
514 <term><varname>DNSOverTLS=</varname></term>
515 <listitem>
516 <para>Takes a boolean or <literal>opportunistic</literal>. When true, enables
517 <ulink url="https://tools.ietf.org/html/rfc7858">DNS-over-TLS</ulink> support on the link.
518 When set to <literal>opportunistic</literal>, compatibility with non-DNS-over-TLS servers is
519 increased, by automatically turning off DNS-over-TLS servers in this case. This option
520 defines a per-interface setting for
521 <citerefentry><refentrytitle>resolved.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>'s
522 global <varname>DNSOverTLS=</varname> option. Defaults to unset, and the global setting will
523 be used. This setting is read by
524 <citerefentry><refentrytitle>systemd-resolved.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
525 </para>
526
527 <xi:include href="version-info.xml" xpointer="v239"/>
528 </listitem>
529 </varlistentry>
530
531 <varlistentry>
532 <term><varname>DNSSEC=</varname></term>
533 <listitem>
534 <para>Takes a boolean or <literal>allow-downgrade</literal>. When true, enables
535 <ulink url="https://tools.ietf.org/html/rfc4033">DNSSEC</ulink> DNS validation support on the
536 link. When set to <literal>allow-downgrade</literal>, compatibility with non-DNSSEC capable
537 networks is increased, by automatically turning off DNSSEC in this case. This option defines
538 a per-interface setting for
539 <citerefentry><refentrytitle>resolved.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>'s
540 global <varname>DNSSEC=</varname> option. Defaults to unset, and the global setting will be
541 used. This setting is read by
542 <citerefentry><refentrytitle>systemd-resolved.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
543 </para>
544
545 <xi:include href="version-info.xml" xpointer="v229"/>
546 </listitem>
547 </varlistentry>
548
549 <varlistentry>
550 <term><varname>DNSSECNegativeTrustAnchors=</varname></term>
551 <listitem>
552 <para>A space-separated list of DNSSEC negative trust anchor domains. If specified and DNSSEC
553 is enabled, look-ups done via the interface's DNS server will be subject to the list of
554 negative trust anchors, and not require authentication for the specified domains, or anything
555 below it. Use this to disable DNSSEC authentication for specific private domains, that cannot
556 be proven valid using the Internet DNS hierarchy. Defaults to the empty list. This setting is
557 read by
558 <citerefentry><refentrytitle>systemd-resolved.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
559 </para>
560
561 <xi:include href="version-info.xml" xpointer="v229"/>
562 </listitem>
563 </varlistentry>
564
565 <varlistentry>
566 <term><varname>LLDP=</varname></term>
567 <listitem>
568 <para>Controls support for Ethernet LLDP packet reception. LLDP is a link-layer protocol
569 commonly implemented on professional routers and bridges which announces which physical port
570 a system is connected to, as well as other related data. Accepts a boolean or the special
571 value <literal>routers-only</literal>. When true, incoming LLDP packets are accepted and a
572 database of all LLDP neighbors maintained. If <literal>routers-only</literal> is set only
573 LLDP data of various types of routers is collected and LLDP data about other types of devices
574 ignored (such as stations, telephones and others). If false, LLDP reception is disabled.
575 Defaults to <literal>routers-only</literal>. Use
576 <citerefentry><refentrytitle>networkctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>
577 to query the collected neighbor data. LLDP is only available on Ethernet links. See
578 <varname>EmitLLDP=</varname> below for enabling LLDP packet emission from the local system.
579 </para>
580
581 <xi:include href="version-info.xml" xpointer="v219"/>
582 </listitem>
583 </varlistentry>
584
585 <varlistentry>
586 <term><varname>EmitLLDP=</varname></term>
587 <listitem>
588 <para>Controls support for Ethernet LLDP packet emission. Accepts a boolean parameter or the
589 special values <literal>nearest-bridge</literal>, <literal>non-tpmr-bridge</literal> and
590 <literal>customer-bridge</literal>. Defaults to false, which turns off LLDP packet emission.
591 If not false, a short LLDP packet with information about the local system is sent out in
592 regular intervals on the link. The LLDP packet will contain information about the local
593 hostname, the local machine ID (as stored in
594 <citerefentry><refentrytitle>machine-id</refentrytitle><manvolnum>5</manvolnum></citerefentry>)
595 and the local interface name, as well as the pretty hostname of the system (as set in
596 <citerefentry><refentrytitle>machine-info</refentrytitle><manvolnum>5</manvolnum></citerefentry>).
597 LLDP emission is only available on Ethernet links. Note that this setting passes data
598 suitable for identification of host to the network and should thus not be enabled on
599 untrusted networks, where such identification data should not be made available. Use this
600 option to permit other systems to identify on which interfaces they are connected to this
601 system. The three special values control propagation of the LLDP packets. The
602 <literal>nearest-bridge</literal> setting permits propagation only to the nearest connected
603 bridge, <literal>non-tpmr-bridge</literal> permits propagation across Two-Port MAC Relays,
604 but not any other bridges, and <literal>customer-bridge</literal> permits propagation until
605 a customer bridge is reached. For details about these concepts, see
606 <ulink url="https://standards.ieee.org/findstds/standard/802.1AB-2016.html">IEEE 802.1AB-2016</ulink>.
607 Note that configuring this setting to true is equivalent to
608 <literal>nearest-bridge</literal>, the recommended and most restricted level of propagation.
609 See <varname>LLDP=</varname> above for an option to enable LLDP reception.</para>
610
611 <xi:include href="version-info.xml" xpointer="v230"/>
612 </listitem>
613 </varlistentry>
614
615 <varlistentry>
616 <term><varname>BindCarrier=</varname></term>
617 <listitem>
618 <para>A link name or a list of link names. When set, controls the behavior of the current
619 link. When all links in the list are in an operational down state, the current link is
620 brought down. When at least one link has carrier, the current interface is brought up.</para>
621
622 <para>This forces <varname>ActivationPolicy=</varname> to be set to <literal>bound</literal>.
623 </para>
624
625 <xi:include href="version-info.xml" xpointer="v220"/>
626 </listitem>
627 </varlistentry>
628
629 <varlistentry>
630 <term><varname>Address=</varname></term>
631 <listitem>
632 <para>A static IPv4 or IPv6 address and its prefix length, separated by a
633 <literal>/</literal> character. Specify this key more than once to configure several
634 addresses. The format of the address must be as described in
635 <citerefentry project='man-pages'><refentrytitle>inet_pton</refentrytitle><manvolnum>3</manvolnum></citerefentry>.
636 This is a short-hand for an [Address] section only containing an Address key (see below).
637 This option may be specified more than once.</para>
638
639 <para>If the specified address is <literal>0.0.0.0</literal> (for IPv4) or
640 <literal>::</literal> (for IPv6), a new address range of the requested size is automatically
641 allocated from a system-wide pool of unused ranges. Note that the prefix length must be equal
642 or larger than 8 for IPv4, and 64 for IPv6. The allocated range is checked against all
643 current network interfaces and all known network configuration files to avoid address range
644 conflicts. The default system-wide pool consists of 192.168.0.0/16, 172.16.0.0/12 and
645 10.0.0.0/8 for IPv4, and fd00::/8 for IPv6. This functionality is useful to manage a large
646 number of dynamically created network interfaces with the same network configuration and
647 automatic address range assignment.</para>
648 </listitem>
649 </varlistentry>
650
651 <varlistentry>
652 <term><varname>Gateway=</varname></term>
653 <listitem>
654 <para>The gateway address, which must be in the format described in
655 <citerefentry project='man-pages'><refentrytitle>inet_pton</refentrytitle><manvolnum>3</manvolnum></citerefentry>.
656 This is a short-hand for a [Route] section only containing a <varname>Gateway=</varname> key.
657 This option may be specified more than once.</para>
658 </listitem>
659 </varlistentry>
660
661 <varlistentry>
662 <term><varname>DNS=</varname></term>
663 <listitem>
664 <para>A DNS server address, which must be in the format described in
665 <citerefentry project='man-pages'><refentrytitle>inet_pton</refentrytitle><manvolnum>3</manvolnum></citerefentry>.
666 This option may be specified more than once. Each address can optionally take a port number
667 separated with <literal>:</literal>, a network interface name or index separated with
668 <literal>%</literal>, and a Server Name Indication (SNI) separated with <literal>#</literal>.
669 When IPv6 address is specified with a port number, then the address must be in the square
670 brackets. That is, the acceptable full formats are
671 <literal>111.222.333.444:9953%ifname#example.com</literal> for IPv4 and
672 <literal>[1111:2222::3333]:9953%ifname#example.com</literal> for IPv6. If an empty string is
673 assigned, then the all previous assignments are cleared. This setting is read by
674 <citerefentry><refentrytitle>systemd-resolved.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
675 </para>
676 </listitem>
677 </varlistentry>
678
679 <varlistentry>
680 <term><varname>Domains=</varname></term>
681 <listitem>
682 <para>A whitespace-separated list of domains which should be resolved using the DNS servers
683 on this link. Each item in the list should be a domain name, optionally prefixed with a tilde
684 (<literal>~</literal>). The domains with the prefix are called "routing-only domains". The
685 domains without the prefix are called "search domains" and are first used as search suffixes
686 for extending single-label hostnames (hostnames containing no dots) to become fully qualified
687 domain names (FQDNs). If a single-label hostname is resolved on this interface, each of the
688 specified search domains are appended to it in turn, converting it into a fully qualified
689 domain name, until one of them may be successfully resolved.</para>
690
691 <para>Both "search" and "routing-only" domains are used for routing of DNS queries: look-ups
692 for hostnames ending in those domains (hence also single label names, if any "search domains"
693 are listed), are routed to the DNS servers configured for this interface. The domain routing
694 logic is particularly useful on multi-homed hosts with DNS servers serving particular private
695 DNS zones on each interface.</para>
696
697 <para>The "routing-only" domain <literal>~.</literal> (the tilde indicating definition of a
698 routing domain, the dot referring to the DNS root domain which is the implied suffix of all
699 valid DNS names) has special effect. It causes all DNS traffic which does not match another
700 configured domain routing entry to be routed to DNS servers specified for this interface.
701 This setting is useful to prefer a certain set of DNS servers if a link on which they are
702 connected is available.</para>
703
704 <para>This setting is read by
705 <citerefentry><refentrytitle>systemd-resolved.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
706 "Search domains" correspond to the <varname>domain</varname> and <varname>search</varname>
707 entries in
708 <citerefentry project='man-pages'><refentrytitle>resolv.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
709 Domain name routing has no equivalent in the traditional glibc API, which has no concept of
710 domain name servers limited to a specific link.</para>
711
712 <xi:include href="version-info.xml" xpointer="v216"/>
713 </listitem>
714 </varlistentry>
715
716 <varlistentry>
717 <term><varname>DNSDefaultRoute=</varname></term>
718 <listitem>
719 <para>Takes a boolean argument. If true, this link's configured DNS servers are used for
720 resolving domain names that do not match any link's configured <varname>Domains=</varname>
721 setting. If false, this link's configured DNS servers are never used for such domains, and
722 are exclusively used for resolving names that match at least one of the domains configured on
723 this link. If not specified defaults to an automatic mode: queries not matching any link's
724 configured domains will be routed to this link if it has no routing-only domains configured.
725 </para>
726
727 <xi:include href="version-info.xml" xpointer="v240"/>
728 </listitem>
729 </varlistentry>
730
731 <varlistentry>
732 <term><varname>NTP=</varname></term>
733 <listitem>
734 <para>An NTP server address (either an IP address, or a hostname). This option may be
735 specified more than once. This setting is read by
736 <citerefentry><refentrytitle>systemd-timesyncd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
737 </para>
738
739 <xi:include href="version-info.xml" xpointer="v216"/>
740 </listitem>
741 </varlistentry>
742
743 <varlistentry>
744 <term><varname>IPForward=</varname></term>
745 <listitem>
746 <para>Configures IP packet forwarding for the system. If enabled, incoming packets on any
747 network interface will be forwarded to any other interfaces according to the routing table.
748 Takes a boolean, or the values <literal>ipv4</literal> or <literal>ipv6</literal>, which only
749 enable IP packet forwarding for the specified address family. This controls the
750 <filename>net.ipv4.ip_forward</filename> and <filename>net.ipv6.conf.all.forwarding</filename>
751 sysctl options of the network interface (see
752 <ulink url="https://docs.kernel.org/networking/ip-sysctl.html">IP Sysctl</ulink>
753 for details about sysctl options). Defaults to <literal>no</literal>.</para>
754
755 <para>Note: this setting controls a global kernel option, and does so one way only: if a
756 network that has this setting enabled is set up the global setting is turned on. However,
757 it is never turned off again, even after all networks with this setting enabled are shut
758 down again.</para>
759
760 <para>To allow IP packet forwarding only between specific network interfaces use a firewall.
761 </para>
762
763 <xi:include href="version-info.xml" xpointer="v219"/>
764 </listitem>
765 </varlistentry>
766
767 <varlistentry>
768 <term><varname>IPMasquerade=</varname></term>
769 <listitem>
770 <para>Configures IP masquerading for the network interface. If enabled, packets forwarded
771 from the network interface will be appear as coming from the local host. Takes one of
772 <literal>ipv4</literal>, <literal>ipv6</literal>, <literal>both</literal>, or
773 <literal>no</literal>. Defaults to <literal>no</literal>. If enabled, this automatically sets
774 <varname>IPForward=</varname> to one of <literal>ipv4</literal>, <literal>ipv6</literal> or
775 <literal>yes</literal>.</para>
776 <para>Note. Any positive boolean values such as <literal>yes</literal> or
777 <literal>true</literal> are now deprecated. Please use one of the values in the above.</para>
778
779 <xi:include href="version-info.xml" xpointer="v219"/>
780 </listitem>
781 </varlistentry>
782
783 <varlistentry>
784 <term><varname>IPv6PrivacyExtensions=</varname></term>
785 <listitem>
786 <para>Configures use of stateless temporary addresses that change over time (see
787 <ulink url="https://tools.ietf.org/html/rfc4941">RFC 4941</ulink>,
788 Privacy Extensions for Stateless Address Autoconfiguration in IPv6). Takes a boolean or the
789 special values <literal>prefer-public</literal> and <literal>kernel</literal>. When true,
790 enables the privacy extensions and prefers temporary addresses over public addresses. When
791 <literal>prefer-public</literal>, enables the privacy extensions, but prefers public
792 addresses over temporary addresses. When false, the privacy extensions remain disabled. When
793 <literal>kernel</literal>, the kernel's default setting will be left in place. When unspecified,
794 the value specified in the same setting in
795 <citerefentry><refentrytitle>networkd.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
796 which defaults to <literal>no</literal>, will be used.</para>
797
798 <xi:include href="version-info.xml" xpointer="v222"/>
799 </listitem>
800 </varlistentry>
801
802 <varlistentry>
803 <term><varname>IPv6AcceptRA=</varname></term>
804 <listitem>
805 <para>Takes a boolean. Controls IPv6 Router Advertisement (RA) reception support for the
806 interface. If true, RAs are accepted; if false, RAs are ignored. When RAs are accepted, they
807 may trigger the start of the DHCPv6 client if the relevant flags are set in the RA data, or
808 if no routers are found on the link. The default is to disable RA reception for bridge
809 devices or when IP forwarding is enabled, and to enable it otherwise. Cannot be enabled on
810 devices aggregated in a bond device or when link-local addressing is disabled.</para>
811
812 <para>Further settings for the IPv6 RA support may be configured in the [IPv6AcceptRA]
813 section, see below.</para>
814
815 <para>Also see
816 <ulink url="https://docs.kernel.org/networking/ip-sysctl.html">IP Sysctl</ulink>
817 in the kernel documentation regarding <literal>accept_ra</literal>, but note that systemd's
818 setting of <constant>1</constant> (i.e. true) corresponds to kernel's setting of
819 <constant>2</constant>.</para>
820
821 <para>Note that kernel's implementation of the IPv6 RA protocol is always disabled,
822 regardless of this setting. If this option is enabled, a userspace implementation of the IPv6
823 RA protocol is used, and the kernel's own implementation remains disabled, since
824 <command>systemd-networkd</command> needs to know all details supplied in the advertisements,
825 and these are not available from the kernel if the kernel's own implementation is used.
826 </para>
827
828 <xi:include href="version-info.xml" xpointer="v231"/>
829 </listitem>
830 </varlistentry>
831
832 <varlistentry>
833 <term><varname>IPv6DuplicateAddressDetection=</varname></term>
834 <listitem>
835 <para>Configures the amount of IPv6 Duplicate Address Detection (DAD) probes to send. When
836 unset, the kernel's default will be used.</para>
837
838 <xi:include href="version-info.xml" xpointer="v228"/>
839 </listitem>
840 </varlistentry>
841
842 <varlistentry>
843 <term><varname>IPv6HopLimit=</varname></term>
844 <listitem>
845 <para>Configures IPv6 Hop Limit. For each router that forwards the packet, the hop limit is
846 decremented by 1. When the hop limit field reaches zero, the packet is discarded. When unset,
847 the kernel's default will be used.</para>
848
849 <xi:include href="version-info.xml" xpointer="v228"/>
850 </listitem>
851 </varlistentry>
852
853 <varlistentry>
854 <term><varname>IPv4ReversePathFilter=</varname></term>
855 <listitem>
856 <para>Configure IPv4 Reverse Path Filtering. If enabled, when an IPv4 packet is received, the machine will first check
857 whether the <emphasis>source</emphasis> of the packet would be routed through the interface it came in. If there is no
858 route to the source on that interface, the machine will drop the packet. Takes one of
859 <literal>no</literal>, <literal>strict</literal>, or <literal>loose</literal>. When <literal>no</literal>,
860 no source validation will be done. When <literal>strict</literal>, mode each incoming packet is tested against the FIB and
861 if the incoming interface is not the best reverse path, the packet check will fail. By default failed packets are discarded.
862 When <literal>loose</literal>, mode each incoming packet's source address is tested against the FIB. The packet is dropped
863 only if the source address is not reachable via any interface on that router.
864 See <ulink url="https://tools.ietf.org/html/rfc1027">RFC 3704</ulink>.
865 When unset, the kernel's default will be used.</para>
866
867 <xi:include href="version-info.xml" xpointer="v255"/>
868 </listitem>
869 </varlistentry>
870
871 <varlistentry>
872 <term><varname>IPv4AcceptLocal=</varname></term>
873 <listitem>
874 <para>Takes a boolean. Accept packets with local source addresses. In combination with
875 suitable routing, this can be used to direct packets between two local interfaces over the
876 wire and have them accepted properly. When unset, the kernel's default will be used.</para>
877
878 <xi:include href="version-info.xml" xpointer="v246"/>
879 </listitem>
880 </varlistentry>
881
882 <varlistentry>
883 <term><varname>IPv4RouteLocalnet=</varname></term>
884 <listitem>
885 <para>Takes a boolean. When true, the kernel does not consider loopback addresses as martian
886 source or destination while routing. This enables the use of 127.0.0.0/8 for local routing
887 purposes. When unset, the kernel's default will be used.</para>
888
889 <xi:include href="version-info.xml" xpointer="v248"/>
890 </listitem>
891 </varlistentry>
892
893 <varlistentry>
894 <term><varname>IPv4ProxyARP=</varname></term>
895 <listitem>
896 <para>Takes a boolean. Configures proxy ARP for IPv4. Proxy ARP is the technique in which one
897 host, usually a router, answers ARP requests intended for another machine. By "faking" its
898 identity, the router accepts responsibility for routing packets to the "real" destination.
899 See <ulink url="https://tools.ietf.org/html/rfc1027">RFC 1027</ulink>. When unset, the
900 kernel's default will be used.</para>
901
902 <xi:include href="version-info.xml" xpointer="v233"/>
903 </listitem>
904 </varlistentry>
905
906 <varlistentry>
907 <term><varname>IPv6ProxyNDP=</varname></term>
908 <listitem>
909 <para>Takes a boolean. Configures proxy NDP for IPv6. Proxy NDP (Neighbor Discovery Protocol)
910 is a technique for IPv6 to allow routing of addresses to a different destination when peers
911 expect them to be present on a certain physical link. In this case a router answers Neighbour
912 Advertisement messages intended for another machine by offering its own MAC address as
913 destination. Unlike proxy ARP for IPv4, it is not enabled globally, but will only send
914 Neighbour Advertisement messages for addresses in the IPv6 neighbor proxy table, which can
915 also be shown by <command>ip -6 neighbour show proxy</command>. systemd-networkd will control
916 the per-interface `proxy_ndp` switch for each configured interface depending on this option.
917 When unset, the kernel's default will be used.</para>
918
919 <xi:include href="version-info.xml" xpointer="v234"/>
920 </listitem>
921 </varlistentry>
922
923 <varlistentry>
924 <term><varname>IPv6ProxyNDPAddress=</varname></term>
925 <listitem>
926 <para>An IPv6 address, for which Neighbour Advertisement messages will be proxied. This
927 option may be specified more than once. systemd-networkd will add the
928 <varname>IPv6ProxyNDPAddress=</varname> entries to the kernel's IPv6 neighbor proxy table.
929 This setting implies <varname>IPv6ProxyNDP=yes</varname> but has no effect if
930 <varname>IPv6ProxyNDP=</varname> has been set to false. When unset, the kernel's default will
931 be used.</para>
932
933 <xi:include href="version-info.xml" xpointer="v233"/>
934 </listitem>
935 </varlistentry>
936
937 <varlistentry>
938 <term><varname>IPv6SendRA=</varname></term>
939 <listitem>
940 <para>Whether to enable or disable Router Advertisement sending on a link. Takes a boolean
941 value. When enabled, prefixes configured in [IPv6Prefix] sections and routes configured in
942 the [IPv6RoutePrefix] sections are distributed as defined in the [IPv6SendRA] section. If
943 <varname>DHCPPrefixDelegation=</varname> is enabled, then the delegated prefixes are also
944 distributed. See <varname>DCHPPrefixDelegation=</varname> setting and the [IPv6SendRA],
945 [IPv6Prefix], [IPv6RoutePrefix], and [DHCPPrefixDelegation] sections for more configuration
946 options.</para>
947
948 <xi:include href="version-info.xml" xpointer="v247"/>
949 </listitem>
950 </varlistentry>
951
952 <varlistentry>
953 <term><varname>DHCPPrefixDelegation=</varname></term>
954 <listitem>
955 <para>Takes a boolean value. When enabled, requests subnet prefixes on another link via the DHCPv6
956 protocol or via the 6RD option in the DHCPv4 protocol. An address within each delegated prefix will
957 be assigned, and the prefixes will be announced through IPv6 Router Advertisement if
958 <varname>IPv6SendRA=</varname> is enabled. This behaviour can be configured in the
959 [DHCPPrefixDelegation] section. Defaults to disabled.</para>
960
961 <xi:include href="version-info.xml" xpointer="v250"/>
962 </listitem>
963 </varlistentry>
964
965 <varlistentry>
966 <term><varname>IPv6MTUBytes=</varname></term>
967 <listitem>
968 <para>Configures IPv6 maximum transmission unit (MTU). An integer greater than or equal to
969 1280 bytes. When unset, the kernel's default will be used.</para>
970
971 <xi:include href="version-info.xml" xpointer="v239"/>
972 </listitem>
973 </varlistentry>
974
975 <varlistentry>
976 <term><varname>KeepMaster=</varname></term>
977 <listitem>
978 <para>Takes a boolean value. When enabled, the current master interface index will not be
979 changed, and <varname>BatmanAdvanced=</varname>, <varname>Bond=</varname>,
980 <varname>Bridge=</varname>, and <varname>VRF=</varname> settings are ignored. This may be
981 useful when a netdev with a master interface is created by another program, e.g.
982 <citerefentry><refentrytitle>systemd-nspawn</refentrytitle><manvolnum>1</manvolnum></citerefentry>.
983 Defaults to false.</para>
984
985 <xi:include href="version-info.xml" xpointer="v250"/>
986 </listitem>
987 </varlistentry>
988
989 <varlistentry>
990 <term><varname>BatmanAdvanced=</varname></term>
991 <term><varname>Bond=</varname></term>
992 <term><varname>Bridge=</varname></term>
993 <term><varname>VRF=</varname></term>
994 <listitem>
995 <para>The name of the B.A.T.M.A.N. Advanced, bond, bridge, or VRF interface to add the link
996 to. See
997 <citerefentry><refentrytitle>systemd.netdev</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
998 </para>
999 </listitem>
1000 </varlistentry>
1001
1002 <varlistentry>
1003 <term><varname>IPoIB=</varname></term>
1004 <term><varname>IPVLAN=</varname></term>
1005 <term><varname>IPVTAP=</varname></term>
1006 <term><varname>MACsec=</varname></term>
1007 <term><varname>MACVLAN=</varname></term>
1008 <term><varname>MACVTAP=</varname></term>
1009 <term><varname>Tunnel=</varname></term>
1010 <term><varname>VLAN=</varname></term>
1011 <term><varname>VXLAN=</varname></term>
1012 <term><varname>Xfrm=</varname></term>
1013 <listitem>
1014 <para>The name of an IPoIB, IPVLAN, IPVTAP, MACsec, MACVLAN, MACVTAP, tunnel, VLAN,
1015 VXLAN, or Xfrm to be created on the link. See
1016 <citerefentry><refentrytitle>systemd.netdev</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
1017 This option may be specified more than once.</para>
1018 </listitem>
1019 </varlistentry>
1020
1021 <varlistentry>
1022 <term><varname>ActiveSlave=</varname></term>
1023 <listitem>
1024 <para>Takes a boolean. Specifies the new active slave. The <literal>ActiveSlave=</literal>
1025 option is only valid for following modes: <literal>active-backup</literal>,
1026 <literal>balance-alb</literal>, and <literal>balance-tlb</literal>. Defaults to false.</para>
1027
1028 <xi:include href="version-info.xml" xpointer="v235"/>
1029 </listitem>
1030 </varlistentry>
1031
1032 <varlistentry>
1033 <term><varname>PrimarySlave=</varname></term>
1034 <listitem>
1035 <para>Takes a boolean. Specifies which slave is the primary device. The specified device will
1036 always be the active slave while it is available. Only when the primary is off-line will
1037 alternate devices be used. This is useful when one slave is preferred over another, e.g.
1038 when one slave has higher throughput than another. The <literal>PrimarySlave=</literal>
1039 option is only valid for following modes: <literal>active-backup</literal>,
1040 <literal>balance-alb</literal>, and <literal>balance-tlb</literal>. Defaults to false.</para>
1041
1042 <xi:include href="version-info.xml" xpointer="v235"/>
1043 </listitem>
1044 </varlistentry>
1045
1046 <varlistentry>
1047 <term><varname>ConfigureWithoutCarrier=</varname></term>
1048 <listitem>
1049 <para>Takes a boolean. Allows networkd to configure a specific link even if it has no
1050 carrier. Defaults to false. If enabled, and the <varname>IgnoreCarrierLoss=</varname> setting
1051 is not explicitly set, then it is enabled as well.</para>
1052
1053 <xi:include href="version-info.xml" xpointer="v235"/>
1054 </listitem>
1055 </varlistentry>
1056
1057 <varlistentry>
1058 <term><varname>IgnoreCarrierLoss=</varname></term>
1059 <listitem>
1060 <para>Takes a boolean or a timespan. When true, <command>systemd-networkd</command> retains
1061 both the static and dynamic configuration of the interface even if its carrier is lost. When
1062 false, <command>systemd-networkd</command> drops both the static and dynamic configuration of
1063 the interface. When a timespan is specified, <command>systemd-networkd</command> waits for
1064 the specified timespan, and ignores the carrier loss if the link regain its carrier within
1065 the timespan. Setting 0 seconds is equivalent to <literal>no</literal>, and
1066 <literal>infinite</literal> is equivalent to <literal>yes</literal>.</para>
1067
1068 <para>Setting a finite timespan may be useful when e.g. in the following cases:
1069 <itemizedlist>
1070 <listitem>
1071 <para>A wireless interface connecting to a network which has multiple access points with
1072 the same SSID.</para>
1073 </listitem>
1074 <listitem>
1075 <para>Enslaving a wireless interface to a bond interface, which may disconnect from the
1076 connected access point and causes its carrier to be lost.</para>
1077 </listitem>
1078 <listitem>
1079 <para>The driver of the interface resets when the MTU is changed.</para>
1080 </listitem>
1081 </itemizedlist>
1082 </para>
1083
1084 <para>When <varname>Bond=</varname> is specified to a wireless interface, defaults to 3
1085 seconds. When the DHCPv4 client is enabled and <varname>UseMTU=</varname> in the [DHCPv4]
1086 section enabled, defaults to 5 seconds. Otherwise, defaults to the value specified with
1087 <varname>ConfigureWithoutCarrier=</varname>. When <varname>ActivationPolicy=</varname> is set
1088 to <literal>always-up</literal>, this is forced to <literal>yes</literal>, and ignored any
1089 user specified values.</para>
1090
1091 <xi:include href="version-info.xml" xpointer="v242"/>
1092 </listitem>
1093 </varlistentry>
1094
1095 <varlistentry>
1096 <term><varname>KeepConfiguration=</varname></term>
1097 <listitem>
1098 <para>Takes a boolean or one of <literal>static</literal>, <literal>dhcp-on-stop</literal>,
1099 <literal>dhcp</literal>. When <literal>static</literal>, <command>systemd-networkd</command>
1100 will not drop static addresses and routes on starting up process. When set to
1101 <literal>dhcp-on-stop</literal>, <command>systemd-networkd</command> will not drop addresses
1102 and routes on stopping the daemon. When <literal>dhcp</literal>,
1103 the addresses and routes provided by a DHCP server will never be dropped even if the DHCP
1104 lease expires. This is contrary to the DHCP specification, but may be the best choice if,
1105 e.g., the root filesystem relies on this connection. The setting <literal>dhcp</literal>
1106 implies <literal>dhcp-on-stop</literal>, and <literal>yes</literal> implies
1107 <literal>dhcp</literal> and <literal>static</literal>. Defaults to
1108 <literal>dhcp-on-stop</literal> when <command>systemd-networkd</command> is running in
1109 initrd, <literal>yes</literal> when the root filesystem is a network filesystem, and
1110 <literal>no</literal> otherwise.</para>
1111
1112 <xi:include href="version-info.xml" xpointer="v243"/>
1113 </listitem>
1114 </varlistentry>
1115 </variablelist>
1116 </refsect1>
1117
1118 <refsect1>
1119 <title>[Address] Section Options</title>
1120
1121 <para>An [Address] section accepts the following keys. Specify several [Address] sections to
1122 configure several addresses.</para>
1123
1124 <variablelist class='network-directives'>
1125 <varlistentry>
1126 <term><varname>Address=</varname></term>
1127 <listitem>
1128 <para>As in the [Network] section. This setting is mandatory. Each [Address] section can
1129 contain one <varname>Address=</varname> setting.</para>
1130
1131 <xi:include href="version-info.xml" xpointer="v215"/>
1132 </listitem>
1133 </varlistentry>
1134
1135 <varlistentry>
1136 <term><varname>Peer=</varname></term>
1137 <listitem>
1138 <para>The peer address in a point-to-point connection. Accepts the same format as the
1139 <varname>Address=</varname> setting.</para>
1140
1141 <xi:include href="version-info.xml" xpointer="v216"/>
1142 </listitem>
1143 </varlistentry>
1144
1145 <varlistentry>
1146 <term><varname>Broadcast=</varname></term>
1147 <listitem>
1148 <para>Takes an IPv4 address or boolean value. The address must be in the format described in
1149 <citerefentry project='man-pages'><refentrytitle>inet_pton</refentrytitle><manvolnum>3</manvolnum></citerefentry>.
1150 If set to true, then the IPv4 broadcast address will be derived from the
1151 <varname>Address=</varname> setting. If set to false, then the broadcast address will not be
1152 set. Defaults to true, except for wireguard interfaces, where it default to false.</para>
1153 </listitem>
1154 </varlistentry>
1155
1156 <varlistentry>
1157 <term><varname>Label=</varname></term>
1158 <listitem>
1159 <para>Specifies the label for the IPv4 address. The label must be a 7-bit ASCII string with
1160 a length of 1…15 characters. Defaults to unset.</para>
1161 </listitem>
1162 </varlistentry>
1163
1164 <varlistentry>
1165 <term><varname>PreferredLifetime=</varname></term>
1166 <listitem>
1167 <para>Allows the default "preferred lifetime" of the address to be overridden. Only three
1168 settings are accepted: <literal>forever</literal>, <literal>infinity</literal>, which is the
1169 default and means that the address never expires, and <literal>0</literal>, which means that
1170 the address is considered immediately "expired" and will not be used, unless explicitly
1171 requested. A setting of <option>PreferredLifetime=0</option> is useful for addresses which
1172 are added to be used only by a specific application, which is then configured to use them
1173 explicitly.</para>
1174
1175 <xi:include href="version-info.xml" xpointer="v230"/>
1176 </listitem>
1177 </varlistentry>
1178
1179 <varlistentry>
1180 <term><varname>Scope=</varname></term>
1181 <listitem>
1182 <para>The scope of the address, which can be <literal>global</literal> (valid everywhere on
1183 the network, even through a gateway), <literal>link</literal> (only valid on this device,
1184 will not traverse a gateway) or <literal>host</literal> (only valid within the device itself,
1185 e.g. 127.0.0.1) or an integer in the range 0…255. Defaults to <literal>global</literal>.
1186 </para>
1187
1188 <xi:include href="version-info.xml" xpointer="v235"/>
1189 </listitem>
1190 </varlistentry>
1191
1192 <varlistentry>
1193 <term><varname>RouteMetric=</varname></term>
1194 <listitem>
1195 <para>The metric of the prefix route, which is pointing to the subnet of the configured IP
1196 address, taking the configured prefix length into account. Takes an unsigned integer in the
1197 range 0…4294967295. When unset or set to 0, the kernel's default value is used. This
1198 setting will be ignored when <varname>AddPrefixRoute=</varname> is false.</para>
1199 </listitem>
1200 </varlistentry>
1201
1202 <varlistentry>
1203 <term><varname>HomeAddress=</varname></term>
1204 <listitem>
1205 <para>Takes a boolean. Designates this address the "home address" as defined in
1206 <ulink url="https://tools.ietf.org/html/rfc6275">RFC 6275</ulink>. Supported only on IPv6.
1207 Defaults to false.</para>
1208
1209 <xi:include href="version-info.xml" xpointer="v232"/>
1210 </listitem>
1211 </varlistentry>
1212
1213 <varlistentry>
1214 <term><varname>DuplicateAddressDetection=</varname></term>
1215 <listitem>
1216 <para>Takes one of <literal>ipv4</literal>, <literal>ipv6</literal>, <literal>both</literal>,
1217 or <literal>none</literal>. When <literal>ipv4</literal>, performs IPv4 Address Conflict
1218 Detection. See <ulink url="https://tools.ietf.org/html/rfc5227">RFC 5227</ulink>.
1219 When <literal>ipv6</literal>, performs IPv6 Duplicate Address Detection. See
1220 <ulink url="https://tools.ietf.org/html/rfc4862">RFC 4862</ulink>. Defaults to
1221 <literal>ipv4</literal> for IPv4 link-local addresses, <literal>ipv6</literal> for IPv6
1222 addresses, and <literal>none</literal> otherwise.</para>
1223
1224 <xi:include href="version-info.xml" xpointer="v232"/>
1225 </listitem>
1226 </varlistentry>
1227
1228 <varlistentry>
1229 <term><varname>ManageTemporaryAddress=</varname></term>
1230 <listitem>
1231 <para>Takes a boolean. If true the kernel manage temporary addresses created from this one as
1232 template on behalf of Privacy Extensions
1233 <ulink url="https://tools.ietf.org/html/rfc3041">RFC 3041</ulink>. For this to become active,
1234 the use_tempaddr sysctl setting has to be set to a value greater than zero. The given address
1235 needs to have a prefix length of 64. This flag allows using privacy extensions in a manually
1236 configured network, just like if stateless auto-configuration was active. Defaults to false.
1237 </para>
1238
1239 <xi:include href="version-info.xml" xpointer="v232"/>
1240 </listitem>
1241 </varlistentry>
1242
1243 <varlistentry>
1244 <term><varname>AddPrefixRoute=</varname></term>
1245 <listitem>
1246 <para>Takes a boolean. When true, the prefix route for the address is automatically added.
1247 Defaults to true.</para>
1248
1249 <xi:include href="version-info.xml" xpointer="v245"/>
1250 </listitem>
1251 </varlistentry>
1252
1253 <varlistentry>
1254 <term><varname>AutoJoin=</varname></term>
1255 <listitem>
1256 <para>Takes a boolean. Joining multicast group on ethernet level via
1257 <command>ip maddr</command> command would not work if we have an Ethernet switch that does
1258 IGMP snooping since the switch would not replicate multicast packets on ports that did not
1259 have IGMP reports for the multicast addresses. Linux vxlan interfaces created via
1260 <command>ip link add vxlan</command> or networkd's netdev kind vxlan have the group option
1261 that enables them to do the required join. By extending <command>ip address</command> command
1262 with option <literal>autojoin</literal> we can get similar functionality for openvswitch (OVS)
1263 vxlan interfaces as well as other tunneling mechanisms that need to receive multicast traffic.
1264 Defaults to <literal>no</literal>.</para>
1265
1266 <xi:include href="version-info.xml" xpointer="v232"/>
1267 </listitem>
1268 </varlistentry>
1269
1270 <varlistentry>
1271 <term><varname>NetLabel=</varname><replaceable>label</replaceable></term>
1272 <listitem>
1273
1274 <para>This setting provides a method for integrating static and dynamic network configuration into
1275 Linux <ulink url="https://docs.kernel.org/netlabel/index.html">NetLabel</ulink> subsystem rules,
1276 used by <ulink url="https://en.wikipedia.org/wiki/Linux_Security_Modules">Linux Security Modules
1277 (LSMs)</ulink> for network access control. The label, with suitable LSM rules, can be used to
1278 control connectivity of (for example) a service with peers in the local network. At least with
1279 SELinux, only the ingress can be controlled but not egress. The benefit of using this setting is
1280 that it may be possible to apply interface independent part of NetLabel configuration at very early
1281 stage of system boot sequence, at the time when the network interfaces are not available yet, with
1282 <citerefentry
1283 project='man-pages'><refentrytitle>netlabelctl</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
1284 and the per-interface configuration with <command>systemd-networkd</command> once the interfaces
1285 appear later. Currently this feature is only implemented for SELinux.</para>
1286
1287 <para>The option expects a single NetLabel label. The label must conform to lexical restrictions of
1288 LSM labels. When an interface is configured with IP addresses, the addresses and subnetwork masks
1289 will be appended to the <ulink
1290 url="https://github.com/SELinuxProject/selinux-notebook/blob/main/src/network_support.md">NetLabel
1291 Fallback Peer Labeling</ulink> rules. They will be removed when the interface is
1292 deconfigured. Failures to manage the labels will be ignored.</para>
1293
1294 <para>Warning: Once labeling is enabled for network traffic, a lot of LSM access control points in
1295 Linux networking stack go from dormant to active. Care should be taken to avoid getting into a
1296 situation where for example remote connectivity is broken, when the security policy hasn't been
1297 updated to consider LSM per-packet access controls and no rules would allow any network
1298 traffic. Also note that additional configuration with <citerefentry
1299 project='man-pages'><refentrytitle>netlabelctl</refentrytitle><manvolnum>8</manvolnum></citerefentry>
1300 is needed.</para>
1301
1302 <para>Example:
1303 <programlisting>[Address]
1304 NetLabel=system_u:object_r:localnet_peer_t:s0</programlisting>
1305
1306 With the example rules applying for interface <literal>eth0</literal>, when the interface is
1307 configured with an IPv4 address of 10.0.0.123/8, <command>systemd-networkd</command> performs the
1308 equivalent of <command>netlabelctl</command> operation
1309
1310 <programlisting>netlabelctl unlbl add interface eth0 address:10.0.0.0/8 label:system_u:object_r:localnet_peer_t:s0</programlisting>
1311
1312 and the reverse operation when the IPv4 address is deconfigured. The configuration can be used with
1313 LSM rules; in case of SELinux to allow a SELinux domain to receive data from objects of SELinux
1314 <literal>peer</literal> class. For example:
1315
1316 <programlisting>type localnet_peer_t;
1317 allow my_server_t localnet_peer_t:peer recv;</programlisting>
1318
1319 The effect of the above configuration and rules (in absence of other rules as may be the case) is
1320 to only allow <literal>my_server_t</literal> (and nothing else) to receive data from local subnet
1321 10.0.0.0/8 of interface <literal>eth0</literal>.
1322 </para>
1323
1324 <xi:include href="version-info.xml" xpointer="v252"/>
1325 </listitem>
1326 </varlistentry>
1327
1328 <varlistentry>
1329 <term><varname>NFTSet=</varname><replaceable>source</replaceable>:<replaceable>family</replaceable>:<replaceable>table</replaceable>:<replaceable>set</replaceable></term>
1330 <listitem>
1331 <para>This setting provides a method for integrating network configuration into firewall rules with
1332 <ulink url="https://netfilter.org/projects/nftables/index.html">NFT</ulink> sets. The benefit of
1333 using the setting is that static network configuration (or dynamically obtained network addresses,
1334 see similar directives in other sections) can be used in firewall rules with the indirection of NFT
1335 set types. For example, access could be granted for hosts in the local subnetwork only. Firewall
1336 rules using IP address of an interface are also instantly updated when the network configuration
1337 changes, for example via DHCP.</para>
1338
1339 <para>This option expects a whitespace separated list of NFT set definitions. Each definition
1340 consists of a colon-separated tuple of source type (one of <literal>address</literal>,
1341 <literal>prefix</literal> or <literal>ifindex</literal>), NFT address family (one of
1342 <literal>arp</literal>, <literal>bridge</literal>, <literal>inet</literal>, <literal>ip</literal>,
1343 <literal>ip6</literal>, or <literal>netdev</literal>), table name and set name. The names of tables
1344 and sets must conform to lexical restrictions of NFT table names. The type of the element used in
1345 the NFT filter must match the type implied by the directive (<literal>address</literal>,
1346 <literal>prefix</literal> or <literal>ifindex</literal>) and address type (IPv4 or IPv6) as shown
1347 in the table below.</para>
1348
1349 <table>
1350 <title>Defined <varname>source type</varname> values</title>
1351 <tgroup cols='3'>
1352 <colspec colname='source type'/>
1353 <colspec colname='description'/>
1354 <colspec colname='NFT type name'/>
1355 <thead>
1356 <row>
1357 <entry>Source type</entry>
1358 <entry>Description</entry>
1359 <entry>Corresponding NFT type name</entry>
1360 </row>
1361 </thead>
1362
1363 <tbody>
1364 <row>
1365 <entry><literal>address</literal></entry>
1366 <entry>host IP address</entry>
1367 <entry><literal>ipv4_addr</literal> or <literal>ipv6_addr</literal></entry>
1368 </row>
1369 <row>
1370 <entry><literal>prefix</literal></entry>
1371 <entry>network prefix</entry>
1372 <entry><literal>ipv4_addr</literal> or <literal>ipv6_addr</literal>, with <literal>flags interval</literal></entry>
1373 </row>
1374 <row>
1375 <entry><literal>ifindex</literal></entry>
1376 <entry>interface index</entry>
1377 <entry><literal>iface_index</literal></entry>
1378 </row>
1379 </tbody>
1380 </tgroup>
1381 </table>
1382
1383 <para>When an interface is configured with IP addresses, the addresses, subnetwork masks or
1384 interface index will be appended to the NFT sets. The information will be removed when the
1385 interface is deconfigured. <command>systemd-networkd</command> only inserts elements to (or removes
1386 from) the sets, so the related NFT rules, tables and sets must be prepared elsewhere in
1387 advance. Failures to manage the sets will be ignored.</para>
1388
1389 <para>Example:
1390 <programlisting>[Address]
1391 NFTSet=prefix:netdev:filter:eth_ipv4_prefix</programlisting>
1392 Corresponding NFT rules:
1393 <programlisting>table netdev filter {
1394 set eth_ipv4_prefix {
1395 type ipv4_addr
1396 flags interval
1397 }
1398 chain eth_ingress {
1399 type filter hook ingress device "eth0" priority filter; policy drop;
1400 ip daddr != @eth_ipv4_prefix drop
1401 accept
1402 }
1403 }</programlisting>
1404 </para>
1405
1406 <xi:include href="version-info.xml" xpointer="v255"/>
1407 </listitem>
1408 </varlistentry>
1409 </variablelist>
1410 </refsect1>
1411
1412 <refsect1>
1413 <title>[Neighbor] Section Options</title>
1414
1415 <para>A [Neighbor] section accepts the following keys. The neighbor section adds a permanent,
1416 static entry to the neighbor table (IPv6) or ARP table (IPv4) for the given hardware address on the
1417 links matched for the network. Specify several [Neighbor] sections to configure several static
1418 neighbors.</para>
1419
1420 <variablelist class='network-directives'>
1421 <varlistentry>
1422 <term><varname>Address=</varname></term>
1423 <listitem>
1424 <para>The IP address of the neighbor.</para>
1425
1426 <xi:include href="version-info.xml" xpointer="v240"/>
1427 </listitem>
1428 </varlistentry>
1429
1430 <varlistentry>
1431 <term><varname>LinkLayerAddress=</varname></term>
1432 <listitem>
1433 <para>The link layer address (MAC address or IP address) of the neighbor.</para>
1434
1435 <xi:include href="version-info.xml" xpointer="v243"/>
1436 </listitem>
1437 </varlistentry>
1438 </variablelist>
1439 </refsect1>
1440
1441 <refsect1>
1442 <title>[IPv6AddressLabel] Section Options</title>
1443
1444 <para>An [IPv6AddressLabel] section accepts the following keys. Specify several [IPv6AddressLabel]
1445 sections to configure several address labels. IPv6 address labels are used for address selection.
1446 See <ulink url="https://tools.ietf.org/html/rfc3484">RFC 3484</ulink>. Precedence is managed by
1447 userspace, and only the label itself is stored in the kernel.</para>
1448
1449 <variablelist class='network-directives'>
1450 <varlistentry>
1451 <term><varname>Label=</varname></term>
1452 <listitem>
1453 <para>The label for the prefix, an unsigned integer in the range 0…4294967294. 0xffffffff is
1454 reserved. This setting is mandatory.</para>
1455
1456 <xi:include href="version-info.xml" xpointer="v234"/>
1457 </listitem>
1458 </varlistentry>
1459
1460 <varlistentry>
1461 <term><varname>Prefix=</varname></term>
1462 <listitem>
1463 <para>IPv6 prefix is an address with a prefix length, separated by a slash
1464 <literal>/</literal> character. This setting is mandatory. </para>
1465
1466 <xi:include href="version-info.xml" xpointer="v234"/>
1467 </listitem>
1468 </varlistentry>
1469 </variablelist>
1470 </refsect1>
1471
1472 <refsect1>
1473 <title>[RoutingPolicyRule] Section Options</title>
1474
1475 <para>An [RoutingPolicyRule] section accepts the following settings. Specify several
1476 [RoutingPolicyRule] sections to configure several rules.</para>
1477
1478 <variablelist class='network-directives'>
1479 <varlistentry>
1480 <term><varname>TypeOfService=</varname></term>
1481 <listitem>
1482 <para>
1483 This specifies the Type of Service (ToS) field of packets to match;
1484 it takes an unsigned integer in the range 0…255.
1485 The field can be used to specify precedence (the first 3 bits) and ToS (the next 3 bits).
1486 The field can be also used to specify Differentiated Services Code Point (DSCP) (the first 6 bits) and
1487 Explicit Congestion Notification (ECN) (the last 2 bits).
1488 See <ulink url="https://en.wikipedia.org/wiki/Type_of_service">Type of Service</ulink>
1489 and <ulink url="https://en.wikipedia.org/wiki/Differentiated_services">Differentiated services</ulink>
1490 for more details.
1491 </para>
1492
1493 <xi:include href="version-info.xml" xpointer="v235"/>
1494 </listitem>
1495 </varlistentry>
1496
1497 <varlistentry>
1498 <term><varname>From=</varname></term>
1499 <listitem>
1500 <para>Specifies the source address prefix to match. Possibly followed by a slash and the
1501 prefix length.</para>
1502
1503 <xi:include href="version-info.xml" xpointer="v235"/>
1504 </listitem>
1505 </varlistentry>
1506
1507 <varlistentry>
1508 <term><varname>To=</varname></term>
1509 <listitem>
1510 <para>Specifies the destination address prefix to match. Possibly followed by a slash and the
1511 prefix length.</para>
1512
1513 <xi:include href="version-info.xml" xpointer="v235"/>
1514 </listitem>
1515 </varlistentry>
1516
1517 <varlistentry>
1518 <term><varname>FirewallMark=</varname></term>
1519 <listitem>
1520 <para>Specifies the iptables firewall mark value to match (a number in the range
1521 1…4294967295). Optionally, the firewall mask (also a number between 1…4294967295) can be
1522 suffixed with a slash (<literal>/</literal>), e.g., <literal>7/255</literal>.</para>
1523
1524 <xi:include href="version-info.xml" xpointer="v235"/>
1525 </listitem>
1526 </varlistentry>
1527
1528 <varlistentry>
1529 <term><varname>Table=</varname></term>
1530 <listitem>
1531 <para>Specifies the routing table identifier to look up if the rule selector matches. Takes
1532 one of predefined names <literal>default</literal>, <literal>main</literal>, and
1533 <literal>local</literal>, and names defined in <varname>RouteTable=</varname> in
1534 <citerefentry><refentrytitle>networkd.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
1535 or a number between 1 and 4294967295. Defaults to <literal>main</literal>.</para>
1536
1537 <xi:include href="version-info.xml" xpointer="v235"/>
1538 </listitem>
1539 </varlistentry>
1540
1541 <varlistentry>
1542 <term><varname>Priority=</varname></term>
1543 <listitem>
1544 <para>Specifies the priority of this rule. <varname>Priority=</varname> is an integer in the
1545 range 0…4294967295. Higher number means lower priority, and rules get processed in order of
1546 increasing number. Defaults to unset, and the kernel will pick a value dynamically.</para>
1547
1548 <xi:include href="version-info.xml" xpointer="v235"/>
1549 </listitem>
1550 </varlistentry>
1551
1552 <varlistentry>
1553 <term><varname>IncomingInterface=</varname></term>
1554 <listitem>
1555 <para>Specifies incoming device to match. If the interface is loopback, the rule only matches
1556 packets originating from this host.</para>
1557
1558 <xi:include href="version-info.xml" xpointer="v236"/>
1559 </listitem>
1560 </varlistentry>
1561
1562 <varlistentry>
1563 <term><varname>OutgoingInterface=</varname></term>
1564 <listitem>
1565 <para>Specifies the outgoing device to match. The outgoing interface is only available for
1566 packets originating from local sockets that are bound to a device.</para>
1567
1568 <xi:include href="version-info.xml" xpointer="v236"/>
1569 </listitem>
1570 </varlistentry>
1571
1572 <varlistentry>
1573 <term><varname>SourcePort=</varname></term>
1574 <listitem>
1575 <para>Specifies the source IP port or IP port range match in forwarding information base
1576 (FIB) rules. A port range is specified by the lower and upper port separated by a dash.
1577 Defaults to unset.</para>
1578
1579 <xi:include href="version-info.xml" xpointer="v240"/>
1580 </listitem>
1581 </varlistentry>
1582
1583 <varlistentry>
1584 <term><varname>DestinationPort=</varname></term>
1585 <listitem>
1586 <para>Specifies the destination IP port or IP port range match in forwarding information base
1587 (FIB) rules. A port range is specified by the lower and upper port separated by a dash.
1588 Defaults to unset.</para>
1589
1590 <xi:include href="version-info.xml" xpointer="v240"/>
1591 </listitem>
1592 </varlistentry>
1593
1594 <varlistentry>
1595 <term><varname>IPProtocol=</varname></term>
1596 <listitem>
1597 <para>Specifies the IP protocol to match in forwarding information base (FIB) rules. Takes IP
1598 protocol name such as <literal>tcp</literal>, <literal>udp</literal> or
1599 <literal>sctp</literal>, or IP protocol number such as <literal>6</literal> for
1600 <literal>tcp</literal> or <literal>17</literal> for <literal>udp</literal>. Defaults to unset.
1601 </para>
1602
1603 <xi:include href="version-info.xml" xpointer="v240"/>
1604 </listitem>
1605 </varlistentry>
1606
1607 <varlistentry>
1608 <term><varname>InvertRule=</varname></term>
1609 <listitem>
1610 <para>A boolean. Specifies whether the rule is to be inverted. Defaults to false.</para>
1611
1612 <xi:include href="version-info.xml" xpointer="v240"/>
1613 </listitem>
1614 </varlistentry>
1615
1616 <varlistentry>
1617 <term><varname>Family=</varname></term>
1618 <listitem>
1619 <para>Takes a special value <literal>ipv4</literal>, <literal>ipv6</literal>, or
1620 <literal>both</literal>. By default, the address family is determined by the address
1621 specified in <varname>To=</varname> or <varname>From=</varname>. If neither
1622 <varname>To=</varname> nor <varname>From=</varname> are specified, then defaults to
1623 <literal>ipv4</literal>.</para>
1624
1625 <xi:include href="version-info.xml" xpointer="v243"/>
1626 </listitem>
1627 </varlistentry>
1628
1629 <varlistentry>
1630 <term><varname>User=</varname></term>
1631 <listitem>
1632 <para>Takes a username, a user ID, or a range of user IDs separated by a dash. Defaults to
1633 unset.</para>
1634
1635 <xi:include href="version-info.xml" xpointer="v245"/>
1636 </listitem>
1637 </varlistentry>
1638
1639 <varlistentry>
1640 <term><varname>SuppressPrefixLength=</varname></term>
1641 <listitem>
1642 <para>Takes a number <replaceable>N</replaceable> in the range 0…128 and rejects routing
1643 decisions that have a prefix length of <replaceable>N</replaceable> or less. Defaults to
1644 unset.</para>
1645
1646 <xi:include href="version-info.xml" xpointer="v245"/>
1647 </listitem>
1648 </varlistentry>
1649
1650 <varlistentry>
1651 <term><varname>SuppressInterfaceGroup=</varname></term>
1652 <listitem>
1653 <para>Takes an integer in the range 0…2147483647 and rejects routing decisions that have
1654 an interface with the same group id. It has the same meaning as
1655 <option>suppress_ifgroup</option> in <command>ip rule</command>. Defaults to unset.</para>
1656
1657 <xi:include href="version-info.xml" xpointer="v250"/>
1658 </listitem>
1659 </varlistentry>
1660
1661 <varlistentry>
1662 <term><varname>Type=</varname></term>
1663 <listitem>
1664 <para>Specifies Routing Policy Database (RPDB) rule type. Takes one of
1665 <literal>blackhole</literal>, <literal>unreachable</literal> or <literal>prohibit</literal>.
1666 </para>
1667
1668 <xi:include href="version-info.xml" xpointer="v248"/>
1669 </listitem>
1670 </varlistentry>
1671 </variablelist>
1672 </refsect1>
1673
1674 <refsect1>
1675 <title>[NextHop] Section Options</title>
1676
1677 <para>The [NextHop] section is used to manipulate entries in the kernel's "nexthop" tables. The
1678 [NextHop] section accepts the following settings. Specify several [NextHop] sections to configure
1679 several hops.</para>
1680
1681 <variablelist class='network-directives'>
1682 <varlistentry>
1683 <term><varname>Id=</varname></term>
1684 <listitem>
1685 <para>The id of the next hop. Takes an integer in the range 1…4294967295. If unspecified,
1686 then automatically chosen by kernel.</para>
1687
1688 <xi:include href="version-info.xml" xpointer="v244"/>
1689 </listitem>
1690 </varlistentry>
1691
1692 <varlistentry>
1693 <term><varname>Gateway=</varname></term>
1694 <listitem>
1695 <para>As in the [Network] section.</para>
1696
1697 <xi:include href="version-info.xml" xpointer="v244"/>
1698 </listitem>
1699 </varlistentry>
1700
1701 <varlistentry>
1702 <term><varname>Family=</varname></term>
1703 <listitem>
1704 <para>Takes one of the special values <literal>ipv4</literal> or <literal>ipv6</literal>.
1705 By default, the family is determined by the address specified in
1706 <varname>Gateway=</varname>. If <varname>Gateway=</varname> is not specified, then defaults
1707 to <literal>ipv4</literal>.</para>
1708
1709 <xi:include href="version-info.xml" xpointer="v248"/>
1710 </listitem>
1711 </varlistentry>
1712
1713 <varlistentry>
1714 <term><varname>OnLink=</varname></term>
1715 <listitem>
1716 <para>Takes a boolean. If set to true, the kernel does not have to check if the gateway is
1717 reachable directly by the current machine (i.e., attached to the local network), so that we
1718 can insert the nexthop in the kernel table without it being complained about. Defaults to
1719 <literal>no</literal>.</para>
1720
1721 <xi:include href="version-info.xml" xpointer="v248"/>
1722 </listitem>
1723 </varlistentry>
1724
1725 <varlistentry>
1726 <term><varname>Blackhole=</varname></term>
1727 <listitem>
1728 <para>Takes a boolean. If enabled, packets to the corresponding routes are discarded
1729 silently, and <varname>Gateway=</varname> cannot be specified. Defaults to
1730 <literal>no</literal>.</para>
1731
1732 <xi:include href="version-info.xml" xpointer="v248"/>
1733 </listitem>
1734 </varlistentry>
1735
1736 <varlistentry>
1737 <term><varname>Group=</varname></term>
1738 <listitem>
1739 <para>Takes a whitespace separated list of nexthop IDs. Each ID must be in the range
1740 1…4294967295. Optionally, each nexthop ID can take a weight after a colon
1741 (<literal><replaceable>id</replaceable><optional>:<replaceable>weight</replaceable></optional></literal>).
1742 The weight must be in the range 1…255. If the weight is not specified, then it is assumed
1743 that the weight is 1. This setting cannot be specified with <varname>Gateway=</varname>,
1744 <varname>Family=</varname>, <varname>Blackhole=</varname>. This setting can be specified
1745 multiple times. If an empty string is assigned, then the all previous assignments are
1746 cleared. Defaults to unset.</para>
1747
1748 <xi:include href="version-info.xml" xpointer="v249"/>
1749 </listitem>
1750 </varlistentry>
1751 </variablelist>
1752 </refsect1>
1753
1754 <refsect1>
1755 <title>[Route] Section Options</title>
1756
1757 <para>The [Route] section accepts the following settings. Specify several [Route] sections to
1758 configure several routes.</para>
1759
1760 <variablelist class='network-directives'>
1761 <varlistentry>
1762 <term><varname>Gateway=</varname></term>
1763 <listitem>
1764 <para>Takes the gateway address or the special values <literal>_dhcp4</literal> and
1765 <literal>_ipv6ra</literal>. If <literal>_dhcp4</literal> or <literal>_ipv6ra</literal> is
1766 set, then the gateway address provided by DHCPv4 or IPv6 RA is used.</para>
1767
1768 <xi:include href="version-info.xml" xpointer="v215"/>
1769 </listitem>
1770 </varlistentry>
1771
1772 <varlistentry>
1773 <term><varname>GatewayOnLink=</varname></term>
1774 <listitem>
1775 <para>Takes a boolean. If set to true, the kernel does not have to check if the gateway is
1776 reachable directly by the current machine (i.e., attached to the local network), so that we
1777 can insert the route in the kernel table without it being complained about. Defaults to
1778 <literal>no</literal>.</para>
1779
1780 <xi:include href="version-info.xml" xpointer="v242"/>
1781 </listitem>
1782 </varlistentry>
1783
1784 <varlistentry>
1785 <term><varname>Destination=</varname></term>
1786 <listitem>
1787 <para>The destination prefix of the route. Possibly followed by a slash and the prefix
1788 length. If omitted, a full-length host route is assumed.</para>
1789 </listitem>
1790 </varlistentry>
1791
1792 <varlistentry>
1793 <term><varname>Source=</varname></term>
1794 <listitem>
1795 <para>The source prefix of the route. Possibly followed by a slash and the prefix length. If
1796 omitted, a full-length host route is assumed.</para>
1797
1798 <xi:include href="version-info.xml" xpointer="v218"/>
1799 </listitem>
1800 </varlistentry>
1801
1802 <varlistentry>
1803 <term><varname>Metric=</varname></term>
1804 <listitem>
1805 <para>The metric of the route. Takes an unsigned integer in the range 0…4294967295. Defaults
1806 to unset, and the kernel's default will be used.</para>
1807
1808 <xi:include href="version-info.xml" xpointer="v216"/>
1809 </listitem>
1810 </varlistentry>
1811
1812 <varlistentry>
1813 <term><varname>IPv6Preference=</varname></term>
1814 <listitem>
1815 <para>Specifies the route preference as defined in
1816 <ulink url="https://tools.ietf.org/html/rfc4191">RFC 4191</ulink> for Router Discovery
1817 messages. Which can be one of <literal>low</literal> the route has a lowest priority,
1818 <literal>medium</literal> the route has a default priority or <literal>high</literal> the
1819 route has a highest priority.</para>
1820
1821 <xi:include href="version-info.xml" xpointer="v234"/>
1822 </listitem>
1823 </varlistentry>
1824
1825 <varlistentry>
1826 <term><varname>Scope=</varname></term>
1827 <listitem>
1828 <para>The scope of the IPv4 route, which can be <literal>global</literal>,
1829 <literal>site</literal>, <literal>link</literal>, <literal>host</literal>, or
1830 <literal>nowhere</literal>:</para>
1831 <itemizedlist>
1832 <listitem>
1833 <para><literal>global</literal> means the route can reach hosts more than one hop away.
1834 </para>
1835 </listitem>
1836
1837 <listitem>
1838 <para><literal>site</literal> means an interior route in the local autonomous system.
1839 </para>
1840 </listitem>
1841
1842 <listitem>
1843 <para><literal>link</literal> means the route can only reach hosts on the local network
1844 (one hop away).</para>
1845 </listitem>
1846
1847 <listitem>
1848 <para><literal>host</literal> means the route will not leave the local machine (used for
1849 internal addresses like 127.0.0.1).</para>
1850 </listitem>
1851
1852 <listitem>
1853 <para><literal>nowhere</literal> means the destination doesn't exist.</para>
1854 </listitem>
1855 </itemizedlist>
1856
1857 <para>For IPv4 route, defaults to <literal>host</literal> if <varname>Type=</varname> is
1858 <literal>local</literal> or <literal>nat</literal>, and <literal>link</literal> if
1859 <varname>Type=</varname> is <literal>broadcast</literal>, <literal>multicast</literal>,
1860 <literal>anycast</literal>, or <literal>unicast</literal>. In other cases,
1861 defaults to <literal>global</literal>. The value is not used for IPv6.</para>
1862
1863 <xi:include href="version-info.xml" xpointer="v219"/>
1864 </listitem>
1865 </varlistentry>
1866
1867 <varlistentry>
1868 <term><varname>PreferredSource=</varname></term>
1869 <listitem>
1870 <para>The preferred source address of the route. The address must be in the format described
1871 in
1872 <citerefentry project='man-pages'><refentrytitle>inet_pton</refentrytitle><manvolnum>3</manvolnum></citerefentry>.
1873 </para>
1874
1875 <xi:include href="version-info.xml" xpointer="v227"/>
1876 </listitem>
1877 </varlistentry>
1878
1879 <varlistentry>
1880 <term><varname>Table=</varname></term>
1881 <listitem>
1882 <para>The table identifier for the route. Takes one of predefined names
1883 <literal>default</literal>, <literal>main</literal>, and <literal>local</literal>, and names
1884 defined in <varname>RouteTable=</varname> in
1885 <citerefentry><refentrytitle>networkd.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
1886 or a number between 1 and 4294967295. The table can be retrieved using
1887 <command>ip route show table <replaceable>num</replaceable></command>. If unset and
1888 <varname>Type=</varname> is <literal>local</literal>, <literal>broadcast</literal>,
1889 <literal>anycast</literal>, or <literal>nat</literal>, then <literal>local</literal> is used.
1890 In other cases, defaults to <literal>main</literal>.</para>
1891
1892 <xi:include href="version-info.xml" xpointer="v244"/>
1893 </listitem>
1894 </varlistentry>
1895
1896 <varlistentry>
1897 <term><varname>HopLimit=</varname></term>
1898 <listitem>
1899 <para>Configures per route hop limit. Takes an integer in the range 1…255. See also
1900 <varname>IPv6HopLimit=</varname>.</para>
1901
1902 <xi:include href="version-info.xml" xpointer="v255"/>
1903 </listitem>
1904 </varlistentry>
1905
1906 <varlistentry>
1907 <term><varname>Protocol=</varname></term>
1908 <listitem>
1909 <para>The protocol identifier for the route. Takes a number between 0 and 255 or the special
1910 values <literal>kernel</literal>, <literal>boot</literal>, <literal>static</literal>,
1911 <literal>ra</literal> and <literal>dhcp</literal>. Defaults to <literal>static</literal>.
1912 </para>
1913
1914 <xi:include href="version-info.xml" xpointer="v234"/>
1915 </listitem>
1916 </varlistentry>
1917
1918 <varlistentry>
1919 <term><varname>Type=</varname></term>
1920 <listitem>
1921 <para>Specifies the type for the route. Takes one of <literal>unicast</literal>,
1922 <literal>local</literal>, <literal>broadcast</literal>, <literal>anycast</literal>,
1923 <literal>multicast</literal>, <literal>blackhole</literal>, <literal>unreachable</literal>,
1924 <literal>prohibit</literal>, <literal>throw</literal>, <literal>nat</literal>, and
1925 <literal>xresolve</literal>. If <literal>unicast</literal>, a regular route is defined, i.e.
1926 a route indicating the path to take to a destination network address. If
1927 <literal>blackhole</literal>, packets to the defined route are discarded silently. If
1928 <literal>unreachable</literal>, packets to the defined route are discarded and the ICMP
1929 message "Host Unreachable" is generated. If <literal>prohibit</literal>, packets to the
1930 defined route are discarded and the ICMP message "Communication Administratively Prohibited"
1931 is generated. If <literal>throw</literal>, route lookup in the current routing table will
1932 fail and the route selection process will return to Routing Policy Database (RPDB). Defaults
1933 to <literal>unicast</literal>.</para>
1934 </listitem>
1935 </varlistentry>
1936
1937 <varlistentry>
1938 <term><varname>InitialCongestionWindow=</varname></term>
1939 <listitem>
1940 <para>The TCP initial congestion window is used during the start of a TCP connection.
1941 During the start of a TCP session, when a client requests a resource, the server's initial
1942 congestion window determines how many packets will be sent during the initial burst of data
1943 without waiting for acknowledgement. Takes a number between 1 and 1023. Note that 100 is
1944 considered an extremely large value for this option. When unset, the kernel's default
1945 (typically 10) will be used.</para>
1946
1947 <xi:include href="version-info.xml" xpointer="v237"/>
1948 </listitem>
1949 </varlistentry>
1950
1951 <varlistentry>
1952 <term><varname>InitialAdvertisedReceiveWindow=</varname></term>
1953 <listitem>
1954 <para>The TCP initial advertised receive window is the amount of receive data (in bytes)
1955 that can initially be buffered at one time on a connection. The sending host can send only
1956 that amount of data before waiting for an acknowledgment and window update from the
1957 receiving host. Takes a number between 1 and 1023. Note that 100 is considered an extremely
1958 large value for this option. When unset, the kernel's default will be used.</para>
1959
1960 <xi:include href="version-info.xml" xpointer="v237"/>
1961 </listitem>
1962 </varlistentry>
1963
1964 <varlistentry>
1965 <term><varname>QuickAck=</varname></term>
1966 <listitem>
1967 <para>Takes a boolean. When true, the TCP quick ACK mode for the route is enabled. When unset,
1968 the kernel's default will be used.</para>
1969
1970 <xi:include href="version-info.xml" xpointer="v237"/>
1971 </listitem>
1972 </varlistentry>
1973
1974 <varlistentry>
1975 <term><varname>FastOpenNoCookie=</varname></term>
1976 <listitem>
1977 <para>Takes a boolean. When true enables TCP fastopen without a cookie on a per-route basis.
1978 When unset, the kernel's default will be used.</para>
1979
1980 <xi:include href="version-info.xml" xpointer="v243"/>
1981 </listitem>
1982 </varlistentry>
1983
1984 <varlistentry>
1985 <term><varname>TTLPropagate=</varname></term>
1986 <listitem>
1987 <para>Takes a boolean. When true enables TTL propagation at Label Switched Path (LSP) egress.
1988 When unset, the kernel's default will be used.</para>
1989
1990 <xi:include href="version-info.xml" xpointer="v243"/>
1991 </listitem>
1992 </varlistentry>
1993
1994 <varlistentry>
1995 <term><varname>MTUBytes=</varname></term>
1996 <listitem>
1997 <para>The maximum transmission unit in bytes to set for the route. The usual suffixes K, M,
1998 G, are supported and are understood to the base of 1024.</para>
1999
2000 <xi:include href="version-info.xml" xpointer="v239"/>
2001 </listitem>
2002 </varlistentry>
2003
2004 <varlistentry>
2005 <term><varname>TCPAdvertisedMaximumSegmentSize=</varname></term>
2006 <listitem>
2007 <para>Specifies the Path MSS (in bytes) hints given on TCP layer. The usual suffixes K, M, G,
2008 are supported and are understood to the base of 1024. An unsigned integer in the range
2009 1…4294967294. When unset, the kernel's default will be used.</para>
2010
2011 <xi:include href="version-info.xml" xpointer="v248"/>
2012 </listitem>
2013 </varlistentry>
2014
2015 <varlistentry>
2016 <term><varname>TCPCongestionControlAlgorithm=</varname></term>
2017 <listitem>
2018 <para>Specifies the TCP congestion control algorithm for the route. Takes a name of the algorithm,
2019 e.g. <literal>bbr</literal>, <literal>dctcp</literal>, or <literal>vegas</literal>. When unset,
2020 the kernel's default will be used.</para>
2021
2022 <xi:include href="version-info.xml" xpointer="v252"/>
2023 </listitem>
2024 </varlistentry>
2025
2026 <varlistentry>
2027 <term><varname>TCPRetransmissionTimeoutSec=</varname></term>
2028 <listitem>
2029 <para>Specifies the TCP Retransmission Timeout (RTO) for the route. Takes time values in seconds.
2030 This value specifies the timeout of an alive TCP connection, when retransmissions remain
2031 unacknowledged. When unset, the kernel's default will be used.</para>
2032
2033 <xi:include href="version-info.xml" xpointer="v255"/>
2034 </listitem>
2035 </varlistentry>
2036
2037 <varlistentry>
2038 <term><varname>MultiPathRoute=<replaceable>address</replaceable>[@<replaceable>name</replaceable>] [<replaceable>weight</replaceable>]</varname></term>
2039 <listitem>
2040 <para>Configures multipath route. Multipath routing is the technique of using multiple
2041 alternative paths through a network. Takes gateway address. Optionally, takes a network
2042 interface name or index separated with <literal>@</literal>, and a weight in 1..256 for this
2043 multipath route separated with whitespace. This setting can be specified multiple times. If
2044 an empty string is assigned, then the all previous assignments are cleared.</para>
2045
2046 <xi:include href="version-info.xml" xpointer="v245"/>
2047 </listitem>
2048 </varlistentry>
2049
2050 <varlistentry>
2051 <term><varname>NextHop=</varname></term>
2052 <listitem>
2053 <para>Specifies the nexthop id. Takes an unsigned integer in the range 1…4294967295. If set,
2054 the corresponding [NextHop] section must be configured. Defaults to unset.</para>
2055
2056 <xi:include href="version-info.xml" xpointer="v248"/>
2057 </listitem>
2058 </varlistentry>
2059 </variablelist>
2060 </refsect1>
2061
2062 <refsect1>
2063 <title>[DHCPv4] Section Options</title>
2064
2065 <para>The [DHCPv4] section configures the DHCPv4 client, if it is enabled with the
2066 <varname>DHCP=</varname> setting described above:</para>
2067
2068 <variablelist class='network-directives'>
2069
2070 <!-- DHCP packet contents -->
2071
2072 <varlistentry>
2073 <term><varname>SendHostname=</varname></term>
2074 <listitem>
2075 <para>When true (the default), the machine's hostname (or the value specified with
2076 <varname>Hostname=</varname>, described below) will be sent to the DHCP server. Note that the
2077 hostname must consist only of 7-bit ASCII lower-case characters and no spaces or dots, and be
2078 formatted as a valid DNS domain name. Otherwise, the hostname is not sent even if this option
2079 is true.</para>
2080 </listitem>
2081 </varlistentry>
2082
2083 <varlistentry>
2084 <term><varname>Hostname=</varname></term>
2085 <listitem>
2086 <para>Use this value for the hostname which is sent to the DHCP server, instead of machine's
2087 hostname. Note that the specified hostname must consist only of 7-bit ASCII lower-case
2088 characters and no spaces or dots, and be formatted as a valid DNS domain name.</para>
2089 </listitem>
2090 </varlistentry>
2091
2092 <varlistentry>
2093 <term><varname>MUDURL=</varname></term>
2094 <listitem>
2095 <para>When configured, the specified Manufacturer Usage Description (MUD) URL will be sent
2096 to the DHCPv4 server. Takes a URL of length up to 255 characters. A superficial verification
2097 that the string is a valid URL will be performed. DHCPv4 clients are intended to have at most
2098 one MUD URL associated with them. See
2099 <ulink url="https://tools.ietf.org/html/rfc8520">RFC 8520</ulink>.</para>
2100
2101 <para>MUD is an embedded software standard defined by the IETF that allows IoT device makers
2102 to advertise device specifications, including the intended communication patterns for their
2103 device when it connects to the network. The network can then use this to author a
2104 context-specific access policy, so the device functions only within those parameters.</para>
2105
2106 <xi:include href="version-info.xml" xpointer="v246"/>
2107 </listitem>
2108 </varlistentry>
2109
2110 <varlistentry>
2111 <term><varname>ClientIdentifier=</varname></term>
2112 <listitem>
2113 <para>The DHCPv4 client identifier to use. Takes one of <option>mac</option> or
2114 <option>duid</option>. If set to <option>mac</option>, the MAC address of the link is used. If set
2115 to <option>duid</option>, an RFC4361-compliant Client ID, which is the combination of IAID and
2116 DUID, is used. IAID can be configured by <varname>IAID=</varname>. DUID can be configured by
2117 <varname>DUIDType=</varname> and <varname>DUIDRawData=</varname>. Defaults to
2118 <option>duid</option>.</para>
2119 </listitem>
2120 </varlistentry>
2121
2122 <varlistentry>
2123 <term><varname>VendorClassIdentifier=</varname></term>
2124 <listitem>
2125 <para>The vendor class identifier used to identify vendor type and configuration.</para>
2126 </listitem>
2127 </varlistentry>
2128
2129 <varlistentry>
2130 <term><varname>UserClass=</varname></term>
2131 <listitem>
2132 <para>A DHCPv4 client can use UserClass option to identify the type or category of user or
2133 applications it represents. The information contained in this option is a string that
2134 represents the user class of which the client is a member. Each class sets an identifying
2135 string of information to be used by the DHCP service to classify clients. Takes a
2136 whitespace-separated list of strings.</para>
2137 </listitem>
2138 </varlistentry>
2139
2140 <varlistentry>
2141 <term><varname>DUIDType=</varname></term>
2142 <listitem>
2143 <para>Override the global <varname>DUIDType=</varname> setting for this network. See
2144 <citerefentry><refentrytitle>networkd.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>
2145 for a description of possible values.</para>
2146 </listitem>
2147 </varlistentry>
2148
2149 <varlistentry>
2150 <term><varname>DUIDRawData=</varname></term>
2151 <listitem>
2152 <para>Override the global <varname>DUIDRawData=</varname> setting for this network. See
2153 <citerefentry><refentrytitle>networkd.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>
2154 for a description of possible values.</para>
2155 </listitem>
2156 </varlistentry>
2157
2158 <varlistentry>
2159 <term><varname>IAID=</varname></term>
2160 <listitem>
2161 <para>The DHCP Identity Association Identifier (IAID) for the interface, a 32-bit unsigned
2162 integer.</para>
2163 </listitem>
2164 </varlistentry>
2165
2166 <varlistentry>
2167 <term><varname>Anonymize=</varname></term>
2168 <listitem>
2169 <para>Takes a boolean. When true, the options sent to the DHCP server will follow the
2170 <ulink url="https://tools.ietf.org/html/rfc7844">RFC 7844</ulink> (Anonymity Profiles for
2171 DHCP Clients) to minimize disclosure of identifying information. Defaults to false.</para>
2172
2173 <para>This option should only be set to true when <varname>MACAddressPolicy=</varname> is set
2174 to <option>random</option> (see
2175 <citerefentry><refentrytitle>systemd.link</refentrytitle><manvolnum>5</manvolnum></citerefentry>).
2176 </para>
2177
2178 <para>When true, <varname>SendHostname=</varname>, <varname>ClientIdentifier=</varname>,
2179 <varname>VendorClassIdentifier=</varname>, <varname>UserClass=</varname>,
2180 <varname>RequestOptions=</varname>, <varname>SendOption=</varname>,
2181 <varname>SendVendorOption=</varname>, and <varname>MUDURL=</varname> are ignored.</para>
2182
2183 <para>With this option enabled DHCP requests will mimic those generated by Microsoft
2184 Windows, in order to reduce the ability to fingerprint and recognize installations. This
2185 means DHCP request sizes will grow and lease data will be more comprehensive than normally,
2186 though most of the requested data is not actually used.</para>
2187 </listitem>
2188 </varlistentry>
2189
2190 <varlistentry>
2191 <term><varname>RequestOptions=</varname></term>
2192 <listitem>
2193 <para>Sets request options to be sent to the server in the DHCPv4 request options list. A
2194 whitespace-separated list of integers in the range 1…254. Defaults to unset.</para>
2195
2196 <xi:include href="version-info.xml" xpointer="v244"/>
2197 </listitem>
2198 </varlistentry>
2199
2200 <varlistentry>
2201 <term><varname>SendOption=</varname></term>
2202 <listitem>
2203 <para>Send an arbitrary raw option in the DHCPv4 request. Takes a DHCP option number, data
2204 type and data separated with a colon
2205 (<literal><replaceable>option</replaceable>:<replaceable>type</replaceable>:<replaceable>value</replaceable></literal>).
2206 The option number must be an integer in the range 1…254. The type takes one of
2207 <literal>uint8</literal>, <literal>uint16</literal>, <literal>uint32</literal>,
2208 <literal>ipv4address</literal>, or <literal>string</literal>. Special characters in the data
2209 string may be escaped using
2210 <ulink url="https://en.wikipedia.org/wiki/Escape_sequences_in_C#Table_of_escape_sequences">C-style
2211 escapes</ulink>. This setting can be specified multiple times. If an empty string is
2212 specified, then all options specified earlier are cleared. Defaults to unset.</para>
2213
2214 <xi:include href="version-info.xml" xpointer="v244"/>
2215 </listitem>
2216 </varlistentry>
2217
2218 <varlistentry>
2219 <term><varname>SendVendorOption=</varname></term>
2220 <listitem>
2221 <para>Send an arbitrary vendor option in the DHCPv4 request. Takes a DHCP option number, data
2222 type and data separated with a colon
2223 (<literal><replaceable>option</replaceable>:<replaceable>type</replaceable>:<replaceable>value</replaceable></literal>).
2224 The option number must be an integer in the range 1…254. The type takes one of
2225 <literal>uint8</literal>, <literal>uint16</literal>, <literal>uint32</literal>,
2226 <literal>ipv4address</literal>, or <literal>string</literal>. Special characters in the data
2227 string may be escaped using
2228 <ulink url="https://en.wikipedia.org/wiki/Escape_sequences_in_C#Table_of_escape_sequences">C-style
2229 escapes</ulink>. This setting can be specified multiple times. If an empty string is specified,
2230 then all options specified earlier are cleared. Defaults to unset.</para>
2231
2232 <xi:include href="version-info.xml" xpointer="v246"/>
2233 </listitem>
2234 </varlistentry>
2235
2236 <varlistentry>
2237 <term><varname>IPServiceType=</varname></term>
2238 <listitem>
2239 <para>Takes one of the special values <literal>none</literal>, <literal>CS6</literal>, or
2240 <literal>CS4</literal>. When <literal>none</literal> no IP service type is set to the packet
2241 sent from the DHCPv4 client. When <literal>CS6</literal> (network control) or
2242 <literal>CS4</literal> (realtime), the corresponding service type will be set. Defaults to
2243 <literal>CS6</literal>.</para>
2244 </listitem>
2245 </varlistentry>
2246
2247 <varlistentry>
2248 <term><varname>SocketPriority=</varname></term>
2249 <listitem>
2250 <para>The Linux socket option <constant>SO_PRIORITY</constant> applied to the raw IP socket used for
2251 initial DHCPv4 messages. Unset by default. Usual values range from 0 to 6.
2252 More details about <constant>SO_PRIORITY</constant> socket option in
2253 <citerefentry project='man-pages'><refentrytitle>socket</refentrytitle><manvolnum>7</manvolnum></citerefentry>.
2254 Can be used in conjunction with [VLAN] section <varname>EgressQOSMaps=</varname> setting of .netdev
2255 file to set the 802.1Q VLAN ethernet tagged header priority, see
2256 <citerefentry><refentrytitle>systemd.netdev</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
2257 </para>
2258
2259 <xi:include href="version-info.xml" xpointer="v253"/>
2260 </listitem>
2261 </varlistentry>
2262
2263 <!-- How to use the DHCP lease -->
2264
2265 <varlistentry>
2266 <term><varname>Label=</varname></term>
2267 <listitem>
2268 <para>Specifies the label for the IPv4 address received from the DHCP server. The label must
2269 be a 7-bit ASCII string with a length of 1…15 characters. Defaults to unset.</para>
2270
2271 <xi:include href="version-info.xml" xpointer="v250"/>
2272 </listitem>
2273 </varlistentry>
2274
2275 <varlistentry>
2276 <term><varname>UseDNS=</varname></term>
2277 <listitem>
2278 <para>When true (the default), the DNS servers received from the DHCP server will be used.
2279 </para>
2280
2281 <para>This corresponds to the <option>nameserver</option> option in
2282 <citerefentry project='man-pages'><refentrytitle>resolv.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
2283 </para>
2284 </listitem>
2285 </varlistentry>
2286
2287 <varlistentry>
2288 <term><varname>RoutesToDNS=</varname></term>
2289 <listitem>
2290 <para>When true, the routes to the DNS servers received from the DHCP server will be
2291 configured. When <varname>UseDNS=</varname> is disabled, this setting is ignored. Defaults to
2292 true.</para>
2293
2294 <xi:include href="version-info.xml" xpointer="v243"/>
2295 </listitem>
2296 </varlistentry>
2297
2298 <varlistentry>
2299 <term><varname>UseNTP=</varname></term>
2300 <listitem>
2301 <para>When true (the default), the NTP servers received from the DHCP server will be used by
2302 <filename>systemd-timesyncd.service</filename>.</para>
2303 </listitem>
2304 </varlistentry>
2305
2306 <varlistentry>
2307 <term><varname>RoutesToNTP=</varname></term>
2308 <listitem>
2309 <para>When true, the routes to the NTP servers received from the DHCP server will be
2310 configured. When <varname>UseNTP=</varname> is disabled, this setting is ignored. Defaults to
2311 true.</para>
2312
2313 <xi:include href="version-info.xml" xpointer="v249"/>
2314 </listitem>
2315 </varlistentry>
2316
2317 <varlistentry>
2318 <term><varname>UseSIP=</varname></term>
2319 <listitem>
2320 <para>When true (the default), the SIP servers received from the DHCP server will be collected
2321 and made available to client programs.</para>
2322
2323 <xi:include href="version-info.xml" xpointer="v244"/>
2324 </listitem>
2325 </varlistentry>
2326
2327 <varlistentry>
2328 <term><varname>UseCaptivePortal=</varname></term>
2329 <listitem>
2330 <para>When true (the default), the captive portal advertised by the DHCP server will be recorded
2331 and made available to client programs and displayed in the networkctl status output per-link.</para>
2332
2333 <xi:include href="version-info.xml" xpointer="v254"/>
2334 </listitem>
2335 </varlistentry>
2336
2337 <varlistentry>
2338 <term><varname>UseMTU=</varname></term>
2339 <listitem>
2340 <para>When true, the interface maximum transmission unit from the DHCP server will be used on
2341 the current link. If <varname>MTUBytes=</varname> is set, then this setting is ignored.
2342 Defaults to false.</para>
2343
2344 <para>Note, some drivers will reset the interfaces if the MTU is changed. For such
2345 interfaces, please try to use <varname>IgnoreCarrierLoss=</varname> with a short timespan,
2346 e.g. <literal>3 seconds</literal>.</para>
2347 </listitem>
2348 </varlistentry>
2349
2350 <varlistentry>
2351 <term><varname>UseHostname=</varname></term>
2352 <listitem>
2353 <para>When true (the default), the hostname received from the DHCP server will be set as the
2354 transient hostname of the system.</para>
2355 </listitem>
2356 </varlistentry>
2357
2358 <varlistentry>
2359 <term><varname>UseDomains=</varname></term>
2360 <listitem>
2361 <para>Takes a boolean, or the special value <option>route</option>. When true, the domain name
2362 received from the DHCP server will be used as DNS search domain over this link, similarly to the
2363 effect of the <option>Domains=</option> setting. If set to <option>route</option>, the domain name
2364 received from the DHCP server will be used for routing DNS queries only, but not for searching,
2365 similarly to the effect of the <option>Domains=</option> setting when the argument is prefixed with
2366 <literal>~</literal>. Defaults to false.</para>
2367
2368 <para>It is recommended to enable this option only on trusted networks, as setting this
2369 affects resolution of all hostnames, in particular of single-label names. It is generally
2370 safer to use the supplied domain only as routing domain, rather than as search domain, in
2371 order to not have it affect local resolution of single-label names.</para>
2372
2373 <para>When set to true, this setting corresponds to the <option>domain</option> option in
2374 <citerefentry project='man-pages'><refentrytitle>resolv.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
2375 </para>
2376 </listitem>
2377 </varlistentry>
2378
2379 <varlistentry>
2380 <term><varname>UseRoutes=</varname></term>
2381 <listitem>
2382 <para>When true (the default), the static routes will be requested from the DHCP server and
2383 added to the routing table with a metric of 1024, and a scope of <option>global</option>,
2384 <option>link</option> or <option>host</option>, depending on the route's destination and
2385 gateway. If the destination is on the local host, e.g., 127.x.x.x, or the same as the link's
2386 own address, the scope will be set to <option>host</option>. Otherwise if the gateway is null
2387 (a direct route), a <option>link</option> scope will be used. For anything else, scope
2388 defaults to <option>global</option>.</para>
2389 </listitem>
2390 </varlistentry>
2391
2392 <varlistentry>
2393 <term><varname>RouteMetric=</varname></term>
2394 <listitem>
2395 <para>Set the routing metric for routes specified by the DHCP server (including the prefix
2396 route added for the specified prefix). Takes an unsigned integer in the range 0…4294967295.
2397 Defaults to 1024.</para>
2398 </listitem>
2399 </varlistentry>
2400
2401 <varlistentry>
2402 <term><varname>RouteTable=<replaceable>num</replaceable></varname></term>
2403 <listitem>
2404 <para>The table identifier for DHCP routes. Takes one of predefined names
2405 <literal>default</literal>, <literal>main</literal>, and <literal>local</literal>, and names
2406 defined in <varname>RouteTable=</varname> in
2407 <citerefentry><refentrytitle>networkd.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
2408 or a number between 1…4294967295.</para>
2409
2410 <para>When used in combination with <varname>VRF=</varname>, the VRF's routing table is
2411 used when this parameter is not specified.</para>
2412 </listitem>
2413 </varlistentry>
2414
2415 <varlistentry>
2416 <term><varname>RouteMTUBytes=</varname></term>
2417 <listitem>
2418 <para>Specifies the MTU for the DHCP routes. Please see the [Route] section for further
2419 details.</para>
2420
2421 <xi:include href="version-info.xml" xpointer="v245"/>
2422 </listitem>
2423 </varlistentry>
2424
2425 <varlistentry>
2426 <term><varname>QuickAck=</varname></term>
2427 <listitem>
2428 <para>Takes a boolean. When true, the TCP quick ACK mode is enabled for the routes configured by
2429 the acquired DHCPv4 lease. When unset, the kernel's default will be used.</para>
2430
2431 <xi:include href="version-info.xml" xpointer="v253"/>
2432 </listitem>
2433 </varlistentry>
2434
2435 <varlistentry>
2436 <term><varname>InitialCongestionWindow=</varname></term>
2437 <listitem>
2438 <para>As in the [Route] section.</para>
2439
2440 <xi:include href="version-info.xml" xpointer="v255"/>
2441 </listitem>
2442 </varlistentry>
2443
2444 <varlistentry>
2445 <term><varname>InitialAdvertisedReceiveWindow=</varname></term>
2446 <listitem>
2447 <para>As in the [Route] section.</para>
2448
2449 <xi:include href="version-info.xml" xpointer="v255"/>
2450 </listitem>
2451 </varlistentry>
2452
2453 <varlistentry>
2454 <term><varname>UseGateway=</varname></term>
2455 <listitem>
2456 <para>When true, the gateway will be requested from the DHCP server and added to the routing
2457 table with a metric of 1024, and a scope of <option>link</option>. When unset, the value
2458 specified with <varname>UseRoutes=</varname> is used.</para>
2459
2460 <xi:include href="version-info.xml" xpointer="v246"/>
2461 </listitem>
2462 </varlistentry>
2463
2464 <varlistentry>
2465 <term><varname>UseTimezone=</varname></term>
2466 <listitem><para>When true, the timezone received from the DHCP server will be set as timezone
2467 of the local system. Defaults to false.</para></listitem>
2468 </varlistentry>
2469
2470 <varlistentry>
2471 <term><varname>Use6RD=</varname></term>
2472 <listitem>
2473 <para>When true, subnets of the received IPv6 prefix are assigned to downstream interfaces
2474 which enables <varname>DHCPPrefixDelegation=</varname>. See also
2475 <varname>DHCPPrefixDelegation=</varname> in the [Network] section, the [DHCPPrefixDelegation]
2476 section, and <ulink url="https://tools.ietf.org/html/rfc5969">RFC 5969</ulink>. Defaults to
2477 false.</para>
2478
2479 <xi:include href="version-info.xml" xpointer="v250"/>
2480 </listitem>
2481 </varlistentry>
2482
2483 <varlistentry>
2484 <term><varname>FallbackLeaseLifetimeSec=</varname></term>
2485 <listitem>
2486 <para>Allows one to set DHCPv4 lease lifetime when DHCPv4 server does not send the lease
2487 lifetime. Takes one of <literal>forever</literal> or <literal>infinity</literal>. If
2488 specified, the acquired address never expires. Defaults to unset.</para>
2489
2490 <xi:include href="version-info.xml" xpointer="v246"/>
2491 </listitem>
2492 </varlistentry>
2493
2494 <!-- How to communicate with the server -->
2495
2496 <varlistentry>
2497 <term><varname>RequestBroadcast=</varname></term>
2498 <listitem>
2499 <para>Request the server to use broadcast messages before the IP address has been configured.
2500 This is necessary for devices that cannot receive RAW packets, or that cannot receive packets
2501 at all before an IP address has been configured. On the other hand, this must not be enabled
2502 on networks where broadcasts are filtered out.</para>
2503 </listitem>
2504 </varlistentry>
2505
2506 <varlistentry>
2507 <term><varname>MaxAttempts=</varname></term>
2508 <listitem>
2509 <para>Specifies how many times the DHCPv4 client configuration should be attempted. Takes a
2510 number or <literal>infinity</literal>. Defaults to <literal>infinity</literal>. Note that the
2511 time between retries is increased exponentially, up to approximately one per minute, so the
2512 network will not be overloaded even if this number is high. The default is suitable in most
2513 circumstances.</para>
2514
2515 <xi:include href="version-info.xml" xpointer="v243"/>
2516 </listitem>
2517 </varlistentry>
2518
2519 <varlistentry>
2520 <term><varname>ListenPort=</varname></term>
2521 <listitem>
2522 <para>Set the port from which the DHCP client packets originate.</para>
2523 </listitem>
2524 </varlistentry>
2525
2526 <varlistentry>
2527 <term><varname>DenyList=</varname></term>
2528 <listitem>
2529 <para>A whitespace-separated list of IPv4 addresses. Each address can optionally take a
2530 prefix length after <literal>/</literal>. DHCP offers from servers in the list are rejected.
2531 Note that if <varname>AllowList=</varname> is configured then <varname>DenyList=</varname> is
2532 ignored.</para>
2533
2534 <xi:include href="version-info.xml" xpointer="v246"/>
2535 </listitem>
2536 </varlistentry>
2537
2538 <varlistentry>
2539 <term><varname>AllowList=</varname></term>
2540 <listitem>
2541 <para>A whitespace-separated list of IPv4 addresses. Each address can optionally take a
2542 prefix length after <literal>/</literal>. DHCP offers from servers in the list are accepted.
2543 </para>
2544
2545 <xi:include href="version-info.xml" xpointer="v246"/>
2546 </listitem>
2547 </varlistentry>
2548
2549 <varlistentry>
2550 <term><varname>SendRelease=</varname></term>
2551 <listitem>
2552 <para>When true, the DHCPv4 client sends a DHCP release packet when it stops. Defaults to
2553 true.</para>
2554
2555 <xi:include href="version-info.xml" xpointer="v243"/>
2556 </listitem>
2557 </varlistentry>
2558
2559 <varlistentry>
2560 <term><varname>SendDecline=</varname></term>
2561 <listitem>
2562 <para>A boolean. When true, <command>systemd-networkd</command> performs IPv4 Duplicate
2563 Address Detection to the acquired address by the DHCPv4 client. If duplicate is detected,
2564 the DHCPv4 client rejects the address by sending a <constant>DHCPDECLINE</constant> packet to
2565 the DHCP server, and tries to obtain an IP address again. See
2566 <ulink url="https://tools.ietf.org/html/rfc5227">RFC 5227</ulink>. Defaults to false.</para>
2567
2568 <xi:include href="version-info.xml" xpointer="v245"/>
2569 </listitem>
2570 </varlistentry>
2571
2572 <varlistentry>
2573 <term><varname>NetLabel=</varname></term>
2574 <listitem>
2575 <para>This applies the NetLabel for the addresses received with DHCP, like
2576 <varname>NetLabel=</varname> in [Address] section applies it to statically configured
2577 addresses. See <varname>NetLabel=</varname> in [Address] section for more details.</para>
2578
2579 <xi:include href="version-info.xml" xpointer="v252"/>
2580 </listitem>
2581 </varlistentry>
2582
2583 <varlistentry>
2584 <term><varname>NFTSet=</varname></term>
2585 <listitem>
2586 <para>This applies the NFT set for the network configuration received with DHCP, like
2587 <varname>NFTSet=</varname> in [Address] section applies it to static configuration. See
2588 <varname>NFTSet=</varname> in [Address] section for more details. For <literal>address</literal> or
2589 <literal>prefix</literal> source types, the type of the element used in the NFT filter must be
2590 <literal>ipv4_addr</literal>.</para>
2591
2592 <xi:include href="version-info.xml" xpointer="v255"/>
2593 </listitem>
2594 </varlistentry>
2595 </variablelist>
2596 </refsect1>
2597
2598 <refsect1>
2599 <title>[DHCPv6] Section Options</title>
2600
2601 <para>The [DHCPv6] section configures the DHCPv6 client, if it is enabled with the
2602 <varname>DHCP=</varname> setting described above, or invoked by the IPv6 Router Advertisement:
2603 </para>
2604
2605 <variablelist class='network-directives'>
2606
2607 <!-- DHCP packet contents -->
2608
2609 <varlistentry>
2610 <term><varname>MUDURL=</varname></term>
2611 <term><varname>IAID=</varname></term>
2612 <term><varname>DUIDType=</varname></term>
2613 <term><varname>DUIDRawData=</varname></term>
2614 <term><varname>RequestOptions=</varname></term>
2615 <listitem>
2616 <para>As in the [DHCPv4] section.</para>
2617 </listitem>
2618 </varlistentry>
2619
2620 <varlistentry>
2621 <term><varname>SendOption=</varname></term>
2622 <listitem>
2623 <para>As in the [DHCPv4] section, however because DHCPv6 uses 16-bit fields to store option
2624 numbers, the option number is an integer in the range 1…65536.</para>
2625
2626 <xi:include href="version-info.xml" xpointer="v246"/>
2627 </listitem>
2628 </varlistentry>
2629
2630 <varlistentry>
2631 <term><varname>SendVendorOption=</varname></term>
2632 <listitem>
2633 <para>Send an arbitrary vendor option in the DHCPv6 request. Takes an enterprise identifier,
2634 DHCP option number, data type, and data separated with a colon
2635 (<literal><replaceable>enterprise identifier</replaceable>:<replaceable>option</replaceable>:<replaceable>type</replaceable>:<replaceable>value</replaceable></literal>).
2636 Enterprise identifier is an unsigned integer in the range 1…4294967294. The option number
2637 must be an integer in the range 1…254. Data type takes one of <literal>uint8</literal>,
2638 <literal>uint16</literal>, <literal>uint32</literal>, <literal>ipv4address</literal>,
2639 <literal>ipv6address</literal>, or <literal>string</literal>. Special characters in the data
2640 string may be escaped using
2641 <ulink url="https://en.wikipedia.org/wiki/Escape_sequences_in_C#Table_of_escape_sequences">C-style
2642 escapes</ulink>. This setting can be specified multiple times. If an empty string is
2643 specified, then all options specified earlier are cleared. Defaults to unset.</para>
2644
2645 <xi:include href="version-info.xml" xpointer="v246"/>
2646 </listitem>
2647 </varlistentry>
2648
2649 <varlistentry>
2650 <term><varname>UserClass=</varname></term>
2651 <listitem>
2652 <para>A DHCPv6 client can use User Class option to identify the type or category of user or
2653 applications it represents. The information contained in this option is a string that
2654 represents the user class of which the client is a member. Each class sets an identifying
2655 string of information to be used by the DHCP service to classify clients. Special characters
2656 in the data string may be escaped using
2657 <ulink url="https://en.wikipedia.org/wiki/Escape_sequences_in_C#Table_of_escape_sequences">C-style
2658 escapes</ulink>. This setting can be specified multiple times. If an empty string is
2659 specified, then all options specified earlier are cleared. Takes a whitespace-separated list
2660 of strings. Note that currently <constant>NUL</constant> bytes are not allowed.</para>
2661
2662 <xi:include href="version-info.xml" xpointer="v246"/>
2663 </listitem>
2664 </varlistentry>
2665
2666 <varlistentry>
2667 <term><varname>VendorClass=</varname></term>
2668 <listitem>
2669 <para>A DHCPv6 client can use VendorClass option to identify the vendor that manufactured the
2670 hardware on which the client is running. The information contained in the data area of this
2671 option is contained in one or more opaque fields that identify details of the hardware
2672 configuration. Takes a whitespace-separated list of strings.</para>
2673
2674 <xi:include href="version-info.xml" xpointer="v246"/>
2675 </listitem>
2676 </varlistentry>
2677
2678 <varlistentry>
2679 <term><varname>PrefixDelegationHint=</varname></term>
2680 <listitem>
2681 <para>Takes an IPv6 address with prefix length in the same format as the
2682 <varname>Address=</varname> in the [Network] section. The DHCPv6 client will include a prefix
2683 hint in the DHCPv6 solicitation sent to the server. The prefix length must be in the range
2684 1…128. Defaults to unset.</para>
2685
2686 <xi:include href="version-info.xml" xpointer="v244"/>
2687 </listitem>
2688 </varlistentry>
2689
2690 <varlistentry>
2691 <term><varname>RapidCommit=</varname></term>
2692 <listitem>
2693 <para>Takes a boolean. The DHCPv6 client can obtain configuration parameters from a DHCPv6 server
2694 through a rapid two-message exchange (solicit and reply). When the rapid commit option is set by
2695 both the DHCPv6 client and the DHCPv6 server, the two-message exchange is used. Otherwise, the
2696 four-message exchange (solicit, advertise, request, and reply) is used. The two-message exchange
2697 provides faster client configuration. See
2698 <ulink url="https://tools.ietf.org/html/rfc3315#section-17.2.1">RFC 3315</ulink> for details.
2699 Defaults to true, and the two-message exchange will be used if the server support it.</para>
2700
2701 <xi:include href="version-info.xml" xpointer="v252"/>
2702 </listitem>
2703 </varlistentry>
2704
2705 <!-- How to use the DHCP lease -->
2706
2707 <varlistentry>
2708 <term><varname>UseAddress=</varname></term>
2709 <listitem>
2710 <para>When true (the default), the IP addresses provided by the DHCPv6 server will be
2711 assigned.</para>
2712
2713 <xi:include href="version-info.xml" xpointer="v248"/>
2714 </listitem>
2715 </varlistentry>
2716
2717 <varlistentry>
2718 <term><varname>UseCaptivePortal=</varname></term>
2719 <listitem>
2720 <para>When true (the default), the captive portal advertised by the DHCPv6 server will be recorded
2721 and made available to client programs and displayed in the networkctl status output per-link.</para>
2722
2723 <xi:include href="version-info.xml" xpointer="v254"/>
2724 </listitem>
2725 </varlistentry>
2726
2727 <varlistentry>
2728 <term><varname>UseDelegatedPrefix=</varname></term>
2729 <listitem>
2730 <para>When true (the default), the client will request the DHCPv6 server to delegate
2731 prefixes. If the server provides prefixes to be delegated, then subnets of the prefixes are
2732 assigned to the interfaces that have <varname>DHCPPrefixDelegation=yes</varname>.
2733 See also the <varname>DHCPPrefixDelegation=</varname> setting in the [Network] section,
2734 settings in the [DHCPPrefixDelegation] section, and
2735 <ulink url="https://www.rfc-editor.org/rfc/rfc8415.html#section-6.3">RFC 8415</ulink>.
2736 </para>
2737
2738 <xi:include href="version-info.xml" xpointer="v250"/>
2739 </listitem>
2740 </varlistentry>
2741
2742 <varlistentry>
2743 <term><varname>UseDNS=</varname></term>
2744 <term><varname>UseNTP=</varname></term>
2745 <term><varname>UseHostname=</varname></term>
2746 <term><varname>UseDomains=</varname></term>
2747 <term><varname>NetLabel=</varname></term>
2748 <term><varname>SendRelease=</varname></term>
2749 <listitem>
2750 <para>As in the [DHCPv4] section.</para>
2751 </listitem>
2752 </varlistentry>
2753
2754 <varlistentry>
2755 <term><varname>NFTSet=</varname></term>
2756 <listitem>
2757 <para>This applies the NFT set for the network configuration received with DHCP, like
2758 <varname>NFTSet=</varname> in [Address] section applies it to static configuration. See
2759 <varname>NFTSet=</varname> in [Address] section for more details. For <literal>address</literal>
2760 or <literal>prefix</literal> source types, the type of the element used in the NFT filter must be
2761 <literal>ipv6_addr</literal>.</para>
2762
2763 <xi:include href="version-info.xml" xpointer="v255"/>
2764 </listitem>
2765 </varlistentry>
2766
2767 <!-- How to communicate with the server -->
2768
2769 <varlistentry>
2770 <term><varname>WithoutRA=</varname></term>
2771 <listitem>
2772 <para>Allows DHCPv6 client to start without router advertisements's
2773 <literal>managed</literal> or <literal>other configuration</literal> flag. Takes one of
2774 <literal>no</literal>, <literal>solicit</literal>, or
2775 <literal>information-request</literal>. If this is not specified,
2776 <literal>solicit</literal> is used when <varname>DHCPPrefixDelegation=</varname> is enabled
2777 and <varname>UplinkInterface=:self</varname> is specified in the [DHCPPrefixDelegation]
2778 section. Otherwise, defaults to <literal>no</literal>, and the DHCPv6 client will be started
2779 when an RA is received. See also the <varname>DHCPv6Client=</varname> setting in the
2780 [IPv6AcceptRA] section.</para>
2781
2782 <xi:include href="version-info.xml" xpointer="v246"/>
2783 </listitem>
2784 </varlistentry>
2785 </variablelist>
2786 </refsect1>
2787
2788 <refsect1>
2789 <title>[DHCPPrefixDelegation] Section Options</title>
2790 <para>The [DHCPPrefixDelegation] section configures subnet prefixes of the delegated prefixes
2791 acquired by a DHCPv6 client or by a DHCPv4 client through the 6RD option on another interface.
2792 The settings in this section are used only when the <varname>DHCPPrefixDelegation=</varname>
2793 setting in the [Network] section is enabled.</para>
2794
2795 <variablelist class='network-directives'>
2796 <varlistentry>
2797 <term><varname>UplinkInterface=</varname></term>
2798 <listitem>
2799 <para>Specifies the name or the index of the uplink interface, or one of the special values
2800 <literal>:self</literal> and <literal>:auto</literal>. When <literal>:self</literal>, the
2801 interface itself is considered the uplink interface, and
2802 <varname>WithoutRA=solicit</varname> is implied if the setting is not explicitly specified.
2803 When <literal>:auto</literal>, the first link which acquired prefixes to be delegated from
2804 the DHCPv6 or DHCPv4 server is selected. Defaults to <literal>:auto</literal>.</para>
2805
2806 <xi:include href="version-info.xml" xpointer="v250"/>
2807 </listitem>
2808 </varlistentry>
2809
2810 <varlistentry>
2811 <term><varname>SubnetId=</varname></term>
2812 <listitem>
2813 <para>Configure a specific subnet ID on the interface from a (previously) received prefix
2814 delegation. You can either set "auto" (the default) or a specific subnet ID (as defined in
2815 <ulink url="https://tools.ietf.org/html/rfc4291#section-2.5.4">RFC 4291</ulink>, section
2816 2.5.4), in which case the allowed value is hexadecimal, from 0 to 0x7fffffffffffffff
2817 inclusive.</para>
2818 </listitem>
2819 </varlistentry>
2820
2821 <varlistentry>
2822 <term><varname>Announce=</varname></term>
2823 <listitem>
2824 <para>Takes a boolean. When enabled, and <varname>IPv6SendRA=</varname> in [Network] section
2825 is enabled, the delegated prefixes are distributed through the IPv6 Router Advertisement.
2826 This setting will be ignored when the <varname>DHCPPrefixDelegation=</varname> setting is
2827 enabled on the upstream interface. Defaults to yes.</para>
2828 </listitem>
2829 </varlistentry>
2830
2831 <varlistentry>
2832 <term><varname>Assign=</varname></term>
2833 <listitem>
2834 <para>Takes a boolean. Specifies whether to add an address from the delegated prefixes which
2835 are received from the WAN interface by the DHCPv6 Prefix Delegation. When true (on LAN
2836 interface), the EUI-64 algorithm will be used by default to form an interface identifier from
2837 the delegated prefixes. See also <varname>Token=</varname> setting below. Defaults to yes.
2838 </para>
2839 </listitem>
2840 </varlistentry>
2841
2842 <varlistentry>
2843 <term><varname>Token=</varname></term>
2844 <listitem>
2845 <para>Specifies an optional address generation mode for assigning an address in each
2846 delegated prefix. This accepts the same syntax as <varname>Token=</varname> in the
2847 [IPv6AcceptRA] section. If <varname>Assign=</varname> is set to false, then this setting will
2848 be ignored. Defaults to unset, which means the EUI-64 algorithm will be used.</para>
2849 </listitem>
2850 </varlistentry>
2851
2852 <varlistentry>
2853 <term><varname>ManageTemporaryAddress=</varname></term>
2854 <listitem>
2855 <para>As in the [Address] section, but defaults to true.</para>
2856 </listitem>
2857 </varlistentry>
2858
2859 <varlistentry>
2860 <term><varname>RouteMetric=</varname></term>
2861 <listitem>
2862 <para>The metric of the route to the delegated prefix subnet. Takes an unsigned integer in
2863 the range 0…4294967295. When set to 0, the kernel's default value is used. Defaults to 256.
2864 </para>
2865 </listitem>
2866 </varlistentry>
2867
2868 <varlistentry>
2869 <term><varname>NetLabel=</varname></term>
2870 <listitem>
2871 <para>This applies the NetLabel for the addresses received with DHCP, like
2872 <varname>NetLabel=</varname> in [Address] section applies it to statically configured
2873 addresses. See <varname>NetLabel=</varname> in [Address] section for more details.</para>
2874
2875 <xi:include href="version-info.xml" xpointer="v252"/>
2876 </listitem>
2877 </varlistentry>
2878
2879 <varlistentry>
2880 <term><varname>NFTSet=</varname></term>
2881 <listitem>
2882 <para>This applies the NFT set for the network configuration received with DHCP, like
2883 <varname>NFTSet=</varname> in [Address] section applies it to static configuration. See
2884 <varname>NFTSet=</varname> in [Address] section for more details. For <literal>address</literal> or
2885 <literal>prefix</literal> source types, the type of the element used in the NFT filter must be
2886 <literal>ipv6_addr</literal>.</para>
2887
2888 <xi:include href="version-info.xml" xpointer="v255"/>
2889 </listitem>
2890 </varlistentry>
2891 </variablelist>
2892 </refsect1>
2893
2894 <refsect1>
2895 <title>[IPv6AcceptRA] Section Options</title>
2896 <para>The [IPv6AcceptRA] section configures the IPv6 Router Advertisement (RA) client, if it is enabled
2897 with the <varname>IPv6AcceptRA=</varname> setting described above:</para>
2898
2899 <variablelist class='network-directives'>
2900 <varlistentry>
2901 <term><varname>Token=</varname></term>
2902 <listitem>
2903 <para>Specifies an optional address generation mode for the Stateless Address
2904 Autoconfiguration (SLAAC). The following values are supported:</para>
2905
2906 <variablelist>
2907 <varlistentry>
2908 <term><option>eui64</option></term>
2909 <listitem>
2910 <para>
2911 The EUI-64 algorithm will be used to generate an address for that prefix. Only
2912 supported by Ethernet or InfiniBand interfaces.
2913 </para>
2914
2915 <xi:include href="version-info.xml" xpointer="v250"/>
2916 </listitem>
2917 </varlistentry>
2918 <varlistentry>
2919 <term><option>static:<replaceable>ADDRESS</replaceable></option></term>
2920 <listitem>
2921 <para>
2922 An IPv6 address must be specified after a colon (<literal>:</literal>), and the
2923 lower bits of the supplied address are combined with the upper bits of a prefix
2924 received in a Router Advertisement (RA) message to form a complete address. Note
2925 that if multiple prefixes are received in an RA message, or in multiple RA messages,
2926 addresses will be formed from each of them using the supplied address. This mode
2927 implements SLAAC but uses a static interface identifier instead of an identifier
2928 generated by using the EUI-64 algorithm. Because the interface identifier is static,
2929 if Duplicate Address Detection detects that the computed address is a duplicate
2930 (in use by another node on the link), then this mode will fail to provide an address
2931 for that prefix. If an IPv6 address without mode is specified, then
2932 <literal>static</literal> mode is assumed.
2933 </para>
2934
2935 <xi:include href="version-info.xml" xpointer="v250"/>
2936 </listitem>
2937 </varlistentry>
2938 <varlistentry>
2939 <term><option>prefixstable[:<replaceable>ADDRESS</replaceable>][,<replaceable>UUID</replaceable>]</option></term>
2940 <listitem>
2941 <para>
2942 The algorithm specified in
2943 <ulink url="https://tools.ietf.org/html/rfc7217">RFC 7217</ulink> will be used to
2944 generate interface identifiers. This mode can optionally take an IPv6 address
2945 separated with a colon (<literal>:</literal>). If an IPv6 address is specified,
2946 then an interface identifier is generated only when a prefix received in an RA
2947 message matches the supplied address.
2948 </para>
2949 <para>
2950 This mode can also optionally take a non-null UUID in the format which
2951 <function>sd_id128_from_string()</function> accepts, e.g.
2952 <literal>86b123b969ba4b7eb8b3d8605123525a</literal> or
2953 <literal>86b123b9-69ba-4b7e-b8b3-d8605123525a</literal>. If a UUID is specified, the
2954 value is used as the secret key to generate interface identifiers. If not specified,
2955 then an application specific ID generated with the system's machine-ID will be used
2956 as the secret key. See
2957 <citerefentry><refentrytitle>sd-id128</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
2958 <citerefentry><refentrytitle>sd_id128_from_string</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
2959 and
2960 <citerefentry><refentrytitle>sd_id128_get_machine</refentrytitle><manvolnum>3</manvolnum></citerefentry>.
2961 </para>
2962 <para>
2963 Note that the <literal>prefixstable</literal> algorithm uses both the interface
2964 name and MAC address as input to the hash to compute the interface identifier, so
2965 if either of those are changed the resulting interface identifier (and address)
2966 will be changed, even if the prefix received in the RA message has not been
2967 changed.
2968 </para>
2969
2970 <xi:include href="version-info.xml" xpointer="v250"/>
2971 </listitem>
2972 </varlistentry>
2973 </variablelist>
2974
2975 <para>If no address generation mode is specified (which is the default), or a received
2976 prefix does not match any of the addresses provided in <literal>prefixstable</literal>
2977 mode, then the EUI-64 algorithm will be used for Ethernet or InfiniBand interfaces,
2978 otherwise <literal>prefixstable</literal> will be used to form an interface identifier for
2979 that prefix.</para>
2980
2981 <para>This setting can be specified multiple times. If an empty string is assigned, then
2982 the all previous assignments are cleared.</para>
2983
2984 <para>Examples:
2985 <programlisting>Token=eui64
2986 Token=::1a:2b:3c:4d
2987 Token=static:::1a:2b:3c:4d
2988 Token=prefixstable
2989 Token=prefixstable:2002:da8:1::</programlisting></para>
2990
2991 <xi:include href="version-info.xml" xpointer="v250"/>
2992 </listitem>
2993 </varlistentry>
2994
2995 <varlistentry>
2996 <term><varname>UseDNS=</varname></term>
2997 <listitem>
2998 <para>When true (the default), the DNS servers received in the Router Advertisement will be used.</para>
2999
3000 <para>This corresponds to the <option>nameserver</option> option in <citerefentry
3001 project='man-pages'><refentrytitle>resolv.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para>
3002 </listitem>
3003 </varlistentry>
3004
3005 <varlistentry>
3006 <term><varname>UseDomains=</varname></term>
3007 <listitem>
3008 <para>Takes a boolean, or the special value <literal>route</literal>. When true, the domain name
3009 received via IPv6 Router Advertisement (RA) will be used as DNS search domain over this link,
3010 similarly to the effect of the <option>Domains=</option> setting. If set to
3011 <literal>route</literal>, the domain name received via IPv6 RA will be used for routing DNS queries
3012 only, but not for searching, similarly to the effect of the <option>Domains=</option> setting when
3013 the argument is prefixed with <literal>~</literal>. Defaults to false.</para>
3014
3015 <para>It is recommended to enable this option only on trusted networks, as setting this affects resolution
3016 of all hostnames, in particular of single-label names. It is generally safer to use the supplied domain
3017 only as routing domain, rather than as search domain, in order to not have it affect local resolution of
3018 single-label names.</para>
3019
3020 <para>When set to true, this setting corresponds to the <option>domain</option> option in <citerefentry
3021 project='man-pages'><refentrytitle>resolv.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para>
3022 </listitem>
3023 </varlistentry>
3024
3025 <varlistentry>
3026 <term><varname>RouteTable=<replaceable>num</replaceable></varname></term>
3027 <listitem>
3028 <para>The table identifier for the routes received in the Router Advertisement. Takes one of
3029 predefined names <literal>default</literal>, <literal>main</literal>, and <literal>local</literal>,
3030 and names defined in <varname>RouteTable=</varname> in
3031 <citerefentry><refentrytitle>networkd.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
3032 or a number between 1…4294967295.</para>
3033
3034 <para>When used in combination with <varname>VRF=</varname>, the VRF's routing table is
3035 used when this parameter is not specified.</para>
3036
3037 <xi:include href="version-info.xml" xpointer="v232"/>
3038 </listitem>
3039 </varlistentry>
3040
3041 <varlistentry>
3042 <term><varname>RouteMetric=</varname></term>
3043 <listitem>
3044 <para>Set the routing metric for the routes received in the Router Advertisement. Takes an unsigned
3045 integer in the range 0…4294967295, or three unsigned integer separated with <literal>:</literal>,
3046 in that case the first one is used when the router preference is high, the second is for medium
3047 preference, and the last is for low preference
3048 (<literal><replaceable>high</replaceable>:<replaceable>medium</replaceable>:<replaceable>low</replaceable></literal>).
3049 Defaults to <literal>512:1024:2048</literal>.</para>
3050
3051 <xi:include href="version-info.xml" xpointer="v249"/>
3052 </listitem>
3053 </varlistentry>
3054
3055 <varlistentry>
3056 <term><varname>QuickAck=</varname></term>
3057 <listitem>
3058 <para>Takes a boolean. When true, the TCP quick ACK mode is enabled for the routes configured by
3059 the received RAs. When unset, the kernel's default will be used.</para>
3060
3061 <xi:include href="version-info.xml" xpointer="v253"/>
3062 </listitem>
3063 </varlistentry>
3064
3065 <varlistentry>
3066 <term><varname>UseMTU=</varname></term>
3067 <listitem>
3068 <para>Takes a boolean. When true, the MTU received in the Router Advertisement will be
3069 used. Defaults to true.</para>
3070
3071 <xi:include href="version-info.xml" xpointer="v250"/>
3072 </listitem>
3073 </varlistentry>
3074
3075 <varlistentry>
3076 <term><varname>UseHopLimit=</varname></term>
3077 <listitem>
3078 <para>Takes a boolean. When true, the hop limit received in the Router Advertisement will be set to routes
3079 configured based on the advertisement. See also <varname>IPv6HopLimit=</varname>. Defaults to true.</para>
3080
3081 <xi:include href="version-info.xml" xpointer="v255"/>
3082 </listitem>
3083 </varlistentry>
3084
3085 <varlistentry>
3086 <term><varname>UseICMP6RateLimit=</varname></term>
3087 <listitem>
3088 <para>Takes a boolean. When true, the ICMP6 rate limit received in the Router Advertisement will be set to ICMP6
3089 rate limit based on the advertisement. Defaults to true.</para>
3090
3091 <xi:include href="version-info.xml" xpointer="v255"/>
3092 </listitem>
3093 </varlistentry>
3094
3095 <varlistentry>
3096 <term><varname>UseGateway=</varname></term>
3097 <listitem>
3098 <para>When true (the default), the router address will be configured as the default gateway.
3099 </para>
3100
3101 <xi:include href="version-info.xml" xpointer="v250"/>
3102 </listitem>
3103 </varlistentry>
3104
3105 <varlistentry>
3106 <term><varname>UseRoutePrefix=</varname></term>
3107 <listitem>
3108 <para>When true (the default), the routes corresponding to the route prefixes received in
3109 the Router Advertisement will be configured.</para>
3110
3111 <xi:include href="version-info.xml" xpointer="v250"/>
3112 </listitem>
3113 </varlistentry>
3114
3115 <varlistentry>
3116 <term><varname>UseCaptivePortal=</varname></term>
3117 <listitem>
3118 <para>When true (the default), the captive portal received in the Router Advertisement will be recorded
3119 and made available to client programs and displayed in the networkctl status output per-link.</para>
3120
3121 <xi:include href="version-info.xml" xpointer="v254"/>
3122 </listitem>
3123 </varlistentry>
3124
3125 <varlistentry>
3126 <term><varname>UsePREF64=</varname></term>
3127 <listitem>
3128 <para>When true, the IPv6 PREF64 (or NAT64) prefixes received in the Router Advertisement will be recorded
3129 and made available to client programs and displayed in the <command>networkctl</command> status output per-link.
3130 See <ulink url="https://tools.ietf.org/html/rfc8781">RFC 8781</ulink>. Defaults to false.</para>
3131
3132 <xi:include href="version-info.xml" xpointer="v255"/>
3133 </listitem>
3134 </varlistentry>
3135
3136 <varlistentry>
3137 <term><varname>UseAutonomousPrefix=</varname></term>
3138 <listitem>
3139 <para>When true (the default), the autonomous prefix received in the Router Advertisement will be used and take
3140 precedence over any statically configured ones.</para>
3141
3142 <xi:include href="version-info.xml" xpointer="v242"/>
3143 </listitem>
3144 </varlistentry>
3145
3146 <varlistentry>
3147 <term><varname>UseOnLinkPrefix=</varname></term>
3148 <listitem>
3149 <para>When true (the default), the onlink prefix received in the Router Advertisement will be
3150 used and takes precedence over any statically configured ones.</para>
3151
3152 <xi:include href="version-info.xml" xpointer="v242"/>
3153 </listitem>
3154 </varlistentry>
3155
3156 <varlistentry>
3157 <term><varname>RouterDenyList=</varname></term>
3158 <listitem>
3159 <para>A whitespace-separated list of IPv6 router addresses. Each address can optionally
3160 take a prefix length after <literal>/</literal>. Any information advertised by the listed
3161 router is ignored.</para>
3162
3163 <xi:include href="version-info.xml" xpointer="v248"/>
3164 </listitem>
3165 </varlistentry>
3166
3167 <varlistentry>
3168 <term><varname>RouterAllowList=</varname></term>
3169 <listitem>
3170 <para>A whitespace-separated list of IPv6 router addresses. Each address can optionally
3171 take a prefix length after <literal>/</literal>. Only information advertised by the listed
3172 router is accepted. Note that if <varname>RouterAllowList=</varname> is configured then
3173 <varname>RouterDenyList=</varname> is ignored.</para>
3174
3175 <xi:include href="version-info.xml" xpointer="v248"/>
3176 </listitem>
3177 </varlistentry>
3178
3179 <varlistentry>
3180 <term><varname>PrefixDenyList=</varname></term>
3181 <listitem>
3182 <para>A whitespace-separated list of IPv6 prefixes. Each prefix can optionally take its
3183 prefix length after <literal>/</literal>. IPv6 prefixes supplied via router advertisements
3184 in the list are ignored.</para>
3185
3186 <xi:include href="version-info.xml" xpointer="v248"/>
3187 </listitem>
3188 </varlistentry>
3189
3190 <varlistentry>
3191 <term><varname>PrefixAllowList=</varname></term>
3192 <listitem>
3193 <para>A whitespace-separated list of IPv6 prefixes. Each prefix can optionally take its
3194 prefix length after <literal>/</literal>. IPv6 prefixes supplied via router advertisements
3195 in the list are allowed. Note that if <varname>PrefixAllowList=</varname> is configured
3196 then <varname>PrefixDenyList=</varname> is ignored.</para>
3197
3198 <xi:include href="version-info.xml" xpointer="v248"/>
3199 </listitem>
3200 </varlistentry>
3201
3202 <varlistentry>
3203 <term><varname>RouteDenyList=</varname></term>
3204 <listitem>
3205 <para>A whitespace-separated list of IPv6 route prefixes. Each prefix can optionally take
3206 its prefix length after <literal>/</literal>. IPv6 route prefixes supplied via router
3207 advertisements in the list are ignored.</para>
3208
3209 <xi:include href="version-info.xml" xpointer="v248"/>
3210 </listitem>
3211 </varlistentry>
3212
3213 <varlistentry>
3214 <term><varname>RouteAllowList=</varname></term>
3215 <listitem>
3216 <para>A whitespace-separated list of IPv6 route prefixes. Each prefix can optionally take
3217 its prefix length after <literal>/</literal>. IPv6 route prefixes supplied via router
3218 advertisements in the list are allowed. Note that if <varname>RouteAllowList=</varname> is
3219 configured then <varname>RouteDenyList=</varname> is ignored.</para>
3220
3221 <xi:include href="version-info.xml" xpointer="v248"/>
3222 </listitem>
3223 </varlistentry>
3224
3225 <varlistentry>
3226 <term><varname>DHCPv6Client=</varname></term>
3227 <listitem>
3228 <para>Takes a boolean, or the special value <literal>always</literal>. When true, the
3229 DHCPv6 client will be started in <literal>solicit</literal> mode if the RA has the
3230 <literal>managed</literal> flag or <literal>information-request</literal> mode if the RA
3231 lacks the <literal>managed</literal> flag but has the
3232 <literal>other configuration</literal> flag. If set to <literal>always</literal>, the
3233 DHCPv6 client will be started in <literal>solicit</literal> mode when an RA is received,
3234 even if neither the <literal>managed</literal> nor the
3235 <literal>other configuration</literal> flag is set in the RA. This will be ignored when
3236 <varname>WithoutRA=</varname> in the [DHCPv6] section is enabled, or
3237 <varname>UplinkInterface=:self</varname> in the [DHCPPrefixDelegation] section is
3238 specified. Defaults to true.</para>
3239
3240 <xi:include href="version-info.xml" xpointer="v246"/>
3241 </listitem>
3242 </varlistentry>
3243
3244 <varlistentry>
3245 <term><varname>NetLabel=</varname></term>
3246 <listitem>
3247 <para>This applies the NetLabel for the addresses received with RA, like
3248 <varname>NetLabel=</varname> in [Address] section applies it to statically configured
3249 addresses. See <varname>NetLabel=</varname> in [Address] section for more details.</para>
3250
3251 <xi:include href="version-info.xml" xpointer="v252"/>
3252 </listitem>
3253 </varlistentry>
3254
3255 <varlistentry>
3256 <term><varname>NFTSet=</varname></term>
3257 <listitem>
3258 <para>This applies the NFT set for the network configuration received with RA, like
3259 <varname>NFTSet=</varname> in [Address] section applies it to static configuration. See
3260 <varname>NFTSet=</varname> in [Address] section for more details. For <literal>address</literal> or
3261 <literal>prefix</literal> source types, the type of the element used in the NFT filter must be
3262 <literal>ipv6_addr</literal>.</para>
3263
3264 <xi:include href="version-info.xml" xpointer="v255"/>
3265 </listitem>
3266 </varlistentry>
3267 </variablelist>
3268 </refsect1>
3269
3270 <refsect1>
3271 <title>[DHCPServer] Section Options</title>
3272 <para>The [DHCPServer] section contains settings for the DHCP server, if enabled via the
3273 <varname>DHCPServer=</varname> option described above:</para>
3274
3275 <variablelist class='network-directives'>
3276
3277 <varlistentry>
3278 <term><varname>ServerAddress=</varname></term>
3279 <listitem><para>Specifies server address for the DHCP server. Takes an IPv4 address with prefix
3280 length, for example 192.168.0.1/24. This setting may be useful when the link on
3281 which the DHCP server is running has multiple static addresses. When unset, one of static addresses
3282 in the link will be automatically selected. Defaults to unset.</para>
3283
3284 <xi:include href="version-info.xml" xpointer="v249"/></listitem>
3285 </varlistentry>
3286
3287 <varlistentry>
3288 <term><varname>PoolOffset=</varname></term>
3289 <term><varname>PoolSize=</varname></term>
3290
3291 <listitem><para>Configures the pool of addresses to hand out. The pool
3292 is a contiguous sequence of IP addresses in the subnet configured for
3293 the server address, which does not include the subnet nor the broadcast
3294 address. <varname>PoolOffset=</varname> takes the offset of the pool
3295 from the start of subnet, or zero to use the default value.
3296 <varname>PoolSize=</varname> takes the number of IP addresses in the
3297 pool or zero to use the default value. By default, the pool starts at
3298 the first address after the subnet address and takes up the rest of
3299 the subnet, excluding the broadcast address. If the pool includes
3300 the server address (the default), this is reserved and not handed
3301 out to clients.</para>
3302
3303 <xi:include href="version-info.xml" xpointer="v226"/></listitem>
3304 </varlistentry>
3305
3306 <varlistentry>
3307 <term><varname>DefaultLeaseTimeSec=</varname></term>
3308 <term><varname>MaxLeaseTimeSec=</varname></term>
3309
3310 <listitem><para>Control the default and maximum DHCP lease
3311 time to pass to clients. These settings take time values in seconds or
3312 another common time unit, depending on the suffix. The default
3313 lease time is used for clients that did not ask for a specific
3314 lease time. If a client asks for a lease time longer than the
3315 maximum lease time, it is automatically shortened to the
3316 specified time. The default lease time defaults to 1h, the
3317 maximum lease time to 12h. Shorter lease times are beneficial
3318 if the configuration data in DHCP leases changes frequently
3319 and clients shall learn the new settings with shorter
3320 latencies. Longer lease times reduce the generated DHCP
3321 network traffic.</para>
3322
3323 <xi:include href="version-info.xml" xpointer="v226"/></listitem>
3324 </varlistentry>
3325
3326 <varlistentry>
3327 <term><varname>UplinkInterface=</varname></term>
3328 <listitem><para>Specifies the name or the index of the uplink interface, or one of the special
3329 values <literal>:none</literal> and <literal>:auto</literal>. When emitting DNS, NTP, or SIP
3330 servers is enabled but no servers are specified, the servers configured in the uplink interface
3331 will be emitted. When <literal>:auto</literal>, the link which has a default gateway with the
3332 highest priority will be automatically selected. When <literal>:none</literal>, no uplink
3333 interface will be selected. Defaults to <literal>:auto</literal>.</para>
3334
3335 <xi:include href="version-info.xml" xpointer="v249"/></listitem>
3336 </varlistentry>
3337
3338 <varlistentry>
3339 <term><varname>EmitDNS=</varname></term>
3340 <term><varname>DNS=</varname></term>
3341
3342 <listitem><para><varname>EmitDNS=</varname> takes a boolean. Configures whether the DHCP leases
3343 handed out to clients shall contain DNS server information. Defaults to <literal>yes</literal>.
3344 The DNS servers to pass to clients may be configured with the <varname>DNS=</varname> option,
3345 which takes a list of IPv4 addresses, or special value <literal>_server_address</literal> which
3346 will be converted to the address used by the DHCP server.</para>
3347
3348 <para>If the <varname>EmitDNS=</varname> option is enabled but no servers configured, the
3349 servers are automatically propagated from an "uplink" interface that has appropriate servers
3350 set. The "uplink" interface is determined by the default route of the system with the highest
3351 priority. Note that this information is acquired at the time the lease is handed out, and does
3352 not take uplink interfaces into account that acquire DNS server information at a later point.
3353 If no suitable uplink interface is found the DNS server data from
3354 <filename>/etc/resolv.conf</filename> is used. Also, note that the leases are not refreshed if
3355 the uplink network configuration changes. To ensure clients regularly acquire the most current
3356 uplink DNS server information, it is thus advisable to shorten the DHCP lease time via
3357 <varname>MaxLeaseTimeSec=</varname> described above.</para>
3358
3359 <para>This setting can be specified multiple times. If an empty string is specified, then all
3360 DNS servers specified earlier are cleared.</para>
3361
3362 <xi:include href="version-info.xml" xpointer="v226"/></listitem>
3363 </varlistentry>
3364
3365 <varlistentry>
3366 <term><varname>EmitNTP=</varname></term>
3367 <term><varname>NTP=</varname></term>
3368 <term><varname>EmitSIP=</varname></term>
3369 <term><varname>SIP=</varname></term>
3370 <term><varname>EmitPOP3=</varname></term>
3371 <term><varname>POP3=</varname></term>
3372 <term><varname>EmitSMTP=</varname></term>
3373 <term><varname>SMTP=</varname></term>
3374 <term><varname>EmitLPR=</varname></term>
3375 <term><varname>LPR=</varname></term>
3376
3377 <listitem><para>Similar to the <varname>EmitDNS=</varname> and <varname>DNS=</varname> settings
3378 described above, these settings configure whether and what server information for the indicate
3379 protocol shall be emitted as part of the DHCP lease. The same syntax, propagation semantics and
3380 defaults apply as for <varname>EmitDNS=</varname> and <varname>DNS=</varname>.</para></listitem>
3381 </varlistentry>
3382
3383 <varlistentry>
3384 <term><varname>EmitRouter=</varname></term>
3385 <term><varname>Router=</varname></term>
3386
3387 <listitem><para>The <varname>EmitRouter=</varname> setting takes a boolean value, and configures
3388 whether the DHCP lease should contain the router option. The <varname>Router=</varname> setting
3389 takes an IPv4 address, and configures the router address to be emitted. When the
3390 <varname>Router=</varname> setting is not specified, then the server address will be used for
3391 the router option. When the <varname>EmitRouter=</varname> setting is disabled, the
3392 <varname>Router=</varname> setting will be ignored. The <varname>EmitRouter=</varname> setting
3393 defaults to true, and the <varname>Router=</varname> setting defaults to unset.
3394 </para></listitem>
3395 </varlistentry>
3396
3397 <varlistentry>
3398 <term><varname>EmitTimezone=</varname></term>
3399 <term><varname>Timezone=</varname></term>
3400
3401 <listitem><para>Takes a boolean. Configures whether the DHCP leases handed out
3402 to clients shall contain timezone information. Defaults to <literal>yes</literal>. The
3403 <varname>Timezone=</varname> setting takes a timezone string
3404 (such as <literal>Europe/Berlin</literal> or
3405 <literal>UTC</literal>) to pass to clients. If no explicit
3406 timezone is set, the system timezone of the local host is
3407 propagated, as determined by the
3408 <filename>/etc/localtime</filename> symlink.</para>
3409
3410 <xi:include href="version-info.xml" xpointer="v226"/></listitem>
3411 </varlistentry>
3412
3413 <varlistentry>
3414 <term><varname>BootServerAddress=</varname></term>
3415
3416 <listitem>
3417 <para>Takes an IPv4 address of the boot server used by e.g. PXE boot systems. When specified, this
3418 address is sent in the <option>siaddr</option> field of the DHCP message header. See <ulink
3419 url="https://www.rfc-editor.org/rfc/rfc2131.html">RFC 2131</ulink> for more details. Defaults to
3420 unset.</para>
3421
3422 <xi:include href="version-info.xml" xpointer="v251"/>
3423 </listitem>
3424 </varlistentry>
3425
3426 <varlistentry>
3427 <term><varname>BootServerName=</varname></term>
3428
3429 <listitem>
3430 <para>Takes a name of the boot server used by e.g. PXE boot systems. When specified, this name is
3431 sent in the DHCP option 66 ("TFTP server name"). See <ulink
3432 url="https://www.rfc-editor.org/rfc/rfc2132.html">RFC 2132</ulink> for more details. Defaults to
3433 unset.</para>
3434
3435 <para>Note that typically setting one of <varname>BootServerName=</varname> or
3436 <varname>BootServerAddress=</varname> is sufficient, but both can be set too, if desired.</para>
3437
3438 <xi:include href="version-info.xml" xpointer="v251"/>
3439 </listitem>
3440 </varlistentry>
3441
3442 <varlistentry>
3443 <term><varname>BootFilename=</varname></term>
3444
3445 <listitem>
3446 <para>Takes a path or URL to a file loaded by e.g. a PXE boot loader. When specified, this path is
3447 sent in the DHCP option 67 ("Bootfile name"). See <ulink
3448 url="https://www.rfc-editor.org/rfc/rfc2132.html">RFC 2132</ulink> for more details. Defaults to
3449 unset.</para>
3450
3451 <xi:include href="version-info.xml" xpointer="v251"/>
3452 </listitem>
3453 </varlistentry>
3454
3455 <varlistentry>
3456 <term><varname>SendOption=</varname></term>
3457 <listitem>
3458 <para>Send a raw option with value via DHCPv4 server. Takes a DHCP option number, data type
3459 and data (<literal><replaceable>option</replaceable>:<replaceable>type</replaceable>:<replaceable>value</replaceable></literal>).
3460 The option number is an integer in the range 1…254. The type takes one of <literal>uint8</literal>,
3461 <literal>uint16</literal>, <literal>uint32</literal>, <literal>ipv4address</literal>, <literal>ipv6address</literal>, or
3462 <literal>string</literal>. Special characters in the data string may be escaped using
3463 <ulink url="https://en.wikipedia.org/wiki/Escape_sequences_in_C#Table_of_escape_sequences">C-style
3464 escapes</ulink>. This setting can be specified multiple times. If an empty string is specified,
3465 then all options specified earlier are cleared. Defaults to unset.</para>
3466
3467 <xi:include href="version-info.xml" xpointer="v244"/>
3468 </listitem>
3469 </varlistentry>
3470
3471 <varlistentry>
3472 <term><varname>SendVendorOption=</varname></term>
3473 <listitem>
3474 <para>Send a vendor option with value via DHCPv4 server. Takes a DHCP option number, data type
3475 and data (<literal><replaceable>option</replaceable>:<replaceable>type</replaceable>:<replaceable>value</replaceable></literal>).
3476 The option number is an integer in the range 1…254. The type takes one of <literal>uint8</literal>,
3477 <literal>uint16</literal>, <literal>uint32</literal>, <literal>ipv4address</literal>, or
3478 <literal>string</literal>. Special characters in the data string may be escaped using
3479 <ulink url="https://en.wikipedia.org/wiki/Escape_sequences_in_C#Table_of_escape_sequences">C-style
3480 escapes</ulink>. This setting can be specified multiple times. If an empty string is specified,
3481 then all options specified earlier are cleared. Defaults to unset.</para>
3482
3483 <xi:include href="version-info.xml" xpointer="v246"/>
3484 </listitem>
3485 </varlistentry>
3486 <varlistentry>
3487 <term><varname>BindToInterface=</varname></term>
3488 <listitem>
3489 <para>Takes a boolean value. When <literal>yes</literal>, DHCP server socket will be bound
3490 to its network interface and all socket communication will be restricted to this interface.
3491 Defaults to <literal>yes</literal>, except if <varname>RelayTarget=</varname> is used (see below),
3492 in which case it defaults to <literal>no</literal>.</para>
3493
3494 <xi:include href="version-info.xml" xpointer="v249"/>
3495 </listitem>
3496 </varlistentry>
3497 <varlistentry>
3498 <term><varname>RelayTarget=</varname></term>
3499 <listitem>
3500 <para>Takes an IPv4 address, which must be in the format described in
3501 <citerefentry project='man-pages'><refentrytitle>inet_pton</refentrytitle><manvolnum>3</manvolnum></citerefentry>.
3502 Turns this DHCP server into a DHCP relay agent. See <ulink url="https://tools.ietf.org/html/rfc1542">RFC 1542</ulink>.
3503 The address is the address of DHCP server or another relay agent to forward DHCP messages to and from.</para>
3504
3505 <xi:include href="version-info.xml" xpointer="v249"/>
3506 </listitem>
3507 </varlistentry>
3508 <varlistentry>
3509 <term><varname>RelayAgentCircuitId=</varname></term>
3510 <listitem>
3511 <para>Specifies value for Agent Circuit ID suboption of Relay Agent Information option.
3512 Takes a string, which must be in the format <literal>string:<replaceable>value</replaceable></literal>,
3513 where <literal><replaceable>value</replaceable></literal> should be replaced with the value of the suboption.
3514 Defaults to unset (means no Agent Circuit ID suboption is generated).
3515 Ignored if <varname>RelayTarget=</varname> is not specified.</para>
3516
3517 <xi:include href="version-info.xml" xpointer="v249"/>
3518 </listitem>
3519 </varlistentry>
3520 <varlistentry>
3521 <term><varname>RelayAgentRemoteId=</varname></term>
3522 <listitem>
3523 <para>Specifies value for Agent Remote ID suboption of Relay Agent Information option.
3524 Takes a string, which must be in the format <literal>string:<replaceable>value</replaceable></literal>,
3525 where <literal><replaceable>value</replaceable></literal> should be replaced with the value of the suboption.
3526 Defaults to unset (means no Agent Remote ID suboption is generated).
3527 Ignored if <varname>RelayTarget=</varname> is not specified.</para>
3528
3529 <xi:include href="version-info.xml" xpointer="v249"/>
3530 </listitem>
3531 </varlistentry>
3532
3533 </variablelist>
3534 </refsect1>
3535
3536 <refsect1>
3537 <title>[DHCPServerStaticLease] Section Options</title>
3538 <para>The <literal>[DHCPServerStaticLease]</literal> section configures a static DHCP lease to assign a
3539 fixed IPv4 address to a specific device based on its MAC address. This section can be specified multiple
3540 times.</para>
3541
3542 <variablelist class='network-directives'>
3543 <varlistentry>
3544 <term><varname>MACAddress=</varname></term>
3545
3546 <listitem><para>The hardware address of a device to match. This key is mandatory.</para></listitem>
3547 </varlistentry>
3548
3549 <varlistentry>
3550 <term><varname>Address=</varname></term>
3551
3552 <listitem><para>The IPv4 address that should be assigned to the device that was matched with
3553 <varname>MACAddress=</varname>. This key is mandatory.</para>
3554
3555 <xi:include href="version-info.xml" xpointer="v249"/></listitem>
3556 </varlistentry>
3557 </variablelist>
3558 </refsect1>
3559
3560 <refsect1>
3561 <title>[IPv6SendRA] Section Options</title>
3562 <para>The [IPv6SendRA] section contains settings for sending IPv6 Router Advertisements and whether
3563 to act as a router, if enabled via the <varname>IPv6SendRA=</varname> option described above. IPv6
3564 network prefixes or routes are defined with one or more [IPv6Prefix] or [IPv6RoutePrefix] sections.
3565 </para>
3566
3567 <variablelist class='network-directives'>
3568
3569 <varlistentry>
3570 <term><varname>Managed=</varname></term>
3571 <term><varname>OtherInformation=</varname></term>
3572
3573 <listitem><para>Takes a boolean. Controls whether a DHCPv6 server is used to acquire IPv6
3574 addresses on the network link when <varname>Managed=</varname>
3575 is set to <literal>true</literal> or if only additional network
3576 information can be obtained via DHCPv6 for the network link when
3577 <varname>OtherInformation=</varname> is set to
3578 <literal>true</literal>. Both settings default to
3579 <literal>false</literal>, which means that a DHCPv6 server is not being
3580 used.</para></listitem>
3581 </varlistentry>
3582
3583 <varlistentry>
3584 <term><varname>RouterLifetimeSec=</varname></term>
3585
3586 <listitem><para>Takes a timespan. Configures the IPv6 router lifetime in seconds. The value must be 0
3587 seconds, or between 4 seconds and 9000 seconds. When set to 0, the host is not acting as a router.
3588 Defaults to 1800 seconds (30 minutes).</para>
3589 </listitem>
3590 </varlistentry>
3591
3592 <varlistentry>
3593 <term><varname>RetransmitSec=</varname></term>
3594
3595 <listitem><para>Takes a timespan. Configures the retransmit time, used by clients to retransmit Neighbor
3596 Solicitation messages on address resolution and the Neighbor Unreachability Detection algorithm.
3597 An integer the default unit of seconds, in the range 0…4294967295 msec. Defaults to 0.</para>
3598
3599 <xi:include href="version-info.xml" xpointer="v255"/>
3600 </listitem>
3601 </varlistentry>
3602
3603 <varlistentry>
3604 <term><varname>RouterPreference=</varname></term>
3605
3606 <listitem><para>Configures IPv6 router preference if
3607 <varname>RouterLifetimeSec=</varname> is non-zero. Valid values are
3608 <literal>high</literal>, <literal>medium</literal> and
3609 <literal>low</literal>, with <literal>normal</literal> and
3610 <literal>default</literal> added as synonyms for
3611 <literal>medium</literal> just to make configuration easier. See
3612 <ulink url="https://tools.ietf.org/html/rfc4191">RFC 4191</ulink>
3613 for details. Defaults to <literal>medium</literal>.</para></listitem>
3614 </varlistentry>
3615
3616 <varlistentry>
3617 <term><varname>HopLimit=</varname></term>
3618 <listitem>
3619 <para>Configures hop limit. Takes an integer in the range 0…255. See also
3620 <varname>IPv6HopLimit=</varname>.</para>
3621
3622 <xi:include href="version-info.xml" xpointer="v255"/>
3623 </listitem>
3624 </varlistentry>
3625
3626 <varlistentry>
3627 <term><varname>UplinkInterface=</varname></term>
3628 <listitem><para>Specifies the name or the index of the uplink interface, or one of the special
3629 values <literal>:none</literal> and <literal>:auto</literal>. When emitting DNS servers or
3630 search domains is enabled but no servers are specified, the servers configured in the uplink
3631 interface will be emitted. When <literal>:auto</literal>, the value specified to the same
3632 setting in the [DHCPPrefixDelegation] section will be used if
3633 <varname>DHCPPrefixDelegation=</varname> is enabled, otherwise the link which has a default
3634 gateway with the highest priority will be automatically selected. When <literal>:none</literal>,
3635 no uplink interface will be selected. Defaults to <literal>:auto</literal>.</para>
3636
3637 <xi:include href="version-info.xml" xpointer="v250"/></listitem>
3638 </varlistentry>
3639
3640 <varlistentry>
3641 <term><varname>EmitDNS=</varname></term>
3642 <term><varname>DNS=</varname></term>
3643
3644 <listitem><para><varname>DNS=</varname> specifies a list of recursive DNS server IPv6 addresses
3645 that are distributed via Router Advertisement messages when <varname>EmitDNS=</varname> is true.
3646 <varname>DNS=</varname> also takes special value <literal>_link_local</literal>; in that case
3647 the IPv6 link-local address is distributed. If <varname>DNS=</varname> is empty, DNS servers are
3648 read from the [Network] section. If the [Network] section does not contain any DNS servers
3649 either, DNS servers from the uplink interface specified in <varname>UplinkInterface=</varname>
3650 will be used. When <varname>EmitDNS=</varname> is false, no DNS server information is sent in
3651 Router Advertisement messages. <varname>EmitDNS=</varname> defaults to true.</para></listitem>
3652 </varlistentry>
3653
3654 <varlistentry>
3655 <term><varname>EmitDomains=</varname></term>
3656 <term><varname>Domains=</varname></term>
3657
3658 <listitem><para>A list of DNS search domains distributed via Router Advertisement messages when
3659 <varname>EmitDomains=</varname> is true. If <varname>Domains=</varname> is empty, DNS search
3660 domains are read from the [Network] section. If the [Network] section does not contain any DNS
3661 search domains either, DNS search domains from the uplink interface specified in
3662 <varname>UplinkInterface=</varname> will be used. When <varname>EmitDomains=</varname> is false,
3663 no DNS search domain information is sent in Router Advertisement messages.
3664 <varname>EmitDomains=</varname> defaults to true.</para></listitem>
3665 </varlistentry>
3666
3667 <varlistentry>
3668 <term><varname>DNSLifetimeSec=</varname></term>
3669
3670 <listitem><para>Lifetime in seconds for the DNS server addresses listed in
3671 <varname>DNS=</varname> and search domains listed in <varname>Domains=</varname>. Defaults to
3672 3600 seconds (one hour).</para></listitem>
3673 </varlistentry>
3674
3675 <varlistentry>
3676 <term><varname>HomeAgent=</varname></term>
3677
3678 <listitem><para>Takes a boolean. Specifies that IPv6 router advertisements which indicates to hosts that
3679 the router acts as a Home Agent and includes a Home Agent Option. Defaults to false. See
3680 <ulink url="https://tools.ietf.org/html/rfc6275">RFC 6275</ulink> for further details.</para>
3681
3682 <xi:include href="version-info.xml" xpointer="v255"/>
3683 </listitem>
3684 </varlistentry>
3685
3686 <varlistentry>
3687 <term><varname>HomeAgentLifetimeSec=</varname></term>
3688
3689 <listitem><para>Takes a timespan. Specifies the lifetime of the Home Agent. An integer the default unit of seconds,
3690 in the range 1…65535. Defaults to the value set to <varname>RouterLifetimeSec=</varname>.</para>
3691
3692 <xi:include href="version-info.xml" xpointer="v255"/>
3693 </listitem>
3694 </varlistentry>
3695
3696 <varlistentry>
3697 <term><varname>HomeAgentPreference=</varname></term>
3698
3699 <listitem><para>Configures IPv6 Home Agent preference. Takes an integer in the range 0…65535.
3700 Defaults to 0.</para>
3701
3702 <xi:include href="version-info.xml" xpointer="v255"/>
3703 </listitem>
3704 </varlistentry>
3705
3706 </variablelist>
3707 </refsect1>
3708
3709 <refsect1>
3710 <title>[IPv6Prefix] Section Options</title>
3711 <para>One or more [IPv6Prefix] sections contain the IPv6 prefixes that are announced via Router
3712 Advertisements. See <ulink url="https://tools.ietf.org/html/rfc4861">RFC 4861</ulink> for further
3713 details.</para>
3714
3715 <variablelist class='network-directives'>
3716
3717 <varlistentry>
3718 <term><varname>AddressAutoconfiguration=</varname></term>
3719 <term><varname>OnLink=</varname></term>
3720
3721 <listitem><para>Takes a boolean to specify whether IPv6 addresses can be
3722 autoconfigured with this prefix and whether the prefix can be used for
3723 onlink determination. Both settings default to <literal>true</literal>
3724 in order to ease configuration.
3725 </para>
3726
3727 <xi:include href="version-info.xml" xpointer="v235"/></listitem>
3728 </varlistentry>
3729
3730 <varlistentry>
3731 <term><varname>Prefix=</varname></term>
3732
3733 <listitem><para>The IPv6 prefix that is to be distributed to hosts. Similarly to configuring static
3734 IPv6 addresses, the setting is configured as an IPv6 prefix and its prefix length, separated by a
3735 <literal>/</literal> character. Use multiple [IPv6Prefix] sections to configure multiple IPv6
3736 prefixes since prefix lifetimes, address autoconfiguration and onlink status may differ from one
3737 prefix to another.</para>
3738
3739 <xi:include href="version-info.xml" xpointer="v235"/></listitem>
3740 </varlistentry>
3741
3742 <varlistentry>
3743 <term><varname>PreferredLifetimeSec=</varname></term>
3744 <term><varname>ValidLifetimeSec=</varname></term>
3745
3746 <listitem><para>Preferred and valid lifetimes for the prefix measured in seconds.
3747 <varname>PreferredLifetimeSec=</varname> defaults to 1800 seconds (30 minutes) and
3748 <varname>ValidLifetimeSec=</varname> defaults to 3600 seconds (one hour).</para>
3749
3750 <xi:include href="version-info.xml" xpointer="v235"/></listitem>
3751 </varlistentry>
3752
3753 <varlistentry>
3754 <term><varname>Assign=</varname></term>
3755 <listitem><para>Takes a boolean. When true, adds an address from the prefix. Default to false.
3756 </para>
3757
3758 <xi:include href="version-info.xml" xpointer="v246"/></listitem>
3759 </varlistentry>
3760
3761 <varlistentry>
3762 <term><varname>Token=</varname></term>
3763 <listitem>
3764 <para>Specifies an optional address generation mode for assigning an address in each
3765 prefix. This accepts the same syntax as <varname>Token=</varname> in the [IPv6AcceptRA]
3766 section. If <varname>Assign=</varname> is set to false, then this setting will be ignored.
3767 Defaults to unset, which means the EUI-64 algorithm will be used.</para>
3768
3769 <xi:include href="version-info.xml" xpointer="v250"/>
3770 </listitem>
3771 </varlistentry>
3772
3773 <varlistentry>
3774 <term><varname>RouteMetric=</varname></term>
3775 <listitem>
3776 <para>The metric of the prefix route. Takes an unsigned integer in the range 0…4294967295.
3777 When unset or set to 0, the kernel's default value is used. This setting is ignored when
3778 <varname>Assign=</varname> is false.</para>
3779
3780 <xi:include href="version-info.xml" xpointer="v249"/>
3781 </listitem>
3782 </varlistentry>
3783 </variablelist>
3784 </refsect1>
3785
3786 <refsect1>
3787 <title>[IPv6RoutePrefix] Section Options</title>
3788 <para>One or more [IPv6RoutePrefix] sections contain the IPv6
3789 prefix routes that are announced via Router Advertisements. See
3790 <ulink url="https://tools.ietf.org/html/rfc4191">RFC 4191</ulink>
3791 for further details.</para>
3792
3793 <variablelist class='network-directives'>
3794
3795 <varlistentry>
3796 <term><varname>Route=</varname></term>
3797
3798 <listitem><para>The IPv6 route that is to be distributed to hosts. Similarly to configuring static
3799 IPv6 routes, the setting is configured as an IPv6 prefix routes and its prefix route length,
3800 separated by a <literal>/</literal> character. Use multiple [IPv6RoutePrefix] sections to configure
3801 multiple IPv6 prefix routes.</para>
3802
3803 <xi:include href="version-info.xml" xpointer="v244"/></listitem>
3804 </varlistentry>
3805
3806 <varlistentry>
3807 <term><varname>LifetimeSec=</varname></term>
3808
3809 <listitem><para>Lifetime for the route prefix measured in seconds.
3810 <varname>LifetimeSec=</varname> defaults to 3600 seconds (one hour).</para>
3811
3812 <xi:include href="version-info.xml" xpointer="v244"/></listitem>
3813 </varlistentry>
3814
3815 </variablelist>
3816 </refsect1>
3817
3818 <refsect1>
3819 <title>[IPv6PREF64Prefix] Section Options</title>
3820 <para>One or more [IPv6PREF64Prefix] sections contain the IPv6 PREF64 (or NAT64) prefixes that are announced via Router
3821 Advertisements. See <ulink url="https://tools.ietf.org/html/rfc8781">RFC 8781</ulink> for further
3822 details.</para>
3823
3824 <variablelist class='network-directives'>
3825
3826 <varlistentry>
3827 <term><varname>Prefix=</varname></term>
3828
3829 <listitem><para>The IPv6 PREF64 (or NAT64) prefix that is to be distributed to hosts. The setting holds
3830 an IPv6 prefix that should be set up for NAT64 translation (PLAT) to allow 464XLAT on the network segment.
3831 Use multiple [IPv6PREF64Prefix] sections to configure multiple IPv6 prefixes since prefix lifetime may differ
3832 from one prefix to another. The prefix is an address with a prefix length, separated by a slash
3833 <literal>/</literal> character. Valid NAT64 prefix length are 96, 64, 56, 48, 40, and 32 bits.</para>
3834
3835 <xi:include href="version-info.xml" xpointer="v255"/></listitem></varlistentry>
3836
3837 <varlistentry>
3838 <term><varname>LifetimeSec=</varname></term>
3839 <listitem><para>Lifetime for the prefix measured in seconds. Should be greater than or equal to <varname>RouterLifetimeSec=</varname>.
3840 <varname>LifetimeSec=</varname> defaults to 1800 seconds.</para>
3841
3842 <xi:include href="version-info.xml" xpointer="v255"/></listitem>
3843 </varlistentry>
3844 </variablelist>
3845 </refsect1>
3846
3847 <refsect1>
3848 <title>[Bridge] Section Options</title>
3849 <para>The [Bridge] section accepts the following keys:</para>
3850 <variablelist class='network-directives'>
3851 <varlistentry>
3852 <term><varname>UnicastFlood=</varname></term>
3853 <listitem>
3854 <para>Takes a boolean. Controls whether the bridge should flood
3855 traffic for which an FDB entry is missing and the destination
3856 is unknown through this port. When unset, the kernel's default will be used.
3857 </para>
3858
3859 <xi:include href="version-info.xml" xpointer="v223"/>
3860 </listitem>
3861 </varlistentry>
3862 <varlistentry>
3863 <term><varname>MulticastFlood=</varname></term>
3864 <listitem>
3865 <para>Takes a boolean. Controls whether the bridge should flood
3866 traffic for which an MDB entry is missing and the destination
3867 is unknown through this port. When unset, the kernel's default will be used.
3868 </para>
3869
3870 <xi:include href="version-info.xml" xpointer="v242"/>
3871 </listitem>
3872 </varlistentry>
3873 <varlistentry>
3874 <term><varname>MulticastToUnicast=</varname></term>
3875 <listitem>
3876 <para>Takes a boolean. Multicast to unicast works on top of the multicast snooping feature of
3877 the bridge. Which means unicast copies are only delivered to hosts which are interested in it.
3878 When unset, the kernel's default will be used.
3879 </para>
3880
3881 <xi:include href="version-info.xml" xpointer="v240"/>
3882 </listitem>
3883 </varlistentry>
3884 <varlistentry>
3885 <term><varname>NeighborSuppression=</varname></term>
3886 <listitem>
3887 <para>Takes a boolean. Configures whether ARP and ND neighbor suppression is enabled for
3888 this port. When unset, the kernel's default will be used.
3889 </para>
3890
3891 <xi:include href="version-info.xml" xpointer="v242"/>
3892 </listitem>
3893 </varlistentry>
3894 <varlistentry>
3895 <term><varname>Learning=</varname></term>
3896 <listitem>
3897 <para>Takes a boolean. Configures whether MAC address learning is enabled for
3898 this port. When unset, the kernel's default will be used.
3899 </para>
3900
3901 <xi:include href="version-info.xml" xpointer="v242"/>
3902 </listitem>
3903 </varlistentry>
3904 <varlistentry>
3905 <term><varname>HairPin=</varname></term>
3906 <listitem>
3907 <para>Takes a boolean. Configures whether traffic may be sent back out of the port on which it
3908 was received. When this flag is false, then the bridge will not forward traffic back out of the
3909 receiving port. When unset, the kernel's default will be used.</para>
3910
3911 <xi:include href="version-info.xml" xpointer="v223"/>
3912 </listitem>
3913 </varlistentry>
3914 <varlistentry>
3915 <term><varname>Isolated=</varname></term>
3916 <listitem>
3917 <para>Takes a boolean. Configures whether this port is isolated or not. Within a bridge,
3918 isolated ports can only communicate with non-isolated ports. When set to true, this port can only
3919 communicate with other ports whose Isolated setting is false. When set to false, this port
3920 can communicate with any other ports. When unset, the kernel's default will be used.</para>
3921
3922 <xi:include href="version-info.xml" xpointer="v251"/>
3923 </listitem>
3924 </varlistentry>
3925 <varlistentry>
3926 <term><varname>UseBPDU=</varname></term>
3927 <listitem>
3928 <para>Takes a boolean. Configures whether STP Bridge Protocol Data Units will be
3929 processed by the bridge port. When unset, the kernel's default will be used.</para>
3930
3931 <xi:include href="version-info.xml" xpointer="v223"/>
3932 </listitem>
3933 </varlistentry>
3934 <varlistentry>
3935 <term><varname>FastLeave=</varname></term>
3936 <listitem>
3937 <para>Takes a boolean. This flag allows the bridge to immediately stop multicast
3938 traffic on a port that receives an IGMP Leave message. It is only used with
3939 IGMP snooping if enabled on the bridge. When unset, the kernel's default will be used.</para>
3940
3941 <xi:include href="version-info.xml" xpointer="v223"/>
3942 </listitem>
3943 </varlistentry>
3944 <varlistentry>
3945 <term><varname>AllowPortToBeRoot=</varname></term>
3946 <listitem>
3947 <para>Takes a boolean. Configures whether a given port is allowed to
3948 become a root port. Only used when STP is enabled on the bridge.
3949 When unset, the kernel's default will be used.</para>
3950
3951 <xi:include href="version-info.xml" xpointer="v223"/>
3952 </listitem>
3953 </varlistentry>
3954 <varlistentry>
3955 <term><varname>ProxyARP=</varname></term>
3956 <listitem>
3957 <para>Takes a boolean. Configures whether proxy ARP to be enabled on this port.
3958 When unset, the kernel's default will be used.</para>
3959
3960 <xi:include href="version-info.xml" xpointer="v243"/>
3961 </listitem>
3962 </varlistentry>
3963 <varlistentry>
3964 <term><varname>ProxyARPWiFi=</varname></term>
3965 <listitem>
3966 <para>Takes a boolean. Configures whether proxy ARP to be enabled on this port
3967 which meets extended requirements by IEEE 802.11 and Hotspot 2.0 specifications.
3968 When unset, the kernel's default will be used.</para>
3969
3970 <xi:include href="version-info.xml" xpointer="v243"/>
3971 </listitem>
3972 </varlistentry>
3973 <varlistentry>
3974 <term><varname>MulticastRouter=</varname></term>
3975 <listitem>
3976 <para>Configures this port for having multicast routers attached. A port with a multicast
3977 router will receive all multicast traffic. Takes one of <literal>no</literal>
3978 to disable multicast routers on this port, <literal>query</literal> to let the system detect
3979 the presence of routers, <literal>permanent</literal> to permanently enable multicast traffic
3980 forwarding on this port, or <literal>temporary</literal> to enable multicast routers temporarily
3981 on this port, not depending on incoming queries. When unset, the kernel's default will be used.</para>
3982
3983 <xi:include href="version-info.xml" xpointer="v243"/>
3984 </listitem>
3985 </varlistentry>
3986 <varlistentry>
3987 <term><varname>Cost=</varname></term>
3988 <listitem>
3989 <para>Sets the "cost" of sending packets of this interface.
3990 Each port in a bridge may have a different speed and the cost
3991 is used to decide which link to use. Faster interfaces
3992 should have lower costs. It is an integer value between 1 and
3993 65535.</para>
3994
3995 <xi:include href="version-info.xml" xpointer="v218"/>
3996 </listitem>
3997 </varlistentry>
3998 <varlistentry>
3999 <term><varname>Priority=</varname></term>
4000 <listitem>
4001 <para>Sets the "priority" of sending packets on this interface.
4002 Each port in a bridge may have a different priority which is used
4003 to decide which link to use. Lower value means higher priority.
4004 It is an integer value between 0 to 63. Networkd does not set any
4005 default, meaning the kernel default value of 32 is used.</para>
4006
4007 <xi:include href="version-info.xml" xpointer="v234"/>
4008 </listitem>
4009 </varlistentry>
4010 </variablelist>
4011 </refsect1>
4012 <refsect1>
4013 <title>[BridgeFDB] Section Options</title>
4014 <para>The [BridgeFDB] section manages the forwarding database table of a port and accepts the following
4015 keys. Specify several [BridgeFDB] sections to configure several static MAC table entries.</para>
4016
4017 <variablelist class='network-directives'>
4018 <varlistentry>
4019 <term><varname>MACAddress=</varname></term>
4020 <listitem>
4021 <para>As in the [Network] section. This key is mandatory.</para>
4022 </listitem>
4023 </varlistentry>
4024 <varlistentry>
4025 <term><varname>Destination=</varname></term>
4026 <listitem>
4027 <para>Takes an IP address of the destination VXLAN tunnel endpoint.</para>
4028
4029 <xi:include href="version-info.xml" xpointer="v243"/>
4030 </listitem>
4031 </varlistentry>
4032 <varlistentry>
4033 <term><varname>VLANId=</varname></term>
4034 <listitem>
4035 <para>The VLAN ID for the new static MAC table entry. If
4036 omitted, no VLAN ID information is appended to the new static MAC
4037 table entry.</para>
4038
4039 <xi:include href="version-info.xml" xpointer="v219"/>
4040 </listitem>
4041 </varlistentry>
4042 <varlistentry>
4043 <term><varname>VNI=</varname></term>
4044 <listitem>
4045 <para>The VXLAN Network Identifier (or VXLAN Segment ID) to use to connect to
4046 the remote VXLAN tunnel endpoint. Takes a number in the range 1…16777215.
4047 Defaults to unset.</para>
4048
4049 <xi:include href="version-info.xml" xpointer="v243"/>
4050 </listitem>
4051 </varlistentry>
4052 <varlistentry>
4053 <term><varname>AssociatedWith=</varname></term>
4054 <listitem>
4055 <para>Specifies where the address is associated with. Takes one of <literal>use</literal>,
4056 <literal>self</literal>, <literal>master</literal> or <literal>router</literal>.
4057 <literal>use</literal> means the address is in use. User space can use this option to
4058 indicate to the kernel that the fdb entry is in use. <literal>self</literal> means
4059 the address is associated with the port drivers fdb. Usually hardware. <literal>master</literal>
4060 means the address is associated with master devices fdb. <literal>router</literal> means
4061 the destination address is associated with a router. Note that it's valid if the referenced
4062 device is a VXLAN type device and has route shortcircuit enabled. Defaults to <literal>self</literal>.</para>
4063
4064 <xi:include href="version-info.xml" xpointer="v243"/>
4065 </listitem>
4066 </varlistentry>
4067 <varlistentry>
4068 <term><varname>OutgoingInterface=</varname></term>
4069 <listitem>
4070 <para>Specifies the name or index of the outgoing interface for the VXLAN device driver to
4071 reach the remote VXLAN tunnel endpoint. Defaults to unset.</para>
4072
4073 <xi:include href="version-info.xml" xpointer="v249"/>
4074 </listitem>
4075 </varlistentry>
4076 </variablelist>
4077 </refsect1>
4078 <refsect1>
4079 <title>[BridgeMDB] Section Options</title>
4080 <para>The [BridgeMDB] section manages the multicast membership entries forwarding database table of a port and accepts the following
4081 keys. Specify several [BridgeMDB] sections to configure several permanent multicast membership entries.</para>
4082
4083 <variablelist class='network-directives'>
4084 <varlistentry>
4085 <term><varname>MulticastGroupAddress=</varname></term>
4086 <listitem>
4087 <para>Specifies the IPv4 or IPv6 multicast group address to add. This setting is mandatory.</para>
4088
4089 <xi:include href="version-info.xml" xpointer="v247"/>
4090 </listitem>
4091 </varlistentry>
4092 <varlistentry>
4093 <term><varname>VLANId=</varname></term>
4094 <listitem>
4095 <para>The VLAN ID for the new entry. Valid ranges are 0 (no VLAN) to 4094. Optional, defaults to 0.</para>
4096 </listitem>
4097 </varlistentry>
4098 </variablelist>
4099 </refsect1>
4100
4101 <refsect1>
4102 <title>[LLDP] Section Options</title>
4103 <para>The [LLDP] section manages the Link Layer Discovery Protocol (LLDP) and accepts the following
4104 keys:</para>
4105 <variablelist class='network-directives'>
4106 <varlistentry>
4107 <term><varname>MUDURL=</varname></term>
4108 <listitem>
4109 <para>When configured, the specified Manufacturer Usage Descriptions (MUD) URL will be sent in
4110 LLDP packets. The syntax and semantics are the same as for <varname>MUDURL=</varname> in the
4111 [DHCPv4] section described above.</para>
4112
4113 <para>The MUD URLs received via LLDP packets are saved and can be read using the
4114 <function>sd_lldp_neighbor_get_mud_url()</function> function.</para>
4115
4116 <xi:include href="version-info.xml" xpointer="v246"/>
4117 </listitem>
4118 </varlistentry>
4119 </variablelist>
4120 </refsect1>
4121
4122 <refsect1>
4123 <title>[CAN] Section Options</title>
4124 <para>The [CAN] section manages the Controller Area Network (CAN bus) and accepts the
4125 following keys:</para>
4126 <variablelist class='network-directives'>
4127 <varlistentry>
4128 <term><varname>BitRate=</varname></term>
4129 <listitem>
4130 <para>The bitrate of CAN device in bits per second. The usual SI prefixes (K, M) with the base of 1000 can
4131 be used here. Takes a number in the range 1…4294967295.</para>
4132
4133 <xi:include href="version-info.xml" xpointer="v239"/>
4134 </listitem>
4135 </varlistentry>
4136 <varlistentry>
4137 <term><varname>SamplePoint=</varname></term>
4138 <listitem>
4139 <para>Optional sample point in percent with one decimal (e.g. <literal>75%</literal>,
4140 <literal>87.5%</literal>) or permille (e.g. <literal>875‰</literal>). This will be ignored when
4141 <varname>BitRate=</varname> is unspecified.</para>
4142
4143 <xi:include href="version-info.xml" xpointer="v239"/>
4144 </listitem>
4145 </varlistentry>
4146 <varlistentry>
4147 <term><varname>TimeQuantaNSec=</varname></term>
4148 <term><varname>PropagationSegment=</varname></term>
4149 <term><varname>PhaseBufferSegment1=</varname></term>
4150 <term><varname>PhaseBufferSegment2=</varname></term>
4151 <term><varname>SyncJumpWidth=</varname></term>
4152 <listitem>
4153 <para>Specifies the time quanta, propagation segment, phase buffer segment 1 and 2, and the
4154 synchronization jump width, which allow one to define the CAN bit-timing in a hardware
4155 independent format as proposed by the Bosch CAN 2.0 Specification.
4156 <varname>TimeQuantaNSec=</varname> takes a timespan in nanoseconds.
4157 <varname>PropagationSegment=</varname>, <varname>PhaseBufferSegment1=</varname>,
4158 <varname>PhaseBufferSegment2=</varname>, and <varname>SyncJumpWidth=</varname> take number
4159 of time quantum specified in <varname>TimeQuantaNSec=</varname> and must be an unsigned
4160 integer in the range 0…4294967295. These settings except for
4161 <varname>SyncJumpWidth=</varname> will be ignored when <varname>BitRate=</varname> is
4162 specified.</para>
4163
4164 <xi:include href="version-info.xml" xpointer="v250"/>
4165 </listitem>
4166 </varlistentry>
4167 <varlistentry>
4168 <term><varname>DataBitRate=</varname></term>
4169 <term><varname>DataSamplePoint=</varname></term>
4170 <listitem>
4171 <para>The bitrate and sample point for the data phase, if CAN-FD is used. These settings are
4172 analogous to the <varname>BitRate=</varname> and <varname>SamplePoint=</varname> keys.</para>
4173
4174 <xi:include href="version-info.xml" xpointer="v246"/>
4175 </listitem>
4176 </varlistentry>
4177 <varlistentry>
4178 <term><varname>DataTimeQuantaNSec=</varname></term>
4179 <term><varname>DataPropagationSegment=</varname></term>
4180 <term><varname>DataPhaseBufferSegment1=</varname></term>
4181 <term><varname>DataPhaseBufferSegment2=</varname></term>
4182 <term><varname>DataSyncJumpWidth=</varname></term>
4183 <listitem>
4184 <para>Specifies the time quanta, propagation segment, phase buffer segment 1 and 2, and the
4185 synchronization jump width for the data phase, if CAN-FD is used. These settings are
4186 analogous to the <varname>TimeQuantaNSec=</varname> or related settings.</para>
4187
4188 <xi:include href="version-info.xml" xpointer="v250"/>
4189 </listitem>
4190 </varlistentry>
4191 <varlistentry>
4192 <term><varname>FDMode=</varname></term>
4193 <listitem>
4194 <para>Takes a boolean. When <literal>yes</literal>, CAN-FD mode is enabled for the interface.
4195 Note, that a bitrate and optional sample point should also be set for the CAN-FD data phase using
4196 the <varname>DataBitRate=</varname> and <varname>DataSamplePoint=</varname> keys, or
4197 <varname>DataTimeQuanta=</varname> and related settings.</para>
4198
4199 <xi:include href="version-info.xml" xpointer="v246"/>
4200 </listitem>
4201 </varlistentry>
4202 <varlistentry>
4203 <term><varname>FDNonISO=</varname></term>
4204 <listitem>
4205 <para>Takes a boolean. When <literal>yes</literal>, non-ISO CAN-FD mode is enabled for the
4206 interface. When unset, the kernel's default will be used.</para>
4207
4208 <xi:include href="version-info.xml" xpointer="v246"/>
4209 </listitem>
4210 </varlistentry>
4211 <varlistentry>
4212 <term><varname>RestartSec=</varname></term>
4213 <listitem>
4214 <para>Automatic restart delay time. If set to a non-zero value, a restart of the CAN controller will be
4215 triggered automatically in case of a bus-off condition after the specified delay time. Subsecond delays can
4216 be specified using decimals (e.g. <literal>0.1s</literal>) or a <literal>ms</literal> or
4217 <literal>us</literal> postfix. Using <literal>infinity</literal> or <literal>0</literal> will turn the
4218 automatic restart off. By default automatic restart is disabled.</para>
4219
4220 <xi:include href="version-info.xml" xpointer="v239"/>
4221 </listitem>
4222 </varlistentry>
4223 <varlistentry>
4224 <term><varname>Termination=</varname></term>
4225 <listitem>
4226 <para>Takes a boolean or a termination resistor value in ohm in the range 0…65535. When
4227 <literal>yes</literal>, the termination resistor is set to 120 ohm. When
4228 <literal>no</literal> or <literal>0</literal> is set, the termination resistor is disabled.
4229 When unset, the kernel's default will be used.</para>
4230
4231 <xi:include href="version-info.xml" xpointer="v246"/>
4232 </listitem>
4233 </varlistentry>
4234 <varlistentry>
4235 <term><varname>TripleSampling=</varname></term>
4236 <listitem>
4237 <para>Takes a boolean. When <literal>yes</literal>, three samples (instead of one) are used to determine
4238 the value of a received bit by majority rule. When unset, the kernel's default will be used.</para>
4239
4240 <xi:include href="version-info.xml" xpointer="v242"/>
4241 </listitem>
4242 </varlistentry>
4243 <varlistentry>
4244 <term><varname>BusErrorReporting=</varname></term>
4245 <listitem>
4246 <para>Takes a boolean. When <literal>yes</literal>, reporting of CAN bus errors is activated
4247 (those include single bit, frame format, and bit stuffing errors, unable to send dominant bit,
4248 unable to send recessive bit, bus overload, active error announcement, error occurred on
4249 transmission). When unset, the kernel's default will be used. Note: in case of a CAN bus with a
4250 single CAN device, sending a CAN frame may result in a huge number of CAN bus errors.</para>
4251
4252 <xi:include href="version-info.xml" xpointer="v248"/>
4253 </listitem>
4254 </varlistentry>
4255 <varlistentry>
4256 <term><varname>ListenOnly=</varname></term>
4257 <listitem>
4258 <para>Takes a boolean. When <literal>yes</literal>, listen-only mode is enabled. When the
4259 interface is in listen-only mode, the interface neither transmit CAN frames nor send ACK
4260 bit. Listen-only mode is important to debug CAN networks without interfering with the
4261 communication or acknowledge the CAN frame. When unset, the kernel's default will be used.
4262 </para>
4263
4264 <xi:include href="version-info.xml" xpointer="v246"/>
4265 </listitem>
4266 </varlistentry>
4267 <varlistentry>
4268 <term><varname>Loopback=</varname></term>
4269 <listitem>
4270 <para>Takes a boolean. When <literal>yes</literal>, loopback mode is enabled. When the
4271 loopback mode is enabled, the interface treats messages transmitted by itself as received
4272 messages. The loopback mode is important to debug CAN networks. When unset, the kernel's
4273 default will be used.</para>
4274
4275 <xi:include href="version-info.xml" xpointer="v250"/>
4276 </listitem>
4277 </varlistentry>
4278 <varlistentry>
4279 <term><varname>OneShot=</varname></term>
4280 <listitem>
4281 <para>Takes a boolean. When <literal>yes</literal>, one-shot mode is enabled. When unset,
4282 the kernel's default will be used.</para>
4283
4284 <xi:include href="version-info.xml" xpointer="v250"/>
4285 </listitem>
4286 </varlistentry>
4287 <varlistentry>
4288 <term><varname>PresumeAck=</varname></term>
4289 <listitem>
4290 <para>Takes a boolean. When <literal>yes</literal>, the interface will ignore missing CAN
4291 ACKs. When unset, the kernel's default will be used.</para>
4292
4293 <xi:include href="version-info.xml" xpointer="v250"/>
4294 </listitem>
4295 </varlistentry>
4296 <varlistentry>
4297 <term><varname>ClassicDataLengthCode=</varname></term>
4298 <listitem>
4299 <para>Takes a boolean. When <literal>yes</literal>, the interface will handle the 4bit data
4300 length code (DLC). When unset, the kernel's default will be used.</para>
4301
4302 <xi:include href="version-info.xml" xpointer="v250"/>
4303 </listitem>
4304 </varlistentry>
4305 </variablelist>
4306 </refsect1>
4307
4308 <refsect1>
4309 <title>[IPoIB] Section Options</title>
4310 <para>The [IPoIB] section manages the IP over Infiniband and accepts the following keys:</para>
4311 <variablelist class='network-directives'>
4312 <xi:include href="systemd.netdev.xml" xpointer="ipoib_mode" />
4313 <xi:include href="systemd.netdev.xml" xpointer="ipoib_umcast" />
4314 </variablelist>
4315 </refsect1>
4316
4317 <refsect1>
4318 <title>[QDisc] Section Options</title>
4319 <para>The [QDisc] section manages the traffic control queueing discipline (qdisc).</para>
4320
4321 <variablelist class='network-directives'>
4322 <varlistentry>
4323 <term><varname>Parent=</varname></term>
4324 <listitem>
4325 <para>Specifies the parent Queueing Discipline (qdisc). Takes one of <literal>clsact</literal>
4326 or <literal>ingress</literal>. This is mandatory.</para>
4327 </listitem>
4328 </varlistentry>
4329
4330 <xi:include href="tc.xml" xpointer="qdisc-handle" />
4331 </variablelist>
4332 </refsect1>
4333
4334 <refsect1>
4335 <title>[NetworkEmulator] Section Options</title>
4336 <para>The [NetworkEmulator] section manages the queueing discipline (qdisc) of the network emulator. It
4337 can be used to configure the kernel packet scheduler and simulate packet delay and loss for UDP or TCP
4338 applications, or limit the bandwidth usage of a particular service to simulate internet connections.
4339 </para>
4340
4341 <variablelist class='network-directives'>
4342 <xi:include href="tc.xml" xpointer="qdisc-parent" />
4343 <xi:include href="tc.xml" xpointer="qdisc-handle" />
4344
4345 <varlistentry>
4346 <term><varname>DelaySec=</varname></term>
4347 <listitem>
4348 <para>Specifies the fixed amount of delay to be added to all packets going out of the
4349 interface. Defaults to unset.</para>
4350
4351 <xi:include href="version-info.xml" xpointer="v245"/>
4352 </listitem>
4353 </varlistentry>
4354
4355 <varlistentry>
4356 <term><varname>DelayJitterSec=</varname></term>
4357 <listitem>
4358 <para>Specifies the chosen delay to be added to the packets outgoing to the network
4359 interface. Defaults to unset.</para>
4360
4361 <xi:include href="version-info.xml" xpointer="v245"/>
4362 </listitem>
4363 </varlistentry>
4364
4365 <varlistentry>
4366 <term><varname>PacketLimit=</varname></term>
4367 <listitem>
4368 <para>Specifies the maximum number of packets the qdisc may hold queued at a time.
4369 An unsigned integer in the range 0…4294967294. Defaults to 1000.</para>
4370
4371 <xi:include href="version-info.xml" xpointer="v245"/>
4372 </listitem>
4373 </varlistentry>
4374
4375 <varlistentry>
4376 <term><varname>LossRate=</varname></term>
4377 <listitem>
4378 <para>Specifies an independent loss probability to be added to the packets outgoing from the
4379 network interface. Takes a percentage value, suffixed with "%". Defaults to unset.</para>
4380
4381 <xi:include href="version-info.xml" xpointer="v245"/>
4382 </listitem>
4383 </varlistentry>
4384
4385 <varlistentry>
4386 <term><varname>DuplicateRate=</varname></term>
4387 <listitem>
4388 <para>Specifies that the chosen percent of packets is duplicated before queuing them.
4389 Takes a percentage value, suffixed with "%". Defaults to unset.</para>
4390
4391 <xi:include href="version-info.xml" xpointer="v245"/>
4392 </listitem>
4393 </varlistentry>
4394 </variablelist>
4395 </refsect1>
4396
4397 <refsect1>
4398 <title>[TokenBucketFilter] Section Options</title>
4399 <para>The [TokenBucketFilter] section manages the queueing discipline (qdisc) of token bucket filter
4400 (tbf).</para>
4401
4402 <variablelist class='network-directives'>
4403 <xi:include href="tc.xml" xpointer="qdisc-parent" />
4404 <xi:include href="tc.xml" xpointer="qdisc-handle" />
4405
4406 <varlistentry>
4407 <term><varname>LatencySec=</varname></term>
4408 <listitem>
4409 <para>Specifies the latency parameter, which specifies the maximum amount of time a
4410 packet can sit in the Token Bucket Filter (TBF). Defaults to unset.</para>
4411
4412 <xi:include href="version-info.xml" xpointer="v245"/>
4413 </listitem>
4414 </varlistentry>
4415
4416 <varlistentry>
4417 <term><varname>LimitBytes=</varname></term>
4418 <listitem>
4419 <para>Takes the number of bytes that can be queued waiting for tokens to become available.
4420 When the size is suffixed with K, M, or G, it is parsed as Kilobytes, Megabytes, or Gigabytes,
4421 respectively, to the base of 1024. Defaults to unset.</para>
4422
4423 <xi:include href="version-info.xml" xpointer="v246"/>
4424 </listitem>
4425 </varlistentry>
4426
4427 <varlistentry>
4428 <term><varname>BurstBytes=</varname></term>
4429 <listitem>
4430 <para>Specifies the size of the bucket. This is the maximum amount of bytes that tokens
4431 can be available for instantaneous transfer. When the size is suffixed with K, M, or G, it is
4432 parsed as Kilobytes, Megabytes, or Gigabytes, respectively, to the base of 1024. Defaults to
4433 unset.</para>
4434
4435 <xi:include href="version-info.xml" xpointer="v246"/>
4436 </listitem>
4437 </varlistentry>
4438
4439 <varlistentry>
4440 <term><varname>Rate=</varname></term>
4441 <listitem>
4442 <para>Specifies the device specific bandwidth. When suffixed with K, M, or G, the specified
4443 bandwidth is parsed as Kilobits, Megabits, or Gigabits, respectively, to the base of 1000.
4444 Defaults to unset.</para>
4445
4446 <xi:include href="version-info.xml" xpointer="v245"/>
4447 </listitem>
4448 </varlistentry>
4449
4450 <varlistentry>
4451 <term><varname>MPUBytes=</varname></term>
4452 <listitem>
4453 <para>The Minimum Packet Unit (MPU) determines the minimal token usage (specified in bytes)
4454 for a packet. When suffixed with K, M, or G, the specified size is parsed as Kilobytes,
4455 Megabytes, or Gigabytes, respectively, to the base of 1024. Defaults to zero.</para>
4456
4457 <xi:include href="version-info.xml" xpointer="v245"/>
4458 </listitem>
4459 </varlistentry>
4460
4461 <varlistentry>
4462 <term><varname>PeakRate=</varname></term>
4463 <listitem>
4464 <para>Takes the maximum depletion rate of the bucket. When suffixed with K, M, or G, the
4465 specified size is parsed as Kilobits, Megabits, or Gigabits, respectively, to the base of
4466 1000. Defaults to unset.</para>
4467
4468 <xi:include href="version-info.xml" xpointer="v245"/>
4469 </listitem>
4470 </varlistentry>
4471
4472 <varlistentry>
4473 <term><varname>MTUBytes=</varname></term>
4474 <listitem>
4475 <para>Specifies the size of the peakrate bucket. When suffixed with K, M, or G, the specified
4476 size is parsed as Kilobytes, Megabytes, or Gigabytes, respectively, to the base of 1024.
4477 Defaults to unset.</para>
4478
4479 <xi:include href="version-info.xml" xpointer="v245"/>
4480 </listitem>
4481 </varlistentry>
4482 </variablelist>
4483 </refsect1>
4484
4485 <refsect1>
4486 <title>[PIE] Section Options</title>
4487 <para>The [PIE] section manages the queueing discipline (qdisc) of Proportional Integral
4488 controller-Enhanced (PIE).</para>
4489
4490 <variablelist class='network-directives'>
4491 <xi:include href="tc.xml" xpointer="qdisc-parent" />
4492 <xi:include href="tc.xml" xpointer="qdisc-handle" />
4493
4494 <varlistentry>
4495 <term><varname>PacketLimit=</varname></term>
4496 <listitem>
4497 <para>Specifies the hard limit on the queue size in number of packets. When this limit is reached,
4498 incoming packets are dropped. An unsigned integer in the range 1…4294967294. Defaults to unset and
4499 kernel's default is used.</para>
4500
4501 <xi:include href="version-info.xml" xpointer="v246"/>
4502 </listitem>
4503 </varlistentry>
4504 </variablelist>
4505 </refsect1>
4506
4507 <refsect1>
4508 <title>[FlowQueuePIE] Section Options</title>
4509 <para>The <literal>[FlowQueuePIE]</literal> section manages the queueing discipline
4510 (qdisc) of Flow Queue Proportional Integral controller-Enhanced (fq_pie).</para>
4511
4512 <variablelist class='network-directives'>
4513 <xi:include href="tc.xml" xpointer="qdisc-parent" />
4514 <xi:include href="tc.xml" xpointer="qdisc-handle" />
4515
4516 <varlistentry>
4517 <term><varname>PacketLimit=</varname></term>
4518 <listitem>
4519 <para>Specifies the hard limit on the queue size in number of packets. When this limit is reached,
4520 incoming packets are dropped. An unsigned integer ranges 1 to 4294967294. Defaults to unset and
4521 kernel's default is used.</para>
4522
4523 <xi:include href="version-info.xml" xpointer="v247"/>
4524 </listitem>
4525 </varlistentry>
4526 </variablelist>
4527 </refsect1>
4528
4529 <refsect1>
4530 <title>[StochasticFairBlue] Section Options</title>
4531 <para>The [StochasticFairBlue] section manages the queueing discipline (qdisc) of stochastic fair blue
4532 (sfb).</para>
4533
4534 <variablelist class='network-directives'>
4535 <xi:include href="tc.xml" xpointer="qdisc-parent" />
4536 <xi:include href="tc.xml" xpointer="qdisc-handle" />
4537
4538 <varlistentry>
4539 <term><varname>PacketLimit=</varname></term>
4540 <listitem>
4541 <para>Specifies the hard limit on the queue size in number of packets. When this limit is reached,
4542 incoming packets are dropped. An unsigned integer in the range 0…4294967294. Defaults to unset and
4543 kernel's default is used.</para>
4544
4545 <xi:include href="version-info.xml" xpointer="v246"/>
4546 </listitem>
4547 </varlistentry>
4548 </variablelist>
4549 </refsect1>
4550
4551 <refsect1>
4552 <title>[StochasticFairnessQueueing] Section Options</title>
4553 <para>The [StochasticFairnessQueueing] section manages the queueing discipline (qdisc) of stochastic
4554 fairness queueing (sfq).</para>
4555
4556 <variablelist class='network-directives'>
4557 <xi:include href="tc.xml" xpointer="qdisc-parent" />
4558 <xi:include href="tc.xml" xpointer="qdisc-handle" />
4559
4560 <varlistentry>
4561 <term><varname>PerturbPeriodSec=</varname></term>
4562 <listitem>
4563 <para>Specifies the interval in seconds for queue algorithm perturbation. Defaults to unset.</para>
4564
4565 <xi:include href="version-info.xml" xpointer="v245"/>
4566 </listitem>
4567 </varlistentry>
4568 </variablelist>
4569 </refsect1>
4570
4571 <refsect1>
4572 <title>[BFIFO] Section Options</title>
4573 <para>The [BFIFO] section manages the queueing discipline (qdisc) of Byte limited Packet First In First
4574 Out (bfifo).</para>
4575
4576 <variablelist class='network-directives'>
4577 <xi:include href="tc.xml" xpointer="qdisc-parent" />
4578 <xi:include href="tc.xml" xpointer="qdisc-handle" />
4579
4580 <varlistentry>
4581 <term><varname>LimitBytes=</varname></term>
4582 <listitem>
4583 <para>Specifies the hard limit in bytes on the FIFO buffer size. The size limit prevents overflow
4584 in case the kernel is unable to dequeue packets as quickly as it receives them. When this limit is
4585 reached, incoming packets are dropped. When suffixed with K, M, or G, the specified size is parsed
4586 as Kilobytes, Megabytes, or Gigabytes, respectively, to the base of 1024. Defaults to unset and
4587 kernel default is used.</para>
4588
4589 <xi:include href="version-info.xml" xpointer="v246"/>
4590 </listitem>
4591 </varlistentry>
4592 </variablelist>
4593 </refsect1>
4594
4595 <refsect1>
4596 <title>[PFIFO] Section Options</title>
4597 <para>The [PFIFO] section manages the queueing discipline (qdisc) of Packet First In First Out
4598 (pfifo).</para>
4599
4600 <variablelist class='network-directives'>
4601 <xi:include href="tc.xml" xpointer="qdisc-parent" />
4602 <xi:include href="tc.xml" xpointer="qdisc-handle" />
4603
4604 <varlistentry>
4605 <term><varname>PacketLimit=</varname></term>
4606 <listitem>
4607 <para>Specifies the hard limit on the number of packets in the FIFO queue. The size limit prevents
4608 overflow in case the kernel is unable to dequeue packets as quickly as it receives them. When this
4609 limit is reached, incoming packets are dropped. An unsigned integer in the range
4610 0…4294967294. Defaults to unset and kernel's default is used.</para>
4611
4612 <xi:include href="version-info.xml" xpointer="v246"/>
4613 </listitem>
4614 </varlistentry>
4615 </variablelist>
4616 </refsect1>
4617
4618 <refsect1>
4619 <title>[PFIFOHeadDrop] Section Options</title>
4620 <para>The [PFIFOHeadDrop] section manages the queueing discipline (qdisc) of Packet First In First Out
4621 Head Drop (pfifo_head_drop).</para>
4622
4623 <variablelist class='network-directives'>
4624 <xi:include href="tc.xml" xpointer="qdisc-parent" />
4625 <xi:include href="tc.xml" xpointer="qdisc-handle" />
4626
4627 <varlistentry>
4628 <term><varname>PacketLimit=</varname></term>
4629 <listitem>
4630 <para>As in [PFIFO] section.</para>
4631
4632 <xi:include href="version-info.xml" xpointer="v246"/></listitem>
4633 </varlistentry>
4634 </variablelist>
4635 </refsect1>
4636
4637 <refsect1>
4638 <title>[PFIFOFast] Section Options</title>
4639 <para>The [PFIFOFast] section manages the queueing discipline (qdisc) of Packet First In First Out Fast
4640 (pfifo_fast).</para>
4641
4642 <variablelist class='network-directives'>
4643 <xi:include href="tc.xml" xpointer="qdisc-parent" />
4644 <xi:include href="tc.xml" xpointer="qdisc-handle" />
4645 </variablelist>
4646 </refsect1>
4647
4648 <refsect1>
4649 <title>[CAKE] Section Options</title>
4650 <para>The [CAKE] section manages the queueing discipline (qdisc) of Common Applications Kept Enhanced
4651 (CAKE).</para>
4652
4653 <variablelist class='network-directives'>
4654 <xi:include href="tc.xml" xpointer="qdisc-parent" />
4655 <xi:include href="tc.xml" xpointer="qdisc-handle" />
4656
4657 <varlistentry>
4658 <term><varname>Bandwidth=</varname></term>
4659 <listitem>
4660 <para>Specifies the shaper bandwidth. When suffixed with K, M, or G, the specified size is
4661 parsed as Kilobits, Megabits, or Gigabits, respectively, to the base of 1000. Defaults to
4662 unset and kernel's default is used.</para>
4663
4664 <xi:include href="version-info.xml" xpointer="v246"/>
4665 </listitem>
4666 </varlistentry>
4667
4668 <varlistentry>
4669 <term><varname>AutoRateIngress=</varname></term>
4670 <listitem>
4671 <para>Takes a boolean value. Enables automatic capacity estimation based on traffic arriving
4672 at this qdisc. This is most likely to be useful with cellular links, which tend to change
4673 quality randomly. If this setting is enabled, the <varname>Bandwidth=</varname> setting is
4674 used as an initial estimate. Defaults to unset, and the kernel's default is used.</para>
4675
4676 <xi:include href="version-info.xml" xpointer="v250"/>
4677 </listitem>
4678 </varlistentry>
4679
4680 <varlistentry>
4681 <term><varname>OverheadBytes=</varname></term>
4682 <listitem>
4683 <para>Specifies that bytes to be addeded to the size of each packet. Bytes may be negative.
4684 Takes an integer in the range -64…256. Defaults to unset and kernel's default is used.
4685 </para>
4686
4687 <xi:include href="version-info.xml" xpointer="v246"/>
4688 </listitem>
4689 </varlistentry>
4690
4691 <varlistentry>
4692 <term><varname>MPUBytes=</varname></term>
4693 <listitem>
4694 <para>Rounds each packet (including overhead) up to the specified bytes. Takes an integer in
4695 the range 1…256. Defaults to unset and kernel's default is used.</para>
4696
4697 <xi:include href="version-info.xml" xpointer="v250"/>
4698 </listitem>
4699 </varlistentry>
4700
4701 <varlistentry>
4702 <term><varname>CompensationMode=</varname></term>
4703 <listitem>
4704 <para>Takes one of <literal>none</literal>, <literal>atm</literal>, or <literal>ptm</literal>.
4705 Specifies the compensation mode for overhead calculation. When <literal>none</literal>, no
4706 compensation is taken into account. When <literal>atm</literal>, enables the compensation for
4707 ATM cell framing, which is normally found on ADSL links. When <literal>ptm</literal>, enables
4708 the compensation for PTM encoding, which is normally found on VDSL2 links and uses a 64b/65b
4709 encoding scheme. Defaults to unset and the kernel's default is used.</para>
4710
4711 <xi:include href="version-info.xml" xpointer="v250"/>
4712 </listitem>
4713 </varlistentry>
4714
4715 <varlistentry>
4716 <term><varname>UseRawPacketSize=</varname></term>
4717 <listitem>
4718 <para>Takes a boolean value. When true, the packet size reported by the Linux kernel will be
4719 used, instead of the underlying IP packet size. Defaults to unset, and the kernel's default
4720 is used.</para>
4721
4722 <xi:include href="version-info.xml" xpointer="v250"/>
4723 </listitem>
4724 </varlistentry>
4725
4726 <varlistentry>
4727 <term><varname>FlowIsolationMode=</varname></term>
4728 <listitem>
4729 <para>CAKE places packets from different flows into different queues, then packets from each
4730 queue are delivered fairly. This specifies whether the fairness is based on source address,
4731 destination address, individual flows, or any combination of those. The available values are:
4732 </para>
4733
4734 <variablelist>
4735 <varlistentry>
4736 <term><option>none</option></term>
4737 <listitem><para>
4738 The flow isolation is disabled, and all traffic passes through a single queue.
4739 </para>
4740
4741 <xi:include href="version-info.xml" xpointer="v250"/></listitem>
4742 </varlistentry>
4743 <varlistentry>
4744 <term><option>src-host</option></term>
4745 <listitem><para>
4746 Flows are defined only by source address. Equivalent to the <literal>srchost</literal>
4747 option for <command>tc qdisc</command> command. See also
4748 <citerefentry project='man-pages'><refentrytitle>tc-cake</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
4749 </para>
4750
4751 <xi:include href="version-info.xml" xpointer="v250"/></listitem>
4752 </varlistentry>
4753 <varlistentry>
4754 <term><option>dst-host</option></term>
4755 <listitem><para>
4756 Flows are defined only by destination address. Equivalent to the
4757 <literal>dsthost</literal> option for <command>tc qdisc</command> command. See also
4758 <citerefentry project='man-pages'><refentrytitle>tc-cake</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
4759 </para>
4760
4761 <xi:include href="version-info.xml" xpointer="v250"/></listitem>
4762 </varlistentry>
4763 <varlistentry>
4764 <term><option>hosts</option></term>
4765 <listitem><para>
4766 Flows are defined by source-destination host pairs. Equivalent to the same option for
4767 <command>tc qdisc</command> command. See also
4768 <citerefentry project='man-pages'><refentrytitle>tc-cake</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
4769 </para>
4770
4771 <xi:include href="version-info.xml" xpointer="v250"/></listitem>
4772 </varlistentry>
4773 <varlistentry>
4774 <term><option>flows</option></term>
4775 <listitem><para>
4776 Flows are defined by the entire 5-tuple of source address, destination address,
4777 transport protocol, source port and destination port. Equivalent to the same option for
4778 <command>tc qdisc</command> command. See also
4779 <citerefentry project='man-pages'><refentrytitle>tc-cake</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
4780 </para>
4781
4782 <xi:include href="version-info.xml" xpointer="v250"/></listitem>
4783 </varlistentry>
4784 <varlistentry>
4785 <term><option>dual-src-host</option></term>
4786 <listitem><para>
4787 Flows are defined by the 5-tuple (see <literal>flows</literal> in the above), and
4788 fairness is applied first over source addresses, then over individual flows. Equivalent
4789 to the <literal>dual-srchost</literal> option for <command>tc qdisc</command> command.
4790 See also
4791 <citerefentry project='man-pages'><refentrytitle>tc-cake</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
4792 </para>
4793
4794 <xi:include href="version-info.xml" xpointer="v250"/></listitem>
4795 </varlistentry>
4796 <varlistentry>
4797 <term><option>dual-dst-host</option></term>
4798 <listitem><para>
4799 Flows are defined by the 5-tuple (see <literal>flows</literal> in the above), and
4800 fairness is applied first over destination addresses, then over individual flows.
4801 Equivalent to the <literal>dual-dsthost</literal> option for
4802 <command>tc qdisc</command> command. See also
4803 <citerefentry project='man-pages'><refentrytitle>tc-cake</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
4804 </para>
4805
4806 <xi:include href="version-info.xml" xpointer="v250"/></listitem>
4807 </varlistentry>
4808 <varlistentry>
4809 <term><option>triple</option></term>
4810 <listitem><para>
4811 Flows are defined by the 5-tuple (see <literal>flows</literal>), and fairness is
4812 applied over source and destination addresses, and also over individual flows.
4813 Equivalent to the <literal>triple-isolate</literal> option for
4814 <command>tc qdisc</command> command. See also
4815 <citerefentry project='man-pages'><refentrytitle>tc-cake</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
4816 </para>
4817
4818 <xi:include href="version-info.xml" xpointer="v250"/></listitem>
4819 </varlistentry>
4820 </variablelist>
4821
4822 <para>Defaults to unset and the kernel's default is used.</para>
4823
4824 <xi:include href="version-info.xml" xpointer="v250"/>
4825 </listitem>
4826 </varlistentry>
4827
4828 <varlistentry>
4829 <term><varname>NAT=</varname></term>
4830 <listitem>
4831 <para>Takes a boolean value. When true, CAKE performs a NAT lookup before applying
4832 flow-isolation rules, to determine the true addresses and port numbers of the packet, to
4833 improve fairness between hosts inside the NAT. This has no practical effect when
4834 <varname>FlowIsolationMode=</varname> is <literal>none</literal> or <literal>flows</literal>,
4835 or if NAT is performed on a different host. Defaults to unset, and the kernel's default is
4836 used.</para>
4837
4838 <xi:include href="version-info.xml" xpointer="v250"/>
4839 </listitem>
4840 </varlistentry>
4841
4842 <varlistentry>
4843 <term><varname>PriorityQueueingPreset=</varname></term>
4844 <listitem>
4845 <para>CAKE divides traffic into <literal>tins</literal>, and each tin has its own independent
4846 set of flow-isolation queues, bandwidth threshold, and priority. This specifies the preset of
4847 tin profiles. The available values are:</para>
4848
4849 <variablelist>
4850 <varlistentry>
4851 <term><option>besteffort</option></term>
4852 <listitem><para>
4853 Disables priority queueing by placing all traffic in one tin.
4854 </para>
4855
4856 <xi:include href="version-info.xml" xpointer="v250"/></listitem>
4857 </varlistentry>
4858 <varlistentry>
4859 <term><option>precedence</option></term>
4860 <listitem><para>
4861 Enables priority queueing based on the legacy interpretation of TOS
4862 <literal>Precedence</literal> field. Use of this preset on the modern Internet is
4863 firmly discouraged.
4864 </para>
4865
4866 <xi:include href="version-info.xml" xpointer="v250"/></listitem>
4867 </varlistentry>
4868 <varlistentry>
4869 <term><option>diffserv8</option></term>
4870 <listitem><para>
4871 Enables priority queueing based on the Differentiated Service
4872 (<literal>DiffServ</literal>) field with eight tins: Background Traffic, High
4873 Throughput, Best Effort, Video Streaming, Low Latency Transactions, Interactive Shell,
4874 Minimum Latency, and Network Control.
4875 </para>
4876
4877 <xi:include href="version-info.xml" xpointer="v250"/></listitem>
4878 </varlistentry>
4879 <varlistentry>
4880 <term><option>diffserv4</option></term>
4881 <listitem><para>
4882 Enables priority queueing based on the Differentiated Service
4883 (<literal>DiffServ</literal>) field with four tins: Background Traffic, Best Effort,
4884 Streaming Media, and Latency Sensitive.
4885 </para>
4886
4887 <xi:include href="version-info.xml" xpointer="v250"/></listitem>
4888 </varlistentry>
4889 <varlistentry>
4890 <term><option>diffserv3</option></term>
4891 <listitem><para>
4892 Enables priority queueing based on the Differentiated Service
4893 (<literal>DiffServ</literal>) field with three tins: Background Traffic, Best Effort,
4894 and Latency Sensitive.
4895 </para>
4896
4897 <xi:include href="version-info.xml" xpointer="v250"/></listitem>
4898 </varlistentry>
4899 </variablelist>
4900
4901 <para>Defaults to unset, and the kernel's default is used.</para>
4902
4903 <xi:include href="version-info.xml" xpointer="v250"/>
4904 </listitem>
4905 </varlistentry>
4906
4907 <varlistentry>
4908 <term><varname>FirewallMark=</varname></term>
4909 <listitem>
4910 <para>Takes an integer in the range 1…4294967295. When specified, firewall-mark-based
4911 overriding of CAKE's tin selection is enabled. Defaults to unset, and the kernel's default is
4912 used.</para>
4913
4914 <xi:include href="version-info.xml" xpointer="v250"/>
4915 </listitem>
4916 </varlistentry>
4917
4918 <varlistentry>
4919 <term><varname>Wash=</varname></term>
4920 <listitem>
4921 <para>Takes a boolean value. When true, CAKE clears the DSCP fields, except for ECN bits, of
4922 any packet passing through CAKE. Defaults to unset, and the kernel's default is used.</para>
4923
4924 <xi:include href="version-info.xml" xpointer="v250"/>
4925 </listitem>
4926 </varlistentry>
4927
4928 <varlistentry>
4929 <term><varname>SplitGSO=</varname></term>
4930 <listitem>
4931 <para>Takes a boolean value. When true, CAKE will split General Segmentation Offload (GSO)
4932 super-packets into their on-the-wire components and dequeue them individually. Defaults to
4933 unset, and the kernel's default is used.</para>
4934
4935 <xi:include href="version-info.xml" xpointer="v250"/>
4936 </listitem>
4937 </varlistentry>
4938
4939 <varlistentry>
4940 <term><varname>RTTSec=</varname></term>
4941 <listitem>
4942 <para>Specifies the RTT for the filter. Takes a timespan. Typical values are e.g. 100us for
4943 extremely high-performance 10GigE+ networks like datacentre, 1ms for non-WiFi LAN connections,
4944 100ms for typical internet connections. Defaults to unset, and the kernel's default will be used.
4945 </para>
4946
4947 <xi:include href="version-info.xml" xpointer="v253"/>
4948 </listitem>
4949 </varlistentry>
4950
4951 <varlistentry>
4952 <term><varname>AckFilter=</varname></term>
4953 <listitem>
4954 <para>Takes a boolean value, or special value <literal>aggressive</literal>. If enabled, ACKs in
4955 each flow are queued and redundant ACKs to the upstream are dropped. If yes, the filter will always
4956 keep at least two redundant ACKs in the queue, while in <literal>aggressive</literal> mode, it will
4957 filter down to a single ACK. This may improve download throughput on links with very asymmetrical
4958 rate limits. Defaults to unset, and the kernel's default will be used.</para>
4959
4960 <xi:include href="version-info.xml" xpointer="v253"/>
4961 </listitem>
4962 </varlistentry>
4963
4964 </variablelist>
4965 </refsect1>
4966
4967 <refsect1>
4968 <title>[ControlledDelay] Section Options</title>
4969 <para>The [ControlledDelay] section manages the queueing discipline (qdisc) of
4970 controlled delay (CoDel).</para>
4971
4972 <variablelist class='network-directives'>
4973 <xi:include href="tc.xml" xpointer="qdisc-parent" />
4974 <xi:include href="tc.xml" xpointer="qdisc-handle" />
4975
4976 <varlistentry>
4977 <term><varname>PacketLimit=</varname></term>
4978 <listitem>
4979 <para>Specifies the hard limit on the queue size in number of packets. When this limit is reached,
4980 incoming packets are dropped. An unsigned integer in the range 0…4294967294. Defaults to unset and
4981 kernel's default is used.</para>
4982
4983 <xi:include href="version-info.xml" xpointer="v245"/>
4984 </listitem>
4985 </varlistentry>
4986
4987 <varlistentry>
4988 <term><varname>TargetSec=</varname></term>
4989 <listitem>
4990 <para>Takes a timespan. Specifies the acceptable minimum standing/persistent queue delay.
4991 Defaults to unset and kernel's default is used.</para>
4992
4993 <xi:include href="version-info.xml" xpointer="v245"/>
4994 </listitem>
4995 </varlistentry>
4996
4997 <varlistentry>
4998 <term><varname>IntervalSec=</varname></term>
4999 <listitem>
5000 <para>Takes a timespan. This is used to ensure that the measured minimum delay does not
5001 become too stale. Defaults to unset and kernel's default is used.</para>
5002
5003 <xi:include href="version-info.xml" xpointer="v245"/>
5004 </listitem>
5005 </varlistentry>
5006
5007 <varlistentry>
5008 <term><varname>ECN=</varname></term>
5009 <listitem>
5010 <para>Takes a boolean. This can be used to mark packets instead of dropping them. Defaults to
5011 unset and kernel's default is used.</para>
5012
5013 <xi:include href="version-info.xml" xpointer="v245"/>
5014 </listitem>
5015 </varlistentry>
5016
5017 <varlistentry>
5018 <term><varname>CEThresholdSec=</varname></term>
5019 <listitem>
5020 <para>Takes a timespan. This sets a threshold above which all packets are marked with ECN
5021 Congestion Experienced (CE). Defaults to unset and kernel's default is used.</para>
5022
5023 <xi:include href="version-info.xml" xpointer="v245"/>
5024 </listitem>
5025 </varlistentry>
5026 </variablelist>
5027 </refsect1>
5028
5029 <refsect1>
5030 <title>[DeficitRoundRobinScheduler] Section Options</title>
5031 <para>The [DeficitRoundRobinScheduler] section manages the queueing discipline (qdisc) of Deficit Round
5032 Robin Scheduler (DRR).</para>
5033
5034 <variablelist class='network-directives'>
5035 <xi:include href="tc.xml" xpointer="qdisc-parent" />
5036 <xi:include href="tc.xml" xpointer="qdisc-handle" />
5037 </variablelist>
5038 </refsect1>
5039
5040 <refsect1>
5041 <title>[DeficitRoundRobinSchedulerClass] Section Options</title>
5042 <para>The [DeficitRoundRobinSchedulerClass] section manages the traffic control class of Deficit Round
5043 Robin Scheduler (DRR).</para>
5044
5045 <variablelist class='network-directives'>
5046 <xi:include href="tc.xml" xpointer="tclass-parent" />
5047 <xi:include href="tc.xml" xpointer="tclass-classid" />
5048
5049 <varlistentry>
5050 <term><varname>QuantumBytes=</varname></term>
5051 <listitem>
5052 <para>Specifies the amount of bytes a flow is allowed to dequeue before the scheduler moves
5053 to the next class. When suffixed with K, M, or G, the specified size is parsed as Kilobytes,
5054 Megabytes, or Gigabytes, respectively, to the base of 1024. Defaults to the MTU of the
5055 interface.</para>
5056
5057 <xi:include href="version-info.xml" xpointer="v246"/>
5058 </listitem>
5059 </varlistentry>
5060
5061 </variablelist>
5062 </refsect1>
5063
5064 <refsect1>
5065 <title>[EnhancedTransmissionSelection] Section Options</title>
5066 <para>The [EnhancedTransmissionSelection] section manages the queueing discipline (qdisc) of Enhanced
5067 Transmission Selection (ETS).</para>
5068
5069 <variablelist class='network-directives'>
5070 <xi:include href="tc.xml" xpointer="qdisc-parent" />
5071 <xi:include href="tc.xml" xpointer="qdisc-handle" />
5072
5073 <varlistentry>
5074 <term><varname>Bands=</varname></term>
5075 <listitem>
5076 <para>Specifies the number of bands. An unsigned integer in the range 1…16. This value has to be at
5077 least large enough to cover the strict bands specified through the <varname>StrictBands=</varname>
5078 and bandwidth-sharing bands specified in <varname>QuantumBytes=</varname>.</para>
5079
5080 <xi:include href="version-info.xml" xpointer="v246"/>
5081 </listitem>
5082 </varlistentry>
5083
5084 <varlistentry>
5085 <term><varname>StrictBands=</varname></term>
5086 <listitem>
5087 <para>Specifies the number of bands that should be created in strict mode. An unsigned integer in
5088 the range 1…16.</para>
5089
5090 <xi:include href="version-info.xml" xpointer="v246"/>
5091 </listitem>
5092 </varlistentry>
5093
5094 <varlistentry>
5095 <term><varname>QuantumBytes=</varname></term>
5096 <listitem>
5097 <para>Specifies the white-space separated list of quantum used in band-sharing bands. When
5098 suffixed with K, M, or G, the specified size is parsed as Kilobytes, Megabytes, or Gigabytes,
5099 respectively, to the base of 1024. This setting can be specified multiple times. If an empty
5100 string is assigned, then the all previous assignments are cleared.</para>
5101
5102 <xi:include href="version-info.xml" xpointer="v246"/>
5103 </listitem>
5104 </varlistentry>
5105
5106 <varlistentry>
5107 <term><varname>PriorityMap=</varname></term>
5108 <listitem>
5109 <para>The priority map maps the priority of a packet to a band. The argument is a whitespace
5110 separated list of numbers. The first number indicates which band the packets with priority 0 should
5111 be put to, the second is for priority 1, and so on. There can be up to 16 numbers in the list. If
5112 there are fewer, the default band that traffic with one of the unmentioned priorities goes to is
5113 the last one. Each band number must be in the range 0…255. This setting can be specified multiple
5114 times. If an empty string is assigned, then the all previous assignments are cleared.</para>
5115
5116 <xi:include href="version-info.xml" xpointer="v246"/>
5117 </listitem>
5118 </varlistentry>
5119 </variablelist>
5120 </refsect1>
5121
5122 <refsect1>
5123 <title>[GenericRandomEarlyDetection] Section Options</title>
5124 <para>The [GenericRandomEarlyDetection] section manages the queueing discipline (qdisc) of Generic Random
5125 Early Detection (GRED).</para>
5126
5127 <variablelist class='network-directives'>
5128 <xi:include href="tc.xml" xpointer="qdisc-parent" />
5129 <xi:include href="tc.xml" xpointer="qdisc-handle" />
5130
5131 <varlistentry>
5132 <term><varname>VirtualQueues=</varname></term>
5133 <listitem>
5134 <para>Specifies the number of virtual queues. Takes an integer in the range 1…16. Defaults to unset
5135 and kernel's default is used.</para>
5136
5137 <xi:include href="version-info.xml" xpointer="v246"/>
5138 </listitem>
5139 </varlistentry>
5140
5141 <varlistentry>
5142 <term><varname>DefaultVirtualQueue=</varname></term>
5143 <listitem>
5144 <para>Specifies the number of default virtual queue. This must be less than <varname>VirtualQueue=</varname>.
5145 Defaults to unset and kernel's default is used.</para>
5146
5147 <xi:include href="version-info.xml" xpointer="v246"/>
5148 </listitem>
5149 </varlistentry>
5150
5151 <varlistentry>
5152 <term><varname>GenericRIO=</varname></term>
5153 <listitem>
5154 <para>Takes a boolean. It turns on the RIO-like buffering scheme. Defaults to
5155 unset and kernel's default is used.</para>
5156
5157 <xi:include href="version-info.xml" xpointer="v246"/>
5158 </listitem>
5159 </varlistentry>
5160 </variablelist>
5161 </refsect1>
5162
5163 <refsect1>
5164 <title>[FairQueueingControlledDelay] Section Options</title>
5165 <para>The [FairQueueingControlledDelay] section manages the queueing discipline (qdisc) of fair queuing
5166 controlled delay (FQ-CoDel).</para>
5167
5168 <variablelist class='network-directives'>
5169 <xi:include href="tc.xml" xpointer="qdisc-parent" />
5170 <xi:include href="tc.xml" xpointer="qdisc-handle" />
5171
5172 <varlistentry>
5173 <term><varname>PacketLimit=</varname></term>
5174 <listitem>
5175 <para>Specifies the hard limit on the real queue size. When this limit is reached, incoming packets are
5176 dropped. Defaults to unset and kernel's default is used.</para>
5177
5178 <xi:include href="version-info.xml" xpointer="v245"/>
5179 </listitem>
5180 </varlistentry>
5181
5182 <varlistentry>
5183 <term><varname>MemoryLimitBytes=</varname></term>
5184 <listitem>
5185 <para>Specifies the limit on the total number of bytes that can be queued in this FQ-CoDel instance.
5186 When suffixed with K, M, or G, the specified size is parsed as Kilobytes, Megabytes, or Gigabytes,
5187 respectively, to the base of 1024. Defaults to unset and kernel's default is used.</para>
5188
5189 <xi:include href="version-info.xml" xpointer="v246"/>
5190 </listitem>
5191 </varlistentry>
5192
5193 <varlistentry>
5194 <term><varname>Flows=</varname></term>
5195 <listitem>
5196 <para>Specifies the number of flows into which the incoming packets are classified.
5197 Defaults to unset and kernel's default is used.</para>
5198
5199 <xi:include href="version-info.xml" xpointer="v245"/>
5200 </listitem>
5201 </varlistentry>
5202
5203 <varlistentry>
5204 <term><varname>TargetSec=</varname></term>
5205 <listitem>
5206 <para>Takes a timespan. Specifies the acceptable minimum standing/persistent queue delay.
5207 Defaults to unset and kernel's default is used.</para>
5208
5209 <xi:include href="version-info.xml" xpointer="v245"/>
5210 </listitem>
5211 </varlistentry>
5212
5213 <varlistentry>
5214 <term><varname>IntervalSec=</varname></term>
5215 <listitem>
5216 <para>Takes a timespan. This is used to ensure that the measured minimum delay does not
5217 become too stale. Defaults to unset and kernel's default is used.</para>
5218
5219 <xi:include href="version-info.xml" xpointer="v245"/>
5220 </listitem>
5221 </varlistentry>
5222
5223 <varlistentry>
5224 <term><varname>QuantumBytes=</varname></term>
5225 <listitem>
5226 <para>Specifies the number of bytes used as the "deficit" in the fair queuing algorithm timespan.
5227 When suffixed with K, M, or G, the specified size is parsed as Kilobytes, Megabytes, or Gigabytes,
5228 respectively, to the base of 1024. Defaults to unset and kernel's default is used.</para>
5229
5230 <xi:include href="version-info.xml" xpointer="v246"/>
5231 </listitem>
5232 </varlistentry>
5233
5234 <varlistentry>
5235 <term><varname>ECN=</varname></term>
5236 <listitem>
5237 <para>Takes a boolean. This can be used to mark packets instead of dropping them. Defaults to
5238 unset and kernel's default is used.</para>
5239
5240 <xi:include href="version-info.xml" xpointer="v245"/>
5241 </listitem>
5242 </varlistentry>
5243
5244 <varlistentry>
5245 <term><varname>CEThresholdSec=</varname></term>
5246 <listitem>
5247 <para>Takes a timespan. This sets a threshold above which all packets are marked with ECN
5248 Congestion Experienced (CE). Defaults to unset and kernel's default is used.</para>
5249
5250 <xi:include href="version-info.xml" xpointer="v245"/>
5251 </listitem>
5252 </varlistentry>
5253 </variablelist>
5254 </refsect1>
5255
5256 <refsect1>
5257 <title>[FairQueueing] Section Options</title>
5258 <para>The [FairQueueing] section manages the queueing discipline (qdisc) of fair queue traffic policing
5259 (FQ).</para>
5260
5261 <variablelist class='network-directives'>
5262 <xi:include href="tc.xml" xpointer="qdisc-parent" />
5263 <xi:include href="tc.xml" xpointer="qdisc-handle" />
5264
5265 <varlistentry>
5266 <term><varname>PacketLimit=</varname></term>
5267 <listitem>
5268 <para>Specifies the hard limit on the real queue size. When this limit is reached, incoming packets are
5269 dropped. Defaults to unset and kernel's default is used.</para>
5270
5271 <xi:include href="version-info.xml" xpointer="v245"/>
5272 </listitem>
5273 </varlistentry>
5274
5275 <varlistentry>
5276 <term><varname>FlowLimit=</varname></term>
5277 <listitem>
5278 <para>Specifies the hard limit on the maximum number of packets queued per flow. Defaults to
5279 unset and kernel's default is used.</para>
5280
5281 <xi:include href="version-info.xml" xpointer="v245"/>
5282 </listitem>
5283 </varlistentry>
5284
5285 <varlistentry>
5286 <term><varname>QuantumBytes=</varname></term>
5287 <listitem>
5288 <para>Specifies the credit per dequeue RR round, i.e. the amount of bytes a flow is allowed
5289 to dequeue at once. When suffixed with K, M, or G, the specified size is parsed as Kilobytes,
5290 Megabytes, or Gigabytes, respectively, to the base of 1024. Defaults to unset and kernel's
5291 default is used.</para>
5292
5293 <xi:include href="version-info.xml" xpointer="v246"/>
5294 </listitem>
5295 </varlistentry>
5296
5297 <varlistentry>
5298 <term><varname>InitialQuantumBytes=</varname></term>
5299 <listitem>
5300 <para>Specifies the initial sending rate credit, i.e. the amount of bytes a new flow is
5301 allowed to dequeue initially. When suffixed with K, M, or G, the specified size is parsed as
5302 Kilobytes, Megabytes, or Gigabytes, respectively, to the base of 1024. Defaults to unset and
5303 kernel's default is used.</para>
5304
5305 <xi:include href="version-info.xml" xpointer="v246"/>
5306 </listitem>
5307 </varlistentry>
5308
5309 <varlistentry>
5310 <term><varname>MaximumRate=</varname></term>
5311 <listitem>
5312 <para>Specifies the maximum sending rate of a flow. When suffixed with K, M, or G, the
5313 specified size is parsed as Kilobits, Megabits, or Gigabits, respectively, to the base of
5314 1000. Defaults to unset and kernel's default is used.</para>
5315
5316 <xi:include href="version-info.xml" xpointer="v245"/>
5317 </listitem>
5318 </varlistentry>
5319
5320 <varlistentry>
5321 <term><varname>Buckets=</varname></term>
5322 <listitem>
5323 <para>Specifies the size of the hash table used for flow lookups. Defaults to unset and
5324 kernel's default is used.</para>
5325
5326 <xi:include href="version-info.xml" xpointer="v245"/>
5327 </listitem>
5328 </varlistentry>
5329
5330 <varlistentry>
5331 <term><varname>OrphanMask=</varname></term>
5332 <listitem>
5333 <para>Takes an unsigned integer. For packets not owned by a socket, fq is able to mask a part
5334 of hash and reduce number of buckets associated with the traffic. Defaults to unset and
5335 kernel's default is used.</para>
5336
5337 <xi:include href="version-info.xml" xpointer="v245"/>
5338 </listitem>
5339 </varlistentry>
5340
5341 <varlistentry>
5342 <term><varname>Pacing=</varname></term>
5343 <listitem>
5344 <para>Takes a boolean, and enables or disables flow pacing. Defaults to unset and kernel's
5345 default is used.</para>
5346
5347 <xi:include href="version-info.xml" xpointer="v245"/>
5348 </listitem>
5349 </varlistentry>
5350
5351 <varlistentry>
5352 <term><varname>CEThresholdSec=</varname></term>
5353 <listitem>
5354 <para>Takes a timespan. This sets a threshold above which all packets are marked with ECN
5355 Congestion Experienced (CE). Defaults to unset and kernel's default is used.</para>
5356
5357 <xi:include href="version-info.xml" xpointer="v245"/>
5358 </listitem>
5359 </varlistentry>
5360 </variablelist>
5361 </refsect1>
5362
5363 <refsect1>
5364 <title>[TrivialLinkEqualizer] Section Options</title>
5365 <para>The [TrivialLinkEqualizer] section manages the queueing discipline (qdisc) of trivial link
5366 equalizer (teql).</para>
5367
5368 <variablelist class='network-directives'>
5369 <xi:include href="tc.xml" xpointer="qdisc-parent" />
5370 <xi:include href="tc.xml" xpointer="qdisc-handle" />
5371
5372 <varlistentry>
5373 <term><varname>Id=</varname></term>
5374 <listitem>
5375 <para>Specifies the interface ID <literal>N</literal> of teql. Defaults to <literal>0</literal>.
5376 Note that when teql is used, currently, the module <constant>sch_teql</constant> with
5377 <constant>max_equalizers=N+1</constant> option must be loaded before
5378 <command>systemd-networkd</command> is started.</para>
5379
5380 <xi:include href="version-info.xml" xpointer="v245"/>
5381 </listitem>
5382 </varlistentry>
5383 </variablelist>
5384 </refsect1>
5385
5386 <refsect1>
5387 <title>[HierarchyTokenBucket] Section Options</title>
5388 <para>The [HierarchyTokenBucket] section manages the queueing discipline (qdisc) of hierarchy token
5389 bucket (htb).</para>
5390
5391 <variablelist class='network-directives'>
5392 <xi:include href="tc.xml" xpointer="qdisc-parent" />
5393 <xi:include href="tc.xml" xpointer="qdisc-handle" />
5394
5395 <varlistentry>
5396 <term><varname>DefaultClass=</varname></term>
5397 <listitem>
5398 <para>Takes the minor id in hexadecimal of the default class. Unclassified traffic gets sent
5399 to the class. Defaults to unset.</para>
5400
5401 <xi:include href="version-info.xml" xpointer="v246"/>
5402 </listitem>
5403 </varlistentry>
5404
5405 <varlistentry>
5406 <term><varname>RateToQuantum=</varname></term>
5407 <listitem>
5408 <para>Takes an unsigned integer. The DRR quantums are calculated by dividing the value
5409 configured in <varname>Rate=</varname> by <varname>RateToQuantum=</varname>.</para>
5410
5411 <xi:include href="version-info.xml" xpointer="v246"/>
5412 </listitem>
5413 </varlistentry>
5414 </variablelist>
5415 </refsect1>
5416
5417 <refsect1>
5418 <title>[HierarchyTokenBucketClass] Section Options</title>
5419 <para>The [HierarchyTokenBucketClass] section manages the traffic control class of hierarchy token bucket
5420 (htb).</para>
5421
5422 <variablelist class='network-directives'>
5423 <xi:include href="tc.xml" xpointer="tclass-parent" />
5424 <xi:include href="tc.xml" xpointer="tclass-classid" />
5425
5426 <varlistentry>
5427 <term><varname>Priority=</varname></term>
5428 <listitem>
5429 <para>Specifies the priority of the class. In the round-robin process, classes with the lowest
5430 priority field are tried for packets first.</para>
5431
5432 <xi:include href="version-info.xml" xpointer="v246"/>
5433 </listitem>
5434 </varlistentry>
5435
5436 <varlistentry>
5437 <term><varname>QuantumBytes=</varname></term>
5438 <listitem>
5439 <para>Specifies how many bytes to serve from leaf at once. When suffixed with K, M, or G, the
5440 specified size is parsed as Kilobytes, Megabytes, or Gigabytes, respectively, to the base of
5441 1024.</para>
5442
5443 <xi:include href="version-info.xml" xpointer="v246"/>
5444 </listitem>
5445 </varlistentry>
5446
5447 <varlistentry>
5448 <term><varname>MTUBytes=</varname></term>
5449 <listitem>
5450 <para>Specifies the maximum packet size we create. When suffixed with K, M, or G, the specified
5451 size is parsed as Kilobytes, Megabytes, or Gigabytes, respectively, to the base of 1024.</para>
5452
5453 <xi:include href="version-info.xml" xpointer="v246"/>
5454 </listitem>
5455 </varlistentry>
5456
5457 <varlistentry>
5458 <term><varname>OverheadBytes=</varname></term>
5459 <listitem>
5460 <para>Takes an unsigned integer which specifies per-packet size overhead used in rate
5461 computations. When suffixed with K, M, or G, the specified size is parsed as Kilobytes,
5462 Megabytes, or Gigabytes, respectively, to the base of 1024.</para>
5463
5464 <xi:include href="version-info.xml" xpointer="v246"/>
5465 </listitem>
5466 </varlistentry>
5467
5468 <varlistentry>
5469 <term><varname>Rate=</varname></term>
5470 <listitem>
5471 <para>Specifies the maximum rate this class and all its children are guaranteed. When suffixed
5472 with K, M, or G, the specified size is parsed as Kilobits, Megabits, or Gigabits, respectively,
5473 to the base of 1000. This setting is mandatory.</para>
5474
5475 <xi:include href="version-info.xml" xpointer="v246"/>
5476 </listitem>
5477 </varlistentry>
5478
5479 <varlistentry>
5480 <term><varname>CeilRate=</varname></term>
5481 <listitem>
5482 <para>Specifies the maximum rate at which a class can send, if its parent has bandwidth to spare.
5483 When suffixed with K, M, or G, the specified size is parsed as Kilobits, Megabits, or Gigabits,
5484 respectively, to the base of 1000. When unset, the value specified with <varname>Rate=</varname>
5485 is used.</para>
5486
5487 <xi:include href="version-info.xml" xpointer="v246"/>
5488 </listitem>
5489 </varlistentry>
5490
5491 <varlistentry>
5492 <term><varname>BufferBytes=</varname></term>
5493 <listitem>
5494 <para>Specifies the maximum bytes burst which can be accumulated during idle period. When suffixed
5495 with K, M, or G, the specified size is parsed as Kilobytes, Megabytes, or Gigabytes, respectively,
5496 to the base of 1024.</para>
5497
5498 <xi:include href="version-info.xml" xpointer="v246"/>
5499 </listitem>
5500 </varlistentry>
5501
5502 <varlistentry>
5503 <term><varname>CeilBufferBytes=</varname></term>
5504 <listitem>
5505 <para>Specifies the maximum bytes burst for ceil which can be accumulated during idle period.
5506 When suffixed with K, M, or G, the specified size is parsed as Kilobytes, Megabytes, or Gigabytes,
5507 respectively, to the base of 1024.</para>
5508
5509 <xi:include href="version-info.xml" xpointer="v246"/>
5510 </listitem>
5511 </varlistentry>
5512 </variablelist>
5513 </refsect1>
5514
5515 <refsect1>
5516 <title>[HeavyHitterFilter] Section Options</title>
5517 <para>The [HeavyHitterFilter] section manages the queueing discipline (qdisc) of Heavy Hitter Filter
5518 (hhf).</para>
5519
5520 <variablelist class='network-directives'>
5521 <xi:include href="tc.xml" xpointer="qdisc-parent" />
5522 <xi:include href="tc.xml" xpointer="qdisc-handle" />
5523
5524 <varlistentry>
5525 <term><varname>PacketLimit=</varname></term>
5526 <listitem>
5527 <para>Specifies the hard limit on the queue size in number of packets. When this limit is reached,
5528 incoming packets are dropped. An unsigned integer in the range 0…4294967294. Defaults to unset and
5529 kernel's default is used.</para>
5530
5531 <xi:include href="version-info.xml" xpointer="v246"/>
5532 </listitem>
5533 </varlistentry>
5534 </variablelist>
5535 </refsect1>
5536
5537 <refsect1>
5538 <title>[QuickFairQueueing] Section Options</title>
5539 <para>The [QuickFairQueueing] section manages the queueing discipline (qdisc) of Quick Fair Queueing
5540 (QFQ).</para>
5541
5542 <variablelist class='network-directives'>
5543 <xi:include href="tc.xml" xpointer="qdisc-parent" />
5544 <xi:include href="tc.xml" xpointer="qdisc-handle" />
5545 </variablelist>
5546 </refsect1>
5547
5548 <refsect1>
5549 <title>[QuickFairQueueingClass] Section Options</title>
5550 <para>The [QuickFairQueueingClass] section manages the traffic control class of Quick Fair Queueing
5551 (qfq).</para>
5552
5553 <variablelist class='network-directives'>
5554 <xi:include href="tc.xml" xpointer="tclass-parent" />
5555 <xi:include href="tc.xml" xpointer="tclass-classid" />
5556
5557 <varlistentry>
5558 <term><varname>Weight=</varname></term>
5559 <listitem>
5560 <para>Specifies the weight of the class. Takes an integer in the range 1…1023. Defaults to
5561 unset in which case the kernel default is used.</para>
5562
5563 <xi:include href="version-info.xml" xpointer="v246"/>
5564 </listitem>
5565 </varlistentry>
5566
5567 <varlistentry>
5568 <term><varname>MaxPacketBytes=</varname></term>
5569 <listitem>
5570 <para>Specifies the maximum packet size in bytes for the class. When suffixed with K, M, or G, the
5571 specified size is parsed as Kilobytes, Megabytes, or Gigabytes, respectively, to the base of
5572 1024. When unset, the kernel default is used.</para>
5573
5574 <xi:include href="version-info.xml" xpointer="v246"/>
5575 </listitem>
5576 </varlistentry>
5577 </variablelist>
5578 </refsect1>
5579
5580 <refsect1>
5581 <title>[BridgeVLAN] Section Options</title>
5582 <para>The [BridgeVLAN] section manages the VLAN ID configuration of a bridge port and accepts the
5583 following keys. Specify several [BridgeVLAN] sections to configure several VLAN entries. The
5584 <varname>VLANFiltering=</varname> option has to be enabled, see the [Bridge] section in
5585 <citerefentry><refentrytitle>systemd.netdev</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para>
5586
5587 <variablelist class='network-directives'>
5588 <varlistentry>
5589 <term><varname>VLAN=</varname></term>
5590 <listitem>
5591 <para>The VLAN ID allowed on the port. This can be either a single ID or a range M-N. Takes
5592 an integer in the range 1…4094.</para>
5593 </listitem>
5594 </varlistentry>
5595 <varlistentry>
5596 <term><varname>EgressUntagged=</varname></term>
5597 <listitem>
5598 <para>The VLAN ID specified here will be used to untag frames on egress. Configuring
5599 <varname>EgressUntagged=</varname> implicates the use of <varname>VLAN=</varname> above and will enable the
5600 VLAN ID for ingress as well. This can be either a single ID or a range M-N.</para>
5601
5602 <xi:include href="version-info.xml" xpointer="v231"/>
5603 </listitem>
5604 </varlistentry>
5605 <varlistentry>
5606 <term><varname>PVID=</varname></term>
5607 <listitem>
5608 <para>The Port VLAN ID specified here is assigned to all untagged frames at ingress.
5609 <varname>PVID=</varname> can be used only once. Configuring <varname>PVID=</varname> implicates the use of
5610 <varname>VLAN=</varname> above and will enable the VLAN ID for ingress as well.</para>
5611
5612 <xi:include href="version-info.xml" xpointer="v231"/>
5613 </listitem>
5614 </varlistentry>
5615 </variablelist>
5616 </refsect1>
5617
5618 <refsect1>
5619 <title>Examples</title>
5620 <example>
5621 <title>Static network configuration</title>
5622
5623 <programlisting># /etc/systemd/network/50-static.network
5624 [Match]
5625 Name=enp2s0
5626
5627 [Network]
5628 Address=192.168.0.15/24
5629 Gateway=192.168.0.1</programlisting>
5630
5631 <para>This brings interface <literal>enp2s0</literal> up with a static address. The
5632 specified gateway will be used for a default route.</para>
5633 </example>
5634
5635 <example>
5636 <title>DHCP on ethernet links</title>
5637
5638 <programlisting># /etc/systemd/network/80-dhcp.network
5639 [Match]
5640 Name=en*
5641
5642 [Network]
5643 DHCP=yes</programlisting>
5644
5645 <para>This will enable DHCPv4 and DHCPv6 on all interfaces with names starting with
5646 <literal>en</literal> (i.e. ethernet interfaces).</para>
5647 </example>
5648
5649 <example>
5650 <title>IPv6 Prefix Delegation (DHCPv6 PD)</title>
5651
5652 <programlisting># /etc/systemd/network/55-dhcpv6-pd-upstream.network
5653 [Match]
5654 Name=enp1s0
5655
5656 [Network]
5657 DHCP=ipv6
5658
5659 # The below setting is optional, to also assign an address in the delegated prefix
5660 # to the upstream interface. If not necessary, then comment out the line below and
5661 # the [DHCPPrefixDelegation] section.
5662 DHCPPrefixDelegation=yes
5663
5664 # If the upstream network provides Router Advertisement with Managed bit set,
5665 # then comment out the line below and WithoutRA= setting in the [DHCPv6] section.
5666 IPv6AcceptRA=no
5667
5668 [DHCPv6]
5669 WithoutRA=solicit
5670
5671 [DHCPPrefixDelegation]
5672 UplinkInterface=:self
5673 SubnetId=0
5674 Announce=no</programlisting>
5675
5676 <programlisting># /etc/systemd/network/55-dhcpv6-pd-downstream.network
5677 [Match]
5678 Name=enp2s0
5679
5680 [Network]
5681 DHCPPrefixDelegation=yes
5682 IPv6SendRA=yes
5683
5684 # It is expected that the host is acting as a router. So, usually it is not
5685 # necessary to receive Router Advertisement from other hosts in the downstream network.
5686 IPv6AcceptRA=no
5687
5688 [DHCPPrefixDelegation]
5689 UplinkInterface=enp1s0
5690 SubnetId=1
5691 Announce=yes</programlisting>
5692
5693 <para>This will enable DHCPv6-PD on the interface enp1s0 as an upstream interface where the
5694 DHCPv6 client is running and enp2s0 as a downstream interface where the prefix is delegated to.
5695 The delegated prefixes are distributed by IPv6 Router Advertisement on the downstream network.
5696 </para>
5697 </example>
5698
5699 <example>
5700 <title>IPv6 Prefix Delegation (DHCPv4 6RD)</title>
5701
5702 <programlisting># /etc/systemd/network/55-dhcpv4-6rd-upstream.network
5703 [Match]
5704 Name=enp1s0
5705
5706 [Network]
5707 DHCP=ipv4
5708
5709 # When DHCPv4-6RD is used, the upstream network does not support IPv6.
5710 # Hence, it is not necessary to wait for Router Advertisement, which is enabled by default.
5711 IPv6AcceptRA=no
5712
5713 [DHCPv4]
5714 Use6RD=yes</programlisting>
5715
5716 <programlisting># /etc/systemd/network/55-dhcpv4-6rd-downstream.network
5717 [Match]
5718 Name=enp2s0
5719
5720 [Network]
5721 DHCPPrefixDelegation=yes
5722 IPv6SendRA=yes
5723
5724 # It is expected that the host is acting as a router. So, usually it is not
5725 # necessary to receive Router Advertisement from other hosts in the downstream network.
5726 IPv6AcceptRA=no
5727
5728 [DHCPPrefixDelegation]
5729 UplinkInterface=enp1s0
5730 SubnetId=1
5731 Announce=yes</programlisting>
5732
5733 <para>This will enable DHCPv4-6RD on the interface enp1s0 as an upstream interface where the
5734 DHCPv4 client is running and enp2s0 as a downstream interface where the prefix is delegated to.
5735 The delegated prefixes are distributed by IPv6 Router Advertisement on the downstream network.
5736 </para>
5737 </example>
5738
5739 <example>
5740 <title>A bridge with two enslaved links</title>
5741
5742 <programlisting># /etc/systemd/network/25-bridge-static.netdev
5743 [NetDev]
5744 Name=bridge0
5745 Kind=bridge</programlisting>
5746
5747 <programlisting># /etc/systemd/network/25-bridge-static.network
5748 [Match]
5749 Name=bridge0
5750
5751 [Network]
5752 Address=192.168.0.15/24
5753 Gateway=192.168.0.1
5754 DNS=192.168.0.1</programlisting>
5755
5756 <programlisting># /etc/systemd/network/25-bridge-slave-interface-1.network
5757 [Match]
5758 Name=enp2s0
5759
5760 [Network]
5761 Bridge=bridge0</programlisting>
5762
5763 <programlisting># /etc/systemd/network/25-bridge-slave-interface-2.network
5764 [Match]
5765 Name=wlp3s0
5766
5767 [Network]
5768 Bridge=bridge0</programlisting>
5769
5770 <para>This creates a bridge and attaches devices <literal>enp2s0</literal> and
5771 <literal>wlp3s0</literal> to it. The bridge will have the specified static address
5772 and network assigned, and a default route via the specified gateway will be
5773 added. The specified DNS server will be added to the global list of DNS resolvers.
5774 </para>
5775 </example>
5776
5777 <example>
5778 <title>Bridge port with VLAN forwarding</title>
5779
5780 <programlisting>
5781 # /etc/systemd/network/25-bridge-slave-interface-1.network
5782 [Match]
5783 Name=enp2s0
5784
5785 [Network]
5786 Bridge=bridge0
5787
5788 [BridgeVLAN]
5789 VLAN=1-32
5790 PVID=42
5791 EgressUntagged=42
5792
5793 [BridgeVLAN]
5794 VLAN=100-200
5795
5796 [BridgeVLAN]
5797 EgressUntagged=300-400</programlisting>
5798
5799 <para>This overrides the configuration specified in the previous example for the
5800 interface <literal>enp2s0</literal>, and enables VLAN on that bridge port. VLAN IDs
5801 1-32, 42, 100-400 will be allowed. Packets tagged with VLAN IDs 42, 300-400 will be
5802 untagged when they leave on this interface. Untagged packets which arrive on this
5803 interface will be assigned VLAN ID 42.</para>
5804 </example>
5805
5806 <example>
5807 <title>Various tunnels</title>
5808
5809 <programlisting>/etc/systemd/network/25-tunnels.network
5810 [Match]
5811 Name=ens1
5812
5813 [Network]
5814 Tunnel=ipip-tun
5815 Tunnel=sit-tun
5816 Tunnel=gre-tun
5817 Tunnel=vti-tun
5818 </programlisting>
5819
5820 <programlisting>/etc/systemd/network/25-tunnel-ipip.netdev
5821 [NetDev]
5822 Name=ipip-tun
5823 Kind=ipip
5824 </programlisting>
5825
5826 <programlisting>/etc/systemd/network/25-tunnel-sit.netdev
5827 [NetDev]
5828 Name=sit-tun
5829 Kind=sit
5830 </programlisting>
5831
5832 <programlisting>/etc/systemd/network/25-tunnel-gre.netdev
5833 [NetDev]
5834 Name=gre-tun
5835 Kind=gre
5836 </programlisting>
5837
5838 <programlisting>/etc/systemd/network/25-tunnel-vti.netdev
5839 [NetDev]
5840 Name=vti-tun
5841 Kind=vti
5842 </programlisting>
5843
5844 <para>This will bring interface <literal>ens1</literal> up and create an IPIP tunnel,
5845 a SIT tunnel, a GRE tunnel, and a VTI tunnel using it.</para>
5846 </example>
5847
5848 <example>
5849 <title>A bond device</title>
5850
5851 <programlisting># /etc/systemd/network/30-bond1.network
5852 [Match]
5853 Name=bond1
5854
5855 [Network]
5856 DHCP=ipv6
5857 </programlisting>
5858
5859 <programlisting># /etc/systemd/network/30-bond1.netdev
5860 [NetDev]
5861 Name=bond1
5862 Kind=bond
5863 </programlisting>
5864
5865 <programlisting># /etc/systemd/network/30-bond1-dev1.network
5866 [Match]
5867 MACAddress=52:54:00:e9:64:41
5868
5869 [Network]
5870 Bond=bond1
5871 </programlisting>
5872
5873 <programlisting># /etc/systemd/network/30-bond1-dev2.network
5874 [Match]
5875 MACAddress=52:54:00:e9:64:42
5876
5877 [Network]
5878 Bond=bond1
5879 </programlisting>
5880
5881 <para>This will create a bond device <literal>bond1</literal> and enslave the two
5882 devices with MAC addresses 52:54:00:e9:64:41 and 52:54:00:e9:64:42 to it. IPv6 DHCP
5883 will be used to acquire an address.</para>
5884 </example>
5885
5886 <example>
5887 <title>Virtual Routing and Forwarding (VRF)</title>
5888 <para>Add the <literal>bond1</literal> interface to the VRF master interface
5889 <literal>vrf1</literal>. This will redirect routes generated on this interface to be
5890 within the routing table defined during VRF creation. For kernels before 4.8 traffic
5891 won't be redirected towards the VRFs routing table unless specific ip-rules are added.
5892 </para>
5893 <programlisting># /etc/systemd/network/25-vrf.network
5894 [Match]
5895 Name=bond1
5896
5897 [Network]
5898 VRF=vrf1
5899 </programlisting>
5900 </example>
5901
5902 <example>
5903 <title>MacVTap</title>
5904 <para>This brings up a network interface <literal>macvtap-test</literal>
5905 and attaches it to <literal>enp0s25</literal>.</para>
5906 <programlisting># /usr/lib/systemd/network/25-macvtap.network
5907 [Match]
5908 Name=enp0s25
5909
5910 [Network]
5911 MACVTAP=macvtap-test
5912 </programlisting>
5913 </example>
5914
5915 <example>
5916 <title>A Xfrm interface with physical underlying device.</title>
5917
5918 <programlisting># /etc/systemd/network/27-xfrm.netdev
5919 [NetDev]
5920 Name=xfrm0
5921 Kind=xfrm
5922
5923 [Xfrm]
5924 InterfaceId=7</programlisting>
5925
5926 <programlisting># /etc/systemd/network/27-eth0.network
5927 [Match]
5928 Name=eth0
5929
5930 [Network]
5931 Xfrm=xfrm0</programlisting>
5932
5933 <para>This creates a <literal>xfrm0</literal> interface and binds it to the <literal>eth0</literal> device.
5934 This allows hardware based ipsec offloading to the <literal>eth0</literal> nic.
5935 If offloading is not needed, xfrm interfaces can be assigned to the <literal>lo</literal> device.
5936 </para>
5937 </example>
5938 </refsect1>
5939
5940 <refsect1>
5941 <title>See Also</title>
5942 <para>
5943 <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
5944 <citerefentry><refentrytitle>systemd-networkd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
5945 <citerefentry><refentrytitle>systemd.link</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
5946 <citerefentry><refentrytitle>systemd.netdev</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
5947 <citerefentry><refentrytitle>systemd-network-generator.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
5948 <citerefentry><refentrytitle>systemd-resolved.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>
5949 </para>
5950 </refsect1>
5951
5952 </refentry>