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