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