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