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