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