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