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