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