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