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