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