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