]> git.ipfire.org Git - thirdparty/systemd.git/blame - man/systemd.network.xml
network: add support to RoutingPolicyRule lookup table name
[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>
e64652f7
AN
1054 <para>The scope of the address, which can be
1055 <literal>global</literal> (valid everywhere on the network, even through a gateway),
1056 <literal>link</literal> (only valid on this device, will not traverse a gateway) or
1057 <literal>host</literal> (only valid within the device itself, e.g. 127.0.0.1)
1058 or an unsigned integer in the range 0—255.
2959fb07
SS
1059 Defaults to <literal>global</literal>.</para>
1060 </listitem>
1061 </varlistentry>
e63be084
SS
1062 <varlistentry>
1063 <term><varname>HomeAddress=</varname></term>
1064 <listitem>
9b6ffef3 1065 <para>Takes a boolean. Designates this address the "home address" as defined in
e63be084
SS
1066 <ulink url="https://tools.ietf.org/html/rfc6275">RFC 6275</ulink>.
1067 Supported only on IPv6. Defaults to false.</para>
1068 </listitem>
1069 </varlistentry>
1070 <varlistentry>
1071 <term><varname>DuplicateAddressDetection=</varname></term>
1072 <listitem>
051e77ca
SS
1073 <para>Takes one of <literal>ipv4</literal>, <literal>ipv6</literal>,
1074 <literal>both</literal>, <literal>none</literal>. When <literal>ipv4</literal>,
1075 performs IPv4 Duplicate Address Detection. See
1076 <ulink url="https://tools.ietf.org/html/rfc5227">RFC 5224</ulink>.
1077 When <literal>ipv6</literal>, performs IPv6 Duplicate Address Detection. See
1078 <ulink url="https://tools.ietf.org/html/rfc4862">RFC 4862</ulink>.
1079 Defaults to <literal>ipv6</literal>.</para>
e63be084
SS
1080 </listitem>
1081 </varlistentry>
1082 <varlistentry>
1083 <term><varname>ManageTemporaryAddress=</varname></term>
1084 <listitem>
9b6ffef3 1085 <para>Takes a boolean. If true the kernel manage temporary addresses created
e63be084 1086 from this one as template on behalf of Privacy Extensions
fec1b650 1087 <ulink url="https://tools.ietf.org/html/rfc3041">RFC 3041</ulink>. For this to become
e63be084 1088 active, the use_tempaddr sysctl setting has to be set to a value greater than zero.
11fcfc53 1089 The given address needs to have a prefix length of 64. This flag allows using privacy
e63be084 1090 extensions in a manually configured network, just like if stateless auto-configuration
fec1b650 1091 was active. Defaults to false.</para>
e63be084
SS
1092 </listitem>
1093 </varlistentry>
1094 <varlistentry>
de697db0 1095 <term><varname>AddPrefixRoute=</varname></term>
e63be084 1096 <listitem>
de697db0
YW
1097 <para>Takes a boolean. When true, the prefix route for the address is automatically added.
1098 Defaults to true.</para>
e63be084
SS
1099 </listitem>
1100 </varlistentry>
1101 <varlistentry>
1102 <term><varname>AutoJoin=</varname></term>
1103 <listitem>
9b6ffef3 1104 <para>Takes a boolean. Joining multicast group on ethernet level via
e63be084
SS
1105 <command>ip maddr</command> command would not work if we have an Ethernet switch that does
1106 IGMP snooping since the switch would not replicate multicast packets on ports that did not
1107 have IGMP reports for the multicast addresses. Linux vxlan interfaces created via
1108 <command>ip link add vxlan</command> or networkd's netdev kind vxlan have the group option
1109 that enables then to do the required join. By extending ip address command with option
1110 <literal>autojoin</literal> we can get similar functionality for openvswitch (OVS) vxlan
1111 interfaces as well as other tunneling mechanisms that need to receive multicast traffic.
1112 Defaults to <literal>no</literal>.</para>
1113 </listitem>
1114 </varlistentry>
798d3a52
ZJS
1115 </variablelist>
1116 </refsect1>
1117
e4a71bf3
WKI
1118 <refsect1>
1119 <title>[Neighbor] Section Options</title>
bdac5608
ZJS
1120 <para>A [Neighbor] section accepts the following keys. The neighbor section adds a permanent, static
1121 entry to the neighbor table (IPv6) or ARP table (IPv4) for the given hardware address on the links
1122 matched for the network. Specify several [Neighbor] sections to configure several static neighbors.
1123 </para>
e4a71bf3
WKI
1124
1125 <variablelist class='network-directives'>
1126 <varlistentry>
1127 <term><varname>Address=</varname></term>
1128 <listitem>
1129 <para>The IP address of the neighbor.</para>
1130 </listitem>
1131 </varlistentry>
1132 <varlistentry>
b956364d 1133 <term><varname>LinkLayerAddress=</varname></term>
e4a71bf3 1134 <listitem>
b956364d 1135 <para>The link layer address (MAC address or IP address) of the neighbor.</para>
e4a71bf3
WKI
1136 </listitem>
1137 </varlistentry>
1138 </variablelist>
1139 </refsect1>
1140
95b74ef6
SS
1141 <refsect1>
1142 <title>[IPv6AddressLabel] Section Options</title>
1143
bdac5608
ZJS
1144 <para>An [IPv6AddressLabel] section accepts the following keys. Specify several [IPv6AddressLabel]
1145 sections to configure several address labels. IPv6 address labels are used for address selection. See
1146 <ulink url="https://tools.ietf.org/html/rfc3484">RFC 3484</ulink>. Precedence is managed by userspace,
23243adf 1147 and only the label itself is stored in the kernel.</para>
95b74ef6
SS
1148
1149 <variablelist class='network-directives'>
1150 <varlistentry>
1151 <term><varname>Label=</varname></term>
1152 <listitem>
e9dd6984
ZJS
1153 <para>The label for the prefix, an unsigned integer in the range 0–4294967294.
1154 0xffffffff is reserved. This setting is mandatory.</para>
95b74ef6
SS
1155 </listitem>
1156 </varlistentry>
1157 <varlistentry>
1158 <term><varname>Prefix=</varname></term>
1159 <listitem>
1160 <para>IPv6 prefix is an address with a prefix length, separated by a slash <literal>/</literal> character.
1161 This key is mandatory. </para>
1162 </listitem>
1163 </varlistentry>
1164 </variablelist>
1165 </refsect1>
1166
bce67bbe
SS
1167 <refsect1>
1168 <title>[RoutingPolicyRule] Section Options</title>
1169
bdac5608 1170 <para>An [RoutingPolicyRule] section accepts the following keys. Specify several [RoutingPolicyRule]
bce67bbe
SS
1171 sections to configure several rules.</para>
1172
1173 <variablelist class='network-directives'>
1174 <varlistentry>
1175 <term><varname>TypeOfService=</varname></term>
1176 <listitem>
e9dd6984 1177 <para>Takes a number between 0 and 255 that specifies the type of service to match.</para>
bce67bbe
SS
1178 </listitem>
1179 </varlistentry>
1180 <varlistentry>
1181 <term><varname>From=</varname></term>
1182 <listitem>
1183 <para>Specifies the source address prefix to match. Possibly followed by a slash and the prefix length.</para>
1184 </listitem>
1185 </varlistentry>
1186 <varlistentry>
1187 <term><varname>To=</varname></term>
1188 <listitem>
1189 <para>Specifies the destination address prefix to match. Possibly followed by a slash and the prefix length.</para>
1190 </listitem>
1191 </varlistentry>
1192 <varlistentry>
1193 <term><varname>FirewallMark=</varname></term>
1194 <listitem>
cbdc9062
YW
1195 <para>Specifies the iptables firewall mark value to match (a number between 1 and
1196 4294967295). Optionally, the firewall mask (also a number between 1 and 4294967295) can be
1197 suffixed with a slash (<literal>/</literal>), e.g., <literal>7/255</literal>.</para>
bce67bbe
SS
1198 </listitem>
1199 </varlistentry>
1200 <varlistentry>
1201 <term><varname>Table=</varname></term>
1202 <listitem>
c038ce46
SS
1203 <para>Specifies the routing table identifier to lookup if the rule selector matches. Takes one of predefined names
1204 <literal>default</literal>, <literal>main</literal>, and <literal>local</literal>, and names defined in <varname>RouteTable=</varname>
1205 in <citerefentry><refentrytitle>networkd.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
41b90a1e 1206 or a number between 1 and 4294967295. Defaults to <literal>main</literal>.</para>
bce67bbe
SS
1207 </listitem>
1208 </varlistentry>
1209 <varlistentry>
1210 <term><varname>Priority=</varname></term>
1211 <listitem>
1212 <para>Specifies the priority of this rule. <varname>Priority=</varname> is an unsigned
1213 integer. Higher number means lower priority, and rules get processed in order of increasing number.</para>
1214 </listitem>
1215 </varlistentry>
762e2659
SS
1216 <varlistentry>
1217 <term><varname>IncomingInterface=</varname></term>
1218 <listitem>
1219 <para>Specifies incoming device to match. If the interface is loopback, the rule only matches packets originating from this host.</para>
1220 </listitem>
1221 </varlistentry>
1222 <varlistentry>
1223 <term><varname>OutgoingInterface=</varname></term>
1224 <listitem>
1225 <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>
1226 </listitem>
1227 </varlistentry>
926062f0
SS
1228 <varlistentry>
1229 <term><varname>SourcePort=</varname></term>
1230 <listitem>
1231 <para>Specifies the source IP port or IP port range match in forwarding information base (FIB) rules.
1232 A port range is specified by the lower and upper port separated by a dash. Defaults to unset.</para>
1233 </listitem>
1234 </varlistentry>
1235 <varlistentry>
1236 <term><varname>DestinationPort=</varname></term>
1237 <listitem>
1238 <para>Specifies the destination IP port or IP port range match in forwarding information base (FIB) rules.
1239 A port range is specified by the lower and upper port separated by a dash. Defaults to unset.</para>
1240 </listitem>
1241 </varlistentry>
1242 <varlistentry>
97f9df9e 1243 <term><varname>IPProtocol=</varname></term>
926062f0 1244 <listitem>
3a269dcf
YW
1245 <para>Specifies the IP protocol to match in forwarding information base (FIB) rules. Takes IP protocol name such as <literal>tcp</literal>,
1246 <literal>udp</literal> or <literal>sctp</literal>, or IP protocol number such as <literal>6</literal> for <literal>tcp</literal> or
1247 <literal>17</literal> for <literal>udp</literal>.
926062f0
SS
1248 Defaults to unset.</para>
1249 </listitem>
1250 </varlistentry>
8b220643
SS
1251 <varlistentry>
1252 <term><varname>InvertRule=</varname></term>
1253 <listitem>
53e1ba28 1254 <para>A boolean. Specifies whether the rule is to be inverted. Defaults to false.</para>
8b220643
SS
1255 </listitem>
1256 </varlistentry>
f6c6ff97
YW
1257 <varlistentry>
1258 <term><varname>Family=</varname></term>
1259 <listitem>
1260 <para>Takes a special value <literal>ipv4</literal>, <literal>ipv6</literal>, or
1261 <literal>both</literal>. By default, the address family is determined by the address
1262 specified in <varname>To=</varname> or <varname>From=</varname>. If neither
1263 <varname>To=</varname> nor <varname>From=</varname> are specified, then defaults to
1264 <literal>ipv4</literal>.</para>
1265 </listitem>
1266 </varlistentry>
ea471a46
YW
1267 <varlistentry>
1268 <term><varname>User=</varname></term>
1269 <listitem>
1270 <para>Takes a username, a user ID, or a range of user IDs separated by a dash. Defaults to
1271 unset.</para>
1272 </listitem>
1273 </varlistentry>
53e1ba28
NF
1274 <varlistentry>
1275 <term><varname>SuppressPrefixLength=</varname></term>
1276 <listitem>
1277 <para>Takes a number <replaceable>N</replaceable> in the range 0-128 and rejects routing
1278 decisions that have a prefix length of <replaceable>N</replaceable> or less. Defaults to
1279 unset.</para>
1280 </listitem>
1281 </varlistentry>
d7d1d18f
SS
1282 <varlistentry>
1283 <term><varname>Type=</varname></term>
1284 <listitem>
1285 <para>Specifies Routing Policy Database (RPDB) rule type. Takes one of <literal>blackhole</literal>,
1286 <literal>unreachable</literal> or <literal>prohibit</literal>.
1287 </para>
1288 </listitem>
1289 </varlistentry>
bce67bbe 1290 </variablelist>
c16c7808
SS
1291 </refsect1>
1292
1293 <refsect1>
1294 <title>[NextHop] Section Options</title>
e9dd6984
ZJS
1295 <para>The [NextHop] section is used to manipulate entries in the kernel's "nexthop" tables. The
1296 [NextHop] section accepts the following keys. Specify several [NextHop] sections to configure several
1297 hops.</para>
c16c7808
SS
1298
1299 <variablelist class='network-directives'>
1300 <varlistentry>
1301 <term><varname>Gateway=</varname></term>
1302 <listitem>
bdac5608 1303 <para>As in the [Network] section. This is mandatory.</para>
c16c7808
SS
1304 </listitem>
1305 </varlistentry>
1306 <varlistentry>
1307 <term><varname>Id=</varname></term>
1308 <listitem>
1309 <para>The id of the nexthop (an unsigned integer). If unspecified or '0' then automatically chosen by kernel.</para>
1310 </listitem>
1311 </varlistentry>
1312 </variablelist>
bce67bbe
SS
1313 </refsect1>
1314
798d3a52
ZJS
1315 <refsect1>
1316 <title>[Route] Section Options</title>
bdac5608
ZJS
1317 <para>The [Route] section accepts the following keys. Specify several [Route] sections to configure
1318 several routes.</para>
798d3a52
ZJS
1319
1320 <variablelist class='network-directives'>
1321 <varlistentry>
1322 <term><varname>Gateway=</varname></term>
1323 <listitem>
d306d1d0 1324 <para>Takes the gateway address or the special values <literal>_dhcp4</literal> and
b8caa4ef
YW
1325 <literal>_ipv6ra</literal>. If <literal>_dhcp4</literal> or <literal>_ipv6ra</literal> is
1326 set, then the gateway address provided by DHCPv4 or IPv6 RA is used.</para>
798d3a52
ZJS
1327 </listitem>
1328 </varlistentry>
28959f7d 1329 <varlistentry>
9cb8c559 1330 <term><varname>GatewayOnLink=</varname></term>
28959f7d 1331 <listitem>
9b6ffef3 1332 <para>Takes a boolean. If set to true, the kernel does not have
28959f7d
SS
1333 to check if the gateway is reachable directly by the current machine (i.e., the kernel does
1334 not need to check if the gateway is attached to the local network), so that we can insert the
9b6ffef3 1335 route in the kernel table without it being complained about. Defaults to <literal>no</literal>.
28959f7d
SS
1336 </para>
1337 </listitem>
1338 </varlistentry>
798d3a52
ZJS
1339 <varlistentry>
1340 <term><varname>Destination=</varname></term>
1341 <listitem>
1342 <para>The destination prefix of the route. Possibly
b938cb90 1343 followed by a slash and the prefix length. If omitted, a
798d3a52
ZJS
1344 full-length host route is assumed.</para>
1345 </listitem>
1346 </varlistentry>
1347 <varlistentry>
1348 <term><varname>Source=</varname></term>
1349 <listitem>
1350 <para>The source prefix of the route. Possibly followed by
b938cb90 1351 a slash and the prefix length. If omitted, a full-length
798d3a52
ZJS
1352 host route is assumed.</para>
1353 </listitem>
1354 </varlistentry>
1355 <varlistentry>
1356 <term><varname>Metric=</varname></term>
1357 <listitem>
b938cb90 1358 <para>The metric of the route (an unsigned integer).</para>
798d3a52
ZJS
1359 </listitem>
1360 </varlistentry>
b5bf6f64
SS
1361 <varlistentry>
1362 <term><varname>IPv6Preference=</varname></term>
1363 <listitem>
1364 <para>Specifies the route preference as defined in <ulink
e9dd6984
ZJS
1365 url="https://tools.ietf.org/html/rfc4191">RFC 4191</ulink> for Router Discovery messages. Which
1366 can be one of <literal>low</literal> the route has a lowest priority, <literal>medium</literal>
1367 the route has a default priority or <literal>high</literal> the route has a highest priority.
1368 </para>
b5bf6f64
SS
1369 </listitem>
1370 </varlistentry>
769b56a3
TG
1371 <varlistentry>
1372 <term><varname>Scope=</varname></term>
1373 <listitem>
e64652f7
AN
1374 <para>The scope of the IPv4 route, which can be <literal>global</literal>, <literal>site</literal>,
1375 <literal>link</literal>, <literal>host</literal>, or
1376 <literal>nowhere</literal>:</para>
1377 <itemizedlist>
1378 <listitem><para><literal>global</literal> means the route can reach
1379 hosts more than one hop away.</para></listitem>
1380
1381 <listitem><para><literal>site</literal> means an interior route in
1382 the local autonomous system.</para></listitem>
1383
1384 <listitem><para><literal>link</literal> means the route can only
1385 reach hosts on the local network (one hop away).</para></listitem>
1386
1387 <listitem><para><literal>host</literal> means the route will not
1388 leave the local machine (used for internal addresses like
1389 127.0.0.1).</para></listitem>
1390
1391 <listitem><para><literal>nowhere</literal> means the destination
1392 doesn't exist.</para></listitem>
1393 </itemizedlist>
1394 <para>For IPv4 route, defaults to <literal>host</literal> if <varname>Type=</varname> is
1395 <literal>local</literal> or <literal>nat</literal>,
1396 and <literal>link</literal> if <varname>Type=</varname> is
f5c38922 1397 <literal>broadcast</literal>, <literal>multicast</literal>, or <literal>anycast</literal>.
e64652f7
AN
1398 In other cases, defaults to <literal>global</literal>. The value is
1399 not used for IPv6.</para>
769b56a3 1400 </listitem>
0d07e595
JK
1401 </varlistentry>
1402 <varlistentry>
1403 <term><varname>PreferredSource=</varname></term>
1404 <listitem>
1405 <para>The preferred source address of the route. The address
1406 must be in the format described in
1407 <citerefentry project='man-pages'><refentrytitle>inet_pton</refentrytitle><manvolnum>3</manvolnum></citerefentry>.</para>
1408 </listitem>
769b56a3 1409 </varlistentry>
c953b24c 1410 <varlistentry>
f5c38922 1411 <term><varname>Table=</varname></term>
c953b24c 1412 <listitem>
c038ce46
SS
1413 <para>The table identifier for the route. Takes one of predefined names <literal>default</literal>, <literal>main</literal>,
1414 and <literal>local</literal>, and names defined in <varname>RouteTable=</varname> in <citerefentry><refentrytitle>networkd.conf</refentrytitle>
1415 <manvolnum>5</manvolnum></citerefentry>, or a number between 1 and 4294967295. The table can be retrieved using
1416 <command>ip route show table <replaceable>num</replaceable></command>. If unset and <varname>Type=</varname> is <literal>local</literal>,
1417 <literal>broadcast</literal>, <literal>anycast</literal>, or <literal>nat</literal>, then <literal>local</literal> is used.
f5c38922 1418 In other cases, defaults to <literal>main</literal>.
c953b24c
SS
1419 </para>
1420 </listitem>
1421 </varlistentry>
c83ecc04
SS
1422 <varlistentry>
1423 <term><varname>Protocol=</varname></term>
1424 <listitem>
88925d2f 1425 <para>The protocol identifier for the route. Takes a number between 0 and 255 or the special values
ca420b62
YW
1426 <literal>kernel</literal>, <literal>boot</literal>, <literal>static</literal>,
1427 <literal>ra</literal> and <literal>dhcp</literal>. Defaults to <literal>static</literal>.
c83ecc04
SS
1428 </para>
1429 </listitem>
1430 </varlistentry>
983226f3
SS
1431 <varlistentry>
1432 <term><varname>Type=</varname></term>
1433 <listitem>
94d6e299
YW
1434 <para>Specifies the type for the route. Takes one of <literal>unicast</literal>,
1435 <literal>local</literal>, <literal>broadcast</literal>, <literal>anycast</literal>,
1436 <literal>multicast</literal>, <literal>blackhole</literal>, <literal>unreachable</literal>,
1437 <literal>prohibit</literal>, <literal>throw</literal>, <literal>nat</literal>, and
1438 <literal>xresolve</literal>. If <literal>unicast</literal>, a regular route is defined, i.e. a
66d7235e
LP
1439 route indicating the path to take to a destination network address. If <literal>blackhole</literal>, packets
1440 to the defined route are discarded silently. If <literal>unreachable</literal>, packets to the defined route
1441 are discarded and the ICMP message "Host Unreachable" is generated. If <literal>prohibit</literal>, packets
1442 to the defined route are discarded and the ICMP message "Communication Administratively Prohibited" is
1443 generated. If <literal>throw</literal>, route lookup in the current routing table will fail and the route
1444 selection process will return to Routing Policy Database (RPDB). Defaults to <literal>unicast</literal>.
983226f3
SS
1445 </para>
1446 </listitem>
1447 </varlistentry>
323d9329
SS
1448 <varlistentry>
1449 <term><varname>InitialCongestionWindow=</varname></term>
1450 <listitem>
3cb7af5b
YW
1451 <para>The TCP initial congestion window is used during the start of a TCP connection.
1452 During the start of a TCP session, when a client requests a resource, the server's initial
1453 congestion window determines how many packets will be sent during the initial burst of data
1454 without waiting for acknowledgement. Takes a number between 1 and 1023. Note that 100 is
1455 considered an extremely large value for this option. When unset, the kernel's default
1456 (typically 10) will be used.</para>
323d9329
SS
1457 </listitem>
1458 </varlistentry>
1459 <varlistentry>
1460 <term><varname>InitialAdvertisedReceiveWindow=</varname></term>
1461 <listitem>
3cb7af5b
YW
1462 <para>The TCP initial advertised receive window is the amount of receive data (in bytes)
1463 that can initially be buffered at one time on a connection. The sending host can send only
1464 that amount of data before waiting for an acknowledgment and window update from the
1465 receiving host. Takes a number between 1 and 1023. Note that 100 is considered an extremely
1466 large value for this option. When unset, the kernel's default will be used.</para>
323d9329
SS
1467 </listitem>
1468 </varlistentry>
09f5dfad
SS
1469 <varlistentry>
1470 <term><varname>QuickAck=</varname></term>
1471 <listitem>
9b6ffef3 1472 <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
1473 </para>
1474 </listitem>
1475 </varlistentry>
633c7258
SS
1476 <varlistentry>
1477 <term><varname>FastOpenNoCookie=</varname></term>
1478 <listitem>
1479 <para>Takes a boolean. When true enables TCP fastopen without a cookie on a per-route basis.
1480 When unset, the kernel's default will be used.
1481 </para>
1482 </listitem>
09f5dfad 1483 </varlistentry>
9b88f20a
SS
1484 <varlistentry>
1485 <term><varname>TTLPropagate=</varname></term>
1486 <listitem>
1487 <para>Takes a boolean. When true enables TTL propagation at Label Switched Path (LSP) egress.
1488 When unset, the kernel's default will be used.
1489 </para>
1490 </listitem>
1491 </varlistentry>
cea79e66
SS
1492 <varlistentry>
1493 <term><varname>MTUBytes=</varname></term>
1494 <listitem>
1495 <para>The maximum transmission unit in bytes to set for the
1496 route. The usual suffixes K, M, G, are supported and are
1497 understood to the base of 1024.</para>
1498 <para>Note that if IPv6 is enabled on the interface, and the MTU is chosen
1499 below 1280 (the minimum MTU for IPv6) it will automatically be increased to this value.</para>
1500 </listitem>
afe42aef
SC
1501 </varlistentry>
1502 <varlistentry>
1503 <term><varname>IPServiceType=</varname></term>
1504 <listitem>
e681a2ee
YW
1505 <para>Takes string; <literal>CS6</literal> or <literal>CS4</literal>. Used to set IP
1506 service type to CS6 (network control) or CS4 (Realtime). Defaults to CS6.</para>
afe42aef
SC
1507 </listitem>
1508 </varlistentry>
007cac09
SS
1509 <varlistentry>
1510 <term><varname>TCPAdvertisedMaximumSegmentSize=</varname></term>
1511 <listitem>
1512 <para>Specifies the Path MSS (in bytes) hints given on TCP layer. The usual suffixes K, M, G, are
1513 supported and are understood to the base of 1024. An unsigned integer in the range 1–4294967294.
1514 When unset, the kernel's default will be used.</para>
1515 </listitem>
1516 </varlistentry>
6ff5cc6b
YW
1517 <varlistentry>
1518 <term><varname>MultiPathRoute=<replaceable>address</replaceable>[@<replaceable>name</replaceable>] [<replaceable>weight</replaceable>]</varname></term>
1519 <listitem>
1520 <para>Configures multipath route. Multipath routing is the technique of using multiple
1521 alternative paths through a network. Takes gateway address. Optionally, takes a network
1522 interface name or index separated with <literal>@</literal>, and a weight in 1..256 for
1523 this multipath route separated with whitespace. This setting can be specified multiple
1524 times. If an empty string is assigned, then the all previous assignments are cleared.</para>
1525 </listitem>
1526 </varlistentry>
798d3a52
ZJS
1527 </variablelist>
1528 </refsect1>
1529
1530 <refsect1>
4f7331a8 1531 <title>[DHCPv4] Section Options</title>
bdac5608 1532 <para>The [DHCPv4] section configures the DHCPv4 client, if it is enabled with the
ad943783 1533 <varname>DHCP=</varname> setting described above:</para>
798d3a52
ZJS
1534
1535 <variablelist class='network-directives'>
1536 <varlistentry>
1537 <term><varname>UseDNS=</varname></term>
1538 <listitem>
1539 <para>When true (the default), the DNS servers received
1540 from the DHCP server will be used and take precedence over
1541 any statically configured ones.</para>
e88d8021
ZJS
1542
1543 <para>This corresponds to the <option>nameserver</option>
ad943783
LP
1544 option in <citerefentry
1545 project='man-pages'><refentrytitle>resolv.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para>
798d3a52
ZJS
1546 </listitem>
1547 </varlistentry>
a24e12f0
YW
1548 <varlistentry>
1549 <term><varname>RoutesToDNS=</varname></term>
1550 <listitem>
1551 <para>When true, the routes to the DNS servers received from the DHCP server will be
1552 configured. When <varname>UseDNS=</varname> is disabled, this setting is ignored.
f7e7bb65 1553 Defaults to false.</para>
a24e12f0
YW
1554 </listitem>
1555 </varlistentry>
301f4073
MM
1556 <varlistentry>
1557 <term><varname>UseNTP=</varname></term>
1558 <listitem>
2a71d57f
LP
1559 <para>When true (the default), the NTP servers received from the DHCP server will be used by
1560 <filename>systemd-timesyncd.service</filename> and take precedence over any statically configured
1561 ones.</para>
301f4073
MM
1562 </listitem>
1563 </varlistentry>
299d578f
SS
1564 <varlistentry>
1565 <term><varname>UseSIP=</varname></term>
1566 <listitem>
2a71d57f
LP
1567 <para>When true (the default), the SIP servers received from the DHCP server will be collected
1568 and made available to client programs.</para>
299d578f
SS
1569 </listitem>
1570 </varlistentry>
284e8fd0 1571
798d3a52
ZJS
1572 <varlistentry>
1573 <term><varname>UseMTU=</varname></term>
1574 <listitem>
1575 <para>When true, the interface maximum transmission unit
1576 from the DHCP server will be used on the current link.
7169cdc8 1577 If <varname>MTUBytes=</varname> is set, then this setting is ignored.
95ab9eff 1578 Defaults to false.</para>
798d3a52
ZJS
1579 </listitem>
1580 </varlistentry>
7585baa0 1581 <varlistentry>
1582 <term><varname>Anonymize=</varname></term>
1583 <listitem>
9b6ffef3 1584 <para>Takes a boolean. When true, the options sent to the DHCP server will
7585baa0 1585 follow the <ulink url="https://tools.ietf.org/html/rfc7844">RFC 7844</ulink>
1586 (Anonymity Profiles for DHCP Clients) to minimize disclosure of identifying information.
1587 Defaults to false.</para>
1588
1589 <para>This option should only be set to true when
1590 <varname>MACAddressPolicy=</varname> is set to <literal>random</literal>
1591 (see <citerefentry
1592 project='man-pages'><refentrytitle>systemd.link</refentrytitle><manvolnum>5</manvolnum></citerefentry>).</para>
1593
1594 <para>Note that this configuration will overwrite others.
1595 In concrete, the following variables will be ignored:
1596 <varname>SendHostname=</varname>, <varname>ClientIdentifier=</varname>,
da2076a1
TK
1597 <varname>UseRoutes=</varname>, <varname>UseMTU=</varname>,
1598 <varname>VendorClassIdentifier=</varname>, <varname>UseTimezone=</varname>.</para>
fba10579
LP
1599
1600 <para>With this option enabled DHCP requests will mimic those generated by Microsoft Windows, in
1601 order to reduce the ability to fingerprint and recognize installations. This means DHCP request
1602 sizes will grow and lease data will be more comprehensive than normally, though most of the
1603 requested data is not actually used.</para>
7585baa0 1604 </listitem>
1605 </varlistentry>
798d3a52
ZJS
1606 <varlistentry>
1607 <term><varname>SendHostname=</varname></term>
1608 <listitem>
31ee3973
YW
1609 <para>When true (the default), the machine's hostname will be sent to the DHCP server.
1610 Note that the machine's hostname must consist only of 7-bit ASCII lower-case characters and
1611 no spaces or dots, and be formatted as a valid DNS domain name. Otherwise, the hostname is not
cad8d671 1612 sent even if this is set to true.</para>
798d3a52
ZJS
1613 </listitem>
1614 </varlistentry>
7b8d23a9
SS
1615
1616 <varlistentry>
1617 <term><varname>MUDURL=</varname></term>
1618 <listitem>
0558f303
ZJS
1619 <para>When configured, the specified Manufacturer Usage Description (MUD) URL will be sent to the
1620 DHCPv4 server. Takes a URL of length up to 255 characters. A superficial verification that the
1621 string is a valid URL will be performed. DHCPv4 clients are intended to have at most one MUD URL
1622 associated with them. See <ulink url="https://tools.ietf.org/html/rfc8520">RFC 8520</ulink>.
1623 </para>
1624
1625 <para>MUD is an embedded software standard defined by the IETF that allows IoT device makers to
1626 advertise device specifications, including the intended communication patterns for their device
1627 when it connects to the network. The network can then use this to author a context-specific
1628 access policy, so the device functions only within those parameters.</para>
7b8d23a9
SS
1629 </listitem>
1630 </varlistentry>
1631
798d3a52
ZJS
1632 <varlistentry>
1633 <term><varname>UseHostname=</varname></term>
1634 <listitem>
1635 <para>When true (the default), the hostname received from
31ee3973 1636 the DHCP server will be set as the transient hostname of the system.
d59be2cf 1637 </para>
798d3a52
ZJS
1638 </listitem>
1639 </varlistentry>
1adc5d0b 1640 <varlistentry>
31ee3973
YW
1641 <term><varname>Hostname=</varname></term>
1642 <listitem>
1643 <para>Use this value for the hostname which is sent to the DHCP server, instead of machine's hostname.
1644 Note that the specified hostname must consist only of 7-bit ASCII lower-case characters and
1645 no spaces or dots, and be formatted as a valid DNS domain name.</para>
1646 </listitem>
1647 </varlistentry>
798d3a52
ZJS
1648 <varlistentry>
1649 <term><varname>UseDomains=</varname></term>
1650 <listitem>
9b6ffef3 1651 <para>Takes a boolean, or the special value <literal>route</literal>. When true, the domain name
b2a81c0b
LP
1652 received from the DHCP server will be used as DNS search domain over this link, similar to the effect of
1653 the <option>Domains=</option> setting. If set to <literal>route</literal>, the domain name received from
1654 the DHCP server will be used for routing DNS queries only, but not for searching, similar to the effect of
1655 the <option>Domains=</option> setting when the argument is prefixed with <literal>~</literal>. Defaults to
1656 false.</para>
1657
1658 <para>It is recommended to enable this option only on trusted networks, as setting this affects resolution
38b38500 1659 of all hostnames, in particular of single-label names. It is generally safer to use the supplied domain
b2a81c0b
LP
1660 only as routing domain, rather than as search domain, in order to not have it affect local resolution of
1661 single-label names.</para>
1662
1663 <para>When set to true, this setting corresponds to the <option>domain</option> option in <citerefentry
1664 project='man-pages'><refentrytitle>resolv.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para>
798d3a52
ZJS
1665 </listitem>
1666 </varlistentry>
1667 <varlistentry>
1668 <term><varname>UseRoutes=</varname></term>
1669 <listitem>
d6eac9bd
DW
1670 <para>When true (the default), the static routes will be requested from the DHCP server and added to the
1671 routing table with a metric of 1024, and a scope of "global", "link" or "host", depending on the route's
1672 destination and gateway. If the destination is on the local host, e.g., 127.x.x.x, or the same as the
1673 link's own address, the scope will be set to "host". Otherwise if the gateway is null (a direct route), a
1674 "link" scope will be used. For anything else, scope defaults to "global".</para>
798d3a52
ZJS
1675 </listitem>
1676 </varlistentry>
b4531227
YW
1677 <varlistentry>
1678 <term><varname>UseGateway=</varname></term>
1679 <listitem>
589397a2
DS
1680 <para>When true, the gateway will be requested from the DHCP server and added to the routing table with a
1681 metric of 1024, and a scope of "link". When unset, the value specified with <option>UseRoutes=</option>
1682 is used.</para>
b4531227
YW
1683 </listitem>
1684 </varlistentry>
ad943783
LP
1685 <varlistentry>
1686 <term><varname>UseTimezone=</varname></term>
1687
1688 <listitem><para>When true, the timezone received from the
7f3fdb7f 1689 DHCP server will be set as timezone of the local
ad943783
LP
1690 system. Defaults to <literal>no</literal>.</para></listitem>
1691 </varlistentry>
1692
3e43b2cd
JJ
1693 <varlistentry>
1694 <term><varname>ClientIdentifier=</varname></term>
1695 <listitem>
dace710c
YW
1696 <para>The DHCPv4 client identifier to use. Takes one of <literal>mac</literal>, <literal>duid</literal> or <literal>duid-only</literal>.
1697 If set to <literal>mac</literal>, the MAC address of the link is used.
1698 If set to <literal>duid</literal>, an RFC4361-compliant Client ID, which is the combination of IAID and DUID (see below), is used.
1699 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.
1700 Defaults to <literal>duid</literal>.</para>
3e43b2cd
JJ
1701 </listitem>
1702 </varlistentry>
e2e08e77 1703
798d3a52
ZJS
1704 <varlistentry>
1705 <term><varname>VendorClassIdentifier=</varname></term>
1706 <listitem>
1707 <para>The vendor class identifier used to identify vendor
1708 type and configuration.</para>
1709 </listitem>
1710 </varlistentry>
076ea6f6 1711
af1c0de0
SS
1712 <varlistentry>
1713 <term><varname>UserClass=</varname></term>
1714 <listitem>
1715 <para>A DHCPv4 client can use UserClass option to identify the type or category of user or applications
1716 it represents. The information contained in this option is a string that represents the user class of which
1717 the client is a member. Each class sets an identifying string of information to be used by the DHCP
1718 service to classify clients. Takes a whitespace-separated list of strings.</para>
1719 </listitem>
1720 </varlistentry>
1721
715cedfb
SS
1722 <varlistentry>
1723 <term><varname>MaxAttempts=</varname></term>
1724 <listitem>
1725 <para>Specifies how many times the DHCPv4 client configuration should be attempted. Takes a
573b02f5
ZJS
1726 number or <literal>infinity</literal>. Defaults to <literal>infinity</literal>. Note that the
1727 time between retries is increased exponentially, up to approximately one per minute, so the
0107b769
ZJS
1728 network will not be overloaded even if this number is high. The default is suitable in most
1729 circumstances.</para>
715cedfb
SS
1730 </listitem>
1731 </varlistentry>
1732
e2e08e77
ZJS
1733 <varlistentry>
1734 <term><varname>DUIDType=</varname></term>
1735 <listitem>
1736 <para>Override the global <varname>DUIDType</varname> setting for this network. See
1737 <citerefentry><refentrytitle>networkd.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>
1738 for a description of possible values.</para>
1739 </listitem>
1740 </varlistentry>
076ea6f6 1741
e2e08e77
ZJS
1742 <varlistentry>
1743 <term><varname>DUIDRawData=</varname></term>
1744 <listitem>
1745 <para>Override the global <varname>DUIDRawData</varname> setting for this network. See
1746 <citerefentry><refentrytitle>networkd.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>
1747 for a description of possible values.</para>
076ea6f6
LP
1748 </listitem>
1749 </varlistentry>
e2e08e77 1750
d05def16
LP
1751 <varlistentry>
1752 <term><varname>IAID=</varname></term>
1753 <listitem>
1754 <para>The DHCP Identity Association Identifier (IAID) for the interface, a 32-bit unsigned integer.</para>
1755 </listitem>
1756 </varlistentry>
1757
798d3a52
ZJS
1758 <varlistentry>
1759 <term><varname>RequestBroadcast=</varname></term>
1760 <listitem>
1761 <para>Request the server to use broadcast messages before
1762 the IP address has been configured. This is necessary for
1763 devices that cannot receive RAW packets, or that cannot
1764 receive packets at all before an IP address has been
1765 configured. On the other hand, this must not be enabled on
1766 networks where broadcasts are filtered out.</para>
1767 </listitem>
1768 </varlistentry>
e2e08e77 1769
798d3a52
ZJS
1770 <varlistentry>
1771 <term><varname>RouteMetric=</varname></term>
1772 <listitem>
1bf1bfd9 1773 <para>Set the routing metric for routes specified by the DHCP server. Defaults to 1024.</para>
798d3a52
ZJS
1774 </listitem>
1775 </varlistentry>
f594276b
JK
1776
1777 <varlistentry>
1778 <term><varname>RouteTable=<replaceable>num</replaceable></varname></term>
1779 <listitem>
d11e656a 1780 <para>The table identifier for DHCP routes (a number between 1 and 4294967295, or 0 to unset).
f594276b
JK
1781 The table can be retrieved using <command>ip route show table <replaceable>num</replaceable></command>.
1782 </para>
e9dd6984
ZJS
1783 <para>When used in combination with <varname>VRF=</varname>, the
1784 VRF's routing table is used when this parameter is not specified.
917b2260 1785 </para>
f594276b
JK
1786 </listitem>
1787 </varlistentry>
9faed222 1788
c695dcf9
SS
1789 <varlistentry>
1790 <term><varname>RouteMTUBytes=</varname></term>
1791 <listitem>
1792 <para>Specifies the MTU for the DHCP routes. Please see the [Route] section for further details.</para>
1793 </listitem>
1794 </varlistentry>
1795
9faed222
SS
1796 <varlistentry>
1797 <term><varname>ListenPort=</varname></term>
1798 <listitem>
1799 <para>Allow setting custom port for the DHCP client to listen on.</para>
1800 </listitem>
1801 </varlistentry>
fb5c8216 1802
d6463307
SS
1803 <varlistentry>
1804 <term><varname>FallbackLeaseLifetimeSec=</varname></term>
1805 <listitem>
1806 <para>Allows to set DHCPv4 lease lifetime when DHCPv4 server does not send the lease lifetime.
1807 Takes one of <literal>forever</literal> or <literal>infinity</literal> means that the address
1808 never expires. Defaults to unset.</para>
1809 </listitem>
1810 </varlistentry>
1811
1501b429
SS
1812 <varlistentry>
1813 <term><varname>SendRelease=</varname></term>
1814 <listitem>
1815 <para>When true, the DHCPv4 client sends a DHCP release packet when it stops.
5f3b5f19 1816 Defaults to true.</para>
1501b429
SS
1817 </listitem>
1818 </varlistentry>
1819
0f3ff4ea
SS
1820 <varlistentry>
1821 <term><varname>SendDecline=</varname></term>
1822 <listitem>
e9dd6984
ZJS
1823 <para>A boolean. When <literal>true</literal>, the DHCPv4 client receives the IP address from the
1824 DHCP server. After a new IP is received, the DHCPv4 client performs IPv4 Duplicate Address
1825 Detection. If duplicate use is detected, the DHCPv4 client rejects the IP by sending a
1826 DHCPDECLINE packet and tries to obtain an IP address again. See <ulink
1827 url="https://tools.ietf.org/html/rfc5227">RFC 5224</ulink>. Defaults to
1828 <literal>unset</literal>.</para>
0f3ff4ea
SS
1829 </listitem>
1830 </varlistentry>
1831
caa8ca42 1832 <varlistentry>
6b000af4 1833 <term><varname>DenyList=</varname></term>
5bc945be 1834 <listitem>
98ebef62
SS
1835 <para>A whitespace-separated list of IPv4 addresses. DHCP offers from servers in the list are rejected. Note that
1836 if <varname>AllowList=</varname> is configured then <varname>DenyList=</varname> is ignored.</para>
1837 </listitem>
1838 </varlistentry>
1839
1840 <varlistentry>
1841 <term><varname>AllowList=</varname></term>
1842 <listitem>
1843 <para>A whitespace-separated list of IPv4 addresses. DHCP offers from servers in the list are accepted.</para>
5bc945be
SS
1844 </listitem>
1845 </varlistentry>
1846
1847 <varlistentry>
1848 <term><varname>RequestOptions=</varname></term>
caa8ca42 1849 <listitem>
35f6a5cb
SS
1850 <para>When configured, allows to set arbitrary request options in the DHCPv4 request options list and will be
1851 sent to the DHCPV4 server. A whitespace-separated list of integers in the range 1..254. Defaults to unset.</para>
caa8ca42
SS
1852 </listitem>
1853 </varlistentry>
1854
cb29c156 1855 <varlistentry>
864edb39 1856 <term><varname>SendOption=</varname></term>
cb29c156 1857 <listitem>
7354900d
DW
1858 <para>Send an arbitrary raw option in the DHCPv4 request. Takes a DHCP option number, data type
1859 and data separated with a colon
1860 (<literal><replaceable>option</replaceable>:<replaceable>type</replaceable>:<replaceable>value</replaceable></literal>).
1861 The option number must be an integer in the range 1..254. The type takes one of <literal>uint8</literal>,
1862 <literal>uint16</literal>, <literal>uint32</literal>, <literal>ipv4address</literal>, or
1863 <literal>string</literal>. Special characters in the data string may be escaped using
1864 <ulink url="https://en.wikipedia.org/wiki/Escape_sequences_in_C#Table_of_escape_sequences">C-style
1865 escapes</ulink>. This setting can be specified multiple times. If an empty string is specified,
1866 then all options specified earlier are cleared. Defaults to unset.</para>
1867 </listitem>
1868 </varlistentry>
1869
1870 <varlistentry>
1871 <term><varname>SendVendorOption=</varname></term>
1872 <listitem>
1873 <para>Send an arbitrary vendor option in the DHCPv4 request. Takes a DHCP option number, data type
d8b736bd
YW
1874 and data separated with a colon
1875 (<literal><replaceable>option</replaceable>:<replaceable>type</replaceable>:<replaceable>value</replaceable></literal>).
11fcfc53 1876 The option number must be an integer in the range 1..254. The type takes one of <literal>uint8</literal>,
d8b736bd
YW
1877 <literal>uint16</literal>, <literal>uint32</literal>, <literal>ipv4address</literal>, or
1878 <literal>string</literal>. Special characters in the data string may be escaped using
a2cc708a 1879 <ulink url="https://en.wikipedia.org/wiki/Escape_sequences_in_C#Table_of_escape_sequences">C-style
d8b736bd 1880 escapes</ulink>. This setting can be specified multiple times. If an empty string is specified,
a2cc708a 1881 then all options specified earlier are cleared. Defaults to unset.</para>
cb29c156
SS
1882 </listitem>
1883 </varlistentry>
caa8ca42
SS
1884 </variablelist>
1885 </refsect1>
1886
1887 <refsect1>
1888 <title>[DHCPv6] Section Options</title>
bdac5608 1889 <para>The [DHCPv6] section configures the DHCPv6 client, if it is enabled with the
4f7331a8 1890 <varname>DHCP=</varname> setting described above, or invoked by the IPv6 Router Advertisement:</para>
caa8ca42
SS
1891
1892 <variablelist class='network-directives'>
1536b7b2
YW
1893 <varlistentry>
1894 <term><varname>UseAddress=</varname></term>
1895 <listitem>
1896 <para>When true (the default), the IP addresses provided by the DHCPv6 server will be
1897 assigned.</para>
1898 </listitem>
1899 </varlistentry>
1900
caa8ca42
SS
1901 <varlistentry>
1902 <term><varname>UseDNS=</varname></term>
1903 <term><varname>UseNTP=</varname></term>
1904 <listitem>
bdac5608 1905 <para>As in the [DHCPv4] section.</para>
caa8ca42
SS
1906 </listitem>
1907 </varlistentry>
1908
1bf1bfd9
YW
1909 <varlistentry>
1910 <term><varname>RouteMetric=</varname></term>
1911 <listitem>
1912 <para>Set the routing metric for routes specified by the DHCP server. Defaults to 1024.</para>
1913 </listitem>
1914 </varlistentry>
1915
fb5c8216
SS
1916 <varlistentry>
1917 <term><varname>RapidCommit=</varname></term>
1918 <listitem>
9b6ffef3 1919 <para>Takes a boolean. The DHCPv6 client can obtain configuration parameters from a DHCPv6 server through
fb5c8216
SS
1920 a rapid two-message exchange (solicit and reply). When the rapid commit option is enabled by both
1921 the DHCPv6 client and the DHCPv6 server, the two-message exchange is used, rather than the default
e9dd6984 1922 four-message exchange (solicit, advertise, request, and reply). The two-message exchange provides
fb5c8216
SS
1923 faster client configuration and is beneficial in environments in which networks are under a heavy load.
1924 See <ulink url="https://tools.ietf.org/html/rfc3315#section-17.2.1">RFC 3315</ulink> for details.
1925 Defaults to true.</para>
1926 </listitem>
1927 </varlistentry>
1928
3175a8c2
SS
1929 <varlistentry>
1930 <term><varname>MUDURL=</varname></term>
1931 <listitem>
0558f303
ZJS
1932 <para>When configured, the specified Manufacturer Usage Description (MUD) URL will be sent to
1933 the DHCPV6 server. The syntax and semantics are the same as for <varname>MUDURL=</varname> in the
1934 [DHCPv4] section described above.</para>
3175a8c2
SS
1935 </listitem>
1936 </varlistentry>
1937
35f6a5cb
SS
1938 <varlistentry>
1939 <term><varname>RequestOptions=</varname></term>
1940 <listitem>
885a4e6c
ZJS
1941 <para>When configured, allows to set arbitrary request options in the DHCPv6 request options list
1942 that will be sent to the DHCPV6 server. A whitespace-separated list of integers in the range
1943 1..254. Defaults to unset.</para>
35f6a5cb
SS
1944 </listitem>
1945 </varlistentry>
1946
b4ccc5de
SS
1947 <varlistentry>
1948 <term><varname>SendVendorOption=</varname></term>
1949 <listitem>
e9dd6984
ZJS
1950 <para>Send an arbitrary vendor option in the DHCPv6 request. Takes an enterprise identifier, DHCP
1951 option number, data type, and data separated with a colon (<literal><replaceable>enterprise
1952 identifier</replaceable>:<replaceable>option</replaceable>:<replaceable>type</replaceable>:
1953 <replaceable>value</replaceable></literal>). Enterprise identifier is an unsigned integer in the
1954 range 1–4294967294. The option number must be an integer in the range 1–254. Data type takes one
1955 of <literal>uint8</literal>, <literal>uint16</literal>, <literal>uint32</literal>,
1956 <literal>ipv4address</literal>, <literal>ipv6address</literal>, or
1957 <literal>string</literal>. Special characters in the data string may be escaped using <ulink
1958 url="https://en.wikipedia.org/wiki/Escape_sequences_in_C#Table_of_escape_sequences">C-style
b4ccc5de
SS
1959 escapes</ulink>. This setting can be specified multiple times. If an empty string is specified,
1960 then all options specified earlier are cleared. Defaults to unset.</para>
1961 </listitem>
1962 </varlistentry>
1963
125f20b4
PF
1964 <varlistentry>
1965 <term><varname>ForceDHCPv6PDOtherInformation=</varname></term>
1966 <listitem>
9b6ffef3 1967 <para>Takes a boolean that enforces DHCPv6 stateful mode when the 'Other information' bit is set in
125f20b4
PF
1968 Router Advertisement messages. By default setting only the 'O' bit in Router Advertisements
1969 makes DHCPv6 request network information in a stateless manner using a two-message Information
1970 Request and Information Reply message exchange.
1971 <ulink url="https://tools.ietf.org/html/rfc7084">RFC 7084</ulink>, requirement WPD-4, updates
1972 this behavior for a Customer Edge router so that stateful DHCPv6 Prefix Delegation is also
1973 requested when only the 'O' bit is set in Router Advertisements. This option enables such a CE
1974 behavior as it is impossible to automatically distinguish the intention of the 'O' bit otherwise.
1975 By default this option is set to 'false', enable it if no prefixes are delegated when the device
1976 should be acting as a CE router.</para>
1977 </listitem>
1978 </varlistentry>
1979
2805536b
SS
1980 <varlistentry>
1981 <term><varname>PrefixDelegationHint=</varname></term>
1982 <listitem>
e9dd6984
ZJS
1983 <para>Takes an IPv6 address with prefix length in the same format as the
1984 <varname>Address=</varname> in the [Network] section. The DHCPv6 client will include a prefix
1985 hint in the DHCPv6 solicitation sent to the server. The prefix length must be in the range
1986 1–128. Defaults to unset.</para>
2805536b
SS
1987 </listitem>
1988 </varlistentry>
cd305af1
SS
1989
1990 <varlistentry>
1991 <term><varname>WithoutRA=</varname></term>
1992 <listitem>
e9dd6984
ZJS
1993 <para>Allows DHCPv6 client to start without router advertisements's managed or other address
1994 configuration flag. Takes one of <literal>solicit</literal> or
1995 <literal>information-request</literal>. Defaults to unset.</para>
cd305af1
SS
1996 </listitem>
1997 </varlistentry>
e7d5fe17
AD
1998
1999 <varlistentry>
2000 <term><varname>SendOption=</varname></term>
2001 <listitem>
bdac5608 2002 <para>As in the [DHCPv4] section, however because DHCPv6 uses 16-bit fields to store
e7d5fe17
AD
2003 option numbers, the option number is an integer in the range 1..65536.</para>
2004 </listitem>
2005 </varlistentry>
f37f2a6b
SS
2006
2007 <varlistentry>
2008 <term><varname>UserClass=</varname></term>
2009 <listitem>
2010 <para>A DHCPv6 client can use User Class option to identify the type or category of user or applications
2011 it represents. The information contained in this option is a string that represents the user class of which
2012 the client is a member. Each class sets an identifying string of information to be used by the DHCP
2013 service to classify clients. Special characters in the data string may be escaped using
2014 <ulink url="https://en.wikipedia.org/wiki/Escape_sequences_in_C#Table_of_escape_sequences">C-style
2015 escapes</ulink>. This setting can be specified multiple times. If an empty string is specified,
2016 then all options specified earlier are cleared. Takes a whitespace-separated list of strings. Note that
6b44ad0b 2017 currently <constant>NUL</constant> bytes are not allowed.</para>
f37f2a6b
SS
2018 </listitem>
2019 </varlistentry>
ed0d1b2e
SS
2020
2021 <varlistentry>
2022 <term><varname>VendorClass=</varname></term>
2023 <listitem>
2024 <para>A DHCPv6 client can use VendorClass option to identify the vendor that
2025 manufactured the hardware on which the client is running. The information
2026 contained in the data area of this option is contained in one or more opaque
2027 fields that identify details of the hardware configuration. Takes a
2028 whitespace-separated list of strings.</para>
2029 </listitem>
2030 </varlistentry>
ad943783 2031 </variablelist>
caa8ca42 2032 </refsect1>
99e015e2
YW
2033
2034 <refsect1>
2035 <title>[DHCPv6PrefixDelegation] Section Options</title>
e5ff2245
YW
2036 <para>The [DHCPv6PrefixDelegation] section configures delegated prefixes assigned by DHCPv6 server.
2037 The settings in this section are used only when <varname>DHCPv6PrefixDelegation=</varname> setting
2038 is enabled.</para>
99e015e2
YW
2039
2040 <variablelist class='network-directives'>
2041 <varlistentry>
2042 <term><varname>SubnetId=</varname></term>
2043 <listitem>
2044 <para>Configure a specific subnet ID on the interface from a (previously) received prefix
2045 delegation. You can either set "auto" (the default) or a specific subnet ID (as defined in
2046 <ulink url="https://tools.ietf.org/html/rfc4291#section-2.5.4">RFC 4291</ulink>, section
2047 2.5.4), in which case the allowed value is hexadecimal, from 0 to 0x7fffffffffffffff
e5ff2245
YW
2048 inclusive.</para>
2049 </listitem>
2050 </varlistentry>
2051
2052 <varlistentry>
2053 <term><varname>Announce=</varname></term>
2054 <listitem>
2055 <para>Takes a boolean. When enabled, and <varname>IPv6SendRA=</varname> in [Network] section
2056 is enabled, the delegated prefixes are distributed through the IPv6 Router Advertisement.
2057 Defaults to yes.</para>
99e015e2
YW
2058 </listitem>
2059 </varlistentry>
2060
2061 <varlistentry>
2062 <term><varname>Assign=</varname></term>
2063 <listitem>
2064 <para>Takes a boolean. Specifies whether to add an address from the delegated prefixes which
e5ff2245
YW
2065 are received from the WAN interface by the DHCPv6 Prefix Delegation. When true (on LAN
2066 interfce), the EUI-64 algorithm will be used by default to form an interface identifier from
2067 the delegated prefixes. See also <varname>Token=</varname> setting below. Defaults to yes.
2068 </para>
99e015e2
YW
2069 </listitem>
2070 </varlistentry>
2071
2072 <varlistentry>
2073 <term><varname>Token=</varname></term>
2074 <listitem>
e5ff2245
YW
2075 <para>Specifies an optional address generation mode for assigning an address in each
2076 delegated prefix. Takes an IPv6 address. When set, the lower bits of the supplied address is
2077 combined with the upper bits of each delegatad prefix received from the WAN interface by the
2078 DHCPv6 Prefix Delegation to form a complete address. When <varname>Assign=</varname> is
2079 disabled, this setting is ignored. When unset, the EUI-64 algorithm will be used to form
2080 addresses. Defaults to unset.</para>
99e015e2
YW
2081 </listitem>
2082 </varlistentry>
fec1b650
YW
2083
2084 <varlistentry>
2085 <term><varname>ManageTemporaryAddress=</varname></term>
2086 <listitem>
2087 <para>As in the [Address] section, but defaults to true.</para>
2088 </listitem>
2089 </varlistentry>
99e015e2
YW
2090 </variablelist>
2091 </refsect1>
413708d1 2092
1e7a0e21 2093 <refsect1>
f921f573 2094 <title>[IPv6AcceptRA] Section Options</title>
bdac5608
ZJS
2095 <para>The [IPv6AcceptRA] section configures the IPv6 Router Advertisement (RA) client, if it is enabled
2096 with the <varname>IPv6AcceptRA=</varname> setting described above:</para>
1e7a0e21
LP
2097
2098 <variablelist class='network-directives'>
2099 <varlistentry>
2100 <term><varname>UseDNS=</varname></term>
2101 <listitem>
2102 <para>When true (the default), the DNS servers received in the Router Advertisement will be used and take
2103 precedence over any statically configured ones.</para>
2104
2105 <para>This corresponds to the <option>nameserver</option> option in <citerefentry
2106 project='man-pages'><refentrytitle>resolv.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para>
2107 </listitem>
2108 </varlistentry>
2109
2110 <varlistentry>
2111 <term><varname>UseDomains=</varname></term>
2112 <listitem>
9b6ffef3 2113 <para>Takes a boolean, or the special value <literal>route</literal>. When true, the domain name
1e7a0e21
LP
2114 received via IPv6 Router Advertisement (RA) will be used as DNS search domain over this link, similar to
2115 the effect of the <option>Domains=</option> setting. If set to <literal>route</literal>, the domain name
2116 received via IPv6 RA will be used for routing DNS queries only, but not for searching, similar to the
2117 effect of the <option>Domains=</option> setting when the argument is prefixed with
2118 <literal>~</literal>. Defaults to false.</para>
2119
2120 <para>It is recommended to enable this option only on trusted networks, as setting this affects resolution
38b38500 2121 of all hostnames, in particular of single-label names. It is generally safer to use the supplied domain
1e7a0e21
LP
2122 only as routing domain, rather than as search domain, in order to not have it affect local resolution of
2123 single-label names.</para>
2124
2125 <para>When set to true, this setting corresponds to the <option>domain</option> option in <citerefentry
2126 project='man-pages'><refentrytitle>resolv.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para>
2127 </listitem>
2128 </varlistentry>
2ba31d29
JK
2129
2130 <varlistentry>
2131 <term><varname>RouteTable=<replaceable>num</replaceable></varname></term>
2132 <listitem>
d11e656a
ZJS
2133 <para>The table identifier for the routes received in the Router Advertisement
2134 (a number between 1 and 4294967295, or 0 to unset).
2ba31d29
JK
2135 The table can be retrieved using <command>ip route show table <replaceable>num</replaceable></command>.
2136 </para>
2137 </listitem>
2138 </varlistentry>
062c2eea
SS
2139
2140 <varlistentry>
2141 <term><varname>UseAutonomousPrefix=</varname></term>
2142 <listitem>
2143 <para>When true (the default), the autonomous prefix received in the Router Advertisement will be used and take
2144 precedence over any statically configured ones.</para>
2145 </listitem>
2146 </varlistentry>
2147
2148 <varlistentry>
2149 <term><varname>UseOnLinkPrefix=</varname></term>
2150 <listitem>
885a4e6c
ZJS
2151 <para>When true (the default), the onlink prefix received in the Router Advertisement will be
2152 used and takes precedence over any statically configured ones.</para>
062c2eea
SS
2153 </listitem>
2154 </varlistentry>
2155
75d26411
YW
2156 <varlistentry>
2157 <term><varname>RouterDenyList=</varname></term>
2158 <listitem>
2159 <para>A whitespace-separated list of IPv6 router addresses. Any information advertised by
2160 the listed router is ignored.</para>
2161 </listitem>
2162 </varlistentry>
2163
2164 <varlistentry>
2165 <term><varname>RouterAllowList=</varname></term>
2166 <listitem>
2167 <para>A whitespace-separated list of IPv6 router addresses. Only information advertised by
2168 the listed router is accepted. Note that if <varname>RouterAllowList=</varname> is
2169 configured then <varname>RouterDenyList=</varname> is ignored.</para>
2170 </listitem>
2171 </varlistentry>
2172
e520ce64 2173 <varlistentry>
3f0af4a5 2174 <term><varname>PrefixDenyList=</varname></term>
e520ce64 2175 <listitem>
16c89e64
DP
2176 <para>A whitespace-separated list of IPv6 prefixes. IPv6 prefixes supplied via router
2177 advertisements in the list are ignored.</para>
2178 </listitem>
2179 </varlistentry>
2180
de6b6ff8
SS
2181 <varlistentry>
2182 <term><varname>PrefixAllowList=</varname></term>
2183 <listitem>
2184 <para>A whitespace-separated list of IPv6 prefixes. IPv6 prefixes supplied via router
2185 advertisements in the list are allowed. Note that if <varname>PrefixAllowList=</varname> is
2186 configured then <varname>PrefixDenyList=</varname> is ignored.</para>
2187 </listitem>
2188 </varlistentry>
2189
16c89e64
DP
2190 <varlistentry>
2191 <term><varname>RouteDenyList=</varname></term>
2192 <listitem>
2193 <para>A whitespace-separated list of IPv6 route prefixes. IPv6 route prefixes supplied via
2194 router advertisements in the list are ignored.</para>
e520ce64
SS
2195 </listitem>
2196 </varlistentry>
2197
de6b6ff8
SS
2198 <varlistentry>
2199 <term><varname>RouteAllowList=</varname></term>
2200 <listitem>
2201 <para>A whitespace-separated list of IPv6 route prefixes. IPv6 route prefixes supplied via
2202 router advertisements in the list are allowed. Note that if <varname>RouteAllowList=</varname> is
2203 configured then <varname>RouteDenyList=</varname> is ignored.</para>
2204 </listitem>
2205 </varlistentry>
2206
d739fdde
YW
2207 <varlistentry>
2208 <term><varname>DHCPv6Client=</varname></term>
2209 <listitem>
0e686fea
YW
2210 <para>Takes a boolean, or the special value <literal>always</literal>. When true or
2211 <literal>always</literal>, the DHCPv6 client will be started when the RA has the managed or
2212 other information flag. If set to <literal>always</literal>, the DHCPv6 client will also be
2213 started in managed mode when neither managed nor other information flag is set in the RA.
2214 Defaults to true.</para>
d739fdde
YW
2215 </listitem>
2216 </varlistentry>
1e7a0e21
LP
2217 </variablelist>
2218 </refsect1>
2219
ad943783
LP
2220 <refsect1>
2221 <title>[DHCPServer] Section Options</title>
bdac5608 2222 <para>The [DHCPServer] section contains settings for the DHCP server, if enabled via the
ad943783
LP
2223 <varname>DHCPServer=</varname> option described above:</para>
2224
2225 <variablelist class='network-directives'>
2226
9b3a67c5
TG
2227 <varlistentry>
2228 <term><varname>PoolOffset=</varname></term>
2229 <term><varname>PoolSize=</varname></term>
2230
2231 <listitem><para>Configures the pool of addresses to hand out. The pool
2232 is a contiguous sequence of IP addresses in the subnet configured for
2233 the server address, which does not include the subnet nor the broadcast
2234 address. <varname>PoolOffset=</varname> takes the offset of the pool
2235 from the start of subnet, or zero to use the default value.
2236 <varname>PoolSize=</varname> takes the number of IP addresses in the
b938cb90 2237 pool or zero to use the default value. By default, the pool starts at
9b3a67c5
TG
2238 the first address after the subnet address and takes up the rest of
2239 the subnet, excluding the broadcast address. If the pool includes
2240 the server address (the default), this is reserved and not handed
2241 out to clients.</para></listitem>
2242 </varlistentry>
2243
ad943783
LP
2244 <varlistentry>
2245 <term><varname>DefaultLeaseTimeSec=</varname></term>
2246 <term><varname>MaxLeaseTimeSec=</varname></term>
2247
2248 <listitem><para>Control the default and maximum DHCP lease
2249 time to pass to clients. These settings take time values in seconds or
2250 another common time unit, depending on the suffix. The default
2251 lease time is used for clients that did not ask for a specific
2252 lease time. If a client asks for a lease time longer than the
b938cb90 2253 maximum lease time, it is automatically shortened to the
ad943783
LP
2254 specified time. The default lease time defaults to 1h, the
2255 maximum lease time to 12h. Shorter lease times are beneficial
2256 if the configuration data in DHCP leases changes frequently
2257 and clients shall learn the new settings with shorter
2258 latencies. Longer lease times reduce the generated DHCP
2259 network traffic.</para></listitem>
2260 </varlistentry>
2261
2262 <varlistentry>
2263 <term><varname>EmitDNS=</varname></term>
2264 <term><varname>DNS=</varname></term>
2265
2a71d57f
LP
2266 <listitem><para><varname>EmitDNS=</varname> takes a boolean. Configures whether the DHCP leases
2267 handed out to clients shall contain DNS server information. Defaults to <literal>yes</literal>. The
2268 DNS servers to pass to clients may be configured with the <varname>DNS=</varname> option, which takes
2269 a list of IPv4 addresses. If the <varname>EmitDNS=</varname> option is enabled but no servers
2270 configured, the servers are automatically propagated from an "uplink" interface that has appropriate
2271 servers set. The "uplink" interface is determined by the default route of the system with the highest
2272 priority. Note that this information is acquired at the time the lease is handed out, and does not
2273 take uplink interfaces into account that acquire DNS server information at a later point. If no
2274 suitable uplinkg interface is found the DNS server data from <filename>/etc/resolv.conf</filename> is
2275 used. Also, note that the leases are not refreshed if the uplink network configuration changes. To
2276 ensure clients regularly acquire the most current uplink DNS server information, it is thus advisable
2277 to shorten the DHCP lease time via <varname>MaxLeaseTimeSec=</varname> described
ad943783
LP
2278 above.</para></listitem>
2279 </varlistentry>
2280
2281 <varlistentry>
2282 <term><varname>EmitNTP=</varname></term>
2283 <term><varname>NTP=</varname></term>
299d578f
SS
2284 <term><varname>EmitSIP=</varname></term>
2285 <term><varname>SIP=</varname></term>
2a71d57f
LP
2286 <term><varname>EmitPOP3=</varname></term>
2287 <term><varname>POP3=</varname></term>
2288 <term><varname>EmitSMTP=</varname></term>
2289 <term><varname>SMTP=</varname></term>
2290 <term><varname>EmitLPR=</varname></term>
2291 <term><varname>LPR=</varname></term>
2292
2293 <listitem><para>Similar to the <varname>EmitDNS=</varname> and <varname>DNS=</varname> settings
2294 described above, these settings configure whether and what server information for the indicate
2295 protocol shall be emitted as part of the DHCP lease. The same syntax, propagation semantics and
2296 defaults apply as for <varname>EmitDNS=</varname> and <varname>DNS=</varname>.</para></listitem>
284e8fd0
SS
2297 </varlistentry>
2298
77ff6022
CG
2299 <varlistentry>
2300 <term><varname>EmitRouter=</varname></term>
2301
2302 <listitem><para>Similar to the <varname>EmitDNS=</varname>
2303 setting described above, this setting configures whether the
2304 DHCP lease should contain the router option. The same syntax,
2305 propagation semantics and defaults apply as for
2306 <varname>EmitDNS=</varname>.</para></listitem>
2307 </varlistentry>
2308
ad943783
LP
2309 <varlistentry>
2310 <term><varname>EmitTimezone=</varname></term>
2311 <term><varname>Timezone=</varname></term>
2312
9b6ffef3
YW
2313 <listitem><para>Takes a boolean. Configures whether the DHCP leases handed out
2314 to clients shall contain timezone information. Defaults to <literal>yes</literal>. The
ad943783
LP
2315 <varname>Timezone=</varname> setting takes a timezone string
2316 (such as <literal>Europe/Berlin</literal> or
2317 <literal>UTC</literal>) to pass to clients. If no explicit
b938cb90 2318 timezone is set, the system timezone of the local host is
ad943783
LP
2319 propagated, as determined by the
2320 <filename>/etc/localtime</filename> symlink.</para></listitem>
2321 </varlistentry>
2322
564ca984 2323 <varlistentry>
d8b736bd
YW
2324 <term><varname>SendOption=</varname></term>
2325 <listitem>
2326 <para>Send a raw option with value via DHCPv4 server. Takes a DHCP option number, data type
2327 and data (<literal><replaceable>option</replaceable>:<replaceable>type</replaceable>:<replaceable>value</replaceable></literal>).
2328 The option number is an integer in the range 1..254. The type takes one of <literal>uint8</literal>,
e7d5fe17 2329 <literal>uint16</literal>, <literal>uint32</literal>, <literal>ipv4address</literal>, <literal>ipv6address</literal>, or
7354900d
DW
2330 <literal>string</literal>. Special characters in the data string may be escaped using
2331 <ulink url="https://en.wikipedia.org/wiki/Escape_sequences_in_C#Table_of_escape_sequences">C-style
2332 escapes</ulink>. This setting can be specified multiple times. If an empty string is specified,
2333 then all options specified earlier are cleared. Defaults to unset.</para>
2334 </listitem>
2335 </varlistentry>
2336
2337 <varlistentry>
2338 <term><varname>SendVendorOption=</varname></term>
2339 <listitem>
2340 <para>Send a vendor option with value via DHCPv4 server. Takes a DHCP option number, data type
2341 and data (<literal><replaceable>option</replaceable>:<replaceable>type</replaceable>:<replaceable>value</replaceable></literal>).
2342 The option number is an integer in the range 1..254. The type takes one of <literal>uint8</literal>,
d8b736bd
YW
2343 <literal>uint16</literal>, <literal>uint32</literal>, <literal>ipv4address</literal>, or
2344 <literal>string</literal>. Special characters in the data string may be escaped using
2345 <ulink url="https://en.wikipedia.org/wiki/Escape_sequences_in_C#Table_of_escape_sequences">C-style
2346 escapes</ulink>. This setting can be specified multiple times. If an empty string is specified,
2347 then all options specified earlier are cleared. Defaults to unset.</para>
2348 </listitem>
564ca984
SS
2349 </varlistentry>
2350
ad943783
LP
2351 </variablelist>
2352 </refsect1>
2353
798d3a52 2354 <refsect1>
e5ff2245
YW
2355 <title>[IPv6SendRA] Section Options</title>
2356 <para>The [IPv6SendRA] section contains settings for sending IPv6 Router Advertisements and whether
2357 to act as a router, if enabled via the <varname>IPv6SendRA=</varname> option described above. IPv6
2358 network prefixes or routes are defined with one or more [IPv6Prefix] or [IPv6RoutePrefix] sections.
2359 </para>
3f9e0236
PF
2360
2361 <variablelist class='network-directives'>
2362
2363 <varlistentry>
2364 <term><varname>Managed=</varname></term>
2365 <term><varname>OtherInformation=</varname></term>
2366
9b6ffef3
YW
2367 <listitem><para>Takes a boolean. Controls whether a DHCPv6 server is used to acquire IPv6
2368 addresses on the network link when <varname>Managed=</varname>
3f9e0236
PF
2369 is set to <literal>true</literal> or if only additional network
2370 information can be obtained via DHCPv6 for the network link when
9b6ffef3 2371 <varname>OtherInformation=</varname> is set to
3f9e0236
PF
2372 <literal>true</literal>. Both settings default to
2373 <literal>false</literal>, which means that a DHCPv6 server is not being
2374 used.</para></listitem>
2375 </varlistentry>
2376
2377 <varlistentry>
2378 <term><varname>RouterLifetimeSec=</varname></term>
2379
71a5db49
YW
2380 <listitem><para>Takes a timespan. Configures the IPv6 router lifetime in seconds. When set to
2381 0, the host is not acting as a router. Defaults to 30 minutes.</para>
3f9e0236
PF
2382 </listitem>
2383 </varlistentry>
2384
2385 <varlistentry>
2386 <term><varname>RouterPreference=</varname></term>
2387
2388 <listitem><para>Configures IPv6 router preference if
2389 <varname>RouterLifetimeSec=</varname> is non-zero. Valid values are
2390 <literal>high</literal>, <literal>medium</literal> and
2391 <literal>low</literal>, with <literal>normal</literal> and
2392 <literal>default</literal> added as synonyms for
2393 <literal>medium</literal> just to make configuration easier. See
2394 <ulink url="https://tools.ietf.org/html/rfc4191">RFC 4191</ulink>
2395 for details. Defaults to <literal>medium</literal>.</para></listitem>
2396 </varlistentry>
2397
2398 <varlistentry>
4cb8478c 2399 <term><varname>EmitDNS=</varname></term>
3f9e0236
PF
2400 <term><varname>DNS=</varname></term>
2401
bdac5608
ZJS
2402 <listitem><para><varname>DNS=</varname> specifies a list of recursive DNS server IPv6 addresses that
2403 are distributed via Router Advertisement messages when <varname>EmitDNS=</varname> is
2404 true. <varname>DNS=</varname> also takes special value <literal>_link_local</literal>; in that case
2405 the IPv6 link local address is distributed. If <varname>DNS=</varname> is empty, DNS servers are read
2406 from the [Network] section. If the [Network] section does not contain any DNS servers either, DNS
2407 servers from the uplink with the highest priority default route are used. When
2408 <varname>EmitDNS=</varname> is false, no DNS server information is sent in Router Advertisement
2409 messages. <varname>EmitDNS=</varname> defaults to true.</para></listitem>
3f9e0236
PF
2410 </varlistentry>
2411
760021c0 2412 <varlistentry>
4cb8478c 2413 <term><varname>EmitDomains=</varname></term>
760021c0
PF
2414 <term><varname>Domains=</varname></term>
2415
bdac5608
ZJS
2416 <listitem><para>A list of DNS search domains distributed via Router Advertisement messages when
2417 <varname>EmitDomains=</varname> is true. If <varname>Domains=</varname> is empty, DNS search domains
2418 are read from the [Network] section. If the [Network] section does not contain any DNS search domains
2419 either, DNS search domains from the uplink with the highest priority default route are used. When
2420 <varname>EmitDomains=</varname> is false, no DNS search domain information is sent in Router
2421 Advertisement messages. <varname>EmitDomains=</varname> defaults to true.</para></listitem>
760021c0
PF
2422 </varlistentry>
2423
3f9e0236
PF
2424 <varlistentry>
2425 <term><varname>DNSLifetimeSec=</varname></term>
2426
2427 <listitem><para>Lifetime in seconds for the DNS server addresses listed
760021c0
PF
2428 in <varname>DNS=</varname> and search domains listed in
2429 <varname>Domains=</varname>.</para></listitem>
3f9e0236
PF
2430 </varlistentry>
2431
2432 </variablelist>
2433 </refsect1>
2434
203d4df5 2435 <refsect1>
3f9e0236 2436 <title>[IPv6Prefix] Section Options</title>
e9dd6984
ZJS
2437 <para>One or more [IPv6Prefix] sections contain the IPv6 prefixes that are announced via Router
2438 Advertisements. See <ulink url="https://tools.ietf.org/html/rfc4861">RFC 4861</ulink> for further
2439 details.</para>
3f9e0236
PF
2440
2441 <variablelist class='network-directives'>
2442
2443 <varlistentry>
2444 <term><varname>AddressAutoconfiguration=</varname></term>
2445 <term><varname>OnLink=</varname></term>
2446
9b6ffef3 2447 <listitem><para>Takes a boolean to specify whether IPv6 addresses can be
3f9e0236
PF
2448 autoconfigured with this prefix and whether the prefix can be used for
2449 onlink determination. Both settings default to <literal>true</literal>
2450 in order to ease configuration.
2451 </para></listitem>
2452 </varlistentry>
2453
2454 <varlistentry>
2455 <term><varname>Prefix=</varname></term>
2456
bdac5608
ZJS
2457 <listitem><para>The IPv6 prefix that is to be distributed to hosts. Similarly to configuring static
2458 IPv6 addresses, the setting is configured as an IPv6 prefix and its prefix length, separated by a
2459 <literal>/</literal> character. Use multiple [IPv6Prefix] sections to configure multiple IPv6
2460 prefixes since prefix lifetimes, address autoconfiguration and onlink status may differ from one
2461 prefix to another.</para></listitem>
3f9e0236
PF
2462 </varlistentry>
2463
2464 <varlistentry>
2465 <term><varname>PreferredLifetimeSec=</varname></term>
2466 <term><varname>ValidLifetimeSec=</varname></term>
2467
2468 <listitem><para>Preferred and valid lifetimes for the prefix measured in
2469 seconds. <varname>PreferredLifetimeSec=</varname> defaults to 604800
2470 seconds (one week) and <varname>ValidLifetimeSec=</varname> defaults
2471 to 2592000 seconds (30 days).</para></listitem>
203d4df5
SS
2472 </varlistentry>
2473
bd6379ec
SS
2474 <varlistentry>
2475 <term><varname>Assign=</varname></term>
2476 <listitem><para>Takes a boolean. When true, adds an address from the prefix. Default to false.
2477 </para></listitem>
2478 </varlistentry>
203d4df5
SS
2479 </variablelist>
2480 </refsect1>
2481
2482 <refsect1>
2483 <title>[IPv6RoutePrefix] Section Options</title>
bdac5608 2484 <para>One or more [IPv6RoutePrefix] sections contain the IPv6
203d4df5
SS
2485 prefix routes that are announced via Router Advertisements. See
2486 <ulink url="https://tools.ietf.org/html/rfc4191">RFC 4191</ulink>
2487 for further details.</para>
2488
2489 <variablelist class='network-directives'>
2490
2491 <varlistentry>
2492 <term><varname>Route=</varname></term>
2493
bdac5608
ZJS
2494 <listitem><para>The IPv6 route that is to be distributed to hosts. Similarly to configuring static
2495 IPv6 routes, the setting is configured as an IPv6 prefix routes and its prefix route length,
2496 separated by a <literal>/</literal> character. Use multiple [IPv6PrefixRoutes] sections to configure
2497 multiple IPv6 prefix routes.</para></listitem>
203d4df5
SS
2498 </varlistentry>
2499
2500 <varlistentry>
2501 <term><varname>LifetimeSec=</varname></term>
2502
2503 <listitem><para>Lifetime for the route prefix measured in
2504 seconds. <varname>LifetimeSec=</varname> defaults to 604800 seconds (one week).
2505 </para></listitem>
3f9e0236
PF
2506 </varlistentry>
2507
2508 </variablelist>
2509 </refsect1>
2510
2511 <refsect1>
798d3a52 2512 <title>[Bridge] Section Options</title>
bdac5608 2513 <para>The [Bridge] section accepts the following keys:</para>
798d3a52 2514 <variablelist class='network-directives'>
165c41a9
SS
2515 <varlistentry>
2516 <term><varname>UnicastFlood=</varname></term>
2517 <listitem>
9b6ffef3 2518 <para>Takes a boolean. Controls whether the bridge should flood
072f9e4a 2519 traffic for which an FDB entry is missing and the destination
025314d9 2520 is unknown through this port. When unset, the kernel's default will be used.
47c7dfe2 2521 </para>
165c41a9
SS
2522 </listitem>
2523 </varlistentry>
7f15b714
TJ
2524 <varlistentry>
2525 <term><varname>MulticastFlood=</varname></term>
2526 <listitem>
2527 <para>Takes a boolean. Controls whether the bridge should flood
2528 traffic for which an MDB entry is missing and the destination
2529 is unknown through this port. When unset, the kernel's default will be used.
2530 </para>
2531 </listitem>
2532 </varlistentry>
d3aa8b49
SS
2533 <varlistentry>
2534 <term><varname>MulticastToUnicast=</varname></term>
2535 <listitem>
2536 <para>Takes a boolean. Multicast to unicast works on top of the multicast snooping feature of
2537 the bridge. Which means unicast copies are only delivered to hosts which are interested in it.
2538 When unset, the kernel's default will be used.
2539 </para>
2540 </listitem>
2541 </varlistentry>
7f15b714
TJ
2542 <varlistentry>
2543 <term><varname>NeighborSuppression=</varname></term>
2544 <listitem>
2545 <para>Takes a boolean. Configures whether ARP and ND neighbor suppression is enabled for
2546 this port. When unset, the kernel's default will be used.
2547 </para>
2548 </listitem>
2549 </varlistentry>
2550 <varlistentry>
2551 <term><varname>Learning=</varname></term>
2552 <listitem>
2553 <para>Takes a boolean. Configures whether MAC address learning is enabled for
2554 this port. When unset, the kernel's default will be used.
2555 </para>
2556 </listitem>
2557 </varlistentry>
165c41a9
SS
2558 <varlistentry>
2559 <term><varname>HairPin=</varname></term>
2560 <listitem>
e9dd6984
ZJS
2561 <para>Takes a boolean. Configures whether traffic may be sent back out of the port on which it
2562 was received. When this flag is false, then the bridge will not forward traffic back out of the
2563 receiving port. When unset, the kernel's default will be used.</para>
165c41a9
SS
2564 </listitem>
2565 </varlistentry>
2566 <varlistentry>
84c34096 2567 <term><varname>UseBPDU=</varname></term>
165c41a9 2568 <listitem>
9b6ffef3 2569 <para>Takes a boolean. Configures whether STP Bridge Protocol Data Units will be
025314d9 2570 processed by the bridge port. When unset, the kernel's default will be used.</para>
165c41a9
SS
2571 </listitem>
2572 </varlistentry>
2573 <varlistentry>
2574 <term><varname>FastLeave=</varname></term>
2575 <listitem>
9b6ffef3 2576 <para>Takes a boolean. This flag allows the bridge to immediately stop multicast
a8eaaee7 2577 traffic on a port that receives an IGMP Leave message. It is only used with
025314d9 2578 IGMP snooping if enabled on the bridge. When unset, the kernel's default will be used.</para>
165c41a9
SS
2579 </listitem>
2580 </varlistentry>
2581 <varlistentry>
23da66bb 2582 <term><varname>AllowPortToBeRoot=</varname></term>
165c41a9 2583 <listitem>
9b6ffef3 2584 <para>Takes a boolean. Configures whether a given port is allowed to
47c7dfe2 2585 become a root port. Only used when STP is enabled on the bridge.
025314d9 2586 When unset, the kernel's default will be used.</para>
165c41a9
SS
2587 </listitem>
2588 </varlistentry>
1087623b
SS
2589 <varlistentry>
2590 <term><varname>ProxyARP=</varname></term>
2591 <listitem>
2592 <para>Takes a boolean. Configures whether proxy ARP to be enabled on this port.
2593 When unset, the kernel's default will be used.</para>
2594 </listitem>
2595 </varlistentry>
2596 <varlistentry>
2597 <term><varname>ProxyARPWiFi=</varname></term>
2598 <listitem>
2599 <para>Takes a boolean. Configures whether proxy ARP to be enabled on this port
2600 which meets extended requirements by IEEE 802.11 and Hotspot 2.0 specifications.
2601 When unset, the kernel's default will be used.</para>
2602 </listitem>
2603 </varlistentry>
0fadb2a4
SS
2604 <varlistentry>
2605 <term><varname>MulticastRouter=</varname></term>
2606 <listitem>
2607 <para>Configures this port for having multicast routers attached. A port with a multicast
2608 router will receive all multicast traffic. Takes one of <literal>no</literal>
2609 to disable multicast routers on this port, <literal>query</literal> to let the system detect
2610 the presence of routers, <literal>permanent</literal> to permanently enable multicast traffic
2611 forwarding on this port, or <literal>temporary</literal> to enable multicast routers temporarily
2612 on this port, not depending on incoming queries. When unset, the kernel's default will be used.</para>
2613 </listitem>
2614 </varlistentry>
798d3a52
ZJS
2615 <varlistentry>
2616 <term><varname>Cost=</varname></term>
2617 <listitem>
47c7dfe2 2618 <para>Sets the "cost" of sending packets of this interface.
a8eaaee7 2619 Each port in a bridge may have a different speed and the cost
798d3a52 2620 is used to decide which link to use. Faster interfaces
785889e5 2621 should have lower costs. It is an integer value between 1 and
b56be296
DJL
2622 65535.</para>
2623 </listitem>
2624 </varlistentry>
2625 <varlistentry>
2626 <term><varname>Priority=</varname></term>
2627 <listitem>
2628 <para>Sets the "priority" of sending packets on this interface.
2629 Each port in a bridge may have a different priority which is used
2630 to decide which link to use. Lower value means higher priority.
785889e5 2631 It is an integer value between 0 to 63. Networkd does not set any
b56be296 2632 default, meaning the kernel default value of 32 is used.</para>
798d3a52
ZJS
2633 </listitem>
2634 </varlistentry>
2635 </variablelist>
2636 </refsect1>
798d3a52
ZJS
2637 <refsect1>
2638 <title>[BridgeFDB] Section Options</title>
bdac5608
ZJS
2639 <para>The [BridgeFDB] section manages the forwarding database table of a port and accepts the following
2640 keys. Specify several [BridgeFDB] sections to configure several static MAC table entries.</para>
798d3a52
ZJS
2641
2642 <variablelist class='network-directives'>
2643 <varlistentry>
2644 <term><varname>MACAddress=</varname></term>
2645 <listitem>
bdac5608 2646 <para>As in the [Network] section. This key is mandatory.</para>
798d3a52
ZJS
2647 </listitem>
2648 </varlistentry>
c2c2793f
SS
2649 <varlistentry>
2650 <term><varname>Destination=</varname></term>
2651 <listitem>
2652 <para>Takes an IP address of the destination VXLAN tunnel endpoint.</para>
2653 </listitem>
2654 </varlistentry>
798d3a52
ZJS
2655 <varlistentry>
2656 <term><varname>VLANId=</varname></term>
2657 <listitem>
a8eaaee7 2658 <para>The VLAN ID for the new static MAC table entry. If
db9b9fb9 2659 omitted, no VLAN ID information is appended to the new static MAC
798d3a52
ZJS
2660 table entry.</para>
2661 </listitem>
2662 </varlistentry>
61b824c5
SS
2663 <varlistentry>
2664 <term><varname>VNI=</varname></term>
2665 <listitem>
2666 <para>The VXLAN Network Identifier (or VXLAN Segment ID) to use to connect to
2667 the remote VXLAN tunnel endpoint. Takes a number in the range 1-16777215.
2668 Defaults to unset.</para>
2669 </listitem>
2670 </varlistentry>
bdb397ed
SS
2671 <varlistentry>
2672 <term><varname>AssociatedWith=</varname></term>
2673 <listitem>
2674 <para>Specifies where the address is associated with. Takes one of <literal>use</literal>,
2675 <literal>self</literal>, <literal>master</literal> or <literal>router</literal>.
2676 <literal>use</literal> means the address is in use. User space can use this option to
2677 indicate to the kernel that the fdb entry is in use. <literal>self</literal> means
2678 the address is associated with the port drivers fdb. Usually hardware. <literal>master</literal>
2679 means the address is associated with master devices fdb. <literal>router</literal> means
2680 the destination address is associated with a router. Note that it's valid if the referenced
2681 device is a VXLAN type device and has route shortcircuit enabled. Defaults to <literal>self</literal>.</para>
2682 </listitem>
2683 </varlistentry>
798d3a52
ZJS
2684 </variablelist>
2685 </refsect1>
a1717e9a
DM
2686 <refsect1>
2687 <title>[BridgeMDB] Section Options</title>
2688 <para>The [BridgeMDB] section manages the multicast membership entries forwarding database table of a port and accepts the following
2689 keys. Specify several [BridgeMDB] sections to configure several permanent multicast membership entries.</para>
2690
2691 <variablelist class='network-directives'>
2692 <varlistentry>
2693 <term><varname>MulticastGroupAddress=</varname></term>
2694 <listitem>
2695 <para>Specifies the IPv4 or IPv6 multicast group address to add. This setting is mandatory.</para>
2696 </listitem>
2697 </varlistentry>
2698 <varlistentry>
2699 <term><varname>VLANId=</varname></term>
2700 <listitem>
2701 <para>The VLAN ID for the new entry. Valid ranges are 0 (no VLAN) to 4094. Optional, defaults to 0.</para>
2702 </listitem>
2703 </varlistentry>
2704 </variablelist>
2705 </refsect1>
06828bb6 2706
e9a8c550
SS
2707 <refsect1>
2708 <title>[LLDP] Section Options</title>
bdac5608 2709 <para>The [LLDP] section manages the Link Layer Discovery Protocol (LLDP) and accepts the following
885a4e6c 2710 keys:</para>
e9a8c550
SS
2711 <variablelist class='network-directives'>
2712 <varlistentry>
2713 <term><varname>MUDURL=</varname></term>
2714 <listitem>
0558f303
ZJS
2715 <para>When configured, the specified Manufacturer Usage Descriptions (MUD) URL will be sent in
2716 LLDP packets. The syntax and semantics are the same as for <varname>MUDURL=</varname> in the
2717 [DHCPv4] section described above.</para>
2718
2719 <para>The MUD URLs received via LLDP packets are saved and can be read using the
e9a8c550
SS
2720 <function>sd_lldp_neighbor_get_mud_url()</function> function.</para>
2721 </listitem>
2722 </varlistentry>
2723 </variablelist>
2724 </refsect1>
2725
06828bb6
HP
2726 <refsect1>
2727 <title>[CAN] Section Options</title>
bdac5608
ZJS
2728 <para>The [CAN] section manages the Controller Area Network (CAN bus) and accepts the
2729 following keys:</para>
06828bb6
HP
2730 <variablelist class='network-directives'>
2731 <varlistentry>
2732 <term><varname>BitRate=</varname></term>
2733 <listitem>
2734 <para>The bitrate of CAN device in bits per second. The usual SI prefixes (K, M) with the base of 1000 can
74a27268 2735 be used here. Takes a number in the range 1..4294967295.</para>
06828bb6
HP
2736 </listitem>
2737 </varlistentry>
2738 <varlistentry>
2739 <term><varname>SamplePoint=</varname></term>
2740 <listitem>
2741 <para>Optional sample point in percent with one decimal (e.g. <literal>75%</literal>,
2742 <literal>87.5%</literal>) or permille (e.g. <literal>875‰</literal>).</para>
2743 </listitem>
2744 </varlistentry>
7e025e9c
RP
2745 <varlistentry>
2746 <term><varname>DataBitRate=</varname></term>
2747 <term><varname>DataSamplePoint=</varname></term>
2748 <listitem>
2749 <para>The bitrate and sample point for the data phase, if CAN-FD is used. These settings are
2750 analogous to the <varname>BitRate=</varname> and <varname>SamplePoint=</varname> keys.</para>
2751 </listitem>
2752 </varlistentry>
2753 <varlistentry>
2754 <term><varname>FDMode=</varname></term>
2755 <listitem>
2756 <para>Takes a boolean. When <literal>yes</literal>, CAN-FD mode is enabled for the interface.
2757 Note, that a bitrate and optional sample point should also be set for the CAN-FD data phase using
2758 the <varname>DataBitRate=</varname> and <varname>DataSamplePoint=</varname> keys.</para>
2759 </listitem>
2760 </varlistentry>
2761 <varlistentry>
2762 <term><varname>FDNonISO=</varname></term>
2763 <listitem>
2764 <para>Takes a boolean. When <literal>yes</literal>, non-ISO CAN-FD mode is enabled for the
2765 interface. When unset, the kernel's default will be used.</para>
2766 </listitem>
2767 </varlistentry>
06828bb6
HP
2768 <varlistentry>
2769 <term><varname>RestartSec=</varname></term>
2770 <listitem>
2771 <para>Automatic restart delay time. If set to a non-zero value, a restart of the CAN controller will be
2772 triggered automatically in case of a bus-off condition after the specified delay time. Subsecond delays can
2773 be specified using decimals (e.g. <literal>0.1s</literal>) or a <literal>ms</literal> or
2774 <literal>us</literal> postfix. Using <literal>infinity</literal> or <literal>0</literal> will turn the
2775 automatic restart off. By default automatic restart is disabled.</para>
2776 </listitem>
2777 </varlistentry>
52aa38f1
MR
2778 <varlistentry>
2779 <term><varname>Termination=</varname></term>
2780 <listitem>
2781 <para>Takes a boolean. When <literal>yes</literal>, the termination resistor will be selected for
2782 the bias network. When unset, the kernel's default will be used.</para>
2783 </listitem>
2784 </varlistentry>
c423be28
CG
2785 <varlistentry>
2786 <term><varname>TripleSampling=</varname></term>
2787 <listitem>
2788 <para>Takes a boolean. When <literal>yes</literal>, three samples (instead of one) are used to determine
2789 the value of a received bit by majority rule. When unset, the kernel's default will be used.</para>
2790 </listitem>
2791 </varlistentry>
77b67404
2792 <varlistentry>
2793 <term><varname>BusErrorReporting=</varname></term>
2794 <listitem>
2795 <para>Takes a boolean. When <literal>yes</literal>, reporting of CAN bus errors is activated
2796 (those include single bit, frame format, and bit stuffing errors, unable to send dominant bit,
2797 unable to send recessive bit, bus overload, active error announcement, error occurred on
2798 transmission). When unset, the kernel's default will be used. Note: in case of a CAN bus with a
2799 single CAN device, sending a CAN frame may result in a huge number of CAN bus errors.</para>
2800 </listitem>
2801 </varlistentry>
74f0fb90
YW
2802 <varlistentry>
2803 <term><varname>ListenOnly=</varname></term>
2804 <listitem>
2805 <para>Takes a boolean. When <literal>yes</literal>, listen-only mode is enabled. When the
2806 interface is in listen-only mode, the interface neither transmit CAN frames nor send ACK
2807 bit. Listen-only mode is important to debug CAN networks without interfering with the
2808 communication or acknowledge the CAN frame. When unset, the kernel's default will be used.
2809 </para>
2810 </listitem>
2811 </varlistentry>
06828bb6
HP
2812 </variablelist>
2813 </refsect1>
2814
2ed5f6d5
YW
2815 <refsect1>
2816 <title>[QDisc] Section Options</title>
bdac5608 2817 <para>The [QDisc] section manages the traffic control queueing discipline (qdisc).</para>
2ed5f6d5
YW
2818
2819 <variablelist class='network-directives'>
2820 <varlistentry>
2821 <term><varname>Parent=</varname></term>
2822 <listitem>
2823 <para>Specifies the parent Queueing Discipline (qdisc). Takes one of <literal>clsact</literal>
2824 or <literal>ingress</literal>. This is mandatory.</para>
2825 </listitem>
2826 </varlistentry>
d8b2396d 2827
f344a492 2828 <xi:include href="tc.xml" xpointer="qdisc-handle" />
2ed5f6d5
YW
2829 </variablelist>
2830 </refsect1>
2831
0f5bd7fe 2832 <refsect1>
18de0969 2833 <title>[NetworkEmulator] Section Options</title>
bdac5608
ZJS
2834 <para>The [NetworkEmulator] section manages the queueing discipline (qdisc) of the network emulator. It
2835 can be used to configure the kernel packet scheduler and simulate packet delay and loss for UDP or TCP
2836 applications, or limit the bandwidth usage of a particular service to simulate internet connections.
2837 </para>
0f5bd7fe
SS
2838
2839 <variablelist class='network-directives'>
f344a492
YW
2840 <xi:include href="tc.xml" xpointer="qdisc-parent" />
2841 <xi:include href="tc.xml" xpointer="qdisc-handle" />
d8b2396d 2842
0f5bd7fe 2843 <varlistentry>
18de0969 2844 <term><varname>DelaySec=</varname></term>
0f5bd7fe
SS
2845 <listitem>
2846 <para>Specifies the fixed amount of delay to be added to all packets going out of the
2847 interface. Defaults to unset.</para>
2848 </listitem>
2849 </varlistentry>
2850
2851 <varlistentry>
18de0969 2852 <term><varname>DelayJitterSec=</varname></term>
0f5bd7fe
SS
2853 <listitem>
2854 <para>Specifies the chosen delay to be added to the packets outgoing to the network
2855 interface. Defaults to unset.</para>
2856 </listitem>
2857 </varlistentry>
2858
2859 <varlistentry>
18de0969 2860 <term><varname>PacketLimit=</varname></term>
0f5bd7fe
SS
2861 <listitem>
2862 <para>Specifies the maximum number of packets the qdisc may hold queued at a time.
e9dd6984 2863 An unsigned integer in the range 0–4294967294. Defaults to 1000.</para>
0f5bd7fe
SS
2864 </listitem>
2865 </varlistentry>
2866
2867 <varlistentry>
18de0969 2868 <term><varname>LossRate=</varname></term>
0f5bd7fe
SS
2869 <listitem>
2870 <para>Specifies an independent loss probability to be added to the packets outgoing from the
2871 network interface. Takes a percentage value, suffixed with "%". Defaults to unset.</para>
2872 </listitem>
2873 </varlistentry>
2874
b9c5aa3c 2875 <varlistentry>
18de0969 2876 <term><varname>DuplicateRate=</varname></term>
b9c5aa3c
SS
2877 <listitem>
2878 <para>Specifies that the chosen percent of packets is duplicated before queuing them.
2879 Takes a percentage value, suffixed with "%". Defaults to unset.</para>
2880 </listitem>
2881 </varlistentry>
18de0969
YW
2882 </variablelist>
2883 </refsect1>
b9c5aa3c 2884
18de0969 2885 <refsect1>
60ed2dcf 2886 <title>[TokenBucketFilter] Section Options</title>
e9dd6984
ZJS
2887 <para>The [TokenBucketFilter] section manages the queueing discipline (qdisc) of token bucket filter
2888 (tbf).</para>
18de0969
YW
2889
2890 <variablelist class='network-directives'>
f344a492
YW
2891 <xi:include href="tc.xml" xpointer="qdisc-parent" />
2892 <xi:include href="tc.xml" xpointer="qdisc-handle" />
d8b2396d 2893
18de0969
YW
2894 <varlistentry>
2895 <term><varname>LatencySec=</varname></term>
ba5841b5
SS
2896 <listitem>
2897 <para>Specifies the latency parameter, which specifies the maximum amount of time a
60ed2dcf 2898 packet can sit in the Token Bucket Filter (TBF). Defaults to unset.</para>
ba5841b5
SS
2899 </listitem>
2900 </varlistentry>
2901
dcfc23ae 2902 <varlistentry>
c03ef420 2903 <term><varname>LimitBytes=</varname></term>
dcfc23ae
YW
2904 <listitem>
2905 <para>Takes the number of bytes that can be queued waiting for tokens to become available.
2906 When the size is suffixed with K, M, or G, it is parsed as Kilobytes, Megabytes, or Gigabytes,
c03ef420 2907 respectively, to the base of 1024. Defaults to unset.</para>
dcfc23ae
YW
2908 </listitem>
2909 </varlistentry>
2910
ba5841b5 2911 <varlistentry>
c03ef420 2912 <term><varname>BurstBytes=</varname></term>
ba5841b5
SS
2913 <listitem>
2914 <para>Specifies the size of the bucket. This is the maximum amount of bytes that tokens
2915 can be available for instantaneous transfer. When the size is suffixed with K, M, or G, it is
c03ef420 2916 parsed as Kilobytes, Megabytes, or Gigabytes, respectively, to the base of 1024. Defaults to
ba5841b5
SS
2917 unset.</para>
2918 </listitem>
2919 </varlistentry>
2920
2921 <varlistentry>
18de0969 2922 <term><varname>Rate=</varname></term>
ba5841b5
SS
2923 <listitem>
2924 <para>Specifies the device specific bandwidth. When suffixed with K, M, or G, the specified
6b8fe4c3 2925 bandwidth is parsed as Kilobits, Megabits, or Gigabits, respectively, to the base of 1000.
ba5841b5
SS
2926 Defaults to unset.</para>
2927 </listitem>
2928 </varlistentry>
2929
dcfc23ae 2930 <varlistentry>
18de0969 2931 <term><varname>MPUBytes=</varname></term>
dcfc23ae
YW
2932 <listitem>
2933 <para>The Minimum Packet Unit (MPU) determines the minimal token usage (specified in bytes)
2934 for a packet. When suffixed with K, M, or G, the specified size is parsed as Kilobytes,
c03ef420 2935 Megabytes, or Gigabytes, respectively, to the base of 1024. Defaults to zero.</para>
dcfc23ae
YW
2936 </listitem>
2937 </varlistentry>
2938
2939 <varlistentry>
18de0969 2940 <term><varname>PeakRate=</varname></term>
dcfc23ae
YW
2941 <listitem>
2942 <para>Takes the maximum depletion rate of the bucket. When suffixed with K, M, or G, the
6b8fe4c3 2943 specified size is parsed as Kilobits, Megabits, or Gigabits, respectively, to the base of
dcfc23ae
YW
2944 1000. Defaults to unset.</para>
2945 </listitem>
2946 </varlistentry>
2947
2948 <varlistentry>
18de0969 2949 <term><varname>MTUBytes=</varname></term>
dcfc23ae
YW
2950 <listitem>
2951 <para>Specifies the size of the peakrate bucket. When suffixed with K, M, or G, the specified
c03ef420 2952 size is parsed as Kilobytes, Megabytes, or Gigabytes, respectively, to the base of 1024.
dcfc23ae
YW
2953 Defaults to unset.</para>
2954 </listitem>
2955 </varlistentry>
18de0969
YW
2956 </variablelist>
2957 </refsect1>
2958
bde4ae88
SS
2959 <refsect1>
2960 <title>[PIE] Section Options</title>
bdac5608
ZJS
2961 <para>The [PIE] section manages the queueing discipline (qdisc) of Proportional Integral
2962 controller-Enhanced (PIE).</para>
bde4ae88
SS
2963
2964 <variablelist class='network-directives'>
f344a492
YW
2965 <xi:include href="tc.xml" xpointer="qdisc-parent" />
2966 <xi:include href="tc.xml" xpointer="qdisc-handle" />
bde4ae88
SS
2967
2968 <varlistentry>
2969 <term><varname>PacketLimit=</varname></term>
2970 <listitem>
2971 <para>Specifies the hard limit on the queue size in number of packets. When this limit is reached, incoming packets are
e9dd6984 2972 dropped. An unsigned integer in the range 1–4294967294. Defaults to unset and kernel's default is used.</para>
8f6b6d70
SS
2973 </listitem>
2974 </varlistentry>
2975 </variablelist>
2976 </refsect1>
2977
2978 <refsect1>
2979 <title>[FlowQueuePIE] Section Options</title>
2980 <para>The <literal>[FlowQueuePIE]</literal> section manages the queueing discipline
2981 (qdisc) of Flow Queue Proportional Integral controller-Enhanced (fq_pie).</para>
2982
2983 <variablelist class='network-directives'>
2984 <xi:include href="tc.xml" xpointer="qdisc-parent" />
2985 <xi:include href="tc.xml" xpointer="qdisc-handle" />
2986
2987 <varlistentry>
2988 <term><varname>PacketLimit=</varname></term>
2989 <listitem>
2990 <para>Specifies the hard limit on the queue size in number of packets. When this limit is reached, incoming packets are
2991 dropped. An unsigned integer ranges 1 to 4294967294. Defaults to unset and kernel's default is used.</para>
bde4ae88
SS
2992 </listitem>
2993 </varlistentry>
2994 </variablelist>
2995 </refsect1>
2996
982998b0
SS
2997 <refsect1>
2998 <title>[StochasticFairBlue] Section Options</title>
bdac5608
ZJS
2999 <para>The [StochasticFairBlue] section manages the queueing discipline (qdisc) of stochastic fair blue
3000 (sfb).</para>
982998b0
SS
3001
3002 <variablelist class='network-directives'>
f344a492
YW
3003 <xi:include href="tc.xml" xpointer="qdisc-parent" />
3004 <xi:include href="tc.xml" xpointer="qdisc-handle" />
982998b0
SS
3005
3006 <varlistentry>
3007 <term><varname>PacketLimit=</varname></term>
3008 <listitem>
e9dd6984
ZJS
3009 <para>Specifies the hard limit on the queue size in number of packets. When this limit is reached,
3010 incoming packets are dropped. An unsigned integer in the range 0–4294967294. Defaults to unset and
3011 kernel's default is used.</para>
982998b0
SS
3012 </listitem>
3013 </varlistentry>
3014 </variablelist>
3015 </refsect1>
3016
18de0969
YW
3017 <refsect1>
3018 <title>[StochasticFairnessQueueing] Section Options</title>
bdac5608
ZJS
3019 <para>The [StochasticFairnessQueueing] section manages the queueing discipline (qdisc) of stochastic
3020 fairness queueing (sfq).</para>
18de0969
YW
3021
3022 <variablelist class='network-directives'>
f344a492
YW
3023 <xi:include href="tc.xml" xpointer="qdisc-parent" />
3024 <xi:include href="tc.xml" xpointer="qdisc-handle" />
d8b2396d 3025
9942b710 3026 <varlistentry>
18de0969 3027 <term><varname>PerturbPeriodSec=</varname></term>
9942b710
SS
3028 <listitem>
3029 <para>Specifies the interval in seconds for queue algorithm perturbation. Defaults to unset.</para>
3030 </listitem>
3031 </varlistentry>
18de0969
YW
3032 </variablelist>
3033 </refsect1>
3034
c853f594
SS
3035 <refsect1>
3036 <title>[BFIFO] Section Options</title>
bdac5608
ZJS
3037 <para>The [BFIFO] section manages the queueing discipline (qdisc) of Byte limited Packet First In First
3038 Out (bfifo).</para>
c853f594
SS
3039
3040 <variablelist class='network-directives'>
f344a492
YW
3041 <xi:include href="tc.xml" xpointer="qdisc-parent" />
3042 <xi:include href="tc.xml" xpointer="qdisc-handle" />
c853f594
SS
3043
3044 <varlistentry>
c03ef420 3045 <term><varname>LimitBytes=</varname></term>
c853f594 3046 <listitem>
885a4e6c
ZJS
3047 <para>Specifies the hard limit in bytes on the FIFO buffer size. The size limit prevents overflow
3048 in case the kernel is unable to dequeue packets as quickly as it receives them. When this limit is
3049 reached, incoming packets are dropped. When suffixed with K, M, or G, the specified size is parsed
3050 as Kilobytes, Megabytes, or Gigabytes, respectively, to the base of 1024. Defaults to unset and
3051 kernel default is used.</para>
c853f594
SS
3052 </listitem>
3053 </varlistentry>
3054 </variablelist>
3055 </refsect1>
3056
a7476065
SS
3057 <refsect1>
3058 <title>[PFIFO] Section Options</title>
bdac5608
ZJS
3059 <para>The [PFIFO] section manages the queueing discipline (qdisc) of Packet First In First Out
3060 (pfifo).</para>
a7476065
SS
3061
3062 <variablelist class='network-directives'>
f344a492
YW
3063 <xi:include href="tc.xml" xpointer="qdisc-parent" />
3064 <xi:include href="tc.xml" xpointer="qdisc-handle" />
a7476065
SS
3065
3066 <varlistentry>
3067 <term><varname>PacketLimit=</varname></term>
3068 <listitem>
e9dd6984
ZJS
3069 <para>Specifies the hard limit on the FIFO size in number of packets. The size limit (a buffer
3070 size) to prevent it from overflowing in case it is unable to dequeue packets as quickly as it
3071 receives them. When this limit is reached, incoming packets are dropped. An unsigned integer in the
3072 range 0–4294967294. Defaults to unset and kernel's default is used.</para>
a7476065
SS
3073 </listitem>
3074 </varlistentry>
ad8352f4
SS
3075 </variablelist>
3076 </refsect1>
3077
053a2ddb
SS
3078 <refsect1>
3079 <title>[PFIFOHeadDrop] Section Options</title>
bdac5608
ZJS
3080 <para>The [PFIFOHeadDrop] section manages the queueing discipline (qdisc) of Packet First In First Out
3081 Head Drop (pfifo_head_drop).</para>
053a2ddb
SS
3082
3083 <variablelist class='network-directives'>
f344a492
YW
3084 <xi:include href="tc.xml" xpointer="qdisc-parent" />
3085 <xi:include href="tc.xml" xpointer="qdisc-handle" />
053a2ddb
SS
3086
3087 <varlistentry>
3088 <term><varname>PacketLimit=</varname></term>
3089 <listitem>
bdac5608 3090 <para>As in [PFIFO] section.</para></listitem>
053a2ddb
SS
3091 </varlistentry>
3092 </variablelist>
3093 </refsect1>
3094
1a95964b
SS
3095 <refsect1>
3096 <title>[PFIFOFast] Section Options</title>
bdac5608
ZJS
3097 <para>The [PFIFOFast] section manages the queueing discipline (qdisc) of Packet First In First Out Fast
3098 (pfifo_fast).</para>
1a95964b
SS
3099
3100 <variablelist class='network-directives'>
f344a492
YW
3101 <xi:include href="tc.xml" xpointer="qdisc-parent" />
3102 <xi:include href="tc.xml" xpointer="qdisc-handle" />
1a95964b
SS
3103 </variablelist>
3104 </refsect1>
3105
ad8352f4
SS
3106 <refsect1>
3107 <title>[CAKE] Section Options</title>
bdac5608
ZJS
3108 <para>The [CAKE] section manages the queueing discipline (qdisc) of Common Applications Kept Enhanced
3109 (CAKE).</para>
ad8352f4
SS
3110
3111 <variablelist class='network-directives'>
f344a492
YW
3112 <xi:include href="tc.xml" xpointer="qdisc-parent" />
3113 <xi:include href="tc.xml" xpointer="qdisc-handle" />
a7476065 3114
ad8352f4 3115 <varlistentry>
c03ef420 3116 <term><varname>OverheadBytes=</varname></term>
ad8352f4 3117 <listitem>
e9dd6984
ZJS
3118 <para>Specifies that bytes to be addeded to the size of each packet. Bytes may be negative. Takes
3119 an integer in the range from -64 to 256. Defaults to unset and kernel's default is used.</para>
ad8352f4 3120 </listitem>
f344a492 3121 </varlistentry>
ad8352f4
SS
3122
3123 <varlistentry>
3124 <term><varname>Bandwidth=</varname></term>
3125 <listitem>
3126 <para>Specifies the shaper bandwidth. When suffixed with K, M, or G, the specified size is
3127 parsed as Kilobits, Megabits, or Gigabits, respectively, to the base of 1000. Defaults to
3128 unset and kernel's default is used.</para>
3129 </listitem>
3130 </varlistentry>
a7476065
SS
3131 </variablelist>
3132 </refsect1>
3133
18de0969
YW
3134 <refsect1>
3135 <title>[ControlledDelay] Section Options</title>
bdac5608 3136 <para>The [ControlledDelay] section manages the queueing discipline (qdisc) of
18de0969 3137 controlled delay (CoDel).</para>
9942b710 3138
18de0969 3139 <variablelist class='network-directives'>
f344a492
YW
3140 <xi:include href="tc.xml" xpointer="qdisc-parent" />
3141 <xi:include href="tc.xml" xpointer="qdisc-handle" />
d8b2396d 3142
18de0969
YW
3143 <varlistentry>
3144 <term><varname>PacketLimit=</varname></term>
a9a5d632 3145 <listitem>
e9dd6984
ZJS
3146 <para>Specifies the hard limit on the queue size in number of packets. When this limit is reached,
3147 incoming packets are dropped. An unsigned integer in the range 0–4294967294. Defaults to unset and
3148 kernel's default is used.</para>
a9a5d632
SS
3149 </listitem>
3150 </varlistentry>
3151
b078e528 3152 <varlistentry>
18de0969 3153 <term><varname>TargetSec=</varname></term>
b078e528
YW
3154 <listitem>
3155 <para>Takes a timespan. Specifies the acceptable minimum standing/persistent queue delay.
3156 Defaults to unset and kernel's default is used.</para>
3157 </listitem>
3158 </varlistentry>
3159
3160 <varlistentry>
18de0969 3161 <term><varname>IntervalSec=</varname></term>
b078e528
YW
3162 <listitem>
3163 <para>Takes a timespan. This is used to ensure that the measured minimum delay does not
3164 become too stale. Defaults to unset and kernel's default is used.</para>
3165 </listitem>
3166 </varlistentry>
3167
3168 <varlistentry>
18de0969 3169 <term><varname>ECN=</varname></term>
b078e528
YW
3170 <listitem>
3171 <para>Takes a boolean. This can be used to mark packets instead of dropping them. Defaults to
3172 unset and kernel's default is used.</para>
3173 </listitem>
3174 </varlistentry>
3175
3176 <varlistentry>
18de0969 3177 <term><varname>CEThresholdSec=</varname></term>
b078e528
YW
3178 <listitem>
3179 <para>Takes a timespan. This sets a threshold above which all packets are marked with ECN
3180 Congestion Experienced (CE). Defaults to unset and kernel's default is used.</para>
3181 </listitem>
3182 </varlistentry>
18de0969
YW
3183 </variablelist>
3184 </refsect1>
b078e528 3185
f5fc0441
SS
3186 <refsect1>
3187 <title>[DeficitRoundRobinScheduler] Section Options</title>
bdac5608
ZJS
3188 <para>The [DeficitRoundRobinScheduler] section manages the queueing discipline (qdisc) of Deficit Round
3189 Robin Scheduler (DRR).</para>
f5fc0441
SS
3190
3191 <variablelist class='network-directives'>
f344a492
YW
3192 <xi:include href="tc.xml" xpointer="qdisc-parent" />
3193 <xi:include href="tc.xml" xpointer="qdisc-handle" />
f5fc0441
SS
3194 </variablelist>
3195 </refsect1>
3196
ad365c5d
YW
3197 <refsect1>
3198 <title>[DeficitRoundRobinSchedulerClass] Section Options</title>
bdac5608
ZJS
3199 <para>The [DeficitRoundRobinSchedulerClass] section manages the traffic control class of Deficit Round
3200 Robin Scheduler (DRR).</para>
ad365c5d
YW
3201
3202 <variablelist class='network-directives'>
f344a492
YW
3203 <xi:include href="tc.xml" xpointer="tclass-parent" />
3204 <xi:include href="tc.xml" xpointer="tclass-classid" />
ad365c5d
YW
3205
3206 <varlistentry>
c03ef420 3207 <term><varname>QuantumBytes=</varname></term>
ad365c5d 3208 <listitem>
c03ef420
YW
3209 <para>Specifies the amount of bytes a flow is allowed to dequeue before the scheduler moves
3210 to the next class. When suffixed with K, M, or G, the specified size is parsed as Kilobytes,
3211 Megabytes, or Gigabytes, respectively, to the base of 1024. Defaults to the MTU of the
3212 interface.</para>
ad365c5d
YW
3213 </listitem>
3214 </varlistentry>
3215
3216 </variablelist>
3217 </refsect1>
3218
d474aa51
YW
3219 <refsect1>
3220 <title>[EnhancedTransmissionSelection] Section Options</title>
bdac5608
ZJS
3221 <para>The [EnhancedTransmissionSelection] section manages the queueing discipline (qdisc) of Enhanced
3222 Transmission Selection (ETS).</para>
d474aa51
YW
3223
3224 <variablelist class='network-directives'>
3225 <xi:include href="tc.xml" xpointer="qdisc-parent" />
3226 <xi:include href="tc.xml" xpointer="qdisc-handle" />
3227
3228 <varlistentry>
3229 <term><varname>Bands=</varname></term>
3230 <listitem>
e9dd6984
ZJS
3231 <para>Specifies the number of bands. An unsigned integer in the range 1–16. This value has to be at
3232 least large enough to cover the strict bands specified through the <varname>StrictBands=</varname>
3233 and bandwidth-sharing bands specified in <varname>QuantumBytes=</varname>.</para>
d474aa51
YW
3234 </listitem>
3235 </varlistentry>
3236
3237 <varlistentry>
3238 <term><varname>StrictBands=</varname></term>
3239 <listitem>
e9dd6984
ZJS
3240 <para>Specifies the number of bands that should be created in strict mode. An unsigned integer in
3241 the range 1–16.</para>
d474aa51
YW
3242 </listitem>
3243 </varlistentry>
3244
3245 <varlistentry>
3246 <term><varname>QuantumBytes=</varname></term>
3247 <listitem>
3248 <para>Specifies the white-space separated list of quantum used in band-sharing bands. When
3249 suffixed with K, M, or G, the specified size is parsed as Kilobytes, Megabytes, or Gigabytes,
3250 respectively, to the base of 1024. This setting can be specified multiple times. If an empty
3251 string is assigned, then the all previous assignments are cleared.</para>
3252 </listitem>
3253 </varlistentry>
3254
3255 <varlistentry>
3256 <term><varname>PriorityMap=</varname></term>
3257 <listitem>
885a4e6c
ZJS
3258 <para>The priority map maps the priority of a packet to a band. The argument is a whitespace
3259 separated list of numbers. The first number indicates which band the packets with priority 0 should
3260 be put to, the second is for priority 1, and so on. There can be up to 16 numbers in the list. If
3261 there are fewer, the default band that traffic with one of the unmentioned priorities goes to is
3262 the last one. Each band number must be in the range 0..255. This setting can be specified multiple
3263 times. If an empty string is assigned, then the all previous assignments are cleared.</para>
d474aa51
YW
3264 </listitem>
3265 </varlistentry>
3266 </variablelist>
3267 </refsect1>
3268
609e8340
SS
3269 <refsect1>
3270 <title>[GenericRandomEarlyDetection] Section Options</title>
bdac5608
ZJS
3271 <para>The [GenericRandomEarlyDetection] section manages the queueing discipline (qdisc) of Generic Random
3272 Early Detection (GRED).</para>
609e8340
SS
3273
3274 <variablelist class='network-directives'>
f344a492
YW
3275 <xi:include href="tc.xml" xpointer="qdisc-parent" />
3276 <xi:include href="tc.xml" xpointer="qdisc-handle" />
609e8340
SS
3277
3278 <varlistentry>
3279 <term><varname>VirtualQueues=</varname></term>
3280 <listitem>
3281 <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>
3282 </listitem>
3283 </varlistentry>
3284
3285 <varlistentry>
3286 <term><varname>DefaultVirtualQueue=</varname></term>
3287 <listitem>
3288 <para>Specifies the number of default virtual queue. This must be less than <varname>VirtualQueue=</varname>.
3289 Defaults to unset and kernel's default is used.</para>
3290 </listitem>
3291 </varlistentry>
3292
3293 <varlistentry>
3294 <term><varname>GenericRIO=</varname></term>
3295 <listitem>
3296 <para>Takes a boolean. It turns on the RIO-like buffering scheme. Defaults to
3297 unset and kernel's default is used.</para>
3298 </listitem>
3299 </varlistentry>
3300 </variablelist>
3301 </refsect1>
3302
18de0969
YW
3303 <refsect1>
3304 <title>[FairQueueingControlledDelay] Section Options</title>
bdac5608
ZJS
3305 <para>The [FairQueueingControlledDelay] section manages the queueing discipline (qdisc) of fair queuing
3306 controlled delay (FQ-CoDel).</para>
18de0969
YW
3307
3308 <variablelist class='network-directives'>
f344a492
YW
3309 <xi:include href="tc.xml" xpointer="qdisc-parent" />
3310 <xi:include href="tc.xml" xpointer="qdisc-handle" />
d8b2396d 3311
18de0969
YW
3312 <varlistentry>
3313 <term><varname>PacketLimit=</varname></term>
4e5ef149
SS
3314 <listitem>
3315 <para>Specifies the hard limit on the real queue size. When this limit is reached, incoming packets are
3316 dropped. Defaults to unset and kernel's default is used.</para>
3317 </listitem>
3318 </varlistentry>
3319
ac810b75 3320 <varlistentry>
c03ef420 3321 <term><varname>MemoryLimitBytes=</varname></term>
ac810b75
YW
3322 <listitem>
3323 <para>Specifies the limit on the total number of bytes that can be queued in this FQ-CoDel instance.
3324 When suffixed with K, M, or G, the specified size is parsed as Kilobytes, Megabytes, or Gigabytes,
3325 respectively, to the base of 1024. Defaults to unset and kernel's default is used.</para>
3326 </listitem>
3327 </varlistentry>
3328
3329 <varlistentry>
18de0969 3330 <term><varname>Flows=</varname></term>
ac810b75
YW
3331 <listitem>
3332 <para>Specifies the number of flows into which the incoming packets are classified.
3333 Defaults to unset and kernel's default is used.</para>
3334 </listitem>
3335 </varlistentry>
3336
3337 <varlistentry>
18de0969 3338 <term><varname>TargetSec=</varname></term>
ac810b75
YW
3339 <listitem>
3340 <para>Takes a timespan. Specifies the acceptable minimum standing/persistent queue delay.
3341 Defaults to unset and kernel's default is used.</para>
3342 </listitem>
3343 </varlistentry>
3344
3345 <varlistentry>
18de0969 3346 <term><varname>IntervalSec=</varname></term>
ac810b75
YW
3347 <listitem>
3348 <para>Takes a timespan. This is used to ensure that the measured minimum delay does not
3349 become too stale. Defaults to unset and kernel's default is used.</para>
3350 </listitem>
3351 </varlistentry>
3352
3353 <varlistentry>
c03ef420 3354 <term><varname>QuantumBytes=</varname></term>
ac810b75 3355 <listitem>
e9dd6984 3356 <para>Specifies the number of bytes used as the "deficit" in the fair queuing algorithm timespan.
ac810b75
YW
3357 When suffixed with K, M, or G, the specified size is parsed as Kilobytes, Megabytes, or Gigabytes,
3358 respectively, to the base of 1024. Defaults to unset and kernel's default is used.</para>
3359 </listitem>
3360 </varlistentry>
3361
3362 <varlistentry>
18de0969 3363 <term><varname>ECN=</varname></term>
ac810b75
YW
3364 <listitem>
3365 <para>Takes a boolean. This can be used to mark packets instead of dropping them. Defaults to
3366 unset and kernel's default is used.</para>
3367 </listitem>
3368 </varlistentry>
3369
3370 <varlistentry>
18de0969 3371 <term><varname>CEThresholdSec=</varname></term>
ac810b75
YW
3372 <listitem>
3373 <para>Takes a timespan. This sets a threshold above which all packets are marked with ECN
3374 Congestion Experienced (CE). Defaults to unset and kernel's default is used.</para>
3375 </listitem>
3376 </varlistentry>
18de0969
YW
3377 </variablelist>
3378 </refsect1>
3379
3380 <refsect1>
ca58d00c 3381 <title>[FairQueueing] Section Options</title>
bdac5608
ZJS
3382 <para>The [FairQueueing] section manages the queueing discipline (qdisc) of fair queue traffic policing
3383 (FQ).</para>
18de0969
YW
3384
3385 <variablelist class='network-directives'>
f344a492
YW
3386 <xi:include href="tc.xml" xpointer="qdisc-parent" />
3387 <xi:include href="tc.xml" xpointer="qdisc-handle" />
d8b2396d 3388
7234b915 3389 <varlistentry>
18de0969 3390 <term><varname>PacketLimit=</varname></term>
7234b915
SS
3391 <listitem>
3392 <para>Specifies the hard limit on the real queue size. When this limit is reached, incoming packets are
3393 dropped. Defaults to unset and kernel's default is used.</para>
3394 </listitem>
3395 </varlistentry>
3396
e83562e5 3397 <varlistentry>
18de0969 3398 <term><varname>FlowLimit=</varname></term>
e83562e5
YW
3399 <listitem>
3400 <para>Specifies the hard limit on the maximum number of packets queued per flow. Defaults to
3401 unset and kernel's default is used.</para>
3402 </listitem>
3403 </varlistentry>
3404
3405 <varlistentry>
c03ef420 3406 <term><varname>QuantumBytes=</varname></term>
e83562e5
YW
3407 <listitem>
3408 <para>Specifies the credit per dequeue RR round, i.e. the amount of bytes a flow is allowed
3409 to dequeue at once. When suffixed with K, M, or G, the specified size is parsed as Kilobytes,
3410 Megabytes, or Gigabytes, respectively, to the base of 1024. Defaults to unset and kernel's
3411 default is used.</para>
3412 </listitem>
3413 </varlistentry>
3414
3415 <varlistentry>
c03ef420 3416 <term><varname>InitialQuantumBytes=</varname></term>
e83562e5
YW
3417 <listitem>
3418 <para>Specifies the initial sending rate credit, i.e. the amount of bytes a new flow is
3419 allowed to dequeue initially. When suffixed with K, M, or G, the specified size is parsed as
3420 Kilobytes, Megabytes, or Gigabytes, respectively, to the base of 1024. Defaults to unset and
3421 kernel's default is used.</para>
3422 </listitem>
3423 </varlistentry>
3424
3425 <varlistentry>
18de0969 3426 <term><varname>MaximumRate=</varname></term>
e83562e5
YW
3427 <listitem>
3428 <para>Specifies the maximum sending rate of a flow. When suffixed with K, M, or G, the
6b8fe4c3 3429 specified size is parsed as Kilobits, Megabits, or Gigabits, respectively, to the base of
e83562e5
YW
3430 1000. Defaults to unset and kernel's default is used.</para>
3431 </listitem>
3432 </varlistentry>
3433
3434 <varlistentry>
18de0969 3435 <term><varname>Buckets=</varname></term>
e83562e5
YW
3436 <listitem>
3437 <para>Specifies the size of the hash table used for flow lookups. Defaults to unset and
3438 kernel's default is used.</para>
3439 </listitem>
3440 </varlistentry>
3441
3442 <varlistentry>
18de0969 3443 <term><varname>OrphanMask=</varname></term>
e83562e5
YW
3444 <listitem>
3445 <para>Takes an unsigned integer. For packets not owned by a socket, fq is able to mask a part
3446 of hash and reduce number of buckets associated with the traffic. Defaults to unset and
3447 kernel's default is used.</para>
3448 </listitem>
3449 </varlistentry>
3450
3451 <varlistentry>
18de0969 3452 <term><varname>Pacing=</varname></term>
e83562e5
YW
3453 <listitem>
3454 <para>Takes a boolean, and enables or disables flow pacing. Defaults to unset and kernel's
3455 default is used.</para>
3456 </listitem>
3457 </varlistentry>
3458
3459 <varlistentry>
18de0969 3460 <term><varname>CEThresholdSec=</varname></term>
e83562e5
YW
3461 <listitem>
3462 <para>Takes a timespan. This sets a threshold above which all packets are marked with ECN
3463 Congestion Experienced (CE). Defaults to unset and kernel's default is used.</para>
3464 </listitem>
3465 </varlistentry>
0f5bd7fe
SS
3466 </variablelist>
3467 </refsect1>
3468
9b749c11
YW
3469 <refsect1>
3470 <title>[TrivialLinkEqualizer] Section Options</title>
bdac5608
ZJS
3471 <para>The [TrivialLinkEqualizer] section manages the queueing discipline (qdisc) of trivial link
3472 equalizer (teql).</para>
9b749c11
YW
3473
3474 <variablelist class='network-directives'>
f344a492
YW
3475 <xi:include href="tc.xml" xpointer="qdisc-parent" />
3476 <xi:include href="tc.xml" xpointer="qdisc-handle" />
d8b2396d 3477
9b749c11
YW
3478 <varlistentry>
3479 <term><varname>Id=</varname></term>
3480 <listitem>
3481 <para>Specifies the interface ID <literal>N</literal> of teql. Defaults to <literal>0</literal>.
3482 Note that when teql is used, currently, the module <constant>sch_teql</constant> with
3483 <constant>max_equalizers=N+1</constant> option must be loaded before
3484 <command>systemd-networkd</command> is started.</para>
3485 </listitem>
3486 </varlistentry>
3487 </variablelist>
3488 </refsect1>
3489
b934ac3d
YW
3490 <refsect1>
3491 <title>[HierarchyTokenBucket] Section Options</title>
bdac5608
ZJS
3492 <para>The [HierarchyTokenBucket] section manages the queueing discipline (qdisc) of hierarchy token
3493 bucket (htb).</para>
b934ac3d
YW
3494
3495 <variablelist class='network-directives'>
f344a492
YW
3496 <xi:include href="tc.xml" xpointer="qdisc-parent" />
3497 <xi:include href="tc.xml" xpointer="qdisc-handle" />
b934ac3d
YW
3498
3499 <varlistentry>
3500 <term><varname>DefaultClass=</varname></term>
3501 <listitem>
3502 <para>Takes the minor id in hexadecimal of the default class. Unclassified traffic gets sent
3503 to the class. Defaults to unset.</para>
3504 </listitem>
3505 </varlistentry>
d9eacc1c
YW
3506
3507 <varlistentry>
3508 <term><varname>RateToQuantum=</varname></term>
3509 <listitem>
3510 <para>Takes an unsigned integer. The DRR quantums are calculated by dividing the value
3511 configured in <varname>Rate=</varname> by <varname>RateToQuantum=</varname>.</para>
3512 </listitem>
3513 </varlistentry>
b934ac3d
YW
3514 </variablelist>
3515 </refsect1>
3516
19f86a63
YW
3517 <refsect1>
3518 <title>[HierarchyTokenBucketClass] Section Options</title>
bdac5608
ZJS
3519 <para>The [HierarchyTokenBucketClass] section manages the traffic control class of hierarchy token bucket
3520 (htb).</para>
19f86a63
YW
3521
3522 <variablelist class='network-directives'>
f344a492
YW
3523 <xi:include href="tc.xml" xpointer="tclass-parent" />
3524 <xi:include href="tc.xml" xpointer="tclass-classid" />
19f86a63
YW
3525
3526 <varlistentry>
3527 <term><varname>Priority=</varname></term>
3528 <listitem>
3529 <para>Specifies the priority of the class. In the round-robin process, classes with the lowest
d9eacc1c
YW
3530 priority field are tried for packets first.</para>
3531 </listitem>
3532 </varlistentry>
3533
3534 <varlistentry>
3535 <term><varname>QuantumBytes=</varname></term>
3536 <listitem>
3537 <para>Specifies how many bytes to serve from leaf at once. When suffixed with K, M, or G, the
3538 specified size is parsed as Kilobytes, Megabytes, or Gigabytes, respectively, to the base of
3539 1024.</para>
3540 </listitem>
3541 </varlistentry>
3542
3543 <varlistentry>
3544 <term><varname>MTUBytes=</varname></term>
3545 <listitem>
3546 <para>Specifies the maximum packet size we create. When suffixed with K, M, or G, the specified
3547 size is parsed as Kilobytes, Megabytes, or Gigabytes, respectively, to the base of 1024.</para>
3548 </listitem>
3549 </varlistentry>
3550
3551 <varlistentry>
3552 <term><varname>OverheadBytes=</varname></term>
3553 <listitem>
3554 <para>Takes an unsigned integer which specifies per-packet size overhead used in rate
3555 computations. When suffixed with K, M, or G, the specified size is parsed as Kilobytes,
3556 Megabytes, or Gigabytes, respectively, to the base of 1024.</para>
19f86a63
YW
3557 </listitem>
3558 </varlistentry>
3559
3560 <varlistentry>
3561 <term><varname>Rate=</varname></term>
3562 <listitem>
3563 <para>Specifies the maximum rate this class and all its children are guaranteed. When suffixed
3564 with K, M, or G, the specified size is parsed as Kilobits, Megabits, or Gigabits, respectively,
3565 to the base of 1000. This setting is mandatory.</para>
3566 </listitem>
3567 </varlistentry>
3568
3569 <varlistentry>
3570 <term><varname>CeilRate=</varname></term>
3571 <listitem>
3572 <para>Specifies the maximum rate at which a class can send, if its parent has bandwidth to spare.
3573 When suffixed with K, M, or G, the specified size is parsed as Kilobits, Megabits, or Gigabits,
3574 respectively, to the base of 1000. When unset, the value specified with <varname>Rate=</varname>
3575 is used.</para>
3576 </listitem>
3577 </varlistentry>
d9eacc1c
YW
3578
3579 <varlistentry>
3580 <term><varname>BufferBytes=</varname></term>
3581 <listitem>
3582 <para>Specifies the maximum bytes burst which can be accumulated during idle period. When suffixed
3583 with K, M, or G, the specified size is parsed as Kilobytes, Megabytes, or Gigabytes, respectively,
3584 to the base of 1024.</para>
3585 </listitem>
3586 </varlistentry>
3587
3588 <varlistentry>
3589 <term><varname>CeilBufferBytes=</varname></term>
3590 <listitem>
3591 <para>Specifies the maximum bytes burst for ceil which can be accumulated during idle period.
3592 When suffixed with K, M, or G, the specified size is parsed as Kilobytes, Megabytes, or Gigabytes,
3593 respectively, to the base of 1024.</para>
3594 </listitem>
3595 </varlistentry>
7f224020
SS
3596 </variablelist>
3597 </refsect1>
3598
3599 <refsect1>
3600 <title>[HeavyHitterFilter] Section Options</title>
bdac5608
ZJS
3601 <para>The [HeavyHitterFilter] section manages the queueing discipline (qdisc) of Heavy Hitter Filter
3602 (hhf).</para>
7f224020
SS
3603
3604 <variablelist class='network-directives'>
f344a492
YW
3605 <xi:include href="tc.xml" xpointer="qdisc-parent" />
3606 <xi:include href="tc.xml" xpointer="qdisc-handle" />
19f86a63 3607
7f224020
SS
3608 <varlistentry>
3609 <term><varname>PacketLimit=</varname></term>
3610 <listitem>
e9dd6984
ZJS
3611 <para>Specifies the hard limit on the queue size in number of packets. When this limit is reached,
3612 incoming packets are dropped. An unsigned integer in the range 0–4294967294. Defaults to unset and
3613 kernel's default is used.</para>
7f224020
SS
3614 </listitem>
3615 </varlistentry>
19f86a63
YW
3616 </variablelist>
3617 </refsect1>
3618
b12aaee5
SS
3619 <refsect1>
3620 <title>[QuickFairQueueing] Section Options</title>
bdac5608
ZJS
3621 <para>The [QuickFairQueueing] section manages the queueing discipline (qdisc) of Quick Fair Queueing
3622 (QFQ).</para>
b12aaee5
SS
3623
3624 <variablelist class='network-directives'>
3625 <xi:include href="tc.xml" xpointer="qdisc-parent" />
3626 <xi:include href="tc.xml" xpointer="qdisc-handle" />
3627 </variablelist>
3628 </refsect1>
3629
4d7ddaf9
YW
3630 <refsect1>
3631 <title>[QuickFairQueueingClass] Section Options</title>
bdac5608
ZJS
3632 <para>The [QuickFairQueueingClass] section manages the traffic control class of Quick Fair Queueing
3633 (qfq).</para>
4d7ddaf9
YW
3634
3635 <variablelist class='network-directives'>
3636 <xi:include href="tc.xml" xpointer="tclass-parent" />
3637 <xi:include href="tc.xml" xpointer="tclass-classid" />
3638
3639 <varlistentry>
3640 <term><varname>Weight=</varname></term>
3641 <listitem>
7487b486 3642 <para>Specifies the weight of the class. Takes an integer in the range 1..1023. Defaults to
4d7ddaf9
YW
3643 unset in which case the kernel default is used.</para>
3644 </listitem>
3645 </varlistentry>
3646
3647 <varlistentry>
c03ef420 3648 <term><varname>MaxPacketBytes=</varname></term>
4d7ddaf9
YW
3649 <listitem>
3650 <para>Specifies the maximum packet size in bytes for the class. When suffixed with K, M, or G, the specified
c03ef420 3651 size is parsed as Kilobytes, Megabytes, or Gigabytes, respectively, to the base of 1024. When unset,
4d7ddaf9
YW
3652 the kernel default is used.</para>
3653 </listitem>
3654 </varlistentry>
3655 </variablelist>
3656 </refsect1>
3657
13b498f9
TJ
3658 <refsect1>
3659 <title>[BridgeVLAN] Section Options</title>
bdac5608
ZJS
3660 <para>The [BridgeVLAN] section manages the VLAN ID configuration of a bridge port and accepts the
3661 following keys. Specify several [BridgeVLAN] sections to configure several VLAN entries. The
3662 <varname>VLANFiltering=</varname> option has to be enabled, see the [Bridge] section in
13b498f9
TJ
3663 <citerefentry><refentrytitle>systemd.netdev</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para>
3664
3665 <variablelist class='network-directives'>
3666 <varlistentry>
3667 <term><varname>VLAN=</varname></term>
3668 <listitem>
3669 <para>The VLAN ID allowed on the port. This can be either a single ID or a range M-N. VLAN IDs are valid
3670 from 1 to 4094.</para>
3671 </listitem>
3672 </varlistentry>
3673 <varlistentry>
3674 <term><varname>EgressUntagged=</varname></term>
3675 <listitem>
3676 <para>The VLAN ID specified here will be used to untag frames on egress. Configuring
3677 <varname>EgressUntagged=</varname> implicates the use of <varname>VLAN=</varname> above and will enable the
3678 VLAN ID for ingress as well. This can be either a single ID or a range M-N.</para>
3679 </listitem>
3680 </varlistentry>
3681 <varlistentry>
3682 <term><varname>PVID=</varname></term>
3683 <listitem>
3684 <para>The Port VLAN ID specified here is assigned to all untagged frames at ingress.
3685 <varname>PVID=</varname> can be used only once. Configuring <varname>PVID=</varname> implicates the use of
3686 <varname>VLAN=</varname> above and will enable the VLAN ID for ingress as well.</para>
3687 </listitem>
3688 </varlistentry>
3689 </variablelist>
3690 </refsect1>
798d3a52
ZJS
3691
3692 <refsect1>
9e35b3de 3693 <title>Examples</title>
798d3a52 3694 <example>
9e35b3de 3695 <title>Static network configuration</title>
798d3a52 3696
9e35b3de
ZJS
3697 <programlisting># /etc/systemd/network/50-static.network
3698[Match]
eac684ef
TG
3699Name=enp2s0
3700
3701[Network]
3702Address=192.168.0.15/24
3703Gateway=192.168.0.1</programlisting>
9e35b3de
ZJS
3704
3705 <para>This brings interface <literal>enp2s0</literal> up with a static address. The
3706 specified gateway will be used for a default route.</para>
798d3a52 3707 </example>
eac684ef 3708
798d3a52 3709 <example>
9e35b3de 3710 <title>DHCP on ethernet links</title>
eac684ef 3711
9e35b3de
ZJS
3712 <programlisting># /etc/systemd/network/80-dhcp.network
3713[Match]
eac684ef
TG
3714Name=en*
3715
3716[Network]
9c8ca3f7 3717DHCP=yes</programlisting>
9e35b3de
ZJS
3718
3719 <para>This will enable DHCPv4 and DHCPv6 on all interfaces with names starting with
3720 <literal>en</literal> (i.e. ethernet interfaces).</para>
798d3a52 3721 </example>
eac684ef 3722
4c94a4c2 3723 <example>
3724 <title>IPv6 Prefix Delegation</title>
3725
3726 <programlisting># /etc/systemd/network/55-ipv6-pd-upstream.network
3727[Match]
3728Name=enp1s0
3729
3730[Network]
3731DHCP=ipv6</programlisting>
3732
3733 <programlisting># /etc/systemd/network/56-ipv6-pd-downstream.network
3734[Match]
3735Name=enp2s0
3736
3737[Network]
e5ff2245
YW
3738IPv6SendRA=yes
3739DHCPv6PrefixDelegation=yes</programlisting>
4c94a4c2 3740
e5ff2245
YW
3741 <para>This will enable DHCPv6-PD on the interface enp1s0 as an upstream interface where the
3742 DHCPv6 client is running and enp2s0 as a downstream interface where the prefix is delegated to.
3743 The delegated prefixes are distributed by IPv6 Router Advertisement on the downstream network.
3744 </para>
4c94a4c2 3745 </example>
3746
798d3a52 3747 <example>
9e35b3de 3748 <title>A bridge with two enslaved links</title>
f47c5c47 3749
9e35b3de
ZJS
3750 <programlisting># /etc/systemd/network/25-bridge-static.network
3751[Match]
f47c5c47 3752Name=bridge0
3753
3754[Network]
3755Address=192.168.0.15/24
3756Gateway=192.168.0.1
3757DNS=192.168.0.1</programlisting>
f47c5c47 3758
9e35b3de
ZJS
3759 <programlisting># /etc/systemd/network/25-bridge-slave-interface-1.network
3760[Match]
f47c5c47 3761Name=enp2s0
3762
3763[Network]
3764Bridge=bridge0</programlisting>
9e35b3de
ZJS
3765
3766 <programlisting># /etc/systemd/network/25-bridge-slave-interface-2.network
3767[Match]
3768Name=wlp3s0
3769
3770[Network]
3771Bridge=bridge0</programlisting>
3772
3773 <para>This creates a bridge and attaches devices <literal>enp2s0</literal> and
3774 <literal>wlp3s0</literal> to it. The bridge will have the specified static address
3775 and network assigned, and a default route via the specified gateway will be
3776 added. The specified DNS server will be added to the global list of DNS resolvers.
3777 </para>
13b498f9 3778 </example>
9e35b3de 3779
13b498f9 3780 <example>
9e35b3de 3781 <title></title>
13b498f9 3782
9e35b3de
ZJS
3783 <programlisting>
3784# /etc/systemd/network/20-bridge-slave-interface-vlan.network
3785[Match]
13b498f9
TJ
3786Name=enp2s0
3787
3788[Network]
3789Bridge=bridge0
3790
3791[BridgeVLAN]
3792VLAN=1-32
3793PVID=42
3794EgressUntagged=42
3795
3796[BridgeVLAN]
3797VLAN=100-200
3798
3799[BridgeVLAN]
3800EgressUntagged=300-400</programlisting>
0a8a0fad 3801
9e35b3de
ZJS
3802 <para>This overrides the configuration specified in the previous example for the
3803 interface <literal>enp2s0</literal>, and enables VLAN on that bridge port. VLAN IDs
3804 1-32, 42, 100-400 will be allowed. Packets tagged with VLAN IDs 42, 300-400 will be
3805 untagged when they leave on this interface. Untagged packets which arrive on this
3806 interface will be assigned VLAN ID 42.</para>
798d3a52 3807 </example>
0a8a0fad 3808
798d3a52 3809 <example>
9e35b3de 3810 <title>Various tunnels</title>
0a8a0fad 3811
9e35b3de
ZJS
3812 <programlisting>/etc/systemd/network/25-tunnels.network
3813[Match]
3814Name=ens1
0a8a0fad
TG
3815
3816[Network]
9e35b3de
ZJS
3817Tunnel=ipip-tun
3818Tunnel=sit-tun
3819Tunnel=gre-tun
3820Tunnel=vti-tun
3821 </programlisting>
3822
3823 <programlisting>/etc/systemd/network/25-tunnel-ipip.netdev
3824[NetDev]
3825Name=ipip-tun
3826Kind=ipip
3827 </programlisting>
3828
3829 <programlisting>/etc/systemd/network/25-tunnel-sit.netdev
3830[NetDev]
3831Name=sit-tun
3832Kind=sit
3833 </programlisting>
3834
3835 <programlisting>/etc/systemd/network/25-tunnel-gre.netdev
3836[NetDev]
3837Name=gre-tun
3838Kind=gre
3839 </programlisting>
3840
3841 <programlisting>/etc/systemd/network/25-tunnel-vti.netdev
3842[NetDev]
3843Name=vti-tun
3844Kind=vti
3845 </programlisting>
3846
3847 <para>This will bring interface <literal>ens1</literal> up and create an IPIP tunnel,
3848 a SIT tunnel, a GRE tunnel, and a VTI tunnel using it.</para>
798d3a52 3849 </example>
0a8a0fad 3850
798d3a52 3851 <example>
9e35b3de 3852 <title>A bond device</title>
0a8a0fad 3853
9e35b3de
ZJS
3854 <programlisting># /etc/systemd/network/30-bond1.network
3855[Match]
3856Name=bond1
0a8a0fad
TG
3857
3858[Network]
9e35b3de
ZJS
3859DHCP=ipv6
3860</programlisting>
0a8a0fad 3861
9e35b3de
ZJS
3862 <programlisting># /etc/systemd/network/30-bond1.netdev
3863[NetDev]
3864Name=bond1
3865Kind=bond
3866</programlisting>
0a8a0fad 3867
301a21a8 3868 <programlisting># /etc/systemd/network/30-bond1-dev1.network
9e35b3de
ZJS
3869[Match]
3870MACAddress=52:54:00:e9:64:41
0a8a0fad
TG
3871
3872[Network]
9e35b3de
ZJS
3873Bond=bond1
3874</programlisting>
d94facdc 3875
301a21a8 3876 <programlisting># /etc/systemd/network/30-bond1-dev2.network
9e35b3de
ZJS
3877[Match]
3878MACAddress=52:54:00:e9:64:42
d94facdc
MH
3879
3880[Network]
9e35b3de 3881Bond=bond1
6cb955c6 3882</programlisting>
9e35b3de
ZJS
3883
3884 <para>This will create a bond device <literal>bond1</literal> and enslave the two
3885 devices with MAC addresses 52:54:00:e9:64:41 and 52:54:00:e9:64:42 to it. IPv6 DHCP
3886 will be used to acquire an address.</para>
6cb955c6
AR
3887 </example>
3888
3889 <example>
9e35b3de
ZJS
3890 <title>Virtual Routing and Forwarding (VRF)</title>
3891 <para>Add the <literal>bond1</literal> interface to the VRF master interface
3892 <literal>vrf1</literal>. This will redirect routes generated on this interface to be
11d38b90
AR
3893 within the routing table defined during VRF creation. For kernels before 4.8 traffic
3894 won't be redirected towards the VRFs routing table unless specific ip-rules are added.
3895 </para>
9e35b3de
ZJS
3896 <programlisting># /etc/systemd/network/25-vrf.network
3897[Match]
6cb955c6
AR
3898Name=bond1
3899
3900[Network]
9e35b3de 3901VRF=vrf1
d94facdc
MH
3902</programlisting>
3903 </example>
3904
42125eda
SS
3905 <example>
3906 <title>MacVTap</title>
3907 <para>This brings up a network interface <literal>macvtap-test</literal>
3908 and attaches it to <literal>enp0s25</literal>.</para>
83ddf5d3 3909 <programlisting># /usr/lib/systemd/network/25-macvtap.network
42125eda
SS
3910[Match]
3911Name=enp0s25
3912
3913[Network]
3914MACVTAP=macvtap-test
3915</programlisting>
3916 </example>
98d20a17 3917
3918 <example>
3919 <title>A Xfrm interface with physical underlying device.</title>
3920
3921 <programlisting># /etc/systemd/network/27-xfrm.netdev
3922[NetDev]
3923Name=xfrm0
3924
3925[Xfrm]
3926InterfaceId=7</programlisting>
3927
3928 <programlisting># /etc/systemd/network/27-eth0.network
3929[Match]
3930Name=eth0
3931
3932[Network]
3933Xfrm=xfrm0</programlisting>
3934
3935 <para>This creates a <literal>xfrm0</literal> interface and binds it to the <literal>eth0</literal> device.
3936 This allows hardware based ipsec offloading to the <literal>eth0</literal> nic.
3937 If offloading is not needed, xfrm interfaces can be assigned to the <literal>lo</literal> device.
3938 </para>
3939 </example>
798d3a52
ZJS
3940 </refsect1>
3941
3942 <refsect1>
3943 <title>See Also</title>
3944 <para>
3945 <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
f41b446a 3946 <citerefentry><refentrytitle>systemd-networkd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
798d3a52 3947 <citerefentry><refentrytitle>systemd.link</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
aaa297d4
LP
3948 <citerefentry><refentrytitle>systemd.netdev</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
3949 <citerefentry><refentrytitle>systemd-resolved.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>
798d3a52
ZJS
3950 </para>
3951 </refsect1>
eac684ef
TG
3952
3953</refentry>