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