]> git.ipfire.org Git - thirdparty/systemd.git/blame - man/systemd.network.xml
Merge pull request #29390 from yuwata/sd-netlink-make-default-timeout-configurable
[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
2101 <varlistentry>
2102 <term><varname>SendHostname=</varname></term>
2103 <listitem>
2104 <para>When true (the default), the machine's hostname (or the value specified with
2105 <varname>Hostname=</varname>, described below) will be sent to the DHCP server. Note that the
2106 hostname must consist only of 7-bit ASCII lower-case characters and no spaces or dots, and be
2107 formatted as a valid DNS domain name. Otherwise, the hostname is not sent even if this option
2108 is true.</para>
aefdc112
AK
2109
2110 <xi:include href="version-info.xml" xpointer="v215"/>
add469f5
YW
2111 </listitem>
2112 </varlistentry>
2113
2114 <varlistentry>
2115 <term><varname>Hostname=</varname></term>
2116 <listitem>
2117 <para>Use this value for the hostname which is sent to the DHCP server, instead of machine's
2118 hostname. Note that the specified hostname must consist only of 7-bit ASCII lower-case
2119 characters and no spaces or dots, and be formatted as a valid DNS domain name.</para>
aefdc112
AK
2120
2121 <xi:include href="version-info.xml" xpointer="v223"/>
add469f5
YW
2122 </listitem>
2123 </varlistentry>
2124
2125 <varlistentry>
2126 <term><varname>MUDURL=</varname></term>
2127 <listitem>
2128 <para>When configured, the specified Manufacturer Usage Description (MUD) URL will be sent
2129 to the DHCPv4 server. Takes a URL of length up to 255 characters. A superficial verification
2130 that the string is a valid URL will be performed. DHCPv4 clients are intended to have at most
2131 one MUD URL associated with them. See
2132 <ulink url="https://tools.ietf.org/html/rfc8520">RFC 8520</ulink>.</para>
2133
2134 <para>MUD is an embedded software standard defined by the IETF that allows IoT device makers
2135 to advertise device specifications, including the intended communication patterns for their
2136 device when it connects to the network. The network can then use this to author a
2137 context-specific access policy, so the device functions only within those parameters.</para>
ec07c3c8
AK
2138
2139 <xi:include href="version-info.xml" xpointer="v246"/>
add469f5
YW
2140 </listitem>
2141 </varlistentry>
2142
2143 <varlistentry>
2144 <term><varname>ClientIdentifier=</varname></term>
2145 <listitem>
d8f19e03
YW
2146 <para>The DHCPv4 client identifier to use. Takes one of <option>mac</option> or
2147 <option>duid</option>. If set to <option>mac</option>, the MAC address of the link is used. If set
2148 to <option>duid</option>, an RFC4361-compliant Client ID, which is the combination of IAID and
2149 DUID, is used. IAID can be configured by <varname>IAID=</varname>. DUID can be configured by
2150 <varname>DUIDType=</varname> and <varname>DUIDRawData=</varname>. Defaults to
2151 <option>duid</option>.</para>
aefdc112
AK
2152
2153 <xi:include href="version-info.xml" xpointer="v220"/>
add469f5
YW
2154 </listitem>
2155 </varlistentry>
2156
2157 <varlistentry>
2158 <term><varname>VendorClassIdentifier=</varname></term>
2159 <listitem>
2160 <para>The vendor class identifier used to identify vendor type and configuration.</para>
aefdc112
AK
2161
2162 <xi:include href="version-info.xml" xpointer="v216"/>
add469f5
YW
2163 </listitem>
2164 </varlistentry>
2165
2166 <varlistentry>
2167 <term><varname>UserClass=</varname></term>
2168 <listitem>
2169 <para>A DHCPv4 client can use UserClass option to identify the type or category of user or
2170 applications it represents. The information contained in this option is a string that
2171 represents the user class of which the client is a member. Each class sets an identifying
2172 string of information to be used by the DHCP service to classify clients. Takes a
2173 whitespace-separated list of strings.</para>
aefdc112
AK
2174
2175 <xi:include href="version-info.xml" xpointer="v239"/>
add469f5
YW
2176 </listitem>
2177 </varlistentry>
2178
2179 <varlistentry>
2180 <term><varname>DUIDType=</varname></term>
2181 <listitem>
2182 <para>Override the global <varname>DUIDType=</varname> setting for this network. See
2183 <citerefentry><refentrytitle>networkd.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>
2184 for a description of possible values.</para>
aefdc112
AK
2185
2186 <xi:include href="version-info.xml" xpointer="v230"/>
add469f5
YW
2187 </listitem>
2188 </varlistentry>
2189
2190 <varlistentry>
2191 <term><varname>DUIDRawData=</varname></term>
2192 <listitem>
2193 <para>Override the global <varname>DUIDRawData=</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>IAID=</varname></term>
2203 <listitem>
2204 <para>The DHCP Identity Association Identifier (IAID) for the interface, a 32-bit unsigned
2205 integer.</para>
aefdc112
AK
2206
2207 <xi:include href="version-info.xml" xpointer="v230"/>
add469f5
YW
2208 </listitem>
2209 </varlistentry>
2210
2211 <varlistentry>
2212 <term><varname>Anonymize=</varname></term>
2213 <listitem>
2214 <para>Takes a boolean. When true, the options sent to the DHCP server will follow the
2215 <ulink url="https://tools.ietf.org/html/rfc7844">RFC 7844</ulink> (Anonymity Profiles for
2216 DHCP Clients) to minimize disclosure of identifying information. Defaults to false.</para>
2217
2218 <para>This option should only be set to true when <varname>MACAddressPolicy=</varname> is set
2219 to <option>random</option> (see
2220 <citerefentry><refentrytitle>systemd.link</refentrytitle><manvolnum>5</manvolnum></citerefentry>).
2221 </para>
2222
2223 <para>When true, <varname>SendHostname=</varname>, <varname>ClientIdentifier=</varname>,
2224 <varname>VendorClassIdentifier=</varname>, <varname>UserClass=</varname>,
2225 <varname>RequestOptions=</varname>, <varname>SendOption=</varname>,
2226 <varname>SendVendorOption=</varname>, and <varname>MUDURL=</varname> are ignored.</para>
2227
2228 <para>With this option enabled DHCP requests will mimic those generated by Microsoft
2229 Windows, in order to reduce the ability to fingerprint and recognize installations. This
2230 means DHCP request sizes will grow and lease data will be more comprehensive than normally,
2231 though most of the requested data is not actually used.</para>
aefdc112
AK
2232
2233 <xi:include href="version-info.xml" xpointer="v235"/>
add469f5
YW
2234 </listitem>
2235 </varlistentry>
2236
2237 <varlistentry>
2238 <term><varname>RequestOptions=</varname></term>
2239 <listitem>
2240 <para>Sets request options to be sent to the server in the DHCPv4 request options list. A
2241 whitespace-separated list of integers in the range 1…254. Defaults to unset.</para>
ec07c3c8
AK
2242
2243 <xi:include href="version-info.xml" xpointer="v244"/>
add469f5
YW
2244 </listitem>
2245 </varlistentry>
2246
2247 <varlistentry>
2248 <term><varname>SendOption=</varname></term>
2249 <listitem>
2250 <para>Send an arbitrary raw option in the DHCPv4 request. Takes a DHCP option number, data
2251 type and data separated with a colon
2252 (<literal><replaceable>option</replaceable>:<replaceable>type</replaceable>:<replaceable>value</replaceable></literal>).
2253 The option number must be an integer in the range 1…254. The type takes one of
2254 <literal>uint8</literal>, <literal>uint16</literal>, <literal>uint32</literal>,
2255 <literal>ipv4address</literal>, or <literal>string</literal>. Special characters in the data
2256 string may be escaped using
2257 <ulink url="https://en.wikipedia.org/wiki/Escape_sequences_in_C#Table_of_escape_sequences">C-style
2258 escapes</ulink>. This setting can be specified multiple times. If an empty string is
2259 specified, then all options specified earlier are cleared. Defaults to unset.</para>
ec07c3c8
AK
2260
2261 <xi:include href="version-info.xml" xpointer="v244"/>
add469f5
YW
2262 </listitem>
2263 </varlistentry>
2264
2265 <varlistentry>
2266 <term><varname>SendVendorOption=</varname></term>
2267 <listitem>
2268 <para>Send an arbitrary vendor option in the DHCPv4 request. Takes a DHCP option number, data
2269 type and data separated with a colon
2270 (<literal><replaceable>option</replaceable>:<replaceable>type</replaceable>:<replaceable>value</replaceable></literal>).
2271 The option number must be an integer in the range 1…254. The type takes one of
2272 <literal>uint8</literal>, <literal>uint16</literal>, <literal>uint32</literal>,
2273 <literal>ipv4address</literal>, or <literal>string</literal>. Special characters in the data
2274 string may be escaped using
2275 <ulink url="https://en.wikipedia.org/wiki/Escape_sequences_in_C#Table_of_escape_sequences">C-style
2276 escapes</ulink>. This setting can be specified multiple times. If an empty string is specified,
2277 then all options specified earlier are cleared. Defaults to unset.</para>
ec07c3c8
AK
2278
2279 <xi:include href="version-info.xml" xpointer="v246"/>
add469f5
YW
2280 </listitem>
2281 </varlistentry>
2282
2283 <varlistentry>
2284 <term><varname>IPServiceType=</varname></term>
2285 <listitem>
2286 <para>Takes one of the special values <literal>none</literal>, <literal>CS6</literal>, or
2287 <literal>CS4</literal>. When <literal>none</literal> no IP service type is set to the packet
2288 sent from the DHCPv4 client. When <literal>CS6</literal> (network control) or
2289 <literal>CS4</literal> (realtime), the corresponding service type will be set. Defaults to
2290 <literal>CS6</literal>.</para>
aefdc112
AK
2291
2292 <xi:include href="version-info.xml" xpointer="v244"/>
add469f5
YW
2293 </listitem>
2294 </varlistentry>
ea577968 2295
2296 <varlistentry>
2297 <term><varname>SocketPriority=</varname></term>
2298 <listitem>
2299 <para>The Linux socket option <constant>SO_PRIORITY</constant> applied to the raw IP socket used for
2300 initial DHCPv4 messages. Unset by default. Usual values range from 0 to 6.
2301 More details about <constant>SO_PRIORITY</constant> socket option in
2302 <citerefentry project='man-pages'><refentrytitle>socket</refentrytitle><manvolnum>7</manvolnum></citerefentry>.
2303 Can be used in conjunction with [VLAN] section <varname>EgressQOSMaps=</varname> setting of .netdev
2304 file to set the 802.1Q VLAN ethernet tagged header priority, see
2305 <citerefentry><refentrytitle>systemd.netdev</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
2306 </para>
ec07c3c8
AK
2307
2308 <xi:include href="version-info.xml" xpointer="v253"/>
ea577968 2309 </listitem>
2310 </varlistentry>
add469f5
YW
2311
2312 <!-- How to use the DHCP lease -->
2313
2314 <varlistentry>
2315 <term><varname>Label=</varname></term>
2316 <listitem>
2317 <para>Specifies the label for the IPv4 address received from the DHCP server. The label must
2318 be a 7-bit ASCII string with a length of 1…15 characters. Defaults to unset.</para>
ec07c3c8
AK
2319
2320 <xi:include href="version-info.xml" xpointer="v250"/>
add469f5
YW
2321 </listitem>
2322 </varlistentry>
2323
2324 <varlistentry>
2325 <term><varname>UseDNS=</varname></term>
2326 <listitem>
2327 <para>When true (the default), the DNS servers received from the DHCP server will be used.
2328 </para>
2329
2330 <para>This corresponds to the <option>nameserver</option> option in
2331 <citerefentry project='man-pages'><refentrytitle>resolv.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
2332 </para>
aefdc112
AK
2333
2334 <xi:include href="version-info.xml" xpointer="v211"/>
add469f5
YW
2335 </listitem>
2336 </varlistentry>
2337
2338 <varlistentry>
2339 <term><varname>RoutesToDNS=</varname></term>
2340 <listitem>
2341 <para>When true, the routes to the DNS servers received from the DHCP server will be
2342 configured. When <varname>UseDNS=</varname> is disabled, this setting is ignored. Defaults to
2343 true.</para>
ec07c3c8
AK
2344
2345 <xi:include href="version-info.xml" xpointer="v243"/>
add469f5
YW
2346 </listitem>
2347 </varlistentry>
2348
2349 <varlistentry>
2350 <term><varname>UseNTP=</varname></term>
2351 <listitem>
2352 <para>When true (the default), the NTP servers received from the DHCP server will be used by
2353 <filename>systemd-timesyncd.service</filename>.</para>
aefdc112
AK
2354
2355 <xi:include href="version-info.xml" xpointer="v220"/>
add469f5
YW
2356 </listitem>
2357 </varlistentry>
2358
2359 <varlistentry>
2360 <term><varname>RoutesToNTP=</varname></term>
2361 <listitem>
2362 <para>When true, the routes to the NTP servers received from the DHCP server will be
2363 configured. When <varname>UseNTP=</varname> is disabled, this setting is ignored. Defaults to
2364 true.</para>
ec07c3c8
AK
2365
2366 <xi:include href="version-info.xml" xpointer="v249"/>
add469f5
YW
2367 </listitem>
2368 </varlistentry>
2369
2370 <varlistentry>
2371 <term><varname>UseSIP=</varname></term>
2372 <listitem>
2373 <para>When true (the default), the SIP servers received from the DHCP server will be collected
2374 and made available to client programs.</para>
ec07c3c8
AK
2375
2376 <xi:include href="version-info.xml" xpointer="v244"/>
add469f5
YW
2377 </listitem>
2378 </varlistentry>
2379
edb88a72
RP
2380 <varlistentry>
2381 <term><varname>UseCaptivePortal=</varname></term>
2382 <listitem>
2383 <para>When true (the default), the captive portal advertised by the DHCP server will be recorded
2384 and made available to client programs and displayed in the networkctl status output per-link.</para>
ec07c3c8
AK
2385
2386 <xi:include href="version-info.xml" xpointer="v254"/>
edb88a72
RP
2387 </listitem>
2388 </varlistentry>
2389
add469f5
YW
2390 <varlistentry>
2391 <term><varname>UseMTU=</varname></term>
2392 <listitem>
2393 <para>When true, the interface maximum transmission unit from the DHCP server will be used on
2394 the current link. If <varname>MTUBytes=</varname> is set, then this setting is ignored.
2395 Defaults to false.</para>
2396
2397 <para>Note, some drivers will reset the interfaces if the MTU is changed. For such
2398 interfaces, please try to use <varname>IgnoreCarrierLoss=</varname> with a short timespan,
2399 e.g. <literal>3 seconds</literal>.</para>
aefdc112
AK
2400
2401 <xi:include href="version-info.xml" xpointer="v211"/>
add469f5
YW
2402 </listitem>
2403 </varlistentry>
2404
2405 <varlistentry>
2406 <term><varname>UseHostname=</varname></term>
2407 <listitem>
2408 <para>When true (the default), the hostname received from the DHCP server will be set as the
2409 transient hostname of the system.</para>
aefdc112
AK
2410
2411 <xi:include href="version-info.xml" xpointer="v211"/>
add469f5
YW
2412 </listitem>
2413 </varlistentry>
2414
2415 <varlistentry>
2416 <term><varname>UseDomains=</varname></term>
2417 <listitem>
15102ced
ZJS
2418 <para>Takes a boolean, or the special value <option>route</option>. When true, the domain name
2419 received from the DHCP server will be used as DNS search domain over this link, similarly to the
2420 effect of the <option>Domains=</option> setting. If set to <option>route</option>, the domain name
2421 received from the DHCP server will be used for routing DNS queries only, but not for searching,
2422 similarly to the effect of the <option>Domains=</option> setting when the argument is prefixed with
2423 <literal>~</literal>. Defaults to false.</para>
add469f5
YW
2424
2425 <para>It is recommended to enable this option only on trusted networks, as setting this
2426 affects resolution of all hostnames, in particular of single-label names. It is generally
2427 safer to use the supplied domain only as routing domain, rather than as search domain, in
2428 order to not have it affect local resolution of single-label names.</para>
2429
2430 <para>When set to true, this setting corresponds to the <option>domain</option> option in
2431 <citerefentry project='man-pages'><refentrytitle>resolv.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
2432 </para>
aefdc112
AK
2433
2434 <xi:include href="version-info.xml" xpointer="v216"/>
add469f5
YW
2435 </listitem>
2436 </varlistentry>
2437
2438 <varlistentry>
2439 <term><varname>UseRoutes=</varname></term>
2440 <listitem>
2441 <para>When true (the default), the static routes will be requested from the DHCP server and
2442 added to the routing table with a metric of 1024, and a scope of <option>global</option>,
2443 <option>link</option> or <option>host</option>, depending on the route's destination and
2444 gateway. If the destination is on the local host, e.g., 127.x.x.x, or the same as the link's
2445 own address, the scope will be set to <option>host</option>. Otherwise if the gateway is null
2446 (a direct route), a <option>link</option> scope will be used. For anything else, scope
2447 defaults to <option>global</option>.</para>
aefdc112
AK
2448
2449 <xi:include href="version-info.xml" xpointer="v215"/>
add469f5
YW
2450 </listitem>
2451 </varlistentry>
2452
2453 <varlistentry>
2454 <term><varname>RouteMetric=</varname></term>
2455 <listitem>
2456 <para>Set the routing metric for routes specified by the DHCP server (including the prefix
2457 route added for the specified prefix). Takes an unsigned integer in the range 0…4294967295.
2458 Defaults to 1024.</para>
aefdc112
AK
2459
2460 <xi:include href="version-info.xml" xpointer="v217"/>
add469f5
YW
2461 </listitem>
2462 </varlistentry>
2463
2464 <varlistentry>
2465 <term><varname>RouteTable=<replaceable>num</replaceable></varname></term>
2466 <listitem>
7db98bc9
YW
2467 <para>The table identifier for DHCP routes. Takes one of predefined names
2468 <literal>default</literal>, <literal>main</literal>, and <literal>local</literal>, and names
2469 defined in <varname>RouteTable=</varname> in
2470 <citerefentry><refentrytitle>networkd.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
2471 or a number between 1…4294967295.</para>
add469f5
YW
2472
2473 <para>When used in combination with <varname>VRF=</varname>, the VRF's routing table is
2474 used when this parameter is not specified.</para>
aefdc112
AK
2475
2476 <xi:include href="version-info.xml" xpointer="v232"/>
add469f5
YW
2477 </listitem>
2478 </varlistentry>
2479
2480 <varlistentry>
2481 <term><varname>RouteMTUBytes=</varname></term>
2482 <listitem>
2483 <para>Specifies the MTU for the DHCP routes. Please see the [Route] section for further
2484 details.</para>
ec07c3c8
AK
2485
2486 <xi:include href="version-info.xml" xpointer="v245"/>
add469f5
YW
2487 </listitem>
2488 </varlistentry>
2489
f95fb199
YW
2490 <varlistentry>
2491 <term><varname>QuickAck=</varname></term>
2492 <listitem>
2493 <para>Takes a boolean. When true, the TCP quick ACK mode is enabled for the routes configured by
2494 the acquired DHCPv4 lease. When unset, the kernel's default will be used.</para>
ec07c3c8
AK
2495
2496 <xi:include href="version-info.xml" xpointer="v253"/>
f95fb199
YW
2497 </listitem>
2498 </varlistentry>
2499
cb35a0d4
SS
2500 <varlistentry>
2501 <term><varname>InitialCongestionWindow=</varname></term>
2502 <listitem>
2503 <para>As in the [Route] section.</para>
ec07c3c8
AK
2504
2505 <xi:include href="version-info.xml" xpointer="v255"/>
cb35a0d4
SS
2506 </listitem>
2507 </varlistentry>
2508
2509 <varlistentry>
2510 <term><varname>InitialAdvertisedReceiveWindow=</varname></term>
2511 <listitem>
2512 <para>As in the [Route] section.</para>
ec07c3c8
AK
2513
2514 <xi:include href="version-info.xml" xpointer="v255"/>
cb35a0d4
SS
2515 </listitem>
2516 </varlistentry>
2517
add469f5
YW
2518 <varlistentry>
2519 <term><varname>UseGateway=</varname></term>
2520 <listitem>
2521 <para>When true, the gateway will be requested from the DHCP server and added to the routing
2522 table with a metric of 1024, and a scope of <option>link</option>. When unset, the value
2523 specified with <varname>UseRoutes=</varname> is used.</para>
ec07c3c8
AK
2524
2525 <xi:include href="version-info.xml" xpointer="v246"/>
add469f5
YW
2526 </listitem>
2527 </varlistentry>
2528
2529 <varlistentry>
2530 <term><varname>UseTimezone=</varname></term>
2531 <listitem><para>When true, the timezone received from the DHCP server will be set as timezone
aefdc112
AK
2532 of the local system. Defaults to false.</para>
2533
2534 <xi:include href="version-info.xml" xpointer="v226"/></listitem>
add469f5
YW
2535 </varlistentry>
2536
2537 <varlistentry>
2538 <term><varname>Use6RD=</varname></term>
2539 <listitem>
2540 <para>When true, subnets of the received IPv6 prefix are assigned to downstream interfaces
2541 which enables <varname>DHCPPrefixDelegation=</varname>. See also
2542 <varname>DHCPPrefixDelegation=</varname> in the [Network] section, the [DHCPPrefixDelegation]
2543 section, and <ulink url="https://tools.ietf.org/html/rfc5969">RFC 5969</ulink>. Defaults to
2544 false.</para>
ec07c3c8
AK
2545
2546 <xi:include href="version-info.xml" xpointer="v250"/>
add469f5
YW
2547 </listitem>
2548 </varlistentry>
2549
2550 <varlistentry>
2551 <term><varname>FallbackLeaseLifetimeSec=</varname></term>
2552 <listitem>
6eed65d4 2553 <para>Allows one to set DHCPv4 lease lifetime when DHCPv4 server does not send the lease
add469f5
YW
2554 lifetime. Takes one of <literal>forever</literal> or <literal>infinity</literal>. If
2555 specified, the acquired address never expires. Defaults to unset.</para>
ec07c3c8
AK
2556
2557 <xi:include href="version-info.xml" xpointer="v246"/>
add469f5
YW
2558 </listitem>
2559 </varlistentry>
2560
2561 <!-- How to communicate with the server -->
2562
2563 <varlistentry>
2564 <term><varname>RequestBroadcast=</varname></term>
2565 <listitem>
2566 <para>Request the server to use broadcast messages before the IP address has been configured.
2567 This is necessary for devices that cannot receive RAW packets, or that cannot receive packets
2568 at all before an IP address has been configured. On the other hand, this must not be enabled
2569 on networks where broadcasts are filtered out.</para>
aefdc112
AK
2570
2571 <xi:include href="version-info.xml" xpointer="v216"/>
add469f5
YW
2572 </listitem>
2573 </varlistentry>
2574
2575 <varlistentry>
2576 <term><varname>MaxAttempts=</varname></term>
2577 <listitem>
2578 <para>Specifies how many times the DHCPv4 client configuration should be attempted. Takes a
2579 number or <literal>infinity</literal>. Defaults to <literal>infinity</literal>. Note that the
2580 time between retries is increased exponentially, up to approximately one per minute, so the
2581 network will not be overloaded even if this number is high. The default is suitable in most
2582 circumstances.</para>
ec07c3c8
AK
2583
2584 <xi:include href="version-info.xml" xpointer="v243"/>
add469f5
YW
2585 </listitem>
2586 </varlistentry>
2587
2588 <varlistentry>
2589 <term><varname>ListenPort=</varname></term>
2590 <listitem>
2591 <para>Set the port from which the DHCP client packets originate.</para>
aefdc112
AK
2592
2593 <xi:include href="version-info.xml" xpointer="v233"/>
add469f5
YW
2594 </listitem>
2595 </varlistentry>
2596
2597 <varlistentry>
2598 <term><varname>DenyList=</varname></term>
2599 <listitem>
2600 <para>A whitespace-separated list of IPv4 addresses. Each address can optionally take a
2601 prefix length after <literal>/</literal>. DHCP offers from servers in the list are rejected.
2602 Note that if <varname>AllowList=</varname> is configured then <varname>DenyList=</varname> is
2603 ignored.</para>
ec07c3c8
AK
2604
2605 <xi:include href="version-info.xml" xpointer="v246"/>
add469f5
YW
2606 </listitem>
2607 </varlistentry>
2608
2609 <varlistentry>
2610 <term><varname>AllowList=</varname></term>
2611 <listitem>
2612 <para>A whitespace-separated list of IPv4 addresses. Each address can optionally take a
2613 prefix length after <literal>/</literal>. DHCP offers from servers in the list are accepted.
2614 </para>
ec07c3c8
AK
2615
2616 <xi:include href="version-info.xml" xpointer="v246"/>
add469f5
YW
2617 </listitem>
2618 </varlistentry>
2619
2620 <varlistentry>
2621 <term><varname>SendRelease=</varname></term>
2622 <listitem>
2623 <para>When true, the DHCPv4 client sends a DHCP release packet when it stops. Defaults to
2624 true.</para>
ec07c3c8
AK
2625
2626 <xi:include href="version-info.xml" xpointer="v243"/>
add469f5
YW
2627 </listitem>
2628 </varlistentry>
2629
2630 <varlistentry>
2631 <term><varname>SendDecline=</varname></term>
2632 <listitem>
2633 <para>A boolean. When true, <command>systemd-networkd</command> performs IPv4 Duplicate
2634 Address Detection to the acquired address by the DHCPv4 client. If duplicate is detected,
2635 the DHCPv4 client rejects the address by sending a <constant>DHCPDECLINE</constant> packet to
2636 the DHCP server, and tries to obtain an IP address again. See
2637 <ulink url="https://tools.ietf.org/html/rfc5227">RFC 5227</ulink>. Defaults to false.</para>
ec07c3c8
AK
2638
2639 <xi:include href="version-info.xml" xpointer="v245"/>
add469f5
YW
2640 </listitem>
2641 </varlistentry>
4b3590c3
TM
2642
2643 <varlistentry>
2644 <term><varname>NetLabel=</varname></term>
2645 <listitem>
2646 <para>This applies the NetLabel for the addresses received with DHCP, like
2647 <varname>NetLabel=</varname> in [Address] section applies it to statically configured
2648 addresses. See <varname>NetLabel=</varname> in [Address] section for more details.</para>
ec07c3c8
AK
2649
2650 <xi:include href="version-info.xml" xpointer="v252"/>
4b3590c3
TM
2651 </listitem>
2652 </varlistentry>
fc289dd0
TM
2653
2654 <varlistentry>
2655 <term><varname>NFTSet=</varname></term>
2656 <listitem>
2657 <para>This applies the NFT set for the network configuration received with DHCP, like
2658 <varname>NFTSet=</varname> in [Address] section applies it to static configuration. See
2659 <varname>NFTSet=</varname> in [Address] section for more details. For <literal>address</literal> or
2660 <literal>prefix</literal> source types, the type of the element used in the NFT filter must be
2661 <literal>ipv4_addr</literal>.</para>
c97f268f
YW
2662
2663 <xi:include href="version-info.xml" xpointer="v255"/>
fc289dd0
TM
2664 </listitem>
2665 </varlistentry>
add469f5
YW
2666 </variablelist>
2667 </refsect1>
2668
2669 <refsect1>
2670 <title>[DHCPv6] Section Options</title>
2671
2672 <para>The [DHCPv6] section configures the DHCPv6 client, if it is enabled with the
2673 <varname>DHCP=</varname> setting described above, or invoked by the IPv6 Router Advertisement:
2674 </para>
2675
2676 <variablelist class='network-directives'>
2677
2678 <!-- DHCP packet contents -->
2679
2680 <varlistentry>
2681 <term><varname>MUDURL=</varname></term>
2682 <term><varname>IAID=</varname></term>
2683 <term><varname>DUIDType=</varname></term>
2684 <term><varname>DUIDRawData=</varname></term>
2685 <term><varname>RequestOptions=</varname></term>
2686 <listitem>
2687 <para>As in the [DHCPv4] section.</para>
aefdc112
AK
2688
2689 <xi:include href="version-info.xml" xpointer="v246"/>
add469f5
YW
2690 </listitem>
2691 </varlistentry>
2692
2693 <varlistentry>
2694 <term><varname>SendOption=</varname></term>
2695 <listitem>
2696 <para>As in the [DHCPv4] section, however because DHCPv6 uses 16-bit fields to store option
2697 numbers, the option number is an integer in the range 1…65536.</para>
ec07c3c8
AK
2698
2699 <xi:include href="version-info.xml" xpointer="v246"/>
add469f5
YW
2700 </listitem>
2701 </varlistentry>
2702
2703 <varlistentry>
2704 <term><varname>SendVendorOption=</varname></term>
2705 <listitem>
2706 <para>Send an arbitrary vendor option in the DHCPv6 request. Takes an enterprise identifier,
2707 DHCP option number, data type, and data separated with a colon
2708 (<literal><replaceable>enterprise identifier</replaceable>:<replaceable>option</replaceable>:<replaceable>type</replaceable>:<replaceable>value</replaceable></literal>).
2709 Enterprise identifier is an unsigned integer in the range 1…4294967294. The option number
2710 must be an integer in the range 1…254. Data type takes one of <literal>uint8</literal>,
2711 <literal>uint16</literal>, <literal>uint32</literal>, <literal>ipv4address</literal>,
2712 <literal>ipv6address</literal>, or <literal>string</literal>. Special characters in the data
2713 string may be escaped using
2714 <ulink url="https://en.wikipedia.org/wiki/Escape_sequences_in_C#Table_of_escape_sequences">C-style
2715 escapes</ulink>. This setting can be specified multiple times. If an empty string is
2716 specified, then all options specified earlier are cleared. Defaults to unset.</para>
ec07c3c8
AK
2717
2718 <xi:include href="version-info.xml" xpointer="v246"/>
add469f5
YW
2719 </listitem>
2720 </varlistentry>
2721
2722 <varlistentry>
2723 <term><varname>UserClass=</varname></term>
2724 <listitem>
2725 <para>A DHCPv6 client can use User Class option to identify the type or category of user or
2726 applications it represents. The information contained in this option is a string that
2727 represents the user class of which the client is a member. Each class sets an identifying
2728 string of information to be used by the DHCP service to classify clients. Special characters
2729 in the data string may be escaped using
2730 <ulink url="https://en.wikipedia.org/wiki/Escape_sequences_in_C#Table_of_escape_sequences">C-style
2731 escapes</ulink>. This setting can be specified multiple times. If an empty string is
2732 specified, then all options specified earlier are cleared. Takes a whitespace-separated list
2733 of strings. Note that currently <constant>NUL</constant> bytes are not allowed.</para>
ec07c3c8
AK
2734
2735 <xi:include href="version-info.xml" xpointer="v246"/>
add469f5
YW
2736 </listitem>
2737 </varlistentry>
2738
2739 <varlistentry>
2740 <term><varname>VendorClass=</varname></term>
2741 <listitem>
2742 <para>A DHCPv6 client can use VendorClass option to identify the vendor that manufactured the
2743 hardware on which the client is running. The information contained in the data area of this
2744 option is contained in one or more opaque fields that identify details of the hardware
2745 configuration. Takes a whitespace-separated list of strings.</para>
ec07c3c8
AK
2746
2747 <xi:include href="version-info.xml" xpointer="v246"/>
add469f5
YW
2748 </listitem>
2749 </varlistentry>
2750
2751 <varlistentry>
2752 <term><varname>PrefixDelegationHint=</varname></term>
2753 <listitem>
2754 <para>Takes an IPv6 address with prefix length in the same format as the
2755 <varname>Address=</varname> in the [Network] section. The DHCPv6 client will include a prefix
2756 hint in the DHCPv6 solicitation sent to the server. The prefix length must be in the range
2757 1…128. Defaults to unset.</para>
ec07c3c8
AK
2758
2759 <xi:include href="version-info.xml" xpointer="v244"/>
add469f5
YW
2760 </listitem>
2761 </varlistentry>
2762
50ee1fec
YW
2763 <varlistentry>
2764 <term><varname>RapidCommit=</varname></term>
2765 <listitem>
2766 <para>Takes a boolean. The DHCPv6 client can obtain configuration parameters from a DHCPv6 server
2767 through a rapid two-message exchange (solicit and reply). When the rapid commit option is set by
2768 both the DHCPv6 client and the DHCPv6 server, the two-message exchange is used. Otherwise, the
2769 four-message exchange (solicit, advertise, request, and reply) is used. The two-message exchange
2770 provides faster client configuration. See
2771 <ulink url="https://tools.ietf.org/html/rfc3315#section-17.2.1">RFC 3315</ulink> for details.
2772 Defaults to true, and the two-message exchange will be used if the server support it.</para>
ec07c3c8
AK
2773
2774 <xi:include href="version-info.xml" xpointer="v252"/>
50ee1fec
YW
2775 </listitem>
2776 </varlistentry>
2777
add469f5
YW
2778 <!-- How to use the DHCP lease -->
2779
2780 <varlistentry>
2781 <term><varname>UseAddress=</varname></term>
2782 <listitem>
2783 <para>When true (the default), the IP addresses provided by the DHCPv6 server will be
2784 assigned.</para>
ec07c3c8
AK
2785
2786 <xi:include href="version-info.xml" xpointer="v248"/>
add469f5
YW
2787 </listitem>
2788 </varlistentry>
2789
a75feb55
RP
2790 <varlistentry>
2791 <term><varname>UseCaptivePortal=</varname></term>
2792 <listitem>
2793 <para>When true (the default), the captive portal advertised by the DHCPv6 server will be recorded
2794 and made available to client programs and displayed in the networkctl status output per-link.</para>
ec07c3c8
AK
2795
2796 <xi:include href="version-info.xml" xpointer="v254"/>
a75feb55
RP
2797 </listitem>
2798 </varlistentry>
2799
add469f5
YW
2800 <varlistentry>
2801 <term><varname>UseDelegatedPrefix=</varname></term>
2802 <listitem>
2803 <para>When true (the default), the client will request the DHCPv6 server to delegate
2804 prefixes. If the server provides prefixes to be delegated, then subnets of the prefixes are
625d71b9 2805 assigned to the interfaces that have <varname>DHCPPrefixDelegation=yes</varname>.
add469f5
YW
2806 See also the <varname>DHCPPrefixDelegation=</varname> setting in the [Network] section,
2807 settings in the [DHCPPrefixDelegation] section, and
2808 <ulink url="https://www.rfc-editor.org/rfc/rfc8415.html#section-6.3">RFC 8415</ulink>.
2809 </para>
ec07c3c8
AK
2810
2811 <xi:include href="version-info.xml" xpointer="v250"/>
add469f5
YW
2812 </listitem>
2813 </varlistentry>
2814
2815 <varlistentry>
2816 <term><varname>UseDNS=</varname></term>
2817 <term><varname>UseNTP=</varname></term>
2818 <term><varname>UseHostname=</varname></term>
2819 <term><varname>UseDomains=</varname></term>
4b3590c3 2820 <term><varname>NetLabel=</varname></term>
b895aa5f 2821 <term><varname>SendRelease=</varname></term>
add469f5
YW
2822 <listitem>
2823 <para>As in the [DHCPv4] section.</para>
aefdc112
AK
2824
2825 <xi:include href="version-info.xml" xpointer="v243"/>
add469f5
YW
2826 </listitem>
2827 </varlistentry>
2828
fc289dd0
TM
2829 <varlistentry>
2830 <term><varname>NFTSet=</varname></term>
2831 <listitem>
2832 <para>This applies the NFT set for the network configuration received with DHCP, like
2833 <varname>NFTSet=</varname> in [Address] section applies it to static configuration. See
2834 <varname>NFTSet=</varname> in [Address] section for more details. For <literal>address</literal>
2835 or <literal>prefix</literal> source types, the type of the element used in the NFT filter must be
2836 <literal>ipv6_addr</literal>.</para>
c97f268f
YW
2837
2838 <xi:include href="version-info.xml" xpointer="v255"/>
fc289dd0
TM
2839 </listitem>
2840 </varlistentry>
2841
add469f5
YW
2842 <!-- How to communicate with the server -->
2843
2844 <varlistentry>
2845 <term><varname>WithoutRA=</varname></term>
2846 <listitem>
0bcc6557
AH
2847 <para>Allows DHCPv6 client to start without router advertisements's
2848 <literal>managed</literal> or <literal>other configuration</literal> flag. Takes one of
2849 <literal>no</literal>, <literal>solicit</literal>, or
2850 <literal>information-request</literal>. If this is not specified,
add469f5
YW
2851 <literal>solicit</literal> is used when <varname>DHCPPrefixDelegation=</varname> is enabled
2852 and <varname>UplinkInterface=:self</varname> is specified in the [DHCPPrefixDelegation]
2853 section. Otherwise, defaults to <literal>no</literal>, and the DHCPv6 client will be started
2854 when an RA is received. See also the <varname>DHCPv6Client=</varname> setting in the
2855 [IPv6AcceptRA] section.</para>
ec07c3c8
AK
2856
2857 <xi:include href="version-info.xml" xpointer="v246"/>
add469f5
YW
2858 </listitem>
2859 </varlistentry>
2860 </variablelist>
caa8ca42 2861 </refsect1>
99e015e2
YW
2862
2863 <refsect1>
a27588d4 2864 <title>[DHCPPrefixDelegation] Section Options</title>
31fc1366 2865 <para>The [DHCPPrefixDelegation] section configures subnet prefixes of the delegated prefixes
8b9f0921 2866 acquired by a DHCPv6 client or by a DHCPv4 client through the 6RD option on another interface.
31fc1366
YW
2867 The settings in this section are used only when the <varname>DHCPPrefixDelegation=</varname>
2868 setting in the [Network] section is enabled.</para>
99e015e2
YW
2869
2870 <variablelist class='network-directives'>
dc5cae6c
YW
2871 <varlistentry>
2872 <term><varname>UplinkInterface=</varname></term>
2873 <listitem>
2874 <para>Specifies the name or the index of the uplink interface, or one of the special values
2875 <literal>:self</literal> and <literal>:auto</literal>. When <literal>:self</literal>, the
149cda85
YW
2876 interface itself is considered the uplink interface, and
2877 <varname>WithoutRA=solicit</varname> is implied if the setting is not explicitly specified.
2878 When <literal>:auto</literal>, the first link which acquired prefixes to be delegated from
31fc1366 2879 the DHCPv6 or DHCPv4 server is selected. Defaults to <literal>:auto</literal>.</para>
ec07c3c8
AK
2880
2881 <xi:include href="version-info.xml" xpointer="v250"/>
dc5cae6c
YW
2882 </listitem>
2883 </varlistentry>
2884
99e015e2
YW
2885 <varlistentry>
2886 <term><varname>SubnetId=</varname></term>
2887 <listitem>
2888 <para>Configure a specific subnet ID on the interface from a (previously) received prefix
2889 delegation. You can either set "auto" (the default) or a specific subnet ID (as defined in
2890 <ulink url="https://tools.ietf.org/html/rfc4291#section-2.5.4">RFC 4291</ulink>, section
2891 2.5.4), in which case the allowed value is hexadecimal, from 0 to 0x7fffffffffffffff
e5ff2245 2892 inclusive.</para>
aefdc112
AK
2893
2894 <xi:include href="version-info.xml" xpointer="v246"/>
e5ff2245
YW
2895 </listitem>
2896 </varlistentry>
2897
2898 <varlistentry>
2899 <term><varname>Announce=</varname></term>
2900 <listitem>
2901 <para>Takes a boolean. When enabled, and <varname>IPv6SendRA=</varname> in [Network] section
2902 is enabled, the delegated prefixes are distributed through the IPv6 Router Advertisement.
31fc1366
YW
2903 This setting will be ignored when the <varname>DHCPPrefixDelegation=</varname> setting is
2904 enabled on the upstream interface. Defaults to yes.</para>
aefdc112
AK
2905
2906 <xi:include href="version-info.xml" xpointer="v247"/>
99e015e2
YW
2907 </listitem>
2908 </varlistentry>
2909
2910 <varlistentry>
2911 <term><varname>Assign=</varname></term>
2912 <listitem>
2913 <para>Takes a boolean. Specifies whether to add an address from the delegated prefixes which
e5ff2245 2914 are received from the WAN interface by the DHCPv6 Prefix Delegation. When true (on LAN
6c2d70ce 2915 interface), the EUI-64 algorithm will be used by default to form an interface identifier from
e5ff2245
YW
2916 the delegated prefixes. See also <varname>Token=</varname> setting below. Defaults to yes.
2917 </para>
aefdc112
AK
2918
2919 <xi:include href="version-info.xml" xpointer="v246"/>
99e015e2
YW
2920 </listitem>
2921 </varlistentry>
2922
2923 <varlistentry>
2924 <term><varname>Token=</varname></term>
2925 <listitem>
e5ff2245 2926 <para>Specifies an optional address generation mode for assigning an address in each
f5960e0a
YW
2927 delegated prefix. This accepts the same syntax as <varname>Token=</varname> in the
2928 [IPv6AcceptRA] section. If <varname>Assign=</varname> is set to false, then this setting will
2929 be ignored. Defaults to unset, which means the EUI-64 algorithm will be used.</para>
aefdc112
AK
2930
2931 <xi:include href="version-info.xml" xpointer="v246"/>
99e015e2
YW
2932 </listitem>
2933 </varlistentry>
fec1b650
YW
2934
2935 <varlistentry>
2936 <term><varname>ManageTemporaryAddress=</varname></term>
2937 <listitem>
2938 <para>As in the [Address] section, but defaults to true.</para>
aefdc112
AK
2939
2940 <xi:include href="version-info.xml" xpointer="v248"/>
fec1b650
YW
2941 </listitem>
2942 </varlistentry>
9fe0b7b4
YW
2943
2944 <varlistentry>
2945 <term><varname>RouteMetric=</varname></term>
2946 <listitem>
2947 <para>The metric of the route to the delegated prefix subnet. Takes an unsigned integer in
d0619f2c
YW
2948 the range 0…4294967295. When set to 0, the kernel's default value is used. Defaults to 256.
2949 </para>
aefdc112
AK
2950
2951 <xi:include href="version-info.xml" xpointer="v249"/>
9fe0b7b4
YW
2952 </listitem>
2953 </varlistentry>
4b3590c3
TM
2954
2955 <varlistentry>
2956 <term><varname>NetLabel=</varname></term>
2957 <listitem>
2958 <para>This applies the NetLabel for the addresses received with DHCP, like
2959 <varname>NetLabel=</varname> in [Address] section applies it to statically configured
2960 addresses. See <varname>NetLabel=</varname> in [Address] section for more details.</para>
ec07c3c8
AK
2961
2962 <xi:include href="version-info.xml" xpointer="v252"/>
4b3590c3
TM
2963 </listitem>
2964 </varlistentry>
fc289dd0
TM
2965
2966 <varlistentry>
2967 <term><varname>NFTSet=</varname></term>
2968 <listitem>
2969 <para>This applies the NFT set for the network configuration received with DHCP, like
2970 <varname>NFTSet=</varname> in [Address] section applies it to static configuration. See
2971 <varname>NFTSet=</varname> in [Address] section for more details. For <literal>address</literal> or
2972 <literal>prefix</literal> source types, the type of the element used in the NFT filter must be
2973 <literal>ipv6_addr</literal>.</para>
c97f268f
YW
2974
2975 <xi:include href="version-info.xml" xpointer="v255"/>
fc289dd0
TM
2976 </listitem>
2977 </varlistentry>
99e015e2
YW
2978 </variablelist>
2979 </refsect1>
413708d1 2980
1e7a0e21 2981 <refsect1>
f921f573 2982 <title>[IPv6AcceptRA] Section Options</title>
c463ae74
YW
2983 <para>The [IPv6AcceptRA] section configures the IPv6 Router Advertisement (RA) client, if it is enabled
2984 with the <varname>IPv6AcceptRA=</varname> setting described above:</para>
1e7a0e21 2985
c463ae74
YW
2986 <variablelist class='network-directives'>
2987 <varlistentry>
2988 <term><varname>Token=</varname></term>
2989 <listitem>
2990 <para>Specifies an optional address generation mode for the Stateless Address
2991 Autoconfiguration (SLAAC). The following values are supported:</para>
2992
2993 <variablelist>
2994 <varlistentry>
2995 <term><option>eui64</option></term>
2996 <listitem>
2997 <para>
ab106a60
YW
2998 The EUI-64 algorithm will be used to generate an address for that prefix. Only
2999 supported by Ethernet or InfiniBand interfaces.
c463ae74 3000 </para>
ec07c3c8
AK
3001
3002 <xi:include href="version-info.xml" xpointer="v250"/>
c463ae74
YW
3003 </listitem>
3004 </varlistentry>
3005 <varlistentry>
3006 <term><option>static:<replaceable>ADDRESS</replaceable></option></term>
3007 <listitem>
3008 <para>
3009 An IPv6 address must be specified after a colon (<literal>:</literal>), and the
3010 lower bits of the supplied address are combined with the upper bits of a prefix
3011 received in a Router Advertisement (RA) message to form a complete address. Note
3012 that if multiple prefixes are received in an RA message, or in multiple RA messages,
3013 addresses will be formed from each of them using the supplied address. This mode
3014 implements SLAAC but uses a static interface identifier instead of an identifier
3015 generated by using the EUI-64 algorithm. Because the interface identifier is static,
3016 if Duplicate Address Detection detects that the computed address is a duplicate
3017 (in use by another node on the link), then this mode will fail to provide an address
3018 for that prefix. If an IPv6 address without mode is specified, then
3019 <literal>static</literal> mode is assumed.
3020 </para>
ec07c3c8
AK
3021
3022 <xi:include href="version-info.xml" xpointer="v250"/>
c463ae74
YW
3023 </listitem>
3024 </varlistentry>
3025 <varlistentry>
f2a3a133 3026 <term><option>prefixstable[:<replaceable>ADDRESS</replaceable>][,<replaceable>UUID</replaceable>]</option></term>
c463ae74
YW
3027 <listitem>
3028 <para>
3029 The algorithm specified in
3030 <ulink url="https://tools.ietf.org/html/rfc7217">RFC 7217</ulink> will be used to
3031 generate interface identifiers. This mode can optionally take an IPv6 address
3032 separated with a colon (<literal>:</literal>). If an IPv6 address is specified,
3033 then an interface identifier is generated only when a prefix received in an RA
3034 message matches the supplied address.
3035 </para>
f2a3a133
YW
3036 <para>
3037 This mode can also optionally take a non-null UUID in the format which
3038 <function>sd_id128_from_string()</function> accepts, e.g.
3039 <literal>86b123b969ba4b7eb8b3d8605123525a</literal> or
3040 <literal>86b123b9-69ba-4b7e-b8b3-d8605123525a</literal>. If a UUID is specified, the
3041 value is used as the secret key to generate interface identifiers. If not specified,
3042 then an application specific ID generated with the system's machine-ID will be used
3043 as the secret key. See
3044 <citerefentry><refentrytitle>sd-id128</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
3045 <citerefentry><refentrytitle>sd_id128_from_string</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
3046 and
fe003f02 3047 <citerefentry><refentrytitle>sd_id128_get_machine</refentrytitle><manvolnum>3</manvolnum></citerefentry>.
f2a3a133 3048 </para>
c463ae74
YW
3049 <para>
3050 Note that the <literal>prefixstable</literal> algorithm uses both the interface
3051 name and MAC address as input to the hash to compute the interface identifier, so
3052 if either of those are changed the resulting interface identifier (and address)
3053 will be changed, even if the prefix received in the RA message has not been
3054 changed.
3055 </para>
ec07c3c8
AK
3056
3057 <xi:include href="version-info.xml" xpointer="v250"/>
c463ae74
YW
3058 </listitem>
3059 </varlistentry>
3060 </variablelist>
3061
3062 <para>If no address generation mode is specified (which is the default), or a received
3063 prefix does not match any of the addresses provided in <literal>prefixstable</literal>
ab106a60
YW
3064 mode, then the EUI-64 algorithm will be used for Ethernet or InfiniBand interfaces,
3065 otherwise <literal>prefixstable</literal> will be used to form an interface identifier for
3066 that prefix.</para>
c463ae74
YW
3067
3068 <para>This setting can be specified multiple times. If an empty string is assigned, then
3069 the all previous assignments are cleared.</para>
3070
3071 <para>Examples:
3072 <programlisting>Token=eui64
140bf8da 3073Token=::1a:2b:3c:4d
a73628e6
YW
3074Token=static:::1a:2b:3c:4d
3075Token=prefixstable
3076Token=prefixstable:2002:da8:1::</programlisting></para>
ec07c3c8
AK
3077
3078 <xi:include href="version-info.xml" xpointer="v250"/>
c463ae74
YW
3079 </listitem>
3080 </varlistentry>
1e7a0e21 3081
c463ae74
YW
3082 <varlistentry>
3083 <term><varname>UseDNS=</varname></term>
3084 <listitem>
3085 <para>When true (the default), the DNS servers received in the Router Advertisement will be used.</para>
1e7a0e21 3086
c463ae74
YW
3087 <para>This corresponds to the <option>nameserver</option> option in <citerefentry
3088 project='man-pages'><refentrytitle>resolv.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para>
aefdc112
AK
3089
3090 <xi:include href="version-info.xml" xpointer="v231"/>
c463ae74
YW
3091 </listitem>
3092 </varlistentry>
1e7a0e21 3093
c463ae74
YW
3094 <varlistentry>
3095 <term><varname>UseDomains=</varname></term>
3096 <listitem>
3097 <para>Takes a boolean, or the special value <literal>route</literal>. When true, the domain name
15102ced
ZJS
3098 received via IPv6 Router Advertisement (RA) will be used as DNS search domain over this link,
3099 similarly to the effect of the <option>Domains=</option> setting. If set to
3100 <literal>route</literal>, the domain name received via IPv6 RA will be used for routing DNS queries
3101 only, but not for searching, similarly to the effect of the <option>Domains=</option> setting when
3102 the argument is prefixed with <literal>~</literal>. Defaults to false.</para>
c463ae74
YW
3103
3104 <para>It is recommended to enable this option only on trusted networks, as setting this affects resolution
3105 of all hostnames, in particular of single-label names. It is generally safer to use the supplied domain
3106 only as routing domain, rather than as search domain, in order to not have it affect local resolution of
3107 single-label names.</para>
3108
3109 <para>When set to true, this setting corresponds to the <option>domain</option> option in <citerefentry
3110 project='man-pages'><refentrytitle>resolv.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para>
aefdc112
AK
3111
3112 <xi:include href="version-info.xml" xpointer="v231"/>
c463ae74
YW
3113 </listitem>
3114 </varlistentry>
2ba31d29 3115
c463ae74
YW
3116 <varlistentry>
3117 <term><varname>RouteTable=<replaceable>num</replaceable></varname></term>
3118 <listitem>
7db98bc9
YW
3119 <para>The table identifier for the routes received in the Router Advertisement. Takes one of
3120 predefined names <literal>default</literal>, <literal>main</literal>, and <literal>local</literal>,
3121 and names defined in <varname>RouteTable=</varname> in
3122 <citerefentry><refentrytitle>networkd.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
3123 or a number between 1…4294967295.</para>
3124
3125 <para>When used in combination with <varname>VRF=</varname>, the VRF's routing table is
3126 used when this parameter is not specified.</para>
ec07c3c8
AK
3127
3128 <xi:include href="version-info.xml" xpointer="v232"/>
c463ae74
YW
3129 </listitem>
3130 </varlistentry>
062c2eea 3131
c463ae74
YW
3132 <varlistentry>
3133 <term><varname>RouteMetric=</varname></term>
3134 <listitem>
6f812d28
YW
3135 <para>Set the routing metric for the routes received in the Router Advertisement. Takes an unsigned
3136 integer in the range 0…4294967295, or three unsigned integer separated with <literal>:</literal>,
3137 in that case the first one is used when the router preference is high, the second is for medium
3138 preference, and the last is for low preference
3139 (<literal><replaceable>high</replaceable>:<replaceable>medium</replaceable>:<replaceable>low</replaceable></literal>).
3140 Defaults to <literal>512:1024:2048</literal>.</para>
ec07c3c8
AK
3141
3142 <xi:include href="version-info.xml" xpointer="v249"/>
c463ae74
YW
3143 </listitem>
3144 </varlistentry>
8ebafba9 3145
f95fb199
YW
3146 <varlistentry>
3147 <term><varname>QuickAck=</varname></term>
3148 <listitem>
3149 <para>Takes a boolean. When true, the TCP quick ACK mode is enabled for the routes configured by
3150 the received RAs. When unset, the kernel's default will be used.</para>
ec07c3c8
AK
3151
3152 <xi:include href="version-info.xml" xpointer="v253"/>
f95fb199
YW
3153 </listitem>
3154 </varlistentry>
3155
c463ae74
YW
3156 <varlistentry>
3157 <term><varname>UseMTU=</varname></term>
3158 <listitem>
3159 <para>Takes a boolean. When true, the MTU received in the Router Advertisement will be
3160 used. Defaults to true.</para>
ec07c3c8
AK
3161
3162 <xi:include href="version-info.xml" xpointer="v250"/>
c463ae74
YW
3163 </listitem>
3164 </varlistentry>
7d93b92f 3165
f141b2c0
SS
3166 <varlistentry>
3167 <term><varname>UseHopLimit=</varname></term>
3168 <listitem>
3169 <para>Takes a boolean. When true, the hop limit received in the Router Advertisement will be set to routes
3170 configured based on the advertisement. See also <varname>IPv6HopLimit=</varname>. Defaults to true.</para>
ec07c3c8
AK
3171
3172 <xi:include href="version-info.xml" xpointer="v255"/>
f141b2c0
SS
3173 </listitem>
3174 </varlistentry>
3175
91750028
SS
3176 <varlistentry>
3177 <term><varname>UseICMP6RateLimit=</varname></term>
3178 <listitem>
3179 <para>Takes a boolean. When true, the ICMP6 rate limit received in the Router Advertisement will be set to ICMP6
3180 rate limit based on the advertisement. Defaults to true.</para>
ec07c3c8
AK
3181
3182 <xi:include href="version-info.xml" xpointer="v255"/>
91750028
SS
3183 </listitem>
3184 </varlistentry>
3185
c463ae74
YW
3186 <varlistentry>
3187 <term><varname>UseGateway=</varname></term>
3188 <listitem>
3189 <para>When true (the default), the router address will be configured as the default gateway.
3190 </para>
ec07c3c8
AK
3191
3192 <xi:include href="version-info.xml" xpointer="v250"/>
c463ae74
YW
3193 </listitem>
3194 </varlistentry>
610c0db1 3195
c463ae74
YW
3196 <varlistentry>
3197 <term><varname>UseRoutePrefix=</varname></term>
3198 <listitem>
3199 <para>When true (the default), the routes corresponding to the route prefixes received in
3200 the Router Advertisement will be configured.</para>
ec07c3c8
AK
3201
3202 <xi:include href="version-info.xml" xpointer="v250"/>
c463ae74
YW
3203 </listitem>
3204 </varlistentry>
610c0db1 3205
d74c4ce1
RP
3206 <varlistentry>
3207 <term><varname>UseCaptivePortal=</varname></term>
3208 <listitem>
3209 <para>When true (the default), the captive portal received in the Router Advertisement will be recorded
3210 and made available to client programs and displayed in the networkctl status output per-link.</para>
ec07c3c8
AK
3211
3212 <xi:include href="version-info.xml" xpointer="v254"/>
d74c4ce1
RP
3213 </listitem>
3214 </varlistentry>
3215
6e8f5e4c
SS
3216 <varlistentry>
3217 <term><varname>UsePREF64=</varname></term>
3218 <listitem>
3219 <para>When true, the IPv6 PREF64 (or NAT64) prefixes received in the Router Advertisement will be recorded
3220 and made available to client programs and displayed in the <command>networkctl</command> status output per-link.
3221 See <ulink url="https://tools.ietf.org/html/rfc8781">RFC 8781</ulink>. Defaults to false.</para>
3222
3223 <xi:include href="version-info.xml" xpointer="v255"/>
3224 </listitem>
3225 </varlistentry>
3226
c463ae74
YW
3227 <varlistentry>
3228 <term><varname>UseAutonomousPrefix=</varname></term>
3229 <listitem>
3230 <para>When true (the default), the autonomous prefix received in the Router Advertisement will be used and take
3231 precedence over any statically configured ones.</para>
ec07c3c8
AK
3232
3233 <xi:include href="version-info.xml" xpointer="v242"/>
c463ae74
YW
3234 </listitem>
3235 </varlistentry>
062c2eea 3236
c463ae74
YW
3237 <varlistentry>
3238 <term><varname>UseOnLinkPrefix=</varname></term>
3239 <listitem>
3240 <para>When true (the default), the onlink prefix received in the Router Advertisement will be
3241 used and takes precedence over any statically configured ones.</para>
ec07c3c8
AK
3242
3243 <xi:include href="version-info.xml" xpointer="v242"/>
c463ae74
YW
3244 </listitem>
3245 </varlistentry>
062c2eea 3246
c463ae74
YW
3247 <varlistentry>
3248 <term><varname>RouterDenyList=</varname></term>
3249 <listitem>
3250 <para>A whitespace-separated list of IPv6 router addresses. Each address can optionally
3251 take a prefix length after <literal>/</literal>. Any information advertised by the listed
3252 router is ignored.</para>
ec07c3c8
AK
3253
3254 <xi:include href="version-info.xml" xpointer="v248"/>
c463ae74
YW
3255 </listitem>
3256 </varlistentry>
75d26411 3257
c463ae74
YW
3258 <varlistentry>
3259 <term><varname>RouterAllowList=</varname></term>
3260 <listitem>
3261 <para>A whitespace-separated list of IPv6 router addresses. Each address can optionally
3262 take a prefix length after <literal>/</literal>. Only information advertised by the listed
3263 router is accepted. Note that if <varname>RouterAllowList=</varname> is configured then
3264 <varname>RouterDenyList=</varname> is ignored.</para>
ec07c3c8
AK
3265
3266 <xi:include href="version-info.xml" xpointer="v248"/>
c463ae74
YW
3267 </listitem>
3268 </varlistentry>
75d26411 3269
c463ae74
YW
3270 <varlistentry>
3271 <term><varname>PrefixDenyList=</varname></term>
3272 <listitem>
3273 <para>A whitespace-separated list of IPv6 prefixes. Each prefix can optionally take its
3274 prefix length after <literal>/</literal>. IPv6 prefixes supplied via router advertisements
3275 in the list are ignored.</para>
ec07c3c8
AK
3276
3277 <xi:include href="version-info.xml" xpointer="v248"/>
c463ae74
YW
3278 </listitem>
3279 </varlistentry>
16c89e64 3280
c463ae74
YW
3281 <varlistentry>
3282 <term><varname>PrefixAllowList=</varname></term>
3283 <listitem>
3284 <para>A whitespace-separated list of IPv6 prefixes. Each prefix can optionally take its
3285 prefix length after <literal>/</literal>. IPv6 prefixes supplied via router advertisements
3286 in the list are allowed. Note that if <varname>PrefixAllowList=</varname> is configured
3287 then <varname>PrefixDenyList=</varname> is ignored.</para>
ec07c3c8
AK
3288
3289 <xi:include href="version-info.xml" xpointer="v248"/>
c463ae74
YW
3290 </listitem>
3291 </varlistentry>
de6b6ff8 3292
c463ae74
YW
3293 <varlistentry>
3294 <term><varname>RouteDenyList=</varname></term>
3295 <listitem>
3296 <para>A whitespace-separated list of IPv6 route prefixes. Each prefix can optionally take
3297 its prefix length after <literal>/</literal>. IPv6 route prefixes supplied via router
3298 advertisements in the list are ignored.</para>
ec07c3c8
AK
3299
3300 <xi:include href="version-info.xml" xpointer="v248"/>
c463ae74
YW
3301 </listitem>
3302 </varlistentry>
e520ce64 3303
c463ae74
YW
3304 <varlistentry>
3305 <term><varname>RouteAllowList=</varname></term>
3306 <listitem>
3307 <para>A whitespace-separated list of IPv6 route prefixes. Each prefix can optionally take
3308 its prefix length after <literal>/</literal>. IPv6 route prefixes supplied via router
3309 advertisements in the list are allowed. Note that if <varname>RouteAllowList=</varname> is
3310 configured then <varname>RouteDenyList=</varname> is ignored.</para>
ec07c3c8
AK
3311
3312 <xi:include href="version-info.xml" xpointer="v248"/>
c463ae74
YW
3313 </listitem>
3314 </varlistentry>
de6b6ff8 3315
c463ae74
YW
3316 <varlistentry>
3317 <term><varname>DHCPv6Client=</varname></term>
3318 <listitem>
3319 <para>Takes a boolean, or the special value <literal>always</literal>. When true, the
0bcc6557
AH
3320 DHCPv6 client will be started in <literal>solicit</literal> mode if the RA has the
3321 <literal>managed</literal> flag or <literal>information-request</literal> mode if the RA
3322 lacks the <literal>managed</literal> flag but has the
3323 <literal>other configuration</literal> flag. If set to <literal>always</literal>, the
3324 DHCPv6 client will be started in <literal>solicit</literal> mode when an RA is received,
3325 even if neither the <literal>managed</literal> nor the
3326 <literal>other configuration</literal> flag is set in the RA. This will be ignored when
3327 <varname>WithoutRA=</varname> in the [DHCPv6] section is enabled, or
a27588d4 3328 <varname>UplinkInterface=:self</varname> in the [DHCPPrefixDelegation] section is
c463ae74 3329 specified. Defaults to true.</para>
ec07c3c8
AK
3330
3331 <xi:include href="version-info.xml" xpointer="v246"/>
c463ae74
YW
3332 </listitem>
3333 </varlistentry>
4b3590c3
TM
3334
3335 <varlistentry>
3336 <term><varname>NetLabel=</varname></term>
3337 <listitem>
3338 <para>This applies the NetLabel for the addresses received with RA, like
3339 <varname>NetLabel=</varname> in [Address] section applies it to statically configured
3340 addresses. See <varname>NetLabel=</varname> in [Address] section for more details.</para>
ec07c3c8
AK
3341
3342 <xi:include href="version-info.xml" xpointer="v252"/>
4b3590c3
TM
3343 </listitem>
3344 </varlistentry>
fc289dd0
TM
3345
3346 <varlistentry>
3347 <term><varname>NFTSet=</varname></term>
3348 <listitem>
3349 <para>This applies the NFT set for the network configuration received with RA, like
3350 <varname>NFTSet=</varname> in [Address] section applies it to static configuration. See
3351 <varname>NFTSet=</varname> in [Address] section for more details. For <literal>address</literal> or
3352 <literal>prefix</literal> source types, the type of the element used in the NFT filter must be
3353 <literal>ipv6_addr</literal>.</para>
c97f268f
YW
3354
3355 <xi:include href="version-info.xml" xpointer="v255"/>
fc289dd0
TM
3356 </listitem>
3357 </varlistentry>
c463ae74 3358 </variablelist>
1e7a0e21
LP
3359 </refsect1>
3360
ad943783
LP
3361 <refsect1>
3362 <title>[DHCPServer] Section Options</title>
bdac5608 3363 <para>The [DHCPServer] section contains settings for the DHCP server, if enabled via the
ad943783
LP
3364 <varname>DHCPServer=</varname> option described above:</para>
3365
3366 <variablelist class='network-directives'>
3367
0017ba31
YW
3368 <varlistentry>
3369 <term><varname>ServerAddress=</varname></term>
e443a88a
YW
3370 <listitem>
3371 <para>Specifies the server address for the DHCP server. Takes an IPv4 address with prefix length
3372 separated with a slash, e.g. <literal>192.168.0.1/24</literal>. Defaults to unset, and one of
3373 static IPv4 addresses configured in [Network] or [Address] section will be automatically selected.
3374 This setting may be useful when the interface on which the DHCP server is running has multiple
3375 static IPv4 addresses.</para>
3376 <para>This implies <varname>Address=</varname> in [Network] or [Address] section with the same
3377 address and prefix length. That is,
3378 <programlisting>[Network]
3379DHCPServer=yes
3380Address=192.168.0.1/24
3381Address=192.168.0.2/24
3382[DHCPServer]
3383ServerAddress=192.168.0.1/24</programlisting>
3384 or
3385 <programlisting>[Network]
3386DHCPServer=yes
3387[Address]
3388Address=192.168.0.1/24
3389[Address]
3390Address=192.168.0.2/24
3391[DHCPServer]
3392ServerAddress=192.168.0.1/24</programlisting>
3393 are equivalent to the following.
3394 <programlisting>[Network]
3395DHCPServer=yes
3396Address=192.168.0.2/24
3397[DHCPServer]
3398ServerAddress=192.168.0.1/24</programlisting>
3399 </para>
3400 <para>Since version 255, like the <varname>Address=</varname> setting in [Network] or [Address]
3401 section, this also supports a null address, e.g. <literal>0.0.0.0/24</literal>, and an unused
3402 address will be automatically selected. For more details about the automatic address selection,
3403 see <varname>Address=</varname> setting in [Network] section in the above.</para>
ec07c3c8 3404
e443a88a
YW
3405 <xi:include href="version-info.xml" xpointer="v249"/>
3406 </listitem>
0017ba31
YW
3407 </varlistentry>
3408
9b3a67c5
TG
3409 <varlistentry>
3410 <term><varname>PoolOffset=</varname></term>
3411 <term><varname>PoolSize=</varname></term>
3412
3413 <listitem><para>Configures the pool of addresses to hand out. The pool
3414 is a contiguous sequence of IP addresses in the subnet configured for
3415 the server address, which does not include the subnet nor the broadcast
3416 address. <varname>PoolOffset=</varname> takes the offset of the pool
3417 from the start of subnet, or zero to use the default value.
3418 <varname>PoolSize=</varname> takes the number of IP addresses in the
b938cb90 3419 pool or zero to use the default value. By default, the pool starts at
9b3a67c5
TG
3420 the first address after the subnet address and takes up the rest of
3421 the subnet, excluding the broadcast address. If the pool includes
3422 the server address (the default), this is reserved and not handed
ec07c3c8
AK
3423 out to clients.</para>
3424
3425 <xi:include href="version-info.xml" xpointer="v226"/></listitem>
9b3a67c5
TG
3426 </varlistentry>
3427
ad943783
LP
3428 <varlistentry>
3429 <term><varname>DefaultLeaseTimeSec=</varname></term>
3430 <term><varname>MaxLeaseTimeSec=</varname></term>
3431
3432 <listitem><para>Control the default and maximum DHCP lease
3433 time to pass to clients. These settings take time values in seconds or
3434 another common time unit, depending on the suffix. The default
3435 lease time is used for clients that did not ask for a specific
3436 lease time. If a client asks for a lease time longer than the
b938cb90 3437 maximum lease time, it is automatically shortened to the
ad943783
LP
3438 specified time. The default lease time defaults to 1h, the
3439 maximum lease time to 12h. Shorter lease times are beneficial
3440 if the configuration data in DHCP leases changes frequently
3441 and clients shall learn the new settings with shorter
3442 latencies. Longer lease times reduce the generated DHCP
ec07c3c8
AK
3443 network traffic.</para>
3444
3445 <xi:include href="version-info.xml" xpointer="v226"/></listitem>
ad943783
LP
3446 </varlistentry>
3447
165d7c5c
YW
3448 <varlistentry>
3449 <term><varname>UplinkInterface=</varname></term>
2b242926
YW
3450 <listitem><para>Specifies the name or the index of the uplink interface, or one of the special
3451 values <literal>:none</literal> and <literal>:auto</literal>. When emitting DNS, NTP, or SIP
3452 servers is enabled but no servers are specified, the servers configured in the uplink interface
3453 will be emitted. When <literal>:auto</literal>, the link which has a default gateway with the
3454 highest priority will be automatically selected. When <literal>:none</literal>, no uplink
ec07c3c8
AK
3455 interface will be selected. Defaults to <literal>:auto</literal>.</para>
3456
3457 <xi:include href="version-info.xml" xpointer="v249"/></listitem>
165d7c5c
YW
3458 </varlistentry>
3459
ad943783
LP
3460 <varlistentry>
3461 <term><varname>EmitDNS=</varname></term>
3462 <term><varname>DNS=</varname></term>
3463
2a71d57f 3464 <listitem><para><varname>EmitDNS=</varname> takes a boolean. Configures whether the DHCP leases
5f468b9f
YW
3465 handed out to clients shall contain DNS server information. Defaults to <literal>yes</literal>.
3466 The DNS servers to pass to clients may be configured with the <varname>DNS=</varname> option,
3467 which takes a list of IPv4 addresses, or special value <literal>_server_address</literal> which
faa1b3c6
YW
3468 will be converted to the address used by the DHCP server.</para>
3469
3470 <para>If the <varname>EmitDNS=</varname> option is enabled but no servers configured, the
3471 servers are automatically propagated from an "uplink" interface that has appropriate servers
3472 set. The "uplink" interface is determined by the default route of the system with the highest
3473 priority. Note that this information is acquired at the time the lease is handed out, and does
3474 not take uplink interfaces into account that acquire DNS server information at a later point.
3475 If no suitable uplink interface is found the DNS server data from
3476 <filename>/etc/resolv.conf</filename> is used. Also, note that the leases are not refreshed if
3477 the uplink network configuration changes. To ensure clients regularly acquire the most current
3478 uplink DNS server information, it is thus advisable to shorten the DHCP lease time via
3479 <varname>MaxLeaseTimeSec=</varname> described above.</para>
3480
3481 <para>This setting can be specified multiple times. If an empty string is specified, then all
ec07c3c8
AK
3482 DNS servers specified earlier are cleared.</para>
3483
3484 <xi:include href="version-info.xml" xpointer="v226"/></listitem>
ad943783
LP
3485 </varlistentry>
3486
3487 <varlistentry>
3488 <term><varname>EmitNTP=</varname></term>
3489 <term><varname>NTP=</varname></term>
299d578f
SS
3490 <term><varname>EmitSIP=</varname></term>
3491 <term><varname>SIP=</varname></term>
2a71d57f
LP
3492 <term><varname>EmitPOP3=</varname></term>
3493 <term><varname>POP3=</varname></term>
3494 <term><varname>EmitSMTP=</varname></term>
3495 <term><varname>SMTP=</varname></term>
3496 <term><varname>EmitLPR=</varname></term>
3497 <term><varname>LPR=</varname></term>
3498
3499 <listitem><para>Similar to the <varname>EmitDNS=</varname> and <varname>DNS=</varname> settings
3500 described above, these settings configure whether and what server information for the indicate
3501 protocol shall be emitted as part of the DHCP lease. The same syntax, propagation semantics and
aefdc112
AK
3502 defaults apply as for <varname>EmitDNS=</varname> and <varname>DNS=</varname>.</para>
3503
3504 <xi:include href="version-info.xml" xpointer="v226"/></listitem>
284e8fd0
SS
3505 </varlistentry>
3506
77ff6022
CG
3507 <varlistentry>
3508 <term><varname>EmitRouter=</varname></term>
59aa6220
YW
3509 <term><varname>Router=</varname></term>
3510
3511 <listitem><para>The <varname>EmitRouter=</varname> setting takes a boolean value, and configures
3512 whether the DHCP lease should contain the router option. The <varname>Router=</varname> setting
3513 takes an IPv4 address, and configures the router address to be emitted. When the
3514 <varname>Router=</varname> setting is not specified, then the server address will be used for
3515 the router option. When the <varname>EmitRouter=</varname> setting is disabled, the
3516 <varname>Router=</varname> setting will be ignored. The <varname>EmitRouter=</varname> setting
3517 defaults to true, and the <varname>Router=</varname> setting defaults to unset.
aefdc112
AK
3518 </para>
3519
3520 <xi:include href="version-info.xml" xpointer="v230"/></listitem>
77ff6022
CG
3521 </varlistentry>
3522
ad943783
LP
3523 <varlistentry>
3524 <term><varname>EmitTimezone=</varname></term>
3525 <term><varname>Timezone=</varname></term>
3526
9b6ffef3
YW
3527 <listitem><para>Takes a boolean. Configures whether the DHCP leases handed out
3528 to clients shall contain timezone information. Defaults to <literal>yes</literal>. The
ad943783
LP
3529 <varname>Timezone=</varname> setting takes a timezone string
3530 (such as <literal>Europe/Berlin</literal> or
3531 <literal>UTC</literal>) to pass to clients. If no explicit
b938cb90 3532 timezone is set, the system timezone of the local host is
ad943783 3533 propagated, as determined by the
ec07c3c8
AK
3534 <filename>/etc/localtime</filename> symlink.</para>
3535
3536 <xi:include href="version-info.xml" xpointer="v226"/></listitem>
ad943783
LP
3537 </varlistentry>
3538
369ac192 3539 <varlistentry>
6278e428 3540 <term><varname>BootServerAddress=</varname></term>
369ac192
YW
3541
3542 <listitem>
94f7ee97
ZJS
3543 <para>Takes an IPv4 address of the boot server used by e.g. PXE boot systems. When specified, this
3544 address is sent in the <option>siaddr</option> field of the DHCP message header. See <ulink
3545 url="https://www.rfc-editor.org/rfc/rfc2131.html">RFC 2131</ulink> for more details. Defaults to
3546 unset.</para>
ec07c3c8
AK
3547
3548 <xi:include href="version-info.xml" xpointer="v251"/>
369ac192
YW
3549 </listitem>
3550 </varlistentry>
3551
3552 <varlistentry>
6278e428 3553 <term><varname>BootServerName=</varname></term>
369ac192
YW
3554
3555 <listitem>
94f7ee97
ZJS
3556 <para>Takes a name of the boot server used by e.g. PXE boot systems. When specified, this name is
3557 sent in the DHCP option 66 ("TFTP server name"). See <ulink
3558 url="https://www.rfc-editor.org/rfc/rfc2132.html">RFC 2132</ulink> for more details. Defaults to
3559 unset.</para>
3560
3561 <para>Note that typically setting one of <varname>BootServerName=</varname> or
3562 <varname>BootServerAddress=</varname> is sufficient, but both can be set too, if desired.</para>
ec07c3c8
AK
3563
3564 <xi:include href="version-info.xml" xpointer="v251"/>
6278e428
YW
3565 </listitem>
3566 </varlistentry>
3567
3568 <varlistentry>
3569 <term><varname>BootFilename=</varname></term>
3570
3571 <listitem>
94f7ee97
ZJS
3572 <para>Takes a path or URL to a file loaded by e.g. a PXE boot loader. When specified, this path is
3573 sent in the DHCP option 67 ("Bootfile name"). See <ulink
3574 url="https://www.rfc-editor.org/rfc/rfc2132.html">RFC 2132</ulink> for more details. Defaults to
3575 unset.</para>
ec07c3c8
AK
3576
3577 <xi:include href="version-info.xml" xpointer="v251"/>
369ac192
YW
3578 </listitem>
3579 </varlistentry>
3580
564ca984 3581 <varlistentry>
d8b736bd
YW
3582 <term><varname>SendOption=</varname></term>
3583 <listitem>
3584 <para>Send a raw option with value via DHCPv4 server. Takes a DHCP option number, data type
3585 and data (<literal><replaceable>option</replaceable>:<replaceable>type</replaceable>:<replaceable>value</replaceable></literal>).
1d3a473b 3586 The option number is an integer in the range 1…254. The type takes one of <literal>uint8</literal>,
e7d5fe17 3587 <literal>uint16</literal>, <literal>uint32</literal>, <literal>ipv4address</literal>, <literal>ipv6address</literal>, or
7354900d
DW
3588 <literal>string</literal>. Special characters in the data string may be escaped using
3589 <ulink url="https://en.wikipedia.org/wiki/Escape_sequences_in_C#Table_of_escape_sequences">C-style
3590 escapes</ulink>. This setting can be specified multiple times. If an empty string is specified,
3591 then all options specified earlier are cleared. Defaults to unset.</para>
ec07c3c8
AK
3592
3593 <xi:include href="version-info.xml" xpointer="v244"/>
7354900d
DW
3594 </listitem>
3595 </varlistentry>
3596
3597 <varlistentry>
3598 <term><varname>SendVendorOption=</varname></term>
3599 <listitem>
3600 <para>Send a vendor option with value via DHCPv4 server. Takes a DHCP option number, data type
3601 and data (<literal><replaceable>option</replaceable>:<replaceable>type</replaceable>:<replaceable>value</replaceable></literal>).
1d3a473b 3602 The option number is an integer in the range 1…254. The type takes one of <literal>uint8</literal>,
d8b736bd
YW
3603 <literal>uint16</literal>, <literal>uint32</literal>, <literal>ipv4address</literal>, or
3604 <literal>string</literal>. Special characters in the data string may be escaped using
3605 <ulink url="https://en.wikipedia.org/wiki/Escape_sequences_in_C#Table_of_escape_sequences">C-style
3606 escapes</ulink>. This setting can be specified multiple times. If an empty string is specified,
3607 then all options specified earlier are cleared. Defaults to unset.</para>
ec07c3c8
AK
3608
3609 <xi:include href="version-info.xml" xpointer="v246"/>
d8b736bd 3610 </listitem>
564ca984 3611 </varlistentry>
21b6b87e
YA
3612 <varlistentry>
3613 <term><varname>BindToInterface=</varname></term>
11c38d3e
YA
3614 <listitem>
3615 <para>Takes a boolean value. When <literal>yes</literal>, DHCP server socket will be bound
3616 to its network interface and all socket communication will be restricted to this interface.
3617 Defaults to <literal>yes</literal>, except if <varname>RelayTarget=</varname> is used (see below),
84b10e53 3618 in which case it defaults to <literal>no</literal>.</para>
ec07c3c8
AK
3619
3620 <xi:include href="version-info.xml" xpointer="v249"/>
11c38d3e
YA
3621 </listitem>
3622 </varlistentry>
3623 <varlistentry>
3624 <term><varname>RelayTarget=</varname></term>
3625 <listitem>
3626 <para>Takes an IPv4 address, which must be in the format described in
3627 <citerefentry project='man-pages'><refentrytitle>inet_pton</refentrytitle><manvolnum>3</manvolnum></citerefentry>.
3628 Turns this DHCP server into a DHCP relay agent. See <ulink url="https://tools.ietf.org/html/rfc1542">RFC 1542</ulink>.
3629 The address is the address of DHCP server or another relay agent to forward DHCP messages to and from.</para>
ec07c3c8
AK
3630
3631 <xi:include href="version-info.xml" xpointer="v249"/>
11c38d3e
YA
3632 </listitem>
3633 </varlistentry>
3634 <varlistentry>
3635 <term><varname>RelayAgentCircuitId=</varname></term>
3636 <listitem>
3637 <para>Specifies value for Agent Circuit ID suboption of Relay Agent Information option.
3638 Takes a string, which must be in the format <literal>string:<replaceable>value</replaceable></literal>,
3639 where <literal><replaceable>value</replaceable></literal> should be replaced with the value of the suboption.
3640 Defaults to unset (means no Agent Circuit ID suboption is generated).
3641 Ignored if <varname>RelayTarget=</varname> is not specified.</para>
ec07c3c8
AK
3642
3643 <xi:include href="version-info.xml" xpointer="v249"/>
11c38d3e
YA
3644 </listitem>
3645 </varlistentry>
3646 <varlistentry>
3647 <term><varname>RelayAgentRemoteId=</varname></term>
3648 <listitem>
3649 <para>Specifies value for Agent Remote ID suboption of Relay Agent Information option.
3650 Takes a string, which must be in the format <literal>string:<replaceable>value</replaceable></literal>,
3651 where <literal><replaceable>value</replaceable></literal> should be replaced with the value of the suboption.
3652 Defaults to unset (means no Agent Remote ID suboption is generated).
3653 Ignored if <varname>RelayTarget=</varname> is not specified.</para>
ec07c3c8
AK
3654
3655 <xi:include href="version-info.xml" xpointer="v249"/>
21b6b87e
YA
3656 </listitem>
3657 </varlistentry>
564ca984 3658
ad943783
LP
3659 </variablelist>
3660 </refsect1>
3661
c517a49b 3662 <refsect1>
3663 <title>[DHCPServerStaticLease] Section Options</title>
be0d27ee
ZJS
3664 <para>The <literal>[DHCPServerStaticLease]</literal> section configures a static DHCP lease to assign a
3665 fixed IPv4 address to a specific device based on its MAC address. This section can be specified multiple
3666 times.</para>
c517a49b 3667
3668 <variablelist class='network-directives'>
3669 <varlistentry>
3670 <term><varname>MACAddress=</varname></term>
3671
aefdc112
AK
3672 <listitem><para>The hardware address of a device to match. This key is mandatory.</para>
3673
3674 <xi:include href="version-info.xml" xpointer="v249"/></listitem>
c517a49b 3675 </varlistentry>
3676
3677 <varlistentry>
3678 <term><varname>Address=</varname></term>
3679
be0d27ee 3680 <listitem><para>The IPv4 address that should be assigned to the device that was matched with
ec07c3c8
AK
3681 <varname>MACAddress=</varname>. This key is mandatory.</para>
3682
3683 <xi:include href="version-info.xml" xpointer="v249"/></listitem>
c517a49b 3684 </varlistentry>
3685 </variablelist>
3686 </refsect1>
3687
798d3a52 3688 <refsect1>
e5ff2245
YW
3689 <title>[IPv6SendRA] Section Options</title>
3690 <para>The [IPv6SendRA] section contains settings for sending IPv6 Router Advertisements and whether
3691 to act as a router, if enabled via the <varname>IPv6SendRA=</varname> option described above. IPv6
3692 network prefixes or routes are defined with one or more [IPv6Prefix] or [IPv6RoutePrefix] sections.
3693 </para>
3f9e0236
PF
3694
3695 <variablelist class='network-directives'>
3696
3697 <varlistentry>
3698 <term><varname>Managed=</varname></term>
3699 <term><varname>OtherInformation=</varname></term>
3700
9b6ffef3
YW
3701 <listitem><para>Takes a boolean. Controls whether a DHCPv6 server is used to acquire IPv6
3702 addresses on the network link when <varname>Managed=</varname>
3f9e0236
PF
3703 is set to <literal>true</literal> or if only additional network
3704 information can be obtained via DHCPv6 for the network link when
9b6ffef3 3705 <varname>OtherInformation=</varname> is set to
3f9e0236
PF
3706 <literal>true</literal>. Both settings default to
3707 <literal>false</literal>, which means that a DHCPv6 server is not being
aefdc112
AK
3708 used.</para>
3709
3710 <xi:include href="version-info.xml" xpointer="v235"/></listitem>
3f9e0236
PF
3711 </varlistentry>
3712
3713 <varlistentry>
3714 <term><varname>RouterLifetimeSec=</varname></term>
3715
17cd1f62
ZJS
3716 <listitem><para>Takes a timespan. Configures the IPv6 router lifetime in seconds. The value must be 0
3717 seconds, or between 4 seconds and 9000 seconds. When set to 0, the host is not acting as a router.
3718 Defaults to 1800 seconds (30 minutes).</para>
aefdc112
AK
3719
3720 <xi:include href="version-info.xml" xpointer="v235"/>
3f9e0236
PF
3721 </listitem>
3722 </varlistentry>
3723
fdc4c67c
SS
3724 <varlistentry>
3725 <term><varname>RetransmitSec=</varname></term>
3726
3727 <listitem><para>Takes a timespan. Configures the retransmit time, used by clients to retransmit Neighbor
3728 Solicitation messages on address resolution and the Neighbor Unreachability Detection algorithm.
3729 An integer the default unit of seconds, in the range 0…4294967295 msec. Defaults to 0.</para>
ec07c3c8
AK
3730
3731 <xi:include href="version-info.xml" xpointer="v255"/>
fdc4c67c
SS
3732 </listitem>
3733 </varlistentry>
3734
3f9e0236
PF
3735 <varlistentry>
3736 <term><varname>RouterPreference=</varname></term>
3737
3738 <listitem><para>Configures IPv6 router preference if
3739 <varname>RouterLifetimeSec=</varname> is non-zero. Valid values are
3740 <literal>high</literal>, <literal>medium</literal> and
3741 <literal>low</literal>, with <literal>normal</literal> and
3742 <literal>default</literal> added as synonyms for
3743 <literal>medium</literal> just to make configuration easier. See
3744 <ulink url="https://tools.ietf.org/html/rfc4191">RFC 4191</ulink>
aefdc112
AK
3745 for details. Defaults to <literal>medium</literal>.</para>
3746
3747 <xi:include href="version-info.xml" xpointer="v235"/></listitem>
3f9e0236
PF
3748 </varlistentry>
3749
b26c3452
SS
3750 <varlistentry>
3751 <term><varname>HopLimit=</varname></term>
3752 <listitem>
3753 <para>Configures hop limit. Takes an integer in the range 0…255. See also
3754 <varname>IPv6HopLimit=</varname>.</para>
ec07c3c8
AK
3755
3756 <xi:include href="version-info.xml" xpointer="v255"/>
b26c3452
SS
3757 </listitem>
3758 </varlistentry>
3759
63295b42
YW
3760 <varlistentry>
3761 <term><varname>UplinkInterface=</varname></term>
3762 <listitem><para>Specifies the name or the index of the uplink interface, or one of the special
3763 values <literal>:none</literal> and <literal>:auto</literal>. When emitting DNS servers or
3764 search domains is enabled but no servers are specified, the servers configured in the uplink
f6032ff3 3765 interface will be emitted. When <literal>:auto</literal>, the value specified to the same
a27588d4
YW
3766 setting in the [DHCPPrefixDelegation] section will be used if
3767 <varname>DHCPPrefixDelegation=</varname> is enabled, otherwise the link which has a default
f6032ff3 3768 gateway with the highest priority will be automatically selected. When <literal>:none</literal>,
ec07c3c8
AK
3769 no uplink interface will be selected. Defaults to <literal>:auto</literal>.</para>
3770
3771 <xi:include href="version-info.xml" xpointer="v250"/></listitem>
63295b42
YW
3772 </varlistentry>
3773
3f9e0236 3774 <varlistentry>
4cb8478c 3775 <term><varname>EmitDNS=</varname></term>
3f9e0236
PF
3776 <term><varname>DNS=</varname></term>
3777
63295b42
YW
3778 <listitem><para><varname>DNS=</varname> specifies a list of recursive DNS server IPv6 addresses
3779 that are distributed via Router Advertisement messages when <varname>EmitDNS=</varname> is true.
3780 <varname>DNS=</varname> also takes special value <literal>_link_local</literal>; in that case
f81ac115 3781 the IPv6 link-local address is distributed. If <varname>DNS=</varname> is empty, DNS servers are
63295b42
YW
3782 read from the [Network] section. If the [Network] section does not contain any DNS servers
3783 either, DNS servers from the uplink interface specified in <varname>UplinkInterface=</varname>
3784 will be used. When <varname>EmitDNS=</varname> is false, no DNS server information is sent in
aefdc112
AK
3785 Router Advertisement messages. <varname>EmitDNS=</varname> defaults to true.</para>
3786
3787 <xi:include href="version-info.xml" xpointer="v235"/></listitem>
3f9e0236
PF
3788 </varlistentry>
3789
760021c0 3790 <varlistentry>
4cb8478c 3791 <term><varname>EmitDomains=</varname></term>
760021c0
PF
3792 <term><varname>Domains=</varname></term>
3793
bdac5608 3794 <listitem><para>A list of DNS search domains distributed via Router Advertisement messages when
63295b42
YW
3795 <varname>EmitDomains=</varname> is true. If <varname>Domains=</varname> is empty, DNS search
3796 domains are read from the [Network] section. If the [Network] section does not contain any DNS
3797 search domains either, DNS search domains from the uplink interface specified in
3798 <varname>UplinkInterface=</varname> will be used. When <varname>EmitDomains=</varname> is false,
3799 no DNS search domain information is sent in Router Advertisement messages.
aefdc112
AK
3800 <varname>EmitDomains=</varname> defaults to true.</para>
3801
3802 <xi:include href="version-info.xml" xpointer="v235"/></listitem>
760021c0
PF
3803 </varlistentry>
3804
3f9e0236
PF
3805 <varlistentry>
3806 <term><varname>DNSLifetimeSec=</varname></term>
3807
9fa25e07
YW
3808 <listitem><para>Lifetime in seconds for the DNS server addresses listed in
3809 <varname>DNS=</varname> and search domains listed in <varname>Domains=</varname>. Defaults to
aefdc112
AK
3810 3600 seconds (one hour).</para>
3811
3812 <xi:include href="version-info.xml" xpointer="v235"/></listitem>
3f9e0236
PF
3813 </varlistentry>
3814
6a6d27bc
SS
3815 <varlistentry>
3816 <term><varname>HomeAgent=</varname></term>
3817
3818 <listitem><para>Takes a boolean. Specifies that IPv6 router advertisements which indicates to hosts that
3819 the router acts as a Home Agent and includes a Home Agent Option. Defaults to false. See
3820 <ulink url="https://tools.ietf.org/html/rfc6275">RFC 6275</ulink> for further details.</para>
3821
3822 <xi:include href="version-info.xml" xpointer="v255"/>
3823 </listitem>
3824 </varlistentry>
3825
3826 <varlistentry>
3827 <term><varname>HomeAgentLifetimeSec=</varname></term>
3828
3829 <listitem><para>Takes a timespan. Specifies the lifetime of the Home Agent. An integer the default unit of seconds,
3830 in the range 1…65535. Defaults to the value set to <varname>RouterLifetimeSec=</varname>.</para>
3831
3832 <xi:include href="version-info.xml" xpointer="v255"/>
3833 </listitem>
3834 </varlistentry>
3835
3836 <varlistentry>
3837 <term><varname>HomeAgentPreference=</varname></term>
3838
3839 <listitem><para>Configures IPv6 Home Agent preference. Takes an integer in the range 0…65535.
3840 Defaults to 0.</para>
3841
3842 <xi:include href="version-info.xml" xpointer="v255"/>
3843 </listitem>
3844 </varlistentry>
3845
3f9e0236
PF
3846 </variablelist>
3847 </refsect1>
3848
203d4df5 3849 <refsect1>
3f9e0236 3850 <title>[IPv6Prefix] Section Options</title>
e9dd6984
ZJS
3851 <para>One or more [IPv6Prefix] sections contain the IPv6 prefixes that are announced via Router
3852 Advertisements. See <ulink url="https://tools.ietf.org/html/rfc4861">RFC 4861</ulink> for further
3853 details.</para>
3f9e0236
PF
3854
3855 <variablelist class='network-directives'>
3856
3857 <varlistentry>
3858 <term><varname>AddressAutoconfiguration=</varname></term>
3859 <term><varname>OnLink=</varname></term>
3860
9b6ffef3 3861 <listitem><para>Takes a boolean to specify whether IPv6 addresses can be
3f9e0236
PF
3862 autoconfigured with this prefix and whether the prefix can be used for
3863 onlink determination. Both settings default to <literal>true</literal>
3864 in order to ease configuration.
ec07c3c8
AK
3865 </para>
3866
3867 <xi:include href="version-info.xml" xpointer="v235"/></listitem>
3f9e0236
PF
3868 </varlistentry>
3869
3870 <varlistentry>
3871 <term><varname>Prefix=</varname></term>
3872
15102ced 3873 <listitem><para>The IPv6 prefix that is to be distributed to hosts. Similarly to configuring static
bdac5608
ZJS
3874 IPv6 addresses, the setting is configured as an IPv6 prefix and its prefix length, separated by a
3875 <literal>/</literal> character. Use multiple [IPv6Prefix] sections to configure multiple IPv6
3876 prefixes since prefix lifetimes, address autoconfiguration and onlink status may differ from one
ec07c3c8
AK
3877 prefix to another.</para>
3878
3879 <xi:include href="version-info.xml" xpointer="v235"/></listitem>
3f9e0236
PF
3880 </varlistentry>
3881
3882 <varlistentry>
3883 <term><varname>PreferredLifetimeSec=</varname></term>
3884 <term><varname>ValidLifetimeSec=</varname></term>
3885
c9e2c2da
YW
3886 <listitem><para>Preferred and valid lifetimes for the prefix measured in seconds.
3887 <varname>PreferredLifetimeSec=</varname> defaults to 1800 seconds (30 minutes) and
ec07c3c8
AK
3888 <varname>ValidLifetimeSec=</varname> defaults to 3600 seconds (one hour).</para>
3889
3890 <xi:include href="version-info.xml" xpointer="v235"/></listitem>
203d4df5
SS
3891 </varlistentry>
3892
bd6379ec
SS
3893 <varlistentry>
3894 <term><varname>Assign=</varname></term>
3895 <listitem><para>Takes a boolean. When true, adds an address from the prefix. Default to false.
ec07c3c8
AK
3896 </para>
3897
3898 <xi:include href="version-info.xml" xpointer="v246"/></listitem>
bd6379ec 3899 </varlistentry>
0e1fb1d0 3900
e609cd06
YW
3901 <varlistentry>
3902 <term><varname>Token=</varname></term>
3903 <listitem>
3904 <para>Specifies an optional address generation mode for assigning an address in each
3905 prefix. This accepts the same syntax as <varname>Token=</varname> in the [IPv6AcceptRA]
3906 section. If <varname>Assign=</varname> is set to false, then this setting will be ignored.
3907 Defaults to unset, which means the EUI-64 algorithm will be used.</para>
ec07c3c8
AK
3908
3909 <xi:include href="version-info.xml" xpointer="v250"/>
e609cd06
YW
3910 </listitem>
3911 </varlistentry>
3912
0e1fb1d0
YW
3913 <varlistentry>
3914 <term><varname>RouteMetric=</varname></term>
3915 <listitem>
3916 <para>The metric of the prefix route. Takes an unsigned integer in the range 0…4294967295.
3917 When unset or set to 0, the kernel's default value is used. This setting is ignored when
3918 <varname>Assign=</varname> is false.</para>
ec07c3c8
AK
3919
3920 <xi:include href="version-info.xml" xpointer="v249"/>
0e1fb1d0
YW
3921 </listitem>
3922 </varlistentry>
203d4df5
SS
3923 </variablelist>
3924 </refsect1>
3925
3926 <refsect1>
3927 <title>[IPv6RoutePrefix] Section Options</title>
bdac5608 3928 <para>One or more [IPv6RoutePrefix] sections contain the IPv6
203d4df5
SS
3929 prefix routes that are announced via Router Advertisements. See
3930 <ulink url="https://tools.ietf.org/html/rfc4191">RFC 4191</ulink>
3931 for further details.</para>
3932
3933 <variablelist class='network-directives'>
3934
3935 <varlistentry>
3936 <term><varname>Route=</varname></term>
3937
15102ced 3938 <listitem><para>The IPv6 route that is to be distributed to hosts. Similarly to configuring static
bdac5608 3939 IPv6 routes, the setting is configured as an IPv6 prefix routes and its prefix route length,
69a7d108 3940 separated by a <literal>/</literal> character. Use multiple [IPv6RoutePrefix] sections to configure
ec07c3c8
AK
3941 multiple IPv6 prefix routes.</para>
3942
3943 <xi:include href="version-info.xml" xpointer="v244"/></listitem>
203d4df5
SS
3944 </varlistentry>
3945
3946 <varlistentry>
3947 <term><varname>LifetimeSec=</varname></term>
3948
c9e2c2da 3949 <listitem><para>Lifetime for the route prefix measured in seconds.
ec07c3c8
AK
3950 <varname>LifetimeSec=</varname> defaults to 3600 seconds (one hour).</para>
3951
3952 <xi:include href="version-info.xml" xpointer="v244"/></listitem>
3f9e0236
PF
3953 </varlistentry>
3954
3955 </variablelist>
3956 </refsect1>
3957
1925f829
SS
3958 <refsect1>
3959 <title>[IPv6PREF64Prefix] Section Options</title>
3960 <para>One or more [IPv6PREF64Prefix] sections contain the IPv6 PREF64 (or NAT64) prefixes that are announced via Router
3961 Advertisements. See <ulink url="https://tools.ietf.org/html/rfc8781">RFC 8781</ulink> for further
3962 details.</para>
3963
3964 <variablelist class='network-directives'>
3965
3966 <varlistentry>
3967 <term><varname>Prefix=</varname></term>
3968
3969 <listitem><para>The IPv6 PREF64 (or NAT64) prefix that is to be distributed to hosts. The setting holds
3970 an IPv6 prefix that should be set up for NAT64 translation (PLAT) to allow 464XLAT on the network segment.
3971 Use multiple [IPv6PREF64Prefix] sections to configure multiple IPv6 prefixes since prefix lifetime may differ
3972 from one prefix to another. The prefix is an address with a prefix length, separated by a slash
ec07c3c8
AK
3973 <literal>/</literal> character. Valid NAT64 prefix length are 96, 64, 56, 48, 40, and 32 bits.</para>
3974
3975 <xi:include href="version-info.xml" xpointer="v255"/></listitem></varlistentry>
1925f829
SS
3976
3977 <varlistentry>
3978 <term><varname>LifetimeSec=</varname></term>
3979 <listitem><para>Lifetime for the prefix measured in seconds. Should be greater than or equal to <varname>RouterLifetimeSec=</varname>.
ec07c3c8
AK
3980 <varname>LifetimeSec=</varname> defaults to 1800 seconds.</para>
3981
3982 <xi:include href="version-info.xml" xpointer="v255"/></listitem>
1925f829
SS
3983 </varlistentry>
3984 </variablelist>
3985 </refsect1>
3986
3f9e0236 3987 <refsect1>
798d3a52 3988 <title>[Bridge] Section Options</title>
bdac5608 3989 <para>The [Bridge] section accepts the following keys:</para>
798d3a52 3990 <variablelist class='network-directives'>
165c41a9
SS
3991 <varlistentry>
3992 <term><varname>UnicastFlood=</varname></term>
3993 <listitem>
9b6ffef3 3994 <para>Takes a boolean. Controls whether the bridge should flood
072f9e4a 3995 traffic for which an FDB entry is missing and the destination
025314d9 3996 is unknown through this port. When unset, the kernel's default will be used.
47c7dfe2 3997 </para>
ec07c3c8
AK
3998
3999 <xi:include href="version-info.xml" xpointer="v223"/>
165c41a9
SS
4000 </listitem>
4001 </varlistentry>
7f15b714
TJ
4002 <varlistentry>
4003 <term><varname>MulticastFlood=</varname></term>
4004 <listitem>
4005 <para>Takes a boolean. Controls whether the bridge should flood
4006 traffic for which an MDB entry is missing and the destination
4007 is unknown through this port. When unset, the kernel's default will be used.
4008 </para>
ec07c3c8
AK
4009
4010 <xi:include href="version-info.xml" xpointer="v242"/>
7f15b714
TJ
4011 </listitem>
4012 </varlistentry>
d3aa8b49
SS
4013 <varlistentry>
4014 <term><varname>MulticastToUnicast=</varname></term>
4015 <listitem>
4016 <para>Takes a boolean. Multicast to unicast works on top of the multicast snooping feature of
4017 the bridge. Which means unicast copies are only delivered to hosts which are interested in it.
4018 When unset, the kernel's default will be used.
4019 </para>
ec07c3c8
AK
4020
4021 <xi:include href="version-info.xml" xpointer="v240"/>
d3aa8b49
SS
4022 </listitem>
4023 </varlistentry>
7f15b714
TJ
4024 <varlistentry>
4025 <term><varname>NeighborSuppression=</varname></term>
4026 <listitem>
4027 <para>Takes a boolean. Configures whether ARP and ND neighbor suppression is enabled for
4028 this port. When unset, the kernel's default will be used.
4029 </para>
ec07c3c8
AK
4030
4031 <xi:include href="version-info.xml" xpointer="v242"/>
7f15b714
TJ
4032 </listitem>
4033 </varlistentry>
4034 <varlistentry>
4035 <term><varname>Learning=</varname></term>
4036 <listitem>
4037 <para>Takes a boolean. Configures whether MAC address learning is enabled for
4038 this port. When unset, the kernel's default will be used.
4039 </para>
ec07c3c8
AK
4040
4041 <xi:include href="version-info.xml" xpointer="v242"/>
7f15b714
TJ
4042 </listitem>
4043 </varlistentry>
165c41a9
SS
4044 <varlistentry>
4045 <term><varname>HairPin=</varname></term>
4046 <listitem>
e9dd6984
ZJS
4047 <para>Takes a boolean. Configures whether traffic may be sent back out of the port on which it
4048 was received. When this flag is false, then the bridge will not forward traffic back out of the
4049 receiving port. When unset, the kernel's default will be used.</para>
ec07c3c8
AK
4050
4051 <xi:include href="version-info.xml" xpointer="v223"/>
165c41a9
SS
4052 </listitem>
4053 </varlistentry>
97f27f8a
SW
4054 <varlistentry>
4055 <term><varname>Isolated=</varname></term>
4056 <listitem>
4057 <para>Takes a boolean. Configures whether this port is isolated or not. Within a bridge,
4058 isolated ports can only communicate with non-isolated ports. When set to true, this port can only
4059 communicate with other ports whose Isolated setting is false. When set to false, this port
4060 can communicate with any other ports. When unset, the kernel's default will be used.</para>
ec07c3c8
AK
4061
4062 <xi:include href="version-info.xml" xpointer="v251"/>
97f27f8a
SW
4063 </listitem>
4064 </varlistentry>
165c41a9 4065 <varlistentry>
84c34096 4066 <term><varname>UseBPDU=</varname></term>
165c41a9 4067 <listitem>
9b6ffef3 4068 <para>Takes a boolean. Configures whether STP Bridge Protocol Data Units will be
025314d9 4069 processed by the bridge port. When unset, the kernel's default will be used.</para>
ec07c3c8
AK
4070
4071 <xi:include href="version-info.xml" xpointer="v223"/>
165c41a9
SS
4072 </listitem>
4073 </varlistentry>
4074 <varlistentry>
4075 <term><varname>FastLeave=</varname></term>
4076 <listitem>
9b6ffef3 4077 <para>Takes a boolean. This flag allows the bridge to immediately stop multicast
a8eaaee7 4078 traffic on a port that receives an IGMP Leave message. It is only used with
025314d9 4079 IGMP snooping if enabled on the bridge. When unset, the kernel's default will be used.</para>
ec07c3c8
AK
4080
4081 <xi:include href="version-info.xml" xpointer="v223"/>
165c41a9
SS
4082 </listitem>
4083 </varlistentry>
4084 <varlistentry>
23da66bb 4085 <term><varname>AllowPortToBeRoot=</varname></term>
165c41a9 4086 <listitem>
9b6ffef3 4087 <para>Takes a boolean. Configures whether a given port is allowed to
47c7dfe2 4088 become a root port. Only used when STP is enabled on the bridge.
025314d9 4089 When unset, the kernel's default will be used.</para>
ec07c3c8
AK
4090
4091 <xi:include href="version-info.xml" xpointer="v223"/>
165c41a9
SS
4092 </listitem>
4093 </varlistentry>
1087623b
SS
4094 <varlistentry>
4095 <term><varname>ProxyARP=</varname></term>
4096 <listitem>
4097 <para>Takes a boolean. Configures whether proxy ARP to be enabled on this port.
4098 When unset, the kernel's default will be used.</para>
ec07c3c8
AK
4099
4100 <xi:include href="version-info.xml" xpointer="v243"/>
1087623b
SS
4101 </listitem>
4102 </varlistentry>
4103 <varlistentry>
4104 <term><varname>ProxyARPWiFi=</varname></term>
4105 <listitem>
4106 <para>Takes a boolean. Configures whether proxy ARP to be enabled on this port
4107 which meets extended requirements by IEEE 802.11 and Hotspot 2.0 specifications.
4108 When unset, the kernel's default will be used.</para>
ec07c3c8
AK
4109
4110 <xi:include href="version-info.xml" xpointer="v243"/>
1087623b
SS
4111 </listitem>
4112 </varlistentry>
0fadb2a4
SS
4113 <varlistentry>
4114 <term><varname>MulticastRouter=</varname></term>
4115 <listitem>
4116 <para>Configures this port for having multicast routers attached. A port with a multicast
4117 router will receive all multicast traffic. Takes one of <literal>no</literal>
4118 to disable multicast routers on this port, <literal>query</literal> to let the system detect
4119 the presence of routers, <literal>permanent</literal> to permanently enable multicast traffic
4120 forwarding on this port, or <literal>temporary</literal> to enable multicast routers temporarily
4121 on this port, not depending on incoming queries. When unset, the kernel's default will be used.</para>
ec07c3c8
AK
4122
4123 <xi:include href="version-info.xml" xpointer="v243"/>
0fadb2a4
SS
4124 </listitem>
4125 </varlistentry>
798d3a52
ZJS
4126 <varlistentry>
4127 <term><varname>Cost=</varname></term>
4128 <listitem>
47c7dfe2 4129 <para>Sets the "cost" of sending packets of this interface.
a8eaaee7 4130 Each port in a bridge may have a different speed and the cost
798d3a52 4131 is used to decide which link to use. Faster interfaces
785889e5 4132 should have lower costs. It is an integer value between 1 and
b56be296 4133 65535.</para>
ec07c3c8
AK
4134
4135 <xi:include href="version-info.xml" xpointer="v218"/>
b56be296
DJL
4136 </listitem>
4137 </varlistentry>
4138 <varlistentry>
4139 <term><varname>Priority=</varname></term>
4140 <listitem>
4141 <para>Sets the "priority" of sending packets on this interface.
4142 Each port in a bridge may have a different priority which is used
4143 to decide which link to use. Lower value means higher priority.
785889e5 4144 It is an integer value between 0 to 63. Networkd does not set any
b56be296 4145 default, meaning the kernel default value of 32 is used.</para>
ec07c3c8
AK
4146
4147 <xi:include href="version-info.xml" xpointer="v234"/>
798d3a52
ZJS
4148 </listitem>
4149 </varlistentry>
4150 </variablelist>
4151 </refsect1>
798d3a52
ZJS
4152 <refsect1>
4153 <title>[BridgeFDB] Section Options</title>
bdac5608
ZJS
4154 <para>The [BridgeFDB] section manages the forwarding database table of a port and accepts the following
4155 keys. Specify several [BridgeFDB] sections to configure several static MAC table entries.</para>
798d3a52
ZJS
4156
4157 <variablelist class='network-directives'>
4158 <varlistentry>
4159 <term><varname>MACAddress=</varname></term>
4160 <listitem>
bdac5608 4161 <para>As in the [Network] section. This key is mandatory.</para>
aefdc112
AK
4162
4163 <xi:include href="version-info.xml" xpointer="v219"/>
798d3a52
ZJS
4164 </listitem>
4165 </varlistentry>
c2c2793f
SS
4166 <varlistentry>
4167 <term><varname>Destination=</varname></term>
4168 <listitem>
4169 <para>Takes an IP address of the destination VXLAN tunnel endpoint.</para>
ec07c3c8
AK
4170
4171 <xi:include href="version-info.xml" xpointer="v243"/>
c2c2793f
SS
4172 </listitem>
4173 </varlistentry>
798d3a52
ZJS
4174 <varlistentry>
4175 <term><varname>VLANId=</varname></term>
4176 <listitem>
a8eaaee7 4177 <para>The VLAN ID for the new static MAC table entry. If
db9b9fb9 4178 omitted, no VLAN ID information is appended to the new static MAC
798d3a52 4179 table entry.</para>
ec07c3c8
AK
4180
4181 <xi:include href="version-info.xml" xpointer="v219"/>
798d3a52
ZJS
4182 </listitem>
4183 </varlistentry>
61b824c5
SS
4184 <varlistentry>
4185 <term><varname>VNI=</varname></term>
4186 <listitem>
4187 <para>The VXLAN Network Identifier (or VXLAN Segment ID) to use to connect to
1d3a473b 4188 the remote VXLAN tunnel endpoint. Takes a number in the range 1…16777215.
61b824c5 4189 Defaults to unset.</para>
ec07c3c8
AK
4190
4191 <xi:include href="version-info.xml" xpointer="v243"/>
61b824c5
SS
4192 </listitem>
4193 </varlistentry>
bdb397ed
SS
4194 <varlistentry>
4195 <term><varname>AssociatedWith=</varname></term>
4196 <listitem>
4197 <para>Specifies where the address is associated with. Takes one of <literal>use</literal>,
4198 <literal>self</literal>, <literal>master</literal> or <literal>router</literal>.
4199 <literal>use</literal> means the address is in use. User space can use this option to
4200 indicate to the kernel that the fdb entry is in use. <literal>self</literal> means
4201 the address is associated with the port drivers fdb. Usually hardware. <literal>master</literal>
4202 means the address is associated with master devices fdb. <literal>router</literal> means
4203 the destination address is associated with a router. Note that it's valid if the referenced
4204 device is a VXLAN type device and has route shortcircuit enabled. Defaults to <literal>self</literal>.</para>
ec07c3c8
AK
4205
4206 <xi:include href="version-info.xml" xpointer="v243"/>
bdb397ed
SS
4207 </listitem>
4208 </varlistentry>
af99cdf4
SS
4209 <varlistentry>
4210 <term><varname>OutgoingInterface=</varname></term>
4211 <listitem>
4212 <para>Specifies the name or index of the outgoing interface for the VXLAN device driver to
4213 reach the remote VXLAN tunnel endpoint. Defaults to unset.</para>
ec07c3c8
AK
4214
4215 <xi:include href="version-info.xml" xpointer="v249"/>
af99cdf4
SS
4216 </listitem>
4217 </varlistentry>
798d3a52
ZJS
4218 </variablelist>
4219 </refsect1>
a1717e9a
DM
4220 <refsect1>
4221 <title>[BridgeMDB] Section Options</title>
4222 <para>The [BridgeMDB] section manages the multicast membership entries forwarding database table of a port and accepts the following
4223 keys. Specify several [BridgeMDB] sections to configure several permanent multicast membership entries.</para>
4224
4225 <variablelist class='network-directives'>
4226 <varlistentry>
4227 <term><varname>MulticastGroupAddress=</varname></term>
4228 <listitem>
4229 <para>Specifies the IPv4 or IPv6 multicast group address to add. This setting is mandatory.</para>
ec07c3c8
AK
4230
4231 <xi:include href="version-info.xml" xpointer="v247"/>
a1717e9a
DM
4232 </listitem>
4233 </varlistentry>
4234 <varlistentry>
4235 <term><varname>VLANId=</varname></term>
4236 <listitem>
4237 <para>The VLAN ID for the new entry. Valid ranges are 0 (no VLAN) to 4094. Optional, defaults to 0.</para>
aefdc112
AK
4238
4239 <xi:include href="version-info.xml" xpointer="v247"/>
a1717e9a
DM
4240 </listitem>
4241 </varlistentry>
4242 </variablelist>
4243 </refsect1>
06828bb6 4244
e9a8c550
SS
4245 <refsect1>
4246 <title>[LLDP] Section Options</title>
bdac5608 4247 <para>The [LLDP] section manages the Link Layer Discovery Protocol (LLDP) and accepts the following
885a4e6c 4248 keys:</para>
e9a8c550
SS
4249 <variablelist class='network-directives'>
4250 <varlistentry>
4251 <term><varname>MUDURL=</varname></term>
4252 <listitem>
0558f303
ZJS
4253 <para>When configured, the specified Manufacturer Usage Descriptions (MUD) URL will be sent in
4254 LLDP packets. The syntax and semantics are the same as for <varname>MUDURL=</varname> in the
4255 [DHCPv4] section described above.</para>
4256
4257 <para>The MUD URLs received via LLDP packets are saved and can be read using the
e9a8c550 4258 <function>sd_lldp_neighbor_get_mud_url()</function> function.</para>
ec07c3c8
AK
4259
4260 <xi:include href="version-info.xml" xpointer="v246"/>
e9a8c550
SS
4261 </listitem>
4262 </varlistentry>
4263 </variablelist>
4264 </refsect1>
4265
06828bb6
HP
4266 <refsect1>
4267 <title>[CAN] Section Options</title>
bdac5608
ZJS
4268 <para>The [CAN] section manages the Controller Area Network (CAN bus) and accepts the
4269 following keys:</para>
06828bb6
HP
4270 <variablelist class='network-directives'>
4271 <varlistentry>
4272 <term><varname>BitRate=</varname></term>
4273 <listitem>
4274 <para>The bitrate of CAN device in bits per second. The usual SI prefixes (K, M) with the base of 1000 can
1d3a473b 4275 be used here. Takes a number in the range 1…4294967295.</para>
ec07c3c8
AK
4276
4277 <xi:include href="version-info.xml" xpointer="v239"/>
06828bb6
HP
4278 </listitem>
4279 </varlistentry>
4280 <varlistentry>
4281 <term><varname>SamplePoint=</varname></term>
4282 <listitem>
4283 <para>Optional sample point in percent with one decimal (e.g. <literal>75%</literal>,
817561cc
YW
4284 <literal>87.5%</literal>) or permille (e.g. <literal>875‰</literal>). This will be ignored when
4285 <varname>BitRate=</varname> is unspecified.</para>
ec07c3c8
AK
4286
4287 <xi:include href="version-info.xml" xpointer="v239"/>
06828bb6
HP
4288 </listitem>
4289 </varlistentry>
b164b570
YW
4290 <varlistentry>
4291 <term><varname>TimeQuantaNSec=</varname></term>
4292 <term><varname>PropagationSegment=</varname></term>
4293 <term><varname>PhaseBufferSegment1=</varname></term>
4294 <term><varname>PhaseBufferSegment2=</varname></term>
4295 <term><varname>SyncJumpWidth=</varname></term>
4296 <listitem>
4297 <para>Specifies the time quanta, propagation segment, phase buffer segment 1 and 2, and the
6eed65d4 4298 synchronization jump width, which allow one to define the CAN bit-timing in a hardware
b164b570
YW
4299 independent format as proposed by the Bosch CAN 2.0 Specification.
4300 <varname>TimeQuantaNSec=</varname> takes a timespan in nanoseconds.
4301 <varname>PropagationSegment=</varname>, <varname>PhaseBufferSegment1=</varname>,
4302 <varname>PhaseBufferSegment2=</varname>, and <varname>SyncJumpWidth=</varname> take number
4303 of time quantum specified in <varname>TimeQuantaNSec=</varname> and must be an unsigned
4304 integer in the range 0…4294967295. These settings except for
4305 <varname>SyncJumpWidth=</varname> will be ignored when <varname>BitRate=</varname> is
4306 specified.</para>
ec07c3c8
AK
4307
4308 <xi:include href="version-info.xml" xpointer="v250"/>
06828bb6
HP
4309 </listitem>
4310 </varlistentry>
7e025e9c
RP
4311 <varlistentry>
4312 <term><varname>DataBitRate=</varname></term>
4313 <term><varname>DataSamplePoint=</varname></term>
4314 <listitem>
4315 <para>The bitrate and sample point for the data phase, if CAN-FD is used. These settings are
4316 analogous to the <varname>BitRate=</varname> and <varname>SamplePoint=</varname> keys.</para>
ec07c3c8
AK
4317
4318 <xi:include href="version-info.xml" xpointer="v246"/>
7e025e9c
RP
4319 </listitem>
4320 </varlistentry>
b164b570
YW
4321 <varlistentry>
4322 <term><varname>DataTimeQuantaNSec=</varname></term>
4323 <term><varname>DataPropagationSegment=</varname></term>
4324 <term><varname>DataPhaseBufferSegment1=</varname></term>
4325 <term><varname>DataPhaseBufferSegment2=</varname></term>
4326 <term><varname>DataSyncJumpWidth=</varname></term>
4327 <listitem>
4328 <para>Specifies the time quanta, propagation segment, phase buffer segment 1 and 2, and the
4329 synchronization jump width for the data phase, if CAN-FD is used. These settings are
4330 analogous to the <varname>TimeQuantaNSec=</varname> or related settings.</para>
ec07c3c8
AK
4331
4332 <xi:include href="version-info.xml" xpointer="v250"/>
b164b570
YW
4333 </listitem>
4334 </varlistentry>
7e025e9c
RP
4335 <varlistentry>
4336 <term><varname>FDMode=</varname></term>
4337 <listitem>
4338 <para>Takes a boolean. When <literal>yes</literal>, CAN-FD mode is enabled for the interface.
4339 Note, that a bitrate and optional sample point should also be set for the CAN-FD data phase using
b164b570
YW
4340 the <varname>DataBitRate=</varname> and <varname>DataSamplePoint=</varname> keys, or
4341 <varname>DataTimeQuanta=</varname> and related settings.</para>
ec07c3c8
AK
4342
4343 <xi:include href="version-info.xml" xpointer="v246"/>
7e025e9c
RP
4344 </listitem>
4345 </varlistentry>
4346 <varlistentry>
4347 <term><varname>FDNonISO=</varname></term>
4348 <listitem>
4349 <para>Takes a boolean. When <literal>yes</literal>, non-ISO CAN-FD mode is enabled for the
4350 interface. When unset, the kernel's default will be used.</para>
ec07c3c8
AK
4351
4352 <xi:include href="version-info.xml" xpointer="v246"/>
7e025e9c
RP
4353 </listitem>
4354 </varlistentry>
06828bb6
HP
4355 <varlistentry>
4356 <term><varname>RestartSec=</varname></term>
4357 <listitem>
4358 <para>Automatic restart delay time. If set to a non-zero value, a restart of the CAN controller will be
4359 triggered automatically in case of a bus-off condition after the specified delay time. Subsecond delays can
4360 be specified using decimals (e.g. <literal>0.1s</literal>) or a <literal>ms</literal> or
4361 <literal>us</literal> postfix. Using <literal>infinity</literal> or <literal>0</literal> will turn the
4362 automatic restart off. By default automatic restart is disabled.</para>
ec07c3c8
AK
4363
4364 <xi:include href="version-info.xml" xpointer="v239"/>
06828bb6
HP
4365 </listitem>
4366 </varlistentry>
52aa38f1
MR
4367 <varlistentry>
4368 <term><varname>Termination=</varname></term>
4369 <listitem>
69978eb9 4370 <para>Takes a boolean or a termination resistor value in ohm in the range 0…65535. When
239f91f7
YW
4371 <literal>yes</literal>, the termination resistor is set to 120 ohm. When
4372 <literal>no</literal> or <literal>0</literal> is set, the termination resistor is disabled.
4373 When unset, the kernel's default will be used.</para>
ec07c3c8
AK
4374
4375 <xi:include href="version-info.xml" xpointer="v246"/>
52aa38f1
MR
4376 </listitem>
4377 </varlistentry>
c423be28
CG
4378 <varlistentry>
4379 <term><varname>TripleSampling=</varname></term>
4380 <listitem>
4381 <para>Takes a boolean. When <literal>yes</literal>, three samples (instead of one) are used to determine
4382 the value of a received bit by majority rule. When unset, the kernel's default will be used.</para>
ec07c3c8
AK
4383
4384 <xi:include href="version-info.xml" xpointer="v242"/>
c423be28
CG
4385 </listitem>
4386 </varlistentry>
77b67404
4387 <varlistentry>
4388 <term><varname>BusErrorReporting=</varname></term>
4389 <listitem>
4390 <para>Takes a boolean. When <literal>yes</literal>, reporting of CAN bus errors is activated
4391 (those include single bit, frame format, and bit stuffing errors, unable to send dominant bit,
4392 unable to send recessive bit, bus overload, active error announcement, error occurred on
4393 transmission). When unset, the kernel's default will be used. Note: in case of a CAN bus with a
4394 single CAN device, sending a CAN frame may result in a huge number of CAN bus errors.</para>
ec07c3c8
AK
4395
4396 <xi:include href="version-info.xml" xpointer="v248"/>
77b67404
4397 </listitem>
4398 </varlistentry>
74f0fb90
YW
4399 <varlistentry>
4400 <term><varname>ListenOnly=</varname></term>
4401 <listitem>
4402 <para>Takes a boolean. When <literal>yes</literal>, listen-only mode is enabled. When the
4403 interface is in listen-only mode, the interface neither transmit CAN frames nor send ACK
4404 bit. Listen-only mode is important to debug CAN networks without interfering with the
4405 communication or acknowledge the CAN frame. When unset, the kernel's default will be used.
4406 </para>
ec07c3c8
AK
4407
4408 <xi:include href="version-info.xml" xpointer="v246"/>
74f0fb90
YW
4409 </listitem>
4410 </varlistentry>
6dd84c9e
YW
4411 <varlistentry>
4412 <term><varname>Loopback=</varname></term>
4413 <listitem>
4414 <para>Takes a boolean. When <literal>yes</literal>, loopback mode is enabled. When the
4415 loopback mode is enabled, the interface treats messages transmitted by itself as received
4416 messages. The loopback mode is important to debug CAN networks. When unset, the kernel's
4417 default will be used.</para>
ec07c3c8
AK
4418
4419 <xi:include href="version-info.xml" xpointer="v250"/>
6dd84c9e
YW
4420 </listitem>
4421 </varlistentry>
4422 <varlistentry>
4423 <term><varname>OneShot=</varname></term>
4424 <listitem>
4425 <para>Takes a boolean. When <literal>yes</literal>, one-shot mode is enabled. When unset,
4426 the kernel's default will be used.</para>
ec07c3c8
AK
4427
4428 <xi:include href="version-info.xml" xpointer="v250"/>
6dd84c9e
YW
4429 </listitem>
4430 </varlistentry>
4431 <varlistentry>
4432 <term><varname>PresumeAck=</varname></term>
4433 <listitem>
4434 <para>Takes a boolean. When <literal>yes</literal>, the interface will ignore missing CAN
4435 ACKs. When unset, the kernel's default will be used.</para>
ec07c3c8
AK
4436
4437 <xi:include href="version-info.xml" xpointer="v250"/>
6dd84c9e
YW
4438 </listitem>
4439 </varlistentry>
4440 <varlistentry>
4441 <term><varname>ClassicDataLengthCode=</varname></term>
4442 <listitem>
4443 <para>Takes a boolean. When <literal>yes</literal>, the interface will handle the 4bit data
4444 length code (DLC). When unset, the kernel's default will be used.</para>
ec07c3c8
AK
4445
4446 <xi:include href="version-info.xml" xpointer="v250"/>
6dd84c9e
YW
4447 </listitem>
4448 </varlistentry>
06828bb6 4449 </variablelist>
72e65e6f
YW
4450 </refsect1>
4451
4452 <refsect1>
4453 <title>[IPoIB] Section Options</title>
4454 <para>The [IPoIB] section manages the IP over Infiniband and accepts the following keys:</para>
4455 <variablelist class='network-directives'>
4456 <xi:include href="systemd.netdev.xml" xpointer="ipoib_mode" />
4457 <xi:include href="systemd.netdev.xml" xpointer="ipoib_umcast" />
4458 </variablelist>
06828bb6
HP
4459 </refsect1>
4460
2ed5f6d5
YW
4461 <refsect1>
4462 <title>[QDisc] Section Options</title>
bdac5608 4463 <para>The [QDisc] section manages the traffic control queueing discipline (qdisc).</para>
2ed5f6d5
YW
4464
4465 <variablelist class='network-directives'>
4466 <varlistentry>
4467 <term><varname>Parent=</varname></term>
4468 <listitem>
4469 <para>Specifies the parent Queueing Discipline (qdisc). Takes one of <literal>clsact</literal>
4470 or <literal>ingress</literal>. This is mandatory.</para>
aefdc112
AK
4471
4472 <xi:include href="version-info.xml" xpointer="v244"/>
2ed5f6d5
YW
4473 </listitem>
4474 </varlistentry>
d8b2396d 4475
f344a492 4476 <xi:include href="tc.xml" xpointer="qdisc-handle" />
2ed5f6d5
YW
4477 </variablelist>
4478 </refsect1>
4479
0f5bd7fe 4480 <refsect1>
18de0969 4481 <title>[NetworkEmulator] Section Options</title>
bdac5608
ZJS
4482 <para>The [NetworkEmulator] section manages the queueing discipline (qdisc) of the network emulator. It
4483 can be used to configure the kernel packet scheduler and simulate packet delay and loss for UDP or TCP
4484 applications, or limit the bandwidth usage of a particular service to simulate internet connections.
4485 </para>
0f5bd7fe
SS
4486
4487 <variablelist class='network-directives'>
f344a492
YW
4488 <xi:include href="tc.xml" xpointer="qdisc-parent" />
4489 <xi:include href="tc.xml" xpointer="qdisc-handle" />
d8b2396d 4490
0f5bd7fe 4491 <varlistentry>
18de0969 4492 <term><varname>DelaySec=</varname></term>
0f5bd7fe
SS
4493 <listitem>
4494 <para>Specifies the fixed amount of delay to be added to all packets going out of the
4495 interface. Defaults to unset.</para>
ec07c3c8
AK
4496
4497 <xi:include href="version-info.xml" xpointer="v245"/>
0f5bd7fe
SS
4498 </listitem>
4499 </varlistentry>
4500
4501 <varlistentry>
18de0969 4502 <term><varname>DelayJitterSec=</varname></term>
0f5bd7fe
SS
4503 <listitem>
4504 <para>Specifies the chosen delay to be added to the packets outgoing to the network
4505 interface. Defaults to unset.</para>
ec07c3c8
AK
4506
4507 <xi:include href="version-info.xml" xpointer="v245"/>
0f5bd7fe
SS
4508 </listitem>
4509 </varlistentry>
4510
4511 <varlistentry>
18de0969 4512 <term><varname>PacketLimit=</varname></term>
0f5bd7fe
SS
4513 <listitem>
4514 <para>Specifies the maximum number of packets the qdisc may hold queued at a time.
69978eb9 4515 An unsigned integer in the range 0…4294967294. Defaults to 1000.</para>
ec07c3c8
AK
4516
4517 <xi:include href="version-info.xml" xpointer="v245"/>
0f5bd7fe
SS
4518 </listitem>
4519 </varlistentry>
4520
4521 <varlistentry>
18de0969 4522 <term><varname>LossRate=</varname></term>
0f5bd7fe
SS
4523 <listitem>
4524 <para>Specifies an independent loss probability to be added to the packets outgoing from the
4525 network interface. Takes a percentage value, suffixed with "%". Defaults to unset.</para>
ec07c3c8
AK
4526
4527 <xi:include href="version-info.xml" xpointer="v245"/>
0f5bd7fe
SS
4528 </listitem>
4529 </varlistentry>
4530
b9c5aa3c 4531 <varlistentry>
18de0969 4532 <term><varname>DuplicateRate=</varname></term>
b9c5aa3c
SS
4533 <listitem>
4534 <para>Specifies that the chosen percent of packets is duplicated before queuing them.
4535 Takes a percentage value, suffixed with "%". Defaults to unset.</para>
ec07c3c8
AK
4536
4537 <xi:include href="version-info.xml" xpointer="v245"/>
b9c5aa3c
SS
4538 </listitem>
4539 </varlistentry>
18de0969
YW
4540 </variablelist>
4541 </refsect1>
b9c5aa3c 4542
18de0969 4543 <refsect1>
60ed2dcf 4544 <title>[TokenBucketFilter] Section Options</title>
e9dd6984
ZJS
4545 <para>The [TokenBucketFilter] section manages the queueing discipline (qdisc) of token bucket filter
4546 (tbf).</para>
18de0969
YW
4547
4548 <variablelist class='network-directives'>
f344a492
YW
4549 <xi:include href="tc.xml" xpointer="qdisc-parent" />
4550 <xi:include href="tc.xml" xpointer="qdisc-handle" />
d8b2396d 4551
18de0969
YW
4552 <varlistentry>
4553 <term><varname>LatencySec=</varname></term>
ba5841b5
SS
4554 <listitem>
4555 <para>Specifies the latency parameter, which specifies the maximum amount of time a
60ed2dcf 4556 packet can sit in the Token Bucket Filter (TBF). Defaults to unset.</para>
ec07c3c8
AK
4557
4558 <xi:include href="version-info.xml" xpointer="v245"/>
ba5841b5
SS
4559 </listitem>
4560 </varlistentry>
4561
dcfc23ae 4562 <varlistentry>
c03ef420 4563 <term><varname>LimitBytes=</varname></term>
dcfc23ae
YW
4564 <listitem>
4565 <para>Takes the number of bytes that can be queued waiting for tokens to become available.
4566 When the size is suffixed with K, M, or G, it is parsed as Kilobytes, Megabytes, or Gigabytes,
c03ef420 4567 respectively, to the base of 1024. Defaults to unset.</para>
ec07c3c8
AK
4568
4569 <xi:include href="version-info.xml" xpointer="v246"/>
dcfc23ae
YW
4570 </listitem>
4571 </varlistentry>
4572
ba5841b5 4573 <varlistentry>
c03ef420 4574 <term><varname>BurstBytes=</varname></term>
ba5841b5
SS
4575 <listitem>
4576 <para>Specifies the size of the bucket. This is the maximum amount of bytes that tokens
4577 can be available for instantaneous transfer. When the size is suffixed with K, M, or G, it is
c03ef420 4578 parsed as Kilobytes, Megabytes, or Gigabytes, respectively, to the base of 1024. Defaults to
ba5841b5 4579 unset.</para>
ec07c3c8
AK
4580
4581 <xi:include href="version-info.xml" xpointer="v246"/>
ba5841b5
SS
4582 </listitem>
4583 </varlistentry>
4584
4585 <varlistentry>
18de0969 4586 <term><varname>Rate=</varname></term>
ba5841b5
SS
4587 <listitem>
4588 <para>Specifies the device specific bandwidth. When suffixed with K, M, or G, the specified
6b8fe4c3 4589 bandwidth is parsed as Kilobits, Megabits, or Gigabits, respectively, to the base of 1000.
ba5841b5 4590 Defaults to unset.</para>
ec07c3c8
AK
4591
4592 <xi:include href="version-info.xml" xpointer="v245"/>
ba5841b5
SS
4593 </listitem>
4594 </varlistentry>
4595
dcfc23ae 4596 <varlistentry>
18de0969 4597 <term><varname>MPUBytes=</varname></term>
dcfc23ae
YW
4598 <listitem>
4599 <para>The Minimum Packet Unit (MPU) determines the minimal token usage (specified in bytes)
4600 for a packet. When suffixed with K, M, or G, the specified size is parsed as Kilobytes,
c03ef420 4601 Megabytes, or Gigabytes, respectively, to the base of 1024. Defaults to zero.</para>
ec07c3c8
AK
4602
4603 <xi:include href="version-info.xml" xpointer="v245"/>
dcfc23ae
YW
4604 </listitem>
4605 </varlistentry>
4606
4607 <varlistentry>
18de0969 4608 <term><varname>PeakRate=</varname></term>
dcfc23ae
YW
4609 <listitem>
4610 <para>Takes the maximum depletion rate of the bucket. When suffixed with K, M, or G, the
6b8fe4c3 4611 specified size is parsed as Kilobits, Megabits, or Gigabits, respectively, to the base of
dcfc23ae 4612 1000. Defaults to unset.</para>
ec07c3c8
AK
4613
4614 <xi:include href="version-info.xml" xpointer="v245"/>
dcfc23ae
YW
4615 </listitem>
4616 </varlistentry>
4617
4618 <varlistentry>
18de0969 4619 <term><varname>MTUBytes=</varname></term>
dcfc23ae
YW
4620 <listitem>
4621 <para>Specifies the size of the peakrate bucket. When suffixed with K, M, or G, the specified
c03ef420 4622 size is parsed as Kilobytes, Megabytes, or Gigabytes, respectively, to the base of 1024.
dcfc23ae 4623 Defaults to unset.</para>
ec07c3c8
AK
4624
4625 <xi:include href="version-info.xml" xpointer="v245"/>
dcfc23ae
YW
4626 </listitem>
4627 </varlistentry>
18de0969
YW
4628 </variablelist>
4629 </refsect1>
4630
bde4ae88
SS
4631 <refsect1>
4632 <title>[PIE] Section Options</title>
bdac5608
ZJS
4633 <para>The [PIE] section manages the queueing discipline (qdisc) of Proportional Integral
4634 controller-Enhanced (PIE).</para>
bde4ae88
SS
4635
4636 <variablelist class='network-directives'>
f344a492
YW
4637 <xi:include href="tc.xml" xpointer="qdisc-parent" />
4638 <xi:include href="tc.xml" xpointer="qdisc-handle" />
bde4ae88
SS
4639
4640 <varlistentry>
4641 <term><varname>PacketLimit=</varname></term>
4642 <listitem>
1d3a473b
ZJS
4643 <para>Specifies the hard limit on the queue size in number of packets. When this limit is reached,
4644 incoming packets are dropped. An unsigned integer in the range 1…4294967294. Defaults to unset and
4645 kernel's default is used.</para>
ec07c3c8
AK
4646
4647 <xi:include href="version-info.xml" xpointer="v246"/>
8f6b6d70
SS
4648 </listitem>
4649 </varlistentry>
4650 </variablelist>
4651 </refsect1>
4652
4653 <refsect1>
4654 <title>[FlowQueuePIE] Section Options</title>
4655 <para>The <literal>[FlowQueuePIE]</literal> section manages the queueing discipline
4656 (qdisc) of Flow Queue Proportional Integral controller-Enhanced (fq_pie).</para>
4657
4658 <variablelist class='network-directives'>
4659 <xi:include href="tc.xml" xpointer="qdisc-parent" />
4660 <xi:include href="tc.xml" xpointer="qdisc-handle" />
4661
4662 <varlistentry>
4663 <term><varname>PacketLimit=</varname></term>
4664 <listitem>
75909cc7
ZJS
4665 <para>Specifies the hard limit on the queue size in number of packets. When this limit is reached,
4666 incoming packets are dropped. An unsigned integer ranges 1 to 4294967294. Defaults to unset and
4667 kernel's default is used.</para>
ec07c3c8
AK
4668
4669 <xi:include href="version-info.xml" xpointer="v247"/>
bde4ae88
SS
4670 </listitem>
4671 </varlistentry>
4672 </variablelist>
4673 </refsect1>
4674
982998b0
SS
4675 <refsect1>
4676 <title>[StochasticFairBlue] Section Options</title>
bdac5608
ZJS
4677 <para>The [StochasticFairBlue] section manages the queueing discipline (qdisc) of stochastic fair blue
4678 (sfb).</para>
982998b0
SS
4679
4680 <variablelist class='network-directives'>
f344a492
YW
4681 <xi:include href="tc.xml" xpointer="qdisc-parent" />
4682 <xi:include href="tc.xml" xpointer="qdisc-handle" />
982998b0
SS
4683
4684 <varlistentry>
4685 <term><varname>PacketLimit=</varname></term>
4686 <listitem>
e9dd6984 4687 <para>Specifies the hard limit on the queue size in number of packets. When this limit is reached,
69978eb9 4688 incoming packets are dropped. An unsigned integer in the range 0…4294967294. Defaults to unset and
e9dd6984 4689 kernel's default is used.</para>
ec07c3c8
AK
4690
4691 <xi:include href="version-info.xml" xpointer="v246"/>
982998b0
SS
4692 </listitem>
4693 </varlistentry>
4694 </variablelist>
4695 </refsect1>
4696
18de0969
YW
4697 <refsect1>
4698 <title>[StochasticFairnessQueueing] Section Options</title>
bdac5608
ZJS
4699 <para>The [StochasticFairnessQueueing] section manages the queueing discipline (qdisc) of stochastic
4700 fairness queueing (sfq).</para>
18de0969
YW
4701
4702 <variablelist class='network-directives'>
f344a492
YW
4703 <xi:include href="tc.xml" xpointer="qdisc-parent" />
4704 <xi:include href="tc.xml" xpointer="qdisc-handle" />
d8b2396d 4705
9942b710 4706 <varlistentry>
18de0969 4707 <term><varname>PerturbPeriodSec=</varname></term>
9942b710
SS
4708 <listitem>
4709 <para>Specifies the interval in seconds for queue algorithm perturbation. Defaults to unset.</para>
ec07c3c8
AK
4710
4711 <xi:include href="version-info.xml" xpointer="v245"/>
9942b710
SS
4712 </listitem>
4713 </varlistentry>
18de0969
YW
4714 </variablelist>
4715 </refsect1>
4716
c853f594
SS
4717 <refsect1>
4718 <title>[BFIFO] Section Options</title>
bdac5608
ZJS
4719 <para>The [BFIFO] section manages the queueing discipline (qdisc) of Byte limited Packet First In First
4720 Out (bfifo).</para>
c853f594
SS
4721
4722 <variablelist class='network-directives'>
f344a492
YW
4723 <xi:include href="tc.xml" xpointer="qdisc-parent" />
4724 <xi:include href="tc.xml" xpointer="qdisc-handle" />
c853f594
SS
4725
4726 <varlistentry>
c03ef420 4727 <term><varname>LimitBytes=</varname></term>
c853f594 4728 <listitem>
885a4e6c
ZJS
4729 <para>Specifies the hard limit in bytes on the FIFO buffer size. The size limit prevents overflow
4730 in case the kernel is unable to dequeue packets as quickly as it receives them. When this limit is
4731 reached, incoming packets are dropped. When suffixed with K, M, or G, the specified size is parsed
4732 as Kilobytes, Megabytes, or Gigabytes, respectively, to the base of 1024. Defaults to unset and
4733 kernel default is used.</para>
ec07c3c8
AK
4734
4735 <xi:include href="version-info.xml" xpointer="v246"/>
c853f594
SS
4736 </listitem>
4737 </varlistentry>
4738 </variablelist>
4739 </refsect1>
4740
a7476065
SS
4741 <refsect1>
4742 <title>[PFIFO] Section Options</title>
bdac5608
ZJS
4743 <para>The [PFIFO] section manages the queueing discipline (qdisc) of Packet First In First Out
4744 (pfifo).</para>
a7476065
SS
4745
4746 <variablelist class='network-directives'>
f344a492
YW
4747 <xi:include href="tc.xml" xpointer="qdisc-parent" />
4748 <xi:include href="tc.xml" xpointer="qdisc-handle" />
a7476065
SS
4749
4750 <varlistentry>
4751 <term><varname>PacketLimit=</varname></term>
4752 <listitem>
75909cc7
ZJS
4753 <para>Specifies the hard limit on the number of packets in the FIFO queue. The size limit prevents
4754 overflow in case the kernel is unable to dequeue packets as quickly as it receives them. When this
4755 limit is reached, incoming packets are dropped. An unsigned integer in the range
69978eb9 4756 0…4294967294. Defaults to unset and kernel's default is used.</para>
ec07c3c8
AK
4757
4758 <xi:include href="version-info.xml" xpointer="v246"/>
a7476065
SS
4759 </listitem>
4760 </varlistentry>
ad8352f4
SS
4761 </variablelist>
4762 </refsect1>
4763
053a2ddb
SS
4764 <refsect1>
4765 <title>[PFIFOHeadDrop] Section Options</title>
bdac5608
ZJS
4766 <para>The [PFIFOHeadDrop] section manages the queueing discipline (qdisc) of Packet First In First Out
4767 Head Drop (pfifo_head_drop).</para>
053a2ddb
SS
4768
4769 <variablelist class='network-directives'>
f344a492
YW
4770 <xi:include href="tc.xml" xpointer="qdisc-parent" />
4771 <xi:include href="tc.xml" xpointer="qdisc-handle" />
053a2ddb
SS
4772
4773 <varlistentry>
4774 <term><varname>PacketLimit=</varname></term>
4775 <listitem>
ec07c3c8
AK
4776 <para>As in [PFIFO] section.</para>
4777
4778 <xi:include href="version-info.xml" xpointer="v246"/></listitem>
053a2ddb
SS
4779 </varlistentry>
4780 </variablelist>
4781 </refsect1>
4782
1a95964b
SS
4783 <refsect1>
4784 <title>[PFIFOFast] Section Options</title>
bdac5608
ZJS
4785 <para>The [PFIFOFast] section manages the queueing discipline (qdisc) of Packet First In First Out Fast
4786 (pfifo_fast).</para>
1a95964b
SS
4787
4788 <variablelist class='network-directives'>
f344a492
YW
4789 <xi:include href="tc.xml" xpointer="qdisc-parent" />
4790 <xi:include href="tc.xml" xpointer="qdisc-handle" />
1a95964b
SS
4791 </variablelist>
4792 </refsect1>
4793
ad8352f4
SS
4794 <refsect1>
4795 <title>[CAKE] Section Options</title>
bdac5608
ZJS
4796 <para>The [CAKE] section manages the queueing discipline (qdisc) of Common Applications Kept Enhanced
4797 (CAKE).</para>
ad8352f4
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 4802
ad8352f4 4803 <varlistentry>
ca2c3e92 4804 <term><varname>Bandwidth=</varname></term>
ad8352f4 4805 <listitem>
ca2c3e92
YW
4806 <para>Specifies the shaper bandwidth. When suffixed with K, M, or G, the specified size is
4807 parsed as Kilobits, Megabits, or Gigabits, respectively, to the base of 1000. Defaults to
4808 unset and kernel's default is used.</para>
ec07c3c8
AK
4809
4810 <xi:include href="version-info.xml" xpointer="v246"/>
ad8352f4 4811 </listitem>
f344a492 4812 </varlistentry>
ad8352f4 4813
025cd94e
YW
4814 <varlistentry>
4815 <term><varname>AutoRateIngress=</varname></term>
4816 <listitem>
4817 <para>Takes a boolean value. Enables automatic capacity estimation based on traffic arriving
4818 at this qdisc. This is most likely to be useful with cellular links, which tend to change
4819 quality randomly. If this setting is enabled, the <varname>Bandwidth=</varname> setting is
4820 used as an initial estimate. Defaults to unset, and the kernel's default is used.</para>
ec07c3c8
AK
4821
4822 <xi:include href="version-info.xml" xpointer="v250"/>
025cd94e
YW
4823 </listitem>
4824 </varlistentry>
4825
ad8352f4 4826 <varlistentry>
c03ef420 4827 <term><varname>OverheadBytes=</varname></term>
ad8352f4 4828 <listitem>
69978eb9
YW
4829 <para>Specifies that bytes to be addeded to the size of each packet. Bytes may be negative.
4830 Takes an integer in the range -64…256. Defaults to unset and kernel's default is used.
4831 </para>
ec07c3c8
AK
4832
4833 <xi:include href="version-info.xml" xpointer="v246"/>
ad8352f4 4834 </listitem>
f344a492 4835 </varlistentry>
ad8352f4
SS
4836
4837 <varlistentry>
863542e1 4838 <term><varname>MPUBytes=</varname></term>
ad8352f4 4839 <listitem>
863542e1
YW
4840 <para>Rounds each packet (including overhead) up to the specified bytes. Takes an integer in
4841 the range 1…256. Defaults to unset and kernel's default is used.</para>
ec07c3c8
AK
4842
4843 <xi:include href="version-info.xml" xpointer="v250"/>
863542e1
YW
4844 </listitem>
4845 </varlistentry>
4846
b6eccfda
YW
4847 <varlistentry>
4848 <term><varname>CompensationMode=</varname></term>
4849 <listitem>
4850 <para>Takes one of <literal>none</literal>, <literal>atm</literal>, or <literal>ptm</literal>.
4851 Specifies the compensation mode for overhead calculation. When <literal>none</literal>, no
4852 compensation is taken into account. When <literal>atm</literal>, enables the compensation for
4853 ATM cell framing, which is normally found on ADSL links. When <literal>ptm</literal>, enables
4854 the compensation for PTM encoding, which is normally found on VDSL2 links and uses a 64b/65b
4855 encoding scheme. Defaults to unset and the kernel's default is used.</para>
ec07c3c8
AK
4856
4857 <xi:include href="version-info.xml" xpointer="v250"/>
b6eccfda
YW
4858 </listitem>
4859 </varlistentry>
4860
1c7a81e6
YW
4861 <varlistentry>
4862 <term><varname>UseRawPacketSize=</varname></term>
4863 <listitem>
4864 <para>Takes a boolean value. When true, the packet size reported by the Linux kernel will be
4865 used, instead of the underlying IP packet size. Defaults to unset, and the kernel's default
4866 is used.</para>
ec07c3c8
AK
4867
4868 <xi:include href="version-info.xml" xpointer="v250"/>
1c7a81e6
YW
4869 </listitem>
4870 </varlistentry>
4871
a049cf16
YW
4872 <varlistentry>
4873 <term><varname>FlowIsolationMode=</varname></term>
4874 <listitem>
4875 <para>CAKE places packets from different flows into different queues, then packets from each
4876 queue are delivered fairly. This specifies whether the fairness is based on source address,
4877 destination address, individual flows, or any combination of those. The available values are:
4878 </para>
4879
4880 <variablelist>
4881 <varlistentry>
4882 <term><option>none</option></term>
4883 <listitem><para>
4884 The flow isolation is disabled, and all traffic passes through a single queue.
ec07c3c8
AK
4885 </para>
4886
4887 <xi:include href="version-info.xml" xpointer="v250"/></listitem>
a049cf16
YW
4888 </varlistentry>
4889 <varlistentry>
4890 <term><option>src-host</option></term>
4891 <listitem><para>
2f7a0648 4892 Flows are defined only by source address. Equivalent to the <literal>srchost</literal>
a049cf16
YW
4893 option for <command>tc qdisc</command> command. See also
4894 <citerefentry project='man-pages'><refentrytitle>tc-cake</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
ec07c3c8
AK
4895 </para>
4896
4897 <xi:include href="version-info.xml" xpointer="v250"/></listitem>
a049cf16
YW
4898 </varlistentry>
4899 <varlistentry>
4900 <term><option>dst-host</option></term>
4901 <listitem><para>
2f7a0648 4902 Flows are defined only by destination address. Equivalent to the
d68c797c 4903 <literal>dsthost</literal> option for <command>tc qdisc</command> command. See also
a049cf16 4904 <citerefentry project='man-pages'><refentrytitle>tc-cake</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
ec07c3c8
AK
4905 </para>
4906
4907 <xi:include href="version-info.xml" xpointer="v250"/></listitem>
a049cf16
YW
4908 </varlistentry>
4909 <varlistentry>
4910 <term><option>hosts</option></term>
4911 <listitem><para>
4912 Flows are defined by source-destination host pairs. Equivalent to the same option for
4913 <command>tc qdisc</command> command. See also
4914 <citerefentry project='man-pages'><refentrytitle>tc-cake</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
ec07c3c8
AK
4915 </para>
4916
4917 <xi:include href="version-info.xml" xpointer="v250"/></listitem>
a049cf16
YW
4918 </varlistentry>
4919 <varlistentry>
4920 <term><option>flows</option></term>
4921 <listitem><para>
4922 Flows are defined by the entire 5-tuple of source address, destination address,
4923 transport protocol, source port and destination port. Equivalent to the same option for
4924 <command>tc qdisc</command> command. See also
4925 <citerefentry project='man-pages'><refentrytitle>tc-cake</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
ec07c3c8
AK
4926 </para>
4927
4928 <xi:include href="version-info.xml" xpointer="v250"/></listitem>
a049cf16
YW
4929 </varlistentry>
4930 <varlistentry>
4931 <term><option>dual-src-host</option></term>
4932 <listitem><para>
4933 Flows are defined by the 5-tuple (see <literal>flows</literal> in the above), and
2f7a0648 4934 fairness is applied first over source addresses, then over individual flows. Equivalent
a049cf16
YW
4935 to the <literal>dual-srchost</literal> option for <command>tc qdisc</command> command.
4936 See also
4937 <citerefentry project='man-pages'><refentrytitle>tc-cake</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
ec07c3c8
AK
4938 </para>
4939
4940 <xi:include href="version-info.xml" xpointer="v250"/></listitem>
a049cf16
YW
4941 </varlistentry>
4942 <varlistentry>
4943 <term><option>dual-dst-host</option></term>
4944 <listitem><para>
4945 Flows are defined by the 5-tuple (see <literal>flows</literal> in the above), and
4946 fairness is applied first over destination addresses, then over individual flows.
2f7a0648 4947 Equivalent to the <literal>dual-dsthost</literal> option for
a049cf16
YW
4948 <command>tc qdisc</command> command. See also
4949 <citerefentry project='man-pages'><refentrytitle>tc-cake</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
ec07c3c8
AK
4950 </para>
4951
4952 <xi:include href="version-info.xml" xpointer="v250"/></listitem>
a049cf16
YW
4953 </varlistentry>
4954 <varlistentry>
4955 <term><option>triple</option></term>
4956 <listitem><para>
4957 Flows are defined by the 5-tuple (see <literal>flows</literal>), and fairness is
4958 applied over source and destination addresses, and also over individual flows.
2f7a0648 4959 Equivalent to the <literal>triple-isolate</literal> option for
a049cf16
YW
4960 <command>tc qdisc</command> command. See also
4961 <citerefentry project='man-pages'><refentrytitle>tc-cake</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
ec07c3c8
AK
4962 </para>
4963
4964 <xi:include href="version-info.xml" xpointer="v250"/></listitem>
a049cf16
YW
4965 </varlistentry>
4966 </variablelist>
4967
4968 <para>Defaults to unset and the kernel's default is used.</para>
ec07c3c8
AK
4969
4970 <xi:include href="version-info.xml" xpointer="v250"/>
a049cf16
YW
4971 </listitem>
4972 </varlistentry>
4973
4bff8086
YW
4974 <varlistentry>
4975 <term><varname>NAT=</varname></term>
4976 <listitem>
4977 <para>Takes a boolean value. When true, CAKE performs a NAT lookup before applying
4978 flow-isolation rules, to determine the true addresses and port numbers of the packet, to
4979 improve fairness between hosts inside the NAT. This has no practical effect when
4980 <varname>FlowIsolationMode=</varname> is <literal>none</literal> or <literal>flows</literal>,
4981 or if NAT is performed on a different host. Defaults to unset, and the kernel's default is
4982 used.</para>
ec07c3c8
AK
4983
4984 <xi:include href="version-info.xml" xpointer="v250"/>
4bff8086
YW
4985 </listitem>
4986 </varlistentry>
4987
fe8e156e
YW
4988 <varlistentry>
4989 <term><varname>PriorityQueueingPreset=</varname></term>
4990 <listitem>
4991 <para>CAKE divides traffic into <literal>tins</literal>, and each tin has its own independent
4992 set of flow-isolation queues, bandwidth threshold, and priority. This specifies the preset of
4993 tin profiles. The available values are:</para>
4994
4995 <variablelist>
4996 <varlistentry>
4997 <term><option>besteffort</option></term>
4998 <listitem><para>
4999 Disables priority queueing by placing all traffic in one tin.
ec07c3c8
AK
5000 </para>
5001
5002 <xi:include href="version-info.xml" xpointer="v250"/></listitem>
fe8e156e
YW
5003 </varlistentry>
5004 <varlistentry>
5005 <term><option>precedence</option></term>
5006 <listitem><para>
5007 Enables priority queueing based on the legacy interpretation of TOS
5008 <literal>Precedence</literal> field. Use of this preset on the modern Internet is
5009 firmly discouraged.
ec07c3c8
AK
5010 </para>
5011
5012 <xi:include href="version-info.xml" xpointer="v250"/></listitem>
fe8e156e
YW
5013 </varlistentry>
5014 <varlistentry>
5015 <term><option>diffserv8</option></term>
5016 <listitem><para>
5017 Enables priority queueing based on the Differentiated Service
5018 (<literal>DiffServ</literal>) field with eight tins: Background Traffic, High
5019 Throughput, Best Effort, Video Streaming, Low Latency Transactions, Interactive Shell,
5020 Minimum Latency, and Network Control.
ec07c3c8
AK
5021 </para>
5022
5023 <xi:include href="version-info.xml" xpointer="v250"/></listitem>
fe8e156e
YW
5024 </varlistentry>
5025 <varlistentry>
5026 <term><option>diffserv4</option></term>
5027 <listitem><para>
5028 Enables priority queueing based on the Differentiated Service
5029 (<literal>DiffServ</literal>) field with four tins: Background Traffic, Best Effort,
5030 Streaming Media, and Latency Sensitive.
ec07c3c8
AK
5031 </para>
5032
5033 <xi:include href="version-info.xml" xpointer="v250"/></listitem>
fe8e156e
YW
5034 </varlistentry>
5035 <varlistentry>
5036 <term><option>diffserv3</option></term>
5037 <listitem><para>
5038 Enables priority queueing based on the Differentiated Service
5039 (<literal>DiffServ</literal>) field with three tins: Background Traffic, Best Effort,
5040 and Latency Sensitive.
ec07c3c8
AK
5041 </para>
5042
5043 <xi:include href="version-info.xml" xpointer="v250"/></listitem>
fe8e156e
YW
5044 </varlistentry>
5045 </variablelist>
5046
5047 <para>Defaults to unset, and the kernel's default is used.</para>
ec07c3c8
AK
5048
5049 <xi:include href="version-info.xml" xpointer="v250"/>
ad8352f4
SS
5050 </listitem>
5051 </varlistentry>
fe8e156e 5052
049b66cc
YW
5053 <varlistentry>
5054 <term><varname>FirewallMark=</varname></term>
5055 <listitem>
5056 <para>Takes an integer in the range 1…4294967295. When specified, firewall-mark-based
5057 overriding of CAKE's tin selection is enabled. Defaults to unset, and the kernel's default is
5058 used.</para>
ec07c3c8
AK
5059
5060 <xi:include href="version-info.xml" xpointer="v250"/>
049b66cc
YW
5061 </listitem>
5062 </varlistentry>
5063
d05dce95
YW
5064 <varlistentry>
5065 <term><varname>Wash=</varname></term>
5066 <listitem>
5067 <para>Takes a boolean value. When true, CAKE clears the DSCP fields, except for ECN bits, of
5068 any packet passing through CAKE. Defaults to unset, and the kernel's default is used.</para>
ec07c3c8
AK
5069
5070 <xi:include href="version-info.xml" xpointer="v250"/>
d05dce95
YW
5071 </listitem>
5072 </varlistentry>
5073
35896db4
YW
5074 <varlistentry>
5075 <term><varname>SplitGSO=</varname></term>
5076 <listitem>
5077 <para>Takes a boolean value. When true, CAKE will split General Segmentation Offload (GSO)
5078 super-packets into their on-the-wire components and dequeue them individually. Defaults to
5079 unset, and the kernel's default is used.</para>
ec07c3c8
AK
5080
5081 <xi:include href="version-info.xml" xpointer="v250"/>
35896db4
YW
5082 </listitem>
5083 </varlistentry>
5084
3af9cd0b
YW
5085 <varlistentry>
5086 <term><varname>RTTSec=</varname></term>
5087 <listitem>
5088 <para>Specifies the RTT for the filter. Takes a timespan. Typical values are e.g. 100us for
5089 extremely high-performance 10GigE+ networks like datacentre, 1ms for non-WiFi LAN connections,
5090 100ms for typical internet connections. Defaults to unset, and the kernel's default will be used.
5091 </para>
ec07c3c8
AK
5092
5093 <xi:include href="version-info.xml" xpointer="v253"/>
3af9cd0b
YW
5094 </listitem>
5095 </varlistentry>
5096
8c920636
YW
5097 <varlistentry>
5098 <term><varname>AckFilter=</varname></term>
5099 <listitem>
5100 <para>Takes a boolean value, or special value <literal>aggressive</literal>. If enabled, ACKs in
5101 each flow are queued and redundant ACKs to the upstream are dropped. If yes, the filter will always
5102 keep at least two redundant ACKs in the queue, while in <literal>aggressive</literal> mode, it will
5103 filter down to a single ACK. This may improve download throughput on links with very asymmetrical
5104 rate limits. Defaults to unset, and the kernel's default will be used.</para>
ec07c3c8
AK
5105
5106 <xi:include href="version-info.xml" xpointer="v253"/>
8c920636
YW
5107 </listitem>
5108 </varlistentry>
5109
a7476065
SS
5110 </variablelist>
5111 </refsect1>
5112
18de0969
YW
5113 <refsect1>
5114 <title>[ControlledDelay] Section Options</title>
bdac5608 5115 <para>The [ControlledDelay] section manages the queueing discipline (qdisc) of
18de0969 5116 controlled delay (CoDel).</para>
9942b710 5117
18de0969 5118 <variablelist class='network-directives'>
f344a492
YW
5119 <xi:include href="tc.xml" xpointer="qdisc-parent" />
5120 <xi:include href="tc.xml" xpointer="qdisc-handle" />
d8b2396d 5121
18de0969
YW
5122 <varlistentry>
5123 <term><varname>PacketLimit=</varname></term>
a9a5d632 5124 <listitem>
e9dd6984 5125 <para>Specifies the hard limit on the queue size in number of packets. When this limit is reached,
69978eb9 5126 incoming packets are dropped. An unsigned integer in the range 0…4294967294. Defaults to unset and
e9dd6984 5127 kernel's default is used.</para>
ec07c3c8
AK
5128
5129 <xi:include href="version-info.xml" xpointer="v245"/>
a9a5d632
SS
5130 </listitem>
5131 </varlistentry>
5132
b078e528 5133 <varlistentry>
18de0969 5134 <term><varname>TargetSec=</varname></term>
b078e528
YW
5135 <listitem>
5136 <para>Takes a timespan. Specifies the acceptable minimum standing/persistent queue delay.
5137 Defaults to unset and kernel's default is used.</para>
ec07c3c8
AK
5138
5139 <xi:include href="version-info.xml" xpointer="v245"/>
b078e528
YW
5140 </listitem>
5141 </varlistentry>
5142
5143 <varlistentry>
18de0969 5144 <term><varname>IntervalSec=</varname></term>
b078e528
YW
5145 <listitem>
5146 <para>Takes a timespan. This is used to ensure that the measured minimum delay does not
5147 become too stale. Defaults to unset and kernel's default is used.</para>
ec07c3c8
AK
5148
5149 <xi:include href="version-info.xml" xpointer="v245"/>
b078e528
YW
5150 </listitem>
5151 </varlistentry>
5152
5153 <varlistentry>
18de0969 5154 <term><varname>ECN=</varname></term>
b078e528
YW
5155 <listitem>
5156 <para>Takes a boolean. This can be used to mark packets instead of dropping them. Defaults to
5157 unset and kernel's default is used.</para>
ec07c3c8
AK
5158
5159 <xi:include href="version-info.xml" xpointer="v245"/>
b078e528
YW
5160 </listitem>
5161 </varlistentry>
5162
5163 <varlistentry>
18de0969 5164 <term><varname>CEThresholdSec=</varname></term>
b078e528
YW
5165 <listitem>
5166 <para>Takes a timespan. This sets a threshold above which all packets are marked with ECN
5167 Congestion Experienced (CE). Defaults to unset and kernel's default is used.</para>
ec07c3c8
AK
5168
5169 <xi:include href="version-info.xml" xpointer="v245"/>
b078e528
YW
5170 </listitem>
5171 </varlistentry>
18de0969
YW
5172 </variablelist>
5173 </refsect1>
b078e528 5174
f5fc0441
SS
5175 <refsect1>
5176 <title>[DeficitRoundRobinScheduler] Section Options</title>
bdac5608
ZJS
5177 <para>The [DeficitRoundRobinScheduler] section manages the queueing discipline (qdisc) of Deficit Round
5178 Robin Scheduler (DRR).</para>
f5fc0441
SS
5179
5180 <variablelist class='network-directives'>
f344a492
YW
5181 <xi:include href="tc.xml" xpointer="qdisc-parent" />
5182 <xi:include href="tc.xml" xpointer="qdisc-handle" />
f5fc0441
SS
5183 </variablelist>
5184 </refsect1>
5185
ad365c5d
YW
5186 <refsect1>
5187 <title>[DeficitRoundRobinSchedulerClass] Section Options</title>
bdac5608
ZJS
5188 <para>The [DeficitRoundRobinSchedulerClass] section manages the traffic control class of Deficit Round
5189 Robin Scheduler (DRR).</para>
ad365c5d
YW
5190
5191 <variablelist class='network-directives'>
f344a492
YW
5192 <xi:include href="tc.xml" xpointer="tclass-parent" />
5193 <xi:include href="tc.xml" xpointer="tclass-classid" />
ad365c5d
YW
5194
5195 <varlistentry>
c03ef420 5196 <term><varname>QuantumBytes=</varname></term>
ad365c5d 5197 <listitem>
c03ef420
YW
5198 <para>Specifies the amount of bytes a flow is allowed to dequeue before the scheduler moves
5199 to the next class. When suffixed with K, M, or G, the specified size is parsed as Kilobytes,
5200 Megabytes, or Gigabytes, respectively, to the base of 1024. Defaults to the MTU of the
5201 interface.</para>
ec07c3c8
AK
5202
5203 <xi:include href="version-info.xml" xpointer="v246"/>
ad365c5d
YW
5204 </listitem>
5205 </varlistentry>
5206
5207 </variablelist>
5208 </refsect1>
5209
d474aa51
YW
5210 <refsect1>
5211 <title>[EnhancedTransmissionSelection] Section Options</title>
bdac5608
ZJS
5212 <para>The [EnhancedTransmissionSelection] section manages the queueing discipline (qdisc) of Enhanced
5213 Transmission Selection (ETS).</para>
d474aa51
YW
5214
5215 <variablelist class='network-directives'>
5216 <xi:include href="tc.xml" xpointer="qdisc-parent" />
5217 <xi:include href="tc.xml" xpointer="qdisc-handle" />
5218
5219 <varlistentry>
5220 <term><varname>Bands=</varname></term>
5221 <listitem>
69978eb9 5222 <para>Specifies the number of bands. An unsigned integer in the range 1…16. This value has to be at
e9dd6984
ZJS
5223 least large enough to cover the strict bands specified through the <varname>StrictBands=</varname>
5224 and bandwidth-sharing bands specified in <varname>QuantumBytes=</varname>.</para>
ec07c3c8
AK
5225
5226 <xi:include href="version-info.xml" xpointer="v246"/>
d474aa51
YW
5227 </listitem>
5228 </varlistentry>
5229
5230 <varlistentry>
5231 <term><varname>StrictBands=</varname></term>
5232 <listitem>
e9dd6984 5233 <para>Specifies the number of bands that should be created in strict mode. An unsigned integer in
69978eb9 5234 the range 1…16.</para>
ec07c3c8
AK
5235
5236 <xi:include href="version-info.xml" xpointer="v246"/>
d474aa51
YW
5237 </listitem>
5238 </varlistentry>
5239
5240 <varlistentry>
5241 <term><varname>QuantumBytes=</varname></term>
5242 <listitem>
5243 <para>Specifies the white-space separated list of quantum used in band-sharing bands. When
5244 suffixed with K, M, or G, the specified size is parsed as Kilobytes, Megabytes, or Gigabytes,
5245 respectively, to the base of 1024. This setting can be specified multiple times. If an empty
5246 string is assigned, then the all previous assignments are cleared.</para>
ec07c3c8
AK
5247
5248 <xi:include href="version-info.xml" xpointer="v246"/>
d474aa51
YW
5249 </listitem>
5250 </varlistentry>
5251
5252 <varlistentry>
5253 <term><varname>PriorityMap=</varname></term>
5254 <listitem>
885a4e6c
ZJS
5255 <para>The priority map maps the priority of a packet to a band. The argument is a whitespace
5256 separated list of numbers. The first number indicates which band the packets with priority 0 should
5257 be put to, the second is for priority 1, and so on. There can be up to 16 numbers in the list. If
5258 there are fewer, the default band that traffic with one of the unmentioned priorities goes to is
1d3a473b 5259 the last one. Each band number must be in the range 0…255. This setting can be specified multiple
885a4e6c 5260 times. If an empty string is assigned, then the all previous assignments are cleared.</para>
ec07c3c8
AK
5261
5262 <xi:include href="version-info.xml" xpointer="v246"/>
d474aa51
YW
5263 </listitem>
5264 </varlistentry>
5265 </variablelist>
5266 </refsect1>
5267
609e8340
SS
5268 <refsect1>
5269 <title>[GenericRandomEarlyDetection] Section Options</title>
bdac5608
ZJS
5270 <para>The [GenericRandomEarlyDetection] section manages the queueing discipline (qdisc) of Generic Random
5271 Early Detection (GRED).</para>
609e8340
SS
5272
5273 <variablelist class='network-directives'>
f344a492
YW
5274 <xi:include href="tc.xml" xpointer="qdisc-parent" />
5275 <xi:include href="tc.xml" xpointer="qdisc-handle" />
609e8340
SS
5276
5277 <varlistentry>
5278 <term><varname>VirtualQueues=</varname></term>
5279 <listitem>
387f6955 5280 <para>Specifies the number of virtual queues. Takes an integer in the range 1…16. Defaults to unset
1d3a473b 5281 and kernel's default is used.</para>
ec07c3c8
AK
5282
5283 <xi:include href="version-info.xml" xpointer="v246"/>
609e8340
SS
5284 </listitem>
5285 </varlistentry>
5286
5287 <varlistentry>
5288 <term><varname>DefaultVirtualQueue=</varname></term>
5289 <listitem>
5290 <para>Specifies the number of default virtual queue. This must be less than <varname>VirtualQueue=</varname>.
5291 Defaults to unset and kernel's default is used.</para>
ec07c3c8
AK
5292
5293 <xi:include href="version-info.xml" xpointer="v246"/>
609e8340
SS
5294 </listitem>
5295 </varlistentry>
5296
5297 <varlistentry>
5298 <term><varname>GenericRIO=</varname></term>
5299 <listitem>
5300 <para>Takes a boolean. It turns on the RIO-like buffering scheme. Defaults to
5301 unset and kernel's default is used.</para>
ec07c3c8
AK
5302
5303 <xi:include href="version-info.xml" xpointer="v246"/>
609e8340
SS
5304 </listitem>
5305 </varlistentry>
5306 </variablelist>
5307 </refsect1>
5308
18de0969
YW
5309 <refsect1>
5310 <title>[FairQueueingControlledDelay] Section Options</title>
bdac5608
ZJS
5311 <para>The [FairQueueingControlledDelay] section manages the queueing discipline (qdisc) of fair queuing
5312 controlled delay (FQ-CoDel).</para>
18de0969
YW
5313
5314 <variablelist class='network-directives'>
f344a492
YW
5315 <xi:include href="tc.xml" xpointer="qdisc-parent" />
5316 <xi:include href="tc.xml" xpointer="qdisc-handle" />
d8b2396d 5317
18de0969
YW
5318 <varlistentry>
5319 <term><varname>PacketLimit=</varname></term>
4e5ef149
SS
5320 <listitem>
5321 <para>Specifies the hard limit on the real queue size. When this limit is reached, incoming packets are
5322 dropped. Defaults to unset and kernel's default is used.</para>
ec07c3c8
AK
5323
5324 <xi:include href="version-info.xml" xpointer="v245"/>
4e5ef149
SS
5325 </listitem>
5326 </varlistentry>
5327
ac810b75 5328 <varlistentry>
c03ef420 5329 <term><varname>MemoryLimitBytes=</varname></term>
ac810b75
YW
5330 <listitem>
5331 <para>Specifies the limit on the total number of bytes that can be queued in this FQ-CoDel instance.
5332 When suffixed with K, M, or G, the specified size is parsed as Kilobytes, Megabytes, or Gigabytes,
5333 respectively, to the base of 1024. Defaults to unset and kernel's default is used.</para>
ec07c3c8
AK
5334
5335 <xi:include href="version-info.xml" xpointer="v246"/>
ac810b75
YW
5336 </listitem>
5337 </varlistentry>
5338
5339 <varlistentry>
18de0969 5340 <term><varname>Flows=</varname></term>
ac810b75
YW
5341 <listitem>
5342 <para>Specifies the number of flows into which the incoming packets are classified.
5343 Defaults to unset and kernel's default is used.</para>
ec07c3c8
AK
5344
5345 <xi:include href="version-info.xml" xpointer="v245"/>
ac810b75
YW
5346 </listitem>
5347 </varlistentry>
5348
5349 <varlistentry>
18de0969 5350 <term><varname>TargetSec=</varname></term>
ac810b75
YW
5351 <listitem>
5352 <para>Takes a timespan. Specifies the acceptable minimum standing/persistent queue delay.
5353 Defaults to unset and kernel's default is used.</para>
ec07c3c8
AK
5354
5355 <xi:include href="version-info.xml" xpointer="v245"/>
ac810b75
YW
5356 </listitem>
5357 </varlistentry>
5358
5359 <varlistentry>
18de0969 5360 <term><varname>IntervalSec=</varname></term>
ac810b75
YW
5361 <listitem>
5362 <para>Takes a timespan. This is used to ensure that the measured minimum delay does not
5363 become too stale. Defaults to unset and kernel's default is used.</para>
ec07c3c8
AK
5364
5365 <xi:include href="version-info.xml" xpointer="v245"/>
ac810b75
YW
5366 </listitem>
5367 </varlistentry>
5368
5369 <varlistentry>
c03ef420 5370 <term><varname>QuantumBytes=</varname></term>
ac810b75 5371 <listitem>
e9dd6984 5372 <para>Specifies the number of bytes used as the "deficit" in the fair queuing algorithm timespan.
ac810b75
YW
5373 When suffixed with K, M, or G, the specified size is parsed as Kilobytes, Megabytes, or Gigabytes,
5374 respectively, to the base of 1024. Defaults to unset and kernel's default is used.</para>
ec07c3c8
AK
5375
5376 <xi:include href="version-info.xml" xpointer="v246"/>
ac810b75
YW
5377 </listitem>
5378 </varlistentry>
5379
5380 <varlistentry>
18de0969 5381 <term><varname>ECN=</varname></term>
ac810b75
YW
5382 <listitem>
5383 <para>Takes a boolean. This can be used to mark packets instead of dropping them. Defaults to
5384 unset and kernel's default is used.</para>
ec07c3c8
AK
5385
5386 <xi:include href="version-info.xml" xpointer="v245"/>
ac810b75
YW
5387 </listitem>
5388 </varlistentry>
5389
5390 <varlistentry>
18de0969 5391 <term><varname>CEThresholdSec=</varname></term>
ac810b75
YW
5392 <listitem>
5393 <para>Takes a timespan. This sets a threshold above which all packets are marked with ECN
5394 Congestion Experienced (CE). Defaults to unset and kernel's default is used.</para>
ec07c3c8
AK
5395
5396 <xi:include href="version-info.xml" xpointer="v245"/>
ac810b75
YW
5397 </listitem>
5398 </varlistentry>
18de0969
YW
5399 </variablelist>
5400 </refsect1>
5401
5402 <refsect1>
ca58d00c 5403 <title>[FairQueueing] Section Options</title>
bdac5608
ZJS
5404 <para>The [FairQueueing] section manages the queueing discipline (qdisc) of fair queue traffic policing
5405 (FQ).</para>
18de0969
YW
5406
5407 <variablelist class='network-directives'>
f344a492
YW
5408 <xi:include href="tc.xml" xpointer="qdisc-parent" />
5409 <xi:include href="tc.xml" xpointer="qdisc-handle" />
d8b2396d 5410
7234b915 5411 <varlistentry>
18de0969 5412 <term><varname>PacketLimit=</varname></term>
7234b915
SS
5413 <listitem>
5414 <para>Specifies the hard limit on the real queue size. When this limit is reached, incoming packets are
5415 dropped. Defaults to unset and kernel's default is used.</para>
ec07c3c8
AK
5416
5417 <xi:include href="version-info.xml" xpointer="v245"/>
7234b915
SS
5418 </listitem>
5419 </varlistentry>
5420
e83562e5 5421 <varlistentry>
18de0969 5422 <term><varname>FlowLimit=</varname></term>
e83562e5
YW
5423 <listitem>
5424 <para>Specifies the hard limit on the maximum number of packets queued per flow. Defaults to
5425 unset and kernel's default is used.</para>
ec07c3c8
AK
5426
5427 <xi:include href="version-info.xml" xpointer="v245"/>
e83562e5
YW
5428 </listitem>
5429 </varlistentry>
5430
5431 <varlistentry>
c03ef420 5432 <term><varname>QuantumBytes=</varname></term>
e83562e5
YW
5433 <listitem>
5434 <para>Specifies the credit per dequeue RR round, i.e. the amount of bytes a flow is allowed
5435 to dequeue at once. When suffixed with K, M, or G, the specified size is parsed as Kilobytes,
5436 Megabytes, or Gigabytes, respectively, to the base of 1024. Defaults to unset and kernel's
5437 default is used.</para>
ec07c3c8
AK
5438
5439 <xi:include href="version-info.xml" xpointer="v246"/>
e83562e5
YW
5440 </listitem>
5441 </varlistentry>
5442
5443 <varlistentry>
c03ef420 5444 <term><varname>InitialQuantumBytes=</varname></term>
e83562e5
YW
5445 <listitem>
5446 <para>Specifies the initial sending rate credit, i.e. the amount of bytes a new flow is
5447 allowed to dequeue initially. When suffixed with K, M, or G, the specified size is parsed as
5448 Kilobytes, Megabytes, or Gigabytes, respectively, to the base of 1024. Defaults to unset and
5449 kernel's default is used.</para>
ec07c3c8 5450
aefdc112 5451 <xi:include href="version-info.xml" xpointer="v245"/>
e83562e5
YW
5452 </listitem>
5453 </varlistentry>
5454
5455 <varlistentry>
18de0969 5456 <term><varname>MaximumRate=</varname></term>
e83562e5
YW
5457 <listitem>
5458 <para>Specifies the maximum sending rate of a flow. When suffixed with K, M, or G, the
6b8fe4c3 5459 specified size is parsed as Kilobits, Megabits, or Gigabits, respectively, to the base of
e83562e5 5460 1000. Defaults to unset and kernel's default is used.</para>
ec07c3c8
AK
5461
5462 <xi:include href="version-info.xml" xpointer="v245"/>
e83562e5
YW
5463 </listitem>
5464 </varlistentry>
5465
5466 <varlistentry>
18de0969 5467 <term><varname>Buckets=</varname></term>
e83562e5
YW
5468 <listitem>
5469 <para>Specifies the size of the hash table used for flow lookups. Defaults to unset and
5470 kernel's default is used.</para>
ec07c3c8
AK
5471
5472 <xi:include href="version-info.xml" xpointer="v245"/>
e83562e5
YW
5473 </listitem>
5474 </varlistentry>
5475
5476 <varlistentry>
18de0969 5477 <term><varname>OrphanMask=</varname></term>
e83562e5
YW
5478 <listitem>
5479 <para>Takes an unsigned integer. For packets not owned by a socket, fq is able to mask a part
5480 of hash and reduce number of buckets associated with the traffic. Defaults to unset and
5481 kernel's default is used.</para>
ec07c3c8
AK
5482
5483 <xi:include href="version-info.xml" xpointer="v245"/>
e83562e5
YW
5484 </listitem>
5485 </varlistentry>
5486
5487 <varlistentry>
18de0969 5488 <term><varname>Pacing=</varname></term>
e83562e5
YW
5489 <listitem>
5490 <para>Takes a boolean, and enables or disables flow pacing. Defaults to unset and kernel's
5491 default is used.</para>
ec07c3c8
AK
5492
5493 <xi:include href="version-info.xml" xpointer="v245"/>
e83562e5
YW
5494 </listitem>
5495 </varlistentry>
5496
5497 <varlistentry>
18de0969 5498 <term><varname>CEThresholdSec=</varname></term>
e83562e5
YW
5499 <listitem>
5500 <para>Takes a timespan. This sets a threshold above which all packets are marked with ECN
5501 Congestion Experienced (CE). Defaults to unset and kernel's default is used.</para>
ec07c3c8
AK
5502
5503 <xi:include href="version-info.xml" xpointer="v245"/>
e83562e5
YW
5504 </listitem>
5505 </varlistentry>
0f5bd7fe
SS
5506 </variablelist>
5507 </refsect1>
5508
9b749c11
YW
5509 <refsect1>
5510 <title>[TrivialLinkEqualizer] Section Options</title>
bdac5608
ZJS
5511 <para>The [TrivialLinkEqualizer] section manages the queueing discipline (qdisc) of trivial link
5512 equalizer (teql).</para>
9b749c11
YW
5513
5514 <variablelist class='network-directives'>
f344a492
YW
5515 <xi:include href="tc.xml" xpointer="qdisc-parent" />
5516 <xi:include href="tc.xml" xpointer="qdisc-handle" />
d8b2396d 5517
9b749c11
YW
5518 <varlistentry>
5519 <term><varname>Id=</varname></term>
5520 <listitem>
5521 <para>Specifies the interface ID <literal>N</literal> of teql. Defaults to <literal>0</literal>.
5522 Note that when teql is used, currently, the module <constant>sch_teql</constant> with
5523 <constant>max_equalizers=N+1</constant> option must be loaded before
5524 <command>systemd-networkd</command> is started.</para>
ec07c3c8
AK
5525
5526 <xi:include href="version-info.xml" xpointer="v245"/>
9b749c11
YW
5527 </listitem>
5528 </varlistentry>
5529 </variablelist>
5530 </refsect1>
5531
b934ac3d
YW
5532 <refsect1>
5533 <title>[HierarchyTokenBucket] Section Options</title>
bdac5608
ZJS
5534 <para>The [HierarchyTokenBucket] section manages the queueing discipline (qdisc) of hierarchy token
5535 bucket (htb).</para>
b934ac3d
YW
5536
5537 <variablelist class='network-directives'>
f344a492
YW
5538 <xi:include href="tc.xml" xpointer="qdisc-parent" />
5539 <xi:include href="tc.xml" xpointer="qdisc-handle" />
b934ac3d
YW
5540
5541 <varlistentry>
5542 <term><varname>DefaultClass=</varname></term>
5543 <listitem>
5544 <para>Takes the minor id in hexadecimal of the default class. Unclassified traffic gets sent
5545 to the class. Defaults to unset.</para>
ec07c3c8
AK
5546
5547 <xi:include href="version-info.xml" xpointer="v246"/>
b934ac3d
YW
5548 </listitem>
5549 </varlistentry>
d9eacc1c
YW
5550
5551 <varlistentry>
5552 <term><varname>RateToQuantum=</varname></term>
5553 <listitem>
5554 <para>Takes an unsigned integer. The DRR quantums are calculated by dividing the value
5555 configured in <varname>Rate=</varname> by <varname>RateToQuantum=</varname>.</para>
ec07c3c8
AK
5556
5557 <xi:include href="version-info.xml" xpointer="v246"/>
d9eacc1c
YW
5558 </listitem>
5559 </varlistentry>
b934ac3d
YW
5560 </variablelist>
5561 </refsect1>
5562
19f86a63
YW
5563 <refsect1>
5564 <title>[HierarchyTokenBucketClass] Section Options</title>
bdac5608
ZJS
5565 <para>The [HierarchyTokenBucketClass] section manages the traffic control class of hierarchy token bucket
5566 (htb).</para>
19f86a63
YW
5567
5568 <variablelist class='network-directives'>
f344a492
YW
5569 <xi:include href="tc.xml" xpointer="tclass-parent" />
5570 <xi:include href="tc.xml" xpointer="tclass-classid" />
19f86a63
YW
5571
5572 <varlistentry>
5573 <term><varname>Priority=</varname></term>
5574 <listitem>
5575 <para>Specifies the priority of the class. In the round-robin process, classes with the lowest
d9eacc1c 5576 priority field are tried for packets first.</para>
ec07c3c8
AK
5577
5578 <xi:include href="version-info.xml" xpointer="v246"/>
d9eacc1c
YW
5579 </listitem>
5580 </varlistentry>
5581
5582 <varlistentry>
5583 <term><varname>QuantumBytes=</varname></term>
5584 <listitem>
5585 <para>Specifies how many bytes to serve from leaf at once. When suffixed with K, M, or G, the
5586 specified size is parsed as Kilobytes, Megabytes, or Gigabytes, respectively, to the base of
5587 1024.</para>
ec07c3c8
AK
5588
5589 <xi:include href="version-info.xml" xpointer="v246"/>
d9eacc1c
YW
5590 </listitem>
5591 </varlistentry>
5592
5593 <varlistentry>
5594 <term><varname>MTUBytes=</varname></term>
5595 <listitem>
5596 <para>Specifies the maximum packet size we create. When suffixed with K, M, or G, the specified
5597 size is parsed as Kilobytes, Megabytes, or Gigabytes, respectively, to the base of 1024.</para>
ec07c3c8
AK
5598
5599 <xi:include href="version-info.xml" xpointer="v246"/>
d9eacc1c
YW
5600 </listitem>
5601 </varlistentry>
5602
5603 <varlistentry>
5604 <term><varname>OverheadBytes=</varname></term>
5605 <listitem>
5606 <para>Takes an unsigned integer which specifies per-packet size overhead used in rate
5607 computations. When suffixed with K, M, or G, the specified size is parsed as Kilobytes,
5608 Megabytes, or Gigabytes, respectively, to the base of 1024.</para>
ec07c3c8
AK
5609
5610 <xi:include href="version-info.xml" xpointer="v246"/>
19f86a63
YW
5611 </listitem>
5612 </varlistentry>
5613
5614 <varlistentry>
5615 <term><varname>Rate=</varname></term>
5616 <listitem>
5617 <para>Specifies the maximum rate this class and all its children are guaranteed. When suffixed
5618 with K, M, or G, the specified size is parsed as Kilobits, Megabits, or Gigabits, respectively,
5619 to the base of 1000. This setting is mandatory.</para>
ec07c3c8
AK
5620
5621 <xi:include href="version-info.xml" xpointer="v246"/>
19f86a63
YW
5622 </listitem>
5623 </varlistentry>
5624
5625 <varlistentry>
5626 <term><varname>CeilRate=</varname></term>
5627 <listitem>
5628 <para>Specifies the maximum rate at which a class can send, if its parent has bandwidth to spare.
5629 When suffixed with K, M, or G, the specified size is parsed as Kilobits, Megabits, or Gigabits,
5630 respectively, to the base of 1000. When unset, the value specified with <varname>Rate=</varname>
5631 is used.</para>
ec07c3c8
AK
5632
5633 <xi:include href="version-info.xml" xpointer="v246"/>
19f86a63
YW
5634 </listitem>
5635 </varlistentry>
d9eacc1c
YW
5636
5637 <varlistentry>
5638 <term><varname>BufferBytes=</varname></term>
5639 <listitem>
5640 <para>Specifies the maximum bytes burst which can be accumulated during idle period. When suffixed
5641 with K, M, or G, the specified size is parsed as Kilobytes, Megabytes, or Gigabytes, respectively,
5642 to the base of 1024.</para>
ec07c3c8
AK
5643
5644 <xi:include href="version-info.xml" xpointer="v246"/>
d9eacc1c
YW
5645 </listitem>
5646 </varlistentry>
5647
5648 <varlistentry>
5649 <term><varname>CeilBufferBytes=</varname></term>
5650 <listitem>
5651 <para>Specifies the maximum bytes burst for ceil which can be accumulated during idle period.
5652 When suffixed with K, M, or G, the specified size is parsed as Kilobytes, Megabytes, or Gigabytes,
5653 respectively, to the base of 1024.</para>
ec07c3c8
AK
5654
5655 <xi:include href="version-info.xml" xpointer="v246"/>
d9eacc1c
YW
5656 </listitem>
5657 </varlistentry>
7f224020
SS
5658 </variablelist>
5659 </refsect1>
5660
5661 <refsect1>
5662 <title>[HeavyHitterFilter] Section Options</title>
bdac5608
ZJS
5663 <para>The [HeavyHitterFilter] section manages the queueing discipline (qdisc) of Heavy Hitter Filter
5664 (hhf).</para>
7f224020
SS
5665
5666 <variablelist class='network-directives'>
f344a492
YW
5667 <xi:include href="tc.xml" xpointer="qdisc-parent" />
5668 <xi:include href="tc.xml" xpointer="qdisc-handle" />
19f86a63 5669
7f224020
SS
5670 <varlistentry>
5671 <term><varname>PacketLimit=</varname></term>
5672 <listitem>
e9dd6984 5673 <para>Specifies the hard limit on the queue size in number of packets. When this limit is reached,
69978eb9 5674 incoming packets are dropped. An unsigned integer in the range 0…4294967294. Defaults to unset and
e9dd6984 5675 kernel's default is used.</para>
ec07c3c8
AK
5676
5677 <xi:include href="version-info.xml" xpointer="v246"/>
7f224020
SS
5678 </listitem>
5679 </varlistentry>
19f86a63
YW
5680 </variablelist>
5681 </refsect1>
5682
b12aaee5
SS
5683 <refsect1>
5684 <title>[QuickFairQueueing] Section Options</title>
bdac5608
ZJS
5685 <para>The [QuickFairQueueing] section manages the queueing discipline (qdisc) of Quick Fair Queueing
5686 (QFQ).</para>
b12aaee5
SS
5687
5688 <variablelist class='network-directives'>
5689 <xi:include href="tc.xml" xpointer="qdisc-parent" />
5690 <xi:include href="tc.xml" xpointer="qdisc-handle" />
5691 </variablelist>
5692 </refsect1>
5693
4d7ddaf9
YW
5694 <refsect1>
5695 <title>[QuickFairQueueingClass] Section Options</title>
bdac5608
ZJS
5696 <para>The [QuickFairQueueingClass] section manages the traffic control class of Quick Fair Queueing
5697 (qfq).</para>
4d7ddaf9
YW
5698
5699 <variablelist class='network-directives'>
5700 <xi:include href="tc.xml" xpointer="tclass-parent" />
5701 <xi:include href="tc.xml" xpointer="tclass-classid" />
5702
5703 <varlistentry>
5704 <term><varname>Weight=</varname></term>
5705 <listitem>
1d3a473b 5706 <para>Specifies the weight of the class. Takes an integer in the range 1…1023. Defaults to
4d7ddaf9 5707 unset in which case the kernel default is used.</para>
ec07c3c8
AK
5708
5709 <xi:include href="version-info.xml" xpointer="v246"/>
4d7ddaf9
YW
5710 </listitem>
5711 </varlistentry>
5712
5713 <varlistentry>
c03ef420 5714 <term><varname>MaxPacketBytes=</varname></term>
4d7ddaf9 5715 <listitem>
75909cc7
ZJS
5716 <para>Specifies the maximum packet size in bytes for the class. When suffixed with K, M, or G, the
5717 specified size is parsed as Kilobytes, Megabytes, or Gigabytes, respectively, to the base of
5718 1024. When unset, the kernel default is used.</para>
ec07c3c8
AK
5719
5720 <xi:include href="version-info.xml" xpointer="v246"/>
4d7ddaf9
YW
5721 </listitem>
5722 </varlistentry>
5723 </variablelist>
5724 </refsect1>
5725
13b498f9
TJ
5726 <refsect1>
5727 <title>[BridgeVLAN] Section Options</title>
bdac5608
ZJS
5728 <para>The [BridgeVLAN] section manages the VLAN ID configuration of a bridge port and accepts the
5729 following keys. Specify several [BridgeVLAN] sections to configure several VLAN entries. The
5730 <varname>VLANFiltering=</varname> option has to be enabled, see the [Bridge] section in
13b498f9
TJ
5731 <citerefentry><refentrytitle>systemd.netdev</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para>
5732
5733 <variablelist class='network-directives'>
5734 <varlistentry>
5735 <term><varname>VLAN=</varname></term>
5736 <listitem>
69978eb9
YW
5737 <para>The VLAN ID allowed on the port. This can be either a single ID or a range M-N. Takes
5738 an integer in the range 1…4094.</para>
aefdc112
AK
5739
5740 <xi:include href="version-info.xml" xpointer="v231"/>
13b498f9
TJ
5741 </listitem>
5742 </varlistentry>
5743 <varlistentry>
5744 <term><varname>EgressUntagged=</varname></term>
5745 <listitem>
5746 <para>The VLAN ID specified here will be used to untag frames on egress. Configuring
5747 <varname>EgressUntagged=</varname> implicates the use of <varname>VLAN=</varname> above and will enable the
5748 VLAN ID for ingress as well. This can be either a single ID or a range M-N.</para>
ec07c3c8
AK
5749
5750 <xi:include href="version-info.xml" xpointer="v231"/>
13b498f9
TJ
5751 </listitem>
5752 </varlistentry>
5753 <varlistentry>
5754 <term><varname>PVID=</varname></term>
5755 <listitem>
5756 <para>The Port VLAN ID specified here is assigned to all untagged frames at ingress.
5757 <varname>PVID=</varname> can be used only once. Configuring <varname>PVID=</varname> implicates the use of
5758 <varname>VLAN=</varname> above and will enable the VLAN ID for ingress as well.</para>
ec07c3c8
AK
5759
5760 <xi:include href="version-info.xml" xpointer="v231"/>
13b498f9
TJ
5761 </listitem>
5762 </varlistentry>
5763 </variablelist>
5764 </refsect1>
798d3a52
ZJS
5765
5766 <refsect1>
9e35b3de 5767 <title>Examples</title>
798d3a52 5768 <example>
9e35b3de 5769 <title>Static network configuration</title>
798d3a52 5770
9e35b3de
ZJS
5771 <programlisting># /etc/systemd/network/50-static.network
5772[Match]
eac684ef
TG
5773Name=enp2s0
5774
5775[Network]
5776Address=192.168.0.15/24
5777Gateway=192.168.0.1</programlisting>
9e35b3de
ZJS
5778
5779 <para>This brings interface <literal>enp2s0</literal> up with a static address. The
5780 specified gateway will be used for a default route.</para>
798d3a52 5781 </example>
eac684ef 5782
798d3a52 5783 <example>
9e35b3de 5784 <title>DHCP on ethernet links</title>
eac684ef 5785
9e35b3de
ZJS
5786 <programlisting># /etc/systemd/network/80-dhcp.network
5787[Match]
eac684ef
TG
5788Name=en*
5789
5790[Network]
9c8ca3f7 5791DHCP=yes</programlisting>
9e35b3de
ZJS
5792
5793 <para>This will enable DHCPv4 and DHCPv6 on all interfaces with names starting with
5794 <literal>en</literal> (i.e. ethernet interfaces).</para>
798d3a52 5795 </example>
eac684ef 5796
4c94a4c2 5797 <example>
d4579825 5798 <title>IPv6 Prefix Delegation (DHCPv6 PD)</title>
4c94a4c2 5799
d4579825 5800 <programlisting># /etc/systemd/network/55-dhcpv6-pd-upstream.network
4c94a4c2 5801[Match]
5802Name=enp1s0
5803
5804[Network]
d4579825 5805DHCP=ipv6
4c94a4c2 5806
d4579825
YW
5807# The below setting is optional, to also assign an address in the delegated prefix
5808# to the upstream interface. If not necessary, then comment out the line below and
5809# the [DHCPPrefixDelegation] section.
5810DHCPPrefixDelegation=yes
5811
5812# If the upstream network provides Router Advertisement with Managed bit set,
5813# then comment out the line below and WithoutRA= setting in the [DHCPv6] section.
5814IPv6AcceptRA=no
5815
5816[DHCPv6]
5817WithoutRA=solicit
5818
5819[DHCPPrefixDelegation]
5820UplinkInterface=:self
5821SubnetId=0
5822Announce=no</programlisting>
5823
5824 <programlisting># /etc/systemd/network/55-dhcpv6-pd-downstream.network
4c94a4c2 5825[Match]
5826Name=enp2s0
5827
5828[Network]
d4579825 5829DHCPPrefixDelegation=yes
e5ff2245 5830IPv6SendRA=yes
d4579825
YW
5831
5832# It is expected that the host is acting as a router. So, usually it is not
5833# necessary to receive Router Advertisement from other hosts in the downstream network.
5834IPv6AcceptRA=no
5835
5836[DHCPPrefixDelegation]
5837UplinkInterface=enp1s0
5838SubnetId=1
5839Announce=yes</programlisting>
4c94a4c2 5840
e5ff2245
YW
5841 <para>This will enable DHCPv6-PD on the interface enp1s0 as an upstream interface where the
5842 DHCPv6 client is running and enp2s0 as a downstream interface where the prefix is delegated to.
5843 The delegated prefixes are distributed by IPv6 Router Advertisement on the downstream network.
5844 </para>
4c94a4c2 5845 </example>
5846
d4579825
YW
5847 <example>
5848 <title>IPv6 Prefix Delegation (DHCPv4 6RD)</title>
5849
5850 <programlisting># /etc/systemd/network/55-dhcpv4-6rd-upstream.network
5851[Match]
5852Name=enp1s0
5853
5854[Network]
5855DHCP=ipv4
5856
5857# When DHCPv4-6RD is used, the upstream network does not support IPv6.
5858# Hence, it is not necessary to wait for Router Advertisement, which is enabled by default.
5859IPv6AcceptRA=no
5860
5861[DHCPv4]
5862Use6RD=yes</programlisting>
5863
5864 <programlisting># /etc/systemd/network/55-dhcpv4-6rd-downstream.network
5865[Match]
5866Name=enp2s0
5867
5868[Network]
5869DHCPPrefixDelegation=yes
5870IPv6SendRA=yes
5871
5872# It is expected that the host is acting as a router. So, usually it is not
5873# necessary to receive Router Advertisement from other hosts in the downstream network.
5874IPv6AcceptRA=no
5875
5876[DHCPPrefixDelegation]
5877UplinkInterface=enp1s0
5878SubnetId=1
5879Announce=yes</programlisting>
5880
5881 <para>This will enable DHCPv4-6RD on the interface enp1s0 as an upstream interface where the
5882 DHCPv4 client is running and enp2s0 as a downstream interface where the prefix is delegated to.
5883 The delegated prefixes are distributed by IPv6 Router Advertisement on the downstream network.
5884 </para>
5885 </example>
5886
798d3a52 5887 <example>
9e35b3de 5888 <title>A bridge with two enslaved links</title>
f47c5c47 5889
bc33789a
JB
5890 <programlisting># /etc/systemd/network/25-bridge-static.netdev
5891[NetDev]
5892Name=bridge0
5893Kind=bridge</programlisting>
5894
9e35b3de
ZJS
5895 <programlisting># /etc/systemd/network/25-bridge-static.network
5896[Match]
f47c5c47 5897Name=bridge0
5898
5899[Network]
5900Address=192.168.0.15/24
5901Gateway=192.168.0.1
5902DNS=192.168.0.1</programlisting>
f47c5c47 5903
9e35b3de
ZJS
5904 <programlisting># /etc/systemd/network/25-bridge-slave-interface-1.network
5905[Match]
f47c5c47 5906Name=enp2s0
5907
5908[Network]
5909Bridge=bridge0</programlisting>
9e35b3de
ZJS
5910
5911 <programlisting># /etc/systemd/network/25-bridge-slave-interface-2.network
5912[Match]
5913Name=wlp3s0
5914
5915[Network]
5916Bridge=bridge0</programlisting>
5917
5918 <para>This creates a bridge and attaches devices <literal>enp2s0</literal> and
5919 <literal>wlp3s0</literal> to it. The bridge will have the specified static address
5920 and network assigned, and a default route via the specified gateway will be
5921 added. The specified DNS server will be added to the global list of DNS resolvers.
5922 </para>
13b498f9 5923 </example>
9e35b3de 5924
13b498f9 5925 <example>
55ac274e 5926 <title>Bridge port with VLAN forwarding</title>
13b498f9 5927
9e35b3de 5928 <programlisting>
55ac274e 5929# /etc/systemd/network/25-bridge-slave-interface-1.network
9e35b3de 5930[Match]
13b498f9
TJ
5931Name=enp2s0
5932
5933[Network]
5934Bridge=bridge0
5935
5936[BridgeVLAN]
5937VLAN=1-32
5938PVID=42
5939EgressUntagged=42
5940
5941[BridgeVLAN]
5942VLAN=100-200
5943
5944[BridgeVLAN]
5945EgressUntagged=300-400</programlisting>
0a8a0fad 5946
9e35b3de
ZJS
5947 <para>This overrides the configuration specified in the previous example for the
5948 interface <literal>enp2s0</literal>, and enables VLAN on that bridge port. VLAN IDs
5949 1-32, 42, 100-400 will be allowed. Packets tagged with VLAN IDs 42, 300-400 will be
5950 untagged when they leave on this interface. Untagged packets which arrive on this
5951 interface will be assigned VLAN ID 42.</para>
798d3a52 5952 </example>
0a8a0fad 5953
798d3a52 5954 <example>
9e35b3de 5955 <title>Various tunnels</title>
0a8a0fad 5956
9e35b3de
ZJS
5957 <programlisting>/etc/systemd/network/25-tunnels.network
5958[Match]
5959Name=ens1
0a8a0fad
TG
5960
5961[Network]
9e35b3de
ZJS
5962Tunnel=ipip-tun
5963Tunnel=sit-tun
5964Tunnel=gre-tun
5965Tunnel=vti-tun
5966 </programlisting>
5967
5968 <programlisting>/etc/systemd/network/25-tunnel-ipip.netdev
5969[NetDev]
5970Name=ipip-tun
5971Kind=ipip
5972 </programlisting>
5973
5974 <programlisting>/etc/systemd/network/25-tunnel-sit.netdev
5975[NetDev]
5976Name=sit-tun
5977Kind=sit
5978 </programlisting>
5979
5980 <programlisting>/etc/systemd/network/25-tunnel-gre.netdev
5981[NetDev]
5982Name=gre-tun
5983Kind=gre
5984 </programlisting>
5985
5986 <programlisting>/etc/systemd/network/25-tunnel-vti.netdev
5987[NetDev]
5988Name=vti-tun
5989Kind=vti
5990 </programlisting>
5991
5992 <para>This will bring interface <literal>ens1</literal> up and create an IPIP tunnel,
5993 a SIT tunnel, a GRE tunnel, and a VTI tunnel using it.</para>
798d3a52 5994 </example>
0a8a0fad 5995
798d3a52 5996 <example>
9e35b3de 5997 <title>A bond device</title>
0a8a0fad 5998
9e35b3de
ZJS
5999 <programlisting># /etc/systemd/network/30-bond1.network
6000[Match]
6001Name=bond1
0a8a0fad
TG
6002
6003[Network]
9e35b3de
ZJS
6004DHCP=ipv6
6005</programlisting>
0a8a0fad 6006
9e35b3de
ZJS
6007 <programlisting># /etc/systemd/network/30-bond1.netdev
6008[NetDev]
6009Name=bond1
6010Kind=bond
6011</programlisting>
0a8a0fad 6012
301a21a8 6013 <programlisting># /etc/systemd/network/30-bond1-dev1.network
9e35b3de
ZJS
6014[Match]
6015MACAddress=52:54:00:e9:64:41
0a8a0fad
TG
6016
6017[Network]
9e35b3de
ZJS
6018Bond=bond1
6019</programlisting>
d94facdc 6020
301a21a8 6021 <programlisting># /etc/systemd/network/30-bond1-dev2.network
9e35b3de
ZJS
6022[Match]
6023MACAddress=52:54:00:e9:64:42
d94facdc
MH
6024
6025[Network]
9e35b3de 6026Bond=bond1
6cb955c6 6027</programlisting>
9e35b3de
ZJS
6028
6029 <para>This will create a bond device <literal>bond1</literal> and enslave the two
6030 devices with MAC addresses 52:54:00:e9:64:41 and 52:54:00:e9:64:42 to it. IPv6 DHCP
6031 will be used to acquire an address.</para>
6cb955c6
AR
6032 </example>
6033
6034 <example>
9e35b3de
ZJS
6035 <title>Virtual Routing and Forwarding (VRF)</title>
6036 <para>Add the <literal>bond1</literal> interface to the VRF master interface
6037 <literal>vrf1</literal>. This will redirect routes generated on this interface to be
11d38b90
AR
6038 within the routing table defined during VRF creation. For kernels before 4.8 traffic
6039 won't be redirected towards the VRFs routing table unless specific ip-rules are added.
6040 </para>
9e35b3de
ZJS
6041 <programlisting># /etc/systemd/network/25-vrf.network
6042[Match]
6cb955c6
AR
6043Name=bond1
6044
6045[Network]
9e35b3de 6046VRF=vrf1
d94facdc
MH
6047</programlisting>
6048 </example>
6049
42125eda
SS
6050 <example>
6051 <title>MacVTap</title>
6052 <para>This brings up a network interface <literal>macvtap-test</literal>
6053 and attaches it to <literal>enp0s25</literal>.</para>
83ddf5d3 6054 <programlisting># /usr/lib/systemd/network/25-macvtap.network
42125eda
SS
6055[Match]
6056Name=enp0s25
6057
6058[Network]
6059MACVTAP=macvtap-test
6060</programlisting>
6061 </example>
98d20a17 6062
6063 <example>
6064 <title>A Xfrm interface with physical underlying device.</title>
6065
6066 <programlisting># /etc/systemd/network/27-xfrm.netdev
6067[NetDev]
6068Name=xfrm0
0d03e672 6069Kind=xfrm
98d20a17 6070
6071[Xfrm]
6072InterfaceId=7</programlisting>
6073
6074 <programlisting># /etc/systemd/network/27-eth0.network
6075[Match]
6076Name=eth0
6077
6078[Network]
6079Xfrm=xfrm0</programlisting>
6080
6081 <para>This creates a <literal>xfrm0</literal> interface and binds it to the <literal>eth0</literal> device.
6082 This allows hardware based ipsec offloading to the <literal>eth0</literal> nic.
6083 If offloading is not needed, xfrm interfaces can be assigned to the <literal>lo</literal> device.
6084 </para>
6085 </example>
798d3a52
ZJS
6086 </refsect1>
6087
6088 <refsect1>
6089 <title>See Also</title>
6090 <para>
6091 <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
f41b446a 6092 <citerefentry><refentrytitle>systemd-networkd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
798d3a52 6093 <citerefentry><refentrytitle>systemd.link</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
aaa297d4 6094 <citerefentry><refentrytitle>systemd.netdev</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
cc9b6bdc 6095 <citerefentry><refentrytitle>systemd-network-generator.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
aaa297d4 6096 <citerefentry><refentrytitle>systemd-resolved.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>
798d3a52
ZJS
6097 </para>
6098 </refsect1>
eac684ef
TG
6099
6100</refentry>