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