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