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