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