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