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