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