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