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