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