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