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