]> git.ipfire.org Git - thirdparty/systemd.git/blame - man/systemd.network.xml
network: DHCPv6 - Add support to set token on the LAN interface
[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>
a6f1848a
SS
196 <varlistentry>
197 <term><varname>IPv6LinkLocalAddressGenerationMode=</varname></term>
198 <listitem>
199 <para>Specifies how IPv6 link local address is generated. Takes one of <literal>eui64</literal>,
200 <literal>none</literal>, <literal>stable-privacy</literal> and <literal>random</literal>.
201 When unset, the kernel's default will be used. Note that if <varname>LinkLocalAdressing=</varname>
202 not configured as <literal>ipv6</literal> then <varname>IPv6LinkLocalAddressGenerationMode=</varname>
203 is ignored.</para>
204 </listitem>
205 </varlistentry>
a09dc546
DM
206 <varlistentry>
207 <term><varname>Unmanaged=</varname></term>
208 <listitem>
9b6ffef3 209 <para>Takes a boolean. When <literal>yes</literal>, no attempts are
a09dc546
DM
210 made to bring up or configure matching links, equivalent to
211 when there are no matching network files. Defaults to
212 <literal>no</literal>.</para>
213 <para>This is useful for preventing later matching network
214 files from interfering with certain interfaces that are fully
215 controlled by other applications.</para>
216 </listitem>
217 </varlistentry>
89fe6535
SS
218 <varlistentry>
219 <term><varname>Group=</varname></term>
220 <listitem>
221 <para>Link groups are similar to port ranges found in managed switches.
222 When network interfaces are added to a numbered group, operations on
223 all the interfaces from that group can be performed at once. An unsigned
224 integer ranges 0 to 4294967294. Default to unset.</para>
225 </listitem>
226 </varlistentry>
c1a38904
MTL
227 <varlistentry>
228 <term><varname>RequiredForOnline=</varname></term>
229 <listitem>
75cd4a5d
DDM
230 <para>Takes a boolean or a minimum operational state and an optional maximum operational state.
231 Please see <citerefentry><refentrytitle>networkctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>
8d6082e4
YW
232 for possible operational states. When <literal>yes</literal>, the network is deemed required when
233 determining whether the system is online when running
234 <command>systemd-networkd-wait-online</command>. When <literal>no</literal>, the network is ignored
75cd4a5d
DDM
235 when checking for online state. When a minimum operational state and an optional maximum operational
236 state are set, <literal>yes</literal> is implied, and this controls the minimum and maximum
237 operational state required for the network interface to be considered online.
8d6082e4
YW
238 Defaults to <literal>yes</literal>.</para>
239
c1a38904
MTL
240 <para>The network will be brought up normally in all cases, but in
241 the event that there is no address being assigned by DHCP or the
242 cable is not plugged in, the link will simply remain offline and be
8d6082e4 243 skipped automatically by <command>systemd-networkd-wait-online</command>
ca92fe36 244 if <literal>RequiredForOnline=no</literal>.</para>
c1a38904
MTL
245 </listitem>
246 </varlistentry>
798d3a52
ZJS
247 </variablelist>
248 </refsect1>
249
250 <refsect1>
251 <title>[Network] Section Options</title>
252
253 <para>The <literal>[Network]</literal> section accepts the following keys:</para>
254
255 <variablelist class='network-directives'>
256 <varlistentry>
257 <term><varname>Description=</varname></term>
258 <listitem>
259 <para>A description of the device. This is only used for
260 presentation purposes.</para>
261 </listitem>
262 </varlistentry>
263 <varlistentry>
264 <term><varname>DHCP=</varname></term>
265 <listitem>
ad943783 266 <para>Enables DHCPv4 and/or DHCPv6 client support. Accepts
798d3a52 267 <literal>yes</literal>, <literal>no</literal>,
c702bd3b
LY
268 <literal>ipv4</literal>, or <literal>ipv6</literal>. Defaults
269 to <literal>no</literal>.</para>
e88d8021 270
f5a8c43f 271 <para>Note that DHCPv6 will by default be triggered by Router
7f3fdb7f 272 Advertisement, if that is enabled, regardless of this parameter.
f5a8c43f
TG
273 By enabling DHCPv6 support explicitly, the DHCPv6 client will
274 be started regardless of the presence of routers on the link,
275 or what flags the routers pass. See
f921f573 276 <literal>IPv6AcceptRA=</literal>.</para>
f5a8c43f
TG
277
278 <para>Furthermore, note that by default the domain name
e88d8021
ZJS
279 specified through DHCP is not used for name resolution.
280 See option <option>UseDomains=</option> below.</para>
2ef322fc 281
4f7331a8
YW
282 <para>See the <literal>[DHCPv4]</literal> or <literal>[DHCPv6]</literal> section below for
283 further configuration options for the DHCP client support.</para>
798d3a52
ZJS
284 </listitem>
285 </varlistentry>
286 <varlistentry>
287 <term><varname>DHCPServer=</varname></term>
288 <listitem>
68b7f7ac 289 <para>Takes a boolean. If set to <literal>yes</literal>, DHCPv4 server will be started. Defaults
ad943783
LP
290 to <literal>no</literal>. Further settings for the DHCP
291 server may be set in the <literal>[DHCPServer]</literal>
292 section described below.</para>
798d3a52
ZJS
293 </listitem>
294 </varlistentry>
295 <varlistentry>
56fd6bf7 296 <term><varname>LinkLocalAddressing=</varname></term>
798d3a52 297 <listitem>
85fc09c9 298 <para>Enables link-local address autoconfiguration. Accepts <literal>yes</literal>,
8bc17bb3
SS
299 <literal>no</literal>, <literal>ipv4</literal>, <literal>ipv6</literal>,
300 <literal>fallback</literal>, or <literal>ipv4-fallback</literal>. If
301 <literal>fallback</literal> or <literal>ipv4-fallback</literal> is specified, then an IPv4
302 link-local address is configured only when DHCPv4 fails. If <literal>fallback</literal>,
303 an IPv6 link-local address is always configured, and if <literal>ipv4-fallback</literal>,
304 the address is not configured. Note that, the fallback mechanism works only when DHCPv4
305 client is enabled, that is, it requires <literal>DHCP=yes</literal> or
306 <literal>DHCP=ipv4</literal>. If <varname>Bridge=</varname> is set, defaults to
307 <literal>no</literal>, and if not, defaults to <literal>ipv6</literal>.
308 </para>
798d3a52
ZJS
309 </listitem>
310 </varlistentry>
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>
f41b446a 581 <para>An NTP server address. 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>
1415 <para>When true (the default), the NTP servers received
1416 from the DHCP server will be used by systemd-timesyncd
1417 and take precedence over any statically configured ones.</para>
1418 </listitem>
1419 </varlistentry>
299d578f
SS
1420 <varlistentry>
1421 <term><varname>UseSIP=</varname></term>
1422 <listitem>
1423 <para>When true (the default), the SIP servers received
1424 from the DHCP server will be saved at the state files and can be
1425 read via <function>sd_network_link_get_sip_servers()</function> function.</para>
1426 </listitem>
1427 </varlistentry>
284e8fd0 1428
798d3a52
ZJS
1429 <varlistentry>
1430 <term><varname>UseMTU=</varname></term>
1431 <listitem>
1432 <para>When true, the interface maximum transmission unit
1433 from the DHCP server will be used on the current link.
7169cdc8 1434 If <varname>MTUBytes=</varname> is set, then this setting is ignored.
95ab9eff 1435 Defaults to false.</para>
798d3a52
ZJS
1436 </listitem>
1437 </varlistentry>
7585baa0 1438 <varlistentry>
1439 <term><varname>Anonymize=</varname></term>
1440 <listitem>
9b6ffef3 1441 <para>Takes a boolean. When true, the options sent to the DHCP server will
7585baa0 1442 follow the <ulink url="https://tools.ietf.org/html/rfc7844">RFC 7844</ulink>
1443 (Anonymity Profiles for DHCP Clients) to minimize disclosure of identifying information.
1444 Defaults to false.</para>
1445
1446 <para>This option should only be set to true when
1447 <varname>MACAddressPolicy=</varname> is set to <literal>random</literal>
1448 (see <citerefentry
1449 project='man-pages'><refentrytitle>systemd.link</refentrytitle><manvolnum>5</manvolnum></citerefentry>).</para>
1450
1451 <para>Note that this configuration will overwrite others.
1452 In concrete, the following variables will be ignored:
1453 <varname>SendHostname=</varname>, <varname>ClientIdentifier=</varname>,
da2076a1
TK
1454 <varname>UseRoutes=</varname>, <varname>UseMTU=</varname>,
1455 <varname>VendorClassIdentifier=</varname>, <varname>UseTimezone=</varname>.</para>
fba10579
LP
1456
1457 <para>With this option enabled DHCP requests will mimic those generated by Microsoft Windows, in
1458 order to reduce the ability to fingerprint and recognize installations. This means DHCP request
1459 sizes will grow and lease data will be more comprehensive than normally, though most of the
1460 requested data is not actually used.</para>
7585baa0 1461 </listitem>
1462 </varlistentry>
798d3a52
ZJS
1463 <varlistentry>
1464 <term><varname>SendHostname=</varname></term>
1465 <listitem>
31ee3973
YW
1466 <para>When true (the default), the machine's hostname will be sent to the DHCP server.
1467 Note that the machine's hostname must consist only of 7-bit ASCII lower-case characters and
1468 no spaces or dots, and be formatted as a valid DNS domain name. Otherwise, the hostname is not
cad8d671 1469 sent even if this is set to true.</para>
798d3a52
ZJS
1470 </listitem>
1471 </varlistentry>
7b8d23a9
SS
1472
1473 <varlistentry>
1474 <term><varname>MUDURL=</varname></term>
1475 <listitem>
1476 <para>When configured, the Manufacturer Usage Descriptions (MUD) URL will be sent to the
1477 DHCPv4 server. Takes an URL of length up to 255 characters. A superficial verification that
1478 the string is a valid URL will be performed. DHCPv4 clients are intended to have at most one
1479 MUD URL associated with them. See
1480 <ulink url="https://tools.ietf.org/html/rfc8520">RFC 8520</ulink>.</para>
1481 </listitem>
1482 </varlistentry>
1483
798d3a52
ZJS
1484 <varlistentry>
1485 <term><varname>UseHostname=</varname></term>
1486 <listitem>
1487 <para>When true (the default), the hostname received from
31ee3973 1488 the DHCP server will be set as the transient hostname of the system.
d59be2cf 1489 </para>
798d3a52
ZJS
1490 </listitem>
1491 </varlistentry>
1adc5d0b 1492 <varlistentry>
31ee3973
YW
1493 <term><varname>Hostname=</varname></term>
1494 <listitem>
1495 <para>Use this value for the hostname which is sent to the DHCP server, instead of machine's hostname.
1496 Note that the specified hostname must consist only of 7-bit ASCII lower-case characters and
1497 no spaces or dots, and be formatted as a valid DNS domain name.</para>
1498 </listitem>
1499 </varlistentry>
798d3a52
ZJS
1500 <varlistentry>
1501 <term><varname>UseDomains=</varname></term>
1502 <listitem>
9b6ffef3 1503 <para>Takes a boolean, or the special value <literal>route</literal>. When true, the domain name
b2a81c0b
LP
1504 received from the DHCP server will be used as DNS search domain over this link, similar to the effect of
1505 the <option>Domains=</option> setting. If set to <literal>route</literal>, the domain name received from
1506 the DHCP server will be used for routing DNS queries only, but not for searching, similar to the effect of
1507 the <option>Domains=</option> setting when the argument is prefixed with <literal>~</literal>. Defaults to
1508 false.</para>
1509
1510 <para>It is recommended to enable this option only on trusted networks, as setting this affects resolution
38b38500 1511 of all hostnames, in particular of single-label names. It is generally safer to use the supplied domain
b2a81c0b
LP
1512 only as routing domain, rather than as search domain, in order to not have it affect local resolution of
1513 single-label names.</para>
1514
1515 <para>When set to true, this setting corresponds to the <option>domain</option> option in <citerefentry
1516 project='man-pages'><refentrytitle>resolv.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para>
798d3a52
ZJS
1517 </listitem>
1518 </varlistentry>
1519 <varlistentry>
1520 <term><varname>UseRoutes=</varname></term>
1521 <listitem>
d6eac9bd
DW
1522 <para>When true (the default), the static routes will be requested from the DHCP server and added to the
1523 routing table with a metric of 1024, and a scope of "global", "link" or "host", depending on the route's
1524 destination and gateway. If the destination is on the local host, e.g., 127.x.x.x, or the same as the
1525 link's own address, the scope will be set to "host". Otherwise if the gateway is null (a direct route), a
1526 "link" scope will be used. For anything else, scope defaults to "global".</para>
798d3a52
ZJS
1527 </listitem>
1528 </varlistentry>
b4531227
YW
1529 <varlistentry>
1530 <term><varname>UseGateway=</varname></term>
1531 <listitem>
589397a2
DS
1532 <para>When true, the gateway will be requested from the DHCP server and added to the routing table with a
1533 metric of 1024, and a scope of "link". When unset, the value specified with <option>UseRoutes=</option>
1534 is used.</para>
b4531227
YW
1535 </listitem>
1536 </varlistentry>
ad943783
LP
1537 <varlistentry>
1538 <term><varname>UseTimezone=</varname></term>
1539
1540 <listitem><para>When true, the timezone received from the
7f3fdb7f 1541 DHCP server will be set as timezone of the local
ad943783
LP
1542 system. Defaults to <literal>no</literal>.</para></listitem>
1543 </varlistentry>
1544
3e43b2cd
JJ
1545 <varlistentry>
1546 <term><varname>ClientIdentifier=</varname></term>
1547 <listitem>
dace710c
YW
1548 <para>The DHCPv4 client identifier to use. Takes one of <literal>mac</literal>, <literal>duid</literal> or <literal>duid-only</literal>.
1549 If set to <literal>mac</literal>, the MAC address of the link is used.
1550 If set to <literal>duid</literal>, an RFC4361-compliant Client ID, which is the combination of IAID and DUID (see below), is used.
1551 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.
1552 Defaults to <literal>duid</literal>.</para>
3e43b2cd
JJ
1553 </listitem>
1554 </varlistentry>
e2e08e77 1555
798d3a52
ZJS
1556 <varlistentry>
1557 <term><varname>VendorClassIdentifier=</varname></term>
1558 <listitem>
1559 <para>The vendor class identifier used to identify vendor
1560 type and configuration.</para>
1561 </listitem>
1562 </varlistentry>
076ea6f6 1563
af1c0de0
SS
1564 <varlistentry>
1565 <term><varname>UserClass=</varname></term>
1566 <listitem>
1567 <para>A DHCPv4 client can use UserClass option to identify the type or category of user or applications
1568 it represents. The information contained in this option is a string that represents the user class of which
1569 the client is a member. Each class sets an identifying string of information to be used by the DHCP
1570 service to classify clients. Takes a whitespace-separated list of strings.</para>
1571 </listitem>
1572 </varlistentry>
1573
715cedfb
SS
1574 <varlistentry>
1575 <term><varname>MaxAttempts=</varname></term>
1576 <listitem>
1577 <para>Specifies how many times the DHCPv4 client configuration should be attempted. Takes a
1578 number or <literal>infinity</literal>. Defaults to <literal>infinity</literal>.
1579 Note that the time between retries is increased exponentially, so the network will not be
1580 overloaded even if this number is high.</para>
1581 </listitem>
1582 </varlistentry>
1583
e2e08e77
ZJS
1584 <varlistentry>
1585 <term><varname>DUIDType=</varname></term>
1586 <listitem>
1587 <para>Override the global <varname>DUIDType</varname> setting for this network. See
1588 <citerefentry><refentrytitle>networkd.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>
1589 for a description of possible values.</para>
1590 </listitem>
1591 </varlistentry>
076ea6f6 1592
e2e08e77
ZJS
1593 <varlistentry>
1594 <term><varname>DUIDRawData=</varname></term>
1595 <listitem>
1596 <para>Override the global <varname>DUIDRawData</varname> setting for this network. See
1597 <citerefentry><refentrytitle>networkd.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>
1598 for a description of possible values.</para>
076ea6f6
LP
1599 </listitem>
1600 </varlistentry>
e2e08e77 1601
d05def16
LP
1602 <varlistentry>
1603 <term><varname>IAID=</varname></term>
1604 <listitem>
1605 <para>The DHCP Identity Association Identifier (IAID) for the interface, a 32-bit unsigned integer.</para>
1606 </listitem>
1607 </varlistentry>
1608
798d3a52
ZJS
1609 <varlistentry>
1610 <term><varname>RequestBroadcast=</varname></term>
1611 <listitem>
1612 <para>Request the server to use broadcast messages before
1613 the IP address has been configured. This is necessary for
1614 devices that cannot receive RAW packets, or that cannot
1615 receive packets at all before an IP address has been
1616 configured. On the other hand, this must not be enabled on
1617 networks where broadcasts are filtered out.</para>
1618 </listitem>
1619 </varlistentry>
e2e08e77 1620
798d3a52
ZJS
1621 <varlistentry>
1622 <term><varname>RouteMetric=</varname></term>
1623 <listitem>
1bf1bfd9 1624 <para>Set the routing metric for routes specified by the DHCP server. Defaults to 1024.</para>
798d3a52
ZJS
1625 </listitem>
1626 </varlistentry>
f594276b
JK
1627
1628 <varlistentry>
1629 <term><varname>RouteTable=<replaceable>num</replaceable></varname></term>
1630 <listitem>
d11e656a 1631 <para>The table identifier for DHCP routes (a number between 1 and 4294967295, or 0 to unset).
f594276b
JK
1632 The table can be retrieved using <command>ip route show table <replaceable>num</replaceable></command>.
1633 </para>
917b2260
AR
1634 <para>When used in combination with <varname>VRF=</varname> the
1635 VRF's routing table is used unless this parameter is specified.
1636 </para>
f594276b
JK
1637 </listitem>
1638 </varlistentry>
9faed222 1639
c695dcf9
SS
1640 <varlistentry>
1641 <term><varname>RouteMTUBytes=</varname></term>
1642 <listitem>
1643 <para>Specifies the MTU for the DHCP routes. Please see the [Route] section for further details.</para>
1644 </listitem>
1645 </varlistentry>
1646
9faed222
SS
1647 <varlistentry>
1648 <term><varname>ListenPort=</varname></term>
1649 <listitem>
1650 <para>Allow setting custom port for the DHCP client to listen on.</para>
1651 </listitem>
1652 </varlistentry>
fb5c8216 1653
d6463307
SS
1654 <varlistentry>
1655 <term><varname>FallbackLeaseLifetimeSec=</varname></term>
1656 <listitem>
1657 <para>Allows to set DHCPv4 lease lifetime when DHCPv4 server does not send the lease lifetime.
1658 Takes one of <literal>forever</literal> or <literal>infinity</literal> means that the address
1659 never expires. Defaults to unset.</para>
1660 </listitem>
1661 </varlistentry>
1662
1501b429
SS
1663 <varlistentry>
1664 <term><varname>SendRelease=</varname></term>
1665 <listitem>
1666 <para>When true, the DHCPv4 client sends a DHCP release packet when it stops.
5f3b5f19 1667 Defaults to true.</para>
1501b429
SS
1668 </listitem>
1669 </varlistentry>
1670
0f3ff4ea
SS
1671 <varlistentry>
1672 <term><varname>SendDecline=</varname></term>
1673 <listitem>
86b52a39 1674 <para>A boolean. When <literal>true</literal>, DHCPv4 clients receives IP address from DHCP server.
0f3ff4ea
SS
1675 After new IP is received, DHCPv4 performs IPv4 Duplicate Address Detection. If duplicate use of IP is detected
1676 the DHCPv4 client rejects the IP by sending a DHCPDECLINE packet DHCP clients try to obtain an IP address again.
1677 See <ulink url="https://tools.ietf.org/html/rfc5227">RFC 5224</ulink>.
1678 Defaults to <literal>unset</literal>.</para>
1679 </listitem>
1680 </varlistentry>
1681
caa8ca42 1682 <varlistentry>
5bc945be
SS
1683 <term><varname>BlackList=</varname></term>
1684 <listitem>
1685 <para>A whitespace-separated list of IPv4 addresses. DHCP offers from servers in the list are rejected.</para>
1686 </listitem>
1687 </varlistentry>
1688
1689 <varlistentry>
1690 <term><varname>RequestOptions=</varname></term>
caa8ca42 1691 <listitem>
35f6a5cb
SS
1692 <para>When configured, allows to set arbitrary request options in the DHCPv4 request options list and will be
1693 sent to the DHCPV4 server. A whitespace-separated list of integers in the range 1..254. Defaults to unset.</para>
caa8ca42
SS
1694 </listitem>
1695 </varlistentry>
1696
cb29c156 1697 <varlistentry>
864edb39 1698 <term><varname>SendOption=</varname></term>
cb29c156 1699 <listitem>
7354900d
DW
1700 <para>Send an arbitrary raw option in the DHCPv4 request. Takes a DHCP option number, data type
1701 and data separated with a colon
1702 (<literal><replaceable>option</replaceable>:<replaceable>type</replaceable>:<replaceable>value</replaceable></literal>).
1703 The option number must be an integer in the range 1..254. The type takes one of <literal>uint8</literal>,
1704 <literal>uint16</literal>, <literal>uint32</literal>, <literal>ipv4address</literal>, or
1705 <literal>string</literal>. Special characters in the data string may be escaped using
1706 <ulink url="https://en.wikipedia.org/wiki/Escape_sequences_in_C#Table_of_escape_sequences">C-style
1707 escapes</ulink>. This setting can be specified multiple times. If an empty string is specified,
1708 then all options specified earlier are cleared. Defaults to unset.</para>
1709 </listitem>
1710 </varlistentry>
1711
1712 <varlistentry>
1713 <term><varname>SendVendorOption=</varname></term>
1714 <listitem>
1715 <para>Send an arbitrary vendor option in the DHCPv4 request. Takes a DHCP option number, data type
d8b736bd
YW
1716 and data separated with a colon
1717 (<literal><replaceable>option</replaceable>:<replaceable>type</replaceable>:<replaceable>value</replaceable></literal>).
11fcfc53 1718 The option number must be an integer in the range 1..254. The type takes one of <literal>uint8</literal>,
d8b736bd
YW
1719 <literal>uint16</literal>, <literal>uint32</literal>, <literal>ipv4address</literal>, or
1720 <literal>string</literal>. Special characters in the data string may be escaped using
a2cc708a 1721 <ulink url="https://en.wikipedia.org/wiki/Escape_sequences_in_C#Table_of_escape_sequences">C-style
d8b736bd 1722 escapes</ulink>. This setting can be specified multiple times. If an empty string is specified,
a2cc708a 1723 then all options specified earlier are cleared. Defaults to unset.</para>
cb29c156
SS
1724 </listitem>
1725 </varlistentry>
caa8ca42
SS
1726 </variablelist>
1727 </refsect1>
1728
1729 <refsect1>
1730 <title>[DHCPv6] Section Options</title>
1731 <para>The <literal>[DHCPv6]</literal> section configures the DHCPv6 client, if it is enabled with the
4f7331a8 1732 <varname>DHCP=</varname> setting described above, or invoked by the IPv6 Router Advertisement:</para>
caa8ca42
SS
1733
1734 <variablelist class='network-directives'>
1735 <varlistentry>
1736 <term><varname>UseDNS=</varname></term>
1737 <term><varname>UseNTP=</varname></term>
1738 <listitem>
9fdae8d5 1739 <para>As in the <literal>[DHCPv4]</literal> section.</para>
caa8ca42
SS
1740 </listitem>
1741 </varlistentry>
1742
1bf1bfd9
YW
1743 <varlistentry>
1744 <term><varname>RouteMetric=</varname></term>
1745 <listitem>
1746 <para>Set the routing metric for routes specified by the DHCP server. Defaults to 1024.</para>
1747 </listitem>
1748 </varlistentry>
1749
fb5c8216
SS
1750 <varlistentry>
1751 <term><varname>RapidCommit=</varname></term>
1752 <listitem>
9b6ffef3 1753 <para>Takes a boolean. The DHCPv6 client can obtain configuration parameters from a DHCPv6 server through
fb5c8216
SS
1754 a rapid two-message exchange (solicit and reply). When the rapid commit option is enabled by both
1755 the DHCPv6 client and the DHCPv6 server, the two-message exchange is used, rather than the default
1756 four-method exchange (solicit, advertise, request, and reply). The two-message exchange provides
1757 faster client configuration and is beneficial in environments in which networks are under a heavy load.
1758 See <ulink url="https://tools.ietf.org/html/rfc3315#section-17.2.1">RFC 3315</ulink> for details.
1759 Defaults to true.</para>
1760 </listitem>
1761 </varlistentry>
1762
3175a8c2
SS
1763 <varlistentry>
1764 <term><varname>MUDURL=</varname></term>
1765 <listitem>
1766 <para>When configured, the Manufacturer Usage Descriptions (MUD) URL will be sent to the DHCPV6 server.
1767 Takes an URL of length up to 255 characters. A superficial verification that the string is a valid URL
1768 will be performed. DHCPv6 clients are intended to have at most one MUD URL associated with them. See
1769 <ulink url="https://tools.ietf.org/html/rfc8520">RFC 8520</ulink>.</para>
1770 </listitem>
1771 </varlistentry>
1772
35f6a5cb
SS
1773 <varlistentry>
1774 <term><varname>RequestOptions=</varname></term>
1775 <listitem>
1776 <para>When configured, allows to set arbitrary request options in the DHCPv6 request options list and will
1777 sent to the DHCPV6 server. A whitespace-separated list of integers in the range 1..254. Defaults to unset.</para>
1778 </listitem>
1779 </varlistentry>
1780
b4ccc5de
SS
1781 <varlistentry>
1782 <term><varname>SendVendorOption=</varname></term>
1783 <listitem>
1784 <para>Send an arbitrary vendor option in the DHCPv6 request. Takes an enterprise identifier, DHCP option number,
1785 data type, and data separated with a colon
1786 (<literal><replaceable>enterprise identifier</replaceable>:<replaceable>option</replaceable>:<replaceable>type</replaceable>:
1787 <replaceable>value</replaceable></literal>). Enterprise identifier is an unsigned integer ranges 1..4294967294.
1788 The option number must be an integer in the range 1..254. Data type takes one of <literal>uint8</literal>,
1789 <literal>uint16</literal>, <literal>uint32</literal>, <literal>ipv4address</literal>, <literal>ipv6address</literal>, or
1790 <literal>string</literal>. Special characters in the data string may be escaped using
1791 <ulink url="https://en.wikipedia.org/wiki/Escape_sequences_in_C#Table_of_escape_sequences">C-style
1792 escapes</ulink>. This setting can be specified multiple times. If an empty string is specified,
1793 then all options specified earlier are cleared. Defaults to unset.</para>
1794 </listitem>
1795 </varlistentry>
1796
125f20b4
PF
1797 <varlistentry>
1798 <term><varname>ForceDHCPv6PDOtherInformation=</varname></term>
1799 <listitem>
9b6ffef3 1800 <para>Takes a boolean that enforces DHCPv6 stateful mode when the 'Other information' bit is set in
125f20b4
PF
1801 Router Advertisement messages. By default setting only the 'O' bit in Router Advertisements
1802 makes DHCPv6 request network information in a stateless manner using a two-message Information
1803 Request and Information Reply message exchange.
1804 <ulink url="https://tools.ietf.org/html/rfc7084">RFC 7084</ulink>, requirement WPD-4, updates
1805 this behavior for a Customer Edge router so that stateful DHCPv6 Prefix Delegation is also
1806 requested when only the 'O' bit is set in Router Advertisements. This option enables such a CE
1807 behavior as it is impossible to automatically distinguish the intention of the 'O' bit otherwise.
1808 By default this option is set to 'false', enable it if no prefixes are delegated when the device
1809 should be acting as a CE router.</para>
1810 </listitem>
1811 </varlistentry>
1812
9efa8a3c
SS
1813 <varlistentry>
1814 <term><varname>AssignAcquiredDelegatedPrefixAddress=</varname></term>
1815 <listitem>
1816 <para>Takes a boolean. Specifies whether to add an address from the delegated prefixes which are received
1817 from the WAN interface by the <varname>IPv6PrefixDelegation=</varname>. When true (on LAN interfce), the EUI-64
1818 algorithm will be used to form an interface identifier from the delegated prefixes. Defaults to true.</para>
1819 </listitem>
1820 </varlistentry>
1821
120b5c0b
SS
1822 <varlistentry>
1823 <term><varname>AssignAcquiredDelegatedPrefixToken=</varname></term>
1824 <listitem>
1825 <para>Specifies an optional address generation mode for <varname>AssignAcquiredDelegatedPrefixAddress=</varname>.
1826 Takes an IPv6 address. When set, the lower bits of the supplied address are combined with the upper bits of a
1827 delegatad prefix received from the WAN interface by the <varname>IPv6PrefixDelegation=</varname> prefixes to
1828 form a complete address.</para>
1829 </listitem>
1830 </varlistentry>
1831
2805536b
SS
1832 <varlistentry>
1833 <term><varname>PrefixDelegationHint=</varname></term>
1834 <listitem>
48daf510 1835 <para>Takes an IPv6 address with prefix length as <varname>Address=</varname> in
2805536b 1836 the "[Network]" section. Specifies the DHCPv6 client for the requesting router to include
35f6a5cb 1837 a prefix-hint in the DHCPv6 solicitation. Prefix ranges 1..128. Defaults to unset.</para>
2805536b
SS
1838 </listitem>
1839 </varlistentry>
cd305af1
SS
1840
1841 <varlistentry>
1842 <term><varname>WithoutRA=</varname></term>
1843 <listitem>
1844 <para>When true, DHCPv6 client starts without router advertisements's managed or other address configuration flag.
1845 Defaults to false.</para>
1846 </listitem>
1847 </varlistentry>
e7d5fe17
AD
1848
1849 <varlistentry>
1850 <term><varname>SendOption=</varname></term>
1851 <listitem>
1852 <para>As in the <literal>[DHCPv4]</literal> section, however because DHCPv6 uses 16-bit fields to store
1853 option numbers, the option number is an integer in the range 1..65536.</para>
1854 </listitem>
1855 </varlistentry>
f37f2a6b
SS
1856
1857 <varlistentry>
1858 <term><varname>UserClass=</varname></term>
1859 <listitem>
1860 <para>A DHCPv6 client can use User Class option to identify the type or category of user or applications
1861 it represents. The information contained in this option is a string that represents the user class of which
1862 the client is a member. Each class sets an identifying string of information to be used by the DHCP
1863 service to classify clients. Special characters in the data string may be escaped using
1864 <ulink url="https://en.wikipedia.org/wiki/Escape_sequences_in_C#Table_of_escape_sequences">C-style
1865 escapes</ulink>. This setting can be specified multiple times. If an empty string is specified,
1866 then all options specified earlier are cleared. Takes a whitespace-separated list of strings. Note that
1867 currently NUL bytes are not allowed.</para>
1868 </listitem>
1869 </varlistentry>
ed0d1b2e
SS
1870
1871 <varlistentry>
1872 <term><varname>VendorClass=</varname></term>
1873 <listitem>
1874 <para>A DHCPv6 client can use VendorClass option to identify the vendor that
1875 manufactured the hardware on which the client is running. The information
1876 contained in the data area of this option is contained in one or more opaque
1877 fields that identify details of the hardware configuration. Takes a
1878 whitespace-separated list of strings.</para>
1879 </listitem>
1880 </varlistentry>
ad943783 1881 </variablelist>
caa8ca42 1882 </refsect1>
413708d1 1883
1e7a0e21 1884 <refsect1>
f921f573
LP
1885 <title>[IPv6AcceptRA] Section Options</title>
1886 <para>The <literal>[IPv6AcceptRA]</literal> section configures the IPv6 Router Advertisement
1887 (RA) client, if it is enabled with the <varname>IPv6AcceptRA=</varname> setting described
1e7a0e21
LP
1888 above:</para>
1889
1890 <variablelist class='network-directives'>
1891 <varlistentry>
1892 <term><varname>UseDNS=</varname></term>
1893 <listitem>
1894 <para>When true (the default), the DNS servers received in the Router Advertisement will be used and take
1895 precedence over any statically configured ones.</para>
1896
1897 <para>This corresponds to the <option>nameserver</option> option in <citerefentry
1898 project='man-pages'><refentrytitle>resolv.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para>
1899 </listitem>
1900 </varlistentry>
1901
1902 <varlistentry>
1903 <term><varname>UseDomains=</varname></term>
1904 <listitem>
9b6ffef3 1905 <para>Takes a boolean, or the special value <literal>route</literal>. When true, the domain name
1e7a0e21
LP
1906 received via IPv6 Router Advertisement (RA) will be used as DNS search domain over this link, similar to
1907 the effect of the <option>Domains=</option> setting. If set to <literal>route</literal>, the domain name
1908 received via IPv6 RA will be used for routing DNS queries only, but not for searching, similar to the
1909 effect of the <option>Domains=</option> setting when the argument is prefixed with
1910 <literal>~</literal>. Defaults to false.</para>
1911
1912 <para>It is recommended to enable this option only on trusted networks, as setting this affects resolution
38b38500 1913 of all hostnames, in particular of single-label names. It is generally safer to use the supplied domain
1e7a0e21
LP
1914 only as routing domain, rather than as search domain, in order to not have it affect local resolution of
1915 single-label names.</para>
1916
1917 <para>When set to true, this setting corresponds to the <option>domain</option> option in <citerefentry
1918 project='man-pages'><refentrytitle>resolv.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para>
1919 </listitem>
1920 </varlistentry>
2ba31d29
JK
1921
1922 <varlistentry>
1923 <term><varname>RouteTable=<replaceable>num</replaceable></varname></term>
1924 <listitem>
d11e656a
ZJS
1925 <para>The table identifier for the routes received in the Router Advertisement
1926 (a number between 1 and 4294967295, or 0 to unset).
2ba31d29
JK
1927 The table can be retrieved using <command>ip route show table <replaceable>num</replaceable></command>.
1928 </para>
1929 </listitem>
1930 </varlistentry>
062c2eea
SS
1931
1932 <varlistentry>
1933 <term><varname>UseAutonomousPrefix=</varname></term>
1934 <listitem>
1935 <para>When true (the default), the autonomous prefix received in the Router Advertisement will be used and take
1936 precedence over any statically configured ones.</para>
1937 </listitem>
1938 </varlistentry>
1939
1940 <varlistentry>
1941 <term><varname>UseOnLinkPrefix=</varname></term>
1942 <listitem>
1943 <para>When true (the default), the onlink prefix received in the Router Advertisement will be used and take
1944 precedence over any statically configured ones.</para>
1945 </listitem>
1946 </varlistentry>
1947
e520ce64
SS
1948 <varlistentry>
1949 <term><varname>BlackList=</varname></term>
1950 <listitem>
1951 <para>A whitespace-separated list of IPv6 prefixes. IPv6 prefixes supplied via router advertisements in the list are ignored.</para>
1952 </listitem>
1953 </varlistentry>
1954
d739fdde
YW
1955 <varlistentry>
1956 <term><varname>DHCPv6Client=</varname></term>
1957 <listitem>
ac24e418
SS
1958 <para>Takes a boolean, or the special value <literal>always</literal>. When true (the default), the DHCPv6 client will be started when the
1959 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
1960 managed or other information flag in the RA.</para>
d739fdde
YW
1961 </listitem>
1962 </varlistentry>
1e7a0e21
LP
1963 </variablelist>
1964 </refsect1>
1965
ad943783
LP
1966 <refsect1>
1967 <title>[DHCPServer] Section Options</title>
1968 <para>The <literal>[DHCPServer]</literal> section contains
1969 settings for the DHCP server, if enabled via the
1970 <varname>DHCPServer=</varname> option described above:</para>
1971
1972 <variablelist class='network-directives'>
1973
9b3a67c5
TG
1974 <varlistentry>
1975 <term><varname>PoolOffset=</varname></term>
1976 <term><varname>PoolSize=</varname></term>
1977
1978 <listitem><para>Configures the pool of addresses to hand out. The pool
1979 is a contiguous sequence of IP addresses in the subnet configured for
1980 the server address, which does not include the subnet nor the broadcast
1981 address. <varname>PoolOffset=</varname> takes the offset of the pool
1982 from the start of subnet, or zero to use the default value.
1983 <varname>PoolSize=</varname> takes the number of IP addresses in the
b938cb90 1984 pool or zero to use the default value. By default, the pool starts at
9b3a67c5
TG
1985 the first address after the subnet address and takes up the rest of
1986 the subnet, excluding the broadcast address. If the pool includes
1987 the server address (the default), this is reserved and not handed
1988 out to clients.</para></listitem>
1989 </varlistentry>
1990
ad943783
LP
1991 <varlistentry>
1992 <term><varname>DefaultLeaseTimeSec=</varname></term>
1993 <term><varname>MaxLeaseTimeSec=</varname></term>
1994
1995 <listitem><para>Control the default and maximum DHCP lease
1996 time to pass to clients. These settings take time values in seconds or
1997 another common time unit, depending on the suffix. The default
1998 lease time is used for clients that did not ask for a specific
1999 lease time. If a client asks for a lease time longer than the
b938cb90 2000 maximum lease time, it is automatically shortened to the
ad943783
LP
2001 specified time. The default lease time defaults to 1h, the
2002 maximum lease time to 12h. Shorter lease times are beneficial
2003 if the configuration data in DHCP leases changes frequently
2004 and clients shall learn the new settings with shorter
2005 latencies. Longer lease times reduce the generated DHCP
2006 network traffic.</para></listitem>
2007 </varlistentry>
2008
2009 <varlistentry>
2010 <term><varname>EmitDNS=</varname></term>
2011 <term><varname>DNS=</varname></term>
2012
9b6ffef3
YW
2013 <listitem><para>Takes a boolean. Configures whether the DHCP leases handed out
2014 to clients shall contain DNS server information. Defaults to <literal>yes</literal>.
2015 The DNS servers to pass to clients may be configured with the
ad943783
LP
2016 <varname>DNS=</varname> option, which takes a list of IPv4
2017 addresses. If the <varname>EmitDNS=</varname> option is
b938cb90 2018 enabled but no servers configured, the servers are
ad943783
LP
2019 automatically propagated from an "uplink" interface that has
2020 appropriate servers set. The "uplink" interface is determined
2021 by the default route of the system with the highest
2022 priority. Note that this information is acquired at the time
2023 the lease is handed out, and does not take uplink interfaces
2024 into account that acquire DNS or NTP server information at a
2025 later point. DNS server propagation does not take
2026 <filename>/etc/resolv.conf</filename> into account. Also, note
a8eaaee7 2027 that the leases are not refreshed if the uplink network
ad943783 2028 configuration changes. To ensure clients regularly acquire the
b938cb90 2029 most current uplink DNS server information, it is thus
ad943783
LP
2030 advisable to shorten the DHCP lease time via
2031 <varname>MaxLeaseTimeSec=</varname> described
2032 above.</para></listitem>
2033 </varlistentry>
2034
2035 <varlistentry>
2036 <term><varname>EmitNTP=</varname></term>
2037 <term><varname>NTP=</varname></term>
2038
2039 <listitem><para>Similar to the <varname>EmitDNS=</varname> and
b938cb90 2040 <varname>DNS=</varname> settings described above, these
ad943783
LP
2041 settings configure whether and what NTP server information
2042 shall be emitted as part of the DHCP lease. The same syntax,
2043 propagation semantics and defaults apply as for
2044 <varname>EmitDNS=</varname> and
2045 <varname>DNS=</varname>.</para></listitem>
2046 </varlistentry>
2047
299d578f
SS
2048 <varlistentry>
2049 <term><varname>EmitSIP=</varname></term>
2050 <term><varname>SIP=</varname></term>
2051
2052 <listitem><para>Similar to the <varname>EmitDNS=</varname> and
2053 <varname>DNS=</varname> settings described above, these
2054 settings configure whether and what SIP server information
2055 shall be emitted as part of the DHCP lease. The same syntax,
2056 propagation semantics and defaults apply as for
2057 <varname>EmitDNS=</varname> and
2058 <varname>DNS=</varname>.</para></listitem>
2059 </varlistentry>
2060
284e8fd0
SS
2061 <varlistentry>
2062 <term><varname>POP3Servers=</varname></term>
2063
7d6342e4
ZJS
2064 <listitem><para>Similar to the <varname>DNS=</varname> setting described above, this setting
2065 configures whether and what POP3 server information shall be emitted as part of the DHCP lease. The
2066 same syntax, propagation semantics and defaults apply as for
f6269fe7
SS
2067 <varname>DNS=</varname>.</para></listitem>
2068 </varlistentry>
2069
2070 <varlistentry>
2071 <term><varname>SMTPServers=</varname></term>
2072
2073 <listitem><para>Similar to the <varname>DNS=</varname> setting described above, this
2074 setting configures whether and what SMTP server information shall be emitted as part of
2075 the DHCP lease. The same syntax, propagation semantics and defaults apply as for
284e8fd0 2076 <varname>DNS=</varname>.</para></listitem>
d361b373
SS
2077 </varlistentry>
2078
2079 <varlistentry>
2080 <term><varname>LPRServers=</varname></term>
2081
2082 <listitem><para>Similar to the <varname>DNS=</varname> setting described above, this
2083 setting configures whether and what LPR (line printer) server information shall be emitted
2084 as part of the DHCP lease. The same syntax, propagation semantics and defaults apply as for
2085 <varname>DNS=</varname>.</para></listitem>
284e8fd0
SS
2086 </varlistentry>
2087
77ff6022
CG
2088 <varlistentry>
2089 <term><varname>EmitRouter=</varname></term>
2090
2091 <listitem><para>Similar to the <varname>EmitDNS=</varname>
2092 setting described above, this setting configures whether the
2093 DHCP lease should contain the router option. The same syntax,
2094 propagation semantics and defaults apply as for
2095 <varname>EmitDNS=</varname>.</para></listitem>
2096 </varlistentry>
2097
ad943783
LP
2098 <varlistentry>
2099 <term><varname>EmitTimezone=</varname></term>
2100 <term><varname>Timezone=</varname></term>
2101
9b6ffef3
YW
2102 <listitem><para>Takes a boolean. Configures whether the DHCP leases handed out
2103 to clients shall contain timezone information. Defaults to <literal>yes</literal>. The
ad943783
LP
2104 <varname>Timezone=</varname> setting takes a timezone string
2105 (such as <literal>Europe/Berlin</literal> or
2106 <literal>UTC</literal>) to pass to clients. If no explicit
b938cb90 2107 timezone is set, the system timezone of the local host is
ad943783
LP
2108 propagated, as determined by the
2109 <filename>/etc/localtime</filename> symlink.</para></listitem>
2110 </varlistentry>
2111
564ca984 2112 <varlistentry>
d8b736bd
YW
2113 <term><varname>SendOption=</varname></term>
2114 <listitem>
2115 <para>Send a raw option with value via DHCPv4 server. Takes a DHCP option number, data type
2116 and data (<literal><replaceable>option</replaceable>:<replaceable>type</replaceable>:<replaceable>value</replaceable></literal>).
2117 The option number is an integer in the range 1..254. The type takes one of <literal>uint8</literal>,
e7d5fe17 2118 <literal>uint16</literal>, <literal>uint32</literal>, <literal>ipv4address</literal>, <literal>ipv6address</literal>, or
7354900d
DW
2119 <literal>string</literal>. Special characters in the data string may be escaped using
2120 <ulink url="https://en.wikipedia.org/wiki/Escape_sequences_in_C#Table_of_escape_sequences">C-style
2121 escapes</ulink>. This setting can be specified multiple times. If an empty string is specified,
2122 then all options specified earlier are cleared. Defaults to unset.</para>
2123 </listitem>
2124 </varlistentry>
2125
2126 <varlistentry>
2127 <term><varname>SendVendorOption=</varname></term>
2128 <listitem>
2129 <para>Send a vendor option with value via DHCPv4 server. Takes a DHCP option number, data type
2130 and data (<literal><replaceable>option</replaceable>:<replaceable>type</replaceable>:<replaceable>value</replaceable></literal>).
2131 The option number is an integer in the range 1..254. The type takes one of <literal>uint8</literal>,
d8b736bd
YW
2132 <literal>uint16</literal>, <literal>uint32</literal>, <literal>ipv4address</literal>, or
2133 <literal>string</literal>. Special characters in the data string may be escaped using
2134 <ulink url="https://en.wikipedia.org/wiki/Escape_sequences_in_C#Table_of_escape_sequences">C-style
2135 escapes</ulink>. This setting can be specified multiple times. If an empty string is specified,
2136 then all options specified earlier are cleared. Defaults to unset.</para>
2137 </listitem>
564ca984
SS
2138 </varlistentry>
2139
ad943783
LP
2140 </variablelist>
2141 </refsect1>
2142
798d3a52 2143 <refsect1>
3f9e0236
PF
2144 <title>[IPv6PrefixDelegation] Section Options</title>
2145 <para>The <literal>[IPv6PrefixDelegation]</literal> section contains
2146 settings for sending IPv6 Router Advertisements and whether to act as
2147 a router, if enabled via the <varname>IPv6PrefixDelegation=</varname>
2148 option described above. IPv6 network prefixes are defined with one or
2149 more <literal>[IPv6Prefix]</literal> sections.</para>
2150
2151 <variablelist class='network-directives'>
2152
2153 <varlistentry>
2154 <term><varname>Managed=</varname></term>
2155 <term><varname>OtherInformation=</varname></term>
2156
9b6ffef3
YW
2157 <listitem><para>Takes a boolean. Controls whether a DHCPv6 server is used to acquire IPv6
2158 addresses on the network link when <varname>Managed=</varname>
3f9e0236
PF
2159 is set to <literal>true</literal> or if only additional network
2160 information can be obtained via DHCPv6 for the network link when
9b6ffef3 2161 <varname>OtherInformation=</varname> is set to
3f9e0236
PF
2162 <literal>true</literal>. Both settings default to
2163 <literal>false</literal>, which means that a DHCPv6 server is not being
2164 used.</para></listitem>
2165 </varlistentry>
2166
2167 <varlistentry>
2168 <term><varname>RouterLifetimeSec=</varname></term>
2169
9b6ffef3 2170 <listitem><para>Takes a timespan. Configures the IPv6 router lifetime in seconds. If set,
3f9e0236 2171 this host also announces itself in Router Advertisements as an IPv6
025314d9 2172 router for the network link. When unset, the host is not acting as a router.</para>
3f9e0236
PF
2173 </listitem>
2174 </varlistentry>
2175
2176 <varlistentry>
2177 <term><varname>RouterPreference=</varname></term>
2178
2179 <listitem><para>Configures IPv6 router preference if
2180 <varname>RouterLifetimeSec=</varname> is non-zero. Valid values are
2181 <literal>high</literal>, <literal>medium</literal> and
2182 <literal>low</literal>, with <literal>normal</literal> and
2183 <literal>default</literal> added as synonyms for
2184 <literal>medium</literal> just to make configuration easier. See
2185 <ulink url="https://tools.ietf.org/html/rfc4191">RFC 4191</ulink>
2186 for details. Defaults to <literal>medium</literal>.</para></listitem>
2187 </varlistentry>
2188
2189 <varlistentry>
4cb8478c 2190 <term><varname>EmitDNS=</varname></term>
3f9e0236
PF
2191 <term><varname>DNS=</varname></term>
2192
fd3ef936
YW
2193 <listitem><para><varname>DNS=</varname> specifies a list of recursive DNS server IPv6 addresses
2194 that are distributed via Router Advertisement messages when <varname>EmitDNS=</varname> is
2195 true. <varname>DNS=</varname> also takes special value <literal>_link_local</literal>; in that
2196 case the IPv6 link local address is distributed. If <varname>DNS=</varname> is empty, DNS
2197 servers are read from the <literal>[Network]</literal> section. If the
2198 <literal>[Network]</literal> section does not contain any DNS servers either, DNS servers from
2199 the uplink with the highest priority default route are used. When <varname>EmitDNS=</varname>
2200 is false, no DNS server information is sent in Router Advertisement messages.
4cb8478c 2201 <varname>EmitDNS=</varname> defaults to true.
3f9e0236
PF
2202 </para></listitem>
2203 </varlistentry>
2204
760021c0 2205 <varlistentry>
4cb8478c 2206 <term><varname>EmitDomains=</varname></term>
760021c0
PF
2207 <term><varname>Domains=</varname></term>
2208
4cb8478c
PF
2209 <listitem><para>A list of DNS search domains distributed via Router
2210 Advertisement messages when <varname>EmitDomains=</varname> is true. If
2211 <varname>Domains=</varname> is empty, DNS search domains are read from the
2212 <literal>[Network]</literal> section. If the <literal>[Network]</literal>
2213 section does not contain any DNS search domains either, DNS search
2214 domains from the uplink with the highest priority default route are
2215 used. When <varname>EmitDomains=</varname> is false, no DNS search domain
2216 information is sent in Router Advertisement messages.
2217 <varname>EmitDomains=</varname> defaults to true.
2218 </para></listitem>
760021c0
PF
2219 </varlistentry>
2220
3f9e0236
PF
2221 <varlistentry>
2222 <term><varname>DNSLifetimeSec=</varname></term>
2223
2224 <listitem><para>Lifetime in seconds for the DNS server addresses listed
760021c0
PF
2225 in <varname>DNS=</varname> and search domains listed in
2226 <varname>Domains=</varname>.</para></listitem>
3f9e0236
PF
2227 </varlistentry>
2228
2229 </variablelist>
2230 </refsect1>
2231
203d4df5 2232 <refsect1>
3f9e0236
PF
2233 <title>[IPv6Prefix] Section Options</title>
2234 <para>One or more <literal>[IPv6Prefix]</literal> sections contain the IPv6
2235 prefixes that are announced via Router Advertisements. See
2236 <ulink url="https://tools.ietf.org/html/rfc4861">RFC 4861</ulink>
2237 for further details.</para>
2238
2239 <variablelist class='network-directives'>
2240
2241 <varlistentry>
2242 <term><varname>AddressAutoconfiguration=</varname></term>
2243 <term><varname>OnLink=</varname></term>
2244
9b6ffef3 2245 <listitem><para>Takes a boolean to specify whether IPv6 addresses can be
3f9e0236
PF
2246 autoconfigured with this prefix and whether the prefix can be used for
2247 onlink determination. Both settings default to <literal>true</literal>
2248 in order to ease configuration.
2249 </para></listitem>
2250 </varlistentry>
2251
2252 <varlistentry>
2253 <term><varname>Prefix=</varname></term>
2254
2255 <listitem><para>The IPv6 prefix that is to be distributed to hosts.
2256 Similarly to configuring static IPv6 addresses, the setting is
2257 configured as an IPv6 prefix and its prefix length, separated by a
2258 <literal>/</literal> character. Use multiple
2259 <literal>[IPv6Prefix]</literal> sections to configure multiple IPv6
2260 prefixes since prefix lifetimes, address autoconfiguration and onlink
2261 status may differ from one prefix to another.</para></listitem>
2262 </varlistentry>
2263
2264 <varlistentry>
2265 <term><varname>PreferredLifetimeSec=</varname></term>
2266 <term><varname>ValidLifetimeSec=</varname></term>
2267
2268 <listitem><para>Preferred and valid lifetimes for the prefix measured in
2269 seconds. <varname>PreferredLifetimeSec=</varname> defaults to 604800
2270 seconds (one week) and <varname>ValidLifetimeSec=</varname> defaults
2271 to 2592000 seconds (30 days).</para></listitem>
203d4df5
SS
2272 </varlistentry>
2273
bd6379ec
SS
2274 <varlistentry>
2275 <term><varname>Assign=</varname></term>
2276 <listitem><para>Takes a boolean. When true, adds an address from the prefix. Default to false.
2277 </para></listitem>
2278 </varlistentry>
203d4df5
SS
2279 </variablelist>
2280 </refsect1>
2281
2282 <refsect1>
2283 <title>[IPv6RoutePrefix] Section Options</title>
2284 <para>One or more <literal>[IPv6RoutePrefix]</literal> sections contain the IPv6
2285 prefix routes that are announced via Router Advertisements. See
2286 <ulink url="https://tools.ietf.org/html/rfc4191">RFC 4191</ulink>
2287 for further details.</para>
2288
2289 <variablelist class='network-directives'>
2290
2291 <varlistentry>
2292 <term><varname>Route=</varname></term>
2293
2294 <listitem><para>The IPv6 route that is to be distributed to hosts.
2295 Similarly to configuring static IPv6 routes, the setting is
2296 configured as an IPv6 prefix routes and its prefix route length,
2297 separated by a<literal>/</literal> character. Use multiple
2298 <literal>[IPv6PrefixRoutes]</literal> sections to configure multiple IPv6
2299 prefix routes.</para></listitem>
2300 </varlistentry>
2301
2302 <varlistentry>
2303 <term><varname>LifetimeSec=</varname></term>
2304
2305 <listitem><para>Lifetime for the route prefix measured in
2306 seconds. <varname>LifetimeSec=</varname> defaults to 604800 seconds (one week).
2307 </para></listitem>
3f9e0236
PF
2308 </varlistentry>
2309
2310 </variablelist>
2311 </refsect1>
2312
2313 <refsect1>
798d3a52
ZJS
2314 <title>[Bridge] Section Options</title>
2315 <para>The <literal>[Bridge]</literal> section accepts the
2316 following keys.</para>
2317 <variablelist class='network-directives'>
165c41a9
SS
2318 <varlistentry>
2319 <term><varname>UnicastFlood=</varname></term>
2320 <listitem>
9b6ffef3 2321 <para>Takes a boolean. Controls whether the bridge should flood
072f9e4a 2322 traffic for which an FDB entry is missing and the destination
025314d9 2323 is unknown through this port. When unset, the kernel's default will be used.
47c7dfe2 2324 </para>
165c41a9
SS
2325 </listitem>
2326 </varlistentry>
7f15b714
TJ
2327 <varlistentry>
2328 <term><varname>MulticastFlood=</varname></term>
2329 <listitem>
2330 <para>Takes a boolean. Controls whether the bridge should flood
2331 traffic for which an MDB entry is missing and the destination
2332 is unknown through this port. When unset, the kernel's default will be used.
2333 </para>
2334 </listitem>
2335 </varlistentry>
d3aa8b49
SS
2336 <varlistentry>
2337 <term><varname>MulticastToUnicast=</varname></term>
2338 <listitem>
2339 <para>Takes a boolean. Multicast to unicast works on top of the multicast snooping feature of
2340 the bridge. Which means unicast copies are only delivered to hosts which are interested in it.
2341 When unset, the kernel's default will be used.
2342 </para>
2343 </listitem>
2344 </varlistentry>
7f15b714
TJ
2345 <varlistentry>
2346 <term><varname>NeighborSuppression=</varname></term>
2347 <listitem>
2348 <para>Takes a boolean. Configures whether ARP and ND neighbor suppression is enabled for
2349 this port. When unset, the kernel's default will be used.
2350 </para>
2351 </listitem>
2352 </varlistentry>
2353 <varlistentry>
2354 <term><varname>Learning=</varname></term>
2355 <listitem>
2356 <para>Takes a boolean. Configures whether MAC address learning is enabled for
2357 this port. When unset, the kernel's default will be used.
2358 </para>
2359 </listitem>
2360 </varlistentry>
165c41a9
SS
2361 <varlistentry>
2362 <term><varname>HairPin=</varname></term>
2363 <listitem>
9b6ffef3 2364 <para>Takes a boolean. Configures whether traffic may be sent back
025314d9
YW
2365 out of the port on which it was received. When this flag is false, and the bridge
2366 will not forward traffic back out of the receiving port.
2367 When unset, the kernel's default will be used.</para>
165c41a9
SS
2368 </listitem>
2369 </varlistentry>
2370 <varlistentry>
84c34096 2371 <term><varname>UseBPDU=</varname></term>
165c41a9 2372 <listitem>
9b6ffef3 2373 <para>Takes a boolean. Configures whether STP Bridge Protocol Data Units will be
025314d9 2374 processed by the bridge port. When unset, the kernel's default will be used.</para>
165c41a9
SS
2375 </listitem>
2376 </varlistentry>
2377 <varlistentry>
2378 <term><varname>FastLeave=</varname></term>
2379 <listitem>
9b6ffef3 2380 <para>Takes a boolean. This flag allows the bridge to immediately stop multicast
a8eaaee7 2381 traffic on a port that receives an IGMP Leave message. It is only used with
025314d9 2382 IGMP snooping if enabled on the bridge. When unset, the kernel's default will be used.</para>
165c41a9
SS
2383 </listitem>
2384 </varlistentry>
2385 <varlistentry>
23da66bb 2386 <term><varname>AllowPortToBeRoot=</varname></term>
165c41a9 2387 <listitem>
9b6ffef3 2388 <para>Takes a boolean. Configures whether a given port is allowed to
47c7dfe2 2389 become a root port. Only used when STP is enabled on the bridge.
025314d9 2390 When unset, the kernel's default will be used.</para>
165c41a9
SS
2391 </listitem>
2392 </varlistentry>
1087623b
SS
2393 <varlistentry>
2394 <term><varname>ProxyARP=</varname></term>
2395 <listitem>
2396 <para>Takes a boolean. Configures whether proxy ARP to be enabled on this port.
2397 When unset, the kernel's default will be used.</para>
2398 </listitem>
2399 </varlistentry>
2400 <varlistentry>
2401 <term><varname>ProxyARPWiFi=</varname></term>
2402 <listitem>
2403 <para>Takes a boolean. Configures whether proxy ARP to be enabled on this port
2404 which meets extended requirements by IEEE 802.11 and Hotspot 2.0 specifications.
2405 When unset, the kernel's default will be used.</para>
2406 </listitem>
2407 </varlistentry>
0fadb2a4
SS
2408 <varlistentry>
2409 <term><varname>MulticastRouter=</varname></term>
2410 <listitem>
2411 <para>Configures this port for having multicast routers attached. A port with a multicast
2412 router will receive all multicast traffic. Takes one of <literal>no</literal>
2413 to disable multicast routers on this port, <literal>query</literal> to let the system detect
2414 the presence of routers, <literal>permanent</literal> to permanently enable multicast traffic
2415 forwarding on this port, or <literal>temporary</literal> to enable multicast routers temporarily
2416 on this port, not depending on incoming queries. When unset, the kernel's default will be used.</para>
2417 </listitem>
2418 </varlistentry>
798d3a52
ZJS
2419 <varlistentry>
2420 <term><varname>Cost=</varname></term>
2421 <listitem>
47c7dfe2 2422 <para>Sets the "cost" of sending packets of this interface.
a8eaaee7 2423 Each port in a bridge may have a different speed and the cost
798d3a52 2424 is used to decide which link to use. Faster interfaces
785889e5 2425 should have lower costs. It is an integer value between 1 and
b56be296
DJL
2426 65535.</para>
2427 </listitem>
2428 </varlistentry>
2429 <varlistentry>
2430 <term><varname>Priority=</varname></term>
2431 <listitem>
2432 <para>Sets the "priority" of sending packets on this interface.
2433 Each port in a bridge may have a different priority which is used
2434 to decide which link to use. Lower value means higher priority.
785889e5 2435 It is an integer value between 0 to 63. Networkd does not set any
b56be296 2436 default, meaning the kernel default value of 32 is used.</para>
798d3a52
ZJS
2437 </listitem>
2438 </varlistentry>
2439 </variablelist>
2440 </refsect1>
798d3a52
ZJS
2441 <refsect1>
2442 <title>[BridgeFDB] Section Options</title>
2443 <para>The <literal>[BridgeFDB]</literal> section manages the
2444 forwarding database table of a port and accepts the following
2445 keys. Specify several <literal>[BridgeFDB]</literal> sections to
2446 configure several static MAC table entries.</para>
2447
2448 <variablelist class='network-directives'>
2449 <varlistentry>
2450 <term><varname>MACAddress=</varname></term>
2451 <listitem>
2452 <para>As in the <literal>[Network]</literal> section. This
2453 key is mandatory.</para>
2454 </listitem>
2455 </varlistentry>
c2c2793f
SS
2456 <varlistentry>
2457 <term><varname>Destination=</varname></term>
2458 <listitem>
2459 <para>Takes an IP address of the destination VXLAN tunnel endpoint.</para>
2460 </listitem>
2461 </varlistentry>
798d3a52
ZJS
2462 <varlistentry>
2463 <term><varname>VLANId=</varname></term>
2464 <listitem>
a8eaaee7 2465 <para>The VLAN ID for the new static MAC table entry. If
db9b9fb9 2466 omitted, no VLAN ID information is appended to the new static MAC
798d3a52
ZJS
2467 table entry.</para>
2468 </listitem>
2469 </varlistentry>
61b824c5
SS
2470 <varlistentry>
2471 <term><varname>VNI=</varname></term>
2472 <listitem>
2473 <para>The VXLAN Network Identifier (or VXLAN Segment ID) to use to connect to
2474 the remote VXLAN tunnel endpoint. Takes a number in the range 1-16777215.
2475 Defaults to unset.</para>
2476 </listitem>
2477 </varlistentry>
bdb397ed
SS
2478 <varlistentry>
2479 <term><varname>AssociatedWith=</varname></term>
2480 <listitem>
2481 <para>Specifies where the address is associated with. Takes one of <literal>use</literal>,
2482 <literal>self</literal>, <literal>master</literal> or <literal>router</literal>.
2483 <literal>use</literal> means the address is in use. User space can use this option to
2484 indicate to the kernel that the fdb entry is in use. <literal>self</literal> means
2485 the address is associated with the port drivers fdb. Usually hardware. <literal>master</literal>
2486 means the address is associated with master devices fdb. <literal>router</literal> means
2487 the destination address is associated with a router. Note that it's valid if the referenced
2488 device is a VXLAN type device and has route shortcircuit enabled. Defaults to <literal>self</literal>.</para>
2489 </listitem>
2490 </varlistentry>
798d3a52
ZJS
2491 </variablelist>
2492 </refsect1>
06828bb6 2493
e9a8c550
SS
2494 <refsect1>
2495 <title>[LLDP] Section Options</title>
2496 <para>The <literal>[LLDP]</literal> section manages the Link Layer Discovery Protocol (LLDP) and accepts the
2497 following keys.</para>
2498 <variablelist class='network-directives'>
2499 <varlistentry>
2500 <term><varname>MUDURL=</varname></term>
2501 <listitem>
2502 <para>Controls support for Ethernet LLDP packet's Manufacturer Usage Description (MUD). MUD is an embedded software
2503 standard defined by the IETF that allows IoT Device makers to advertise device specifications, including the intended
2504 communication patterns for their device when it connects to the network. The network can then use this intent to author
2505 a context-specific access policy, so the device functions only within those parameters. Takes an URL of length up to 255
2506 characters. A superficial verification that the string is a valid URL
2507 will be performed. See
2508 <ulink url="https://tools.ietf.org/html/rfc8520">RFC 8520</ulink> for details. The MUD URL received
2509 from the LLDP packets will be saved at the state files and can be read via
2510 <function>sd_lldp_neighbor_get_mud_url()</function> function.</para>
2511 </listitem>
2512 </varlistentry>
2513 </variablelist>
2514 </refsect1>
2515
06828bb6
HP
2516 <refsect1>
2517 <title>[CAN] Section Options</title>
2518 <para>The <literal>[CAN]</literal> section manages the Controller Area Network (CAN bus) and accepts the
2519 following keys.</para>
2520 <variablelist class='network-directives'>
2521 <varlistentry>
2522 <term><varname>BitRate=</varname></term>
2523 <listitem>
2524 <para>The bitrate of CAN device in bits per second. The usual SI prefixes (K, M) with the base of 1000 can
74a27268 2525 be used here. Takes a number in the range 1..4294967295.</para>
06828bb6
HP
2526 </listitem>
2527 </varlistentry>
2528 <varlistentry>
2529 <term><varname>SamplePoint=</varname></term>
2530 <listitem>
2531 <para>Optional sample point in percent with one decimal (e.g. <literal>75%</literal>,
2532 <literal>87.5%</literal>) or permille (e.g. <literal>875‰</literal>).</para>
2533 </listitem>
2534 </varlistentry>
7e025e9c
RP
2535 <varlistentry>
2536 <term><varname>DataBitRate=</varname></term>
2537 <term><varname>DataSamplePoint=</varname></term>
2538 <listitem>
2539 <para>The bitrate and sample point for the data phase, if CAN-FD is used. These settings are
2540 analogous to the <varname>BitRate=</varname> and <varname>SamplePoint=</varname> keys.</para>
2541 </listitem>
2542 </varlistentry>
2543 <varlistentry>
2544 <term><varname>FDMode=</varname></term>
2545 <listitem>
2546 <para>Takes a boolean. When <literal>yes</literal>, CAN-FD mode is enabled for the interface.
2547 Note, that a bitrate and optional sample point should also be set for the CAN-FD data phase using
2548 the <varname>DataBitRate=</varname> and <varname>DataSamplePoint=</varname> keys.</para>
2549 </listitem>
2550 </varlistentry>
2551 <varlistentry>
2552 <term><varname>FDNonISO=</varname></term>
2553 <listitem>
2554 <para>Takes a boolean. When <literal>yes</literal>, non-ISO CAN-FD mode is enabled for the
2555 interface. When unset, the kernel's default will be used.</para>
2556 </listitem>
2557 </varlistentry>
06828bb6
HP
2558 <varlistentry>
2559 <term><varname>RestartSec=</varname></term>
2560 <listitem>
2561 <para>Automatic restart delay time. If set to a non-zero value, a restart of the CAN controller will be
2562 triggered automatically in case of a bus-off condition after the specified delay time. Subsecond delays can
2563 be specified using decimals (e.g. <literal>0.1s</literal>) or a <literal>ms</literal> or
2564 <literal>us</literal> postfix. Using <literal>infinity</literal> or <literal>0</literal> will turn the
2565 automatic restart off. By default automatic restart is disabled.</para>
2566 </listitem>
2567 </varlistentry>
52aa38f1
MR
2568 <varlistentry>
2569 <term><varname>Termination=</varname></term>
2570 <listitem>
2571 <para>Takes a boolean. When <literal>yes</literal>, the termination resistor will be selected for
2572 the bias network. When unset, the kernel's default will be used.</para>
2573 </listitem>
2574 </varlistentry>
c423be28
CG
2575 <varlistentry>
2576 <term><varname>TripleSampling=</varname></term>
2577 <listitem>
2578 <para>Takes a boolean. When <literal>yes</literal>, three samples (instead of one) are used to determine
2579 the value of a received bit by majority rule. When unset, the kernel's default will be used.</para>
2580 </listitem>
2581 </varlistentry>
74f0fb90
YW
2582 <varlistentry>
2583 <term><varname>ListenOnly=</varname></term>
2584 <listitem>
2585 <para>Takes a boolean. When <literal>yes</literal>, listen-only mode is enabled. When the
2586 interface is in listen-only mode, the interface neither transmit CAN frames nor send ACK
2587 bit. Listen-only mode is important to debug CAN networks without interfering with the
2588 communication or acknowledge the CAN frame. When unset, the kernel's default will be used.
2589 </para>
2590 </listitem>
2591 </varlistentry>
06828bb6
HP
2592 </variablelist>
2593 </refsect1>
2594
2ed5f6d5
YW
2595 <refsect1>
2596 <title>[QDisc] Section Options</title>
2597 <para>The <literal>[QDisc]</literal> section manages the traffic control queueing discipline (qdisc).</para>
2598
2599 <variablelist class='network-directives'>
2600 <varlistentry>
2601 <term><varname>Parent=</varname></term>
2602 <listitem>
2603 <para>Specifies the parent Queueing Discipline (qdisc). Takes one of <literal>clsact</literal>
2604 or <literal>ingress</literal>. This is mandatory.</para>
2605 </listitem>
2606 </varlistentry>
d8b2396d 2607
f344a492 2608 <xi:include href="tc.xml" xpointer="qdisc-handle" />
2ed5f6d5
YW
2609 </variablelist>
2610 </refsect1>
2611
0f5bd7fe 2612 <refsect1>
18de0969
YW
2613 <title>[NetworkEmulator] Section Options</title>
2614 <para>The <literal>[NetworkEmulator]</literal> section manages the queueing discipline (qdisc) of
2615 the network emulator. It can be used to configure the kernel packet scheduler and simulate packet
2616 delay and loss for UDP or TCP applications, or limit the bandwidth usage of a particular service to
2617 simulate internet connections.</para>
0f5bd7fe
SS
2618
2619 <variablelist class='network-directives'>
f344a492
YW
2620 <xi:include href="tc.xml" xpointer="qdisc-parent" />
2621 <xi:include href="tc.xml" xpointer="qdisc-handle" />
d8b2396d 2622
0f5bd7fe 2623 <varlistentry>
18de0969 2624 <term><varname>DelaySec=</varname></term>
0f5bd7fe
SS
2625 <listitem>
2626 <para>Specifies the fixed amount of delay to be added to all packets going out of the
2627 interface. Defaults to unset.</para>
2628 </listitem>
2629 </varlistentry>
2630
2631 <varlistentry>
18de0969 2632 <term><varname>DelayJitterSec=</varname></term>
0f5bd7fe
SS
2633 <listitem>
2634 <para>Specifies the chosen delay to be added to the packets outgoing to the network
2635 interface. Defaults to unset.</para>
2636 </listitem>
2637 </varlistentry>
2638
2639 <varlistentry>
18de0969 2640 <term><varname>PacketLimit=</varname></term>
0f5bd7fe
SS
2641 <listitem>
2642 <para>Specifies the maximum number of packets the qdisc may hold queued at a time.
2643 An unsigned integer ranges 0 to 4294967294. Defaults to 1000.</para>
2644 </listitem>
2645 </varlistentry>
2646
2647 <varlistentry>
18de0969 2648 <term><varname>LossRate=</varname></term>
0f5bd7fe
SS
2649 <listitem>
2650 <para>Specifies an independent loss probability to be added to the packets outgoing from the
2651 network interface. Takes a percentage value, suffixed with "%". Defaults to unset.</para>
2652 </listitem>
2653 </varlistentry>
2654
b9c5aa3c 2655 <varlistentry>
18de0969 2656 <term><varname>DuplicateRate=</varname></term>
b9c5aa3c
SS
2657 <listitem>
2658 <para>Specifies that the chosen percent of packets is duplicated before queuing them.
2659 Takes a percentage value, suffixed with "%". Defaults to unset.</para>
2660 </listitem>
2661 </varlistentry>
18de0969
YW
2662 </variablelist>
2663 </refsect1>
b9c5aa3c 2664
18de0969 2665 <refsect1>
60ed2dcf
ZJS
2666 <title>[TokenBucketFilter] Section Options</title>
2667 <para>The <literal>[TokenBucketFilter]</literal> section manages the queueing discipline (qdisc) of
2668 token bucket filter (tbf).</para>
18de0969
YW
2669
2670 <variablelist class='network-directives'>
f344a492
YW
2671 <xi:include href="tc.xml" xpointer="qdisc-parent" />
2672 <xi:include href="tc.xml" xpointer="qdisc-handle" />
d8b2396d 2673
18de0969
YW
2674 <varlistentry>
2675 <term><varname>LatencySec=</varname></term>
ba5841b5
SS
2676 <listitem>
2677 <para>Specifies the latency parameter, which specifies the maximum amount of time a
60ed2dcf 2678 packet can sit in the Token Bucket Filter (TBF). Defaults to unset.</para>
ba5841b5
SS
2679 </listitem>
2680 </varlistentry>
2681
dcfc23ae 2682 <varlistentry>
18de0969 2683 <term><varname>LimitSize=</varname></term>
dcfc23ae
YW
2684 <listitem>
2685 <para>Takes the number of bytes that can be queued waiting for tokens to become available.
2686 When the size is suffixed with K, M, or G, it is parsed as Kilobytes, Megabytes, or Gigabytes,
2687 respectively, to the base of 1000. Defaults to unset.</para>
2688 </listitem>
2689 </varlistentry>
2690
ba5841b5 2691 <varlistentry>
18de0969 2692 <term><varname>Burst=</varname></term>
ba5841b5
SS
2693 <listitem>
2694 <para>Specifies the size of the bucket. This is the maximum amount of bytes that tokens
2695 can be available for instantaneous transfer. When the size is suffixed with K, M, or G, it is
2696 parsed as Kilobytes, Megabytes, or Gigabytes, respectively, to the base of 1000. Defaults to
2697 unset.</para>
2698 </listitem>
2699 </varlistentry>
2700
2701 <varlistentry>
18de0969 2702 <term><varname>Rate=</varname></term>
ba5841b5
SS
2703 <listitem>
2704 <para>Specifies the device specific bandwidth. When suffixed with K, M, or G, the specified
6b8fe4c3 2705 bandwidth is parsed as Kilobits, Megabits, or Gigabits, respectively, to the base of 1000.
ba5841b5
SS
2706 Defaults to unset.</para>
2707 </listitem>
2708 </varlistentry>
2709
dcfc23ae 2710 <varlistentry>
18de0969 2711 <term><varname>MPUBytes=</varname></term>
dcfc23ae
YW
2712 <listitem>
2713 <para>The Minimum Packet Unit (MPU) determines the minimal token usage (specified in bytes)
2714 for a packet. When suffixed with K, M, or G, the specified size is parsed as Kilobytes,
2715 Megabytes, or Gigabytes, respectively, to the base of 1000. Defaults to zero.</para>
2716 </listitem>
2717 </varlistentry>
2718
2719 <varlistentry>
18de0969 2720 <term><varname>PeakRate=</varname></term>
dcfc23ae
YW
2721 <listitem>
2722 <para>Takes the maximum depletion rate of the bucket. When suffixed with K, M, or G, the
6b8fe4c3 2723 specified size is parsed as Kilobits, Megabits, or Gigabits, respectively, to the base of
dcfc23ae
YW
2724 1000. Defaults to unset.</para>
2725 </listitem>
2726 </varlistentry>
2727
2728 <varlistentry>
18de0969 2729 <term><varname>MTUBytes=</varname></term>
dcfc23ae
YW
2730 <listitem>
2731 <para>Specifies the size of the peakrate bucket. When suffixed with K, M, or G, the specified
2732 size is parsed as Kilobytes, Megabytes, or Gigabytes, respectively, to the base of 1000.
2733 Defaults to unset.</para>
2734 </listitem>
2735 </varlistentry>
18de0969
YW
2736 </variablelist>
2737 </refsect1>
2738
bde4ae88
SS
2739 <refsect1>
2740 <title>[PIE] Section Options</title>
2741 <para>The <literal>[PIE]</literal> section manages the queueing discipline
2742 (qdisc) of Proportional Integral controller-Enhanced (PIE).</para>
2743
2744 <variablelist class='network-directives'>
f344a492
YW
2745 <xi:include href="tc.xml" xpointer="qdisc-parent" />
2746 <xi:include href="tc.xml" xpointer="qdisc-handle" />
bde4ae88
SS
2747
2748 <varlistentry>
2749 <term><varname>PacketLimit=</varname></term>
2750 <listitem>
2751 <para>Specifies the hard limit on the queue size in number of packets. When this limit is reached, incoming packets are
2752 dropped. An unsigned integer ranges 1 to 4294967294. Defaults to unset and kernel's default is used.</para>
2753 </listitem>
2754 </varlistentry>
2755 </variablelist>
2756 </refsect1>
2757
982998b0
SS
2758 <refsect1>
2759 <title>[StochasticFairBlue] Section Options</title>
2760 <para>The <literal>[StochasticFairBlue]</literal> section manages the queueing discipline
2761 (qdisc) of stochastic fair blue (sfb).</para>
2762
2763 <variablelist class='network-directives'>
f344a492
YW
2764 <xi:include href="tc.xml" xpointer="qdisc-parent" />
2765 <xi:include href="tc.xml" xpointer="qdisc-handle" />
982998b0
SS
2766
2767 <varlistentry>
2768 <term><varname>PacketLimit=</varname></term>
2769 <listitem>
2770 <para>Specifies the hard limit on the queue size in number of packets. When this limit is reached, incoming packets are
2771 dropped. An unsigned integer ranges 0 to 4294967294. Defaults to unset and kernel's default is used.</para>
2772 </listitem>
2773 </varlistentry>
2774 </variablelist>
2775 </refsect1>
2776
18de0969
YW
2777 <refsect1>
2778 <title>[StochasticFairnessQueueing] Section Options</title>
2779 <para>The <literal>[StochasticFairnessQueueing]</literal> section manages the queueing discipline
2780 (qdisc) of stochastic fairness queueing (sfq).</para>
2781
2782 <variablelist class='network-directives'>
f344a492
YW
2783 <xi:include href="tc.xml" xpointer="qdisc-parent" />
2784 <xi:include href="tc.xml" xpointer="qdisc-handle" />
d8b2396d 2785
9942b710 2786 <varlistentry>
18de0969 2787 <term><varname>PerturbPeriodSec=</varname></term>
9942b710
SS
2788 <listitem>
2789 <para>Specifies the interval in seconds for queue algorithm perturbation. Defaults to unset.</para>
2790 </listitem>
2791 </varlistentry>
18de0969
YW
2792 </variablelist>
2793 </refsect1>
2794
c853f594
SS
2795 <refsect1>
2796 <title>[BFIFO] Section Options</title>
2797 <para>The <literal>[BFIFO]</literal> section manages the queueing discipline (qdisc) of
2798 Byte limited Packet First In First Out (bfifo).</para>
2799
2800 <variablelist class='network-directives'>
f344a492
YW
2801 <xi:include href="tc.xml" xpointer="qdisc-parent" />
2802 <xi:include href="tc.xml" xpointer="qdisc-handle" />
c853f594
SS
2803
2804 <varlistentry>
2805 <term><varname>LimitSize=</varname></term>
2806 <listitem>
2807 <para>Specifies the hard limit on the FIFO size in bytes. The size limit (a buffer size) to prevent it
2808 from overflowing in case it is unable to dequeue packets as quickly as it receives them. When this limit
2809 is reached, incoming packets are dropped. When suffixed with K, M, or G, the specified size is parsed as
2810 Kilobytes, Megabytes, or Gigabytes, respectively, to the base of 1024. Defaults to unset and kernel's default is used.</para>
2811 </listitem>
2812 </varlistentry>
2813 </variablelist>
2814 </refsect1>
2815
a7476065
SS
2816 <refsect1>
2817 <title>[PFIFO] Section Options</title>
2818 <para>The <literal>[PFIFO]</literal> section manages the queueing discipline (qdisc) of
2819 Packet First In First Out (pfifo).</para>
2820
2821 <variablelist class='network-directives'>
f344a492
YW
2822 <xi:include href="tc.xml" xpointer="qdisc-parent" />
2823 <xi:include href="tc.xml" xpointer="qdisc-handle" />
a7476065
SS
2824
2825 <varlistentry>
2826 <term><varname>PacketLimit=</varname></term>
2827 <listitem>
2828 <para>Specifies the hard limit on the FIFO size in number of packets. The size limit (a buffer size) to prevent it
2829 from overflowing in case it is unable to dequeue packets as quickly as it receives them. When this limit is reached,
2830 incoming packets are dropped. An unsigned integer ranges 0 to 4294967294. Defaults to unset and kernel's default is used.</para>
2831 </listitem>
2832 </varlistentry>
ad8352f4
SS
2833 </variablelist>
2834 </refsect1>
2835
053a2ddb
SS
2836 <refsect1>
2837 <title>[PFIFOHeadDrop] Section Options</title>
2838 <para>The <literal>[PFIFOHeadDrop]</literal> section manages the queueing discipline (qdisc) of
2839 Packet First In First Out Head Drop (pfifo_head_drop).</para>
2840
2841 <variablelist class='network-directives'>
f344a492
YW
2842 <xi:include href="tc.xml" xpointer="qdisc-parent" />
2843 <xi:include href="tc.xml" xpointer="qdisc-handle" />
053a2ddb
SS
2844
2845 <varlistentry>
2846 <term><varname>PacketLimit=</varname></term>
2847 <listitem>
2848 <para>As in <literal>[PFIFO]</literal> section.</para></listitem>
2849 </varlistentry>
2850 </variablelist>
2851 </refsect1>
2852
1a95964b
SS
2853 <refsect1>
2854 <title>[PFIFOFast] Section Options</title>
2855 <para>The <literal>[PFIFOFast]</literal> section manages the queueing discipline (qdisc) of
2856 Packet First In First Out Fast (pfifo_fast).</para>
2857
2858 <variablelist class='network-directives'>
f344a492
YW
2859 <xi:include href="tc.xml" xpointer="qdisc-parent" />
2860 <xi:include href="tc.xml" xpointer="qdisc-handle" />
1a95964b
SS
2861 </variablelist>
2862 </refsect1>
2863
ad8352f4
SS
2864 <refsect1>
2865 <title>[CAKE] Section Options</title>
2866 <para>The <literal>[CAKE]</literal> section manages the queueing discipline (qdisc) of
2867 Common Applications Kept Enhanced (CAKE).</para>
2868
2869 <variablelist class='network-directives'>
f344a492
YW
2870 <xi:include href="tc.xml" xpointer="qdisc-parent" />
2871 <xi:include href="tc.xml" xpointer="qdisc-handle" />
a7476065 2872
ad8352f4 2873 <varlistentry>
ad8352f4
SS
2874 <term><varname>Overhead=</varname></term>
2875 <listitem>
2876 <para>Specifies that bytes to be addeded to the size of each packet. Bytes may be negative.
2877 Takes an integer ranges -64 to 256. Defaults to unset and kernel's default is used.</para>
2878 </listitem>
f344a492 2879 </varlistentry>
ad8352f4
SS
2880
2881 <varlistentry>
2882 <term><varname>Bandwidth=</varname></term>
2883 <listitem>
2884 <para>Specifies the shaper bandwidth. When suffixed with K, M, or G, the specified size is
2885 parsed as Kilobits, Megabits, or Gigabits, respectively, to the base of 1000. Defaults to
2886 unset and kernel's default is used.</para>
2887 </listitem>
2888 </varlistentry>
a7476065
SS
2889 </variablelist>
2890 </refsect1>
2891
18de0969
YW
2892 <refsect1>
2893 <title>[ControlledDelay] Section Options</title>
2894 <para>The <literal>[ControlledDelay]</literal> section manages the queueing discipline (qdisc) of
2895 controlled delay (CoDel).</para>
9942b710 2896
18de0969 2897 <variablelist class='network-directives'>
f344a492
YW
2898 <xi:include href="tc.xml" xpointer="qdisc-parent" />
2899 <xi:include href="tc.xml" xpointer="qdisc-handle" />
d8b2396d 2900
18de0969
YW
2901 <varlistentry>
2902 <term><varname>PacketLimit=</varname></term>
a9a5d632 2903 <listitem>
2cd65106 2904 <para>Specifies the hard limit on the queue size in number of packets. When this limit is reached, incoming packets are
a9a5d632
SS
2905 dropped. An unsigned integer ranges 0 to 4294967294. Defaults to unset and kernel's default is used.</para>
2906 </listitem>
2907 </varlistentry>
2908
b078e528 2909 <varlistentry>
18de0969 2910 <term><varname>TargetSec=</varname></term>
b078e528
YW
2911 <listitem>
2912 <para>Takes a timespan. Specifies the acceptable minimum standing/persistent queue delay.
2913 Defaults to unset and kernel's default is used.</para>
2914 </listitem>
2915 </varlistentry>
2916
2917 <varlistentry>
18de0969 2918 <term><varname>IntervalSec=</varname></term>
b078e528
YW
2919 <listitem>
2920 <para>Takes a timespan. This is used to ensure that the measured minimum delay does not
2921 become too stale. Defaults to unset and kernel's default is used.</para>
2922 </listitem>
2923 </varlistentry>
2924
2925 <varlistentry>
18de0969 2926 <term><varname>ECN=</varname></term>
b078e528
YW
2927 <listitem>
2928 <para>Takes a boolean. This can be used to mark packets instead of dropping them. Defaults to
2929 unset and kernel's default is used.</para>
2930 </listitem>
2931 </varlistentry>
2932
2933 <varlistentry>
18de0969 2934 <term><varname>CEThresholdSec=</varname></term>
b078e528
YW
2935 <listitem>
2936 <para>Takes a timespan. This sets a threshold above which all packets are marked with ECN
2937 Congestion Experienced (CE). Defaults to unset and kernel's default is used.</para>
2938 </listitem>
2939 </varlistentry>
18de0969
YW
2940 </variablelist>
2941 </refsect1>
b078e528 2942
f5fc0441
SS
2943 <refsect1>
2944 <title>[DeficitRoundRobinScheduler] Section Options</title>
2945 <para>The <literal>[DeficitRoundRobinScheduler]</literal> section manages the queueing discipline (qdisc) of
2946 Deficit Round Robin Scheduler (DRR).</para>
2947
2948 <variablelist class='network-directives'>
f344a492
YW
2949 <xi:include href="tc.xml" xpointer="qdisc-parent" />
2950 <xi:include href="tc.xml" xpointer="qdisc-handle" />
f5fc0441
SS
2951 </variablelist>
2952 </refsect1>
2953
ad365c5d
YW
2954 <refsect1>
2955 <title>[DeficitRoundRobinSchedulerClass] Section Options</title>
2956 <para>The <literal>[DeficitRoundRobinSchedulerClass]</literal> section manages the traffic control class of
2957 Deficit Round Robin Scheduler (DRR).</para>
2958
2959 <variablelist class='network-directives'>
f344a492
YW
2960 <xi:include href="tc.xml" xpointer="tclass-parent" />
2961 <xi:include href="tc.xml" xpointer="tclass-classid" />
ad365c5d
YW
2962
2963 <varlistentry>
2964 <term><varname>Quantum=</varname></term>
2965 <listitem>
2966 <para>Specifies the amount of bytes a flow is allowed to dequeue before the
2967 scheduler moves to the next class. An unsigned integer ranges 1 to 4294967294.
2968 Defaults to the MTU of the interface.</para>
2969 </listitem>
2970 </varlistentry>
2971
2972 </variablelist>
2973 </refsect1>
2974
609e8340
SS
2975 <refsect1>
2976 <title>[GenericRandomEarlyDetection] Section Options</title>
2977 <para>The <literal>[GenericRandomEarlyDetection]</literal> section manages the queueing discipline
2978 (qdisc) of Generic Random Early Detection (GRED).</para>
2979
2980 <variablelist class='network-directives'>
f344a492
YW
2981 <xi:include href="tc.xml" xpointer="qdisc-parent" />
2982 <xi:include href="tc.xml" xpointer="qdisc-handle" />
609e8340
SS
2983
2984 <varlistentry>
2985 <term><varname>VirtualQueues=</varname></term>
2986 <listitem>
2987 <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>
2988 </listitem>
2989 </varlistentry>
2990
2991 <varlistentry>
2992 <term><varname>DefaultVirtualQueue=</varname></term>
2993 <listitem>
2994 <para>Specifies the number of default virtual queue. This must be less than <varname>VirtualQueue=</varname>.
2995 Defaults to unset and kernel's default is used.</para>
2996 </listitem>
2997 </varlistentry>
2998
2999 <varlistentry>
3000 <term><varname>GenericRIO=</varname></term>
3001 <listitem>
3002 <para>Takes a boolean. It turns on the RIO-like buffering scheme. Defaults to
3003 unset and kernel's default is used.</para>
3004 </listitem>
3005 </varlistentry>
3006 </variablelist>
3007 </refsect1>
3008
18de0969
YW
3009 <refsect1>
3010 <title>[FairQueueingControlledDelay] Section Options</title>
3011 <para>The <literal>[FairQueueingControlledDelay]</literal> section manages the queueing discipline
3012 (qdisc) of fair queuing controlled delay (FQ-CoDel).</para>
3013
3014 <variablelist class='network-directives'>
f344a492
YW
3015 <xi:include href="tc.xml" xpointer="qdisc-parent" />
3016 <xi:include href="tc.xml" xpointer="qdisc-handle" />
d8b2396d 3017
18de0969
YW
3018 <varlistentry>
3019 <term><varname>PacketLimit=</varname></term>
4e5ef149
SS
3020 <listitem>
3021 <para>Specifies the hard limit on the real queue size. When this limit is reached, incoming packets are
3022 dropped. Defaults to unset and kernel's default is used.</para>
3023 </listitem>
3024 </varlistentry>
3025
ac810b75 3026 <varlistentry>
18de0969 3027 <term><varname>MemoryLimit=</varname></term>
ac810b75
YW
3028 <listitem>
3029 <para>Specifies the limit on the total number of bytes that can be queued in this FQ-CoDel instance.
3030 When suffixed with K, M, or G, the specified size is parsed as Kilobytes, Megabytes, or Gigabytes,
3031 respectively, to the base of 1024. Defaults to unset and kernel's default is used.</para>
3032 </listitem>
3033 </varlistentry>
3034
3035 <varlistentry>
18de0969 3036 <term><varname>Flows=</varname></term>
ac810b75
YW
3037 <listitem>
3038 <para>Specifies the number of flows into which the incoming packets are classified.
3039 Defaults to unset and kernel's default is used.</para>
3040 </listitem>
3041 </varlistentry>
3042
3043 <varlistentry>
18de0969 3044 <term><varname>TargetSec=</varname></term>
ac810b75
YW
3045 <listitem>
3046 <para>Takes a timespan. Specifies the acceptable minimum standing/persistent queue delay.
3047 Defaults to unset and kernel's default is used.</para>
3048 </listitem>
3049 </varlistentry>
3050
3051 <varlistentry>
18de0969 3052 <term><varname>IntervalSec=</varname></term>
ac810b75
YW
3053 <listitem>
3054 <para>Takes a timespan. This is used to ensure that the measured minimum delay does not
3055 become too stale. Defaults to unset and kernel's default is used.</para>
3056 </listitem>
3057 </varlistentry>
3058
3059 <varlistentry>
18de0969 3060 <term><varname>Quantum=</varname></term>
ac810b75
YW
3061 <listitem>
3062 <para>Specifies the number of bytes used as 'deficit' in the fair queuing algorithmtimespan.
3063 When suffixed with K, M, or G, the specified size is parsed as Kilobytes, Megabytes, or Gigabytes,
3064 respectively, to the base of 1024. Defaults to unset and kernel's default is used.</para>
3065 </listitem>
3066 </varlistentry>
3067
3068 <varlistentry>
18de0969 3069 <term><varname>ECN=</varname></term>
ac810b75
YW
3070 <listitem>
3071 <para>Takes a boolean. This can be used to mark packets instead of dropping them. Defaults to
3072 unset and kernel's default is used.</para>
3073 </listitem>
3074 </varlistentry>
3075
3076 <varlistentry>
18de0969 3077 <term><varname>CEThresholdSec=</varname></term>
ac810b75
YW
3078 <listitem>
3079 <para>Takes a timespan. This sets a threshold above which all packets are marked with ECN
3080 Congestion Experienced (CE). Defaults to unset and kernel's default is used.</para>
3081 </listitem>
3082 </varlistentry>
18de0969
YW
3083 </variablelist>
3084 </refsect1>
3085
3086 <refsect1>
ca58d00c
ZJS
3087 <title>[FairQueueing] Section Options</title>
3088 <para>The <literal>[FairQueueing]</literal> section manages the queueing discipline
18de0969
YW
3089 (qdisc) of fair queue traffic policing (FQ).</para>
3090
3091 <variablelist class='network-directives'>
f344a492
YW
3092 <xi:include href="tc.xml" xpointer="qdisc-parent" />
3093 <xi:include href="tc.xml" xpointer="qdisc-handle" />
d8b2396d 3094
7234b915 3095 <varlistentry>
18de0969 3096 <term><varname>PacketLimit=</varname></term>
7234b915
SS
3097 <listitem>
3098 <para>Specifies the hard limit on the real queue size. When this limit is reached, incoming packets are
3099 dropped. Defaults to unset and kernel's default is used.</para>
3100 </listitem>
3101 </varlistentry>
3102
e83562e5 3103 <varlistentry>
18de0969 3104 <term><varname>FlowLimit=</varname></term>
e83562e5
YW
3105 <listitem>
3106 <para>Specifies the hard limit on the maximum number of packets queued per flow. Defaults to
3107 unset and kernel's default is used.</para>
3108 </listitem>
3109 </varlistentry>
3110
3111 <varlistentry>
18de0969 3112 <term><varname>Quantum=</varname></term>
e83562e5
YW
3113 <listitem>
3114 <para>Specifies the credit per dequeue RR round, i.e. the amount of bytes a flow is allowed
3115 to dequeue at once. When suffixed with K, M, or G, the specified size is parsed as Kilobytes,
3116 Megabytes, or Gigabytes, respectively, to the base of 1024. Defaults to unset and kernel's
3117 default is used.</para>
3118 </listitem>
3119 </varlistentry>
3120
3121 <varlistentry>
18de0969 3122 <term><varname>InitialQuantum=</varname></term>
e83562e5
YW
3123 <listitem>
3124 <para>Specifies the initial sending rate credit, i.e. the amount of bytes a new flow is
3125 allowed to dequeue initially. When suffixed with K, M, or G, the specified size is parsed as
3126 Kilobytes, Megabytes, or Gigabytes, respectively, to the base of 1024. Defaults to unset and
3127 kernel's default is used.</para>
3128 </listitem>
3129 </varlistentry>
3130
3131 <varlistentry>
18de0969 3132 <term><varname>MaximumRate=</varname></term>
e83562e5
YW
3133 <listitem>
3134 <para>Specifies the maximum sending rate of a flow. When suffixed with K, M, or G, the
6b8fe4c3 3135 specified size is parsed as Kilobits, Megabits, or Gigabits, respectively, to the base of
e83562e5
YW
3136 1000. Defaults to unset and kernel's default is used.</para>
3137 </listitem>
3138 </varlistentry>
3139
3140 <varlistentry>
18de0969 3141 <term><varname>Buckets=</varname></term>
e83562e5
YW
3142 <listitem>
3143 <para>Specifies the size of the hash table used for flow lookups. Defaults to unset and
3144 kernel's default is used.</para>
3145 </listitem>
3146 </varlistentry>
3147
3148 <varlistentry>
18de0969 3149 <term><varname>OrphanMask=</varname></term>
e83562e5
YW
3150 <listitem>
3151 <para>Takes an unsigned integer. For packets not owned by a socket, fq is able to mask a part
3152 of hash and reduce number of buckets associated with the traffic. Defaults to unset and
3153 kernel's default is used.</para>
3154 </listitem>
3155 </varlistentry>
3156
3157 <varlistentry>
18de0969 3158 <term><varname>Pacing=</varname></term>
e83562e5
YW
3159 <listitem>
3160 <para>Takes a boolean, and enables or disables flow pacing. Defaults to unset and kernel's
3161 default is used.</para>
3162 </listitem>
3163 </varlistentry>
3164
3165 <varlistentry>
18de0969 3166 <term><varname>CEThresholdSec=</varname></term>
e83562e5
YW
3167 <listitem>
3168 <para>Takes a timespan. This sets a threshold above which all packets are marked with ECN
3169 Congestion Experienced (CE). Defaults to unset and kernel's default is used.</para>
3170 </listitem>
3171 </varlistentry>
0f5bd7fe
SS
3172 </variablelist>
3173 </refsect1>
3174
9b749c11
YW
3175 <refsect1>
3176 <title>[TrivialLinkEqualizer] Section Options</title>
3177 <para>The <literal>[TrivialLinkEqualizer]</literal> section manages the queueing discipline (qdisc) of
3178 trivial link equalizer (teql).</para>
3179
3180 <variablelist class='network-directives'>
f344a492
YW
3181 <xi:include href="tc.xml" xpointer="qdisc-parent" />
3182 <xi:include href="tc.xml" xpointer="qdisc-handle" />
d8b2396d 3183
9b749c11
YW
3184 <varlistentry>
3185 <term><varname>Id=</varname></term>
3186 <listitem>
3187 <para>Specifies the interface ID <literal>N</literal> of teql. Defaults to <literal>0</literal>.
3188 Note that when teql is used, currently, the module <constant>sch_teql</constant> with
3189 <constant>max_equalizers=N+1</constant> option must be loaded before
3190 <command>systemd-networkd</command> is started.</para>
3191 </listitem>
3192 </varlistentry>
3193 </variablelist>
3194 </refsect1>
3195
b934ac3d
YW
3196 <refsect1>
3197 <title>[HierarchyTokenBucket] Section Options</title>
3198 <para>The <literal>[HierarchyTokenBucket]</literal> section manages the queueing discipline (qdisc) of
3199 hierarchy token bucket (htb).</para>
3200
3201 <variablelist class='network-directives'>
f344a492
YW
3202 <xi:include href="tc.xml" xpointer="qdisc-parent" />
3203 <xi:include href="tc.xml" xpointer="qdisc-handle" />
b934ac3d
YW
3204
3205 <varlistentry>
3206 <term><varname>DefaultClass=</varname></term>
3207 <listitem>
3208 <para>Takes the minor id in hexadecimal of the default class. Unclassified traffic gets sent
3209 to the class. Defaults to unset.</para>
3210 </listitem>
3211 </varlistentry>
3212 </variablelist>
3213 </refsect1>
3214
19f86a63
YW
3215 <refsect1>
3216 <title>[HierarchyTokenBucketClass] Section Options</title>
3217 <para>The <literal>[HierarchyTokenBucketClass]</literal> section manages the traffic control class of
3218 hierarchy token bucket (htb).</para>
3219
3220 <variablelist class='network-directives'>
f344a492
YW
3221 <xi:include href="tc.xml" xpointer="tclass-parent" />
3222 <xi:include href="tc.xml" xpointer="tclass-classid" />
19f86a63
YW
3223
3224 <varlistentry>
3225 <term><varname>Priority=</varname></term>
3226 <listitem>
3227 <para>Specifies the priority of the class. In the round-robin process, classes with the lowest
3228 priority field are tried for packets first. This setting is mandatory.</para>
3229 </listitem>
3230 </varlistentry>
3231
3232 <varlistentry>
3233 <term><varname>Rate=</varname></term>
3234 <listitem>
3235 <para>Specifies the maximum rate this class and all its children are guaranteed. When suffixed
3236 with K, M, or G, the specified size is parsed as Kilobits, Megabits, or Gigabits, respectively,
3237 to the base of 1000. This setting is mandatory.</para>
3238 </listitem>
3239 </varlistentry>
3240
3241 <varlistentry>
3242 <term><varname>CeilRate=</varname></term>
3243 <listitem>
3244 <para>Specifies the maximum rate at which a class can send, if its parent has bandwidth to spare.
3245 When suffixed with K, M, or G, the specified size is parsed as Kilobits, Megabits, or Gigabits,
3246 respectively, to the base of 1000. When unset, the value specified with <varname>Rate=</varname>
3247 is used.</para>
3248 </listitem>
3249 </varlistentry>
7f224020
SS
3250 </variablelist>
3251 </refsect1>
3252
3253 <refsect1>
3254 <title>[HeavyHitterFilter] Section Options</title>
3255 <para>The <literal>[HeavyHitterFilter]</literal> section manages the queueing discipline
3256 (qdisc) of Heavy Hitter Filter (hhf).</para>
3257
3258 <variablelist class='network-directives'>
f344a492
YW
3259 <xi:include href="tc.xml" xpointer="qdisc-parent" />
3260 <xi:include href="tc.xml" xpointer="qdisc-handle" />
19f86a63 3261
7f224020
SS
3262 <varlistentry>
3263 <term><varname>PacketLimit=</varname></term>
3264 <listitem>
3265 <para>Specifies the hard limit on the queue size in number of packets. When this limit is reached, incoming packets are
3266 dropped. An unsigned integer ranges 0 to 4294967294. Defaults to unset and kernel's default is used.</para>
3267 </listitem>
3268 </varlistentry>
19f86a63
YW
3269 </variablelist>
3270 </refsect1>
3271
b12aaee5
SS
3272 <refsect1>
3273 <title>[QuickFairQueueing] Section Options</title>
3274 <para>The <literal>[QuickFairQueueing]</literal> section manages the queueing discipline
3275 (qdisc) of Quick Fair Queueing (QFQ).</para>
3276
3277 <variablelist class='network-directives'>
3278 <xi:include href="tc.xml" xpointer="qdisc-parent" />
3279 <xi:include href="tc.xml" xpointer="qdisc-handle" />
3280 </variablelist>
3281 </refsect1>
3282
4d7ddaf9
YW
3283 <refsect1>
3284 <title>[QuickFairQueueingClass] Section Options</title>
3285 <para>The <literal>[QuickFairQueueingClass]</literal> section manages the traffic control class of
3286 Quick Fair Queueing (qfq).</para>
3287
3288 <variablelist class='network-directives'>
3289 <xi:include href="tc.xml" xpointer="tclass-parent" />
3290 <xi:include href="tc.xml" xpointer="tclass-classid" />
3291
3292 <varlistentry>
3293 <term><varname>Weight=</varname></term>
3294 <listitem>
7487b486 3295 <para>Specifies the weight of the class. Takes an integer in the range 1..1023. Defaults to
4d7ddaf9
YW
3296 unset in which case the kernel default is used.</para>
3297 </listitem>
3298 </varlistentry>
3299
3300 <varlistentry>
3301 <term><varname>MaxPacketSize=</varname></term>
3302 <listitem>
3303 <para>Specifies the maximum packet size in bytes for the class. When suffixed with K, M, or G, the specified
3304 size is parsed as Kilobytes, Megabytes, or Gigabytes, respectively, to the base of 1000. When unset,
3305 the kernel default is used.</para>
3306 </listitem>
3307 </varlistentry>
3308 </variablelist>
3309 </refsect1>
3310
13b498f9
TJ
3311 <refsect1>
3312 <title>[BridgeVLAN] Section Options</title>
3313 <para>The <literal>[BridgeVLAN]</literal> section manages the VLAN ID configuration of a bridge port and accepts
3314 the following keys. Specify several <literal>[BridgeVLAN]</literal> sections to configure several VLAN entries.
3315 The <varname>VLANFiltering=</varname> option has to be enabled, see <literal>[Bridge]</literal> section in
3316 <citerefentry><refentrytitle>systemd.netdev</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para>
3317
3318 <variablelist class='network-directives'>
3319 <varlistentry>
3320 <term><varname>VLAN=</varname></term>
3321 <listitem>
3322 <para>The VLAN ID allowed on the port. This can be either a single ID or a range M-N. VLAN IDs are valid
3323 from 1 to 4094.</para>
3324 </listitem>
3325 </varlistentry>
3326 <varlistentry>
3327 <term><varname>EgressUntagged=</varname></term>
3328 <listitem>
3329 <para>The VLAN ID specified here will be used to untag frames on egress. Configuring
3330 <varname>EgressUntagged=</varname> implicates the use of <varname>VLAN=</varname> above and will enable the
3331 VLAN ID for ingress as well. This can be either a single ID or a range M-N.</para>
3332 </listitem>
3333 </varlistentry>
3334 <varlistentry>
3335 <term><varname>PVID=</varname></term>
3336 <listitem>
3337 <para>The Port VLAN ID specified here is assigned to all untagged frames at ingress.
3338 <varname>PVID=</varname> can be used only once. Configuring <varname>PVID=</varname> implicates the use of
3339 <varname>VLAN=</varname> above and will enable the VLAN ID for ingress as well.</para>
3340 </listitem>
3341 </varlistentry>
3342 </variablelist>
3343 </refsect1>
798d3a52
ZJS
3344
3345 <refsect1>
9e35b3de 3346 <title>Examples</title>
798d3a52 3347 <example>
9e35b3de 3348 <title>Static network configuration</title>
798d3a52 3349
9e35b3de
ZJS
3350 <programlisting># /etc/systemd/network/50-static.network
3351[Match]
eac684ef
TG
3352Name=enp2s0
3353
3354[Network]
3355Address=192.168.0.15/24
3356Gateway=192.168.0.1</programlisting>
9e35b3de
ZJS
3357
3358 <para>This brings interface <literal>enp2s0</literal> up with a static address. The
3359 specified gateway will be used for a default route.</para>
798d3a52 3360 </example>
eac684ef 3361
798d3a52 3362 <example>
9e35b3de 3363 <title>DHCP on ethernet links</title>
eac684ef 3364
9e35b3de
ZJS
3365 <programlisting># /etc/systemd/network/80-dhcp.network
3366[Match]
eac684ef
TG
3367Name=en*
3368
3369[Network]
9c8ca3f7 3370DHCP=yes</programlisting>
9e35b3de
ZJS
3371
3372 <para>This will enable DHCPv4 and DHCPv6 on all interfaces with names starting with
3373 <literal>en</literal> (i.e. ethernet interfaces).</para>
798d3a52 3374 </example>
eac684ef 3375
4c94a4c2 3376 <example>
3377 <title>IPv6 Prefix Delegation</title>
3378
3379 <programlisting># /etc/systemd/network/55-ipv6-pd-upstream.network
3380[Match]
3381Name=enp1s0
3382
3383[Network]
3384DHCP=ipv6</programlisting>
3385
3386 <programlisting># /etc/systemd/network/56-ipv6-pd-downstream.network
3387[Match]
3388Name=enp2s0
3389
3390[Network]
9efa8a3c
SS
3391IPv6PrefixDelegation=dhcpv6
3392
3393[DHCPv6]
3394AssignAcquiredDelegatedPrefixAddress=yes</programlisting>
4c94a4c2 3395
3396 <para>This will enable IPv6 PD on the interface enp1s0 as an upstream interface where the
3397 DHCPv6 client is running and enp2s0 as a downstream interface where the prefix is delegated to.</para>
3398 </example>
3399
798d3a52 3400 <example>
9e35b3de 3401 <title>A bridge with two enslaved links</title>
f47c5c47 3402
9e35b3de
ZJS
3403 <programlisting># /etc/systemd/network/25-bridge-static.network
3404[Match]
f47c5c47 3405Name=bridge0
3406
3407[Network]
3408Address=192.168.0.15/24
3409Gateway=192.168.0.1
3410DNS=192.168.0.1</programlisting>
f47c5c47 3411
9e35b3de
ZJS
3412 <programlisting># /etc/systemd/network/25-bridge-slave-interface-1.network
3413[Match]
f47c5c47 3414Name=enp2s0
3415
3416[Network]
3417Bridge=bridge0</programlisting>
9e35b3de
ZJS
3418
3419 <programlisting># /etc/systemd/network/25-bridge-slave-interface-2.network
3420[Match]
3421Name=wlp3s0
3422
3423[Network]
3424Bridge=bridge0</programlisting>
3425
3426 <para>This creates a bridge and attaches devices <literal>enp2s0</literal> and
3427 <literal>wlp3s0</literal> to it. The bridge will have the specified static address
3428 and network assigned, and a default route via the specified gateway will be
3429 added. The specified DNS server will be added to the global list of DNS resolvers.
3430 </para>
13b498f9 3431 </example>
9e35b3de 3432
13b498f9 3433 <example>
9e35b3de 3434 <title></title>
13b498f9 3435
9e35b3de
ZJS
3436 <programlisting>
3437# /etc/systemd/network/20-bridge-slave-interface-vlan.network
3438[Match]
13b498f9
TJ
3439Name=enp2s0
3440
3441[Network]
3442Bridge=bridge0
3443
3444[BridgeVLAN]
3445VLAN=1-32
3446PVID=42
3447EgressUntagged=42
3448
3449[BridgeVLAN]
3450VLAN=100-200
3451
3452[BridgeVLAN]
3453EgressUntagged=300-400</programlisting>
0a8a0fad 3454
9e35b3de
ZJS
3455 <para>This overrides the configuration specified in the previous example for the
3456 interface <literal>enp2s0</literal>, and enables VLAN on that bridge port. VLAN IDs
3457 1-32, 42, 100-400 will be allowed. Packets tagged with VLAN IDs 42, 300-400 will be
3458 untagged when they leave on this interface. Untagged packets which arrive on this
3459 interface will be assigned VLAN ID 42.</para>
798d3a52 3460 </example>
0a8a0fad 3461
798d3a52 3462 <example>
9e35b3de 3463 <title>Various tunnels</title>
0a8a0fad 3464
9e35b3de
ZJS
3465 <programlisting>/etc/systemd/network/25-tunnels.network
3466[Match]
3467Name=ens1
0a8a0fad
TG
3468
3469[Network]
9e35b3de
ZJS
3470Tunnel=ipip-tun
3471Tunnel=sit-tun
3472Tunnel=gre-tun
3473Tunnel=vti-tun
3474 </programlisting>
3475
3476 <programlisting>/etc/systemd/network/25-tunnel-ipip.netdev
3477[NetDev]
3478Name=ipip-tun
3479Kind=ipip
3480 </programlisting>
3481
3482 <programlisting>/etc/systemd/network/25-tunnel-sit.netdev
3483[NetDev]
3484Name=sit-tun
3485Kind=sit
3486 </programlisting>
3487
3488 <programlisting>/etc/systemd/network/25-tunnel-gre.netdev
3489[NetDev]
3490Name=gre-tun
3491Kind=gre
3492 </programlisting>
3493
3494 <programlisting>/etc/systemd/network/25-tunnel-vti.netdev
3495[NetDev]
3496Name=vti-tun
3497Kind=vti
3498 </programlisting>
3499
3500 <para>This will bring interface <literal>ens1</literal> up and create an IPIP tunnel,
3501 a SIT tunnel, a GRE tunnel, and a VTI tunnel using it.</para>
798d3a52 3502 </example>
0a8a0fad 3503
798d3a52 3504 <example>
9e35b3de 3505 <title>A bond device</title>
0a8a0fad 3506
9e35b3de
ZJS
3507 <programlisting># /etc/systemd/network/30-bond1.network
3508[Match]
3509Name=bond1
0a8a0fad
TG
3510
3511[Network]
9e35b3de
ZJS
3512DHCP=ipv6
3513</programlisting>
0a8a0fad 3514
9e35b3de
ZJS
3515 <programlisting># /etc/systemd/network/30-bond1.netdev
3516[NetDev]
3517Name=bond1
3518Kind=bond
3519</programlisting>
0a8a0fad 3520
301a21a8 3521 <programlisting># /etc/systemd/network/30-bond1-dev1.network
9e35b3de
ZJS
3522[Match]
3523MACAddress=52:54:00:e9:64:41
0a8a0fad
TG
3524
3525[Network]
9e35b3de
ZJS
3526Bond=bond1
3527</programlisting>
d94facdc 3528
301a21a8 3529 <programlisting># /etc/systemd/network/30-bond1-dev2.network
9e35b3de
ZJS
3530[Match]
3531MACAddress=52:54:00:e9:64:42
d94facdc
MH
3532
3533[Network]
9e35b3de 3534Bond=bond1
6cb955c6 3535</programlisting>
9e35b3de
ZJS
3536
3537 <para>This will create a bond device <literal>bond1</literal> and enslave the two
3538 devices with MAC addresses 52:54:00:e9:64:41 and 52:54:00:e9:64:42 to it. IPv6 DHCP
3539 will be used to acquire an address.</para>
6cb955c6
AR
3540 </example>
3541
3542 <example>
9e35b3de
ZJS
3543 <title>Virtual Routing and Forwarding (VRF)</title>
3544 <para>Add the <literal>bond1</literal> interface to the VRF master interface
3545 <literal>vrf1</literal>. This will redirect routes generated on this interface to be
11d38b90
AR
3546 within the routing table defined during VRF creation. For kernels before 4.8 traffic
3547 won't be redirected towards the VRFs routing table unless specific ip-rules are added.
3548 </para>
9e35b3de
ZJS
3549 <programlisting># /etc/systemd/network/25-vrf.network
3550[Match]
6cb955c6
AR
3551Name=bond1
3552
3553[Network]
9e35b3de 3554VRF=vrf1
d94facdc
MH
3555</programlisting>
3556 </example>
3557
42125eda
SS
3558 <example>
3559 <title>MacVTap</title>
3560 <para>This brings up a network interface <literal>macvtap-test</literal>
3561 and attaches it to <literal>enp0s25</literal>.</para>
83ddf5d3 3562 <programlisting># /usr/lib/systemd/network/25-macvtap.network
42125eda
SS
3563[Match]
3564Name=enp0s25
3565
3566[Network]
3567MACVTAP=macvtap-test
3568</programlisting>
3569 </example>
98d20a17 3570
3571 <example>
3572 <title>A Xfrm interface with physical underlying device.</title>
3573
3574 <programlisting># /etc/systemd/network/27-xfrm.netdev
3575[NetDev]
3576Name=xfrm0
3577
3578[Xfrm]
3579InterfaceId=7</programlisting>
3580
3581 <programlisting># /etc/systemd/network/27-eth0.network
3582[Match]
3583Name=eth0
3584
3585[Network]
3586Xfrm=xfrm0</programlisting>
3587
3588 <para>This creates a <literal>xfrm0</literal> interface and binds it to the <literal>eth0</literal> device.
3589 This allows hardware based ipsec offloading to the <literal>eth0</literal> nic.
3590 If offloading is not needed, xfrm interfaces can be assigned to the <literal>lo</literal> device.
3591 </para>
3592 </example>
798d3a52
ZJS
3593 </refsect1>
3594
3595 <refsect1>
3596 <title>See Also</title>
3597 <para>
3598 <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
f41b446a 3599 <citerefentry><refentrytitle>systemd-networkd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
798d3a52 3600 <citerefentry><refentrytitle>systemd.link</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
aaa297d4
LP
3601 <citerefentry><refentrytitle>systemd.netdev</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
3602 <citerefentry><refentrytitle>systemd-resolved.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>
798d3a52
ZJS
3603 </para>
3604 </refsect1>
eac684ef
TG
3605
3606</refentry>