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