]> git.ipfire.org Git - thirdparty/systemd.git/blame - man/systemd.network.xml
network: fix DHCPv6 Prefix Delegation example after option rename
[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">
0307f791 4<!-- SPDX-License-Identifier: LGPL-2.1+ -->
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
d4de2b2a
ZJS
31 <para>A plain ini-style text file that encodes network configuration for matching network interfaces,
32 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
44 <filename>/etc/systemd/network</filename>. All configuration files are collectively sorted and processed
45 in lexical order, regardless of the directories in which they live. However, files with identical
46 filenames replace each other. Files in <filename>/etc</filename> have the highest priority, files in
47 <filename>/run</filename> take precedence over files with the same name under
48 <filename>/usr</filename>. This can be used to override a system-supplied configuration file with a local
49 file if needed. As a special case, an empty file (file size 0) or symlink with the same name pointing to
50 <filename>/dev/null</filename> disables the configuration file entirely (it is "masked").</para>
bac150e9
ZJS
51
52 <para>Along with the network file <filename>foo.network</filename>, a "drop-in" directory
53 <filename>foo.network.d/</filename> may exist. All files with the suffix
54 <literal>.conf</literal> from this directory will be parsed after the file itself is
55 parsed. This is useful to alter or add configuration settings, without having to modify the main
56 configuration file. Each drop-in file must have appropriate section headers.</para>
57
58 <para>In addition to <filename>/etc/systemd/network</filename>, drop-in <literal>.d</literal>
59 directories can be placed in <filename>/usr/lib/systemd/network</filename> or
60 <filename>/run/systemd/network</filename> directories. Drop-in files in
61 <filename>/etc</filename> take precedence over those in <filename>/run</filename> which in turn
62 take precedence over those in <filename>/usr/lib</filename>. Drop-in files under any of these
b1e91af8 63 directories take precedence over the main network file wherever located.</para>
bac150e9
ZJS
64
65 <para>Note that an interface without any static IPv6 addresses configured, and neither DHCPv6
66 nor IPv6LL enabled, shall be considered to have no IPv6 support. IPv6 will be automatically
67 disabled for that interface by writing "1" to
68 <filename>/proc/sys/net/ipv6/conf/<replaceable>ifname</replaceable>/disable_ipv6</filename>.
82ecb4c3 69 </para>
798d3a52
ZJS
70 </refsect1>
71
72 <refsect1>
73 <title>[Match] Section Options</title>
74
bdac5608
ZJS
75 <para>The network file contains a [Match] section, which determines if a given network file may be
76 applied to a given device; and a [Network] section specifying how the device should be configured. The
77 first (in lexical order) of the network files that matches a given device is applied, all later files
78 are ignored, even if they match as well.</para>
79
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 the
82 file will match all interfaces and <command>systemd-networkd</command> warns about that. Hint: to avoid
83 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>
798d3a52
ZJS
85
86 <variablelist class='network-directives'>
d9b20454
ZJS
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" />
92 <xi:include href="systemd.link.xml" xpointer="property" />
9310bf4b 93
798d3a52
ZJS
94 <varlistentry>
95 <term><varname>Name=</varname></term>
96 <listitem>
572b21d9
YW
97 <para>A whitespace-separated list of shell-style globs matching the device name, as exposed
98 by the udev property <literal>INTERFACE</literal>, or device's alternative names. If the
99 list is prefixed with a "!", the test is inverted.</para>
798d3a52
ZJS
100 </listitem>
101 </varlistentry>
44005bfb 102
78404d22 103 <varlistentry>
1bcefad9 104 <term><varname>WLANInterfaceType=</varname></term>
78404d22
YW
105 <listitem>
106 <para>A whitespace-separated list of wireless network type. Supported values are
107 <literal>ad-hoc</literal>, <literal>station</literal>, <literal>ap</literal>,
108 <literal>ap-vlan</literal>, <literal>wds</literal>, <literal>monitor</literal>,
109 <literal>mesh-point</literal>, <literal>p2p-client</literal>, <literal>p2p-go</literal>,
110 <literal>p2p-device</literal>, <literal>ocb</literal>, and <literal>nan</literal>. If the
111 list is prefixed with a "!", the test is inverted.
112 </para>
113 </listitem>
114 </varlistentry>
d9b20454 115
8d968fdd
YW
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.
121 </para>
122 </listitem>
123 </varlistentry>
d9b20454 124
277ba8d1
YW
125 <varlistentry>
126 <term><varname>BSSID=</varname></term>
127 <listitem>
128 <para>A whitespace-separated list of hardware address of the currently connected wireless
129 LAN. Use full colon-, hyphen- or dot-delimited hexadecimal. See the example in
e9dd6984
ZJS
130 <varname>MACAddress=</varname>. This option may appear more than once, in which case the
131 lists are merged. If the empty string is assigned to this option, the list is reset.</para>
277ba8d1
YW
132 </listitem>
133 </varlistentry>
d9b20454
ZJS
134
135 <xi:include href="systemd.link.xml" xpointer="host" />
136 <xi:include href="systemd.link.xml" xpointer="virtualization" />
137 <xi:include href="systemd.link.xml" xpointer="kernel-command-line" />
138 <xi:include href="systemd.link.xml" xpointer="kernel-version" />
139 <xi:include href="systemd.link.xml" xpointer="architecture" />
798d3a52
ZJS
140 </variablelist>
141
142 </refsect1>
143
144 <refsect1>
145 <title>[Link] Section Options</title>
146
bdac5608 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>
156 <varlistentry>
157 <term><varname>MTUBytes=</varname></term>
158 <listitem>
159 <para>The maximum transmission unit in bytes to set for the
160 device. The usual suffixes K, M, G, are supported and are
161 understood to the base of 1024.</para>
439689c6
SS
162 <para>Note that if IPv6 is enabled on the interface, and the MTU is chosen
163 below 1280 (the minimum MTU for IPv6) it will automatically be increased to this value.</para>
798d3a52
ZJS
164 </listitem>
165 </varlistentry>
99d2baa2
SS
166 <varlistentry>
167 <term><varname>ARP=</varname></term>
168 <listitem>
9b6ffef3
YW
169 <para>Takes a boolean. If set to true, the ARP (low-level Address Resolution Protocol)
170 for this interface is enabled. When unset, the kernel's default will be used.</para>
99d2baa2
SS
171 <para> For example, disabling ARP is useful when creating multiple MACVLAN or VLAN virtual
172 interfaces atop a single lower-level physical interface, which will then only serve as a
173 link/"bridge" device aggregating traffic to the same physical link and not participate in
174 the network otherwise.</para>
175 </listitem>
176 </varlistentry>
e6ebebbe
SS
177 <varlistentry>
178 <term><varname>Multicast=</varname></term>
179 <listitem>
9b6ffef3 180 <para>Takes a boolean. If set to true, the multicast flag on the device is enabled.</para>
866e6b7a
SS
181 </listitem>
182 </varlistentry>
183 <varlistentry>
184 <term><varname>AllMulticast=</varname></term>
185 <listitem>
9b6ffef3 186 <para>Takes a boolean. If set to true, the driver retrieves all multicast packets from the network.
866e6b7a 187 This happens when multicast routing is enabled.</para>
e6ebebbe
SS
188 </listitem>
189 </varlistentry>
a09dc546
DM
190 <varlistentry>
191 <term><varname>Unmanaged=</varname></term>
192 <listitem>
9b6ffef3 193 <para>Takes a boolean. When <literal>yes</literal>, no attempts are
a09dc546
DM
194 made to bring up or configure matching links, equivalent to
195 when there are no matching network files. Defaults to
196 <literal>no</literal>.</para>
197 <para>This is useful for preventing later matching network
198 files from interfering with certain interfaces that are fully
199 controlled by other applications.</para>
200 </listitem>
201 </varlistentry>
89fe6535
SS
202 <varlistentry>
203 <term><varname>Group=</varname></term>
204 <listitem>
205 <para>Link groups are similar to port ranges found in managed switches.
206 When network interfaces are added to a numbered group, operations on
207 all the interfaces from that group can be performed at once. An unsigned
e9dd6984 208 integer in the range 0—4294967294. Defaults to unset.</para>
89fe6535
SS
209 </listitem>
210 </varlistentry>
c1a38904
MTL
211 <varlistentry>
212 <term><varname>RequiredForOnline=</varname></term>
213 <listitem>
75cd4a5d
DDM
214 <para>Takes a boolean or a minimum operational state and an optional maximum operational state.
215 Please see <citerefentry><refentrytitle>networkctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>
8d6082e4
YW
216 for possible operational states. When <literal>yes</literal>, the network is deemed required when
217 determining whether the system is online when running
218 <command>systemd-networkd-wait-online</command>. When <literal>no</literal>, the network is ignored
75cd4a5d
DDM
219 when checking for online state. When a minimum operational state and an optional maximum operational
220 state are set, <literal>yes</literal> is implied, and this controls the minimum and maximum
221 operational state required for the network interface to be considered online.
8d6082e4
YW
222 Defaults to <literal>yes</literal>.</para>
223
c1a38904
MTL
224 <para>The network will be brought up normally in all cases, but in
225 the event that there is no address being assigned by DHCP or the
226 cable is not plugged in, the link will simply remain offline and be
8d6082e4 227 skipped automatically by <command>systemd-networkd-wait-online</command>
ca92fe36 228 if <literal>RequiredForOnline=no</literal>.</para>
c1a38904
MTL
229 </listitem>
230 </varlistentry>
798d3a52
ZJS
231 </variablelist>
232 </refsect1>
233
518cd6b5
SS
234 <refsect1>
235 <title>[SR-IOV] Section Options</title>
bdac5608
ZJS
236 <para>The [SR-IOV] section accepts the following keys. Specify several [SR-IOV] sections to configure
237 several SR-IOVs. SR-IOV provides the ability to partition a single physical PCI resource into virtual
238 PCI functions which can then be injected into a VM. In the case of network VFs, SR-IOV improves
239 north-south network performance (that is, traffic with endpoints outside the host machine) by allowing
240 traffic to bypass the host machine’s network stack.</para>
518cd6b5
SS
241
242 <variablelist class='network-directives'>
243 <varlistentry>
244 <term><varname>VirtualFunction=</varname></term>
245 <listitem>
246 <para>Specifies a Virtual Function (VF), lightweight PCIe function designed solely to move data
247 in and out. Takes an unsigned integer in the range 0..2147483646. This option is compulsory.</para>
248 </listitem>
249 </varlistentry>
250
251 <varlistentry>
252 <term><varname>VLANId=</varname></term>
253 <listitem>
254 <para>Specifies VLAN ID of the virtual function. Takes an unsigned integer in the range 1..4095.</para>
255 </listitem>
256 </varlistentry>
257
258 <varlistentry>
259 <term><varname>QualityOfService=</varname></term>
260 <listitem>
261 <para>Specifies quality of service of the virtual function. Takes an unsigned integer in the range 1..4294967294.</para>
262 </listitem>
e64b31c8
YW
263 </varlistentry>
264
265 <varlistentry>
266 <term><varname>VLANProtocol=</varname></term>
267 <listitem>
268 <para>Specifies VLAN protocol of the virtual function. Takes <literal>802.1Q</literal> or
269 <literal>802.1ad</literal>.</para>
270 </listitem>
518cd6b5
SS
271 </varlistentry>
272
273 <varlistentry>
274 <term><varname>MACSpoofCheck=</varname></term>
275 <listitem>
276 <para>Takes a boolean. Controls the MAC spoof checking. When unset, the kernel's default will be used.</para>
277 </listitem>
278 </varlistentry>
279
280 <varlistentry>
281 <term><varname>QueryReceiveSideScaling=</varname></term>
282 <listitem>
283 <para>Takes a boolean. Toggle the ability of querying the receive side scaling (RSS)
284 configuration of the virtual function (VF). The VF RSS information like RSS hash key may be
285 considered sensitive on some devices where this information is shared between VF and the
286 physical function (PF). When unset, the kernel's default will be used.</para>
287 </listitem>
288 </varlistentry>
289
290 <varlistentry>
291 <term><varname>Trust=</varname></term>
292 <listitem>
293 <para>Takes a boolean. Allows to set trust mode of the virtual function (VF). When set, VF
294 users can set a specific feature which may impact security and/or performance. When unset,
295 the kernel's default will be used.</para>
296 </listitem>
297 </varlistentry>
298
299 <varlistentry>
300 <term><varname>LinkState=</varname></term>
301 <listitem>
302 <para>Allows to set the link state of the virtual function (VF). Takes a boolean or a
303 special value <literal>auto</literal>. Setting to <literal>auto</literal> means a
304 reflection of the physical function (PF) link state, <literal>yes</literal> lets the VF to
305 communicate with other VFs on this host even if the PF link state is down,
306 <literal>no</literal> causes the hardware to drop any packets sent by the VF. When unset,
307 the kernel's default will be used.</para>
308 </listitem>
309 </varlistentry>
310
c3a5025d
YW
311 <varlistentry>
312 <term><varname>MACAddress=</varname></term>
313 <listitem>
314 <para>Specifies the MAC address for the virtual function.</para>
315 </listitem>
316 </varlistentry>
518cd6b5
SS
317 </variablelist>
318 </refsect1>
319
798d3a52
ZJS
320 <refsect1>
321 <title>[Network] Section Options</title>
322
bdac5608 323 <para>The [Network] section accepts the following keys:</para>
798d3a52
ZJS
324
325 <variablelist class='network-directives'>
326 <varlistentry>
327 <term><varname>Description=</varname></term>
328 <listitem>
329 <para>A description of the device. This is only used for
330 presentation purposes.</para>
331 </listitem>
332 </varlistentry>
333 <varlistentry>
334 <term><varname>DHCP=</varname></term>
335 <listitem>
ad943783 336 <para>Enables DHCPv4 and/or DHCPv6 client support. Accepts
798d3a52 337 <literal>yes</literal>, <literal>no</literal>,
c702bd3b
LY
338 <literal>ipv4</literal>, or <literal>ipv6</literal>. Defaults
339 to <literal>no</literal>.</para>
e88d8021 340
f5a8c43f 341 <para>Note that DHCPv6 will by default be triggered by Router
7f3fdb7f 342 Advertisement, if that is enabled, regardless of this parameter.
f5a8c43f
TG
343 By enabling DHCPv6 support explicitly, the DHCPv6 client will
344 be started regardless of the presence of routers on the link,
345 or what flags the routers pass. See
f921f573 346 <literal>IPv6AcceptRA=</literal>.</para>
f5a8c43f
TG
347
348 <para>Furthermore, note that by default the domain name
e88d8021
ZJS
349 specified through DHCP is not used for name resolution.
350 See option <option>UseDomains=</option> below.</para>
2ef322fc 351
bdac5608
ZJS
352 <para>See the [DHCPv4] or [DHCPv6] sections below for further configuration options for the DHCP
353 client support.</para>
798d3a52
ZJS
354 </listitem>
355 </varlistentry>
356 <varlistentry>
357 <term><varname>DHCPServer=</varname></term>
358 <listitem>
68b7f7ac 359 <para>Takes a boolean. If set to <literal>yes</literal>, DHCPv4 server will be started. Defaults
bdac5608 360 to <literal>no</literal>. Further settings for the DHCP server may be set in the [DHCPServer]
ad943783 361 section described below.</para>
798d3a52
ZJS
362 </listitem>
363 </varlistentry>
364 <varlistentry>
56fd6bf7 365 <term><varname>LinkLocalAddressing=</varname></term>
798d3a52 366 <listitem>
85fc09c9 367 <para>Enables link-local address autoconfiguration. Accepts <literal>yes</literal>,
8bc17bb3
SS
368 <literal>no</literal>, <literal>ipv4</literal>, <literal>ipv6</literal>,
369 <literal>fallback</literal>, or <literal>ipv4-fallback</literal>. If
370 <literal>fallback</literal> or <literal>ipv4-fallback</literal> is specified, then an IPv4
371 link-local address is configured only when DHCPv4 fails. If <literal>fallback</literal>,
372 an IPv6 link-local address is always configured, and if <literal>ipv4-fallback</literal>,
373 the address is not configured. Note that, the fallback mechanism works only when DHCPv4
374 client is enabled, that is, it requires <literal>DHCP=yes</literal> or
375 <literal>DHCP=ipv4</literal>. If <varname>Bridge=</varname> is set, defaults to
376 <literal>no</literal>, and if not, defaults to <literal>ipv6</literal>.
377 </para>
798d3a52
ZJS
378 </listitem>
379 </varlistentry>
6f6296b9
YW
380 <varlistentry>
381 <term><varname>IPv6LinkLocalAddressGenerationMode=</varname></term>
382 <listitem>
383 <para>Specifies how IPv6 link local address is generated. Takes one of <literal>eui64</literal>,
384 <literal>none</literal>, <literal>stable-privacy</literal> and <literal>random</literal>.
385 When unset, the kernel's default will be used. Note that if <varname>LinkLocalAdressing=</varname>
386 not configured as <literal>ipv6</literal> then <varname>IPv6LinkLocalAddressGenerationMode=</varname>
387 is ignored.</para>
388 </listitem>
389 </varlistentry>
798d3a52
ZJS
390 <varlistentry>
391 <term><varname>IPv4LLRoute=</varname></term>
392 <listitem>
9b6ffef3 393 <para>Takes a boolean. If set to true, sets up the route needed for
798d3a52
ZJS
394 non-IPv4LL hosts to communicate with IPv4LL-only hosts. Defaults
395 to false.
396 </para>
397 </listitem>
398 </varlistentry>
5d5003ab
YW
399 <varlistentry>
400 <term><varname>DefaultRouteOnDevice=</varname></term>
401 <listitem>
402 <para>Takes a boolean. If set to true, sets up the default route bound to the interface.
403 Defaults to false. This is useful when creating routes on point-to-point interfaces.
404 This is equivalent to e.g. the following.
405 <programlisting>ip route add default dev veth99</programlisting></para>
406 </listitem>
407 </varlistentry>
798d3a52 408 <varlistentry>
113bfde1
TG
409 <term><varname>IPv6Token=</varname></term>
410 <listitem>
8dcce054
KF
411 <para>Specifies an optional address generation mode and a required IPv6 address. If
412 the mode is present, the two parts must be separated with a colon
413 <literal><replaceable>mode</replaceable>:<replaceable>address</replaceable></literal>. The
414 address generation mode may be either <constant>prefixstable</constant> or
415 <constant>static</constant>. If not specified, <constant>static</constant> is assumed.
416 </para>
417 <para>When the mode is set to <constant>static</constant>, or unspecified, the lower bits of
418 the supplied address are combined with the upper bits of a prefix received in a Router Advertisement
419 message to form a complete address. Note that if multiple prefixes are received in an RA message, or in
420 multiple RA messages, addresses will be formed from each of them using the supplied address. This
421 mode implements SLAAC but uses a static interface identifier instead of an identifier generated
422 using the EUI-64 algorithm. Because the interface identifier is static, if Duplicate Address Detection
423 detects that the computed address is a duplicate (in use by another node on the link), then this
424 mode will fail to provide an address for that prefix.
8dcce054
KF
425 </para>
426 <para>When the mode is set to <literal>prefixstable</literal> the RFC 7217 algorithm for generating
427 interface identifiers will be used, but only when a prefix received in an RA message matches the supplied address.
428 See <ulink url="https://tools.ietf.org/html/rfc7217">RFC 7217</ulink>. Prefix matching will be attempted
429 against each <constant>prefixstable</constant> IPv6Token variable provided in the configuration; if a received
430 prefix does not match any of the provided addresses, then the EUI-64 algorithm will be used to form
431 an interface identifier for that prefix. This mode is also SLAAC, but with a potentially stable interface
432 identifier which does not directly map to the interface's hardware address.
433
434 Note that the <constant>prefixstable</constant> algorithm includes both the interface's name and
435 MAC address in the hash used to compute the interface identifier, so if either of those are changed the resulting
436 interface identifier (and address) will change, even if the prefix received in the RA message has not changed.
437
438 Note that if multiple <constant>prefixstable</constant> IPv6Token variables are supplied with addresses that
439 match a prefix received in an RA message, only the first one will be used to generate addresses.
5f506a55 440 </para>
113bfde1
TG
441 </listitem>
442 </varlistentry>
443 <varlistentry>
798d3a52
ZJS
444 <term><varname>LLMNR=</varname></term>
445 <listitem>
9b6ffef3 446 <para>Takes a boolean or <literal>resolve</literal>. When true,
aaa297d4
LP
447 enables <ulink
448 url="https://tools.ietf.org/html/rfc4795">Link-Local
449 Multicast Name Resolution</ulink> on the link. When set to
450 <literal>resolve</literal>, only resolution is enabled,
451 but not host registration and announcement. Defaults to
452 true. This setting is read by
453 <citerefentry><refentrytitle>systemd-resolved.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
454 </listitem>
455 </varlistentry>
456 <varlistentry>
457 <term><varname>MulticastDNS=</varname></term>
458 <listitem>
9b6ffef3 459 <para>Takes a boolean or <literal>resolve</literal>. When true,
aaa297d4
LP
460 enables <ulink
461 url="https://tools.ietf.org/html/rfc6762">Multicast
462 DNS</ulink> support on the link. When set to
463 <literal>resolve</literal>, only resolution is enabled,
464 but not host or service registration and
465 announcement. Defaults to false. This setting is read by
466 <citerefentry><refentrytitle>systemd-resolved.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
798d3a52
ZJS
467 </listitem>
468 </varlistentry>
30e59c84 469 <varlistentry>
c9299be2 470 <term><varname>DNSOverTLS=</varname></term>
30e59c84 471 <listitem>
4310bfc2
IT
472 <para>Takes a boolean or <literal>opportunistic</literal>.
473 When true, enables
30e59c84
IT
474 <ulink
475 url="https://tools.ietf.org/html/rfc7858">DNS-over-TLS</ulink>
4310bfc2
IT
476 support on the link.
477 When set to <literal>opportunistic</literal>, compatibility with
478 non-DNS-over-TLS servers is increased, by automatically
479 turning off DNS-over-TLS servers in this case.
480 This option defines a per-interface setting for
30e59c84 481 <citerefentry><refentrytitle>resolved.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>'s
c9299be2 482 global <varname>DNSOverTLS=</varname> option. Defaults to
30e59c84
IT
483 false. This setting is read by
484 <citerefentry><refentrytitle>systemd-resolved.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
485 </listitem>
486 </varlistentry>
ad6c0475
LP
487 <varlistentry>
488 <term><varname>DNSSEC=</varname></term>
489 <listitem>
e9dd6984
ZJS
490 <para>Takes a boolean or <literal>allow-downgrade</literal>. When true, enables
491 <ulink url="https://tools.ietf.org/html/rfc4033">DNSSEC</ulink>
ad6c0475
LP
492 DNS validation support on the link. When set to
493 <literal>allow-downgrade</literal>, compatibility with
494 non-DNSSEC capable networks is increased, by automatically
785889e5 495 turning off DNSSEC in this case. This option defines a
ad6c0475
LP
496 per-interface setting for
497 <citerefentry><refentrytitle>resolved.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>'s
498 global <varname>DNSSEC=</varname> option. Defaults to
499 false. This setting is read by
500 <citerefentry><refentrytitle>systemd-resolved.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
501 </listitem>
502 </varlistentry>
8a516214
LP
503 <varlistentry>
504 <term><varname>DNSSECNegativeTrustAnchors=</varname></term>
505 <listitem><para>A space-separated list of DNSSEC negative
506 trust anchor domains. If specified and DNSSEC is enabled,
507 look-ups done via the interface's DNS server will be subject
508 to the list of negative trust anchors, and not require
509 authentication for the specified domains, or anything below
510 it. Use this to disable DNSSEC authentication for specific
511 private domains, that cannot be proven valid using the
512 Internet DNS hierarchy. Defaults to the empty list. This
513 setting is read by
514 <citerefentry><refentrytitle>systemd-resolved.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
515 </listitem>
516 </varlistentry>
798d3a52
ZJS
517 <varlistentry>
518 <term><varname>LLDP=</varname></term>
519 <listitem>
da6c766d
LP
520 <para>Controls support for Ethernet LLDP packet reception. LLDP is a link-layer protocol commonly
521 implemented on professional routers and bridges which announces which physical port a system is connected
522 to, as well as other related data. Accepts a boolean or the special value
34437b4f
LP
523 <literal>routers-only</literal>. When true, incoming LLDP packets are accepted and a database of all LLDP
524 neighbors maintained. If <literal>routers-only</literal> is set only LLDP data of various types of routers
525 is collected and LLDP data about other types of devices ignored (such as stations, telephones and
7cececb2 526 others). If false, LLDP reception is disabled. Defaults to <literal>routers-only</literal>. Use
34437b4f 527 <citerefentry><refentrytitle>networkctl</refentrytitle><manvolnum>1</manvolnum></citerefentry> to query the
da6c766d
LP
528 collected neighbor data. LLDP is only available on Ethernet links. See <varname>EmitLLDP=</varname> below
529 for enabling LLDP packet emission from the local system.
798d3a52
ZJS
530 </para>
531 </listitem>
532 </varlistentry>
da6c766d
LP
533 <varlistentry>
534 <term><varname>EmitLLDP=</varname></term>
535 <listitem>
7272b25e
LP
536 <para>Controls support for Ethernet LLDP packet emission. Accepts a boolean parameter or the special values
537 <literal>nearest-bridge</literal>, <literal>non-tpmr-bridge</literal> and
538 <literal>customer-bridge</literal>. Defaults to false, which turns off LLDP packet emission. If not false,
539 a short LLDP packet with information about the local system is sent out in regular intervals on the
38b38500 540 link. The LLDP packet will contain information about the local hostname, the local machine ID (as stored
7272b25e 541 in <citerefentry><refentrytitle>machine-id</refentrytitle><manvolnum>5</manvolnum></citerefentry>) and the
da6c766d
LP
542 local interface name, as well as the pretty hostname of the system (as set in
543 <citerefentry><refentrytitle>machine-info</refentrytitle><manvolnum>5</manvolnum></citerefentry>). LLDP
7272b25e
LP
544 emission is only available on Ethernet links. Note that this setting passes data suitable for
545 identification of host to the network and should thus not be enabled on untrusted networks, where such
546 identification data should not be made available. Use this option to permit other systems to identify on
547 which interfaces they are connected to this system. The three special values control propagation of the
548 LLDP packets. The <literal>nearest-bridge</literal> setting permits propagation only to the nearest
549 connected bridge, <literal>non-tpmr-bridge</literal> permits propagation across Two-Port MAC Relays, but
550 not any other bridges, and <literal>customer-bridge</literal> permits propagation until a customer bridge
551 is reached. For details about these concepts, see <ulink
6a1bae83 552 url="https://standards.ieee.org/findstds/standard/802.1AB-2016.html">IEEE 802.1AB-2016</ulink>. Note that
7272b25e
LP
553 configuring this setting to true is equivalent to <literal>nearest-bridge</literal>, the recommended and
554 most restricted level of propagation. See <varname>LLDP=</varname> above for an option to enable LLDP
555 reception.</para>
da6c766d
LP
556 </listitem>
557 </varlistentry>
e9a8c550 558
0d4ad91d
AR
559 <varlistentry>
560 <term><varname>BindCarrier=</varname></term>
561 <listitem>
2ae7505f
TG
562 <para>A link name or a list of link names. When set, controls the behavior of the current
563 link. When all links in the list are in an operational down state, the current link is brought
564 down. When at least one link has carrier, the current interface is brought up.
0d4ad91d
AR
565 </para>
566 </listitem>
567 </varlistentry>
798d3a52
ZJS
568 <varlistentry>
569 <term><varname>Address=</varname></term>
570 <listitem>
571 <para>A static IPv4 or IPv6 address and its prefix length,
572 separated by a <literal>/</literal> character. Specify
573 this key more than once to configure several addresses.
574 The format of the address must be as described in
3ba3a79d 575 <citerefentry project='man-pages'><refentrytitle>inet_pton</refentrytitle><manvolnum>3</manvolnum></citerefentry>.
798d3a52
ZJS
576 This is a short-hand for an [Address] section only
577 containing an Address key (see below). This option may be
578 specified more than once.
579 </para>
580
e6ef3a13
YW
581 <para>If the specified address is <literal>0.0.0.0</literal> (for IPv4) or <literal>::</literal>
582 (for IPv6), a new address range of the requested size is automatically allocated from a
583 system-wide pool of unused ranges. Note that the prefix length must be equal or larger than 8 for
584 IPv4, and 64 for IPv6. The allocated range is checked against all current network interfaces and
585 all known network configuration files to avoid address range conflicts. The default system-wide
586 pool consists of 192.168.0.0/16, 172.16.0.0/12 and 10.0.0.0/8 for IPv4, and fd00::/8 for IPv6.
587 This functionality is useful to manage a large number of dynamically created network interfaces
588 with the same network configuration and automatic address range assignment.</para>
798d3a52
ZJS
589
590 </listitem>
591 </varlistentry>
592 <varlistentry>
593 <term><varname>Gateway=</varname></term>
594 <listitem>
595 <para>The gateway address, which must be in the format
596 described in
3ba3a79d 597 <citerefentry project='man-pages'><refentrytitle>inet_pton</refentrytitle><manvolnum>3</manvolnum></citerefentry>.
798d3a52
ZJS
598 This is a short-hand for a [Route] section only containing
599 a Gateway key. This option may be specified more than
600 once.</para>
601 </listitem>
602 </varlistentry>
603 <varlistentry>
604 <term><varname>DNS=</varname></term>
605 <listitem>
606 <para>A DNS server address, which must be in the format
607 described in
3ba3a79d 608 <citerefentry project='man-pages'><refentrytitle>inet_pton</refentrytitle><manvolnum>3</manvolnum></citerefentry>.
711dd5db
YW
609 This option may be specified more than once. Each address can optionally take a port number
610 separated with <literal>:</literal>, a network interface name or index separated with
611 <literal>%</literal>, and a Server Name Indication (SNI) separated with <literal>#</literal>.
612 When IPv6 address is specified with a port number, then the address must be in the square
613 brackets. That is, the acceptable full formats are
614 <literal>111.222.333.444:9953%ifname#example.com</literal> for IPv4 and
615 <literal>[1111:2222::3333]:9953%ifname#example.com</literal> for IPv6. This setting can be
616 specified multiple times. If an empty string is assigned, then the all previous assignments
617 are cleared. This setting is read by
3df9bec5 618 <citerefentry><refentrytitle>systemd-resolved.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
798d3a52
ZJS
619 </listitem>
620 </varlistentry>
621 <varlistentry>
622 <term><varname>Domains=</varname></term>
623 <listitem>
cd517eb7
ZJS
624 <para>A whitespace-separated list of domains which should be resolved using the DNS servers on
625 this link. Each item in the list should be a domain name, optionally prefixed with a tilde
626 (<literal>~</literal>). The domains with the prefix are called "routing-only domains". The
627 domains without the prefix are called "search domains" and are first used as search suffixes for
38b38500
ZJS
628 extending single-label hostnames (hostnames containing no dots) to become fully qualified
629 domain names (FQDNs). If a single-label hostname is resolved on this interface, each of the
cd517eb7
ZJS
630 specified search domains are appended to it in turn, converting it into a fully qualified domain
631 name, until one of them may be successfully resolved.</para>
2df22529 632
38b38500 633 <para>Both "search" and "routing-only" domains are used for routing of DNS queries: look-ups for hostnames
2df22529
ZJS
634 ending in those domains (hence also single label names, if any "search domains" are listed), are routed to
635 the DNS servers configured for this interface. The domain routing logic is particularly useful on
636 multi-homed hosts with DNS servers serving particular private DNS zones on each interface.</para>
637
638 <para>The "routing-only" domain <literal>~.</literal> (the tilde indicating definition of a routing domain,
639 the dot referring to the DNS root domain which is the implied suffix of all valid DNS names) has special
640 effect. It causes all DNS traffic which does not match another configured domain routing entry to be routed
641 to DNS servers specified for this interface. This setting is useful to prefer a certain set of DNS servers
642 if a link on which they are connected is available.</para>
3df9bec5
LP
643
644 <para>This setting is read by
2df22529
ZJS
645 <citerefentry><refentrytitle>systemd-resolved.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
646 "Search domains" correspond to the <varname>domain</varname> and <varname>search</varname> entries in
98e9d710 647 <citerefentry project='man-pages'><refentrytitle>resolv.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
2df22529
ZJS
648 Domain name routing has no equivalent in the traditional glibc API, which has no concept of domain
649 name servers limited to a specific link.</para>
798d3a52
ZJS
650 </listitem>
651 </varlistentry>
7ece6f58
LP
652 <varlistentry>
653 <term><varname>DNSDefaultRoute=</varname></term>
654 <listitem>
655 <para>Takes a boolean argument. If true, this link's configured DNS servers are used for resolving domain
656 names that do not match any link's configured <varname>Domains=</varname> setting. If false, this link's
657 configured DNS servers are never used for such domains, and are exclusively used for resolving names that
658 match at least one of the domains configured on this link. If not specified defaults to an automatic mode:
659 queries not matching any link's configured domains will be routed to this link if it has no routing-only
660 domains configured.</para>
661 </listitem>
662 </varlistentry>
798d3a52
ZJS
663 <varlistentry>
664 <term><varname>NTP=</varname></term>
665 <listitem>
2a71d57f 666 <para>An NTP server address (either an IP address, or a hostname). This option may be specified more than once. This setting is read by
3df9bec5 667 <citerefentry><refentrytitle>systemd-timesyncd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
798d3a52
ZJS
668 </listitem>
669 </varlistentry>
670 <varlistentry>
671 <term><varname>IPForward=</varname></term>
765afd5c
LP
672 <listitem><para>Configures IP packet forwarding for the
673 system. If enabled, incoming packets on any network
674 interface will be forwarded to any other interfaces
9b6ffef3
YW
675 according to the routing table. Takes a boolean,
676 or the values <literal>ipv4</literal> or
765afd5c
LP
677 <literal>ipv6</literal>, which only enable IP packet
678 forwarding for the specified address family. This controls
679 the <filename>net.ipv4.ip_forward</filename> and
680 <filename>net.ipv6.conf.all.forwarding</filename> sysctl
681 options of the network interface (see <ulink
4046d836
LP
682 url="https://www.kernel.org/doc/Documentation/networking/ip-sysctl.txt">ip-sysctl.txt</ulink>
683 for details about sysctl options). Defaults to
684 <literal>no</literal>.</para>
685
765afd5c
LP
686 <para>Note: this setting controls a global kernel option,
687 and does so one way only: if a network that has this setting
688 enabled is set up the global setting is turned on. However,
689 it is never turned off again, even after all networks with
690 this setting enabled are shut down again.</para>
691
692 <para>To allow IP packet forwarding only between specific
693 network interfaces use a firewall.</para>
4046d836 694 </listitem>
798d3a52
ZJS
695 </varlistentry>
696 <varlistentry>
697 <term><varname>IPMasquerade=</varname></term>
698 <listitem><para>Configures IP masquerading for the network
b938cb90 699 interface. If enabled, packets forwarded from the network
798d3a52
ZJS
700 interface will be appear as coming from the local host.
701 Takes a boolean argument. Implies
5c82dd13 702 <varname>IPForward=ipv4</varname>. Defaults to
4046d836 703 <literal>no</literal>.</para></listitem>
798d3a52 704 </varlistentry>
a46e37cb
SS
705 <varlistentry>
706 <term><varname>IPv6PrivacyExtensions=</varname></term>
1f0d9695
LP
707 <listitem><para>Configures use of stateless temporary
708 addresses that change over time (see <ulink
709 url="https://tools.ietf.org/html/rfc4941">RFC 4941</ulink>,
710 Privacy Extensions for Stateless Address Autoconfiguration
711 in IPv6). Takes a boolean or the special values
712 <literal>prefer-public</literal> and
b938cb90 713 <literal>kernel</literal>. When true, enables the privacy
1f0d9695 714 extensions and prefers temporary addresses over public
b938cb90 715 addresses. When <literal>prefer-public</literal>, enables the
1f0d9695
LP
716 privacy extensions, but prefers public addresses over
717 temporary addresses. When false, the privacy extensions
b938cb90 718 remain disabled. When <literal>kernel</literal>, the kernel's
1f0d9695 719 default setting will be left in place. Defaults to
a46e37cb
SS
720 <literal>no</literal>.</para></listitem>
721 </varlistentry>
941d0aa8 722 <varlistentry>
f921f573 723 <term><varname>IPv6AcceptRA=</varname></term>
c7fe06fb
ZJS
724 <listitem><para>Takes a boolean. Controls IPv6 Router Advertisement (RA) reception support for the
725 interface. If true, RAs are accepted; if false, RAs are ignored. When RAs are accepted, they may
726 trigger the start of the DHCPv6 client if the relevant flags are set in the RA data, or if no
727 routers are found on the link. The default is to disable RA reception for bridge devices or when IP
728 forwarding is enabled, and to enable it otherwise. Cannot be enabled on bond devices and when link
86b52a39 729 local addressing is disabled.</para>
1e7a0e21 730
bdac5608
ZJS
731 <para>Further settings for the IPv6 RA support may be configured in the [IPv6AcceptRA] section, see
732 below.</para>
1e7a0e21
LP
733
734 <para>Also see <ulink
735 url="https://www.kernel.org/doc/Documentation/networking/ip-sysctl.txt">ip-sysctl.txt</ulink> in the kernel
736 documentation regarding <literal>accept_ra</literal>, but note that systemd's setting of
737 <constant>1</constant> (i.e. true) corresponds to kernel's setting of <constant>2</constant>.</para>
c4a05aa1 738
b3454e1e
YW
739 <para>Note that kernel's implementation of the IPv6 RA protocol is always disabled,
740 regardless of this setting. If this option is enabled, a userspace implementation of the IPv6
741 RA protocol is used, and the kernel's own implementation remains disabled, since
742 <command>systemd-networkd</command> needs to know all details supplied in the advertisements,
743 and these are not available from the kernel if the kernel's own implementation is used.</para>
ebf98081 744 </listitem>
941d0aa8 745 </varlistentry>
44de7fb1
SS
746 <varlistentry>
747 <term><varname>IPv6DuplicateAddressDetection=</varname></term>
a8eaaee7 748 <listitem><para>Configures the amount of IPv6 Duplicate
025314d9 749 Address Detection (DAD) probes to send. When unset, the kernel's default will be used.
44de7fb1
SS
750 </para></listitem>
751 </varlistentry>
a86cba89
SS
752 <varlistentry>
753 <term><varname>IPv6HopLimit=</varname></term>
754 <listitem><para>Configures IPv6 Hop Limit. For each router that
755 forwards the packet, the hop limit is decremented by 1. When the
756 hop limit field reaches zero, the packet is discarded.
025314d9 757 When unset, the kernel's default will be used.
a86cba89
SS
758 </para></listitem>
759 </varlistentry>
94d76d07
YW
760 <varlistentry>
761 <term><varname>IPv4AcceptLocal=</varname></term>
762 <listitem><para>Takes a boolean. Accept packets with local source addresses. In combination
763 with suitable routing, this can be used to direct packets between two local interfaces over
764 the wire and have them accepted properly. When unset, the kernel's default will be used.
765 </para></listitem>
766 </varlistentry>
23d8b221 767 <varlistentry>
8f9a206b 768 <term><varname>IPv4ProxyARP=</varname></term>
9b6ffef3 769 <listitem><para>Takes a boolean. Configures proxy ARP for IPv4. Proxy ARP is the technique in which one host,
23d8b221 770 usually a router, answers ARP requests intended for another machine. By "faking" its identity,
e9dd6984 771 the router accepts responsibility for routing packets to the "real" destination. See <ulink
23d8b221 772 url="https://tools.ietf.org/html/rfc1027">RFC 1027</ulink>.
025314d9 773 When unset, the kernel's default will be used.
23d8b221
SS
774 </para></listitem>
775 </varlistentry>
a0e5c15d 776 <varlistentry>
465dfe59 777 <term><varname>IPv6ProxyNDP=</varname></term>
9b6ffef3 778 <listitem><para>Takes a boolean. Configures proxy NDP for IPv6. Proxy NDP (Neighbor Discovery
465dfe59
HV
779 Protocol) is a technique for IPv6 to allow routing of addresses to a different
780 destination when peers expect them to be present on a certain physical link.
a0e5c15d
FK
781 In this case a router answers Neighbour Advertisement messages intended for
782 another machine by offering its own MAC address as destination.
465dfe59 783 Unlike proxy ARP for IPv4, it is not enabled globally, but will only send Neighbour
a0e5c15d 784 Advertisement messages for addresses in the IPv6 neighbor proxy table,
465dfe59
HV
785 which can also be shown by <command>ip -6 neighbour show proxy</command>.
786 systemd-networkd will control the per-interface `proxy_ndp` switch for each configured
787 interface depending on this option.
025314d9 788 When unset, the kernel's default will be used.
465dfe59
HV
789 </para></listitem>
790 </varlistentry>
791 <varlistentry>
792 <term><varname>IPv6ProxyNDPAddress=</varname></term>
793 <listitem><para>An IPv6 address, for which Neighbour Advertisement messages will be
794 proxied. This option may be specified more than once. systemd-networkd will add the
795 <option>IPv6ProxyNDPAddress=</option> entries to the kernel's IPv6 neighbor proxy table.
964c4eda 796 This option implies <option>IPv6ProxyNDP=yes</option> but has no effect if
025314d9 797 <option>IPv6ProxyNDP</option> has been set to false. When unset, the kernel's default will be used.
a0e5c15d
FK
798 </para></listitem>
799 </varlistentry>
3f9e0236
PF
800 <varlistentry>
801 <term><varname>IPv6PrefixDelegation=</varname></term>
bdac5608
ZJS
802 <listitem><para>Whether to enable or disable Router Advertisement sending on a link. Allowed
803 values are <literal>static</literal> which distributes prefixes as defined in the
804 [IPv6PrefixDelegation] and any [IPv6Prefix] sections, <literal>dhcpv6</literal> which requests
805 prefixes using a DHCPv6 client configured for another link and any values configured in the
806 [IPv6PrefixDelegation] section while ignoring all static prefix configuration sections,
807 <literal>yes</literal> which uses both static configuration and DHCPv6, and
808 <literal>false</literal> which turns off IPv6 prefix delegation altogether. Defaults to
809 <literal>false</literal>. See the [IPv6PrefixDelegation] and the [IPv6Prefix] sections for more
810 configuration options.</para></listitem>
3f9e0236 811 </varlistentry>
11102cba
SS
812 <varlistentry>
813 <term><varname>IPv6MTUBytes=</varname></term>
814 <listitem><para>Configures IPv6 maximum transmission unit (MTU).
025314d9 815 An integer greater than or equal to 1280 bytes. When unset, the kernel's default will be used.
11102cba
SS
816 </para></listitem>
817 </varlistentry>
798d3a52
ZJS
818 <varlistentry>
819 <term><varname>Bridge=</varname></term>
820 <listitem>
9e35b3de
ZJS
821 <para>The name of the bridge to add the link to. See
822 <citerefentry><refentrytitle>systemd.netdev</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
823 </para>
798d3a52
ZJS
824 </listitem>
825 </varlistentry>
826 <varlistentry>
827 <term><varname>Bond=</varname></term>
828 <listitem>
9e35b3de
ZJS
829 <para>The name of the bond to add the link to. See
830 <citerefentry><refentrytitle>systemd.netdev</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
831 </para>
798d3a52
ZJS
832 </listitem>
833 </varlistentry>
6cb955c6
AR
834 <varlistentry>
835 <term><varname>VRF=</varname></term>
836 <listitem>
9e35b3de
ZJS
837 <para>The name of the VRF to add the link to. See
838 <citerefentry><refentrytitle>systemd.netdev</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
839 </para>
6cb955c6
AR
840 </listitem>
841 </varlistentry>
798d3a52
ZJS
842 <varlistentry>
843 <term><varname>VLAN=</varname></term>
844 <listitem>
9e35b3de
ZJS
845 <para>The name of a VLAN to create on the link. See
846 <citerefentry><refentrytitle>systemd.netdev</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
847 This option may be specified more than once.</para>
798d3a52
ZJS
848 </listitem>
849 </varlistentry>
2479c4fe 850 <varlistentry>
851 <term><varname>IPVLAN=</varname></term>
852 <listitem>
853 <para>The name of a IPVLAN to create on the link. See
854 <citerefentry><refentrytitle>systemd.netdev</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
855 This option may be specified more than once.</para>
856 </listitem>
857 </varlistentry>
798d3a52
ZJS
858 <varlistentry>
859 <term><varname>MACVLAN=</varname></term>
860 <listitem>
9e35b3de
ZJS
861 <para>The name of a MACVLAN to create on the link. See
862 <citerefentry><refentrytitle>systemd.netdev</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
863 This option may be specified more than once.</para>
798d3a52
ZJS
864 </listitem>
865 </varlistentry>
866 <varlistentry>
867 <term><varname>VXLAN=</varname></term>
868 <listitem>
9e35b3de
ZJS
869 <para>The name of a VXLAN to create on the link. See
870 <citerefentry><refentrytitle>systemd.netdev</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
871 This option may be specified more than once.</para>
798d3a52
ZJS
872 </listitem>
873 </varlistentry>
874 <varlistentry>
875 <term><varname>Tunnel=</varname></term>
876 <listitem>
9e35b3de
ZJS
877 <para>The name of a Tunnel to create on the link. See
878 <citerefentry><refentrytitle>systemd.netdev</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
879 This option may be specified more than once.</para>
798d3a52
ZJS
880 </listitem>
881 </varlistentry>
81962db7
SS
882 <varlistentry>
883 <term><varname>MACsec=</varname></term>
884 <listitem>
885 <para>The name of a MACsec device to create on the link. See
886 <citerefentry><refentrytitle>systemd.netdev</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
887 This option may be specified more than once.</para>
888 </listitem>
889 </varlistentry>
dd5f3175
SS
890 <varlistentry>
891 <term><varname>ActiveSlave=</varname></term>
892 <listitem>
9b6ffef3 893 <para>Takes a boolean. Specifies the new active slave. The <literal>ActiveSlave=</literal>
dd5f3175
SS
894 option is only valid for following modes:
895 <literal>active-backup</literal>,
896 <literal>balance-alb</literal> and
897 <literal>balance-tlb</literal>. Defaults to false.
898 </para>
899 </listitem>
900 </varlistentry>
901 <varlistentry>
902 <term><varname>PrimarySlave=</varname></term>
903 <listitem>
9b6ffef3 904 <para>Takes a boolean. Specifies which slave is the primary device. The specified
dd5f3175
SS
905 device will always be the active slave while it is available. Only when the
906 primary is off-line will alternate devices be used. This is useful when
907 one slave is preferred over another, e.g. when one slave has higher throughput
908 than another. The <literal>PrimarySlave=</literal> option is only valid for
909 following modes:
910 <literal>active-backup</literal>,
911 <literal>balance-alb</literal> and
912 <literal>balance-tlb</literal>. Defaults to false.
913 </para>
914 </listitem>
915 </varlistentry>
dad2d78e
SS
916 <varlistentry>
917 <term><varname>ConfigureWithoutCarrier=</varname></term>
918 <listitem>
9b6ffef3 919 <para>Takes a boolean. Allows networkd to configure a specific link even if it has no carrier.
bd0d471c
DS
920 Defaults to false. If <option>IgnoreCarrierLoss=</option> is not explicitly set, it will
921 default to this value.
dad2d78e
SS
922 </para>
923 </listitem>
924 </varlistentry>
93b4dab5
SS
925 <varlistentry>
926 <term><varname>IgnoreCarrierLoss=</varname></term>
927 <listitem>
bd0d471c
DS
928 <para>Takes a boolean. Allows networkd to retain both the static and dynamic configuration
929 of the interface even if its carrier is lost. When unset, the value specified with
930 <option>ConfigureWithoutCarrier=</option> is used.
93b4dab5
SS
931 </para>
932 </listitem>
933 </varlistentry>
98d20a17 934 <varlistentry>
935 <term><varname>Xfrm=</varname></term>
936 <listitem>
937 <para>The name of the xfrm to create on the link. See
938 <citerefentry><refentrytitle>systemd.netdev</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
939 This option may be specified more than once.</para>
940 </listitem>
941 </varlistentry>
c98d78d3
YW
942 <varlistentry>
943 <term><varname>KeepConfiguration=</varname></term>
944 <listitem>
945 <para>Takes a boolean or one of <literal>static</literal>, <literal>dhcp-on-stop</literal>,
946 <literal>dhcp</literal>. When <literal>static</literal>, <command>systemd-networkd</command>
947 will not drop static addresses and routes on starting up process. When set to
948 <literal>dhcp-on-stop</literal>, <command>systemd-networkd</command> will not drop addresses
949 and routes on stopping the daemon. When <literal>dhcp</literal>,
950 the addresses and routes provided by a DHCP server will never be dropped even if the DHCP
951 lease expires. This is contrary to the DHCP specification, but may be the best choice if,
952 e.g., the root filesystem relies on this connection. The setting <literal>dhcp</literal>
953 implies <literal>dhcp-on-stop</literal>, and <literal>yes</literal> implies
80060352
ZJS
954 <literal>dhcp</literal> and <literal>static</literal>. Defaults to <literal>no</literal>.
955 </para>
c98d78d3
YW
956 </listitem>
957 </varlistentry>
93b4dab5 958
798d3a52
ZJS
959 </variablelist>
960
961 </refsect1>
962
963 <refsect1>
964 <title>[Address] Section Options</title>
965
bdac5608 966 <para>An [Address] section accepts the following keys. Specify several [Address]
798d3a52
ZJS
967 sections to configure several addresses.</para>
968
969 <variablelist class='network-directives'>
970 <varlistentry>
971 <term><varname>Address=</varname></term>
972 <listitem>
bdac5608
ZJS
973 <para>As in the [Network] section. This key is mandatory. Each [Address] section can contain one
974 <varname>Address=</varname> setting.</para>
798d3a52
ZJS
975 </listitem>
976 </varlistentry>
977 <varlistentry>
978 <term><varname>Peer=</varname></term>
979 <listitem>
980 <para>The peer address in a point-to-point connection.
4e68898e 981 Accepts the same format as the <varname>Address=</varname>
798d3a52
ZJS
982 key.</para>
983 </listitem>
984 </varlistentry>
985 <varlistentry>
986 <term><varname>Broadcast=</varname></term>
987 <listitem>
988 <para>The broadcast address, which must be in the format
989 described in
3ba3a79d 990 <citerefentry project='man-pages'><refentrytitle>inet_pton</refentrytitle><manvolnum>3</manvolnum></citerefentry>.
798d3a52 991 This key only applies to IPv4 addresses. If it is not
4e68898e 992 given, it is derived from the <varname>Address=</varname>
798d3a52
ZJS
993 key.</para>
994 </listitem>
995 </varlistentry>
996 <varlistentry>
997 <term><varname>Label=</varname></term>
998 <listitem>
999 <para>An address label.</para>
1000 </listitem>
1001 </varlistentry>
b5834a0b
SS
1002 <varlistentry>
1003 <term><varname>PreferredLifetime=</varname></term>
1004 <listitem>
1005 <para>Allows the default "preferred lifetime" of the address to be overridden.
1006 Only three settings are accepted: <literal>forever</literal> or <literal>infinity</literal>
1007 which is the default and means that the address never expires, and <literal>0</literal> which means
1008 that the address is considered immediately "expired" and will not be used,
1009 unless explicitly requested. A setting of PreferredLifetime=0 is useful for
1010 addresses which are added to be used only by a specific application,
1011 which is then configured to use them explicitly.</para>
1012 </listitem>
1013 </varlistentry>
2959fb07
SS
1014 <varlistentry>
1015 <term><varname>Scope=</varname></term>
1016 <listitem>
1017 <para>The scope of the address, which can be <literal>global</literal>,
e9dd6984 1018 <literal>link</literal> or <literal>host</literal> or an unsigned integer in the range 0—255.
2959fb07
SS
1019 Defaults to <literal>global</literal>.</para>
1020 </listitem>
1021 </varlistentry>
e63be084
SS
1022 <varlistentry>
1023 <term><varname>HomeAddress=</varname></term>
1024 <listitem>
9b6ffef3 1025 <para>Takes a boolean. Designates this address the "home address" as defined in
e63be084
SS
1026 <ulink url="https://tools.ietf.org/html/rfc6275">RFC 6275</ulink>.
1027 Supported only on IPv6. Defaults to false.</para>
1028 </listitem>
1029 </varlistentry>
1030 <varlistentry>
1031 <term><varname>DuplicateAddressDetection=</varname></term>
1032 <listitem>
051e77ca
SS
1033 <para>Takes one of <literal>ipv4</literal>, <literal>ipv6</literal>,
1034 <literal>both</literal>, <literal>none</literal>. When <literal>ipv4</literal>,
1035 performs IPv4 Duplicate Address Detection. See
1036 <ulink url="https://tools.ietf.org/html/rfc5227">RFC 5224</ulink>.
1037 When <literal>ipv6</literal>, performs IPv6 Duplicate Address Detection. See
1038 <ulink url="https://tools.ietf.org/html/rfc4862">RFC 4862</ulink>.
1039 Defaults to <literal>ipv6</literal>.</para>
e63be084
SS
1040 </listitem>
1041 </varlistentry>
1042 <varlistentry>
1043 <term><varname>ManageTemporaryAddress=</varname></term>
1044 <listitem>
9b6ffef3 1045 <para>Takes a boolean. If true the kernel manage temporary addresses created
e63be084
SS
1046 from this one as template on behalf of Privacy Extensions
1047 <ulink url="https://tools.ietf.org/html/rfc3041">RFC 3041</ulink>. For this to become
1048 active, the use_tempaddr sysctl setting has to be set to a value greater than zero.
11fcfc53 1049 The given address needs to have a prefix length of 64. This flag allows using privacy
e63be084
SS
1050 extensions in a manually configured network, just like if stateless auto-configuration
1051 was active. Defaults to false. </para>
1052 </listitem>
1053 </varlistentry>
1054 <varlistentry>
de697db0 1055 <term><varname>AddPrefixRoute=</varname></term>
e63be084 1056 <listitem>
de697db0
YW
1057 <para>Takes a boolean. When true, the prefix route for the address is automatically added.
1058 Defaults to true.</para>
e63be084
SS
1059 </listitem>
1060 </varlistentry>
1061 <varlistentry>
1062 <term><varname>AutoJoin=</varname></term>
1063 <listitem>
9b6ffef3 1064 <para>Takes a boolean. Joining multicast group on ethernet level via
e63be084
SS
1065 <command>ip maddr</command> command would not work if we have an Ethernet switch that does
1066 IGMP snooping since the switch would not replicate multicast packets on ports that did not
1067 have IGMP reports for the multicast addresses. Linux vxlan interfaces created via
1068 <command>ip link add vxlan</command> or networkd's netdev kind vxlan have the group option
1069 that enables then to do the required join. By extending ip address command with option
1070 <literal>autojoin</literal> we can get similar functionality for openvswitch (OVS) vxlan
1071 interfaces as well as other tunneling mechanisms that need to receive multicast traffic.
1072 Defaults to <literal>no</literal>.</para>
1073 </listitem>
1074 </varlistentry>
798d3a52
ZJS
1075 </variablelist>
1076 </refsect1>
1077
e4a71bf3
WKI
1078 <refsect1>
1079 <title>[Neighbor] Section Options</title>
bdac5608
ZJS
1080 <para>A [Neighbor] section accepts the following keys. The neighbor section adds a permanent, static
1081 entry to the neighbor table (IPv6) or ARP table (IPv4) for the given hardware address on the links
1082 matched for the network. Specify several [Neighbor] sections to configure several static neighbors.
1083 </para>
e4a71bf3
WKI
1084
1085 <variablelist class='network-directives'>
1086 <varlistentry>
1087 <term><varname>Address=</varname></term>
1088 <listitem>
1089 <para>The IP address of the neighbor.</para>
1090 </listitem>
1091 </varlistentry>
1092 <varlistentry>
b956364d 1093 <term><varname>LinkLayerAddress=</varname></term>
e4a71bf3 1094 <listitem>
b956364d 1095 <para>The link layer address (MAC address or IP address) of the neighbor.</para>
e4a71bf3
WKI
1096 </listitem>
1097 </varlistentry>
1098 </variablelist>
1099 </refsect1>
1100
95b74ef6
SS
1101 <refsect1>
1102 <title>[IPv6AddressLabel] Section Options</title>
1103
bdac5608
ZJS
1104 <para>An [IPv6AddressLabel] section accepts the following keys. Specify several [IPv6AddressLabel]
1105 sections to configure several address labels. IPv6 address labels are used for address selection. See
1106 <ulink url="https://tools.ietf.org/html/rfc3484">RFC 3484</ulink>. Precedence is managed by userspace,
1107 and only the label itself is stored in the kernel</para>
95b74ef6
SS
1108
1109 <variablelist class='network-directives'>
1110 <varlistentry>
1111 <term><varname>Label=</varname></term>
1112 <listitem>
e9dd6984
ZJS
1113 <para>The label for the prefix, an unsigned integer in the range 0–4294967294.
1114 0xffffffff is reserved. This setting is mandatory.</para>
95b74ef6
SS
1115 </listitem>
1116 </varlistentry>
1117 <varlistentry>
1118 <term><varname>Prefix=</varname></term>
1119 <listitem>
1120 <para>IPv6 prefix is an address with a prefix length, separated by a slash <literal>/</literal> character.
1121 This key is mandatory. </para>
1122 </listitem>
1123 </varlistentry>
1124 </variablelist>
1125 </refsect1>
1126
bce67bbe
SS
1127 <refsect1>
1128 <title>[RoutingPolicyRule] Section Options</title>
1129
bdac5608 1130 <para>An [RoutingPolicyRule] section accepts the following keys. Specify several [RoutingPolicyRule]
bce67bbe
SS
1131 sections to configure several rules.</para>
1132
1133 <variablelist class='network-directives'>
1134 <varlistentry>
1135 <term><varname>TypeOfService=</varname></term>
1136 <listitem>
e9dd6984 1137 <para>Takes a number between 0 and 255 that specifies the type of service to match.</para>
bce67bbe
SS
1138 </listitem>
1139 </varlistentry>
1140 <varlistentry>
1141 <term><varname>From=</varname></term>
1142 <listitem>
1143 <para>Specifies the source address prefix to match. Possibly followed by a slash and the prefix length.</para>
1144 </listitem>
1145 </varlistentry>
1146 <varlistentry>
1147 <term><varname>To=</varname></term>
1148 <listitem>
1149 <para>Specifies the destination address prefix to match. Possibly followed by a slash and the prefix length.</para>
1150 </listitem>
1151 </varlistentry>
1152 <varlistentry>
1153 <term><varname>FirewallMark=</varname></term>
1154 <listitem>
1155 <para>Specifies the iptables firewall mark value to match (a number between 1 and 4294967295).</para>
1156 </listitem>
1157 </varlistentry>
1158 <varlistentry>
1159 <term><varname>Table=</varname></term>
1160 <listitem>
41b90a1e
YW
1161 <para>Specifies the routing table identifier to lookup if the rule selector matches. Takes
1162 one of <literal>default</literal>, <literal>main</literal>, and <literal>local</literal>,
1163 or a number between 1 and 4294967295. Defaults to <literal>main</literal>.</para>
bce67bbe
SS
1164 </listitem>
1165 </varlistentry>
1166 <varlistentry>
1167 <term><varname>Priority=</varname></term>
1168 <listitem>
1169 <para>Specifies the priority of this rule. <varname>Priority=</varname> is an unsigned
1170 integer. Higher number means lower priority, and rules get processed in order of increasing number.</para>
1171 </listitem>
1172 </varlistentry>
762e2659
SS
1173 <varlistentry>
1174 <term><varname>IncomingInterface=</varname></term>
1175 <listitem>
1176 <para>Specifies incoming device to match. If the interface is loopback, the rule only matches packets originating from this host.</para>
1177 </listitem>
1178 </varlistentry>
1179 <varlistentry>
1180 <term><varname>OutgoingInterface=</varname></term>
1181 <listitem>
1182 <para>Specifies the outgoing device to match. The outgoing interface is only available for packets originating from local sockets that are bound to a device.</para>
1183 </listitem>
1184 </varlistentry>
926062f0
SS
1185 <varlistentry>
1186 <term><varname>SourcePort=</varname></term>
1187 <listitem>
1188 <para>Specifies the source IP port or IP port range match in forwarding information base (FIB) rules.
1189 A port range is specified by the lower and upper port separated by a dash. Defaults to unset.</para>
1190 </listitem>
1191 </varlistentry>
1192 <varlistentry>
1193 <term><varname>DestinationPort=</varname></term>
1194 <listitem>
1195 <para>Specifies the destination IP port or IP port range match in forwarding information base (FIB) rules.
1196 A port range is specified by the lower and upper port separated by a dash. Defaults to unset.</para>
1197 </listitem>
1198 </varlistentry>
1199 <varlistentry>
97f9df9e 1200 <term><varname>IPProtocol=</varname></term>
926062f0 1201 <listitem>
3a269dcf
YW
1202 <para>Specifies the IP protocol to match in forwarding information base (FIB) rules. Takes IP protocol name such as <literal>tcp</literal>,
1203 <literal>udp</literal> or <literal>sctp</literal>, or IP protocol number such as <literal>6</literal> for <literal>tcp</literal> or
1204 <literal>17</literal> for <literal>udp</literal>.
926062f0
SS
1205 Defaults to unset.</para>
1206 </listitem>
1207 </varlistentry>
8b220643
SS
1208 <varlistentry>
1209 <term><varname>InvertRule=</varname></term>
1210 <listitem>
53e1ba28 1211 <para>A boolean. Specifies whether the rule is to be inverted. Defaults to false.</para>
8b220643
SS
1212 </listitem>
1213 </varlistentry>
f6c6ff97
YW
1214 <varlistentry>
1215 <term><varname>Family=</varname></term>
1216 <listitem>
1217 <para>Takes a special value <literal>ipv4</literal>, <literal>ipv6</literal>, or
1218 <literal>both</literal>. By default, the address family is determined by the address
1219 specified in <varname>To=</varname> or <varname>From=</varname>. If neither
1220 <varname>To=</varname> nor <varname>From=</varname> are specified, then defaults to
1221 <literal>ipv4</literal>.</para>
1222 </listitem>
1223 </varlistentry>
ea471a46
YW
1224 <varlistentry>
1225 <term><varname>User=</varname></term>
1226 <listitem>
1227 <para>Takes a username, a user ID, or a range of user IDs separated by a dash. Defaults to
1228 unset.</para>
1229 </listitem>
1230 </varlistentry>
53e1ba28
NF
1231 <varlistentry>
1232 <term><varname>SuppressPrefixLength=</varname></term>
1233 <listitem>
1234 <para>Takes a number <replaceable>N</replaceable> in the range 0-128 and rejects routing
1235 decisions that have a prefix length of <replaceable>N</replaceable> or less. Defaults to
1236 unset.</para>
1237 </listitem>
1238 </varlistentry>
bce67bbe 1239 </variablelist>
c16c7808
SS
1240 </refsect1>
1241
1242 <refsect1>
1243 <title>[NextHop] Section Options</title>
e9dd6984
ZJS
1244 <para>The [NextHop] section is used to manipulate entries in the kernel's "nexthop" tables. The
1245 [NextHop] section accepts the following keys. Specify several [NextHop] sections to configure several
1246 hops.</para>
c16c7808
SS
1247
1248 <variablelist class='network-directives'>
1249 <varlistentry>
1250 <term><varname>Gateway=</varname></term>
1251 <listitem>
bdac5608 1252 <para>As in the [Network] section. This is mandatory.</para>
c16c7808
SS
1253 </listitem>
1254 </varlistentry>
1255 <varlistentry>
1256 <term><varname>Id=</varname></term>
1257 <listitem>
1258 <para>The id of the nexthop (an unsigned integer). If unspecified or '0' then automatically chosen by kernel.</para>
1259 </listitem>
1260 </varlistentry>
1261 </variablelist>
bce67bbe
SS
1262 </refsect1>
1263
798d3a52
ZJS
1264 <refsect1>
1265 <title>[Route] Section Options</title>
bdac5608
ZJS
1266 <para>The [Route] section accepts the following keys. Specify several [Route] sections to configure
1267 several routes.</para>
798d3a52
ZJS
1268
1269 <variablelist class='network-directives'>
1270 <varlistentry>
1271 <term><varname>Gateway=</varname></term>
1272 <listitem>
427928ca
ZJS
1273 <para>Takes the gateway address or special value <literal>_dhcp</literal>. If
1274 <literal>_dhcp</literal>, then the gateway address provided by DHCP (or in the IPv6 case,
1985c54f 1275 provided by IPv6 RA) is used.</para>
798d3a52
ZJS
1276 </listitem>
1277 </varlistentry>
28959f7d 1278 <varlistentry>
9cb8c559 1279 <term><varname>GatewayOnLink=</varname></term>
28959f7d 1280 <listitem>
9b6ffef3 1281 <para>Takes a boolean. If set to true, the kernel does not have
28959f7d
SS
1282 to check if the gateway is reachable directly by the current machine (i.e., the kernel does
1283 not need to check if the gateway is attached to the local network), so that we can insert the
9b6ffef3 1284 route in the kernel table without it being complained about. Defaults to <literal>no</literal>.
28959f7d
SS
1285 </para>
1286 </listitem>
1287 </varlistentry>
798d3a52
ZJS
1288 <varlistentry>
1289 <term><varname>Destination=</varname></term>
1290 <listitem>
1291 <para>The destination prefix of the route. Possibly
b938cb90 1292 followed by a slash and the prefix length. If omitted, a
798d3a52
ZJS
1293 full-length host route is assumed.</para>
1294 </listitem>
1295 </varlistentry>
1296 <varlistentry>
1297 <term><varname>Source=</varname></term>
1298 <listitem>
1299 <para>The source prefix of the route. Possibly followed by
b938cb90 1300 a slash and the prefix length. If omitted, a full-length
798d3a52
ZJS
1301 host route is assumed.</para>
1302 </listitem>
1303 </varlistentry>
1304 <varlistentry>
1305 <term><varname>Metric=</varname></term>
1306 <listitem>
b938cb90 1307 <para>The metric of the route (an unsigned integer).</para>
798d3a52
ZJS
1308 </listitem>
1309 </varlistentry>
b5bf6f64
SS
1310 <varlistentry>
1311 <term><varname>IPv6Preference=</varname></term>
1312 <listitem>
1313 <para>Specifies the route preference as defined in <ulink
e9dd6984
ZJS
1314 url="https://tools.ietf.org/html/rfc4191">RFC 4191</ulink> for Router Discovery messages. Which
1315 can be one of <literal>low</literal> the route has a lowest priority, <literal>medium</literal>
1316 the route has a default priority or <literal>high</literal> the route has a highest priority.
1317 </para>
b5bf6f64
SS
1318 </listitem>
1319 </varlistentry>
769b56a3
TG
1320 <varlistentry>
1321 <term><varname>Scope=</varname></term>
1322 <listitem>
f5c38922
YW
1323 <para>The scope of the route, which can be <literal>global</literal>, <literal>site</literal>,
1324 <literal>link</literal>, <literal>host</literal>, or <literal>nowhere</literal>. For IPv4 route,
1325 defaults to <literal>host</literal> if <varname>Type=</varname> is <literal>local</literal>
1326 or <literal>nat</literal>, and <literal>link</literal> if <varname>Type=</varname> is
1327 <literal>broadcast</literal>, <literal>multicast</literal>, or <literal>anycast</literal>.
1328 In other cases, defaults to <literal>global</literal>.</para>
769b56a3 1329 </listitem>
0d07e595
JK
1330 </varlistentry>
1331 <varlistentry>
1332 <term><varname>PreferredSource=</varname></term>
1333 <listitem>
1334 <para>The preferred source address of the route. The address
1335 must be in the format described in
1336 <citerefentry project='man-pages'><refentrytitle>inet_pton</refentrytitle><manvolnum>3</manvolnum></citerefentry>.</para>
1337 </listitem>
769b56a3 1338 </varlistentry>
c953b24c 1339 <varlistentry>
f5c38922 1340 <term><varname>Table=</varname></term>
c953b24c 1341 <listitem>
f5c38922
YW
1342 <para>The table identifier for the route. Takes <literal>default</literal>,
1343 <literal>main</literal>, <literal>local</literal> or a number between 1 and 4294967295.
1344 The table can be retrieved using <command>ip route show table <replaceable>num</replaceable></command>.
1345 If unset and <varname>Type=</varname> is <literal>local</literal>, <literal>broadcast</literal>,
1346 <literal>anycast</literal>, or <literal>nat</literal>, then <literal>local</literal> is used.
1347 In other cases, defaults to <literal>main</literal>.
c953b24c
SS
1348 </para>
1349 </listitem>
1350 </varlistentry>
c83ecc04
SS
1351 <varlistentry>
1352 <term><varname>Protocol=</varname></term>
1353 <listitem>
88925d2f 1354 <para>The protocol identifier for the route. Takes a number between 0 and 255 or the special values
ca420b62
YW
1355 <literal>kernel</literal>, <literal>boot</literal>, <literal>static</literal>,
1356 <literal>ra</literal> and <literal>dhcp</literal>. Defaults to <literal>static</literal>.
c83ecc04
SS
1357 </para>
1358 </listitem>
1359 </varlistentry>
983226f3
SS
1360 <varlistentry>
1361 <term><varname>Type=</varname></term>
1362 <listitem>
94d6e299
YW
1363 <para>Specifies the type for the route. Takes one of <literal>unicast</literal>,
1364 <literal>local</literal>, <literal>broadcast</literal>, <literal>anycast</literal>,
1365 <literal>multicast</literal>, <literal>blackhole</literal>, <literal>unreachable</literal>,
1366 <literal>prohibit</literal>, <literal>throw</literal>, <literal>nat</literal>, and
1367 <literal>xresolve</literal>. If <literal>unicast</literal>, a regular route is defined, i.e. a
66d7235e
LP
1368 route indicating the path to take to a destination network address. If <literal>blackhole</literal>, packets
1369 to the defined route are discarded silently. If <literal>unreachable</literal>, packets to the defined route
1370 are discarded and the ICMP message "Host Unreachable" is generated. If <literal>prohibit</literal>, packets
1371 to the defined route are discarded and the ICMP message "Communication Administratively Prohibited" is
1372 generated. If <literal>throw</literal>, route lookup in the current routing table will fail and the route
1373 selection process will return to Routing Policy Database (RPDB). Defaults to <literal>unicast</literal>.
983226f3
SS
1374 </para>
1375 </listitem>
1376 </varlistentry>
323d9329
SS
1377 <varlistentry>
1378 <term><varname>InitialCongestionWindow=</varname></term>
1379 <listitem>
6b21ad33
SS
1380 <para>The TCP initial congestion window is used during the start of a TCP connection. During the start of a TCP
1381 session, when a client requests a resource, the server's initial congestion window determines how many data bytes
1382 will be sent during the initial burst of data. Takes a size in bytes between 1 and 4294967295 (2^32 - 1). The usual
025314d9 1383 suffixes K, M, G are supported and are understood to the base of 1024. When unset, the kernel's default will be used.
323d9329
SS
1384 </para>
1385 </listitem>
1386 </varlistentry>
1387 <varlistentry>
1388 <term><varname>InitialAdvertisedReceiveWindow=</varname></term>
1389 <listitem>
5238e957 1390 <para>The TCP initial advertised receive window is the amount of receive data (in bytes) that can initially be buffered at one time
6b21ad33
SS
1391 on a connection. The sending host can send only that amount of data before waiting for an acknowledgment and window update
1392 from the receiving host. Takes a size in bytes between 1 and 4294967295 (2^32 - 1). The usual suffixes K, M, G are supported
025314d9 1393 and are understood to the base of 1024. When unset, the kernel's default will be used.
323d9329
SS
1394 </para>
1395 </listitem>
1396 </varlistentry>
09f5dfad
SS
1397 <varlistentry>
1398 <term><varname>QuickAck=</varname></term>
1399 <listitem>
9b6ffef3 1400 <para>Takes a boolean. When true enables TCP quick ack mode for the route. When unset, the kernel's default will be used.
09f5dfad
SS
1401 </para>
1402 </listitem>
1403 </varlistentry>
633c7258
SS
1404 <varlistentry>
1405 <term><varname>FastOpenNoCookie=</varname></term>
1406 <listitem>
1407 <para>Takes a boolean. When true enables TCP fastopen without a cookie on a per-route basis.
1408 When unset, the kernel's default will be used.
1409 </para>
1410 </listitem>
09f5dfad 1411 </varlistentry>
9b88f20a
SS
1412 <varlistentry>
1413 <term><varname>TTLPropagate=</varname></term>
1414 <listitem>
1415 <para>Takes a boolean. When true enables TTL propagation at Label Switched Path (LSP) egress.
1416 When unset, the kernel's default will be used.
1417 </para>
1418 </listitem>
1419 </varlistentry>
cea79e66
SS
1420 <varlistentry>
1421 <term><varname>MTUBytes=</varname></term>
1422 <listitem>
1423 <para>The maximum transmission unit in bytes to set for the
1424 route. The usual suffixes K, M, G, are supported and are
1425 understood to the base of 1024.</para>
1426 <para>Note that if IPv6 is enabled on the interface, and the MTU is chosen
1427 below 1280 (the minimum MTU for IPv6) it will automatically be increased to this value.</para>
1428 </listitem>
afe42aef
SC
1429 </varlistentry>
1430 <varlistentry>
1431 <term><varname>IPServiceType=</varname></term>
1432 <listitem>
e681a2ee
YW
1433 <para>Takes string; <literal>CS6</literal> or <literal>CS4</literal>. Used to set IP
1434 service type to CS6 (network control) or CS4 (Realtime). Defaults to CS6.</para>
afe42aef
SC
1435 </listitem>
1436 </varlistentry>
6ff5cc6b
YW
1437 <varlistentry>
1438 <term><varname>MultiPathRoute=<replaceable>address</replaceable>[@<replaceable>name</replaceable>] [<replaceable>weight</replaceable>]</varname></term>
1439 <listitem>
1440 <para>Configures multipath route. Multipath routing is the technique of using multiple
1441 alternative paths through a network. Takes gateway address. Optionally, takes a network
1442 interface name or index separated with <literal>@</literal>, and a weight in 1..256 for
1443 this multipath route separated with whitespace. This setting can be specified multiple
1444 times. If an empty string is assigned, then the all previous assignments are cleared.</para>
1445 </listitem>
1446 </varlistentry>
798d3a52
ZJS
1447 </variablelist>
1448 </refsect1>
1449
1450 <refsect1>
4f7331a8 1451 <title>[DHCPv4] Section Options</title>
bdac5608 1452 <para>The [DHCPv4] section configures the DHCPv4 client, if it is enabled with the
ad943783 1453 <varname>DHCP=</varname> setting described above:</para>
798d3a52
ZJS
1454
1455 <variablelist class='network-directives'>
1456 <varlistentry>
1457 <term><varname>UseDNS=</varname></term>
1458 <listitem>
1459 <para>When true (the default), the DNS servers received
1460 from the DHCP server will be used and take precedence over
1461 any statically configured ones.</para>
e88d8021
ZJS
1462
1463 <para>This corresponds to the <option>nameserver</option>
ad943783
LP
1464 option in <citerefentry
1465 project='man-pages'><refentrytitle>resolv.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para>
798d3a52
ZJS
1466 </listitem>
1467 </varlistentry>
a24e12f0
YW
1468 <varlistentry>
1469 <term><varname>RoutesToDNS=</varname></term>
1470 <listitem>
1471 <para>When true, the routes to the DNS servers received from the DHCP server will be
1472 configured. When <varname>UseDNS=</varname> is disabled, this setting is ignored.
f7e7bb65 1473 Defaults to false.</para>
a24e12f0
YW
1474 </listitem>
1475 </varlistentry>
301f4073
MM
1476 <varlistentry>
1477 <term><varname>UseNTP=</varname></term>
1478 <listitem>
2a71d57f
LP
1479 <para>When true (the default), the NTP servers received from the DHCP server will be used by
1480 <filename>systemd-timesyncd.service</filename> and take precedence over any statically configured
1481 ones.</para>
301f4073
MM
1482 </listitem>
1483 </varlistentry>
299d578f
SS
1484 <varlistentry>
1485 <term><varname>UseSIP=</varname></term>
1486 <listitem>
2a71d57f
LP
1487 <para>When true (the default), the SIP servers received from the DHCP server will be collected
1488 and made available to client programs.</para>
299d578f
SS
1489 </listitem>
1490 </varlistentry>
284e8fd0 1491
798d3a52
ZJS
1492 <varlistentry>
1493 <term><varname>UseMTU=</varname></term>
1494 <listitem>
1495 <para>When true, the interface maximum transmission unit
1496 from the DHCP server will be used on the current link.
7169cdc8 1497 If <varname>MTUBytes=</varname> is set, then this setting is ignored.
95ab9eff 1498 Defaults to false.</para>
798d3a52
ZJS
1499 </listitem>
1500 </varlistentry>
7585baa0 1501 <varlistentry>
1502 <term><varname>Anonymize=</varname></term>
1503 <listitem>
9b6ffef3 1504 <para>Takes a boolean. When true, the options sent to the DHCP server will
7585baa0 1505 follow the <ulink url="https://tools.ietf.org/html/rfc7844">RFC 7844</ulink>
1506 (Anonymity Profiles for DHCP Clients) to minimize disclosure of identifying information.
1507 Defaults to false.</para>
1508
1509 <para>This option should only be set to true when
1510 <varname>MACAddressPolicy=</varname> is set to <literal>random</literal>
1511 (see <citerefentry
1512 project='man-pages'><refentrytitle>systemd.link</refentrytitle><manvolnum>5</manvolnum></citerefentry>).</para>
1513
1514 <para>Note that this configuration will overwrite others.
1515 In concrete, the following variables will be ignored:
1516 <varname>SendHostname=</varname>, <varname>ClientIdentifier=</varname>,
da2076a1
TK
1517 <varname>UseRoutes=</varname>, <varname>UseMTU=</varname>,
1518 <varname>VendorClassIdentifier=</varname>, <varname>UseTimezone=</varname>.</para>
fba10579
LP
1519
1520 <para>With this option enabled DHCP requests will mimic those generated by Microsoft Windows, in
1521 order to reduce the ability to fingerprint and recognize installations. This means DHCP request
1522 sizes will grow and lease data will be more comprehensive than normally, though most of the
1523 requested data is not actually used.</para>
7585baa0 1524 </listitem>
1525 </varlistentry>
798d3a52
ZJS
1526 <varlistentry>
1527 <term><varname>SendHostname=</varname></term>
1528 <listitem>
31ee3973
YW
1529 <para>When true (the default), the machine's hostname will be sent to the DHCP server.
1530 Note that the machine's hostname must consist only of 7-bit ASCII lower-case characters and
1531 no spaces or dots, and be formatted as a valid DNS domain name. Otherwise, the hostname is not
cad8d671 1532 sent even if this is set to true.</para>
798d3a52
ZJS
1533 </listitem>
1534 </varlistentry>
7b8d23a9
SS
1535
1536 <varlistentry>
1537 <term><varname>MUDURL=</varname></term>
1538 <listitem>
1539 <para>When configured, the Manufacturer Usage Descriptions (MUD) URL will be sent to the
1540 DHCPv4 server. Takes an URL of length up to 255 characters. A superficial verification that
1541 the string is a valid URL will be performed. DHCPv4 clients are intended to have at most one
1542 MUD URL associated with them. See
1543 <ulink url="https://tools.ietf.org/html/rfc8520">RFC 8520</ulink>.</para>
1544 </listitem>
1545 </varlistentry>
1546
798d3a52
ZJS
1547 <varlistentry>
1548 <term><varname>UseHostname=</varname></term>
1549 <listitem>
1550 <para>When true (the default), the hostname received from
31ee3973 1551 the DHCP server will be set as the transient hostname of the system.
d59be2cf 1552 </para>
798d3a52
ZJS
1553 </listitem>
1554 </varlistentry>
1adc5d0b 1555 <varlistentry>
31ee3973
YW
1556 <term><varname>Hostname=</varname></term>
1557 <listitem>
1558 <para>Use this value for the hostname which is sent to the DHCP server, instead of machine's hostname.
1559 Note that the specified hostname must consist only of 7-bit ASCII lower-case characters and
1560 no spaces or dots, and be formatted as a valid DNS domain name.</para>
1561 </listitem>
1562 </varlistentry>
798d3a52
ZJS
1563 <varlistentry>
1564 <term><varname>UseDomains=</varname></term>
1565 <listitem>
9b6ffef3 1566 <para>Takes a boolean, or the special value <literal>route</literal>. When true, the domain name
b2a81c0b
LP
1567 received from the DHCP server will be used as DNS search domain over this link, similar to the effect of
1568 the <option>Domains=</option> setting. If set to <literal>route</literal>, the domain name received from
1569 the DHCP server will be used for routing DNS queries only, but not for searching, similar to the effect of
1570 the <option>Domains=</option> setting when the argument is prefixed with <literal>~</literal>. Defaults to
1571 false.</para>
1572
1573 <para>It is recommended to enable this option only on trusted networks, as setting this affects resolution
38b38500 1574 of all hostnames, in particular of single-label names. It is generally safer to use the supplied domain
b2a81c0b
LP
1575 only as routing domain, rather than as search domain, in order to not have it affect local resolution of
1576 single-label names.</para>
1577
1578 <para>When set to true, this setting corresponds to the <option>domain</option> option in <citerefentry
1579 project='man-pages'><refentrytitle>resolv.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para>
798d3a52
ZJS
1580 </listitem>
1581 </varlistentry>
1582 <varlistentry>
1583 <term><varname>UseRoutes=</varname></term>
1584 <listitem>
d6eac9bd
DW
1585 <para>When true (the default), the static routes will be requested from the DHCP server and added to the
1586 routing table with a metric of 1024, and a scope of "global", "link" or "host", depending on the route's
1587 destination and gateway. If the destination is on the local host, e.g., 127.x.x.x, or the same as the
1588 link's own address, the scope will be set to "host". Otherwise if the gateway is null (a direct route), a
1589 "link" scope will be used. For anything else, scope defaults to "global".</para>
798d3a52
ZJS
1590 </listitem>
1591 </varlistentry>
b4531227
YW
1592 <varlistentry>
1593 <term><varname>UseGateway=</varname></term>
1594 <listitem>
589397a2
DS
1595 <para>When true, the gateway will be requested from the DHCP server and added to the routing table with a
1596 metric of 1024, and a scope of "link". When unset, the value specified with <option>UseRoutes=</option>
1597 is used.</para>
b4531227
YW
1598 </listitem>
1599 </varlistentry>
ad943783
LP
1600 <varlistentry>
1601 <term><varname>UseTimezone=</varname></term>
1602
1603 <listitem><para>When true, the timezone received from the
7f3fdb7f 1604 DHCP server will be set as timezone of the local
ad943783
LP
1605 system. Defaults to <literal>no</literal>.</para></listitem>
1606 </varlistentry>
1607
3e43b2cd
JJ
1608 <varlistentry>
1609 <term><varname>ClientIdentifier=</varname></term>
1610 <listitem>
dace710c
YW
1611 <para>The DHCPv4 client identifier to use. Takes one of <literal>mac</literal>, <literal>duid</literal> or <literal>duid-only</literal>.
1612 If set to <literal>mac</literal>, the MAC address of the link is used.
1613 If set to <literal>duid</literal>, an RFC4361-compliant Client ID, which is the combination of IAID and DUID (see below), is used.
1614 If set to <literal>duid-only</literal>, only DUID is used, this may not be RFC compliant, but some setups may require to use this.
1615 Defaults to <literal>duid</literal>.</para>
3e43b2cd
JJ
1616 </listitem>
1617 </varlistentry>
e2e08e77 1618
798d3a52
ZJS
1619 <varlistentry>
1620 <term><varname>VendorClassIdentifier=</varname></term>
1621 <listitem>
1622 <para>The vendor class identifier used to identify vendor
1623 type and configuration.</para>
1624 </listitem>
1625 </varlistentry>
076ea6f6 1626
af1c0de0
SS
1627 <varlistentry>
1628 <term><varname>UserClass=</varname></term>
1629 <listitem>
1630 <para>A DHCPv4 client can use UserClass option to identify the type or category of user or applications
1631 it represents. The information contained in this option is a string that represents the user class of which
1632 the client is a member. Each class sets an identifying string of information to be used by the DHCP
1633 service to classify clients. Takes a whitespace-separated list of strings.</para>
1634 </listitem>
1635 </varlistentry>
1636
715cedfb
SS
1637 <varlistentry>
1638 <term><varname>MaxAttempts=</varname></term>
1639 <listitem>
1640 <para>Specifies how many times the DHCPv4 client configuration should be attempted. Takes a
1641 number or <literal>infinity</literal>. Defaults to <literal>infinity</literal>.
1642 Note that the time between retries is increased exponentially, so the network will not be
1643 overloaded even if this number is high.</para>
1644 </listitem>
1645 </varlistentry>
1646
e2e08e77
ZJS
1647 <varlistentry>
1648 <term><varname>DUIDType=</varname></term>
1649 <listitem>
1650 <para>Override the global <varname>DUIDType</varname> setting for this network. See
1651 <citerefentry><refentrytitle>networkd.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>
1652 for a description of possible values.</para>
1653 </listitem>
1654 </varlistentry>
076ea6f6 1655
e2e08e77
ZJS
1656 <varlistentry>
1657 <term><varname>DUIDRawData=</varname></term>
1658 <listitem>
1659 <para>Override the global <varname>DUIDRawData</varname> setting for this network. See
1660 <citerefentry><refentrytitle>networkd.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>
1661 for a description of possible values.</para>
076ea6f6
LP
1662 </listitem>
1663 </varlistentry>
e2e08e77 1664
d05def16
LP
1665 <varlistentry>
1666 <term><varname>IAID=</varname></term>
1667 <listitem>
1668 <para>The DHCP Identity Association Identifier (IAID) for the interface, a 32-bit unsigned integer.</para>
1669 </listitem>
1670 </varlistentry>
1671
798d3a52
ZJS
1672 <varlistentry>
1673 <term><varname>RequestBroadcast=</varname></term>
1674 <listitem>
1675 <para>Request the server to use broadcast messages before
1676 the IP address has been configured. This is necessary for
1677 devices that cannot receive RAW packets, or that cannot
1678 receive packets at all before an IP address has been
1679 configured. On the other hand, this must not be enabled on
1680 networks where broadcasts are filtered out.</para>
1681 </listitem>
1682 </varlistentry>
e2e08e77 1683
798d3a52
ZJS
1684 <varlistentry>
1685 <term><varname>RouteMetric=</varname></term>
1686 <listitem>
1bf1bfd9 1687 <para>Set the routing metric for routes specified by the DHCP server. Defaults to 1024.</para>
798d3a52
ZJS
1688 </listitem>
1689 </varlistentry>
f594276b
JK
1690
1691 <varlistentry>
1692 <term><varname>RouteTable=<replaceable>num</replaceable></varname></term>
1693 <listitem>
d11e656a 1694 <para>The table identifier for DHCP routes (a number between 1 and 4294967295, or 0 to unset).
f594276b
JK
1695 The table can be retrieved using <command>ip route show table <replaceable>num</replaceable></command>.
1696 </para>
e9dd6984
ZJS
1697 <para>When used in combination with <varname>VRF=</varname>, the
1698 VRF's routing table is used when this parameter is not specified.
917b2260 1699 </para>
f594276b
JK
1700 </listitem>
1701 </varlistentry>
9faed222 1702
c695dcf9
SS
1703 <varlistentry>
1704 <term><varname>RouteMTUBytes=</varname></term>
1705 <listitem>
1706 <para>Specifies the MTU for the DHCP routes. Please see the [Route] section for further details.</para>
1707 </listitem>
1708 </varlistentry>
1709
9faed222
SS
1710 <varlistentry>
1711 <term><varname>ListenPort=</varname></term>
1712 <listitem>
1713 <para>Allow setting custom port for the DHCP client to listen on.</para>
1714 </listitem>
1715 </varlistentry>
fb5c8216 1716
d6463307
SS
1717 <varlistentry>
1718 <term><varname>FallbackLeaseLifetimeSec=</varname></term>
1719 <listitem>
1720 <para>Allows to set DHCPv4 lease lifetime when DHCPv4 server does not send the lease lifetime.
1721 Takes one of <literal>forever</literal> or <literal>infinity</literal> means that the address
1722 never expires. Defaults to unset.</para>
1723 </listitem>
1724 </varlistentry>
1725
1501b429
SS
1726 <varlistentry>
1727 <term><varname>SendRelease=</varname></term>
1728 <listitem>
1729 <para>When true, the DHCPv4 client sends a DHCP release packet when it stops.
5f3b5f19 1730 Defaults to true.</para>
1501b429
SS
1731 </listitem>
1732 </varlistentry>
1733
0f3ff4ea
SS
1734 <varlistentry>
1735 <term><varname>SendDecline=</varname></term>
1736 <listitem>
e9dd6984
ZJS
1737 <para>A boolean. When <literal>true</literal>, the DHCPv4 client receives the IP address from the
1738 DHCP server. After a new IP is received, the DHCPv4 client performs IPv4 Duplicate Address
1739 Detection. If duplicate use is detected, the DHCPv4 client rejects the IP by sending a
1740 DHCPDECLINE packet and tries to obtain an IP address again. See <ulink
1741 url="https://tools.ietf.org/html/rfc5227">RFC 5224</ulink>. Defaults to
1742 <literal>unset</literal>.</para>
0f3ff4ea
SS
1743 </listitem>
1744 </varlistentry>
1745
caa8ca42 1746 <varlistentry>
6b000af4 1747 <term><varname>DenyList=</varname></term>
5bc945be 1748 <listitem>
98ebef62
SS
1749 <para>A whitespace-separated list of IPv4 addresses. DHCP offers from servers in the list are rejected. Note that
1750 if <varname>AllowList=</varname> is configured then <varname>DenyList=</varname> is ignored.</para>
1751 </listitem>
1752 </varlistentry>
1753
1754 <varlistentry>
1755 <term><varname>AllowList=</varname></term>
1756 <listitem>
1757 <para>A whitespace-separated list of IPv4 addresses. DHCP offers from servers in the list are accepted.</para>
5bc945be
SS
1758 </listitem>
1759 </varlistentry>
1760
1761 <varlistentry>
1762 <term><varname>RequestOptions=</varname></term>
caa8ca42 1763 <listitem>
35f6a5cb
SS
1764 <para>When configured, allows to set arbitrary request options in the DHCPv4 request options list and will be
1765 sent to the DHCPV4 server. A whitespace-separated list of integers in the range 1..254. Defaults to unset.</para>
caa8ca42
SS
1766 </listitem>
1767 </varlistentry>
1768
cb29c156 1769 <varlistentry>
864edb39 1770 <term><varname>SendOption=</varname></term>
cb29c156 1771 <listitem>
7354900d
DW
1772 <para>Send an arbitrary raw option in the DHCPv4 request. Takes a DHCP option number, data type
1773 and data separated with a colon
1774 (<literal><replaceable>option</replaceable>:<replaceable>type</replaceable>:<replaceable>value</replaceable></literal>).
1775 The option number must be an integer in the range 1..254. The type takes one of <literal>uint8</literal>,
1776 <literal>uint16</literal>, <literal>uint32</literal>, <literal>ipv4address</literal>, or
1777 <literal>string</literal>. Special characters in the data string may be escaped using
1778 <ulink url="https://en.wikipedia.org/wiki/Escape_sequences_in_C#Table_of_escape_sequences">C-style
1779 escapes</ulink>. This setting can be specified multiple times. If an empty string is specified,
1780 then all options specified earlier are cleared. Defaults to unset.</para>
1781 </listitem>
1782 </varlistentry>
1783
1784 <varlistentry>
1785 <term><varname>SendVendorOption=</varname></term>
1786 <listitem>
1787 <para>Send an arbitrary vendor option in the DHCPv4 request. Takes a DHCP option number, data type
d8b736bd
YW
1788 and data separated with a colon
1789 (<literal><replaceable>option</replaceable>:<replaceable>type</replaceable>:<replaceable>value</replaceable></literal>).
11fcfc53 1790 The option number must be an integer in the range 1..254. The type takes one of <literal>uint8</literal>,
d8b736bd
YW
1791 <literal>uint16</literal>, <literal>uint32</literal>, <literal>ipv4address</literal>, or
1792 <literal>string</literal>. Special characters in the data string may be escaped using
a2cc708a 1793 <ulink url="https://en.wikipedia.org/wiki/Escape_sequences_in_C#Table_of_escape_sequences">C-style
d8b736bd 1794 escapes</ulink>. This setting can be specified multiple times. If an empty string is specified,
a2cc708a 1795 then all options specified earlier are cleared. Defaults to unset.</para>
cb29c156
SS
1796 </listitem>
1797 </varlistentry>
caa8ca42
SS
1798 </variablelist>
1799 </refsect1>
1800
1801 <refsect1>
1802 <title>[DHCPv6] Section Options</title>
bdac5608 1803 <para>The [DHCPv6] section configures the DHCPv6 client, if it is enabled with the
4f7331a8 1804 <varname>DHCP=</varname> setting described above, or invoked by the IPv6 Router Advertisement:</para>
caa8ca42
SS
1805
1806 <variablelist class='network-directives'>
1807 <varlistentry>
1808 <term><varname>UseDNS=</varname></term>
1809 <term><varname>UseNTP=</varname></term>
1810 <listitem>
bdac5608 1811 <para>As in the [DHCPv4] section.</para>
caa8ca42
SS
1812 </listitem>
1813 </varlistentry>
1814
1bf1bfd9
YW
1815 <varlistentry>
1816 <term><varname>RouteMetric=</varname></term>
1817 <listitem>
1818 <para>Set the routing metric for routes specified by the DHCP server. Defaults to 1024.</para>
1819 </listitem>
1820 </varlistentry>
1821
fb5c8216
SS
1822 <varlistentry>
1823 <term><varname>RapidCommit=</varname></term>
1824 <listitem>
9b6ffef3 1825 <para>Takes a boolean. The DHCPv6 client can obtain configuration parameters from a DHCPv6 server through
fb5c8216
SS
1826 a rapid two-message exchange (solicit and reply). When the rapid commit option is enabled by both
1827 the DHCPv6 client and the DHCPv6 server, the two-message exchange is used, rather than the default
e9dd6984 1828 four-message exchange (solicit, advertise, request, and reply). The two-message exchange provides
fb5c8216
SS
1829 faster client configuration and is beneficial in environments in which networks are under a heavy load.
1830 See <ulink url="https://tools.ietf.org/html/rfc3315#section-17.2.1">RFC 3315</ulink> for details.
1831 Defaults to true.</para>
1832 </listitem>
1833 </varlistentry>
1834
3175a8c2
SS
1835 <varlistentry>
1836 <term><varname>MUDURL=</varname></term>
1837 <listitem>
1838 <para>When configured, the Manufacturer Usage Descriptions (MUD) URL will be sent to the DHCPV6 server.
1839 Takes an URL of length up to 255 characters. A superficial verification that the string is a valid URL
1840 will be performed. DHCPv6 clients are intended to have at most one MUD URL associated with them. See
1841 <ulink url="https://tools.ietf.org/html/rfc8520">RFC 8520</ulink>.</para>
1842 </listitem>
1843 </varlistentry>
1844
35f6a5cb
SS
1845 <varlistentry>
1846 <term><varname>RequestOptions=</varname></term>
1847 <listitem>
1848 <para>When configured, allows to set arbitrary request options in the DHCPv6 request options list and will
1849 sent to the DHCPV6 server. A whitespace-separated list of integers in the range 1..254. Defaults to unset.</para>
1850 </listitem>
1851 </varlistentry>
1852
b4ccc5de
SS
1853 <varlistentry>
1854 <term><varname>SendVendorOption=</varname></term>
1855 <listitem>
e9dd6984
ZJS
1856 <para>Send an arbitrary vendor option in the DHCPv6 request. Takes an enterprise identifier, DHCP
1857 option number, data type, and data separated with a colon (<literal><replaceable>enterprise
1858 identifier</replaceable>:<replaceable>option</replaceable>:<replaceable>type</replaceable>:
1859 <replaceable>value</replaceable></literal>). Enterprise identifier is an unsigned integer in the
1860 range 1–4294967294. The option number must be an integer in the range 1–254. Data type takes one
1861 of <literal>uint8</literal>, <literal>uint16</literal>, <literal>uint32</literal>,
1862 <literal>ipv4address</literal>, <literal>ipv6address</literal>, or
1863 <literal>string</literal>. Special characters in the data string may be escaped using <ulink
1864 url="https://en.wikipedia.org/wiki/Escape_sequences_in_C#Table_of_escape_sequences">C-style
b4ccc5de
SS
1865 escapes</ulink>. This setting can be specified multiple times. If an empty string is specified,
1866 then all options specified earlier are cleared. Defaults to unset.</para>
1867 </listitem>
1868 </varlistentry>
1869
125f20b4
PF
1870 <varlistentry>
1871 <term><varname>ForceDHCPv6PDOtherInformation=</varname></term>
1872 <listitem>
9b6ffef3 1873 <para>Takes a boolean that enforces DHCPv6 stateful mode when the 'Other information' bit is set in
125f20b4
PF
1874 Router Advertisement messages. By default setting only the 'O' bit in Router Advertisements
1875 makes DHCPv6 request network information in a stateless manner using a two-message Information
1876 Request and Information Reply message exchange.
1877 <ulink url="https://tools.ietf.org/html/rfc7084">RFC 7084</ulink>, requirement WPD-4, updates
1878 this behavior for a Customer Edge router so that stateful DHCPv6 Prefix Delegation is also
1879 requested when only the 'O' bit is set in Router Advertisements. This option enables such a CE
1880 behavior as it is impossible to automatically distinguish the intention of the 'O' bit otherwise.
1881 By default this option is set to 'false', enable it if no prefixes are delegated when the device
1882 should be acting as a CE router.</para>
1883 </listitem>
1884 </varlistentry>
1885
2805536b
SS
1886 <varlistentry>
1887 <term><varname>PrefixDelegationHint=</varname></term>
1888 <listitem>
e9dd6984
ZJS
1889 <para>Takes an IPv6 address with prefix length in the same format as the
1890 <varname>Address=</varname> in the [Network] section. The DHCPv6 client will include a prefix
1891 hint in the DHCPv6 solicitation sent to the server. The prefix length must be in the range
1892 1–128. Defaults to unset.</para>
2805536b
SS
1893 </listitem>
1894 </varlistentry>
cd305af1
SS
1895
1896 <varlistentry>
1897 <term><varname>WithoutRA=</varname></term>
1898 <listitem>
e9dd6984
ZJS
1899 <para>Allows DHCPv6 client to start without router advertisements's managed or other address
1900 configuration flag. Takes one of <literal>solicit</literal> or
1901 <literal>information-request</literal>. Defaults to unset.</para>
cd305af1
SS
1902 </listitem>
1903 </varlistentry>
e7d5fe17
AD
1904
1905 <varlistentry>
1906 <term><varname>SendOption=</varname></term>
1907 <listitem>
bdac5608 1908 <para>As in the [DHCPv4] section, however because DHCPv6 uses 16-bit fields to store
e7d5fe17
AD
1909 option numbers, the option number is an integer in the range 1..65536.</para>
1910 </listitem>
1911 </varlistentry>
f37f2a6b
SS
1912
1913 <varlistentry>
1914 <term><varname>UserClass=</varname></term>
1915 <listitem>
1916 <para>A DHCPv6 client can use User Class option to identify the type or category of user or applications
1917 it represents. The information contained in this option is a string that represents the user class of which
1918 the client is a member. Each class sets an identifying string of information to be used by the DHCP
1919 service to classify clients. Special characters in the data string may be escaped using
1920 <ulink url="https://en.wikipedia.org/wiki/Escape_sequences_in_C#Table_of_escape_sequences">C-style
1921 escapes</ulink>. This setting can be specified multiple times. If an empty string is specified,
1922 then all options specified earlier are cleared. Takes a whitespace-separated list of strings. Note that
1923 currently NUL bytes are not allowed.</para>
1924 </listitem>
1925 </varlistentry>
ed0d1b2e
SS
1926
1927 <varlistentry>
1928 <term><varname>VendorClass=</varname></term>
1929 <listitem>
1930 <para>A DHCPv6 client can use VendorClass option to identify the vendor that
1931 manufactured the hardware on which the client is running. The information
1932 contained in the data area of this option is contained in one or more opaque
1933 fields that identify details of the hardware configuration. Takes a
1934 whitespace-separated list of strings.</para>
1935 </listitem>
1936 </varlistentry>
ad943783 1937 </variablelist>
caa8ca42 1938 </refsect1>
99e015e2
YW
1939
1940 <refsect1>
1941 <title>[DHCPv6PrefixDelegation] Section Options</title>
1942 <para>The [DHCPv6PrefixDelegation] section configures delegated prefix assigned by DHCPv6 server.
1943 The settings in this section are used only when <varname>IPv6PrefixDelegation=</varname> setting is
1944 enabled, or set to <literal>dhcp6</literal>.</para>
1945
1946 <variablelist class='network-directives'>
1947 <varlistentry>
1948 <term><varname>SubnetId=</varname></term>
1949 <listitem>
1950 <para>Configure a specific subnet ID on the interface from a (previously) received prefix
1951 delegation. You can either set "auto" (the default) or a specific subnet ID (as defined in
1952 <ulink url="https://tools.ietf.org/html/rfc4291#section-2.5.4">RFC 4291</ulink>, section
1953 2.5.4), in which case the allowed value is hexadecimal, from 0 to 0x7fffffffffffffff
1954 inclusive. This option is only effective when used together with
1955 <varname>IPv6PrefixDelegation=</varname> and the corresponding configuration on the upstream
1956 interface.</para>
1957 </listitem>
1958 </varlistentry>
1959
1960 <varlistentry>
1961 <term><varname>Assign=</varname></term>
1962 <listitem>
1963 <para>Takes a boolean. Specifies whether to add an address from the delegated prefixes which
1964 are received from the WAN interface by the <varname>IPv6PrefixDelegation=</varname>. When
1965 true (on LAN interfce), the EUI-64 algorithm will be used to form an interface identifier
1966 from the delegated prefixes. Defaults to true.</para>
1967 </listitem>
1968 </varlistentry>
1969
1970 <varlistentry>
1971 <term><varname>Token=</varname></term>
1972 <listitem>
1973 <para>Specifies an optional address generation mode for <varname>Assign=</varname>. Takes an
1974 IPv6 address. When set, the lower bits of the supplied address are combined with the upper
1975 bits of a delegatad prefix received from the WAN interface by the
1976 <varname>IPv6PrefixDelegation=</varname> prefixes to form a complete address.</para>
1977 </listitem>
1978 </varlistentry>
1979 </variablelist>
1980 </refsect1>
413708d1 1981
1e7a0e21 1982 <refsect1>
f921f573 1983 <title>[IPv6AcceptRA] Section Options</title>
bdac5608
ZJS
1984 <para>The [IPv6AcceptRA] section configures the IPv6 Router Advertisement (RA) client, if it is enabled
1985 with the <varname>IPv6AcceptRA=</varname> setting described above:</para>
1e7a0e21
LP
1986
1987 <variablelist class='network-directives'>
1988 <varlistentry>
1989 <term><varname>UseDNS=</varname></term>
1990 <listitem>
1991 <para>When true (the default), the DNS servers received in the Router Advertisement will be used and take
1992 precedence over any statically configured ones.</para>
1993
1994 <para>This corresponds to the <option>nameserver</option> option in <citerefentry
1995 project='man-pages'><refentrytitle>resolv.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para>
1996 </listitem>
1997 </varlistentry>
1998
1999 <varlistentry>
2000 <term><varname>UseDomains=</varname></term>
2001 <listitem>
9b6ffef3 2002 <para>Takes a boolean, or the special value <literal>route</literal>. When true, the domain name
1e7a0e21
LP
2003 received via IPv6 Router Advertisement (RA) will be used as DNS search domain over this link, similar to
2004 the effect of the <option>Domains=</option> setting. If set to <literal>route</literal>, the domain name
2005 received via IPv6 RA will be used for routing DNS queries only, but not for searching, similar to the
2006 effect of the <option>Domains=</option> setting when the argument is prefixed with
2007 <literal>~</literal>. Defaults to false.</para>
2008
2009 <para>It is recommended to enable this option only on trusted networks, as setting this affects resolution
38b38500 2010 of all hostnames, in particular of single-label names. It is generally safer to use the supplied domain
1e7a0e21
LP
2011 only as routing domain, rather than as search domain, in order to not have it affect local resolution of
2012 single-label names.</para>
2013
2014 <para>When set to true, this setting corresponds to the <option>domain</option> option in <citerefentry
2015 project='man-pages'><refentrytitle>resolv.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para>
2016 </listitem>
2017 </varlistentry>
2ba31d29
JK
2018
2019 <varlistentry>
2020 <term><varname>RouteTable=<replaceable>num</replaceable></varname></term>
2021 <listitem>
d11e656a
ZJS
2022 <para>The table identifier for the routes received in the Router Advertisement
2023 (a number between 1 and 4294967295, or 0 to unset).
2ba31d29
JK
2024 The table can be retrieved using <command>ip route show table <replaceable>num</replaceable></command>.
2025 </para>
2026 </listitem>
2027 </varlistentry>
062c2eea
SS
2028
2029 <varlistentry>
2030 <term><varname>UseAutonomousPrefix=</varname></term>
2031 <listitem>
2032 <para>When true (the default), the autonomous prefix received in the Router Advertisement will be used and take
2033 precedence over any statically configured ones.</para>
2034 </listitem>
2035 </varlistentry>
2036
2037 <varlistentry>
2038 <term><varname>UseOnLinkPrefix=</varname></term>
2039 <listitem>
2040 <para>When true (the default), the onlink prefix received in the Router Advertisement will be used and take
2041 precedence over any statically configured ones.</para>
2042 </listitem>
2043 </varlistentry>
2044
e520ce64 2045 <varlistentry>
6b000af4 2046 <term><varname>DenyList=</varname></term>
e520ce64
SS
2047 <listitem>
2048 <para>A whitespace-separated list of IPv6 prefixes. IPv6 prefixes supplied via router advertisements in the list are ignored.</para>
2049 </listitem>
2050 </varlistentry>
2051
d739fdde
YW
2052 <varlistentry>
2053 <term><varname>DHCPv6Client=</varname></term>
2054 <listitem>
ac24e418
SS
2055 <para>Takes a boolean, or the special value <literal>always</literal>. When true (the default), the DHCPv6 client will be started when the
2056 RA has the managed or other information flag. If set to <literal>always</literal>, the DHCPv6 client will be started even if there is no
2057 managed or other information flag in the RA.</para>
d739fdde
YW
2058 </listitem>
2059 </varlistentry>
1e7a0e21
LP
2060 </variablelist>
2061 </refsect1>
2062
ad943783
LP
2063 <refsect1>
2064 <title>[DHCPServer] Section Options</title>
bdac5608 2065 <para>The [DHCPServer] section contains settings for the DHCP server, if enabled via the
ad943783
LP
2066 <varname>DHCPServer=</varname> option described above:</para>
2067
2068 <variablelist class='network-directives'>
2069
9b3a67c5
TG
2070 <varlistentry>
2071 <term><varname>PoolOffset=</varname></term>
2072 <term><varname>PoolSize=</varname></term>
2073
2074 <listitem><para>Configures the pool of addresses to hand out. The pool
2075 is a contiguous sequence of IP addresses in the subnet configured for
2076 the server address, which does not include the subnet nor the broadcast
2077 address. <varname>PoolOffset=</varname> takes the offset of the pool
2078 from the start of subnet, or zero to use the default value.
2079 <varname>PoolSize=</varname> takes the number of IP addresses in the
b938cb90 2080 pool or zero to use the default value. By default, the pool starts at
9b3a67c5
TG
2081 the first address after the subnet address and takes up the rest of
2082 the subnet, excluding the broadcast address. If the pool includes
2083 the server address (the default), this is reserved and not handed
2084 out to clients.</para></listitem>
2085 </varlistentry>
2086
ad943783
LP
2087 <varlistentry>
2088 <term><varname>DefaultLeaseTimeSec=</varname></term>
2089 <term><varname>MaxLeaseTimeSec=</varname></term>
2090
2091 <listitem><para>Control the default and maximum DHCP lease
2092 time to pass to clients. These settings take time values in seconds or
2093 another common time unit, depending on the suffix. The default
2094 lease time is used for clients that did not ask for a specific
2095 lease time. If a client asks for a lease time longer than the
b938cb90 2096 maximum lease time, it is automatically shortened to the
ad943783
LP
2097 specified time. The default lease time defaults to 1h, the
2098 maximum lease time to 12h. Shorter lease times are beneficial
2099 if the configuration data in DHCP leases changes frequently
2100 and clients shall learn the new settings with shorter
2101 latencies. Longer lease times reduce the generated DHCP
2102 network traffic.</para></listitem>
2103 </varlistentry>
2104
2105 <varlistentry>
2106 <term><varname>EmitDNS=</varname></term>
2107 <term><varname>DNS=</varname></term>
2108
2a71d57f
LP
2109 <listitem><para><varname>EmitDNS=</varname> takes a boolean. Configures whether the DHCP leases
2110 handed out to clients shall contain DNS server information. Defaults to <literal>yes</literal>. The
2111 DNS servers to pass to clients may be configured with the <varname>DNS=</varname> option, which takes
2112 a list of IPv4 addresses. If the <varname>EmitDNS=</varname> option is enabled but no servers
2113 configured, the servers are automatically propagated from an "uplink" interface that has appropriate
2114 servers set. The "uplink" interface is determined by the default route of the system with the highest
2115 priority. Note that this information is acquired at the time the lease is handed out, and does not
2116 take uplink interfaces into account that acquire DNS server information at a later point. If no
2117 suitable uplinkg interface is found the DNS server data from <filename>/etc/resolv.conf</filename> is
2118 used. Also, note that the leases are not refreshed if the uplink network configuration changes. To
2119 ensure clients regularly acquire the most current uplink DNS server information, it is thus advisable
2120 to shorten the DHCP lease time via <varname>MaxLeaseTimeSec=</varname> described
ad943783
LP
2121 above.</para></listitem>
2122 </varlistentry>
2123
2124 <varlistentry>
2125 <term><varname>EmitNTP=</varname></term>
2126 <term><varname>NTP=</varname></term>
299d578f
SS
2127 <term><varname>EmitSIP=</varname></term>
2128 <term><varname>SIP=</varname></term>
2a71d57f
LP
2129 <term><varname>EmitPOP3=</varname></term>
2130 <term><varname>POP3=</varname></term>
2131 <term><varname>EmitSMTP=</varname></term>
2132 <term><varname>SMTP=</varname></term>
2133 <term><varname>EmitLPR=</varname></term>
2134 <term><varname>LPR=</varname></term>
2135
2136 <listitem><para>Similar to the <varname>EmitDNS=</varname> and <varname>DNS=</varname> settings
2137 described above, these settings configure whether and what server information for the indicate
2138 protocol shall be emitted as part of the DHCP lease. The same syntax, propagation semantics and
2139 defaults apply as for <varname>EmitDNS=</varname> and <varname>DNS=</varname>.</para></listitem>
284e8fd0
SS
2140 </varlistentry>
2141
77ff6022
CG
2142 <varlistentry>
2143 <term><varname>EmitRouter=</varname></term>
2144
2145 <listitem><para>Similar to the <varname>EmitDNS=</varname>
2146 setting described above, this setting configures whether the
2147 DHCP lease should contain the router option. The same syntax,
2148 propagation semantics and defaults apply as for
2149 <varname>EmitDNS=</varname>.</para></listitem>
2150 </varlistentry>
2151
ad943783
LP
2152 <varlistentry>
2153 <term><varname>EmitTimezone=</varname></term>
2154 <term><varname>Timezone=</varname></term>
2155
9b6ffef3
YW
2156 <listitem><para>Takes a boolean. Configures whether the DHCP leases handed out
2157 to clients shall contain timezone information. Defaults to <literal>yes</literal>. The
ad943783
LP
2158 <varname>Timezone=</varname> setting takes a timezone string
2159 (such as <literal>Europe/Berlin</literal> or
2160 <literal>UTC</literal>) to pass to clients. If no explicit
b938cb90 2161 timezone is set, the system timezone of the local host is
ad943783
LP
2162 propagated, as determined by the
2163 <filename>/etc/localtime</filename> symlink.</para></listitem>
2164 </varlistentry>
2165
564ca984 2166 <varlistentry>
d8b736bd
YW
2167 <term><varname>SendOption=</varname></term>
2168 <listitem>
2169 <para>Send a raw option with value via DHCPv4 server. Takes a DHCP option number, data type
2170 and data (<literal><replaceable>option</replaceable>:<replaceable>type</replaceable>:<replaceable>value</replaceable></literal>).
2171 The option number is an integer in the range 1..254. The type takes one of <literal>uint8</literal>,
e7d5fe17 2172 <literal>uint16</literal>, <literal>uint32</literal>, <literal>ipv4address</literal>, <literal>ipv6address</literal>, or
7354900d
DW
2173 <literal>string</literal>. Special characters in the data string may be escaped using
2174 <ulink url="https://en.wikipedia.org/wiki/Escape_sequences_in_C#Table_of_escape_sequences">C-style
2175 escapes</ulink>. This setting can be specified multiple times. If an empty string is specified,
2176 then all options specified earlier are cleared. Defaults to unset.</para>
2177 </listitem>
2178 </varlistentry>
2179
2180 <varlistentry>
2181 <term><varname>SendVendorOption=</varname></term>
2182 <listitem>
2183 <para>Send a vendor option with value via DHCPv4 server. Takes a DHCP option number, data type
2184 and data (<literal><replaceable>option</replaceable>:<replaceable>type</replaceable>:<replaceable>value</replaceable></literal>).
2185 The option number is an integer in the range 1..254. The type takes one of <literal>uint8</literal>,
d8b736bd
YW
2186 <literal>uint16</literal>, <literal>uint32</literal>, <literal>ipv4address</literal>, or
2187 <literal>string</literal>. Special characters in the data string may be escaped using
2188 <ulink url="https://en.wikipedia.org/wiki/Escape_sequences_in_C#Table_of_escape_sequences">C-style
2189 escapes</ulink>. This setting can be specified multiple times. If an empty string is specified,
2190 then all options specified earlier are cleared. Defaults to unset.</para>
2191 </listitem>
564ca984
SS
2192 </varlistentry>
2193
ad943783
LP
2194 </variablelist>
2195 </refsect1>
2196
798d3a52 2197 <refsect1>
3f9e0236 2198 <title>[IPv6PrefixDelegation] Section Options</title>
bdac5608
ZJS
2199 <para>The [IPv6PrefixDelegation] section contains settings for sending IPv6 Router Advertisements and
2200 whether to act as a router, if enabled via the <varname>IPv6PrefixDelegation=</varname> option described
2201 above. IPv6 network prefixes are defined with one or more [IPv6Prefix] sections.</para>
3f9e0236
PF
2202
2203 <variablelist class='network-directives'>
2204
2205 <varlistentry>
2206 <term><varname>Managed=</varname></term>
2207 <term><varname>OtherInformation=</varname></term>
2208
9b6ffef3
YW
2209 <listitem><para>Takes a boolean. Controls whether a DHCPv6 server is used to acquire IPv6
2210 addresses on the network link when <varname>Managed=</varname>
3f9e0236
PF
2211 is set to <literal>true</literal> or if only additional network
2212 information can be obtained via DHCPv6 for the network link when
9b6ffef3 2213 <varname>OtherInformation=</varname> is set to
3f9e0236
PF
2214 <literal>true</literal>. Both settings default to
2215 <literal>false</literal>, which means that a DHCPv6 server is not being
2216 used.</para></listitem>
2217 </varlistentry>
2218
2219 <varlistentry>
2220 <term><varname>RouterLifetimeSec=</varname></term>
2221
9b6ffef3 2222 <listitem><para>Takes a timespan. Configures the IPv6 router lifetime in seconds. If set,
3f9e0236 2223 this host also announces itself in Router Advertisements as an IPv6
025314d9 2224 router for the network link. When unset, the host is not acting as a router.</para>
3f9e0236
PF
2225 </listitem>
2226 </varlistentry>
2227
2228 <varlistentry>
2229 <term><varname>RouterPreference=</varname></term>
2230
2231 <listitem><para>Configures IPv6 router preference if
2232 <varname>RouterLifetimeSec=</varname> is non-zero. Valid values are
2233 <literal>high</literal>, <literal>medium</literal> and
2234 <literal>low</literal>, with <literal>normal</literal> and
2235 <literal>default</literal> added as synonyms for
2236 <literal>medium</literal> just to make configuration easier. See
2237 <ulink url="https://tools.ietf.org/html/rfc4191">RFC 4191</ulink>
2238 for details. Defaults to <literal>medium</literal>.</para></listitem>
2239 </varlistentry>
2240
2241 <varlistentry>
4cb8478c 2242 <term><varname>EmitDNS=</varname></term>
3f9e0236
PF
2243 <term><varname>DNS=</varname></term>
2244
bdac5608
ZJS
2245 <listitem><para><varname>DNS=</varname> specifies a list of recursive DNS server IPv6 addresses that
2246 are distributed via Router Advertisement messages when <varname>EmitDNS=</varname> is
2247 true. <varname>DNS=</varname> also takes special value <literal>_link_local</literal>; in that case
2248 the IPv6 link local address is distributed. If <varname>DNS=</varname> is empty, DNS servers are read
2249 from the [Network] section. If the [Network] section does not contain any DNS servers either, DNS
2250 servers from the uplink with the highest priority default route are used. When
2251 <varname>EmitDNS=</varname> is false, no DNS server information is sent in Router Advertisement
2252 messages. <varname>EmitDNS=</varname> defaults to true.</para></listitem>
3f9e0236
PF
2253 </varlistentry>
2254
760021c0 2255 <varlistentry>
4cb8478c 2256 <term><varname>EmitDomains=</varname></term>
760021c0
PF
2257 <term><varname>Domains=</varname></term>
2258
bdac5608
ZJS
2259 <listitem><para>A list of DNS search domains distributed via Router Advertisement messages when
2260 <varname>EmitDomains=</varname> is true. If <varname>Domains=</varname> is empty, DNS search domains
2261 are read from the [Network] section. If the [Network] section does not contain any DNS search domains
2262 either, DNS search domains from the uplink with the highest priority default route are used. When
2263 <varname>EmitDomains=</varname> is false, no DNS search domain information is sent in Router
2264 Advertisement messages. <varname>EmitDomains=</varname> defaults to true.</para></listitem>
760021c0
PF
2265 </varlistentry>
2266
3f9e0236
PF
2267 <varlistentry>
2268 <term><varname>DNSLifetimeSec=</varname></term>
2269
2270 <listitem><para>Lifetime in seconds for the DNS server addresses listed
760021c0
PF
2271 in <varname>DNS=</varname> and search domains listed in
2272 <varname>Domains=</varname>.</para></listitem>
3f9e0236
PF
2273 </varlistentry>
2274
2275 </variablelist>
2276 </refsect1>
2277
203d4df5 2278 <refsect1>
3f9e0236 2279 <title>[IPv6Prefix] Section Options</title>
e9dd6984
ZJS
2280 <para>One or more [IPv6Prefix] sections contain the IPv6 prefixes that are announced via Router
2281 Advertisements. See <ulink url="https://tools.ietf.org/html/rfc4861">RFC 4861</ulink> for further
2282 details.</para>
3f9e0236
PF
2283
2284 <variablelist class='network-directives'>
2285
2286 <varlistentry>
2287 <term><varname>AddressAutoconfiguration=</varname></term>
2288 <term><varname>OnLink=</varname></term>
2289
9b6ffef3 2290 <listitem><para>Takes a boolean to specify whether IPv6 addresses can be
3f9e0236
PF
2291 autoconfigured with this prefix and whether the prefix can be used for
2292 onlink determination. Both settings default to <literal>true</literal>
2293 in order to ease configuration.
2294 </para></listitem>
2295 </varlistentry>
2296
2297 <varlistentry>
2298 <term><varname>Prefix=</varname></term>
2299
bdac5608
ZJS
2300 <listitem><para>The IPv6 prefix that is to be distributed to hosts. Similarly to configuring static
2301 IPv6 addresses, the setting is configured as an IPv6 prefix and its prefix length, separated by a
2302 <literal>/</literal> character. Use multiple [IPv6Prefix] sections to configure multiple IPv6
2303 prefixes since prefix lifetimes, address autoconfiguration and onlink status may differ from one
2304 prefix to another.</para></listitem>
3f9e0236
PF
2305 </varlistentry>
2306
2307 <varlistentry>
2308 <term><varname>PreferredLifetimeSec=</varname></term>
2309 <term><varname>ValidLifetimeSec=</varname></term>
2310
2311 <listitem><para>Preferred and valid lifetimes for the prefix measured in
2312 seconds. <varname>PreferredLifetimeSec=</varname> defaults to 604800
2313 seconds (one week) and <varname>ValidLifetimeSec=</varname> defaults
2314 to 2592000 seconds (30 days).</para></listitem>
203d4df5
SS
2315 </varlistentry>
2316
bd6379ec
SS
2317 <varlistentry>
2318 <term><varname>Assign=</varname></term>
2319 <listitem><para>Takes a boolean. When true, adds an address from the prefix. Default to false.
2320 </para></listitem>
2321 </varlistentry>
203d4df5
SS
2322 </variablelist>
2323 </refsect1>
2324
2325 <refsect1>
2326 <title>[IPv6RoutePrefix] Section Options</title>
bdac5608 2327 <para>One or more [IPv6RoutePrefix] sections contain the IPv6
203d4df5
SS
2328 prefix routes that are announced via Router Advertisements. See
2329 <ulink url="https://tools.ietf.org/html/rfc4191">RFC 4191</ulink>
2330 for further details.</para>
2331
2332 <variablelist class='network-directives'>
2333
2334 <varlistentry>
2335 <term><varname>Route=</varname></term>
2336
bdac5608
ZJS
2337 <listitem><para>The IPv6 route that is to be distributed to hosts. Similarly to configuring static
2338 IPv6 routes, the setting is configured as an IPv6 prefix routes and its prefix route length,
2339 separated by a <literal>/</literal> character. Use multiple [IPv6PrefixRoutes] sections to configure
2340 multiple IPv6 prefix routes.</para></listitem>
203d4df5
SS
2341 </varlistentry>
2342
2343 <varlistentry>
2344 <term><varname>LifetimeSec=</varname></term>
2345
2346 <listitem><para>Lifetime for the route prefix measured in
2347 seconds. <varname>LifetimeSec=</varname> defaults to 604800 seconds (one week).
2348 </para></listitem>
3f9e0236
PF
2349 </varlistentry>
2350
2351 </variablelist>
2352 </refsect1>
2353
2354 <refsect1>
798d3a52 2355 <title>[Bridge] Section Options</title>
bdac5608 2356 <para>The [Bridge] section accepts the following keys:</para>
798d3a52 2357 <variablelist class='network-directives'>
165c41a9
SS
2358 <varlistentry>
2359 <term><varname>UnicastFlood=</varname></term>
2360 <listitem>
9b6ffef3 2361 <para>Takes a boolean. Controls whether the bridge should flood
072f9e4a 2362 traffic for which an FDB entry is missing and the destination
025314d9 2363 is unknown through this port. When unset, the kernel's default will be used.
47c7dfe2 2364 </para>
165c41a9
SS
2365 </listitem>
2366 </varlistentry>
7f15b714
TJ
2367 <varlistentry>
2368 <term><varname>MulticastFlood=</varname></term>
2369 <listitem>
2370 <para>Takes a boolean. Controls whether the bridge should flood
2371 traffic for which an MDB entry is missing and the destination
2372 is unknown through this port. When unset, the kernel's default will be used.
2373 </para>
2374 </listitem>
2375 </varlistentry>
d3aa8b49
SS
2376 <varlistentry>
2377 <term><varname>MulticastToUnicast=</varname></term>
2378 <listitem>
2379 <para>Takes a boolean. Multicast to unicast works on top of the multicast snooping feature of
2380 the bridge. Which means unicast copies are only delivered to hosts which are interested in it.
2381 When unset, the kernel's default will be used.
2382 </para>
2383 </listitem>
2384 </varlistentry>
7f15b714
TJ
2385 <varlistentry>
2386 <term><varname>NeighborSuppression=</varname></term>
2387 <listitem>
2388 <para>Takes a boolean. Configures whether ARP and ND neighbor suppression is enabled for
2389 this port. When unset, the kernel's default will be used.
2390 </para>
2391 </listitem>
2392 </varlistentry>
2393 <varlistentry>
2394 <term><varname>Learning=</varname></term>
2395 <listitem>
2396 <para>Takes a boolean. Configures whether MAC address learning is enabled for
2397 this port. When unset, the kernel's default will be used.
2398 </para>
2399 </listitem>
2400 </varlistentry>
165c41a9
SS
2401 <varlistentry>
2402 <term><varname>HairPin=</varname></term>
2403 <listitem>
e9dd6984
ZJS
2404 <para>Takes a boolean. Configures whether traffic may be sent back out of the port on which it
2405 was received. When this flag is false, then the bridge will not forward traffic back out of the
2406 receiving port. When unset, the kernel's default will be used.</para>
165c41a9
SS
2407 </listitem>
2408 </varlistentry>
2409 <varlistentry>
84c34096 2410 <term><varname>UseBPDU=</varname></term>
165c41a9 2411 <listitem>
9b6ffef3 2412 <para>Takes a boolean. Configures whether STP Bridge Protocol Data Units will be
025314d9 2413 processed by the bridge port. When unset, the kernel's default will be used.</para>
165c41a9
SS
2414 </listitem>
2415 </varlistentry>
2416 <varlistentry>
2417 <term><varname>FastLeave=</varname></term>
2418 <listitem>
9b6ffef3 2419 <para>Takes a boolean. This flag allows the bridge to immediately stop multicast
a8eaaee7 2420 traffic on a port that receives an IGMP Leave message. It is only used with
025314d9 2421 IGMP snooping if enabled on the bridge. When unset, the kernel's default will be used.</para>
165c41a9
SS
2422 </listitem>
2423 </varlistentry>
2424 <varlistentry>
23da66bb 2425 <term><varname>AllowPortToBeRoot=</varname></term>
165c41a9 2426 <listitem>
9b6ffef3 2427 <para>Takes a boolean. Configures whether a given port is allowed to
47c7dfe2 2428 become a root port. Only used when STP is enabled on the bridge.
025314d9 2429 When unset, the kernel's default will be used.</para>
165c41a9
SS
2430 </listitem>
2431 </varlistentry>
1087623b
SS
2432 <varlistentry>
2433 <term><varname>ProxyARP=</varname></term>
2434 <listitem>
2435 <para>Takes a boolean. Configures whether proxy ARP to be enabled on this port.
2436 When unset, the kernel's default will be used.</para>
2437 </listitem>
2438 </varlistentry>
2439 <varlistentry>
2440 <term><varname>ProxyARPWiFi=</varname></term>
2441 <listitem>
2442 <para>Takes a boolean. Configures whether proxy ARP to be enabled on this port
2443 which meets extended requirements by IEEE 802.11 and Hotspot 2.0 specifications.
2444 When unset, the kernel's default will be used.</para>
2445 </listitem>
2446 </varlistentry>
0fadb2a4
SS
2447 <varlistentry>
2448 <term><varname>MulticastRouter=</varname></term>
2449 <listitem>
2450 <para>Configures this port for having multicast routers attached. A port with a multicast
2451 router will receive all multicast traffic. Takes one of <literal>no</literal>
2452 to disable multicast routers on this port, <literal>query</literal> to let the system detect
2453 the presence of routers, <literal>permanent</literal> to permanently enable multicast traffic
2454 forwarding on this port, or <literal>temporary</literal> to enable multicast routers temporarily
2455 on this port, not depending on incoming queries. When unset, the kernel's default will be used.</para>
2456 </listitem>
2457 </varlistentry>
798d3a52
ZJS
2458 <varlistentry>
2459 <term><varname>Cost=</varname></term>
2460 <listitem>
47c7dfe2 2461 <para>Sets the "cost" of sending packets of this interface.
a8eaaee7 2462 Each port in a bridge may have a different speed and the cost
798d3a52 2463 is used to decide which link to use. Faster interfaces
785889e5 2464 should have lower costs. It is an integer value between 1 and
b56be296
DJL
2465 65535.</para>
2466 </listitem>
2467 </varlistentry>
2468 <varlistentry>
2469 <term><varname>Priority=</varname></term>
2470 <listitem>
2471 <para>Sets the "priority" of sending packets on this interface.
2472 Each port in a bridge may have a different priority which is used
2473 to decide which link to use. Lower value means higher priority.
785889e5 2474 It is an integer value between 0 to 63. Networkd does not set any
b56be296 2475 default, meaning the kernel default value of 32 is used.</para>
798d3a52
ZJS
2476 </listitem>
2477 </varlistentry>
2478 </variablelist>
2479 </refsect1>
798d3a52
ZJS
2480 <refsect1>
2481 <title>[BridgeFDB] Section Options</title>
bdac5608
ZJS
2482 <para>The [BridgeFDB] section manages the forwarding database table of a port and accepts the following
2483 keys. Specify several [BridgeFDB] sections to configure several static MAC table entries.</para>
798d3a52
ZJS
2484
2485 <variablelist class='network-directives'>
2486 <varlistentry>
2487 <term><varname>MACAddress=</varname></term>
2488 <listitem>
bdac5608 2489 <para>As in the [Network] section. This key is mandatory.</para>
798d3a52
ZJS
2490 </listitem>
2491 </varlistentry>
c2c2793f
SS
2492 <varlistentry>
2493 <term><varname>Destination=</varname></term>
2494 <listitem>
2495 <para>Takes an IP address of the destination VXLAN tunnel endpoint.</para>
2496 </listitem>
2497 </varlistentry>
798d3a52
ZJS
2498 <varlistentry>
2499 <term><varname>VLANId=</varname></term>
2500 <listitem>
a8eaaee7 2501 <para>The VLAN ID for the new static MAC table entry. If
db9b9fb9 2502 omitted, no VLAN ID information is appended to the new static MAC
798d3a52
ZJS
2503 table entry.</para>
2504 </listitem>
2505 </varlistentry>
61b824c5
SS
2506 <varlistentry>
2507 <term><varname>VNI=</varname></term>
2508 <listitem>
2509 <para>The VXLAN Network Identifier (or VXLAN Segment ID) to use to connect to
2510 the remote VXLAN tunnel endpoint. Takes a number in the range 1-16777215.
2511 Defaults to unset.</para>
2512 </listitem>
2513 </varlistentry>
bdb397ed
SS
2514 <varlistentry>
2515 <term><varname>AssociatedWith=</varname></term>
2516 <listitem>
2517 <para>Specifies where the address is associated with. Takes one of <literal>use</literal>,
2518 <literal>self</literal>, <literal>master</literal> or <literal>router</literal>.
2519 <literal>use</literal> means the address is in use. User space can use this option to
2520 indicate to the kernel that the fdb entry is in use. <literal>self</literal> means
2521 the address is associated with the port drivers fdb. Usually hardware. <literal>master</literal>
2522 means the address is associated with master devices fdb. <literal>router</literal> means
2523 the destination address is associated with a router. Note that it's valid if the referenced
2524 device is a VXLAN type device and has route shortcircuit enabled. Defaults to <literal>self</literal>.</para>
2525 </listitem>
2526 </varlistentry>
798d3a52
ZJS
2527 </variablelist>
2528 </refsect1>
06828bb6 2529
e9a8c550
SS
2530 <refsect1>
2531 <title>[LLDP] Section Options</title>
bdac5608
ZJS
2532 <para>The [LLDP] section manages the Link Layer Discovery Protocol (LLDP) and accepts the following
2533 keys.</para>
e9a8c550
SS
2534 <variablelist class='network-directives'>
2535 <varlistentry>
2536 <term><varname>MUDURL=</varname></term>
2537 <listitem>
2538 <para>Controls support for Ethernet LLDP packet's Manufacturer Usage Description (MUD). MUD is an embedded software
2539 standard defined by the IETF that allows IoT Device makers to advertise device specifications, including the intended
2540 communication patterns for their device when it connects to the network. The network can then use this intent to author
2541 a context-specific access policy, so the device functions only within those parameters. Takes an URL of length up to 255
2542 characters. A superficial verification that the string is a valid URL
2543 will be performed. See
2544 <ulink url="https://tools.ietf.org/html/rfc8520">RFC 8520</ulink> for details. The MUD URL received
2545 from the LLDP packets will be saved at the state files and can be read via
2546 <function>sd_lldp_neighbor_get_mud_url()</function> function.</para>
2547 </listitem>
2548 </varlistentry>
2549 </variablelist>
2550 </refsect1>
2551
06828bb6
HP
2552 <refsect1>
2553 <title>[CAN] Section Options</title>
bdac5608
ZJS
2554 <para>The [CAN] section manages the Controller Area Network (CAN bus) and accepts the
2555 following keys:</para>
06828bb6
HP
2556 <variablelist class='network-directives'>
2557 <varlistentry>
2558 <term><varname>BitRate=</varname></term>
2559 <listitem>
2560 <para>The bitrate of CAN device in bits per second. The usual SI prefixes (K, M) with the base of 1000 can
74a27268 2561 be used here. Takes a number in the range 1..4294967295.</para>
06828bb6
HP
2562 </listitem>
2563 </varlistentry>
2564 <varlistentry>
2565 <term><varname>SamplePoint=</varname></term>
2566 <listitem>
2567 <para>Optional sample point in percent with one decimal (e.g. <literal>75%</literal>,
2568 <literal>87.5%</literal>) or permille (e.g. <literal>875‰</literal>).</para>
2569 </listitem>
2570 </varlistentry>
7e025e9c
RP
2571 <varlistentry>
2572 <term><varname>DataBitRate=</varname></term>
2573 <term><varname>DataSamplePoint=</varname></term>
2574 <listitem>
2575 <para>The bitrate and sample point for the data phase, if CAN-FD is used. These settings are
2576 analogous to the <varname>BitRate=</varname> and <varname>SamplePoint=</varname> keys.</para>
2577 </listitem>
2578 </varlistentry>
2579 <varlistentry>
2580 <term><varname>FDMode=</varname></term>
2581 <listitem>
2582 <para>Takes a boolean. When <literal>yes</literal>, CAN-FD mode is enabled for the interface.
2583 Note, that a bitrate and optional sample point should also be set for the CAN-FD data phase using
2584 the <varname>DataBitRate=</varname> and <varname>DataSamplePoint=</varname> keys.</para>
2585 </listitem>
2586 </varlistentry>
2587 <varlistentry>
2588 <term><varname>FDNonISO=</varname></term>
2589 <listitem>
2590 <para>Takes a boolean. When <literal>yes</literal>, non-ISO CAN-FD mode is enabled for the
2591 interface. When unset, the kernel's default will be used.</para>
2592 </listitem>
2593 </varlistentry>
06828bb6
HP
2594 <varlistentry>
2595 <term><varname>RestartSec=</varname></term>
2596 <listitem>
2597 <para>Automatic restart delay time. If set to a non-zero value, a restart of the CAN controller will be
2598 triggered automatically in case of a bus-off condition after the specified delay time. Subsecond delays can
2599 be specified using decimals (e.g. <literal>0.1s</literal>) or a <literal>ms</literal> or
2600 <literal>us</literal> postfix. Using <literal>infinity</literal> or <literal>0</literal> will turn the
2601 automatic restart off. By default automatic restart is disabled.</para>
2602 </listitem>
2603 </varlistentry>
52aa38f1
MR
2604 <varlistentry>
2605 <term><varname>Termination=</varname></term>
2606 <listitem>
2607 <para>Takes a boolean. When <literal>yes</literal>, the termination resistor will be selected for
2608 the bias network. When unset, the kernel's default will be used.</para>
2609 </listitem>
2610 </varlistentry>
c423be28
CG
2611 <varlistentry>
2612 <term><varname>TripleSampling=</varname></term>
2613 <listitem>
2614 <para>Takes a boolean. When <literal>yes</literal>, three samples (instead of one) are used to determine
2615 the value of a received bit by majority rule. When unset, the kernel's default will be used.</para>
2616 </listitem>
2617 </varlistentry>
74f0fb90
YW
2618 <varlistentry>
2619 <term><varname>ListenOnly=</varname></term>
2620 <listitem>
2621 <para>Takes a boolean. When <literal>yes</literal>, listen-only mode is enabled. When the
2622 interface is in listen-only mode, the interface neither transmit CAN frames nor send ACK
2623 bit. Listen-only mode is important to debug CAN networks without interfering with the
2624 communication or acknowledge the CAN frame. When unset, the kernel's default will be used.
2625 </para>
2626 </listitem>
2627 </varlistentry>
06828bb6
HP
2628 </variablelist>
2629 </refsect1>
2630
2ed5f6d5
YW
2631 <refsect1>
2632 <title>[QDisc] Section Options</title>
bdac5608 2633 <para>The [QDisc] section manages the traffic control queueing discipline (qdisc).</para>
2ed5f6d5
YW
2634
2635 <variablelist class='network-directives'>
2636 <varlistentry>
2637 <term><varname>Parent=</varname></term>
2638 <listitem>
2639 <para>Specifies the parent Queueing Discipline (qdisc). Takes one of <literal>clsact</literal>
2640 or <literal>ingress</literal>. This is mandatory.</para>
2641 </listitem>
2642 </varlistentry>
d8b2396d 2643
f344a492 2644 <xi:include href="tc.xml" xpointer="qdisc-handle" />
2ed5f6d5
YW
2645 </variablelist>
2646 </refsect1>
2647
0f5bd7fe 2648 <refsect1>
18de0969 2649 <title>[NetworkEmulator] Section Options</title>
bdac5608
ZJS
2650 <para>The [NetworkEmulator] section manages the queueing discipline (qdisc) of the network emulator. It
2651 can be used to configure the kernel packet scheduler and simulate packet delay and loss for UDP or TCP
2652 applications, or limit the bandwidth usage of a particular service to simulate internet connections.
2653 </para>
0f5bd7fe
SS
2654
2655 <variablelist class='network-directives'>
f344a492
YW
2656 <xi:include href="tc.xml" xpointer="qdisc-parent" />
2657 <xi:include href="tc.xml" xpointer="qdisc-handle" />
d8b2396d 2658
0f5bd7fe 2659 <varlistentry>
18de0969 2660 <term><varname>DelaySec=</varname></term>
0f5bd7fe
SS
2661 <listitem>
2662 <para>Specifies the fixed amount of delay to be added to all packets going out of the
2663 interface. Defaults to unset.</para>
2664 </listitem>
2665 </varlistentry>
2666
2667 <varlistentry>
18de0969 2668 <term><varname>DelayJitterSec=</varname></term>
0f5bd7fe
SS
2669 <listitem>
2670 <para>Specifies the chosen delay to be added to the packets outgoing to the network
2671 interface. Defaults to unset.</para>
2672 </listitem>
2673 </varlistentry>
2674
2675 <varlistentry>
18de0969 2676 <term><varname>PacketLimit=</varname></term>
0f5bd7fe
SS
2677 <listitem>
2678 <para>Specifies the maximum number of packets the qdisc may hold queued at a time.
e9dd6984 2679 An unsigned integer in the range 0–4294967294. Defaults to 1000.</para>
0f5bd7fe
SS
2680 </listitem>
2681 </varlistentry>
2682
2683 <varlistentry>
18de0969 2684 <term><varname>LossRate=</varname></term>
0f5bd7fe
SS
2685 <listitem>
2686 <para>Specifies an independent loss probability to be added to the packets outgoing from the
2687 network interface. Takes a percentage value, suffixed with "%". Defaults to unset.</para>
2688 </listitem>
2689 </varlistentry>
2690
b9c5aa3c 2691 <varlistentry>
18de0969 2692 <term><varname>DuplicateRate=</varname></term>
b9c5aa3c
SS
2693 <listitem>
2694 <para>Specifies that the chosen percent of packets is duplicated before queuing them.
2695 Takes a percentage value, suffixed with "%". Defaults to unset.</para>
2696 </listitem>
2697 </varlistentry>
18de0969
YW
2698 </variablelist>
2699 </refsect1>
b9c5aa3c 2700
18de0969 2701 <refsect1>
60ed2dcf 2702 <title>[TokenBucketFilter] Section Options</title>
e9dd6984
ZJS
2703 <para>The [TokenBucketFilter] section manages the queueing discipline (qdisc) of token bucket filter
2704 (tbf).</para>
18de0969
YW
2705
2706 <variablelist class='network-directives'>
f344a492
YW
2707 <xi:include href="tc.xml" xpointer="qdisc-parent" />
2708 <xi:include href="tc.xml" xpointer="qdisc-handle" />
d8b2396d 2709
18de0969
YW
2710 <varlistentry>
2711 <term><varname>LatencySec=</varname></term>
ba5841b5
SS
2712 <listitem>
2713 <para>Specifies the latency parameter, which specifies the maximum amount of time a
60ed2dcf 2714 packet can sit in the Token Bucket Filter (TBF). Defaults to unset.</para>
ba5841b5
SS
2715 </listitem>
2716 </varlistentry>
2717
dcfc23ae 2718 <varlistentry>
c03ef420 2719 <term><varname>LimitBytes=</varname></term>
dcfc23ae
YW
2720 <listitem>
2721 <para>Takes the number of bytes that can be queued waiting for tokens to become available.
2722 When the size is suffixed with K, M, or G, it is parsed as Kilobytes, Megabytes, or Gigabytes,
c03ef420 2723 respectively, to the base of 1024. Defaults to unset.</para>
dcfc23ae
YW
2724 </listitem>
2725 </varlistentry>
2726
ba5841b5 2727 <varlistentry>
c03ef420 2728 <term><varname>BurstBytes=</varname></term>
ba5841b5
SS
2729 <listitem>
2730 <para>Specifies the size of the bucket. This is the maximum amount of bytes that tokens
2731 can be available for instantaneous transfer. When the size is suffixed with K, M, or G, it is
c03ef420 2732 parsed as Kilobytes, Megabytes, or Gigabytes, respectively, to the base of 1024. Defaults to
ba5841b5
SS
2733 unset.</para>
2734 </listitem>
2735 </varlistentry>
2736
2737 <varlistentry>
18de0969 2738 <term><varname>Rate=</varname></term>
ba5841b5
SS
2739 <listitem>
2740 <para>Specifies the device specific bandwidth. When suffixed with K, M, or G, the specified
6b8fe4c3 2741 bandwidth is parsed as Kilobits, Megabits, or Gigabits, respectively, to the base of 1000.
ba5841b5
SS
2742 Defaults to unset.</para>
2743 </listitem>
2744 </varlistentry>
2745
dcfc23ae 2746 <varlistentry>
18de0969 2747 <term><varname>MPUBytes=</varname></term>
dcfc23ae
YW
2748 <listitem>
2749 <para>The Minimum Packet Unit (MPU) determines the minimal token usage (specified in bytes)
2750 for a packet. When suffixed with K, M, or G, the specified size is parsed as Kilobytes,
c03ef420 2751 Megabytes, or Gigabytes, respectively, to the base of 1024. Defaults to zero.</para>
dcfc23ae
YW
2752 </listitem>
2753 </varlistentry>
2754
2755 <varlistentry>
18de0969 2756 <term><varname>PeakRate=</varname></term>
dcfc23ae
YW
2757 <listitem>
2758 <para>Takes the maximum depletion rate of the bucket. When suffixed with K, M, or G, the
6b8fe4c3 2759 specified size is parsed as Kilobits, Megabits, or Gigabits, respectively, to the base of
dcfc23ae
YW
2760 1000. Defaults to unset.</para>
2761 </listitem>
2762 </varlistentry>
2763
2764 <varlistentry>
18de0969 2765 <term><varname>MTUBytes=</varname></term>
dcfc23ae
YW
2766 <listitem>
2767 <para>Specifies the size of the peakrate bucket. When suffixed with K, M, or G, the specified
c03ef420 2768 size is parsed as Kilobytes, Megabytes, or Gigabytes, respectively, to the base of 1024.
dcfc23ae
YW
2769 Defaults to unset.</para>
2770 </listitem>
2771 </varlistentry>
18de0969
YW
2772 </variablelist>
2773 </refsect1>
2774
bde4ae88
SS
2775 <refsect1>
2776 <title>[PIE] Section Options</title>
bdac5608
ZJS
2777 <para>The [PIE] section manages the queueing discipline (qdisc) of Proportional Integral
2778 controller-Enhanced (PIE).</para>
bde4ae88
SS
2779
2780 <variablelist class='network-directives'>
f344a492
YW
2781 <xi:include href="tc.xml" xpointer="qdisc-parent" />
2782 <xi:include href="tc.xml" xpointer="qdisc-handle" />
bde4ae88
SS
2783
2784 <varlistentry>
2785 <term><varname>PacketLimit=</varname></term>
2786 <listitem>
2787 <para>Specifies the hard limit on the queue size in number of packets. When this limit is reached, incoming packets are
e9dd6984 2788 dropped. An unsigned integer in the range 1–4294967294. Defaults to unset and kernel's default is used.</para>
bde4ae88
SS
2789 </listitem>
2790 </varlistentry>
2791 </variablelist>
2792 </refsect1>
2793
982998b0
SS
2794 <refsect1>
2795 <title>[StochasticFairBlue] Section Options</title>
bdac5608
ZJS
2796 <para>The [StochasticFairBlue] section manages the queueing discipline (qdisc) of stochastic fair blue
2797 (sfb).</para>
982998b0
SS
2798
2799 <variablelist class='network-directives'>
f344a492
YW
2800 <xi:include href="tc.xml" xpointer="qdisc-parent" />
2801 <xi:include href="tc.xml" xpointer="qdisc-handle" />
982998b0
SS
2802
2803 <varlistentry>
2804 <term><varname>PacketLimit=</varname></term>
2805 <listitem>
e9dd6984
ZJS
2806 <para>Specifies the hard limit on the queue size in number of packets. When this limit is reached,
2807 incoming packets are dropped. An unsigned integer in the range 0–4294967294. Defaults to unset and
2808 kernel's default is used.</para>
982998b0
SS
2809 </listitem>
2810 </varlistentry>
2811 </variablelist>
2812 </refsect1>
2813
18de0969
YW
2814 <refsect1>
2815 <title>[StochasticFairnessQueueing] Section Options</title>
bdac5608
ZJS
2816 <para>The [StochasticFairnessQueueing] section manages the queueing discipline (qdisc) of stochastic
2817 fairness queueing (sfq).</para>
18de0969
YW
2818
2819 <variablelist class='network-directives'>
f344a492
YW
2820 <xi:include href="tc.xml" xpointer="qdisc-parent" />
2821 <xi:include href="tc.xml" xpointer="qdisc-handle" />
d8b2396d 2822
9942b710 2823 <varlistentry>
18de0969 2824 <term><varname>PerturbPeriodSec=</varname></term>
9942b710
SS
2825 <listitem>
2826 <para>Specifies the interval in seconds for queue algorithm perturbation. Defaults to unset.</para>
2827 </listitem>
2828 </varlistentry>
18de0969
YW
2829 </variablelist>
2830 </refsect1>
2831
c853f594
SS
2832 <refsect1>
2833 <title>[BFIFO] Section Options</title>
bdac5608
ZJS
2834 <para>The [BFIFO] section manages the queueing discipline (qdisc) of Byte limited Packet First In First
2835 Out (bfifo).</para>
c853f594
SS
2836
2837 <variablelist class='network-directives'>
f344a492
YW
2838 <xi:include href="tc.xml" xpointer="qdisc-parent" />
2839 <xi:include href="tc.xml" xpointer="qdisc-handle" />
c853f594
SS
2840
2841 <varlistentry>
c03ef420 2842 <term><varname>LimitBytes=</varname></term>
c853f594 2843 <listitem>
e9dd6984
ZJS
2844 <para>Specifies the hard limit on the FIFO size in bytes. The size limit (a buffer size) to prevent
2845 it from overflowing in case it is unable to dequeue packets as quickly as it receives them. When
2846 this limit is reached, incoming packets are dropped. When suffixed with K, M, or G, the specified
2847 size is parsed as Kilobytes, Megabytes, or Gigabytes, respectively, to the base of 1024. Defaults
2848 to unset and kernel's default is used.</para>
c853f594
SS
2849 </listitem>
2850 </varlistentry>
2851 </variablelist>
2852 </refsect1>
2853
a7476065
SS
2854 <refsect1>
2855 <title>[PFIFO] Section Options</title>
bdac5608
ZJS
2856 <para>The [PFIFO] section manages the queueing discipline (qdisc) of Packet First In First Out
2857 (pfifo).</para>
a7476065
SS
2858
2859 <variablelist class='network-directives'>
f344a492
YW
2860 <xi:include href="tc.xml" xpointer="qdisc-parent" />
2861 <xi:include href="tc.xml" xpointer="qdisc-handle" />
a7476065
SS
2862
2863 <varlistentry>
2864 <term><varname>PacketLimit=</varname></term>
2865 <listitem>
e9dd6984
ZJS
2866 <para>Specifies the hard limit on the FIFO size in number of packets. The size limit (a buffer
2867 size) to prevent it from overflowing in case it is unable to dequeue packets as quickly as it
2868 receives them. When this limit is reached, incoming packets are dropped. An unsigned integer in the
2869 range 0–4294967294. Defaults to unset and kernel's default is used.</para>
a7476065
SS
2870 </listitem>
2871 </varlistentry>
ad8352f4
SS
2872 </variablelist>
2873 </refsect1>
2874
053a2ddb
SS
2875 <refsect1>
2876 <title>[PFIFOHeadDrop] Section Options</title>
bdac5608
ZJS
2877 <para>The [PFIFOHeadDrop] section manages the queueing discipline (qdisc) of Packet First In First Out
2878 Head Drop (pfifo_head_drop).</para>
053a2ddb
SS
2879
2880 <variablelist class='network-directives'>
f344a492
YW
2881 <xi:include href="tc.xml" xpointer="qdisc-parent" />
2882 <xi:include href="tc.xml" xpointer="qdisc-handle" />
053a2ddb
SS
2883
2884 <varlistentry>
2885 <term><varname>PacketLimit=</varname></term>
2886 <listitem>
bdac5608 2887 <para>As in [PFIFO] section.</para></listitem>
053a2ddb
SS
2888 </varlistentry>
2889 </variablelist>
2890 </refsect1>
2891
1a95964b
SS
2892 <refsect1>
2893 <title>[PFIFOFast] Section Options</title>
bdac5608
ZJS
2894 <para>The [PFIFOFast] section manages the queueing discipline (qdisc) of Packet First In First Out Fast
2895 (pfifo_fast).</para>
1a95964b
SS
2896
2897 <variablelist class='network-directives'>
f344a492
YW
2898 <xi:include href="tc.xml" xpointer="qdisc-parent" />
2899 <xi:include href="tc.xml" xpointer="qdisc-handle" />
1a95964b
SS
2900 </variablelist>
2901 </refsect1>
2902
ad8352f4
SS
2903 <refsect1>
2904 <title>[CAKE] Section Options</title>
bdac5608
ZJS
2905 <para>The [CAKE] section manages the queueing discipline (qdisc) of Common Applications Kept Enhanced
2906 (CAKE).</para>
ad8352f4
SS
2907
2908 <variablelist class='network-directives'>
f344a492
YW
2909 <xi:include href="tc.xml" xpointer="qdisc-parent" />
2910 <xi:include href="tc.xml" xpointer="qdisc-handle" />
a7476065 2911
ad8352f4 2912 <varlistentry>
c03ef420 2913 <term><varname>OverheadBytes=</varname></term>
ad8352f4 2914 <listitem>
e9dd6984
ZJS
2915 <para>Specifies that bytes to be addeded to the size of each packet. Bytes may be negative. Takes
2916 an integer in the range from -64 to 256. Defaults to unset and kernel's default is used.</para>
ad8352f4 2917 </listitem>
f344a492 2918 </varlistentry>
ad8352f4
SS
2919
2920 <varlistentry>
2921 <term><varname>Bandwidth=</varname></term>
2922 <listitem>
2923 <para>Specifies the shaper bandwidth. When suffixed with K, M, or G, the specified size is
2924 parsed as Kilobits, Megabits, or Gigabits, respectively, to the base of 1000. Defaults to
2925 unset and kernel's default is used.</para>
2926 </listitem>
2927 </varlistentry>
a7476065
SS
2928 </variablelist>
2929 </refsect1>
2930
18de0969
YW
2931 <refsect1>
2932 <title>[ControlledDelay] Section Options</title>
bdac5608 2933 <para>The [ControlledDelay] section manages the queueing discipline (qdisc) of
18de0969 2934 controlled delay (CoDel).</para>
9942b710 2935
18de0969 2936 <variablelist class='network-directives'>
f344a492
YW
2937 <xi:include href="tc.xml" xpointer="qdisc-parent" />
2938 <xi:include href="tc.xml" xpointer="qdisc-handle" />
d8b2396d 2939
18de0969
YW
2940 <varlistentry>
2941 <term><varname>PacketLimit=</varname></term>
a9a5d632 2942 <listitem>
e9dd6984
ZJS
2943 <para>Specifies the hard limit on the queue size in number of packets. When this limit is reached,
2944 incoming packets are dropped. An unsigned integer in the range 0–4294967294. Defaults to unset and
2945 kernel's default is used.</para>
a9a5d632
SS
2946 </listitem>
2947 </varlistentry>
2948
b078e528 2949 <varlistentry>
18de0969 2950 <term><varname>TargetSec=</varname></term>
b078e528
YW
2951 <listitem>
2952 <para>Takes a timespan. Specifies the acceptable minimum standing/persistent queue delay.
2953 Defaults to unset and kernel's default is used.</para>
2954 </listitem>
2955 </varlistentry>
2956
2957 <varlistentry>
18de0969 2958 <term><varname>IntervalSec=</varname></term>
b078e528
YW
2959 <listitem>
2960 <para>Takes a timespan. This is used to ensure that the measured minimum delay does not
2961 become too stale. Defaults to unset and kernel's default is used.</para>
2962 </listitem>
2963 </varlistentry>
2964
2965 <varlistentry>
18de0969 2966 <term><varname>ECN=</varname></term>
b078e528
YW
2967 <listitem>
2968 <para>Takes a boolean. This can be used to mark packets instead of dropping them. Defaults to
2969 unset and kernel's default is used.</para>
2970 </listitem>
2971 </varlistentry>
2972
2973 <varlistentry>
18de0969 2974 <term><varname>CEThresholdSec=</varname></term>
b078e528
YW
2975 <listitem>
2976 <para>Takes a timespan. This sets a threshold above which all packets are marked with ECN
2977 Congestion Experienced (CE). Defaults to unset and kernel's default is used.</para>
2978 </listitem>
2979 </varlistentry>
18de0969
YW
2980 </variablelist>
2981 </refsect1>
b078e528 2982
f5fc0441
SS
2983 <refsect1>
2984 <title>[DeficitRoundRobinScheduler] Section Options</title>
bdac5608
ZJS
2985 <para>The [DeficitRoundRobinScheduler] section manages the queueing discipline (qdisc) of Deficit Round
2986 Robin Scheduler (DRR).</para>
f5fc0441
SS
2987
2988 <variablelist class='network-directives'>
f344a492
YW
2989 <xi:include href="tc.xml" xpointer="qdisc-parent" />
2990 <xi:include href="tc.xml" xpointer="qdisc-handle" />
f5fc0441
SS
2991 </variablelist>
2992 </refsect1>
2993
ad365c5d
YW
2994 <refsect1>
2995 <title>[DeficitRoundRobinSchedulerClass] Section Options</title>
bdac5608
ZJS
2996 <para>The [DeficitRoundRobinSchedulerClass] section manages the traffic control class of Deficit Round
2997 Robin Scheduler (DRR).</para>
ad365c5d
YW
2998
2999 <variablelist class='network-directives'>
f344a492
YW
3000 <xi:include href="tc.xml" xpointer="tclass-parent" />
3001 <xi:include href="tc.xml" xpointer="tclass-classid" />
ad365c5d
YW
3002
3003 <varlistentry>
c03ef420 3004 <term><varname>QuantumBytes=</varname></term>
ad365c5d 3005 <listitem>
c03ef420
YW
3006 <para>Specifies the amount of bytes a flow is allowed to dequeue before the scheduler moves
3007 to the next class. When suffixed with K, M, or G, the specified size is parsed as Kilobytes,
3008 Megabytes, or Gigabytes, respectively, to the base of 1024. Defaults to the MTU of the
3009 interface.</para>
ad365c5d
YW
3010 </listitem>
3011 </varlistentry>
3012
3013 </variablelist>
3014 </refsect1>
3015
d474aa51
YW
3016 <refsect1>
3017 <title>[EnhancedTransmissionSelection] Section Options</title>
bdac5608
ZJS
3018 <para>The [EnhancedTransmissionSelection] section manages the queueing discipline (qdisc) of Enhanced
3019 Transmission Selection (ETS).</para>
d474aa51
YW
3020
3021 <variablelist class='network-directives'>
3022 <xi:include href="tc.xml" xpointer="qdisc-parent" />
3023 <xi:include href="tc.xml" xpointer="qdisc-handle" />
3024
3025 <varlistentry>
3026 <term><varname>Bands=</varname></term>
3027 <listitem>
e9dd6984
ZJS
3028 <para>Specifies the number of bands. An unsigned integer in the range 1–16. This value has to be at
3029 least large enough to cover the strict bands specified through the <varname>StrictBands=</varname>
3030 and bandwidth-sharing bands specified in <varname>QuantumBytes=</varname>.</para>
d474aa51
YW
3031 </listitem>
3032 </varlistentry>
3033
3034 <varlistentry>
3035 <term><varname>StrictBands=</varname></term>
3036 <listitem>
e9dd6984
ZJS
3037 <para>Specifies the number of bands that should be created in strict mode. An unsigned integer in
3038 the range 1–16.</para>
d474aa51
YW
3039 </listitem>
3040 </varlistentry>
3041
3042 <varlistentry>
3043 <term><varname>QuantumBytes=</varname></term>
3044 <listitem>
3045 <para>Specifies the white-space separated list of quantum used in band-sharing bands. When
3046 suffixed with K, M, or G, the specified size is parsed as Kilobytes, Megabytes, or Gigabytes,
3047 respectively, to the base of 1024. This setting can be specified multiple times. If an empty
3048 string is assigned, then the all previous assignments are cleared.</para>
3049 </listitem>
3050 </varlistentry>
3051
3052 <varlistentry>
3053 <term><varname>PriorityMap=</varname></term>
3054 <listitem>
3055 <para>The priority map maps the priority of a packet to a band. The argument is a white-space
3056 separated list of numbers. The first number indicates which band the packets with priority
3057 0 should be put to, the second is for priority 1, and so on. There can be up to 16 numbers in
3058 the list. If there are fewer, the default band that traffic with one of the unmentioned
3059 priorities goes to is the last one. Each band number must be 0..255. This setting can be
3060 specified multiple times. If an empty string is assigned, then the all previous assignments
3061 are cleared.</para>
3062 </listitem>
3063 </varlistentry>
3064 </variablelist>
3065 </refsect1>
3066
609e8340
SS
3067 <refsect1>
3068 <title>[GenericRandomEarlyDetection] Section Options</title>
bdac5608
ZJS
3069 <para>The [GenericRandomEarlyDetection] section manages the queueing discipline (qdisc) of Generic Random
3070 Early Detection (GRED).</para>
609e8340
SS
3071
3072 <variablelist class='network-directives'>
f344a492
YW
3073 <xi:include href="tc.xml" xpointer="qdisc-parent" />
3074 <xi:include href="tc.xml" xpointer="qdisc-handle" />
609e8340
SS
3075
3076 <varlistentry>
3077 <term><varname>VirtualQueues=</varname></term>
3078 <listitem>
3079 <para>Specifies the number of virtual queues. Takes a integer in the range 1-16. Defaults to unset and kernel's default is used.</para>
3080 </listitem>
3081 </varlistentry>
3082
3083 <varlistentry>
3084 <term><varname>DefaultVirtualQueue=</varname></term>
3085 <listitem>
3086 <para>Specifies the number of default virtual queue. This must be less than <varname>VirtualQueue=</varname>.
3087 Defaults to unset and kernel's default is used.</para>
3088 </listitem>
3089 </varlistentry>
3090
3091 <varlistentry>
3092 <term><varname>GenericRIO=</varname></term>
3093 <listitem>
3094 <para>Takes a boolean. It turns on the RIO-like buffering scheme. Defaults to
3095 unset and kernel's default is used.</para>
3096 </listitem>
3097 </varlistentry>
3098 </variablelist>
3099 </refsect1>
3100
18de0969
YW
3101 <refsect1>
3102 <title>[FairQueueingControlledDelay] Section Options</title>
bdac5608
ZJS
3103 <para>The [FairQueueingControlledDelay] section manages the queueing discipline (qdisc) of fair queuing
3104 controlled delay (FQ-CoDel).</para>
18de0969
YW
3105
3106 <variablelist class='network-directives'>
f344a492
YW
3107 <xi:include href="tc.xml" xpointer="qdisc-parent" />
3108 <xi:include href="tc.xml" xpointer="qdisc-handle" />
d8b2396d 3109
18de0969
YW
3110 <varlistentry>
3111 <term><varname>PacketLimit=</varname></term>
4e5ef149
SS
3112 <listitem>
3113 <para>Specifies the hard limit on the real queue size. When this limit is reached, incoming packets are
3114 dropped. Defaults to unset and kernel's default is used.</para>
3115 </listitem>
3116 </varlistentry>
3117
ac810b75 3118 <varlistentry>
c03ef420 3119 <term><varname>MemoryLimitBytes=</varname></term>
ac810b75
YW
3120 <listitem>
3121 <para>Specifies the limit on the total number of bytes that can be queued in this FQ-CoDel instance.
3122 When suffixed with K, M, or G, the specified size is parsed as Kilobytes, Megabytes, or Gigabytes,
3123 respectively, to the base of 1024. Defaults to unset and kernel's default is used.</para>
3124 </listitem>
3125 </varlistentry>
3126
3127 <varlistentry>
18de0969 3128 <term><varname>Flows=</varname></term>
ac810b75
YW
3129 <listitem>
3130 <para>Specifies the number of flows into which the incoming packets are classified.
3131 Defaults to unset and kernel's default is used.</para>
3132 </listitem>
3133 </varlistentry>
3134
3135 <varlistentry>
18de0969 3136 <term><varname>TargetSec=</varname></term>
ac810b75
YW
3137 <listitem>
3138 <para>Takes a timespan. Specifies the acceptable minimum standing/persistent queue delay.
3139 Defaults to unset and kernel's default is used.</para>
3140 </listitem>
3141 </varlistentry>
3142
3143 <varlistentry>
18de0969 3144 <term><varname>IntervalSec=</varname></term>
ac810b75
YW
3145 <listitem>
3146 <para>Takes a timespan. This is used to ensure that the measured minimum delay does not
3147 become too stale. Defaults to unset and kernel's default is used.</para>
3148 </listitem>
3149 </varlistentry>
3150
3151 <varlistentry>
c03ef420 3152 <term><varname>QuantumBytes=</varname></term>
ac810b75 3153 <listitem>
e9dd6984 3154 <para>Specifies the number of bytes used as the "deficit" in the fair queuing algorithm timespan.
ac810b75
YW
3155 When suffixed with K, M, or G, the specified size is parsed as Kilobytes, Megabytes, or Gigabytes,
3156 respectively, to the base of 1024. Defaults to unset and kernel's default is used.</para>
3157 </listitem>
3158 </varlistentry>
3159
3160 <varlistentry>
18de0969 3161 <term><varname>ECN=</varname></term>
ac810b75
YW
3162 <listitem>
3163 <para>Takes a boolean. This can be used to mark packets instead of dropping them. Defaults to
3164 unset and kernel's default is used.</para>
3165 </listitem>
3166 </varlistentry>
3167
3168 <varlistentry>
18de0969 3169 <term><varname>CEThresholdSec=</varname></term>
ac810b75
YW
3170 <listitem>
3171 <para>Takes a timespan. This sets a threshold above which all packets are marked with ECN
3172 Congestion Experienced (CE). Defaults to unset and kernel's default is used.</para>
3173 </listitem>
3174 </varlistentry>
18de0969
YW
3175 </variablelist>
3176 </refsect1>
3177
3178 <refsect1>
ca58d00c 3179 <title>[FairQueueing] Section Options</title>
bdac5608
ZJS
3180 <para>The [FairQueueing] section manages the queueing discipline (qdisc) of fair queue traffic policing
3181 (FQ).</para>
18de0969
YW
3182
3183 <variablelist class='network-directives'>
f344a492
YW
3184 <xi:include href="tc.xml" xpointer="qdisc-parent" />
3185 <xi:include href="tc.xml" xpointer="qdisc-handle" />
d8b2396d 3186
7234b915 3187 <varlistentry>
18de0969 3188 <term><varname>PacketLimit=</varname></term>
7234b915
SS
3189 <listitem>
3190 <para>Specifies the hard limit on the real queue size. When this limit is reached, incoming packets are
3191 dropped. Defaults to unset and kernel's default is used.</para>
3192 </listitem>
3193 </varlistentry>
3194
e83562e5 3195 <varlistentry>
18de0969 3196 <term><varname>FlowLimit=</varname></term>
e83562e5
YW
3197 <listitem>
3198 <para>Specifies the hard limit on the maximum number of packets queued per flow. Defaults to
3199 unset and kernel's default is used.</para>
3200 </listitem>
3201 </varlistentry>
3202
3203 <varlistentry>
c03ef420 3204 <term><varname>QuantumBytes=</varname></term>
e83562e5
YW
3205 <listitem>
3206 <para>Specifies the credit per dequeue RR round, i.e. the amount of bytes a flow is allowed
3207 to dequeue at once. When suffixed with K, M, or G, the specified size is parsed as Kilobytes,
3208 Megabytes, or Gigabytes, respectively, to the base of 1024. Defaults to unset and kernel's
3209 default is used.</para>
3210 </listitem>
3211 </varlistentry>
3212
3213 <varlistentry>
c03ef420 3214 <term><varname>InitialQuantumBytes=</varname></term>
e83562e5
YW
3215 <listitem>
3216 <para>Specifies the initial sending rate credit, i.e. the amount of bytes a new flow is
3217 allowed to dequeue initially. When suffixed with K, M, or G, the specified size is parsed as
3218 Kilobytes, Megabytes, or Gigabytes, respectively, to the base of 1024. Defaults to unset and
3219 kernel's default is used.</para>
3220 </listitem>
3221 </varlistentry>
3222
3223 <varlistentry>
18de0969 3224 <term><varname>MaximumRate=</varname></term>
e83562e5
YW
3225 <listitem>
3226 <para>Specifies the maximum sending rate of a flow. When suffixed with K, M, or G, the
6b8fe4c3 3227 specified size is parsed as Kilobits, Megabits, or Gigabits, respectively, to the base of
e83562e5
YW
3228 1000. Defaults to unset and kernel's default is used.</para>
3229 </listitem>
3230 </varlistentry>
3231
3232 <varlistentry>
18de0969 3233 <term><varname>Buckets=</varname></term>
e83562e5
YW
3234 <listitem>
3235 <para>Specifies the size of the hash table used for flow lookups. Defaults to unset and
3236 kernel's default is used.</para>
3237 </listitem>
3238 </varlistentry>
3239
3240 <varlistentry>
18de0969 3241 <term><varname>OrphanMask=</varname></term>
e83562e5
YW
3242 <listitem>
3243 <para>Takes an unsigned integer. For packets not owned by a socket, fq is able to mask a part
3244 of hash and reduce number of buckets associated with the traffic. Defaults to unset and
3245 kernel's default is used.</para>
3246 </listitem>
3247 </varlistentry>
3248
3249 <varlistentry>
18de0969 3250 <term><varname>Pacing=</varname></term>
e83562e5
YW
3251 <listitem>
3252 <para>Takes a boolean, and enables or disables flow pacing. Defaults to unset and kernel's
3253 default is used.</para>
3254 </listitem>
3255 </varlistentry>
3256
3257 <varlistentry>
18de0969 3258 <term><varname>CEThresholdSec=</varname></term>
e83562e5
YW
3259 <listitem>
3260 <para>Takes a timespan. This sets a threshold above which all packets are marked with ECN
3261 Congestion Experienced (CE). Defaults to unset and kernel's default is used.</para>
3262 </listitem>
3263 </varlistentry>
0f5bd7fe
SS
3264 </variablelist>
3265 </refsect1>
3266
9b749c11
YW
3267 <refsect1>
3268 <title>[TrivialLinkEqualizer] Section Options</title>
bdac5608
ZJS
3269 <para>The [TrivialLinkEqualizer] section manages the queueing discipline (qdisc) of trivial link
3270 equalizer (teql).</para>
9b749c11
YW
3271
3272 <variablelist class='network-directives'>
f344a492
YW
3273 <xi:include href="tc.xml" xpointer="qdisc-parent" />
3274 <xi:include href="tc.xml" xpointer="qdisc-handle" />
d8b2396d 3275
9b749c11
YW
3276 <varlistentry>
3277 <term><varname>Id=</varname></term>
3278 <listitem>
3279 <para>Specifies the interface ID <literal>N</literal> of teql. Defaults to <literal>0</literal>.
3280 Note that when teql is used, currently, the module <constant>sch_teql</constant> with
3281 <constant>max_equalizers=N+1</constant> option must be loaded before
3282 <command>systemd-networkd</command> is started.</para>
3283 </listitem>
3284 </varlistentry>
3285 </variablelist>
3286 </refsect1>
3287
b934ac3d
YW
3288 <refsect1>
3289 <title>[HierarchyTokenBucket] Section Options</title>
bdac5608
ZJS
3290 <para>The [HierarchyTokenBucket] section manages the queueing discipline (qdisc) of hierarchy token
3291 bucket (htb).</para>
b934ac3d
YW
3292
3293 <variablelist class='network-directives'>
f344a492
YW
3294 <xi:include href="tc.xml" xpointer="qdisc-parent" />
3295 <xi:include href="tc.xml" xpointer="qdisc-handle" />
b934ac3d
YW
3296
3297 <varlistentry>
3298 <term><varname>DefaultClass=</varname></term>
3299 <listitem>
3300 <para>Takes the minor id in hexadecimal of the default class. Unclassified traffic gets sent
3301 to the class. Defaults to unset.</para>
3302 </listitem>
3303 </varlistentry>
d9eacc1c
YW
3304
3305 <varlistentry>
3306 <term><varname>RateToQuantum=</varname></term>
3307 <listitem>
3308 <para>Takes an unsigned integer. The DRR quantums are calculated by dividing the value
3309 configured in <varname>Rate=</varname> by <varname>RateToQuantum=</varname>.</para>
3310 </listitem>
3311 </varlistentry>
b934ac3d
YW
3312 </variablelist>
3313 </refsect1>
3314
19f86a63
YW
3315 <refsect1>
3316 <title>[HierarchyTokenBucketClass] Section Options</title>
bdac5608
ZJS
3317 <para>The [HierarchyTokenBucketClass] section manages the traffic control class of hierarchy token bucket
3318 (htb).</para>
19f86a63
YW
3319
3320 <variablelist class='network-directives'>
f344a492
YW
3321 <xi:include href="tc.xml" xpointer="tclass-parent" />
3322 <xi:include href="tc.xml" xpointer="tclass-classid" />
19f86a63
YW
3323
3324 <varlistentry>
3325 <term><varname>Priority=</varname></term>
3326 <listitem>
3327 <para>Specifies the priority of the class. In the round-robin process, classes with the lowest
d9eacc1c
YW
3328 priority field are tried for packets first.</para>
3329 </listitem>
3330 </varlistentry>
3331
3332 <varlistentry>
3333 <term><varname>QuantumBytes=</varname></term>
3334 <listitem>
3335 <para>Specifies how many bytes to serve from leaf at once. When suffixed with K, M, or G, the
3336 specified size is parsed as Kilobytes, Megabytes, or Gigabytes, respectively, to the base of
3337 1024.</para>
3338 </listitem>
3339 </varlistentry>
3340
3341 <varlistentry>
3342 <term><varname>MTUBytes=</varname></term>
3343 <listitem>
3344 <para>Specifies the maximum packet size we create. When suffixed with K, M, or G, the specified
3345 size is parsed as Kilobytes, Megabytes, or Gigabytes, respectively, to the base of 1024.</para>
3346 </listitem>
3347 </varlistentry>
3348
3349 <varlistentry>
3350 <term><varname>OverheadBytes=</varname></term>
3351 <listitem>
3352 <para>Takes an unsigned integer which specifies per-packet size overhead used in rate
3353 computations. When suffixed with K, M, or G, the specified size is parsed as Kilobytes,
3354 Megabytes, or Gigabytes, respectively, to the base of 1024.</para>
19f86a63
YW
3355 </listitem>
3356 </varlistentry>
3357
3358 <varlistentry>
3359 <term><varname>Rate=</varname></term>
3360 <listitem>
3361 <para>Specifies the maximum rate this class and all its children are guaranteed. When suffixed
3362 with K, M, or G, the specified size is parsed as Kilobits, Megabits, or Gigabits, respectively,
3363 to the base of 1000. This setting is mandatory.</para>
3364 </listitem>
3365 </varlistentry>
3366
3367 <varlistentry>
3368 <term><varname>CeilRate=</varname></term>
3369 <listitem>
3370 <para>Specifies the maximum rate at which a class can send, if its parent has bandwidth to spare.
3371 When suffixed with K, M, or G, the specified size is parsed as Kilobits, Megabits, or Gigabits,
3372 respectively, to the base of 1000. When unset, the value specified with <varname>Rate=</varname>
3373 is used.</para>
3374 </listitem>
3375 </varlistentry>
d9eacc1c
YW
3376
3377 <varlistentry>
3378 <term><varname>BufferBytes=</varname></term>
3379 <listitem>
3380 <para>Specifies the maximum bytes burst which can be accumulated during idle period. When suffixed
3381 with K, M, or G, the specified size is parsed as Kilobytes, Megabytes, or Gigabytes, respectively,
3382 to the base of 1024.</para>
3383 </listitem>
3384 </varlistentry>
3385
3386 <varlistentry>
3387 <term><varname>CeilBufferBytes=</varname></term>
3388 <listitem>
3389 <para>Specifies the maximum bytes burst for ceil which can be accumulated during idle period.
3390 When suffixed with K, M, or G, the specified size is parsed as Kilobytes, Megabytes, or Gigabytes,
3391 respectively, to the base of 1024.</para>
3392 </listitem>
3393 </varlistentry>
7f224020
SS
3394 </variablelist>
3395 </refsect1>
3396
3397 <refsect1>
3398 <title>[HeavyHitterFilter] Section Options</title>
bdac5608
ZJS
3399 <para>The [HeavyHitterFilter] section manages the queueing discipline (qdisc) of Heavy Hitter Filter
3400 (hhf).</para>
7f224020
SS
3401
3402 <variablelist class='network-directives'>
f344a492
YW
3403 <xi:include href="tc.xml" xpointer="qdisc-parent" />
3404 <xi:include href="tc.xml" xpointer="qdisc-handle" />
19f86a63 3405
7f224020
SS
3406 <varlistentry>
3407 <term><varname>PacketLimit=</varname></term>
3408 <listitem>
e9dd6984
ZJS
3409 <para>Specifies the hard limit on the queue size in number of packets. When this limit is reached,
3410 incoming packets are dropped. An unsigned integer in the range 0–4294967294. Defaults to unset and
3411 kernel's default is used.</para>
7f224020
SS
3412 </listitem>
3413 </varlistentry>
19f86a63
YW
3414 </variablelist>
3415 </refsect1>
3416
b12aaee5
SS
3417 <refsect1>
3418 <title>[QuickFairQueueing] Section Options</title>
bdac5608
ZJS
3419 <para>The [QuickFairQueueing] section manages the queueing discipline (qdisc) of Quick Fair Queueing
3420 (QFQ).</para>
b12aaee5
SS
3421
3422 <variablelist class='network-directives'>
3423 <xi:include href="tc.xml" xpointer="qdisc-parent" />
3424 <xi:include href="tc.xml" xpointer="qdisc-handle" />
3425 </variablelist>
3426 </refsect1>
3427
4d7ddaf9
YW
3428 <refsect1>
3429 <title>[QuickFairQueueingClass] Section Options</title>
bdac5608
ZJS
3430 <para>The [QuickFairQueueingClass] section manages the traffic control class of Quick Fair Queueing
3431 (qfq).</para>
4d7ddaf9
YW
3432
3433 <variablelist class='network-directives'>
3434 <xi:include href="tc.xml" xpointer="tclass-parent" />
3435 <xi:include href="tc.xml" xpointer="tclass-classid" />
3436
3437 <varlistentry>
3438 <term><varname>Weight=</varname></term>
3439 <listitem>
7487b486 3440 <para>Specifies the weight of the class. Takes an integer in the range 1..1023. Defaults to
4d7ddaf9
YW
3441 unset in which case the kernel default is used.</para>
3442 </listitem>
3443 </varlistentry>
3444
3445 <varlistentry>
c03ef420 3446 <term><varname>MaxPacketBytes=</varname></term>
4d7ddaf9
YW
3447 <listitem>
3448 <para>Specifies the maximum packet size in bytes for the class. When suffixed with K, M, or G, the specified
c03ef420 3449 size is parsed as Kilobytes, Megabytes, or Gigabytes, respectively, to the base of 1024. When unset,
4d7ddaf9
YW
3450 the kernel default is used.</para>
3451 </listitem>
3452 </varlistentry>
3453 </variablelist>
3454 </refsect1>
3455
13b498f9
TJ
3456 <refsect1>
3457 <title>[BridgeVLAN] Section Options</title>
bdac5608
ZJS
3458 <para>The [BridgeVLAN] section manages the VLAN ID configuration of a bridge port and accepts the
3459 following keys. Specify several [BridgeVLAN] sections to configure several VLAN entries. The
3460 <varname>VLANFiltering=</varname> option has to be enabled, see the [Bridge] section in
13b498f9
TJ
3461 <citerefentry><refentrytitle>systemd.netdev</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para>
3462
3463 <variablelist class='network-directives'>
3464 <varlistentry>
3465 <term><varname>VLAN=</varname></term>
3466 <listitem>
3467 <para>The VLAN ID allowed on the port. This can be either a single ID or a range M-N. VLAN IDs are valid
3468 from 1 to 4094.</para>
3469 </listitem>
3470 </varlistentry>
3471 <varlistentry>
3472 <term><varname>EgressUntagged=</varname></term>
3473 <listitem>
3474 <para>The VLAN ID specified here will be used to untag frames on egress. Configuring
3475 <varname>EgressUntagged=</varname> implicates the use of <varname>VLAN=</varname> above and will enable the
3476 VLAN ID for ingress as well. This can be either a single ID or a range M-N.</para>
3477 </listitem>
3478 </varlistentry>
3479 <varlistentry>
3480 <term><varname>PVID=</varname></term>
3481 <listitem>
3482 <para>The Port VLAN ID specified here is assigned to all untagged frames at ingress.
3483 <varname>PVID=</varname> can be used only once. Configuring <varname>PVID=</varname> implicates the use of
3484 <varname>VLAN=</varname> above and will enable the VLAN ID for ingress as well.</para>
3485 </listitem>
3486 </varlistentry>
3487 </variablelist>
3488 </refsect1>
798d3a52
ZJS
3489
3490 <refsect1>
9e35b3de 3491 <title>Examples</title>
798d3a52 3492 <example>
9e35b3de 3493 <title>Static network configuration</title>
798d3a52 3494
9e35b3de
ZJS
3495 <programlisting># /etc/systemd/network/50-static.network
3496[Match]
eac684ef
TG
3497Name=enp2s0
3498
3499[Network]
3500Address=192.168.0.15/24
3501Gateway=192.168.0.1</programlisting>
9e35b3de
ZJS
3502
3503 <para>This brings interface <literal>enp2s0</literal> up with a static address. The
3504 specified gateway will be used for a default route.</para>
798d3a52 3505 </example>
eac684ef 3506
798d3a52 3507 <example>
9e35b3de 3508 <title>DHCP on ethernet links</title>
eac684ef 3509
9e35b3de
ZJS
3510 <programlisting># /etc/systemd/network/80-dhcp.network
3511[Match]
eac684ef
TG
3512Name=en*
3513
3514[Network]
9c8ca3f7 3515DHCP=yes</programlisting>
9e35b3de
ZJS
3516
3517 <para>This will enable DHCPv4 and DHCPv6 on all interfaces with names starting with
3518 <literal>en</literal> (i.e. ethernet interfaces).</para>
798d3a52 3519 </example>
eac684ef 3520
4c94a4c2 3521 <example>
3522 <title>IPv6 Prefix Delegation</title>
3523
3524 <programlisting># /etc/systemd/network/55-ipv6-pd-upstream.network
3525[Match]
3526Name=enp1s0
3527
3528[Network]
3529DHCP=ipv6</programlisting>
3530
3531 <programlisting># /etc/systemd/network/56-ipv6-pd-downstream.network
3532[Match]
3533Name=enp2s0
3534
3535[Network]
73b432e7 3536IPv6PrefixDelegation=dhcpv6</programlisting>
4c94a4c2 3537
3538 <para>This will enable IPv6 PD on the interface enp1s0 as an upstream interface where the
3539 DHCPv6 client is running and enp2s0 as a downstream interface where the prefix is delegated to.</para>
3540 </example>
3541
798d3a52 3542 <example>
9e35b3de 3543 <title>A bridge with two enslaved links</title>
f47c5c47 3544
9e35b3de
ZJS
3545 <programlisting># /etc/systemd/network/25-bridge-static.network
3546[Match]
f47c5c47 3547Name=bridge0
3548
3549[Network]
3550Address=192.168.0.15/24
3551Gateway=192.168.0.1
3552DNS=192.168.0.1</programlisting>
f47c5c47 3553
9e35b3de
ZJS
3554 <programlisting># /etc/systemd/network/25-bridge-slave-interface-1.network
3555[Match]
f47c5c47 3556Name=enp2s0
3557
3558[Network]
3559Bridge=bridge0</programlisting>
9e35b3de
ZJS
3560
3561 <programlisting># /etc/systemd/network/25-bridge-slave-interface-2.network
3562[Match]
3563Name=wlp3s0
3564
3565[Network]
3566Bridge=bridge0</programlisting>
3567
3568 <para>This creates a bridge and attaches devices <literal>enp2s0</literal> and
3569 <literal>wlp3s0</literal> to it. The bridge will have the specified static address
3570 and network assigned, and a default route via the specified gateway will be
3571 added. The specified DNS server will be added to the global list of DNS resolvers.
3572 </para>
13b498f9 3573 </example>
9e35b3de 3574
13b498f9 3575 <example>
9e35b3de 3576 <title></title>
13b498f9 3577
9e35b3de
ZJS
3578 <programlisting>
3579# /etc/systemd/network/20-bridge-slave-interface-vlan.network
3580[Match]
13b498f9
TJ
3581Name=enp2s0
3582
3583[Network]
3584Bridge=bridge0
3585
3586[BridgeVLAN]
3587VLAN=1-32
3588PVID=42
3589EgressUntagged=42
3590
3591[BridgeVLAN]
3592VLAN=100-200
3593
3594[BridgeVLAN]
3595EgressUntagged=300-400</programlisting>
0a8a0fad 3596
9e35b3de
ZJS
3597 <para>This overrides the configuration specified in the previous example for the
3598 interface <literal>enp2s0</literal>, and enables VLAN on that bridge port. VLAN IDs
3599 1-32, 42, 100-400 will be allowed. Packets tagged with VLAN IDs 42, 300-400 will be
3600 untagged when they leave on this interface. Untagged packets which arrive on this
3601 interface will be assigned VLAN ID 42.</para>
798d3a52 3602 </example>
0a8a0fad 3603
798d3a52 3604 <example>
9e35b3de 3605 <title>Various tunnels</title>
0a8a0fad 3606
9e35b3de
ZJS
3607 <programlisting>/etc/systemd/network/25-tunnels.network
3608[Match]
3609Name=ens1
0a8a0fad
TG
3610
3611[Network]
9e35b3de
ZJS
3612Tunnel=ipip-tun
3613Tunnel=sit-tun
3614Tunnel=gre-tun
3615Tunnel=vti-tun
3616 </programlisting>
3617
3618 <programlisting>/etc/systemd/network/25-tunnel-ipip.netdev
3619[NetDev]
3620Name=ipip-tun
3621Kind=ipip
3622 </programlisting>
3623
3624 <programlisting>/etc/systemd/network/25-tunnel-sit.netdev
3625[NetDev]
3626Name=sit-tun
3627Kind=sit
3628 </programlisting>
3629
3630 <programlisting>/etc/systemd/network/25-tunnel-gre.netdev
3631[NetDev]
3632Name=gre-tun
3633Kind=gre
3634 </programlisting>
3635
3636 <programlisting>/etc/systemd/network/25-tunnel-vti.netdev
3637[NetDev]
3638Name=vti-tun
3639Kind=vti
3640 </programlisting>
3641
3642 <para>This will bring interface <literal>ens1</literal> up and create an IPIP tunnel,
3643 a SIT tunnel, a GRE tunnel, and a VTI tunnel using it.</para>
798d3a52 3644 </example>
0a8a0fad 3645
798d3a52 3646 <example>
9e35b3de 3647 <title>A bond device</title>
0a8a0fad 3648
9e35b3de
ZJS
3649 <programlisting># /etc/systemd/network/30-bond1.network
3650[Match]
3651Name=bond1
0a8a0fad
TG
3652
3653[Network]
9e35b3de
ZJS
3654DHCP=ipv6
3655</programlisting>
0a8a0fad 3656
9e35b3de
ZJS
3657 <programlisting># /etc/systemd/network/30-bond1.netdev
3658[NetDev]
3659Name=bond1
3660Kind=bond
3661</programlisting>
0a8a0fad 3662
301a21a8 3663 <programlisting># /etc/systemd/network/30-bond1-dev1.network
9e35b3de
ZJS
3664[Match]
3665MACAddress=52:54:00:e9:64:41
0a8a0fad
TG
3666
3667[Network]
9e35b3de
ZJS
3668Bond=bond1
3669</programlisting>
d94facdc 3670
301a21a8 3671 <programlisting># /etc/systemd/network/30-bond1-dev2.network
9e35b3de
ZJS
3672[Match]
3673MACAddress=52:54:00:e9:64:42
d94facdc
MH
3674
3675[Network]
9e35b3de 3676Bond=bond1
6cb955c6 3677</programlisting>
9e35b3de
ZJS
3678
3679 <para>This will create a bond device <literal>bond1</literal> and enslave the two
3680 devices with MAC addresses 52:54:00:e9:64:41 and 52:54:00:e9:64:42 to it. IPv6 DHCP
3681 will be used to acquire an address.</para>
6cb955c6
AR
3682 </example>
3683
3684 <example>
9e35b3de
ZJS
3685 <title>Virtual Routing and Forwarding (VRF)</title>
3686 <para>Add the <literal>bond1</literal> interface to the VRF master interface
3687 <literal>vrf1</literal>. This will redirect routes generated on this interface to be
11d38b90
AR
3688 within the routing table defined during VRF creation. For kernels before 4.8 traffic
3689 won't be redirected towards the VRFs routing table unless specific ip-rules are added.
3690 </para>
9e35b3de
ZJS
3691 <programlisting># /etc/systemd/network/25-vrf.network
3692[Match]
6cb955c6
AR
3693Name=bond1
3694
3695[Network]
9e35b3de 3696VRF=vrf1
d94facdc
MH
3697</programlisting>
3698 </example>
3699
42125eda
SS
3700 <example>
3701 <title>MacVTap</title>
3702 <para>This brings up a network interface <literal>macvtap-test</literal>
3703 and attaches it to <literal>enp0s25</literal>.</para>
83ddf5d3 3704 <programlisting># /usr/lib/systemd/network/25-macvtap.network
42125eda
SS
3705[Match]
3706Name=enp0s25
3707
3708[Network]
3709MACVTAP=macvtap-test
3710</programlisting>
3711 </example>
98d20a17 3712
3713 <example>
3714 <title>A Xfrm interface with physical underlying device.</title>
3715
3716 <programlisting># /etc/systemd/network/27-xfrm.netdev
3717[NetDev]
3718Name=xfrm0
3719
3720[Xfrm]
3721InterfaceId=7</programlisting>
3722
3723 <programlisting># /etc/systemd/network/27-eth0.network
3724[Match]
3725Name=eth0
3726
3727[Network]
3728Xfrm=xfrm0</programlisting>
3729
3730 <para>This creates a <literal>xfrm0</literal> interface and binds it to the <literal>eth0</literal> device.
3731 This allows hardware based ipsec offloading to the <literal>eth0</literal> nic.
3732 If offloading is not needed, xfrm interfaces can be assigned to the <literal>lo</literal> device.
3733 </para>
3734 </example>
798d3a52
ZJS
3735 </refsect1>
3736
3737 <refsect1>
3738 <title>See Also</title>
3739 <para>
3740 <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
f41b446a 3741 <citerefentry><refentrytitle>systemd-networkd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
798d3a52 3742 <citerefentry><refentrytitle>systemd.link</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
aaa297d4
LP
3743 <citerefentry><refentrytitle>systemd.netdev</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
3744 <citerefentry><refentrytitle>systemd-resolved.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>
798d3a52
ZJS
3745 </para>
3746 </refsect1>
eac684ef
TG
3747
3748</refentry>