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