]> git.ipfire.org Git - thirdparty/systemd.git/blame - man/systemd.network.xml
network: change link group type to int32
[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>
883 <term><varname>Bond=</varname></term>
884 <term><varname>Bridge=</varname></term>
885 <term><varname>VRF=</varname></term>
886 <listitem>
887 <para>Takes a boolean value. When enabled, the current master interface index will not be
888 changed, and <varname>BatmanAdvanced=</varname>, <varname>Bond=</varname>,
889 <varname>Bridge=</varname>, and <varname>VRF=</varname> settings are ignored. This may be
890 useful when a netdev with a master interface is created by another program, e.g.
891 <citerefentry><refentrytitle>systemd-nspawn</refentrytitle><manvolnum>1</manvolnum></citerefentry>.
892 Defaults to false.</para>
893 </listitem>
894 </varlistentry>
798d3a52 895 <varlistentry>
85bc4c08 896 <term><varname>BatmanAdvanced=</varname></term>
798d3a52 897 <term><varname>Bond=</varname></term>
85bc4c08 898 <term><varname>Bridge=</varname></term>
6cb955c6
AR
899 <term><varname>VRF=</varname></term>
900 <listitem>
85bc4c08
YW
901 <para>The name of the B.A.T.M.A.N. Advanced, bond, bridge, or VRF interface to add the link
902 to. See
9e35b3de
ZJS
903 <citerefentry><refentrytitle>systemd.netdev</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
904 </para>
6cb955c6
AR
905 </listitem>
906 </varlistentry>
2479c4fe 907 <varlistentry>
908 <term><varname>IPVLAN=</varname></term>
c3006a48
YW
909 <term><varname>IPVTAP=</varname></term>
910 <term><varname>L2TP=</varname></term>
85bc4c08 911 <term><varname>MACsec=</varname></term>
798d3a52 912 <term><varname>MACVLAN=</varname></term>
c3006a48 913 <term><varname>MACVTAP=</varname></term>
798d3a52 914 <term><varname>Tunnel=</varname></term>
85bc4c08
YW
915 <term><varname>VLAN=</varname></term>
916 <term><varname>VXLAN=</varname></term>
c3006a48 917 <term><varname>Xfrm=</varname></term>
798d3a52 918 <listitem>
387f6955 919 <para>The name of an IPVLAN, IPVTAP, L2TP, MACsec, MACVLAN, MACVTAP, tunnel, VLAN, VXLAN, or
c3006a48 920 Xfrm to be created on the link. See
81962db7
SS
921 <citerefentry><refentrytitle>systemd.netdev</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
922 This option may be specified more than once.</para>
923 </listitem>
924 </varlistentry>
dd5f3175
SS
925 <varlistentry>
926 <term><varname>ActiveSlave=</varname></term>
927 <listitem>
9b6ffef3 928 <para>Takes a boolean. Specifies the new active slave. The <literal>ActiveSlave=</literal>
dd5f3175
SS
929 option is only valid for following modes:
930 <literal>active-backup</literal>,
931 <literal>balance-alb</literal> and
932 <literal>balance-tlb</literal>. Defaults to false.
933 </para>
934 </listitem>
935 </varlistentry>
936 <varlistentry>
937 <term><varname>PrimarySlave=</varname></term>
938 <listitem>
9b6ffef3 939 <para>Takes a boolean. Specifies which slave is the primary device. The specified
dd5f3175
SS
940 device will always be the active slave while it is available. Only when the
941 primary is off-line will alternate devices be used. This is useful when
942 one slave is preferred over another, e.g. when one slave has higher throughput
943 than another. The <literal>PrimarySlave=</literal> option is only valid for
944 following modes:
945 <literal>active-backup</literal>,
946 <literal>balance-alb</literal> and
947 <literal>balance-tlb</literal>. Defaults to false.
948 </para>
949 </listitem>
950 </varlistentry>
dad2d78e
SS
951 <varlistentry>
952 <term><varname>ConfigureWithoutCarrier=</varname></term>
953 <listitem>
9b6ffef3 954 <para>Takes a boolean. Allows networkd to configure a specific link even if it has no carrier.
bd0d471c
DS
955 Defaults to false. If <option>IgnoreCarrierLoss=</option> is not explicitly set, it will
956 default to this value.
dad2d78e
SS
957 </para>
958 </listitem>
959 </varlistentry>
93b4dab5
SS
960 <varlistentry>
961 <term><varname>IgnoreCarrierLoss=</varname></term>
962 <listitem>
bd0d471c
DS
963 <para>Takes a boolean. Allows networkd to retain both the static and dynamic configuration
964 of the interface even if its carrier is lost. When unset, the value specified with
965 <option>ConfigureWithoutCarrier=</option> is used.
93b4dab5 966 </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>
d7d1d18f
SS
1285 <varlistentry>
1286 <term><varname>Type=</varname></term>
1287 <listitem>
1288 <para>Specifies Routing Policy Database (RPDB) rule type. Takes one of <literal>blackhole</literal>,
1289 <literal>unreachable</literal> or <literal>prohibit</literal>.
1290 </para>
1291 </listitem>
1292 </varlistentry>
bce67bbe 1293 </variablelist>
c16c7808
SS
1294 </refsect1>
1295
1296 <refsect1>
1297 <title>[NextHop] Section Options</title>
e9dd6984
ZJS
1298 <para>The [NextHop] section is used to manipulate entries in the kernel's "nexthop" tables. The
1299 [NextHop] section accepts the following keys. Specify several [NextHop] sections to configure several
1300 hops.</para>
c16c7808
SS
1301
1302 <variablelist class='network-directives'>
26ff4505
YW
1303 <varlistentry>
1304 <term><varname>Id=</varname></term>
1305 <listitem>
1306 <para>The id of the next hop. Takes an unsigned integer in the range 1…4294967295. If left
1307 unspecified, then automatically chosen by kernel.</para>
1308 </listitem>
1309 </varlistentry>
c16c7808
SS
1310 <varlistentry>
1311 <term><varname>Gateway=</varname></term>
1312 <listitem>
26ff4505 1313 <para>As in the [Network] section.</para>
c16c7808
SS
1314 </listitem>
1315 </varlistentry>
1316 <varlistentry>
26ff4505 1317 <term><varname>Family=</varname></term>
c16c7808 1318 <listitem>
26ff4505
YW
1319 <para>Takes one of the special values <literal>ipv4</literal> or <literal>ipv6</literal>.
1320 By default, the family is determined by the address specified in
1321 <varname>Gateway=</varname>. If <varname>Gateway=</varname> is not specified, then defaults
1322 to <literal>ipv4</literal>.</para>
c16c7808
SS
1323 </listitem>
1324 </varlistentry>
2ddd52d1
YW
1325 <varlistentry>
1326 <term><varname>OnLink=</varname></term>
1327 <listitem>
1328 <para>Takes a boolean. If set to true, the kernel does not have to check if the gateway is
1329 reachable directly by the current machine (i.e., attached to the local network), so that we
1330 can insert the nexthop in the kernel table without it being complained about. Defaults to
1331 <literal>no</literal>.</para>
1332 </listitem>
1333 </varlistentry>
30f10837
YW
1334 <varlistentry>
1335 <term><varname>Blackhole=</varname></term>
1336 <listitem>
1337 <para>Takes a boolean. If enabled, packets to the corresponding routes are discarded
1338 silently, and <varname>Gateway=</varname> cannot be specified. Defaults to
1339 <literal>no</literal>.</para>
1340 </listitem>
1341 </varlistentry>
228c3e21
YW
1342 <varlistentry>
1343 <term><varname>Group=</varname></term>
1344 <listitem>
1345 <para>Takes a whitespace separated list of nexthop IDs. Each ID must be in the range
1346 1…4294967295. Optionally, each nexthop ID can take a weight after a colon
1347 (<literal><replaceable>id</replaceable><optional>:<replaceable>weight</replaceable></optional></literal>).
1348 The weight must be in the range 1…255. If the weight is not specified, then it is assumed
1349 that the weight is 1. This setting cannot be specified with <varname>Gateway=</varname>,
1350 <varname>Family=</varname>, <varname>Blackhole=</varname>. This setting can be specified
1351 multiple times. If an empty string is assigned, then the all previous assignments are
1352 cleared. Defaults to unset.</para>
1353 </listitem>
1354 </varlistentry>
c16c7808 1355 </variablelist>
bce67bbe
SS
1356 </refsect1>
1357
798d3a52
ZJS
1358 <refsect1>
1359 <title>[Route] Section Options</title>
bdac5608
ZJS
1360 <para>The [Route] section accepts the following keys. Specify several [Route] sections to configure
1361 several routes.</para>
798d3a52
ZJS
1362
1363 <variablelist class='network-directives'>
1364 <varlistentry>
1365 <term><varname>Gateway=</varname></term>
1366 <listitem>
d306d1d0 1367 <para>Takes the gateway address or the special values <literal>_dhcp4</literal> and
b8caa4ef
YW
1368 <literal>_ipv6ra</literal>. If <literal>_dhcp4</literal> or <literal>_ipv6ra</literal> is
1369 set, then the gateway address provided by DHCPv4 or IPv6 RA is used.</para>
798d3a52
ZJS
1370 </listitem>
1371 </varlistentry>
ccb4072e
YW
1372 <varlistentry>
1373 <term><varname>GatewayOnLink=</varname></term>
1374 <listitem>
1375 <para>Takes a boolean. If set to true, the kernel does not have to check if the gateway is
2ddd52d1
YW
1376 reachable directly by the current machine (i.e., attached to the local network), so that we
1377 can insert the route in the kernel table without it being complained about. Defaults to
1378 <literal>no</literal>.</para>
ccb4072e
YW
1379 </listitem>
1380 </varlistentry>
798d3a52
ZJS
1381 <varlistentry>
1382 <term><varname>Destination=</varname></term>
1383 <listitem>
1384 <para>The destination prefix of the route. Possibly
b938cb90 1385 followed by a slash and the prefix length. If omitted, a
798d3a52
ZJS
1386 full-length host route is assumed.</para>
1387 </listitem>
1388 </varlistentry>
1389 <varlistentry>
1390 <term><varname>Source=</varname></term>
1391 <listitem>
1392 <para>The source prefix of the route. Possibly followed by
b938cb90 1393 a slash and the prefix length. If omitted, a full-length
798d3a52
ZJS
1394 host route is assumed.</para>
1395 </listitem>
1396 </varlistentry>
1397 <varlistentry>
1398 <term><varname>Metric=</varname></term>
1399 <listitem>
4c0aae01 1400 <para>The metric of the route. Takes an unsigned integer in the range 0…4294967295.
be0d27ee 1401 Defaults to unset, and the kernel's default will be used.</para>
798d3a52
ZJS
1402 </listitem>
1403 </varlistentry>
b5bf6f64
SS
1404 <varlistentry>
1405 <term><varname>IPv6Preference=</varname></term>
1406 <listitem>
1407 <para>Specifies the route preference as defined in <ulink
e9dd6984
ZJS
1408 url="https://tools.ietf.org/html/rfc4191">RFC 4191</ulink> for Router Discovery messages. Which
1409 can be one of <literal>low</literal> the route has a lowest priority, <literal>medium</literal>
1410 the route has a default priority or <literal>high</literal> the route has a highest priority.
1411 </para>
b5bf6f64
SS
1412 </listitem>
1413 </varlistentry>
769b56a3
TG
1414 <varlistentry>
1415 <term><varname>Scope=</varname></term>
1416 <listitem>
e64652f7
AN
1417 <para>The scope of the IPv4 route, which can be <literal>global</literal>, <literal>site</literal>,
1418 <literal>link</literal>, <literal>host</literal>, or
1419 <literal>nowhere</literal>:</para>
1420 <itemizedlist>
1421 <listitem><para><literal>global</literal> means the route can reach
1422 hosts more than one hop away.</para></listitem>
1423
1424 <listitem><para><literal>site</literal> means an interior route in
1425 the local autonomous system.</para></listitem>
1426
1427 <listitem><para><literal>link</literal> means the route can only
1428 reach hosts on the local network (one hop away).</para></listitem>
1429
1430 <listitem><para><literal>host</literal> means the route will not
1431 leave the local machine (used for internal addresses like
1432 127.0.0.1).</para></listitem>
1433
1434 <listitem><para><literal>nowhere</literal> means the destination
1435 doesn't exist.</para></listitem>
1436 </itemizedlist>
1437 <para>For IPv4 route, defaults to <literal>host</literal> if <varname>Type=</varname> is
1438 <literal>local</literal> or <literal>nat</literal>,
1439 and <literal>link</literal> if <varname>Type=</varname> is
f5c38922 1440 <literal>broadcast</literal>, <literal>multicast</literal>, or <literal>anycast</literal>.
e64652f7
AN
1441 In other cases, defaults to <literal>global</literal>. The value is
1442 not used for IPv6.</para>
769b56a3 1443 </listitem>
0d07e595
JK
1444 </varlistentry>
1445 <varlistentry>
1446 <term><varname>PreferredSource=</varname></term>
1447 <listitem>
1448 <para>The preferred source address of the route. The address
1449 must be in the format described in
1450 <citerefentry project='man-pages'><refentrytitle>inet_pton</refentrytitle><manvolnum>3</manvolnum></citerefentry>.</para>
1451 </listitem>
769b56a3 1452 </varlistentry>
c953b24c 1453 <varlistentry>
f5c38922 1454 <term><varname>Table=</varname></term>
c953b24c 1455 <listitem>
c038ce46
SS
1456 <para>The table identifier for the route. Takes one of predefined names <literal>default</literal>, <literal>main</literal>,
1457 and <literal>local</literal>, and names defined in <varname>RouteTable=</varname> in <citerefentry><refentrytitle>networkd.conf</refentrytitle>
1458 <manvolnum>5</manvolnum></citerefentry>, or a number between 1 and 4294967295. The table can be retrieved using
1459 <command>ip route show table <replaceable>num</replaceable></command>. If unset and <varname>Type=</varname> is <literal>local</literal>,
1460 <literal>broadcast</literal>, <literal>anycast</literal>, or <literal>nat</literal>, then <literal>local</literal> is used.
f5c38922 1461 In other cases, defaults to <literal>main</literal>.
c953b24c
SS
1462 </para>
1463 </listitem>
1464 </varlistentry>
c83ecc04
SS
1465 <varlistentry>
1466 <term><varname>Protocol=</varname></term>
1467 <listitem>
88925d2f 1468 <para>The protocol identifier for the route. Takes a number between 0 and 255 or the special values
ca420b62
YW
1469 <literal>kernel</literal>, <literal>boot</literal>, <literal>static</literal>,
1470 <literal>ra</literal> and <literal>dhcp</literal>. Defaults to <literal>static</literal>.
c83ecc04
SS
1471 </para>
1472 </listitem>
1473 </varlistentry>
983226f3
SS
1474 <varlistentry>
1475 <term><varname>Type=</varname></term>
1476 <listitem>
94d6e299
YW
1477 <para>Specifies the type for the route. Takes one of <literal>unicast</literal>,
1478 <literal>local</literal>, <literal>broadcast</literal>, <literal>anycast</literal>,
1479 <literal>multicast</literal>, <literal>blackhole</literal>, <literal>unreachable</literal>,
1480 <literal>prohibit</literal>, <literal>throw</literal>, <literal>nat</literal>, and
1481 <literal>xresolve</literal>. If <literal>unicast</literal>, a regular route is defined, i.e. a
66d7235e
LP
1482 route indicating the path to take to a destination network address. If <literal>blackhole</literal>, packets
1483 to the defined route are discarded silently. If <literal>unreachable</literal>, packets to the defined route
1484 are discarded and the ICMP message "Host Unreachable" is generated. If <literal>prohibit</literal>, packets
1485 to the defined route are discarded and the ICMP message "Communication Administratively Prohibited" is
1486 generated. If <literal>throw</literal>, route lookup in the current routing table will fail and the route
1487 selection process will return to Routing Policy Database (RPDB). Defaults to <literal>unicast</literal>.
983226f3
SS
1488 </para>
1489 </listitem>
1490 </varlistentry>
323d9329
SS
1491 <varlistentry>
1492 <term><varname>InitialCongestionWindow=</varname></term>
1493 <listitem>
3cb7af5b
YW
1494 <para>The TCP initial congestion window is used during the start of a TCP connection.
1495 During the start of a TCP session, when a client requests a resource, the server's initial
1496 congestion window determines how many packets will be sent during the initial burst of data
1497 without waiting for acknowledgement. Takes a number between 1 and 1023. Note that 100 is
1498 considered an extremely large value for this option. When unset, the kernel's default
1499 (typically 10) will be used.</para>
323d9329
SS
1500 </listitem>
1501 </varlistentry>
1502 <varlistentry>
1503 <term><varname>InitialAdvertisedReceiveWindow=</varname></term>
1504 <listitem>
3cb7af5b
YW
1505 <para>The TCP initial advertised receive window is the amount of receive data (in bytes)
1506 that can initially be buffered at one time on a connection. The sending host can send only
1507 that amount of data before waiting for an acknowledgment and window update from the
1508 receiving host. Takes a number between 1 and 1023. Note that 100 is considered an extremely
1509 large value for this option. When unset, the kernel's default will be used.</para>
323d9329
SS
1510 </listitem>
1511 </varlistentry>
09f5dfad
SS
1512 <varlistentry>
1513 <term><varname>QuickAck=</varname></term>
1514 <listitem>
9b6ffef3 1515 <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
1516 </para>
1517 </listitem>
1518 </varlistentry>
633c7258
SS
1519 <varlistentry>
1520 <term><varname>FastOpenNoCookie=</varname></term>
1521 <listitem>
1522 <para>Takes a boolean. When true enables TCP fastopen without a cookie on a per-route basis.
1523 When unset, the kernel's default will be used.
1524 </para>
1525 </listitem>
09f5dfad 1526 </varlistentry>
9b88f20a
SS
1527 <varlistentry>
1528 <term><varname>TTLPropagate=</varname></term>
1529 <listitem>
1530 <para>Takes a boolean. When true enables TTL propagation at Label Switched Path (LSP) egress.
1531 When unset, the kernel's default will be used.
1532 </para>
1533 </listitem>
1534 </varlistentry>
cea79e66
SS
1535 <varlistentry>
1536 <term><varname>MTUBytes=</varname></term>
1537 <listitem>
1538 <para>The maximum transmission unit in bytes to set for the
1539 route. The usual suffixes K, M, G, are supported and are
1540 understood to the base of 1024.</para>
1541 <para>Note that if IPv6 is enabled on the interface, and the MTU is chosen
1542 below 1280 (the minimum MTU for IPv6) it will automatically be increased to this value.</para>
1543 </listitem>
afe42aef
SC
1544 </varlistentry>
1545 <varlistentry>
1546 <term><varname>IPServiceType=</varname></term>
1547 <listitem>
e681a2ee
YW
1548 <para>Takes string; <literal>CS6</literal> or <literal>CS4</literal>. Used to set IP
1549 service type to CS6 (network control) or CS4 (Realtime). Defaults to CS6.</para>
afe42aef
SC
1550 </listitem>
1551 </varlistentry>
007cac09
SS
1552 <varlistentry>
1553 <term><varname>TCPAdvertisedMaximumSegmentSize=</varname></term>
1554 <listitem>
1555 <para>Specifies the Path MSS (in bytes) hints given on TCP layer. The usual suffixes K, M, G, are
69978eb9 1556 supported and are understood to the base of 1024. An unsigned integer in the range 1…4294967294.
007cac09
SS
1557 When unset, the kernel's default will be used.</para>
1558 </listitem>
1559 </varlistentry>
6ff5cc6b
YW
1560 <varlistentry>
1561 <term><varname>MultiPathRoute=<replaceable>address</replaceable>[@<replaceable>name</replaceable>] [<replaceable>weight</replaceable>]</varname></term>
1562 <listitem>
1563 <para>Configures multipath route. Multipath routing is the technique of using multiple
1564 alternative paths through a network. Takes gateway address. Optionally, takes a network
1565 interface name or index separated with <literal>@</literal>, and a weight in 1..256 for
1566 this multipath route separated with whitespace. This setting can be specified multiple
1567 times. If an empty string is assigned, then the all previous assignments are cleared.</para>
1568 </listitem>
1569 </varlistentry>
324e3422
YW
1570 <varlistentry>
1571 <term><varname>NextHop=</varname></term>
1572 <listitem>
1573 <para>Specifies the nexthop id. Takes an unsigned integer in the range 1…4294967295.
1574 If set, the corresponding [NextHop] section must be configured. Defaults to unset.</para>
1575 </listitem>
1576 </varlistentry>
798d3a52
ZJS
1577 </variablelist>
1578 </refsect1>
1579
1580 <refsect1>
4f7331a8 1581 <title>[DHCPv4] Section Options</title>
bdac5608 1582 <para>The [DHCPv4] section configures the DHCPv4 client, if it is enabled with the
ad943783 1583 <varname>DHCP=</varname> setting described above:</para>
798d3a52
ZJS
1584
1585 <variablelist class='network-directives'>
c3696a91
ZJS
1586
1587 <!-- DHCP packet contents -->
1588
798d3a52 1589 <varlistentry>
c3696a91 1590 <term><varname>SendHostname=</varname></term>
798d3a52 1591 <listitem>
6c55cefe 1592 <para>When true (the default), the machine's hostname (or the value specified with
be0d27ee
ZJS
1593 <varname>Hostname=</varname>, described below) will be sent to the DHCP server. Note that the
1594 hostname must consist only of 7-bit ASCII lower-case characters and no spaces or dots, and be
1595 formatted as a valid DNS domain name. Otherwise, the hostname is not sent even if this option is
1596 true.</para>
c3696a91
ZJS
1597 </listitem>
1598 </varlistentry>
e88d8021 1599
c3696a91
ZJS
1600 <varlistentry>
1601 <term><varname>Hostname=</varname></term>
1602 <listitem>
1603 <para>Use this value for the hostname which is sent to the DHCP server, instead of machine's hostname.
1604 Note that the specified hostname must consist only of 7-bit ASCII lower-case characters and
1605 no spaces or dots, and be formatted as a valid DNS domain name.</para>
798d3a52
ZJS
1606 </listitem>
1607 </varlistentry>
c3696a91 1608
a24e12f0 1609 <varlistentry>
c3696a91 1610 <term><varname>MUDURL=</varname></term>
a24e12f0 1611 <listitem>
c3696a91
ZJS
1612 <para>When configured, the specified Manufacturer Usage Description (MUD) URL will be sent to the
1613 DHCPv4 server. Takes a URL of length up to 255 characters. A superficial verification that the
1614 string is a valid URL will be performed. DHCPv4 clients are intended to have at most one MUD URL
1615 associated with them. See <ulink url="https://tools.ietf.org/html/rfc8520">RFC 8520</ulink>.
1616 </para>
1617
1618 <para>MUD is an embedded software standard defined by the IETF that allows IoT device makers to
1619 advertise device specifications, including the intended communication patterns for their device
1620 when it connects to the network. The network can then use this to author a context-specific
1621 access policy, so the device functions only within those parameters.</para>
a24e12f0
YW
1622 </listitem>
1623 </varlistentry>
c3696a91 1624
301f4073 1625 <varlistentry>
c3696a91 1626 <term><varname>ClientIdentifier=</varname></term>
301f4073 1627 <listitem>
c3696a91
ZJS
1628 <para>The DHCPv4 client identifier to use. Takes one of <option>mac</option>,
1629 <option>duid</option> or <option>duid-only</option>. If set to <option>mac</option>, the
1630 MAC address of the link is used. If set to <option>duid</option>, an RFC4361-compliant Client
1631 ID, which is the combination of IAID and DUID (see below), is used. If set to
1632 <option>duid-only</option>, only DUID is used, this may not be RFC compliant, but some setups
1633 may require to use this. Defaults to <option>duid</option>.</para>
301f4073
MM
1634 </listitem>
1635 </varlistentry>
c3696a91 1636
d7b04506 1637 <varlistentry>
c3696a91 1638 <term><varname>VendorClassIdentifier=</varname></term>
d7b04506 1639 <listitem>
c3696a91
ZJS
1640 <para>The vendor class identifier used to identify vendor
1641 type and configuration.</para>
d7b04506
YW
1642 </listitem>
1643 </varlistentry>
c3696a91 1644
299d578f 1645 <varlistentry>
c3696a91 1646 <term><varname>UserClass=</varname></term>
299d578f 1647 <listitem>
c3696a91
ZJS
1648 <para>A DHCPv4 client can use UserClass option to identify the type or category of user or
1649 applications it represents. The information contained in this option is a string that represents
1650 the user class of which the client is a member. Each class sets an identifying string of
1651 information to be used by the DHCP service to classify clients. Takes a whitespace-separated list
1652 of strings.</para>
299d578f
SS
1653 </listitem>
1654 </varlistentry>
284e8fd0 1655
798d3a52 1656 <varlistentry>
c3696a91
ZJS
1657 <term><varname>DUIDType=</varname></term>
1658 <listitem>
1659 <para>Override the global <varname>DUIDType=</varname> setting for this network. See
1660 <citerefentry><refentrytitle>networkd.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>
1661 for a description of possible values.</para>
1662 </listitem>
1663 </varlistentry>
1664
1665 <varlistentry>
1666 <term><varname>DUIDRawData=</varname></term>
1667 <listitem>
1668 <para>Override the global <varname>DUIDRawData=</varname> setting for this network. See
1669 <citerefentry><refentrytitle>networkd.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>
1670 for a description of possible values.</para>
1671 </listitem>
1672 </varlistentry>
1673
1674 <varlistentry>
1675 <term><varname>IAID=</varname></term>
798d3a52 1676 <listitem>
c3696a91
ZJS
1677 <para>The DHCP Identity Association Identifier (IAID) for the interface, a 32-bit unsigned
1678 integer.</para>
798d3a52
ZJS
1679 </listitem>
1680 </varlistentry>
c3696a91 1681
7585baa0 1682 <varlistentry>
1683 <term><varname>Anonymize=</varname></term>
1684 <listitem>
86d58c86
YW
1685 <para>Takes a boolean. When true, the options sent to the DHCP server will follow the
1686 <ulink url="https://tools.ietf.org/html/rfc7844">RFC 7844</ulink> (Anonymity Profiles for
1687 DHCP Clients) to minimize disclosure of identifying information. Defaults to false.</para>
1688
1689 <para>This option should only be set to true when <varname>MACAddressPolicy=</varname> is
c3696a91 1690 set to <option>random</option> (see
d3a047b9 1691 <citerefentry><refentrytitle>systemd.link</refentrytitle><manvolnum>5</manvolnum></citerefentry>).
86d58c86
YW
1692 </para>
1693
1694 <para>When true, <varname>SendHostname=</varname>, <varname>ClientIdentifier=</varname>,
1695 <varname>VendorClassIdentifier=</varname>, <varname>UserClass=</varname>,
1696 <varname>RequestOptions=</varname>, <varname>SendOption=</varname>,
1697 <varname>SendVendorOption=</varname>, and <varname>MUDURL=</varname> are ignored.</para>
7585baa0 1698
86d58c86
YW
1699 <para>With this option enabled DHCP requests will mimic those generated by Microsoft
1700 Windows, in order to reduce the ability to fingerprint and recognize installations. This
1701 means DHCP request sizes will grow and lease data will be more comprehensive than normally,
1702 though most of the requested data is not actually used.</para>
7585baa0 1703 </listitem>
1704 </varlistentry>
7b8d23a9
SS
1705
1706 <varlistentry>
c3696a91 1707 <term><varname>RequestOptions=</varname></term>
7b8d23a9 1708 <listitem>
c3696a91
ZJS
1709 <para>Sets request options to be sent to the server in the DHCPv4 request options list. A
1710 whitespace-separated list of integers in the range 1…254. Defaults to unset.</para>
7b8d23a9
SS
1711 </listitem>
1712 </varlistentry>
1713
798d3a52 1714 <varlistentry>
c3696a91 1715 <term><varname>SendOption=</varname></term>
798d3a52 1716 <listitem>
c3696a91
ZJS
1717 <para>Send an arbitrary raw option in the DHCPv4 request. Takes a DHCP option number, data type
1718 and data separated with a colon
1719 (<literal><replaceable>option</replaceable>:<replaceable>type</replaceable>:<replaceable>value</replaceable></literal>).
1720 The option number must be an integer in the range 1…254. The type takes one of
1721 <literal>uint8</literal>, <literal>uint16</literal>, <literal>uint32</literal>,
1722 <literal>ipv4address</literal>, or <literal>string</literal>. Special characters in the data
1723 string may be escaped using <ulink
1724 url="https://en.wikipedia.org/wiki/Escape_sequences_in_C#Table_of_escape_sequences">C-style
1725 escapes</ulink>. This setting can be specified multiple times. If an empty string is specified,
1726 then all options specified earlier are cleared. Defaults to unset.</para>
798d3a52
ZJS
1727 </listitem>
1728 </varlistentry>
c3696a91 1729
1adc5d0b 1730 <varlistentry>
c3696a91 1731 <term><varname>SendVendorOption=</varname></term>
31ee3973 1732 <listitem>
c3696a91
ZJS
1733 <para>Send an arbitrary vendor option in the DHCPv4 request. Takes a DHCP option number, data
1734 type and data separated with a colon
1735 (<literal><replaceable>option</replaceable>:<replaceable>type</replaceable>:<replaceable>value</replaceable></literal>).
1736 The option number must be an integer in the range 1…254. The type takes one of
1737 <literal>uint8</literal>, <literal>uint16</literal>, <literal>uint32</literal>,
1738 <literal>ipv4address</literal>, or <literal>string</literal>. Special characters in the data
1739 string may be escaped using <ulink
1740 url="https://en.wikipedia.org/wiki/Escape_sequences_in_C#Table_of_escape_sequences">C-style
1741 escapes</ulink>. This setting can be specified multiple times. If an empty string is specified,
1742 then all options specified earlier are cleared. Defaults to unset.</para>
31ee3973
YW
1743 </listitem>
1744 </varlistentry>
b2a81c0b 1745
c3696a91 1746 <!-- How to use the DHCP lease -->
b2a81c0b 1747
d419ef02
MR
1748 <varlistentry>
1749 <term><varname>Label=</varname></term>
1750 <listitem>
1751 <para>Specifies the label for the IPv4 address received from the DHCP server.
1752 The label must be a 7-bit ASCII string with a length of 1…15 characters.
1753 Defaults to unset.</para>
1754 </listitem>
1755 </varlistentry>
1756
798d3a52 1757 <varlistentry>
c3696a91 1758 <term><varname>UseDNS=</varname></term>
b4531227 1759 <listitem>
c3696a91
ZJS
1760 <para>When true (the default), the DNS servers received from the DHCP server will be used.</para>
1761
1762 <para>This corresponds to the <option>nameserver</option>
1763 option in <citerefentry
1764 project='man-pages'><refentrytitle>resolv.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para>
b4531227
YW
1765 </listitem>
1766 </varlistentry>
ad943783 1767
3e43b2cd 1768 <varlistentry>
c3696a91 1769 <term><varname>RoutesToDNS=</varname></term>
3e43b2cd 1770 <listitem>
c3696a91
ZJS
1771 <para>When true, the routes to the DNS servers received from the DHCP server will be
1772 configured. When <varname>UseDNS=</varname> is disabled, this setting is ignored.
1773 Defaults to true.</para>
3e43b2cd
JJ
1774 </listitem>
1775 </varlistentry>
e2e08e77 1776
798d3a52 1777 <varlistentry>
c3696a91 1778 <term><varname>UseNTP=</varname></term>
798d3a52 1779 <listitem>
c3696a91
ZJS
1780 <para>When true (the default), the NTP servers received from the DHCP server will be used by
1781 <filename>systemd-timesyncd.service</filename>.</para>
798d3a52
ZJS
1782 </listitem>
1783 </varlistentry>
076ea6f6 1784
af1c0de0 1785 <varlistentry>
c3696a91 1786 <term><varname>RoutesToNTP=</varname></term>
af1c0de0 1787 <listitem>
c3696a91
ZJS
1788 <para>When true, the routes to the NTP servers received from the DHCP server will be
1789 configured. When <varname>UseNTP=</varname> is disabled, this setting is ignored.
1790 Defaults to true.</para>
af1c0de0
SS
1791 </listitem>
1792 </varlistentry>
1793
715cedfb 1794 <varlistentry>
c3696a91 1795 <term><varname>UseSIP=</varname></term>
715cedfb 1796 <listitem>
c3696a91
ZJS
1797 <para>When true (the default), the SIP servers received from the DHCP server will be collected
1798 and made available to client programs.</para>
715cedfb
SS
1799 </listitem>
1800 </varlistentry>
1801
e2e08e77 1802 <varlistentry>
c3696a91 1803 <term><varname>UseMTU=</varname></term>
e2e08e77 1804 <listitem>
c3696a91
ZJS
1805 <para>When true, the interface maximum transmission unit from the DHCP server will be used on the
1806 current link. If <varname>MTUBytes=</varname> is set, then this setting is ignored. Defaults to
1807 false.</para>
e2e08e77
ZJS
1808 </listitem>
1809 </varlistentry>
076ea6f6 1810
e2e08e77 1811 <varlistentry>
c3696a91 1812 <term><varname>UseHostname=</varname></term>
e2e08e77 1813 <listitem>
c3696a91
ZJS
1814 <para>When true (the default), the hostname received from the DHCP server will be set as the
1815 transient hostname of the system.</para>
076ea6f6
LP
1816 </listitem>
1817 </varlistentry>
e2e08e77 1818
d05def16 1819 <varlistentry>
c3696a91 1820 <term><varname>UseDomains=</varname></term>
d05def16 1821 <listitem>
c3696a91
ZJS
1822 <para>Takes a boolean, or the special value <option>route</option>. When true, the domain name
1823 received from the DHCP server will be used as DNS search domain over this link, similar to the
1824 effect of the <option>Domains=</option> setting. If set to <option>route</option>, the domain
1825 name received from the DHCP server will be used for routing DNS queries only, but not for
1826 searching, similar to the effect of the <option>Domains=</option> setting when the argument is
1827 prefixed with <literal>~</literal>. Defaults to false.</para>
1828
1829 <para>It is recommended to enable this option only on trusted networks, as setting this affects
1830 resolution of all hostnames, in particular of single-label names. It is generally safer to use
1831 the supplied domain only as routing domain, rather than as search domain, in order to not have it
1832 affect local resolution of single-label names.</para>
1833
1834 <para>When set to true, this setting corresponds to the <option>domain</option> option in
1835 <citerefentry project='man-pages'><refentrytitle>resolv.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
1836 </para>
d05def16
LP
1837 </listitem>
1838 </varlistentry>
1839
798d3a52 1840 <varlistentry>
c3696a91 1841 <term><varname>UseRoutes=</varname></term>
798d3a52 1842 <listitem>
c3696a91
ZJS
1843 <para>When true (the default), the static routes will be requested from the DHCP server and added
1844 to the routing table with a metric of 1024, and a scope of <option>global</option>,
1845 <option>link</option> or <option>host</option>, depending on the route's destination and
1846 gateway. If the destination is on the local host, e.g., 127.x.x.x, or the same as the link's own
1847 address, the scope will be set to <option>host</option>. Otherwise if the gateway is null (a
1848 direct route), a <option>link</option> scope will be used. For anything else, scope defaults to
1849 <option>global</option>.</para>
798d3a52
ZJS
1850 </listitem>
1851 </varlistentry>
e2e08e77 1852
798d3a52
ZJS
1853 <varlistentry>
1854 <term><varname>RouteMetric=</varname></term>
1855 <listitem>
5cf9069f
TY
1856 <para>Set the routing metric for routes specified by the DHCP server (including the prefix
1857 route added for the specified prefix). Takes an unsigned integer in the range 0…4294967295.
1858 Defaults to 1024.</para>
798d3a52
ZJS
1859 </listitem>
1860 </varlistentry>
f594276b
JK
1861
1862 <varlistentry>
1863 <term><varname>RouteTable=<replaceable>num</replaceable></varname></term>
1864 <listitem>
d11e656a 1865 <para>The table identifier for DHCP routes (a number between 1 and 4294967295, or 0 to unset).
f594276b
JK
1866 The table can be retrieved using <command>ip route show table <replaceable>num</replaceable></command>.
1867 </para>
e9dd6984
ZJS
1868 <para>When used in combination with <varname>VRF=</varname>, the
1869 VRF's routing table is used when this parameter is not specified.
917b2260 1870 </para>
f594276b
JK
1871 </listitem>
1872 </varlistentry>
9faed222 1873
c695dcf9
SS
1874 <varlistentry>
1875 <term><varname>RouteMTUBytes=</varname></term>
1876 <listitem>
1877 <para>Specifies the MTU for the DHCP routes. Please see the [Route] section for further details.</para>
1878 </listitem>
1879 </varlistentry>
1880
9faed222 1881 <varlistentry>
c3696a91 1882 <term><varname>UseGateway=</varname></term>
9faed222 1883 <listitem>
c3696a91
ZJS
1884 <para>When true, the gateway will be requested from the DHCP server and added to the routing
1885 table with a metric of 1024, and a scope of <option>link</option>. When unset, the value specified
1886 with <varname>UseRoutes=</varname> is used.</para>
9faed222
SS
1887 </listitem>
1888 </varlistentry>
fb5c8216 1889
c3696a91
ZJS
1890 <varlistentry>
1891 <term><varname>UseTimezone=</varname></term>
1892 <listitem><para>When true, the timezone received from the DHCP server will be set as timezone of
1893 the local system. Defaults to false.</para></listitem>
1894 </varlistentry>
1895
1896 <varlistentry>
d6463307
SS
1897 <term><varname>FallbackLeaseLifetimeSec=</varname></term>
1898 <listitem>
1899 <para>Allows to set DHCPv4 lease lifetime when DHCPv4 server does not send the lease lifetime.
be0d27ee
ZJS
1900 Takes one of <literal>forever</literal> or <literal>infinity</literal>. The latter means that the
1901 address never expires. Defaults to unset.</para>
d6463307
SS
1902 </listitem>
1903 </varlistentry>
1904
c3696a91
ZJS
1905 <!-- How to communicate with the server -->
1906
1501b429 1907 <varlistentry>
c3696a91 1908 <term><varname>RequestBroadcast=</varname></term>
1501b429 1909 <listitem>
c3696a91
ZJS
1910 <para>Request the server to use broadcast messages before the IP address has been configured.
1911 This is necessary for devices that cannot receive RAW packets, or that cannot receive packets at
1912 all before an IP address has been configured. On the other hand, this must not be enabled on
1913 networks where broadcasts are filtered out.</para>
1501b429
SS
1914 </listitem>
1915 </varlistentry>
1916
0f3ff4ea 1917 <varlistentry>
c3696a91 1918 <term><varname>MaxAttempts=</varname></term>
0f3ff4ea 1919 <listitem>
c3696a91
ZJS
1920 <para>Specifies how many times the DHCPv4 client configuration should be attempted. Takes a
1921 number or <literal>infinity</literal>. Defaults to <literal>infinity</literal>. Note that the
1922 time between retries is increased exponentially, up to approximately one per minute, so the
1923 network will not be overloaded even if this number is high. The default is suitable in most
1924 circumstances.</para>
0f3ff4ea
SS
1925 </listitem>
1926 </varlistentry>
1927
caa8ca42 1928 <varlistentry>
c3696a91
ZJS
1929 <term><varname>ListenPort=</varname></term>
1930 <listitem>
6c55cefe 1931 <para>Set the port from which the DHCP client packets originate.</para>
c3696a91 1932 </listitem>
98ebef62
SS
1933 </varlistentry>
1934
1935 <varlistentry>
c3696a91
ZJS
1936 <term><varname>DenyList=</varname></term>
1937 <listitem>
c995fa02
YW
1938 <para>A whitespace-separated list of IPv4 addresses. Each address can optionally take a
1939 prefix length after <literal>/</literal>. DHCP offers from servers in the list are
c3696a91
ZJS
1940 rejected. Note that if <varname>AllowList=</varname> is configured then
1941 <varname>DenyList=</varname> is ignored.</para>
1942 </listitem>
5bc945be
SS
1943 </varlistentry>
1944
1945 <varlistentry>
c3696a91 1946 <term><varname>AllowList=</varname></term>
caa8ca42 1947 <listitem>
c995fa02
YW
1948 <para>A whitespace-separated list of IPv4 addresses. Each address can optionally take a
1949 prefix length after <literal>/</literal>. DHCP offers from servers in the list are
c3696a91 1950 accepted.</para>
caa8ca42
SS
1951 </listitem>
1952 </varlistentry>
1953
cb29c156 1954 <varlistentry>
c3696a91 1955 <term><varname>SendRelease=</varname></term>
cb29c156 1956 <listitem>
c3696a91
ZJS
1957 <para>When true, the DHCPv4 client sends a DHCP release packet when it stops. Defaults to
1958 true.</para>
7354900d
DW
1959 </listitem>
1960 </varlistentry>
1961
1962 <varlistentry>
c3696a91 1963 <term><varname>SendDecline=</varname></term>
7354900d 1964 <listitem>
c3696a91
ZJS
1965 <para>A boolean. When <literal>true</literal>, the DHCPv4 client receives the IP address from the
1966 DHCP server. After a new IP is received, the DHCPv4 client performs IPv4 Duplicate Address
1967 Detection. If duplicate use is detected, the DHCPv4 client rejects the IP by sending a
1968 <constant>DHCPDECLINE</constant> packet and tries to obtain an IP address again. See <ulink
9de0c7f4 1969 url="https://tools.ietf.org/html/rfc5227">RFC 5227</ulink>. Defaults to
c3696a91 1970 <literal>unset</literal>.</para>
cb29c156
SS
1971 </listitem>
1972 </varlistentry>
c3696a91
ZJS
1973
1974 </variablelist>
caa8ca42
SS
1975 </refsect1>
1976
1977 <refsect1>
1978 <title>[DHCPv6] Section Options</title>
bdac5608 1979 <para>The [DHCPv6] section configures the DHCPv6 client, if it is enabled with the
4f7331a8 1980 <varname>DHCP=</varname> setting described above, or invoked by the IPv6 Router Advertisement:</para>
caa8ca42
SS
1981
1982 <variablelist class='network-directives'>
c3696a91
ZJS
1983
1984 <!-- DHCP packet contents -->
1536b7b2 1985
caa8ca42 1986 <varlistentry>
c3696a91 1987 <term><varname>MUDURL=</varname></term>
4e26a5ba
YW
1988 <term><varname>IAID=</varname></term>
1989 <term><varname>DUIDType=</varname></term>
1990 <term><varname>DUIDRawData=</varname></term>
c3696a91 1991 <term><varname>RequestOptions=</varname></term>
caa8ca42 1992 <listitem>
bdac5608 1993 <para>As in the [DHCPv4] section.</para>
caa8ca42
SS
1994 </listitem>
1995 </varlistentry>
1996
fb5c8216 1997 <varlistentry>
c3696a91 1998 <term><varname>SendOption=</varname></term>
3175a8c2 1999 <listitem>
c3696a91
ZJS
2000 <para>As in the [DHCPv4] section, however because DHCPv6 uses 16-bit fields to store option
2001 numbers, the option number is an integer in the range 1…65536.</para>
3175a8c2
SS
2002 </listitem>
2003 </varlistentry>
2004
35f6a5cb 2005 <varlistentry>
c3696a91 2006 <term><varname>SendVendorOption=</varname></term>
35f6a5cb 2007 <listitem>
c3696a91
ZJS
2008 <para>Send an arbitrary vendor option in the DHCPv6 request. Takes an enterprise identifier, DHCP
2009 option number, data type, and data separated with a colon (<literal><replaceable>enterprise
2010 identifier</replaceable>:<replaceable>option</replaceable>:<replaceable>type</replaceable>:<replaceable>value</replaceable></literal>).
2011 Enterprise identifier is an unsigned integer in the range 1…4294967294. The option number must be
2012 an integer in the range 1…254. Data type takes one of <literal>uint8</literal>,
2013 <literal>uint16</literal>, <literal>uint32</literal>, <literal>ipv4address</literal>,
2014 <literal>ipv6address</literal>, or <literal>string</literal>. Special characters in the data
2015 string may be escaped using <ulink
2016 url="https://en.wikipedia.org/wiki/Escape_sequences_in_C#Table_of_escape_sequences">C-style
2017 escapes</ulink>. This setting can be specified multiple times. If an empty string is specified,
2018 then all options specified earlier are cleared. Defaults to unset.</para>
35f6a5cb
SS
2019 </listitem>
2020 </varlistentry>
2021
b4ccc5de 2022 <varlistentry>
c3696a91 2023 <term><varname>UserClass=</varname></term>
b4ccc5de 2024 <listitem>
c3696a91
ZJS
2025 <para>A DHCPv6 client can use User Class option to identify the type or category of user or
2026 applications it represents. The information contained in this option is a string that represents
2027 the user class of which the client is a member. Each class sets an identifying string of
2028 information to be used by the DHCP service to classify clients. Special characters in the data
2029 string may be escaped using <ulink
e9dd6984 2030 url="https://en.wikipedia.org/wiki/Escape_sequences_in_C#Table_of_escape_sequences">C-style
b4ccc5de 2031 escapes</ulink>. This setting can be specified multiple times. If an empty string is specified,
c3696a91
ZJS
2032 then all options specified earlier are cleared. Takes a whitespace-separated list of
2033 strings. Note that currently <constant>NUL</constant> bytes are not allowed.</para>
b4ccc5de
SS
2034 </listitem>
2035 </varlistentry>
2036
125f20b4 2037 <varlistentry>
c3696a91 2038 <term><varname>VendorClass=</varname></term>
125f20b4 2039 <listitem>
c3696a91
ZJS
2040 <para>A DHCPv6 client can use VendorClass option to identify the vendor that manufactured the
2041 hardware on which the client is running. The information contained in the data area of this
2042 option is contained in one or more opaque fields that identify details of the hardware
2043 configuration. Takes a whitespace-separated list of strings.</para>
125f20b4
PF
2044 </listitem>
2045 </varlistentry>
2046
2805536b
SS
2047 <varlistentry>
2048 <term><varname>PrefixDelegationHint=</varname></term>
2049 <listitem>
e9dd6984
ZJS
2050 <para>Takes an IPv6 address with prefix length in the same format as the
2051 <varname>Address=</varname> in the [Network] section. The DHCPv6 client will include a prefix
2052 hint in the DHCPv6 solicitation sent to the server. The prefix length must be in the range
69978eb9 2053 1…128. Defaults to unset.</para>
2805536b
SS
2054 </listitem>
2055 </varlistentry>
cd305af1 2056
c3696a91
ZJS
2057 <!-- How to use the DHCP lease -->
2058
cd305af1 2059 <varlistentry>
c3696a91 2060 <term><varname>UseAddress=</varname></term>
cd305af1 2061 <listitem>
c3696a91
ZJS
2062 <para>When true (the default), the IP addresses provided by the DHCPv6 server will be
2063 assigned.</para>
cd305af1
SS
2064 </listitem>
2065 </varlistentry>
e7d5fe17 2066
0f5ef9b6
YW
2067 <varlistentry>
2068 <term><varname>UseDelegatedPrefix=</varname></term>
2069 <listitem>
2070 <para>When true (the default), the client will request the DHCPv6 server to delegate
2071 prefixes. If the server provides prefixes to be delegated, then subnets of the prefixes are
2072 assigned to the interfaces which enables <varname>DHCPv6PrefixDelegation=</varname>.
2073 See also <varname>DHCPv6PrefixDelegation=</varname> in [Network] section,
2074 [DHCPv6PrefixDelegation] section, and
2075 <ulink url="https://www.rfc-editor.org/rfc/rfc8415.html#section-6.3">RFC 8415</ulink>.
2076 </para>
2077 </listitem>
2078 </varlistentry>
2079
e7d5fe17 2080 <varlistentry>
e47bcb7d 2081 <term><varname>RouteMetric=</varname></term>
c3696a91
ZJS
2082 <term><varname>UseDNS=</varname></term>
2083 <term><varname>UseNTP=</varname></term>
2084 <term><varname>UseHostname=</varname></term>
2085 <term><varname>UseDomains=</varname></term>
e7d5fe17 2086 <listitem>
c3696a91 2087 <para>As in the [DHCPv4] section.</para>
e7d5fe17
AD
2088 </listitem>
2089 </varlistentry>
f37f2a6b 2090
c3696a91
ZJS
2091 <!-- How to communicate with the server -->
2092
ed0d1b2e 2093 <varlistentry>
c3696a91
ZJS
2094 <term><varname>WithoutRA=</varname></term>
2095 <listitem>
149cda85
YW
2096 <para>Allows DHCPv6 client to start without router advertisements's managed or other
2097 address configuration flag. Takes one of <literal>no</literal>, <literal>solicit</literal>
2098 or <literal>information-request</literal>. When this is not specified and
2099 <varname>UplinkInterface=:self</varname> is specified, then <literal>solicit</literal> is
2100 implied. Otherwise, defaults to <literal>no</literal>, and the DHCPv6 client will be
2101 started when an RA is received. See also <varname>DHCPv6Client=</varname> setting in the
2102 [IPv6AcceptRA] section.</para>
c3696a91
ZJS
2103 </listitem>
2104 </varlistentry>
ad943783 2105 </variablelist>
caa8ca42 2106 </refsect1>
99e015e2
YW
2107
2108 <refsect1>
2109 <title>[DHCPv6PrefixDelegation] Section Options</title>
e5ff2245
YW
2110 <para>The [DHCPv6PrefixDelegation] section configures delegated prefixes assigned by DHCPv6 server.
2111 The settings in this section are used only when <varname>DHCPv6PrefixDelegation=</varname> setting
2112 is enabled.</para>
99e015e2
YW
2113
2114 <variablelist class='network-directives'>
dc5cae6c
YW
2115 <varlistentry>
2116 <term><varname>UplinkInterface=</varname></term>
2117 <listitem>
2118 <para>Specifies the name or the index of the uplink interface, or one of the special values
2119 <literal>:self</literal> and <literal>:auto</literal>. When <literal>:self</literal>, the
149cda85
YW
2120 interface itself is considered the uplink interface, and
2121 <varname>WithoutRA=solicit</varname> is implied if the setting is not explicitly specified.
2122 When <literal>:auto</literal>, the first link which acquired prefixes to be delegated from
2123 the DHCPv6 server is selected. Defaults to <literal>:auto</literal>.</para>
dc5cae6c
YW
2124 </listitem>
2125 </varlistentry>
2126
99e015e2
YW
2127 <varlistentry>
2128 <term><varname>SubnetId=</varname></term>
2129 <listitem>
2130 <para>Configure a specific subnet ID on the interface from a (previously) received prefix
2131 delegation. You can either set "auto" (the default) or a specific subnet ID (as defined in
2132 <ulink url="https://tools.ietf.org/html/rfc4291#section-2.5.4">RFC 4291</ulink>, section
2133 2.5.4), in which case the allowed value is hexadecimal, from 0 to 0x7fffffffffffffff
e5ff2245
YW
2134 inclusive.</para>
2135 </listitem>
2136 </varlistentry>
2137
2138 <varlistentry>
2139 <term><varname>Announce=</varname></term>
2140 <listitem>
2141 <para>Takes a boolean. When enabled, and <varname>IPv6SendRA=</varname> in [Network] section
2142 is enabled, the delegated prefixes are distributed through the IPv6 Router Advertisement.
2143 Defaults to yes.</para>
99e015e2
YW
2144 </listitem>
2145 </varlistentry>
2146
2147 <varlistentry>
2148 <term><varname>Assign=</varname></term>
2149 <listitem>
2150 <para>Takes a boolean. Specifies whether to add an address from the delegated prefixes which
e5ff2245
YW
2151 are received from the WAN interface by the DHCPv6 Prefix Delegation. When true (on LAN
2152 interfce), the EUI-64 algorithm will be used by default to form an interface identifier from
2153 the delegated prefixes. See also <varname>Token=</varname> setting below. Defaults to yes.
2154 </para>
99e015e2
YW
2155 </listitem>
2156 </varlistentry>
2157
2158 <varlistentry>
2159 <term><varname>Token=</varname></term>
2160 <listitem>
e5ff2245 2161 <para>Specifies an optional address generation mode for assigning an address in each
f5960e0a
YW
2162 delegated prefix. This accepts the same syntax as <varname>Token=</varname> in the
2163 [IPv6AcceptRA] section. If <varname>Assign=</varname> is set to false, then this setting will
2164 be ignored. Defaults to unset, which means the EUI-64 algorithm will be used.</para>
99e015e2
YW
2165 </listitem>
2166 </varlistentry>
fec1b650
YW
2167
2168 <varlistentry>
2169 <term><varname>ManageTemporaryAddress=</varname></term>
2170 <listitem>
2171 <para>As in the [Address] section, but defaults to true.</para>
2172 </listitem>
2173 </varlistentry>
9fe0b7b4
YW
2174
2175 <varlistentry>
2176 <term><varname>RouteMetric=</varname></term>
2177 <listitem>
2178 <para>The metric of the route to the delegated prefix subnet. Takes an unsigned integer in
d0619f2c
YW
2179 the range 0…4294967295. When set to 0, the kernel's default value is used. Defaults to 256.
2180 </para>
9fe0b7b4
YW
2181 </listitem>
2182 </varlistentry>
99e015e2
YW
2183 </variablelist>
2184 </refsect1>
413708d1 2185
1e7a0e21 2186 <refsect1>
f921f573 2187 <title>[IPv6AcceptRA] Section Options</title>
bdac5608
ZJS
2188 <para>The [IPv6AcceptRA] section configures the IPv6 Router Advertisement (RA) client, if it is enabled
2189 with the <varname>IPv6AcceptRA=</varname> setting described above:</para>
1e7a0e21
LP
2190
2191 <variablelist class='network-directives'>
a73628e6
YW
2192 <varlistentry>
2193 <term><varname>Token=</varname></term>
2194 <listitem>
2195 <para>Specifies an optional address generation mode for the Stateless Address
140bf8da
YW
2196 Autoconfiguration (SLAAC). Supported modes are <literal>eui64</literal>,
2197 <literal>static</literal>, and <literal>prefixstable</literal>.</para>
2198
2199 <para>When the mode is set to <literal>eui64</literal>, then the EUI-64 algorithm will be
2200 used to generate an address for that prefix.</para>
a73628e6
YW
2201
2202 <para>When the mode is set to <literal>static</literal>, an IPv6 address must be
2203 specified after a colon (<literal>:</literal>), and the lower bits of the supplied
2204 address are combined with the upper bits of a prefix received in a Router Advertisement
2205 (RA) message to form a complete address. Note that if multiple prefixes are received in an
2206 RA message, or in multiple RA messages, addresses will be formed from each of them using
2207 the supplied address. This mode implements SLAAC but uses a static interface identifier
2208 instead of an identifier generated by using the EUI-64 algorithm. Because the interface
2209 identifier is static, if Duplicate Address Detection detects that the computed address is a
2210 duplicate (in use by another node on the link), then this mode will fail to provide an
2211 address for that prefix. If an IPv6 address without mode is specified, then
2212 <literal>static</literal> mode is assumed.</para>
2213
2214 <para>When the mode is set to <literal>prefixstable</literal> the
2215 <ulink url="https://tools.ietf.org/html/rfc7217">RFC 7217</ulink> algorithm for generating
2216 interface identifiers will be used. This mode can optionally take an IPv6 address separated
2217 with a colon (<literal>:</literal>). If an IPv6 address is specified, then an interface
2218 identifier is generated only when a prefix received in an RA message matches the supplied
2219 address.</para>
2220
2221 <para>If no address generation mode is specified (which is the default), or a received
2222 prefix does not match any of the addresses provided in <literal>prefixstable</literal>
2223 mode, then the EUI-64 algorithm will be used to form an interface identifier for that
2224 prefix.</para>
2225
2226 <para>Note that the <literal>prefixstable</literal> algorithm uses both the interface
2227 name and MAC address as input to the hash to compute the interface identifier, so if either
2228 of those are changed the resulting interface identifier (and address) will be changed, even
2229 if the prefix received in the RA message has not been changed.</para>
2230
2231 <para>This setting can be specified multiple times. If an empty string is assigned, then
2232 the all previous assignments are cleared.</para>
2233
2234 <para>Examples:
140bf8da
YW
2235 <programlisting>Token=eui64
2236Token=::1a:2b:3c:4d
a73628e6
YW
2237Token=static:::1a:2b:3c:4d
2238Token=prefixstable
2239Token=prefixstable:2002:da8:1::</programlisting></para>
2240 </listitem>
2241 </varlistentry>
2242
1e7a0e21
LP
2243 <varlistentry>
2244 <term><varname>UseDNS=</varname></term>
2245 <listitem>
b63dae31 2246 <para>When true (the default), the DNS servers received in the Router Advertisement will be used.</para>
1e7a0e21
LP
2247
2248 <para>This corresponds to the <option>nameserver</option> option in <citerefentry
2249 project='man-pages'><refentrytitle>resolv.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para>
2250 </listitem>
2251 </varlistentry>
2252
2253 <varlistentry>
2254 <term><varname>UseDomains=</varname></term>
2255 <listitem>
9b6ffef3 2256 <para>Takes a boolean, or the special value <literal>route</literal>. When true, the domain name
1e7a0e21
LP
2257 received via IPv6 Router Advertisement (RA) will be used as DNS search domain over this link, similar to
2258 the effect of the <option>Domains=</option> setting. If set to <literal>route</literal>, the domain name
2259 received via IPv6 RA will be used for routing DNS queries only, but not for searching, similar to the
2260 effect of the <option>Domains=</option> setting when the argument is prefixed with
2261 <literal>~</literal>. Defaults to false.</para>
2262
2263 <para>It is recommended to enable this option only on trusted networks, as setting this affects resolution
38b38500 2264 of all hostnames, in particular of single-label names. It is generally safer to use the supplied domain
1e7a0e21
LP
2265 only as routing domain, rather than as search domain, in order to not have it affect local resolution of
2266 single-label names.</para>
2267
2268 <para>When set to true, this setting corresponds to the <option>domain</option> option in <citerefentry
2269 project='man-pages'><refentrytitle>resolv.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para>
2270 </listitem>
2271 </varlistentry>
2ba31d29
JK
2272
2273 <varlistentry>
2274 <term><varname>RouteTable=<replaceable>num</replaceable></varname></term>
2275 <listitem>
d11e656a
ZJS
2276 <para>The table identifier for the routes received in the Router Advertisement
2277 (a number between 1 and 4294967295, or 0 to unset).
2ba31d29
JK
2278 The table can be retrieved using <command>ip route show table <replaceable>num</replaceable></command>.
2279 </para>
2280 </listitem>
2281 </varlistentry>
062c2eea 2282
8ebafba9
YW
2283 <varlistentry>
2284 <term><varname>RouteMetric=</varname></term>
2285 <listitem>
2286 <para>Set the routing metric for the routes received in the Router Advertisement. Takes an
2287 unsigned integer in the range 0…4294967295. Defaults to 1024.</para>
2288 </listitem>
2289 </varlistentry>
2290
7d93b92f
YW
2291 <varlistentry>
2292 <term><varname>UseMTU=</varname></term>
2293 <listitem>
2294 <para>Takes a boolean. When true, the MTU received in the Router Advertisement will be
2295 used. Defaults to true.</para>
2296 </listitem>
2297 </varlistentry>
2298
610c0db1
YW
2299 <varlistentry>
2300 <term><varname>UseGateway=</varname></term>
2301 <listitem>
2302 <para>When true (the default), the router address will be configured as the default gateway.
2303 </para>
2304 </listitem>
2305 </varlistentry>
2306
2307 <varlistentry>
2308 <term><varname>UseRoutePrefix=</varname></term>
2309 <listitem>
2310 <para>When true (the default), the routes corresponding to the route prefixes received in
2311 the Router Advertisement will be configured.</para>
2312 </listitem>
2313 </varlistentry>
2314
062c2eea
SS
2315 <varlistentry>
2316 <term><varname>UseAutonomousPrefix=</varname></term>
2317 <listitem>
2318 <para>When true (the default), the autonomous prefix received in the Router Advertisement will be used and take
2319 precedence over any statically configured ones.</para>
2320 </listitem>
2321 </varlistentry>
2322
2323 <varlistentry>
2324 <term><varname>UseOnLinkPrefix=</varname></term>
2325 <listitem>
885a4e6c
ZJS
2326 <para>When true (the default), the onlink prefix received in the Router Advertisement will be
2327 used and takes precedence over any statically configured ones.</para>
062c2eea
SS
2328 </listitem>
2329 </varlistentry>
2330
75d26411
YW
2331 <varlistentry>
2332 <term><varname>RouterDenyList=</varname></term>
2333 <listitem>
c995fa02
YW
2334 <para>A whitespace-separated list of IPv6 router addresses. Each address can optionally
2335 take a prefix length after <literal>/</literal>. Any information advertised by the listed
2336 router is ignored.</para>
75d26411
YW
2337 </listitem>
2338 </varlistentry>
2339
2340 <varlistentry>
2341 <term><varname>RouterAllowList=</varname></term>
2342 <listitem>
c995fa02
YW
2343 <para>A whitespace-separated list of IPv6 router addresses. Each address can optionally
2344 take a prefix length after <literal>/</literal>. Only information advertised by the listed
2345 router is accepted. Note that if <varname>RouterAllowList=</varname> is configured then
2346 <varname>RouterDenyList=</varname> is ignored.</para>
75d26411
YW
2347 </listitem>
2348 </varlistentry>
2349
e520ce64 2350 <varlistentry>
3f0af4a5 2351 <term><varname>PrefixDenyList=</varname></term>
e520ce64 2352 <listitem>
c995fa02
YW
2353 <para>A whitespace-separated list of IPv6 prefixes. Each prefix can optionally take its
2354 prefix length after <literal>/</literal>. IPv6 prefixes supplied via router advertisements
2355 in the list are ignored.</para>
16c89e64
DP
2356 </listitem>
2357 </varlistentry>
2358
de6b6ff8
SS
2359 <varlistentry>
2360 <term><varname>PrefixAllowList=</varname></term>
2361 <listitem>
c995fa02
YW
2362 <para>A whitespace-separated list of IPv6 prefixes. Each prefix can optionally take its
2363 prefix length after <literal>/</literal>. IPv6 prefixes supplied via router advertisements
2364 in the list are allowed. Note that if <varname>PrefixAllowList=</varname> is configured
2365 then <varname>PrefixDenyList=</varname> is ignored.</para>
de6b6ff8
SS
2366 </listitem>
2367 </varlistentry>
2368
16c89e64
DP
2369 <varlistentry>
2370 <term><varname>RouteDenyList=</varname></term>
2371 <listitem>
c995fa02
YW
2372 <para>A whitespace-separated list of IPv6 route prefixes. Each prefix can optionally take
2373 its prefix length after <literal>/</literal>. IPv6 route prefixes supplied via router
2374 advertisements in the list are ignored.</para>
e520ce64
SS
2375 </listitem>
2376 </varlistentry>
2377
de6b6ff8
SS
2378 <varlistentry>
2379 <term><varname>RouteAllowList=</varname></term>
2380 <listitem>
c995fa02
YW
2381 <para>A whitespace-separated list of IPv6 route prefixes. Each prefix can optionally take
2382 its prefix length after <literal>/</literal>. IPv6 route prefixes supplied via router
2383 advertisements in the list are allowed. Note that if <varname>RouteAllowList=</varname> is
de6b6ff8
SS
2384 configured then <varname>RouteDenyList=</varname> is ignored.</para>
2385 </listitem>
2386 </varlistentry>
2387
d739fdde
YW
2388 <varlistentry>
2389 <term><varname>DHCPv6Client=</varname></term>
2390 <listitem>
149cda85
YW
2391 <para>Takes a boolean, or the special value <literal>always</literal>. When true, the
2392 DHCPv6 client will be started when the RA has the managed or other information flag. If set
2393 to <literal>always</literal>, the DHCPv6 client will be started in managed mode when an RA
2394 is received, even if neither managed nor other information flag is set in the RA. This will
2395 be ignored when <varname>WithoutRA=</varname> in the [DHCPv6] section is enabled, or
2396 <varname>UplinkInterface=:self</varname> in the [DHCPv6PrefixDelegation] section is
2397 specified. Defaults to true.</para>
d739fdde
YW
2398 </listitem>
2399 </varlistentry>
1e7a0e21
LP
2400 </variablelist>
2401 </refsect1>
2402
ad943783
LP
2403 <refsect1>
2404 <title>[DHCPServer] Section Options</title>
bdac5608 2405 <para>The [DHCPServer] section contains settings for the DHCP server, if enabled via the
ad943783
LP
2406 <varname>DHCPServer=</varname> option described above:</para>
2407
2408 <variablelist class='network-directives'>
2409
0017ba31
YW
2410 <varlistentry>
2411 <term><varname>ServerAddress=</varname></term>
2412 <listitem><para>Specifies server address for the DHCP server. Takes an IPv4 address with prefix
be0d27ee
ZJS
2413 length, for example <literal>192.168.0.1/24</literal>. This setting may be useful when the link on
2414 which the DHCP server is running has multiple static addresses. When unset, one of static addresses
2415 in the link will be automatically selected. Defaults to unset.</para></listitem>
0017ba31
YW
2416 </varlistentry>
2417
9b3a67c5
TG
2418 <varlistentry>
2419 <term><varname>PoolOffset=</varname></term>
2420 <term><varname>PoolSize=</varname></term>
2421
2422 <listitem><para>Configures the pool of addresses to hand out. The pool
2423 is a contiguous sequence of IP addresses in the subnet configured for
2424 the server address, which does not include the subnet nor the broadcast
2425 address. <varname>PoolOffset=</varname> takes the offset of the pool
2426 from the start of subnet, or zero to use the default value.
2427 <varname>PoolSize=</varname> takes the number of IP addresses in the
b938cb90 2428 pool or zero to use the default value. By default, the pool starts at
9b3a67c5
TG
2429 the first address after the subnet address and takes up the rest of
2430 the subnet, excluding the broadcast address. If the pool includes
2431 the server address (the default), this is reserved and not handed
2432 out to clients.</para></listitem>
2433 </varlistentry>
2434
ad943783
LP
2435 <varlistentry>
2436 <term><varname>DefaultLeaseTimeSec=</varname></term>
2437 <term><varname>MaxLeaseTimeSec=</varname></term>
2438
2439 <listitem><para>Control the default and maximum DHCP lease
2440 time to pass to clients. These settings take time values in seconds or
2441 another common time unit, depending on the suffix. The default
2442 lease time is used for clients that did not ask for a specific
2443 lease time. If a client asks for a lease time longer than the
b938cb90 2444 maximum lease time, it is automatically shortened to the
ad943783
LP
2445 specified time. The default lease time defaults to 1h, the
2446 maximum lease time to 12h. Shorter lease times are beneficial
2447 if the configuration data in DHCP leases changes frequently
2448 and clients shall learn the new settings with shorter
2449 latencies. Longer lease times reduce the generated DHCP
2450 network traffic.</para></listitem>
2451 </varlistentry>
2452
165d7c5c
YW
2453 <varlistentry>
2454 <term><varname>UplinkInterface=</varname></term>
2b242926
YW
2455 <listitem><para>Specifies the name or the index of the uplink interface, or one of the special
2456 values <literal>:none</literal> and <literal>:auto</literal>. When emitting DNS, NTP, or SIP
2457 servers is enabled but no servers are specified, the servers configured in the uplink interface
2458 will be emitted. When <literal>:auto</literal>, the link which has a default gateway with the
2459 highest priority will be automatically selected. When <literal>:none</literal>, no uplink
2460 interface will be selected. Defaults to <literal>:auto</literal>.</para></listitem>
165d7c5c
YW
2461 </varlistentry>
2462
ad943783
LP
2463 <varlistentry>
2464 <term><varname>EmitDNS=</varname></term>
2465 <term><varname>DNS=</varname></term>
2466
2a71d57f
LP
2467 <listitem><para><varname>EmitDNS=</varname> takes a boolean. Configures whether the DHCP leases
2468 handed out to clients shall contain DNS server information. Defaults to <literal>yes</literal>. The
2469 DNS servers to pass to clients may be configured with the <varname>DNS=</varname> option, which takes
2470 a list of IPv4 addresses. If the <varname>EmitDNS=</varname> option is enabled but no servers
2471 configured, the servers are automatically propagated from an "uplink" interface that has appropriate
2472 servers set. The "uplink" interface is determined by the default route of the system with the highest
2473 priority. Note that this information is acquired at the time the lease is handed out, and does not
2474 take uplink interfaces into account that acquire DNS server information at a later point. If no
75909cc7 2475 suitable uplink interface is found the DNS server data from <filename>/etc/resolv.conf</filename> is
2a71d57f
LP
2476 used. Also, note that the leases are not refreshed if the uplink network configuration changes. To
2477 ensure clients regularly acquire the most current uplink DNS server information, it is thus advisable
2478 to shorten the DHCP lease time via <varname>MaxLeaseTimeSec=</varname> described
ad943783
LP
2479 above.</para></listitem>
2480 </varlistentry>
2481
2482 <varlistentry>
2483 <term><varname>EmitNTP=</varname></term>
2484 <term><varname>NTP=</varname></term>
299d578f
SS
2485 <term><varname>EmitSIP=</varname></term>
2486 <term><varname>SIP=</varname></term>
2a71d57f
LP
2487 <term><varname>EmitPOP3=</varname></term>
2488 <term><varname>POP3=</varname></term>
2489 <term><varname>EmitSMTP=</varname></term>
2490 <term><varname>SMTP=</varname></term>
2491 <term><varname>EmitLPR=</varname></term>
2492 <term><varname>LPR=</varname></term>
2493
2494 <listitem><para>Similar to the <varname>EmitDNS=</varname> and <varname>DNS=</varname> settings
2495 described above, these settings configure whether and what server information for the indicate
2496 protocol shall be emitted as part of the DHCP lease. The same syntax, propagation semantics and
2497 defaults apply as for <varname>EmitDNS=</varname> and <varname>DNS=</varname>.</para></listitem>
284e8fd0
SS
2498 </varlistentry>
2499
77ff6022
CG
2500 <varlistentry>
2501 <term><varname>EmitRouter=</varname></term>
59aa6220
YW
2502 <term><varname>Router=</varname></term>
2503
2504 <listitem><para>The <varname>EmitRouter=</varname> setting takes a boolean value, and configures
2505 whether the DHCP lease should contain the router option. The <varname>Router=</varname> setting
2506 takes an IPv4 address, and configures the router address to be emitted. When the
2507 <varname>Router=</varname> setting is not specified, then the server address will be used for
2508 the router option. When the <varname>EmitRouter=</varname> setting is disabled, the
2509 <varname>Router=</varname> setting will be ignored. The <varname>EmitRouter=</varname> setting
2510 defaults to true, and the <varname>Router=</varname> setting defaults to unset.
2511 </para></listitem>
77ff6022
CG
2512 </varlistentry>
2513
ad943783
LP
2514 <varlistentry>
2515 <term><varname>EmitTimezone=</varname></term>
2516 <term><varname>Timezone=</varname></term>
2517
9b6ffef3
YW
2518 <listitem><para>Takes a boolean. Configures whether the DHCP leases handed out
2519 to clients shall contain timezone information. Defaults to <literal>yes</literal>. The
ad943783
LP
2520 <varname>Timezone=</varname> setting takes a timezone string
2521 (such as <literal>Europe/Berlin</literal> or
2522 <literal>UTC</literal>) to pass to clients. If no explicit
b938cb90 2523 timezone is set, the system timezone of the local host is
ad943783
LP
2524 propagated, as determined by the
2525 <filename>/etc/localtime</filename> symlink.</para></listitem>
2526 </varlistentry>
2527
564ca984 2528 <varlistentry>
d8b736bd
YW
2529 <term><varname>SendOption=</varname></term>
2530 <listitem>
2531 <para>Send a raw option with value via DHCPv4 server. Takes a DHCP option number, data type
2532 and data (<literal><replaceable>option</replaceable>:<replaceable>type</replaceable>:<replaceable>value</replaceable></literal>).
1d3a473b 2533 The option number is an integer in the range 1…254. The type takes one of <literal>uint8</literal>,
e7d5fe17 2534 <literal>uint16</literal>, <literal>uint32</literal>, <literal>ipv4address</literal>, <literal>ipv6address</literal>, or
7354900d
DW
2535 <literal>string</literal>. Special characters in the data string may be escaped using
2536 <ulink url="https://en.wikipedia.org/wiki/Escape_sequences_in_C#Table_of_escape_sequences">C-style
2537 escapes</ulink>. This setting can be specified multiple times. If an empty string is specified,
2538 then all options specified earlier are cleared. Defaults to unset.</para>
2539 </listitem>
2540 </varlistentry>
2541
2542 <varlistentry>
2543 <term><varname>SendVendorOption=</varname></term>
2544 <listitem>
2545 <para>Send a vendor option with value via DHCPv4 server. Takes a DHCP option number, data type
2546 and data (<literal><replaceable>option</replaceable>:<replaceable>type</replaceable>:<replaceable>value</replaceable></literal>).
1d3a473b 2547 The option number is an integer in the range 1…254. The type takes one of <literal>uint8</literal>,
d8b736bd
YW
2548 <literal>uint16</literal>, <literal>uint32</literal>, <literal>ipv4address</literal>, or
2549 <literal>string</literal>. Special characters in the data string may be escaped using
2550 <ulink url="https://en.wikipedia.org/wiki/Escape_sequences_in_C#Table_of_escape_sequences">C-style
2551 escapes</ulink>. This setting can be specified multiple times. If an empty string is specified,
2552 then all options specified earlier are cleared. Defaults to unset.</para>
2553 </listitem>
564ca984 2554 </varlistentry>
21b6b87e
YA
2555 <varlistentry>
2556 <term><varname>BindToInterface=</varname></term>
11c38d3e
YA
2557 <listitem>
2558 <para>Takes a boolean value. When <literal>yes</literal>, DHCP server socket will be bound
2559 to its network interface and all socket communication will be restricted to this interface.
2560 Defaults to <literal>yes</literal>, except if <varname>RelayTarget=</varname> is used (see below),
84b10e53 2561 in which case it defaults to <literal>no</literal>.</para>
11c38d3e
YA
2562 </listitem>
2563 </varlistentry>
2564 <varlistentry>
2565 <term><varname>RelayTarget=</varname></term>
2566 <listitem>
2567 <para>Takes an IPv4 address, which must be in the format described in
2568 <citerefentry project='man-pages'><refentrytitle>inet_pton</refentrytitle><manvolnum>3</manvolnum></citerefentry>.
2569 Turns this DHCP server into a DHCP relay agent. See <ulink url="https://tools.ietf.org/html/rfc1542">RFC 1542</ulink>.
2570 The address is the address of DHCP server or another relay agent to forward DHCP messages to and from.</para>
2571 </listitem>
2572 </varlistentry>
2573 <varlistentry>
2574 <term><varname>RelayAgentCircuitId=</varname></term>
2575 <listitem>
2576 <para>Specifies value for Agent Circuit ID suboption of Relay Agent Information option.
2577 Takes a string, which must be in the format <literal>string:<replaceable>value</replaceable></literal>,
2578 where <literal><replaceable>value</replaceable></literal> should be replaced with the value of the suboption.
2579 Defaults to unset (means no Agent Circuit ID suboption is generated).
2580 Ignored if <varname>RelayTarget=</varname> is not specified.</para>
2581 </listitem>
2582 </varlistentry>
2583 <varlistentry>
2584 <term><varname>RelayAgentRemoteId=</varname></term>
2585 <listitem>
2586 <para>Specifies value for Agent Remote ID suboption of Relay Agent Information option.
2587 Takes a string, which must be in the format <literal>string:<replaceable>value</replaceable></literal>,
2588 where <literal><replaceable>value</replaceable></literal> should be replaced with the value of the suboption.
2589 Defaults to unset (means no Agent Remote ID suboption is generated).
2590 Ignored if <varname>RelayTarget=</varname> is not specified.</para>
21b6b87e
YA
2591 </listitem>
2592 </varlistentry>
564ca984 2593
ad943783
LP
2594 </variablelist>
2595 </refsect1>
2596
c517a49b 2597 <refsect1>
2598 <title>[DHCPServerStaticLease] Section Options</title>
be0d27ee
ZJS
2599 <para>The <literal>[DHCPServerStaticLease]</literal> section configures a static DHCP lease to assign a
2600 fixed IPv4 address to a specific device based on its MAC address. This section can be specified multiple
2601 times.</para>
c517a49b 2602
2603 <variablelist class='network-directives'>
2604 <varlistentry>
2605 <term><varname>MACAddress=</varname></term>
2606
be0d27ee 2607 <listitem><para>The hardware address of a device to match. This key is mandatory.</para></listitem>
c517a49b 2608 </varlistentry>
2609
2610 <varlistentry>
2611 <term><varname>Address=</varname></term>
2612
be0d27ee
ZJS
2613 <listitem><para>The IPv4 address that should be assigned to the device that was matched with
2614 <varname>MACAddress=</varname>. This key is mandatory.</para></listitem>
c517a49b 2615 </varlistentry>
2616 </variablelist>
2617 </refsect1>
2618
798d3a52 2619 <refsect1>
e5ff2245
YW
2620 <title>[IPv6SendRA] Section Options</title>
2621 <para>The [IPv6SendRA] section contains settings for sending IPv6 Router Advertisements and whether
2622 to act as a router, if enabled via the <varname>IPv6SendRA=</varname> option described above. IPv6
2623 network prefixes or routes are defined with one or more [IPv6Prefix] or [IPv6RoutePrefix] sections.
2624 </para>
3f9e0236
PF
2625
2626 <variablelist class='network-directives'>
2627
2628 <varlistentry>
2629 <term><varname>Managed=</varname></term>
2630 <term><varname>OtherInformation=</varname></term>
2631
9b6ffef3
YW
2632 <listitem><para>Takes a boolean. Controls whether a DHCPv6 server is used to acquire IPv6
2633 addresses on the network link when <varname>Managed=</varname>
3f9e0236
PF
2634 is set to <literal>true</literal> or if only additional network
2635 information can be obtained via DHCPv6 for the network link when
9b6ffef3 2636 <varname>OtherInformation=</varname> is set to
3f9e0236
PF
2637 <literal>true</literal>. Both settings default to
2638 <literal>false</literal>, which means that a DHCPv6 server is not being
2639 used.</para></listitem>
2640 </varlistentry>
2641
2642 <varlistentry>
2643 <term><varname>RouterLifetimeSec=</varname></term>
2644
71a5db49 2645 <listitem><para>Takes a timespan. Configures the IPv6 router lifetime in seconds. When set to
4f1ac4a3
YW
2646 0, the host is not acting as a router. The value must be 0 second, or between 4 seconds and
2647 9000 seconds. Defaults to 1800 seconds (30 minutes).</para>
3f9e0236
PF
2648 </listitem>
2649 </varlistentry>
2650
2651 <varlistentry>
2652 <term><varname>RouterPreference=</varname></term>
2653
2654 <listitem><para>Configures IPv6 router preference if
2655 <varname>RouterLifetimeSec=</varname> is non-zero. Valid values are
2656 <literal>high</literal>, <literal>medium</literal> and
2657 <literal>low</literal>, with <literal>normal</literal> and
2658 <literal>default</literal> added as synonyms for
2659 <literal>medium</literal> just to make configuration easier. See
2660 <ulink url="https://tools.ietf.org/html/rfc4191">RFC 4191</ulink>
2661 for details. Defaults to <literal>medium</literal>.</para></listitem>
2662 </varlistentry>
2663
63295b42
YW
2664 <varlistentry>
2665 <term><varname>UplinkInterface=</varname></term>
2666 <listitem><para>Specifies the name or the index of the uplink interface, or one of the special
2667 values <literal>:none</literal> and <literal>:auto</literal>. When emitting DNS servers or
2668 search domains is enabled but no servers are specified, the servers configured in the uplink
2669 interface will be emitted. When <literal>:auto</literal>, the link which has a default gateway
2670 with the highest priority will be automatically selected. When <literal>:none</literal>, no
2671 uplink interface will be selected. Defaults to <literal>:auto</literal>.</para></listitem>
2672 </varlistentry>
2673
3f9e0236 2674 <varlistentry>
4cb8478c 2675 <term><varname>EmitDNS=</varname></term>
3f9e0236
PF
2676 <term><varname>DNS=</varname></term>
2677
63295b42
YW
2678 <listitem><para><varname>DNS=</varname> specifies a list of recursive DNS server IPv6 addresses
2679 that are distributed via Router Advertisement messages when <varname>EmitDNS=</varname> is true.
2680 <varname>DNS=</varname> also takes special value <literal>_link_local</literal>; in that case
2681 the IPv6 link local address is distributed. If <varname>DNS=</varname> is empty, DNS servers are
2682 read from the [Network] section. If the [Network] section does not contain any DNS servers
2683 either, DNS servers from the uplink interface specified in <varname>UplinkInterface=</varname>
2684 will be used. When <varname>EmitDNS=</varname> is false, no DNS server information is sent in
2685 Router Advertisement messages. <varname>EmitDNS=</varname> defaults to true.</para></listitem>
3f9e0236
PF
2686 </varlistentry>
2687
760021c0 2688 <varlistentry>
4cb8478c 2689 <term><varname>EmitDomains=</varname></term>
760021c0
PF
2690 <term><varname>Domains=</varname></term>
2691
bdac5608 2692 <listitem><para>A list of DNS search domains distributed via Router Advertisement messages when
63295b42
YW
2693 <varname>EmitDomains=</varname> is true. If <varname>Domains=</varname> is empty, DNS search
2694 domains are read from the [Network] section. If the [Network] section does not contain any DNS
2695 search domains either, DNS search domains from the uplink interface specified in
2696 <varname>UplinkInterface=</varname> will be used. When <varname>EmitDomains=</varname> is false,
2697 no DNS search domain information is sent in Router Advertisement messages.
2698 <varname>EmitDomains=</varname> defaults to true.</para></listitem>
760021c0
PF
2699 </varlistentry>
2700
3f9e0236
PF
2701 <varlistentry>
2702 <term><varname>DNSLifetimeSec=</varname></term>
2703
9fa25e07
YW
2704 <listitem><para>Lifetime in seconds for the DNS server addresses listed in
2705 <varname>DNS=</varname> and search domains listed in <varname>Domains=</varname>. Defaults to
c9e2c2da 2706 3600 seconds (one hour).</para></listitem>
3f9e0236
PF
2707 </varlistentry>
2708
2709 </variablelist>
2710 </refsect1>
2711
203d4df5 2712 <refsect1>
3f9e0236 2713 <title>[IPv6Prefix] Section Options</title>
e9dd6984
ZJS
2714 <para>One or more [IPv6Prefix] sections contain the IPv6 prefixes that are announced via Router
2715 Advertisements. See <ulink url="https://tools.ietf.org/html/rfc4861">RFC 4861</ulink> for further
2716 details.</para>
3f9e0236
PF
2717
2718 <variablelist class='network-directives'>
2719
2720 <varlistentry>
2721 <term><varname>AddressAutoconfiguration=</varname></term>
2722 <term><varname>OnLink=</varname></term>
2723
9b6ffef3 2724 <listitem><para>Takes a boolean to specify whether IPv6 addresses can be
3f9e0236
PF
2725 autoconfigured with this prefix and whether the prefix can be used for
2726 onlink determination. Both settings default to <literal>true</literal>
2727 in order to ease configuration.
2728 </para></listitem>
2729 </varlistentry>
2730
2731 <varlistentry>
2732 <term><varname>Prefix=</varname></term>
2733
bdac5608
ZJS
2734 <listitem><para>The IPv6 prefix that is to be distributed to hosts. Similarly to configuring static
2735 IPv6 addresses, the setting is configured as an IPv6 prefix and its prefix length, separated by a
2736 <literal>/</literal> character. Use multiple [IPv6Prefix] sections to configure multiple IPv6
2737 prefixes since prefix lifetimes, address autoconfiguration and onlink status may differ from one
2738 prefix to another.</para></listitem>
3f9e0236
PF
2739 </varlistentry>
2740
2741 <varlistentry>
2742 <term><varname>PreferredLifetimeSec=</varname></term>
2743 <term><varname>ValidLifetimeSec=</varname></term>
2744
c9e2c2da
YW
2745 <listitem><para>Preferred and valid lifetimes for the prefix measured in seconds.
2746 <varname>PreferredLifetimeSec=</varname> defaults to 1800 seconds (30 minutes) and
2747 <varname>ValidLifetimeSec=</varname> defaults to 3600 seconds (one hour).</para></listitem>
203d4df5
SS
2748 </varlistentry>
2749
bd6379ec
SS
2750 <varlistentry>
2751 <term><varname>Assign=</varname></term>
2752 <listitem><para>Takes a boolean. When true, adds an address from the prefix. Default to false.
2753 </para></listitem>
2754 </varlistentry>
0e1fb1d0 2755
e609cd06
YW
2756 <varlistentry>
2757 <term><varname>Token=</varname></term>
2758 <listitem>
2759 <para>Specifies an optional address generation mode for assigning an address in each
2760 prefix. This accepts the same syntax as <varname>Token=</varname> in the [IPv6AcceptRA]
2761 section. If <varname>Assign=</varname> is set to false, then this setting will be ignored.
2762 Defaults to unset, which means the EUI-64 algorithm will be used.</para>
2763 </listitem>
2764 </varlistentry>
2765
0e1fb1d0
YW
2766 <varlistentry>
2767 <term><varname>RouteMetric=</varname></term>
2768 <listitem>
2769 <para>The metric of the prefix route. Takes an unsigned integer in the range 0…4294967295.
2770 When unset or set to 0, the kernel's default value is used. This setting is ignored when
2771 <varname>Assign=</varname> is false.</para>
2772 </listitem>
2773 </varlistentry>
203d4df5
SS
2774 </variablelist>
2775 </refsect1>
2776
2777 <refsect1>
2778 <title>[IPv6RoutePrefix] Section Options</title>
bdac5608 2779 <para>One or more [IPv6RoutePrefix] sections contain the IPv6
203d4df5
SS
2780 prefix routes that are announced via Router Advertisements. See
2781 <ulink url="https://tools.ietf.org/html/rfc4191">RFC 4191</ulink>
2782 for further details.</para>
2783
2784 <variablelist class='network-directives'>
2785
2786 <varlistentry>
2787 <term><varname>Route=</varname></term>
2788
bdac5608
ZJS
2789 <listitem><para>The IPv6 route that is to be distributed to hosts. Similarly to configuring static
2790 IPv6 routes, the setting is configured as an IPv6 prefix routes and its prefix route length,
2791 separated by a <literal>/</literal> character. Use multiple [IPv6PrefixRoutes] sections to configure
2792 multiple IPv6 prefix routes.</para></listitem>
203d4df5
SS
2793 </varlistentry>
2794
2795 <varlistentry>
2796 <term><varname>LifetimeSec=</varname></term>
2797
c9e2c2da
YW
2798 <listitem><para>Lifetime for the route prefix measured in seconds.
2799 <varname>LifetimeSec=</varname> defaults to 3600 seconds (one hour).</para></listitem>
3f9e0236
PF
2800 </varlistentry>
2801
2802 </variablelist>
2803 </refsect1>
2804
2805 <refsect1>
798d3a52 2806 <title>[Bridge] Section Options</title>
bdac5608 2807 <para>The [Bridge] section accepts the following keys:</para>
798d3a52 2808 <variablelist class='network-directives'>
165c41a9
SS
2809 <varlistentry>
2810 <term><varname>UnicastFlood=</varname></term>
2811 <listitem>
9b6ffef3 2812 <para>Takes a boolean. Controls whether the bridge should flood
072f9e4a 2813 traffic for which an FDB entry is missing and the destination
025314d9 2814 is unknown through this port. When unset, the kernel's default will be used.
47c7dfe2 2815 </para>
165c41a9
SS
2816 </listitem>
2817 </varlistentry>
7f15b714
TJ
2818 <varlistentry>
2819 <term><varname>MulticastFlood=</varname></term>
2820 <listitem>
2821 <para>Takes a boolean. Controls whether the bridge should flood
2822 traffic for which an MDB entry is missing and the destination
2823 is unknown through this port. When unset, the kernel's default will be used.
2824 </para>
2825 </listitem>
2826 </varlistentry>
d3aa8b49
SS
2827 <varlistentry>
2828 <term><varname>MulticastToUnicast=</varname></term>
2829 <listitem>
2830 <para>Takes a boolean. Multicast to unicast works on top of the multicast snooping feature of
2831 the bridge. Which means unicast copies are only delivered to hosts which are interested in it.
2832 When unset, the kernel's default will be used.
2833 </para>
2834 </listitem>
2835 </varlistentry>
7f15b714
TJ
2836 <varlistentry>
2837 <term><varname>NeighborSuppression=</varname></term>
2838 <listitem>
2839 <para>Takes a boolean. Configures whether ARP and ND neighbor suppression is enabled for
2840 this port. When unset, the kernel's default will be used.
2841 </para>
2842 </listitem>
2843 </varlistentry>
2844 <varlistentry>
2845 <term><varname>Learning=</varname></term>
2846 <listitem>
2847 <para>Takes a boolean. Configures whether MAC address learning is enabled for
2848 this port. When unset, the kernel's default will be used.
2849 </para>
2850 </listitem>
2851 </varlistentry>
165c41a9
SS
2852 <varlistentry>
2853 <term><varname>HairPin=</varname></term>
2854 <listitem>
e9dd6984
ZJS
2855 <para>Takes a boolean. Configures whether traffic may be sent back out of the port on which it
2856 was received. When this flag is false, then the bridge will not forward traffic back out of the
2857 receiving port. When unset, the kernel's default will be used.</para>
165c41a9
SS
2858 </listitem>
2859 </varlistentry>
2860 <varlistentry>
84c34096 2861 <term><varname>UseBPDU=</varname></term>
165c41a9 2862 <listitem>
9b6ffef3 2863 <para>Takes a boolean. Configures whether STP Bridge Protocol Data Units will be
025314d9 2864 processed by the bridge port. When unset, the kernel's default will be used.</para>
165c41a9
SS
2865 </listitem>
2866 </varlistentry>
2867 <varlistentry>
2868 <term><varname>FastLeave=</varname></term>
2869 <listitem>
9b6ffef3 2870 <para>Takes a boolean. This flag allows the bridge to immediately stop multicast
a8eaaee7 2871 traffic on a port that receives an IGMP Leave message. It is only used with
025314d9 2872 IGMP snooping if enabled on the bridge. When unset, the kernel's default will be used.</para>
165c41a9
SS
2873 </listitem>
2874 </varlistentry>
2875 <varlistentry>
23da66bb 2876 <term><varname>AllowPortToBeRoot=</varname></term>
165c41a9 2877 <listitem>
9b6ffef3 2878 <para>Takes a boolean. Configures whether a given port is allowed to
47c7dfe2 2879 become a root port. Only used when STP is enabled on the bridge.
025314d9 2880 When unset, the kernel's default will be used.</para>
165c41a9
SS
2881 </listitem>
2882 </varlistentry>
1087623b
SS
2883 <varlistentry>
2884 <term><varname>ProxyARP=</varname></term>
2885 <listitem>
2886 <para>Takes a boolean. Configures whether proxy ARP to be enabled on this port.
2887 When unset, the kernel's default will be used.</para>
2888 </listitem>
2889 </varlistentry>
2890 <varlistentry>
2891 <term><varname>ProxyARPWiFi=</varname></term>
2892 <listitem>
2893 <para>Takes a boolean. Configures whether proxy ARP to be enabled on this port
2894 which meets extended requirements by IEEE 802.11 and Hotspot 2.0 specifications.
2895 When unset, the kernel's default will be used.</para>
2896 </listitem>
2897 </varlistentry>
0fadb2a4
SS
2898 <varlistentry>
2899 <term><varname>MulticastRouter=</varname></term>
2900 <listitem>
2901 <para>Configures this port for having multicast routers attached. A port with a multicast
2902 router will receive all multicast traffic. Takes one of <literal>no</literal>
2903 to disable multicast routers on this port, <literal>query</literal> to let the system detect
2904 the presence of routers, <literal>permanent</literal> to permanently enable multicast traffic
2905 forwarding on this port, or <literal>temporary</literal> to enable multicast routers temporarily
2906 on this port, not depending on incoming queries. When unset, the kernel's default will be used.</para>
2907 </listitem>
2908 </varlistentry>
798d3a52
ZJS
2909 <varlistentry>
2910 <term><varname>Cost=</varname></term>
2911 <listitem>
47c7dfe2 2912 <para>Sets the "cost" of sending packets of this interface.
a8eaaee7 2913 Each port in a bridge may have a different speed and the cost
798d3a52 2914 is used to decide which link to use. Faster interfaces
785889e5 2915 should have lower costs. It is an integer value between 1 and
b56be296
DJL
2916 65535.</para>
2917 </listitem>
2918 </varlistentry>
2919 <varlistentry>
2920 <term><varname>Priority=</varname></term>
2921 <listitem>
2922 <para>Sets the "priority" of sending packets on this interface.
2923 Each port in a bridge may have a different priority which is used
2924 to decide which link to use. Lower value means higher priority.
785889e5 2925 It is an integer value between 0 to 63. Networkd does not set any
b56be296 2926 default, meaning the kernel default value of 32 is used.</para>
798d3a52
ZJS
2927 </listitem>
2928 </varlistentry>
2929 </variablelist>
2930 </refsect1>
798d3a52
ZJS
2931 <refsect1>
2932 <title>[BridgeFDB] Section Options</title>
bdac5608
ZJS
2933 <para>The [BridgeFDB] section manages the forwarding database table of a port and accepts the following
2934 keys. Specify several [BridgeFDB] sections to configure several static MAC table entries.</para>
798d3a52
ZJS
2935
2936 <variablelist class='network-directives'>
2937 <varlistentry>
2938 <term><varname>MACAddress=</varname></term>
2939 <listitem>
bdac5608 2940 <para>As in the [Network] section. This key is mandatory.</para>
798d3a52
ZJS
2941 </listitem>
2942 </varlistentry>
c2c2793f
SS
2943 <varlistentry>
2944 <term><varname>Destination=</varname></term>
2945 <listitem>
2946 <para>Takes an IP address of the destination VXLAN tunnel endpoint.</para>
2947 </listitem>
2948 </varlistentry>
798d3a52
ZJS
2949 <varlistentry>
2950 <term><varname>VLANId=</varname></term>
2951 <listitem>
a8eaaee7 2952 <para>The VLAN ID for the new static MAC table entry. If
db9b9fb9 2953 omitted, no VLAN ID information is appended to the new static MAC
798d3a52
ZJS
2954 table entry.</para>
2955 </listitem>
2956 </varlistentry>
61b824c5
SS
2957 <varlistentry>
2958 <term><varname>VNI=</varname></term>
2959 <listitem>
2960 <para>The VXLAN Network Identifier (or VXLAN Segment ID) to use to connect to
1d3a473b 2961 the remote VXLAN tunnel endpoint. Takes a number in the range 1…16777215.
61b824c5
SS
2962 Defaults to unset.</para>
2963 </listitem>
2964 </varlistentry>
bdb397ed
SS
2965 <varlistentry>
2966 <term><varname>AssociatedWith=</varname></term>
2967 <listitem>
2968 <para>Specifies where the address is associated with. Takes one of <literal>use</literal>,
2969 <literal>self</literal>, <literal>master</literal> or <literal>router</literal>.
2970 <literal>use</literal> means the address is in use. User space can use this option to
2971 indicate to the kernel that the fdb entry is in use. <literal>self</literal> means
2972 the address is associated with the port drivers fdb. Usually hardware. <literal>master</literal>
2973 means the address is associated with master devices fdb. <literal>router</literal> means
2974 the destination address is associated with a router. Note that it's valid if the referenced
2975 device is a VXLAN type device and has route shortcircuit enabled. Defaults to <literal>self</literal>.</para>
2976 </listitem>
2977 </varlistentry>
af99cdf4
SS
2978 <varlistentry>
2979 <term><varname>OutgoingInterface=</varname></term>
2980 <listitem>
2981 <para>Specifies the name or index of the outgoing interface for the VXLAN device driver to
2982 reach the remote VXLAN tunnel endpoint. Defaults to unset.</para>
2983 </listitem>
2984 </varlistentry>
798d3a52
ZJS
2985 </variablelist>
2986 </refsect1>
a1717e9a
DM
2987 <refsect1>
2988 <title>[BridgeMDB] Section Options</title>
2989 <para>The [BridgeMDB] section manages the multicast membership entries forwarding database table of a port and accepts the following
2990 keys. Specify several [BridgeMDB] sections to configure several permanent multicast membership entries.</para>
2991
2992 <variablelist class='network-directives'>
2993 <varlistentry>
2994 <term><varname>MulticastGroupAddress=</varname></term>
2995 <listitem>
2996 <para>Specifies the IPv4 or IPv6 multicast group address to add. This setting is mandatory.</para>
2997 </listitem>
2998 </varlistentry>
2999 <varlistentry>
3000 <term><varname>VLANId=</varname></term>
3001 <listitem>
3002 <para>The VLAN ID for the new entry. Valid ranges are 0 (no VLAN) to 4094. Optional, defaults to 0.</para>
3003 </listitem>
3004 </varlistentry>
3005 </variablelist>
3006 </refsect1>
06828bb6 3007
e9a8c550
SS
3008 <refsect1>
3009 <title>[LLDP] Section Options</title>
bdac5608 3010 <para>The [LLDP] section manages the Link Layer Discovery Protocol (LLDP) and accepts the following
885a4e6c 3011 keys:</para>
e9a8c550
SS
3012 <variablelist class='network-directives'>
3013 <varlistentry>
3014 <term><varname>MUDURL=</varname></term>
3015 <listitem>
0558f303
ZJS
3016 <para>When configured, the specified Manufacturer Usage Descriptions (MUD) URL will be sent in
3017 LLDP packets. The syntax and semantics are the same as for <varname>MUDURL=</varname> in the
3018 [DHCPv4] section described above.</para>
3019
3020 <para>The MUD URLs received via LLDP packets are saved and can be read using the
e9a8c550
SS
3021 <function>sd_lldp_neighbor_get_mud_url()</function> function.</para>
3022 </listitem>
3023 </varlistentry>
3024 </variablelist>
3025 </refsect1>
3026
06828bb6
HP
3027 <refsect1>
3028 <title>[CAN] Section Options</title>
bdac5608
ZJS
3029 <para>The [CAN] section manages the Controller Area Network (CAN bus) and accepts the
3030 following keys:</para>
06828bb6
HP
3031 <variablelist class='network-directives'>
3032 <varlistentry>
3033 <term><varname>BitRate=</varname></term>
3034 <listitem>
3035 <para>The bitrate of CAN device in bits per second. The usual SI prefixes (K, M) with the base of 1000 can
1d3a473b 3036 be used here. Takes a number in the range 1…4294967295.</para>
06828bb6
HP
3037 </listitem>
3038 </varlistentry>
3039 <varlistentry>
3040 <term><varname>SamplePoint=</varname></term>
3041 <listitem>
3042 <para>Optional sample point in percent with one decimal (e.g. <literal>75%</literal>,
817561cc
YW
3043 <literal>87.5%</literal>) or permille (e.g. <literal>875‰</literal>). This will be ignored when
3044 <varname>BitRate=</varname> is unspecified.</para>
06828bb6
HP
3045 </listitem>
3046 </varlistentry>
b164b570
YW
3047 <varlistentry>
3048 <term><varname>TimeQuantaNSec=</varname></term>
3049 <term><varname>PropagationSegment=</varname></term>
3050 <term><varname>PhaseBufferSegment1=</varname></term>
3051 <term><varname>PhaseBufferSegment2=</varname></term>
3052 <term><varname>SyncJumpWidth=</varname></term>
3053 <listitem>
3054 <para>Specifies the time quanta, propagation segment, phase buffer segment 1 and 2, and the
3055 synchronization jump width, which allow to define the CAN bit-timing in a hardware
3056 independent format as proposed by the Bosch CAN 2.0 Specification.
3057 <varname>TimeQuantaNSec=</varname> takes a timespan in nanoseconds.
3058 <varname>PropagationSegment=</varname>, <varname>PhaseBufferSegment1=</varname>,
3059 <varname>PhaseBufferSegment2=</varname>, and <varname>SyncJumpWidth=</varname> take number
3060 of time quantum specified in <varname>TimeQuantaNSec=</varname> and must be an unsigned
3061 integer in the range 0…4294967295. These settings except for
3062 <varname>SyncJumpWidth=</varname> will be ignored when <varname>BitRate=</varname> is
3063 specified.</para>
06828bb6
HP
3064 </listitem>
3065 </varlistentry>
7e025e9c
RP
3066 <varlistentry>
3067 <term><varname>DataBitRate=</varname></term>
3068 <term><varname>DataSamplePoint=</varname></term>
3069 <listitem>
3070 <para>The bitrate and sample point for the data phase, if CAN-FD is used. These settings are
3071 analogous to the <varname>BitRate=</varname> and <varname>SamplePoint=</varname> keys.</para>
3072 </listitem>
3073 </varlistentry>
b164b570
YW
3074 <varlistentry>
3075 <term><varname>DataTimeQuantaNSec=</varname></term>
3076 <term><varname>DataPropagationSegment=</varname></term>
3077 <term><varname>DataPhaseBufferSegment1=</varname></term>
3078 <term><varname>DataPhaseBufferSegment2=</varname></term>
3079 <term><varname>DataSyncJumpWidth=</varname></term>
3080 <listitem>
3081 <para>Specifies the time quanta, propagation segment, phase buffer segment 1 and 2, and the
3082 synchronization jump width for the data phase, if CAN-FD is used. These settings are
3083 analogous to the <varname>TimeQuantaNSec=</varname> or related settings.</para>
3084 </listitem>
3085 </varlistentry>
7e025e9c
RP
3086 <varlistentry>
3087 <term><varname>FDMode=</varname></term>
3088 <listitem>
3089 <para>Takes a boolean. When <literal>yes</literal>, CAN-FD mode is enabled for the interface.
3090 Note, that a bitrate and optional sample point should also be set for the CAN-FD data phase using
b164b570
YW
3091 the <varname>DataBitRate=</varname> and <varname>DataSamplePoint=</varname> keys, or
3092 <varname>DataTimeQuanta=</varname> and related settings.</para>
7e025e9c
RP
3093 </listitem>
3094 </varlistentry>
3095 <varlistentry>
3096 <term><varname>FDNonISO=</varname></term>
3097 <listitem>
3098 <para>Takes a boolean. When <literal>yes</literal>, non-ISO CAN-FD mode is enabled for the
3099 interface. When unset, the kernel's default will be used.</para>
3100 </listitem>
3101 </varlistentry>
06828bb6
HP
3102 <varlistentry>
3103 <term><varname>RestartSec=</varname></term>
3104 <listitem>
3105 <para>Automatic restart delay time. If set to a non-zero value, a restart of the CAN controller will be
3106 triggered automatically in case of a bus-off condition after the specified delay time. Subsecond delays can
3107 be specified using decimals (e.g. <literal>0.1s</literal>) or a <literal>ms</literal> or
3108 <literal>us</literal> postfix. Using <literal>infinity</literal> or <literal>0</literal> will turn the
3109 automatic restart off. By default automatic restart is disabled.</para>
3110 </listitem>
3111 </varlistentry>
52aa38f1
MR
3112 <varlistentry>
3113 <term><varname>Termination=</varname></term>
3114 <listitem>
69978eb9 3115 <para>Takes a boolean or a termination resistor value in ohm in the range 0…65535. When
239f91f7
YW
3116 <literal>yes</literal>, the termination resistor is set to 120 ohm. When
3117 <literal>no</literal> or <literal>0</literal> is set, the termination resistor is disabled.
3118 When unset, the kernel's default will be used.</para>
52aa38f1
MR
3119 </listitem>
3120 </varlistentry>
c423be28
CG
3121 <varlistentry>
3122 <term><varname>TripleSampling=</varname></term>
3123 <listitem>
3124 <para>Takes a boolean. When <literal>yes</literal>, three samples (instead of one) are used to determine
3125 the value of a received bit by majority rule. When unset, the kernel's default will be used.</para>
3126 </listitem>
3127 </varlistentry>
77b67404
3128 <varlistentry>
3129 <term><varname>BusErrorReporting=</varname></term>
3130 <listitem>
3131 <para>Takes a boolean. When <literal>yes</literal>, reporting of CAN bus errors is activated
3132 (those include single bit, frame format, and bit stuffing errors, unable to send dominant bit,
3133 unable to send recessive bit, bus overload, active error announcement, error occurred on
3134 transmission). When unset, the kernel's default will be used. Note: in case of a CAN bus with a
3135 single CAN device, sending a CAN frame may result in a huge number of CAN bus errors.</para>
3136 </listitem>
3137 </varlistentry>
74f0fb90
YW
3138 <varlistentry>
3139 <term><varname>ListenOnly=</varname></term>
3140 <listitem>
3141 <para>Takes a boolean. When <literal>yes</literal>, listen-only mode is enabled. When the
3142 interface is in listen-only mode, the interface neither transmit CAN frames nor send ACK
3143 bit. Listen-only mode is important to debug CAN networks without interfering with the
3144 communication or acknowledge the CAN frame. When unset, the kernel's default will be used.
3145 </para>
3146 </listitem>
3147 </varlistentry>
6dd84c9e
YW
3148 <varlistentry>
3149 <term><varname>Loopback=</varname></term>
3150 <listitem>
3151 <para>Takes a boolean. When <literal>yes</literal>, loopback mode is enabled. When the
3152 loopback mode is enabled, the interface treats messages transmitted by itself as received
3153 messages. The loopback mode is important to debug CAN networks. When unset, the kernel's
3154 default will be used.</para>
3155 </listitem>
3156 </varlistentry>
3157 <varlistentry>
3158 <term><varname>OneShot=</varname></term>
3159 <listitem>
3160 <para>Takes a boolean. When <literal>yes</literal>, one-shot mode is enabled. When unset,
3161 the kernel's default will be used.</para>
3162 </listitem>
3163 </varlistentry>
3164 <varlistentry>
3165 <term><varname>PresumeAck=</varname></term>
3166 <listitem>
3167 <para>Takes a boolean. When <literal>yes</literal>, the interface will ignore missing CAN
3168 ACKs. When unset, the kernel's default will be used.</para>
3169 </listitem>
3170 </varlistentry>
3171 <varlistentry>
3172 <term><varname>ClassicDataLengthCode=</varname></term>
3173 <listitem>
3174 <para>Takes a boolean. When <literal>yes</literal>, the interface will handle the 4bit data
3175 length code (DLC). When unset, the kernel's default will be used.</para>
3176 </listitem>
3177 </varlistentry>
06828bb6
HP
3178 </variablelist>
3179 </refsect1>
3180
2ed5f6d5
YW
3181 <refsect1>
3182 <title>[QDisc] Section Options</title>
bdac5608 3183 <para>The [QDisc] section manages the traffic control queueing discipline (qdisc).</para>
2ed5f6d5
YW
3184
3185 <variablelist class='network-directives'>
3186 <varlistentry>
3187 <term><varname>Parent=</varname></term>
3188 <listitem>
3189 <para>Specifies the parent Queueing Discipline (qdisc). Takes one of <literal>clsact</literal>
3190 or <literal>ingress</literal>. This is mandatory.</para>
3191 </listitem>
3192 </varlistentry>
d8b2396d 3193
f344a492 3194 <xi:include href="tc.xml" xpointer="qdisc-handle" />
2ed5f6d5
YW
3195 </variablelist>
3196 </refsect1>
3197
0f5bd7fe 3198 <refsect1>
18de0969 3199 <title>[NetworkEmulator] Section Options</title>
bdac5608
ZJS
3200 <para>The [NetworkEmulator] section manages the queueing discipline (qdisc) of the network emulator. It
3201 can be used to configure the kernel packet scheduler and simulate packet delay and loss for UDP or TCP
3202 applications, or limit the bandwidth usage of a particular service to simulate internet connections.
3203 </para>
0f5bd7fe
SS
3204
3205 <variablelist class='network-directives'>
f344a492
YW
3206 <xi:include href="tc.xml" xpointer="qdisc-parent" />
3207 <xi:include href="tc.xml" xpointer="qdisc-handle" />
d8b2396d 3208
0f5bd7fe 3209 <varlistentry>
18de0969 3210 <term><varname>DelaySec=</varname></term>
0f5bd7fe
SS
3211 <listitem>
3212 <para>Specifies the fixed amount of delay to be added to all packets going out of the
3213 interface. Defaults to unset.</para>
3214 </listitem>
3215 </varlistentry>
3216
3217 <varlistentry>
18de0969 3218 <term><varname>DelayJitterSec=</varname></term>
0f5bd7fe
SS
3219 <listitem>
3220 <para>Specifies the chosen delay to be added to the packets outgoing to the network
3221 interface. Defaults to unset.</para>
3222 </listitem>
3223 </varlistentry>
3224
3225 <varlistentry>
18de0969 3226 <term><varname>PacketLimit=</varname></term>
0f5bd7fe
SS
3227 <listitem>
3228 <para>Specifies the maximum number of packets the qdisc may hold queued at a time.
69978eb9 3229 An unsigned integer in the range 0…4294967294. Defaults to 1000.</para>
0f5bd7fe
SS
3230 </listitem>
3231 </varlistentry>
3232
3233 <varlistentry>
18de0969 3234 <term><varname>LossRate=</varname></term>
0f5bd7fe
SS
3235 <listitem>
3236 <para>Specifies an independent loss probability to be added to the packets outgoing from the
3237 network interface. Takes a percentage value, suffixed with "%". Defaults to unset.</para>
3238 </listitem>
3239 </varlistentry>
3240
b9c5aa3c 3241 <varlistentry>
18de0969 3242 <term><varname>DuplicateRate=</varname></term>
b9c5aa3c
SS
3243 <listitem>
3244 <para>Specifies that the chosen percent of packets is duplicated before queuing them.
3245 Takes a percentage value, suffixed with "%". Defaults to unset.</para>
3246 </listitem>
3247 </varlistentry>
18de0969
YW
3248 </variablelist>
3249 </refsect1>
b9c5aa3c 3250
18de0969 3251 <refsect1>
60ed2dcf 3252 <title>[TokenBucketFilter] Section Options</title>
e9dd6984
ZJS
3253 <para>The [TokenBucketFilter] section manages the queueing discipline (qdisc) of token bucket filter
3254 (tbf).</para>
18de0969
YW
3255
3256 <variablelist class='network-directives'>
f344a492
YW
3257 <xi:include href="tc.xml" xpointer="qdisc-parent" />
3258 <xi:include href="tc.xml" xpointer="qdisc-handle" />
d8b2396d 3259
18de0969
YW
3260 <varlistentry>
3261 <term><varname>LatencySec=</varname></term>
ba5841b5
SS
3262 <listitem>
3263 <para>Specifies the latency parameter, which specifies the maximum amount of time a
60ed2dcf 3264 packet can sit in the Token Bucket Filter (TBF). Defaults to unset.</para>
ba5841b5
SS
3265 </listitem>
3266 </varlistentry>
3267
dcfc23ae 3268 <varlistentry>
c03ef420 3269 <term><varname>LimitBytes=</varname></term>
dcfc23ae
YW
3270 <listitem>
3271 <para>Takes the number of bytes that can be queued waiting for tokens to become available.
3272 When the size is suffixed with K, M, or G, it is parsed as Kilobytes, Megabytes, or Gigabytes,
c03ef420 3273 respectively, to the base of 1024. Defaults to unset.</para>
dcfc23ae
YW
3274 </listitem>
3275 </varlistentry>
3276
ba5841b5 3277 <varlistentry>
c03ef420 3278 <term><varname>BurstBytes=</varname></term>
ba5841b5
SS
3279 <listitem>
3280 <para>Specifies the size of the bucket. This is the maximum amount of bytes that tokens
3281 can be available for instantaneous transfer. When the size is suffixed with K, M, or G, it is
c03ef420 3282 parsed as Kilobytes, Megabytes, or Gigabytes, respectively, to the base of 1024. Defaults to
ba5841b5
SS
3283 unset.</para>
3284 </listitem>
3285 </varlistentry>
3286
3287 <varlistentry>
18de0969 3288 <term><varname>Rate=</varname></term>
ba5841b5
SS
3289 <listitem>
3290 <para>Specifies the device specific bandwidth. When suffixed with K, M, or G, the specified
6b8fe4c3 3291 bandwidth is parsed as Kilobits, Megabits, or Gigabits, respectively, to the base of 1000.
ba5841b5
SS
3292 Defaults to unset.</para>
3293 </listitem>
3294 </varlistentry>
3295
dcfc23ae 3296 <varlistentry>
18de0969 3297 <term><varname>MPUBytes=</varname></term>
dcfc23ae
YW
3298 <listitem>
3299 <para>The Minimum Packet Unit (MPU) determines the minimal token usage (specified in bytes)
3300 for a packet. When suffixed with K, M, or G, the specified size is parsed as Kilobytes,
c03ef420 3301 Megabytes, or Gigabytes, respectively, to the base of 1024. Defaults to zero.</para>
dcfc23ae
YW
3302 </listitem>
3303 </varlistentry>
3304
3305 <varlistentry>
18de0969 3306 <term><varname>PeakRate=</varname></term>
dcfc23ae
YW
3307 <listitem>
3308 <para>Takes the maximum depletion rate of the bucket. When suffixed with K, M, or G, the
6b8fe4c3 3309 specified size is parsed as Kilobits, Megabits, or Gigabits, respectively, to the base of
dcfc23ae
YW
3310 1000. Defaults to unset.</para>
3311 </listitem>
3312 </varlistentry>
3313
3314 <varlistentry>
18de0969 3315 <term><varname>MTUBytes=</varname></term>
dcfc23ae
YW
3316 <listitem>
3317 <para>Specifies the size of the peakrate bucket. When suffixed with K, M, or G, the specified
c03ef420 3318 size is parsed as Kilobytes, Megabytes, or Gigabytes, respectively, to the base of 1024.
dcfc23ae
YW
3319 Defaults to unset.</para>
3320 </listitem>
3321 </varlistentry>
18de0969
YW
3322 </variablelist>
3323 </refsect1>
3324
bde4ae88
SS
3325 <refsect1>
3326 <title>[PIE] Section Options</title>
bdac5608
ZJS
3327 <para>The [PIE] section manages the queueing discipline (qdisc) of Proportional Integral
3328 controller-Enhanced (PIE).</para>
bde4ae88
SS
3329
3330 <variablelist class='network-directives'>
f344a492
YW
3331 <xi:include href="tc.xml" xpointer="qdisc-parent" />
3332 <xi:include href="tc.xml" xpointer="qdisc-handle" />
bde4ae88
SS
3333
3334 <varlistentry>
3335 <term><varname>PacketLimit=</varname></term>
3336 <listitem>
1d3a473b
ZJS
3337 <para>Specifies the hard limit on the queue size in number of packets. When this limit is reached,
3338 incoming packets are dropped. An unsigned integer in the range 1…4294967294. Defaults to unset and
3339 kernel's default is used.</para>
8f6b6d70
SS
3340 </listitem>
3341 </varlistentry>
3342 </variablelist>
3343 </refsect1>
3344
3345 <refsect1>
3346 <title>[FlowQueuePIE] Section Options</title>
3347 <para>The <literal>[FlowQueuePIE]</literal> section manages the queueing discipline
3348 (qdisc) of Flow Queue Proportional Integral controller-Enhanced (fq_pie).</para>
3349
3350 <variablelist class='network-directives'>
3351 <xi:include href="tc.xml" xpointer="qdisc-parent" />
3352 <xi:include href="tc.xml" xpointer="qdisc-handle" />
3353
3354 <varlistentry>
3355 <term><varname>PacketLimit=</varname></term>
3356 <listitem>
75909cc7
ZJS
3357 <para>Specifies the hard limit on the queue size in number of packets. When this limit is reached,
3358 incoming packets are dropped. An unsigned integer ranges 1 to 4294967294. Defaults to unset and
3359 kernel's default is used.</para>
bde4ae88
SS
3360 </listitem>
3361 </varlistentry>
3362 </variablelist>
3363 </refsect1>
3364
982998b0
SS
3365 <refsect1>
3366 <title>[StochasticFairBlue] Section Options</title>
bdac5608
ZJS
3367 <para>The [StochasticFairBlue] section manages the queueing discipline (qdisc) of stochastic fair blue
3368 (sfb).</para>
982998b0
SS
3369
3370 <variablelist class='network-directives'>
f344a492
YW
3371 <xi:include href="tc.xml" xpointer="qdisc-parent" />
3372 <xi:include href="tc.xml" xpointer="qdisc-handle" />
982998b0
SS
3373
3374 <varlistentry>
3375 <term><varname>PacketLimit=</varname></term>
3376 <listitem>
e9dd6984 3377 <para>Specifies the hard limit on the queue size in number of packets. When this limit is reached,
69978eb9 3378 incoming packets are dropped. An unsigned integer in the range 0…4294967294. Defaults to unset and
e9dd6984 3379 kernel's default is used.</para>
982998b0
SS
3380 </listitem>
3381 </varlistentry>
3382 </variablelist>
3383 </refsect1>
3384
18de0969
YW
3385 <refsect1>
3386 <title>[StochasticFairnessQueueing] Section Options</title>
bdac5608
ZJS
3387 <para>The [StochasticFairnessQueueing] section manages the queueing discipline (qdisc) of stochastic
3388 fairness queueing (sfq).</para>
18de0969
YW
3389
3390 <variablelist class='network-directives'>
f344a492
YW
3391 <xi:include href="tc.xml" xpointer="qdisc-parent" />
3392 <xi:include href="tc.xml" xpointer="qdisc-handle" />
d8b2396d 3393
9942b710 3394 <varlistentry>
18de0969 3395 <term><varname>PerturbPeriodSec=</varname></term>
9942b710
SS
3396 <listitem>
3397 <para>Specifies the interval in seconds for queue algorithm perturbation. Defaults to unset.</para>
3398 </listitem>
3399 </varlistentry>
18de0969
YW
3400 </variablelist>
3401 </refsect1>
3402
c853f594
SS
3403 <refsect1>
3404 <title>[BFIFO] Section Options</title>
bdac5608
ZJS
3405 <para>The [BFIFO] section manages the queueing discipline (qdisc) of Byte limited Packet First In First
3406 Out (bfifo).</para>
c853f594
SS
3407
3408 <variablelist class='network-directives'>
f344a492
YW
3409 <xi:include href="tc.xml" xpointer="qdisc-parent" />
3410 <xi:include href="tc.xml" xpointer="qdisc-handle" />
c853f594
SS
3411
3412 <varlistentry>
c03ef420 3413 <term><varname>LimitBytes=</varname></term>
c853f594 3414 <listitem>
885a4e6c
ZJS
3415 <para>Specifies the hard limit in bytes on the FIFO buffer size. The size limit prevents overflow
3416 in case the kernel is unable to dequeue packets as quickly as it receives them. When this limit is
3417 reached, incoming packets are dropped. When suffixed with K, M, or G, the specified size is parsed
3418 as Kilobytes, Megabytes, or Gigabytes, respectively, to the base of 1024. Defaults to unset and
3419 kernel default is used.</para>
c853f594
SS
3420 </listitem>
3421 </varlistentry>
3422 </variablelist>
3423 </refsect1>
3424
a7476065
SS
3425 <refsect1>
3426 <title>[PFIFO] Section Options</title>
bdac5608
ZJS
3427 <para>The [PFIFO] section manages the queueing discipline (qdisc) of Packet First In First Out
3428 (pfifo).</para>
a7476065
SS
3429
3430 <variablelist class='network-directives'>
f344a492
YW
3431 <xi:include href="tc.xml" xpointer="qdisc-parent" />
3432 <xi:include href="tc.xml" xpointer="qdisc-handle" />
a7476065
SS
3433
3434 <varlistentry>
3435 <term><varname>PacketLimit=</varname></term>
3436 <listitem>
75909cc7
ZJS
3437 <para>Specifies the hard limit on the number of packets in the FIFO queue. The size limit prevents
3438 overflow in case the kernel is unable to dequeue packets as quickly as it receives them. When this
3439 limit is reached, incoming packets are dropped. An unsigned integer in the range
69978eb9 3440 0…4294967294. Defaults to unset and kernel's default is used.</para>
a7476065
SS
3441 </listitem>
3442 </varlistentry>
ad8352f4
SS
3443 </variablelist>
3444 </refsect1>
3445
053a2ddb
SS
3446 <refsect1>
3447 <title>[PFIFOHeadDrop] Section Options</title>
bdac5608
ZJS
3448 <para>The [PFIFOHeadDrop] section manages the queueing discipline (qdisc) of Packet First In First Out
3449 Head Drop (pfifo_head_drop).</para>
053a2ddb
SS
3450
3451 <variablelist class='network-directives'>
f344a492
YW
3452 <xi:include href="tc.xml" xpointer="qdisc-parent" />
3453 <xi:include href="tc.xml" xpointer="qdisc-handle" />
053a2ddb
SS
3454
3455 <varlistentry>
3456 <term><varname>PacketLimit=</varname></term>
3457 <listitem>
bdac5608 3458 <para>As in [PFIFO] section.</para></listitem>
053a2ddb
SS
3459 </varlistentry>
3460 </variablelist>
3461 </refsect1>
3462
1a95964b
SS
3463 <refsect1>
3464 <title>[PFIFOFast] Section Options</title>
bdac5608
ZJS
3465 <para>The [PFIFOFast] section manages the queueing discipline (qdisc) of Packet First In First Out Fast
3466 (pfifo_fast).</para>
1a95964b
SS
3467
3468 <variablelist class='network-directives'>
f344a492
YW
3469 <xi:include href="tc.xml" xpointer="qdisc-parent" />
3470 <xi:include href="tc.xml" xpointer="qdisc-handle" />
1a95964b
SS
3471 </variablelist>
3472 </refsect1>
3473
ad8352f4
SS
3474 <refsect1>
3475 <title>[CAKE] Section Options</title>
bdac5608
ZJS
3476 <para>The [CAKE] section manages the queueing discipline (qdisc) of Common Applications Kept Enhanced
3477 (CAKE).</para>
ad8352f4
SS
3478
3479 <variablelist class='network-directives'>
f344a492
YW
3480 <xi:include href="tc.xml" xpointer="qdisc-parent" />
3481 <xi:include href="tc.xml" xpointer="qdisc-handle" />
a7476065 3482
ad8352f4 3483 <varlistentry>
ca2c3e92 3484 <term><varname>Bandwidth=</varname></term>
ad8352f4 3485 <listitem>
ca2c3e92
YW
3486 <para>Specifies the shaper bandwidth. When suffixed with K, M, or G, the specified size is
3487 parsed as Kilobits, Megabits, or Gigabits, respectively, to the base of 1000. Defaults to
3488 unset and kernel's default is used.</para>
ad8352f4 3489 </listitem>
f344a492 3490 </varlistentry>
ad8352f4 3491
025cd94e
YW
3492 <varlistentry>
3493 <term><varname>AutoRateIngress=</varname></term>
3494 <listitem>
3495 <para>Takes a boolean value. Enables automatic capacity estimation based on traffic arriving
3496 at this qdisc. This is most likely to be useful with cellular links, which tend to change
3497 quality randomly. If this setting is enabled, the <varname>Bandwidth=</varname> setting is
3498 used as an initial estimate. Defaults to unset, and the kernel's default is used.</para>
3499 </listitem>
3500 </varlistentry>
3501
ad8352f4 3502 <varlistentry>
c03ef420 3503 <term><varname>OverheadBytes=</varname></term>
ad8352f4 3504 <listitem>
69978eb9
YW
3505 <para>Specifies that bytes to be addeded to the size of each packet. Bytes may be negative.
3506 Takes an integer in the range -64…256. Defaults to unset and kernel's default is used.
3507 </para>
ad8352f4 3508 </listitem>
f344a492 3509 </varlistentry>
ad8352f4
SS
3510
3511 <varlistentry>
863542e1 3512 <term><varname>MPUBytes=</varname></term>
ad8352f4 3513 <listitem>
863542e1
YW
3514 <para>Rounds each packet (including overhead) up to the specified bytes. Takes an integer in
3515 the range 1…256. Defaults to unset and kernel's default is used.</para>
3516 </listitem>
3517 </varlistentry>
3518
b6eccfda
YW
3519 <varlistentry>
3520 <term><varname>CompensationMode=</varname></term>
3521 <listitem>
3522 <para>Takes one of <literal>none</literal>, <literal>atm</literal>, or <literal>ptm</literal>.
3523 Specifies the compensation mode for overhead calculation. When <literal>none</literal>, no
3524 compensation is taken into account. When <literal>atm</literal>, enables the compensation for
3525 ATM cell framing, which is normally found on ADSL links. When <literal>ptm</literal>, enables
3526 the compensation for PTM encoding, which is normally found on VDSL2 links and uses a 64b/65b
3527 encoding scheme. Defaults to unset and the kernel's default is used.</para>
3528 </listitem>
3529 </varlistentry>
3530
1c7a81e6
YW
3531 <varlistentry>
3532 <term><varname>UseRawPacketSize=</varname></term>
3533 <listitem>
3534 <para>Takes a boolean value. When true, the packet size reported by the Linux kernel will be
3535 used, instead of the underlying IP packet size. Defaults to unset, and the kernel's default
3536 is used.</para>
3537 </listitem>
3538 </varlistentry>
3539
a049cf16
YW
3540 <varlistentry>
3541 <term><varname>FlowIsolationMode=</varname></term>
3542 <listitem>
3543 <para>CAKE places packets from different flows into different queues, then packets from each
3544 queue are delivered fairly. This specifies whether the fairness is based on source address,
3545 destination address, individual flows, or any combination of those. The available values are:
3546 </para>
3547
3548 <variablelist>
3549 <varlistentry>
3550 <term><option>none</option></term>
3551 <listitem><para>
3552 The flow isolation is disabled, and all traffic passes through a single queue.
3553 </para></listitem>
3554 </varlistentry>
3555 <varlistentry>
3556 <term><option>src-host</option></term>
3557 <listitem><para>
3558 Flows are defined only by source address. Equivalnet to the <literal>srchost</literal>
3559 option for <command>tc qdisc</command> command. See also
3560 <citerefentry project='man-pages'><refentrytitle>tc-cake</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
3561 </para></listitem>
3562 </varlistentry>
3563 <varlistentry>
3564 <term><option>dst-host</option></term>
3565 <listitem><para>
3566 Flows are defined only by destination address. Equivalnet to the
3567 <literal>srchost</literal> option for <command>tc qdisc</command> command. See also
3568 <citerefentry project='man-pages'><refentrytitle>tc-cake</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
3569 </para></listitem>
3570 </varlistentry>
3571 <varlistentry>
3572 <term><option>hosts</option></term>
3573 <listitem><para>
3574 Flows are defined by source-destination host pairs. Equivalent to the same option for
3575 <command>tc qdisc</command> command. See also
3576 <citerefentry project='man-pages'><refentrytitle>tc-cake</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
3577 </para></listitem>
3578 </varlistentry>
3579 <varlistentry>
3580 <term><option>flows</option></term>
3581 <listitem><para>
3582 Flows are defined by the entire 5-tuple of source address, destination address,
3583 transport protocol, source port and destination port. Equivalent to the same option for
3584 <command>tc qdisc</command> command. See also
3585 <citerefentry project='man-pages'><refentrytitle>tc-cake</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
3586 </para></listitem>
3587 </varlistentry>
3588 <varlistentry>
3589 <term><option>dual-src-host</option></term>
3590 <listitem><para>
3591 Flows are defined by the 5-tuple (see <literal>flows</literal> in the above), and
3592 fairness is applied first over source addresses, then over individual flows. Equivalnet
3593 to the <literal>dual-srchost</literal> option for <command>tc qdisc</command> command.
3594 See also
3595 <citerefentry project='man-pages'><refentrytitle>tc-cake</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
3596 </para></listitem>
3597 </varlistentry>
3598 <varlistentry>
3599 <term><option>dual-dst-host</option></term>
3600 <listitem><para>
3601 Flows are defined by the 5-tuple (see <literal>flows</literal> in the above), and
3602 fairness is applied first over destination addresses, then over individual flows.
3603 Equivalnet to the <literal>dual-dsthost</literal> option for
3604 <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>triple</option></term>
3610 <listitem><para>
3611 Flows are defined by the 5-tuple (see <literal>flows</literal>), and fairness is
3612 applied over source and destination addresses, and also over individual flows.
3613 Equivalnet to the <literal>triple-isolate</literal> option for
3614 <command>tc qdisc</command> command. See also
3615 <citerefentry project='man-pages'><refentrytitle>tc-cake</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
3616 </para></listitem>
3617 </varlistentry>
3618 </variablelist>
3619
3620 <para>Defaults to unset and the kernel's default is used.</para>
3621 </listitem>
3622 </varlistentry>
3623
4bff8086
YW
3624 <varlistentry>
3625 <term><varname>NAT=</varname></term>
3626 <listitem>
3627 <para>Takes a boolean value. When true, CAKE performs a NAT lookup before applying
3628 flow-isolation rules, to determine the true addresses and port numbers of the packet, to
3629 improve fairness between hosts inside the NAT. This has no practical effect when
3630 <varname>FlowIsolationMode=</varname> is <literal>none</literal> or <literal>flows</literal>,
3631 or if NAT is performed on a different host. Defaults to unset, and the kernel's default is
3632 used.</para>
3633 </listitem>
3634 </varlistentry>
3635
fe8e156e
YW
3636 <varlistentry>
3637 <term><varname>PriorityQueueingPreset=</varname></term>
3638 <listitem>
3639 <para>CAKE divides traffic into <literal>tins</literal>, and each tin has its own independent
3640 set of flow-isolation queues, bandwidth threshold, and priority. This specifies the preset of
3641 tin profiles. The available values are:</para>
3642
3643 <variablelist>
3644 <varlistentry>
3645 <term><option>besteffort</option></term>
3646 <listitem><para>
3647 Disables priority queueing by placing all traffic in one tin.
3648 </para></listitem>
3649 </varlistentry>
3650 <varlistentry>
3651 <term><option>precedence</option></term>
3652 <listitem><para>
3653 Enables priority queueing based on the legacy interpretation of TOS
3654 <literal>Precedence</literal> field. Use of this preset on the modern Internet is
3655 firmly discouraged.
3656 </para></listitem>
3657 </varlistentry>
3658 <varlistentry>
3659 <term><option>diffserv8</option></term>
3660 <listitem><para>
3661 Enables priority queueing based on the Differentiated Service
3662 (<literal>DiffServ</literal>) field with eight tins: Background Traffic, High
3663 Throughput, Best Effort, Video Streaming, Low Latency Transactions, Interactive Shell,
3664 Minimum Latency, and Network Control.
3665 </para></listitem>
3666 </varlistentry>
3667 <varlistentry>
3668 <term><option>diffserv4</option></term>
3669 <listitem><para>
3670 Enables priority queueing based on the Differentiated Service
3671 (<literal>DiffServ</literal>) field with four tins: Background Traffic, Best Effort,
3672 Streaming Media, and Latency Sensitive.
3673 </para></listitem>
3674 </varlistentry>
3675 <varlistentry>
3676 <term><option>diffserv3</option></term>
3677 <listitem><para>
3678 Enables priority queueing based on the Differentiated Service
3679 (<literal>DiffServ</literal>) field with three tins: Background Traffic, Best Effort,
3680 and Latency Sensitive.
3681 </para></listitem>
3682 </varlistentry>
3683 </variablelist>
3684
3685 <para>Defaults to unset, and the kernel's default is used.</para>
ad8352f4
SS
3686 </listitem>
3687 </varlistentry>
fe8e156e 3688
049b66cc
YW
3689 <varlistentry>
3690 <term><varname>FirewallMark=</varname></term>
3691 <listitem>
3692 <para>Takes an integer in the range 1…4294967295. When specified, firewall-mark-based
3693 overriding of CAKE's tin selection is enabled. Defaults to unset, and the kernel's default is
3694 used.</para>
3695 </listitem>
3696 </varlistentry>
3697
d05dce95
YW
3698 <varlistentry>
3699 <term><varname>Wash=</varname></term>
3700 <listitem>
3701 <para>Takes a boolean value. When true, CAKE clears the DSCP fields, except for ECN bits, of
3702 any packet passing through CAKE. Defaults to unset, and the kernel's default is used.</para>
3703 </listitem>
3704 </varlistentry>
3705
35896db4
YW
3706 <varlistentry>
3707 <term><varname>SplitGSO=</varname></term>
3708 <listitem>
3709 <para>Takes a boolean value. When true, CAKE will split General Segmentation Offload (GSO)
3710 super-packets into their on-the-wire components and dequeue them individually. Defaults to
3711 unset, and the kernel's default is used.</para>
3712 </listitem>
3713 </varlistentry>
3714
a7476065
SS
3715 </variablelist>
3716 </refsect1>
3717
18de0969
YW
3718 <refsect1>
3719 <title>[ControlledDelay] Section Options</title>
bdac5608 3720 <para>The [ControlledDelay] section manages the queueing discipline (qdisc) of
18de0969 3721 controlled delay (CoDel).</para>
9942b710 3722
18de0969 3723 <variablelist class='network-directives'>
f344a492
YW
3724 <xi:include href="tc.xml" xpointer="qdisc-parent" />
3725 <xi:include href="tc.xml" xpointer="qdisc-handle" />
d8b2396d 3726
18de0969
YW
3727 <varlistentry>
3728 <term><varname>PacketLimit=</varname></term>
a9a5d632 3729 <listitem>
e9dd6984 3730 <para>Specifies the hard limit on the queue size in number of packets. When this limit is reached,
69978eb9 3731 incoming packets are dropped. An unsigned integer in the range 0…4294967294. Defaults to unset and
e9dd6984 3732 kernel's default is used.</para>
a9a5d632
SS
3733 </listitem>
3734 </varlistentry>
3735
b078e528 3736 <varlistentry>
18de0969 3737 <term><varname>TargetSec=</varname></term>
b078e528
YW
3738 <listitem>
3739 <para>Takes a timespan. Specifies the acceptable minimum standing/persistent queue delay.
3740 Defaults to unset and kernel's default is used.</para>
3741 </listitem>
3742 </varlistentry>
3743
3744 <varlistentry>
18de0969 3745 <term><varname>IntervalSec=</varname></term>
b078e528
YW
3746 <listitem>
3747 <para>Takes a timespan. This is used to ensure that the measured minimum delay does not
3748 become too stale. Defaults to unset and kernel's default is used.</para>
3749 </listitem>
3750 </varlistentry>
3751
3752 <varlistentry>
18de0969 3753 <term><varname>ECN=</varname></term>
b078e528
YW
3754 <listitem>
3755 <para>Takes a boolean. This can be used to mark packets instead of dropping them. Defaults to
3756 unset and kernel's default is used.</para>
3757 </listitem>
3758 </varlistentry>
3759
3760 <varlistentry>
18de0969 3761 <term><varname>CEThresholdSec=</varname></term>
b078e528
YW
3762 <listitem>
3763 <para>Takes a timespan. This sets a threshold above which all packets are marked with ECN
3764 Congestion Experienced (CE). Defaults to unset and kernel's default is used.</para>
3765 </listitem>
3766 </varlistentry>
18de0969
YW
3767 </variablelist>
3768 </refsect1>
b078e528 3769
f5fc0441
SS
3770 <refsect1>
3771 <title>[DeficitRoundRobinScheduler] Section Options</title>
bdac5608
ZJS
3772 <para>The [DeficitRoundRobinScheduler] section manages the queueing discipline (qdisc) of Deficit Round
3773 Robin Scheduler (DRR).</para>
f5fc0441
SS
3774
3775 <variablelist class='network-directives'>
f344a492
YW
3776 <xi:include href="tc.xml" xpointer="qdisc-parent" />
3777 <xi:include href="tc.xml" xpointer="qdisc-handle" />
f5fc0441
SS
3778 </variablelist>
3779 </refsect1>
3780
ad365c5d
YW
3781 <refsect1>
3782 <title>[DeficitRoundRobinSchedulerClass] Section Options</title>
bdac5608
ZJS
3783 <para>The [DeficitRoundRobinSchedulerClass] section manages the traffic control class of Deficit Round
3784 Robin Scheduler (DRR).</para>
ad365c5d
YW
3785
3786 <variablelist class='network-directives'>
f344a492
YW
3787 <xi:include href="tc.xml" xpointer="tclass-parent" />
3788 <xi:include href="tc.xml" xpointer="tclass-classid" />
ad365c5d
YW
3789
3790 <varlistentry>
c03ef420 3791 <term><varname>QuantumBytes=</varname></term>
ad365c5d 3792 <listitem>
c03ef420
YW
3793 <para>Specifies the amount of bytes a flow is allowed to dequeue before the scheduler moves
3794 to the next class. When suffixed with K, M, or G, the specified size is parsed as Kilobytes,
3795 Megabytes, or Gigabytes, respectively, to the base of 1024. Defaults to the MTU of the
3796 interface.</para>
ad365c5d
YW
3797 </listitem>
3798 </varlistentry>
3799
3800 </variablelist>
3801 </refsect1>
3802
d474aa51
YW
3803 <refsect1>
3804 <title>[EnhancedTransmissionSelection] Section Options</title>
bdac5608
ZJS
3805 <para>The [EnhancedTransmissionSelection] section manages the queueing discipline (qdisc) of Enhanced
3806 Transmission Selection (ETS).</para>
d474aa51
YW
3807
3808 <variablelist class='network-directives'>
3809 <xi:include href="tc.xml" xpointer="qdisc-parent" />
3810 <xi:include href="tc.xml" xpointer="qdisc-handle" />
3811
3812 <varlistentry>
3813 <term><varname>Bands=</varname></term>
3814 <listitem>
69978eb9 3815 <para>Specifies the number of bands. An unsigned integer in the range 1…16. This value has to be at
e9dd6984
ZJS
3816 least large enough to cover the strict bands specified through the <varname>StrictBands=</varname>
3817 and bandwidth-sharing bands specified in <varname>QuantumBytes=</varname>.</para>
d474aa51
YW
3818 </listitem>
3819 </varlistentry>
3820
3821 <varlistentry>
3822 <term><varname>StrictBands=</varname></term>
3823 <listitem>
e9dd6984 3824 <para>Specifies the number of bands that should be created in strict mode. An unsigned integer in
69978eb9 3825 the range 1…16.</para>
d474aa51
YW
3826 </listitem>
3827 </varlistentry>
3828
3829 <varlistentry>
3830 <term><varname>QuantumBytes=</varname></term>
3831 <listitem>
3832 <para>Specifies the white-space separated list of quantum used in band-sharing bands. When
3833 suffixed with K, M, or G, the specified size is parsed as Kilobytes, Megabytes, or Gigabytes,
3834 respectively, to the base of 1024. This setting can be specified multiple times. If an empty
3835 string is assigned, then the all previous assignments are cleared.</para>
3836 </listitem>
3837 </varlistentry>
3838
3839 <varlistentry>
3840 <term><varname>PriorityMap=</varname></term>
3841 <listitem>
885a4e6c
ZJS
3842 <para>The priority map maps the priority of a packet to a band. The argument is a whitespace
3843 separated list of numbers. The first number indicates which band the packets with priority 0 should
3844 be put to, the second is for priority 1, and so on. There can be up to 16 numbers in the list. If
3845 there are fewer, the default band that traffic with one of the unmentioned priorities goes to is
1d3a473b 3846 the last one. Each band number must be in the range 0…255. This setting can be specified multiple
885a4e6c 3847 times. If an empty string is assigned, then the all previous assignments are cleared.</para>
d474aa51
YW
3848 </listitem>
3849 </varlistentry>
3850 </variablelist>
3851 </refsect1>
3852
609e8340
SS
3853 <refsect1>
3854 <title>[GenericRandomEarlyDetection] Section Options</title>
bdac5608
ZJS
3855 <para>The [GenericRandomEarlyDetection] section manages the queueing discipline (qdisc) of Generic Random
3856 Early Detection (GRED).</para>
609e8340
SS
3857
3858 <variablelist class='network-directives'>
f344a492
YW
3859 <xi:include href="tc.xml" xpointer="qdisc-parent" />
3860 <xi:include href="tc.xml" xpointer="qdisc-handle" />
609e8340
SS
3861
3862 <varlistentry>
3863 <term><varname>VirtualQueues=</varname></term>
3864 <listitem>
387f6955 3865 <para>Specifies the number of virtual queues. Takes an integer in the range 1…16. Defaults to unset
1d3a473b 3866 and kernel's default is used.</para>
609e8340
SS
3867 </listitem>
3868 </varlistentry>
3869
3870 <varlistentry>
3871 <term><varname>DefaultVirtualQueue=</varname></term>
3872 <listitem>
3873 <para>Specifies the number of default virtual queue. This must be less than <varname>VirtualQueue=</varname>.
3874 Defaults to unset and kernel's default is used.</para>
3875 </listitem>
3876 </varlistentry>
3877
3878 <varlistentry>
3879 <term><varname>GenericRIO=</varname></term>
3880 <listitem>
3881 <para>Takes a boolean. It turns on the RIO-like buffering scheme. Defaults to
3882 unset and kernel's default is used.</para>
3883 </listitem>
3884 </varlistentry>
3885 </variablelist>
3886 </refsect1>
3887
18de0969
YW
3888 <refsect1>
3889 <title>[FairQueueingControlledDelay] Section Options</title>
bdac5608
ZJS
3890 <para>The [FairQueueingControlledDelay] section manages the queueing discipline (qdisc) of fair queuing
3891 controlled delay (FQ-CoDel).</para>
18de0969
YW
3892
3893 <variablelist class='network-directives'>
f344a492
YW
3894 <xi:include href="tc.xml" xpointer="qdisc-parent" />
3895 <xi:include href="tc.xml" xpointer="qdisc-handle" />
d8b2396d 3896
18de0969
YW
3897 <varlistentry>
3898 <term><varname>PacketLimit=</varname></term>
4e5ef149
SS
3899 <listitem>
3900 <para>Specifies the hard limit on the real queue size. When this limit is reached, incoming packets are
3901 dropped. Defaults to unset and kernel's default is used.</para>
3902 </listitem>
3903 </varlistentry>
3904
ac810b75 3905 <varlistentry>
c03ef420 3906 <term><varname>MemoryLimitBytes=</varname></term>
ac810b75
YW
3907 <listitem>
3908 <para>Specifies the limit on the total number of bytes that can be queued in this FQ-CoDel instance.
3909 When suffixed with K, M, or G, the specified size is parsed as Kilobytes, Megabytes, or Gigabytes,
3910 respectively, to the base of 1024. Defaults to unset and kernel's default is used.</para>
3911 </listitem>
3912 </varlistentry>
3913
3914 <varlistentry>
18de0969 3915 <term><varname>Flows=</varname></term>
ac810b75
YW
3916 <listitem>
3917 <para>Specifies the number of flows into which the incoming packets are classified.
3918 Defaults to unset and kernel's default is used.</para>
3919 </listitem>
3920 </varlistentry>
3921
3922 <varlistentry>
18de0969 3923 <term><varname>TargetSec=</varname></term>
ac810b75
YW
3924 <listitem>
3925 <para>Takes a timespan. Specifies the acceptable minimum standing/persistent queue delay.
3926 Defaults to unset and kernel's default is used.</para>
3927 </listitem>
3928 </varlistentry>
3929
3930 <varlistentry>
18de0969 3931 <term><varname>IntervalSec=</varname></term>
ac810b75
YW
3932 <listitem>
3933 <para>Takes a timespan. This is used to ensure that the measured minimum delay does not
3934 become too stale. Defaults to unset and kernel's default is used.</para>
3935 </listitem>
3936 </varlistentry>
3937
3938 <varlistentry>
c03ef420 3939 <term><varname>QuantumBytes=</varname></term>
ac810b75 3940 <listitem>
e9dd6984 3941 <para>Specifies the number of bytes used as the "deficit" in the fair queuing algorithm timespan.
ac810b75
YW
3942 When suffixed with K, M, or G, the specified size is parsed as Kilobytes, Megabytes, or Gigabytes,
3943 respectively, to the base of 1024. Defaults to unset and kernel's default is used.</para>
3944 </listitem>
3945 </varlistentry>
3946
3947 <varlistentry>
18de0969 3948 <term><varname>ECN=</varname></term>
ac810b75
YW
3949 <listitem>
3950 <para>Takes a boolean. This can be used to mark packets instead of dropping them. Defaults to
3951 unset and kernel's default is used.</para>
3952 </listitem>
3953 </varlistentry>
3954
3955 <varlistentry>
18de0969 3956 <term><varname>CEThresholdSec=</varname></term>
ac810b75
YW
3957 <listitem>
3958 <para>Takes a timespan. This sets a threshold above which all packets are marked with ECN
3959 Congestion Experienced (CE). Defaults to unset and kernel's default is used.</para>
3960 </listitem>
3961 </varlistentry>
18de0969
YW
3962 </variablelist>
3963 </refsect1>
3964
3965 <refsect1>
ca58d00c 3966 <title>[FairQueueing] Section Options</title>
bdac5608
ZJS
3967 <para>The [FairQueueing] section manages the queueing discipline (qdisc) of fair queue traffic policing
3968 (FQ).</para>
18de0969
YW
3969
3970 <variablelist class='network-directives'>
f344a492
YW
3971 <xi:include href="tc.xml" xpointer="qdisc-parent" />
3972 <xi:include href="tc.xml" xpointer="qdisc-handle" />
d8b2396d 3973
7234b915 3974 <varlistentry>
18de0969 3975 <term><varname>PacketLimit=</varname></term>
7234b915
SS
3976 <listitem>
3977 <para>Specifies the hard limit on the real queue size. When this limit is reached, incoming packets are
3978 dropped. Defaults to unset and kernel's default is used.</para>
3979 </listitem>
3980 </varlistentry>
3981
e83562e5 3982 <varlistentry>
18de0969 3983 <term><varname>FlowLimit=</varname></term>
e83562e5
YW
3984 <listitem>
3985 <para>Specifies the hard limit on the maximum number of packets queued per flow. Defaults to
3986 unset and kernel's default is used.</para>
3987 </listitem>
3988 </varlistentry>
3989
3990 <varlistentry>
c03ef420 3991 <term><varname>QuantumBytes=</varname></term>
e83562e5
YW
3992 <listitem>
3993 <para>Specifies the credit per dequeue RR round, i.e. the amount of bytes a flow is allowed
3994 to dequeue at once. When suffixed with K, M, or G, the specified size is parsed as Kilobytes,
3995 Megabytes, or Gigabytes, respectively, to the base of 1024. Defaults to unset and kernel's
3996 default is used.</para>
3997 </listitem>
3998 </varlistentry>
3999
4000 <varlistentry>
c03ef420 4001 <term><varname>InitialQuantumBytes=</varname></term>
e83562e5
YW
4002 <listitem>
4003 <para>Specifies the initial sending rate credit, i.e. the amount of bytes a new flow is
4004 allowed to dequeue initially. When suffixed with K, M, or G, the specified size is parsed as
4005 Kilobytes, Megabytes, or Gigabytes, respectively, to the base of 1024. Defaults to unset and
4006 kernel's default is used.</para>
4007 </listitem>
4008 </varlistentry>
4009
4010 <varlistentry>
18de0969 4011 <term><varname>MaximumRate=</varname></term>
e83562e5
YW
4012 <listitem>
4013 <para>Specifies the maximum sending rate of a flow. When suffixed with K, M, or G, the
6b8fe4c3 4014 specified size is parsed as Kilobits, Megabits, or Gigabits, respectively, to the base of
e83562e5
YW
4015 1000. Defaults to unset and kernel's default is used.</para>
4016 </listitem>
4017 </varlistentry>
4018
4019 <varlistentry>
18de0969 4020 <term><varname>Buckets=</varname></term>
e83562e5
YW
4021 <listitem>
4022 <para>Specifies the size of the hash table used for flow lookups. Defaults to unset and
4023 kernel's default is used.</para>
4024 </listitem>
4025 </varlistentry>
4026
4027 <varlistentry>
18de0969 4028 <term><varname>OrphanMask=</varname></term>
e83562e5
YW
4029 <listitem>
4030 <para>Takes an unsigned integer. For packets not owned by a socket, fq is able to mask a part
4031 of hash and reduce number of buckets associated with the traffic. Defaults to unset and
4032 kernel's default is used.</para>
4033 </listitem>
4034 </varlistentry>
4035
4036 <varlistentry>
18de0969 4037 <term><varname>Pacing=</varname></term>
e83562e5
YW
4038 <listitem>
4039 <para>Takes a boolean, and enables or disables flow pacing. Defaults to unset and kernel's
4040 default is used.</para>
4041 </listitem>
4042 </varlistentry>
4043
4044 <varlistentry>
18de0969 4045 <term><varname>CEThresholdSec=</varname></term>
e83562e5
YW
4046 <listitem>
4047 <para>Takes a timespan. This sets a threshold above which all packets are marked with ECN
4048 Congestion Experienced (CE). Defaults to unset and kernel's default is used.</para>
4049 </listitem>
4050 </varlistentry>
0f5bd7fe
SS
4051 </variablelist>
4052 </refsect1>
4053
9b749c11
YW
4054 <refsect1>
4055 <title>[TrivialLinkEqualizer] Section Options</title>
bdac5608
ZJS
4056 <para>The [TrivialLinkEqualizer] section manages the queueing discipline (qdisc) of trivial link
4057 equalizer (teql).</para>
9b749c11
YW
4058
4059 <variablelist class='network-directives'>
f344a492
YW
4060 <xi:include href="tc.xml" xpointer="qdisc-parent" />
4061 <xi:include href="tc.xml" xpointer="qdisc-handle" />
d8b2396d 4062
9b749c11
YW
4063 <varlistentry>
4064 <term><varname>Id=</varname></term>
4065 <listitem>
4066 <para>Specifies the interface ID <literal>N</literal> of teql. Defaults to <literal>0</literal>.
4067 Note that when teql is used, currently, the module <constant>sch_teql</constant> with
4068 <constant>max_equalizers=N+1</constant> option must be loaded before
4069 <command>systemd-networkd</command> is started.</para>
4070 </listitem>
4071 </varlistentry>
4072 </variablelist>
4073 </refsect1>
4074
b934ac3d
YW
4075 <refsect1>
4076 <title>[HierarchyTokenBucket] Section Options</title>
bdac5608
ZJS
4077 <para>The [HierarchyTokenBucket] section manages the queueing discipline (qdisc) of hierarchy token
4078 bucket (htb).</para>
b934ac3d
YW
4079
4080 <variablelist class='network-directives'>
f344a492
YW
4081 <xi:include href="tc.xml" xpointer="qdisc-parent" />
4082 <xi:include href="tc.xml" xpointer="qdisc-handle" />
b934ac3d
YW
4083
4084 <varlistentry>
4085 <term><varname>DefaultClass=</varname></term>
4086 <listitem>
4087 <para>Takes the minor id in hexadecimal of the default class. Unclassified traffic gets sent
4088 to the class. Defaults to unset.</para>
4089 </listitem>
4090 </varlistentry>
d9eacc1c
YW
4091
4092 <varlistentry>
4093 <term><varname>RateToQuantum=</varname></term>
4094 <listitem>
4095 <para>Takes an unsigned integer. The DRR quantums are calculated by dividing the value
4096 configured in <varname>Rate=</varname> by <varname>RateToQuantum=</varname>.</para>
4097 </listitem>
4098 </varlistentry>
b934ac3d
YW
4099 </variablelist>
4100 </refsect1>
4101
19f86a63
YW
4102 <refsect1>
4103 <title>[HierarchyTokenBucketClass] Section Options</title>
bdac5608
ZJS
4104 <para>The [HierarchyTokenBucketClass] section manages the traffic control class of hierarchy token bucket
4105 (htb).</para>
19f86a63
YW
4106
4107 <variablelist class='network-directives'>
f344a492
YW
4108 <xi:include href="tc.xml" xpointer="tclass-parent" />
4109 <xi:include href="tc.xml" xpointer="tclass-classid" />
19f86a63
YW
4110
4111 <varlistentry>
4112 <term><varname>Priority=</varname></term>
4113 <listitem>
4114 <para>Specifies the priority of the class. In the round-robin process, classes with the lowest
d9eacc1c
YW
4115 priority field are tried for packets first.</para>
4116 </listitem>
4117 </varlistentry>
4118
4119 <varlistentry>
4120 <term><varname>QuantumBytes=</varname></term>
4121 <listitem>
4122 <para>Specifies how many bytes to serve from leaf at once. When suffixed with K, M, or G, the
4123 specified size is parsed as Kilobytes, Megabytes, or Gigabytes, respectively, to the base of
4124 1024.</para>
4125 </listitem>
4126 </varlistentry>
4127
4128 <varlistentry>
4129 <term><varname>MTUBytes=</varname></term>
4130 <listitem>
4131 <para>Specifies the maximum packet size we create. When suffixed with K, M, or G, the specified
4132 size is parsed as Kilobytes, Megabytes, or Gigabytes, respectively, to the base of 1024.</para>
4133 </listitem>
4134 </varlistentry>
4135
4136 <varlistentry>
4137 <term><varname>OverheadBytes=</varname></term>
4138 <listitem>
4139 <para>Takes an unsigned integer which specifies per-packet size overhead used in rate
4140 computations. When suffixed with K, M, or G, the specified size is parsed as Kilobytes,
4141 Megabytes, or Gigabytes, respectively, to the base of 1024.</para>
19f86a63
YW
4142 </listitem>
4143 </varlistentry>
4144
4145 <varlistentry>
4146 <term><varname>Rate=</varname></term>
4147 <listitem>
4148 <para>Specifies the maximum rate this class and all its children are guaranteed. When suffixed
4149 with K, M, or G, the specified size is parsed as Kilobits, Megabits, or Gigabits, respectively,
4150 to the base of 1000. This setting is mandatory.</para>
4151 </listitem>
4152 </varlistentry>
4153
4154 <varlistentry>
4155 <term><varname>CeilRate=</varname></term>
4156 <listitem>
4157 <para>Specifies the maximum rate at which a class can send, if its parent has bandwidth to spare.
4158 When suffixed with K, M, or G, the specified size is parsed as Kilobits, Megabits, or Gigabits,
4159 respectively, to the base of 1000. When unset, the value specified with <varname>Rate=</varname>
4160 is used.</para>
4161 </listitem>
4162 </varlistentry>
d9eacc1c
YW
4163
4164 <varlistentry>
4165 <term><varname>BufferBytes=</varname></term>
4166 <listitem>
4167 <para>Specifies the maximum bytes burst which can be accumulated during idle period. When suffixed
4168 with K, M, or G, the specified size is parsed as Kilobytes, Megabytes, or Gigabytes, respectively,
4169 to the base of 1024.</para>
4170 </listitem>
4171 </varlistentry>
4172
4173 <varlistentry>
4174 <term><varname>CeilBufferBytes=</varname></term>
4175 <listitem>
4176 <para>Specifies the maximum bytes burst for ceil which can be accumulated during idle period.
4177 When suffixed with K, M, or G, the specified size is parsed as Kilobytes, Megabytes, or Gigabytes,
4178 respectively, to the base of 1024.</para>
4179 </listitem>
4180 </varlistentry>
7f224020
SS
4181 </variablelist>
4182 </refsect1>
4183
4184 <refsect1>
4185 <title>[HeavyHitterFilter] Section Options</title>
bdac5608
ZJS
4186 <para>The [HeavyHitterFilter] section manages the queueing discipline (qdisc) of Heavy Hitter Filter
4187 (hhf).</para>
7f224020
SS
4188
4189 <variablelist class='network-directives'>
f344a492
YW
4190 <xi:include href="tc.xml" xpointer="qdisc-parent" />
4191 <xi:include href="tc.xml" xpointer="qdisc-handle" />
19f86a63 4192
7f224020
SS
4193 <varlistentry>
4194 <term><varname>PacketLimit=</varname></term>
4195 <listitem>
e9dd6984 4196 <para>Specifies the hard limit on the queue size in number of packets. When this limit is reached,
69978eb9 4197 incoming packets are dropped. An unsigned integer in the range 0…4294967294. Defaults to unset and
e9dd6984 4198 kernel's default is used.</para>
7f224020
SS
4199 </listitem>
4200 </varlistentry>
19f86a63
YW
4201 </variablelist>
4202 </refsect1>
4203
b12aaee5
SS
4204 <refsect1>
4205 <title>[QuickFairQueueing] Section Options</title>
bdac5608
ZJS
4206 <para>The [QuickFairQueueing] section manages the queueing discipline (qdisc) of Quick Fair Queueing
4207 (QFQ).</para>
b12aaee5
SS
4208
4209 <variablelist class='network-directives'>
4210 <xi:include href="tc.xml" xpointer="qdisc-parent" />
4211 <xi:include href="tc.xml" xpointer="qdisc-handle" />
4212 </variablelist>
4213 </refsect1>
4214
4d7ddaf9
YW
4215 <refsect1>
4216 <title>[QuickFairQueueingClass] Section Options</title>
bdac5608
ZJS
4217 <para>The [QuickFairQueueingClass] section manages the traffic control class of Quick Fair Queueing
4218 (qfq).</para>
4d7ddaf9
YW
4219
4220 <variablelist class='network-directives'>
4221 <xi:include href="tc.xml" xpointer="tclass-parent" />
4222 <xi:include href="tc.xml" xpointer="tclass-classid" />
4223
4224 <varlistentry>
4225 <term><varname>Weight=</varname></term>
4226 <listitem>
1d3a473b 4227 <para>Specifies the weight of the class. Takes an integer in the range 1…1023. Defaults to
4d7ddaf9
YW
4228 unset in which case the kernel default is used.</para>
4229 </listitem>
4230 </varlistentry>
4231
4232 <varlistentry>
c03ef420 4233 <term><varname>MaxPacketBytes=</varname></term>
4d7ddaf9 4234 <listitem>
75909cc7
ZJS
4235 <para>Specifies the maximum packet size in bytes for the class. When suffixed with K, M, or G, the
4236 specified size is parsed as Kilobytes, Megabytes, or Gigabytes, respectively, to the base of
4237 1024. When unset, the kernel default is used.</para>
4d7ddaf9
YW
4238 </listitem>
4239 </varlistentry>
4240 </variablelist>
4241 </refsect1>
4242
13b498f9
TJ
4243 <refsect1>
4244 <title>[BridgeVLAN] Section Options</title>
bdac5608
ZJS
4245 <para>The [BridgeVLAN] section manages the VLAN ID configuration of a bridge port and accepts the
4246 following keys. Specify several [BridgeVLAN] sections to configure several VLAN entries. The
4247 <varname>VLANFiltering=</varname> option has to be enabled, see the [Bridge] section in
13b498f9
TJ
4248 <citerefentry><refentrytitle>systemd.netdev</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para>
4249
4250 <variablelist class='network-directives'>
4251 <varlistentry>
4252 <term><varname>VLAN=</varname></term>
4253 <listitem>
69978eb9
YW
4254 <para>The VLAN ID allowed on the port. This can be either a single ID or a range M-N. Takes
4255 an integer in the range 1…4094.</para>
13b498f9
TJ
4256 </listitem>
4257 </varlistentry>
4258 <varlistentry>
4259 <term><varname>EgressUntagged=</varname></term>
4260 <listitem>
4261 <para>The VLAN ID specified here will be used to untag frames on egress. Configuring
4262 <varname>EgressUntagged=</varname> implicates the use of <varname>VLAN=</varname> above and will enable the
4263 VLAN ID for ingress as well. This can be either a single ID or a range M-N.</para>
4264 </listitem>
4265 </varlistentry>
4266 <varlistentry>
4267 <term><varname>PVID=</varname></term>
4268 <listitem>
4269 <para>The Port VLAN ID specified here is assigned to all untagged frames at ingress.
4270 <varname>PVID=</varname> can be used only once. Configuring <varname>PVID=</varname> implicates the use of
4271 <varname>VLAN=</varname> above and will enable the VLAN ID for ingress as well.</para>
4272 </listitem>
4273 </varlistentry>
4274 </variablelist>
4275 </refsect1>
798d3a52
ZJS
4276
4277 <refsect1>
9e35b3de 4278 <title>Examples</title>
798d3a52 4279 <example>
9e35b3de 4280 <title>Static network configuration</title>
798d3a52 4281
9e35b3de
ZJS
4282 <programlisting># /etc/systemd/network/50-static.network
4283[Match]
eac684ef
TG
4284Name=enp2s0
4285
4286[Network]
4287Address=192.168.0.15/24
4288Gateway=192.168.0.1</programlisting>
9e35b3de
ZJS
4289
4290 <para>This brings interface <literal>enp2s0</literal> up with a static address. The
4291 specified gateway will be used for a default route.</para>
798d3a52 4292 </example>
eac684ef 4293
798d3a52 4294 <example>
9e35b3de 4295 <title>DHCP on ethernet links</title>
eac684ef 4296
9e35b3de
ZJS
4297 <programlisting># /etc/systemd/network/80-dhcp.network
4298[Match]
eac684ef
TG
4299Name=en*
4300
4301[Network]
9c8ca3f7 4302DHCP=yes</programlisting>
9e35b3de
ZJS
4303
4304 <para>This will enable DHCPv4 and DHCPv6 on all interfaces with names starting with
4305 <literal>en</literal> (i.e. ethernet interfaces).</para>
798d3a52 4306 </example>
eac684ef 4307
4c94a4c2 4308 <example>
4309 <title>IPv6 Prefix Delegation</title>
4310
4311 <programlisting># /etc/systemd/network/55-ipv6-pd-upstream.network
4312[Match]
4313Name=enp1s0
4314
4315[Network]
4316DHCP=ipv6</programlisting>
4317
4318 <programlisting># /etc/systemd/network/56-ipv6-pd-downstream.network
4319[Match]
4320Name=enp2s0
4321
4322[Network]
e5ff2245
YW
4323IPv6SendRA=yes
4324DHCPv6PrefixDelegation=yes</programlisting>
4c94a4c2 4325
e5ff2245
YW
4326 <para>This will enable DHCPv6-PD on the interface enp1s0 as an upstream interface where the
4327 DHCPv6 client is running and enp2s0 as a downstream interface where the prefix is delegated to.
4328 The delegated prefixes are distributed by IPv6 Router Advertisement on the downstream network.
4329 </para>
4c94a4c2 4330 </example>
4331
798d3a52 4332 <example>
9e35b3de 4333 <title>A bridge with two enslaved links</title>
f47c5c47 4334
9e35b3de
ZJS
4335 <programlisting># /etc/systemd/network/25-bridge-static.network
4336[Match]
f47c5c47 4337Name=bridge0
4338
4339[Network]
4340Address=192.168.0.15/24
4341Gateway=192.168.0.1
4342DNS=192.168.0.1</programlisting>
f47c5c47 4343
9e35b3de
ZJS
4344 <programlisting># /etc/systemd/network/25-bridge-slave-interface-1.network
4345[Match]
f47c5c47 4346Name=enp2s0
4347
4348[Network]
4349Bridge=bridge0</programlisting>
9e35b3de
ZJS
4350
4351 <programlisting># /etc/systemd/network/25-bridge-slave-interface-2.network
4352[Match]
4353Name=wlp3s0
4354
4355[Network]
4356Bridge=bridge0</programlisting>
4357
4358 <para>This creates a bridge and attaches devices <literal>enp2s0</literal> and
4359 <literal>wlp3s0</literal> to it. The bridge will have the specified static address
4360 and network assigned, and a default route via the specified gateway will be
4361 added. The specified DNS server will be added to the global list of DNS resolvers.
4362 </para>
13b498f9 4363 </example>
9e35b3de 4364
13b498f9 4365 <example>
9e35b3de 4366 <title></title>
13b498f9 4367
9e35b3de
ZJS
4368 <programlisting>
4369# /etc/systemd/network/20-bridge-slave-interface-vlan.network
4370[Match]
13b498f9
TJ
4371Name=enp2s0
4372
4373[Network]
4374Bridge=bridge0
4375
4376[BridgeVLAN]
4377VLAN=1-32
4378PVID=42
4379EgressUntagged=42
4380
4381[BridgeVLAN]
4382VLAN=100-200
4383
4384[BridgeVLAN]
4385EgressUntagged=300-400</programlisting>
0a8a0fad 4386
9e35b3de
ZJS
4387 <para>This overrides the configuration specified in the previous example for the
4388 interface <literal>enp2s0</literal>, and enables VLAN on that bridge port. VLAN IDs
4389 1-32, 42, 100-400 will be allowed. Packets tagged with VLAN IDs 42, 300-400 will be
4390 untagged when they leave on this interface. Untagged packets which arrive on this
4391 interface will be assigned VLAN ID 42.</para>
798d3a52 4392 </example>
0a8a0fad 4393
798d3a52 4394 <example>
9e35b3de 4395 <title>Various tunnels</title>
0a8a0fad 4396
9e35b3de
ZJS
4397 <programlisting>/etc/systemd/network/25-tunnels.network
4398[Match]
4399Name=ens1
0a8a0fad
TG
4400
4401[Network]
9e35b3de
ZJS
4402Tunnel=ipip-tun
4403Tunnel=sit-tun
4404Tunnel=gre-tun
4405Tunnel=vti-tun
4406 </programlisting>
4407
4408 <programlisting>/etc/systemd/network/25-tunnel-ipip.netdev
4409[NetDev]
4410Name=ipip-tun
4411Kind=ipip
4412 </programlisting>
4413
4414 <programlisting>/etc/systemd/network/25-tunnel-sit.netdev
4415[NetDev]
4416Name=sit-tun
4417Kind=sit
4418 </programlisting>
4419
4420 <programlisting>/etc/systemd/network/25-tunnel-gre.netdev
4421[NetDev]
4422Name=gre-tun
4423Kind=gre
4424 </programlisting>
4425
4426 <programlisting>/etc/systemd/network/25-tunnel-vti.netdev
4427[NetDev]
4428Name=vti-tun
4429Kind=vti
4430 </programlisting>
4431
4432 <para>This will bring interface <literal>ens1</literal> up and create an IPIP tunnel,
4433 a SIT tunnel, a GRE tunnel, and a VTI tunnel using it.</para>
798d3a52 4434 </example>
0a8a0fad 4435
798d3a52 4436 <example>
9e35b3de 4437 <title>A bond device</title>
0a8a0fad 4438
9e35b3de
ZJS
4439 <programlisting># /etc/systemd/network/30-bond1.network
4440[Match]
4441Name=bond1
0a8a0fad
TG
4442
4443[Network]
9e35b3de
ZJS
4444DHCP=ipv6
4445</programlisting>
0a8a0fad 4446
9e35b3de
ZJS
4447 <programlisting># /etc/systemd/network/30-bond1.netdev
4448[NetDev]
4449Name=bond1
4450Kind=bond
4451</programlisting>
0a8a0fad 4452
301a21a8 4453 <programlisting># /etc/systemd/network/30-bond1-dev1.network
9e35b3de
ZJS
4454[Match]
4455MACAddress=52:54:00:e9:64:41
0a8a0fad
TG
4456
4457[Network]
9e35b3de
ZJS
4458Bond=bond1
4459</programlisting>
d94facdc 4460
301a21a8 4461 <programlisting># /etc/systemd/network/30-bond1-dev2.network
9e35b3de
ZJS
4462[Match]
4463MACAddress=52:54:00:e9:64:42
d94facdc
MH
4464
4465[Network]
9e35b3de 4466Bond=bond1
6cb955c6 4467</programlisting>
9e35b3de
ZJS
4468
4469 <para>This will create a bond device <literal>bond1</literal> and enslave the two
4470 devices with MAC addresses 52:54:00:e9:64:41 and 52:54:00:e9:64:42 to it. IPv6 DHCP
4471 will be used to acquire an address.</para>
6cb955c6
AR
4472 </example>
4473
4474 <example>
9e35b3de
ZJS
4475 <title>Virtual Routing and Forwarding (VRF)</title>
4476 <para>Add the <literal>bond1</literal> interface to the VRF master interface
4477 <literal>vrf1</literal>. This will redirect routes generated on this interface to be
11d38b90
AR
4478 within the routing table defined during VRF creation. For kernels before 4.8 traffic
4479 won't be redirected towards the VRFs routing table unless specific ip-rules are added.
4480 </para>
9e35b3de
ZJS
4481 <programlisting># /etc/systemd/network/25-vrf.network
4482[Match]
6cb955c6
AR
4483Name=bond1
4484
4485[Network]
9e35b3de 4486VRF=vrf1
d94facdc
MH
4487</programlisting>
4488 </example>
4489
42125eda
SS
4490 <example>
4491 <title>MacVTap</title>
4492 <para>This brings up a network interface <literal>macvtap-test</literal>
4493 and attaches it to <literal>enp0s25</literal>.</para>
83ddf5d3 4494 <programlisting># /usr/lib/systemd/network/25-macvtap.network
42125eda
SS
4495[Match]
4496Name=enp0s25
4497
4498[Network]
4499MACVTAP=macvtap-test
4500</programlisting>
4501 </example>
98d20a17 4502
4503 <example>
4504 <title>A Xfrm interface with physical underlying device.</title>
4505
4506 <programlisting># /etc/systemd/network/27-xfrm.netdev
4507[NetDev]
4508Name=xfrm0
4509
4510[Xfrm]
4511InterfaceId=7</programlisting>
4512
4513 <programlisting># /etc/systemd/network/27-eth0.network
4514[Match]
4515Name=eth0
4516
4517[Network]
4518Xfrm=xfrm0</programlisting>
4519
4520 <para>This creates a <literal>xfrm0</literal> interface and binds it to the <literal>eth0</literal> device.
4521 This allows hardware based ipsec offloading to the <literal>eth0</literal> nic.
4522 If offloading is not needed, xfrm interfaces can be assigned to the <literal>lo</literal> device.
4523 </para>
4524 </example>
798d3a52
ZJS
4525 </refsect1>
4526
4527 <refsect1>
4528 <title>See Also</title>
4529 <para>
4530 <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
f41b446a 4531 <citerefentry><refentrytitle>systemd-networkd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
798d3a52 4532 <citerefentry><refentrytitle>systemd.link</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
aaa297d4
LP
4533 <citerefentry><refentrytitle>systemd.netdev</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
4534 <citerefentry><refentrytitle>systemd-resolved.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>
798d3a52
ZJS
4535 </para>
4536 </refsect1>
eac684ef
TG
4537
4538</refentry>