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