]> git.ipfire.org Git - thirdparty/systemd.git/blob - man/systemd.network.xml
Merge pull request #32347 from yuwata/sd-radv-reachable-time
[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.5/docbookx.dtd">
4 <!-- SPDX-License-Identifier: LGPL-2.1-or-later -->
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
32 interfaces, 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
45 processed in alphanumeric order, regardless of the directories in which they live. However, files
46 with identical filenames replace each other. It is recommended that each filename is prefixed with
47 a number smaller than <literal>70</literal> (e.g. <filename>10-eth0.network</filename>). Otherwise, the
48 default <filename>.network</filename> files or those generated by
49 <citerefentry><refentrytitle>systemd-network-generator.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>
50 may take precedence over user configured files. Files in <filename>/etc/</filename> have the highest
51 priority, files in <filename>/run/</filename> take precedence over files with the same name under
52 <filename>/usr/</filename>. This can be used to override a system-supplied configuration file with
53 a local file if needed. As a special case, an empty file (file size 0) or symlink with the same
54 name pointing to <filename>/dev/null</filename> disables the configuration file entirely (it is
55 "masked").</para>
56
57 <para>Along with the network file <filename>foo.network</filename>, a "drop-in" directory
58 <filename>foo.network.d/</filename> may exist. All files with the suffix
59 <literal>.conf</literal> from this directory will be merged in the alphanumeric order and parsed
60 after the main file itself has been parsed. This is useful to alter or add configuration settings,
61 without having to modify the main configuration file. Each drop-in file must have appropriate
62 section headers.</para>
63
64 <para>In addition to <filename>/etc/systemd/network</filename>, drop-in <literal>.d</literal>
65 directories can be placed in <filename>/usr/lib/systemd/network</filename> or
66 <filename>/run/systemd/network</filename> directories. Drop-in files in
67 <filename>/etc/</filename> take precedence over those in <filename>/run/</filename> which in turn
68 take precedence over those in <filename>/usr/lib/</filename>. Drop-in files under any of these
69 directories take precedence over the main network file wherever located.</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
76 be applied to a given interface; and a [Network] section specifying how the interface should be
77 configured. The first (in alphanumeric order) of the network files that matches a given interface
78 is applied, all later files are ignored, even if they match as well.</para>
79
80 <para>Note that any network interfaces that have the <varname>ID_NET_MANAGED_BY=</varname> udev property
81 set will never be matched by any .network files – unless the property's value is the string
82 <literal>io.systemd.Network</literal> – even if the [Match] section would otherwise match. This may be
83 used to exclude specific network interfaces from <command>systemd-networkd</command>'s management, while
84 keeping the [Match] section generic. The <varname>ID_NET_MANAGED_BY=</varname> property thus declares
85 intended <emphasis>ownership</emphasis> of the device, and permits ensuring that concurrent network
86 management implementations do not compete for management of specific devices.</para>
87
88 <para>A network file is said to match a network interface if all matches specified by the [Match]
89 section are satisfied. When a network file does not contain valid settings in [Match] section, then
90 the file will match all interfaces and <command>systemd-networkd</command> warns about that. Hint:
91 to avoid the warning and to make it clear that all interfaces shall be matched, add the following:
92 <programlisting>Name=*</programlisting> The following keys are accepted:</para>
93
94 <variablelist class='network-directives'>
95 <xi:include href="systemd.link.xml" xpointer="mac-address" />
96 <xi:include href="systemd.link.xml" xpointer="permanent-mac-address" />
97 <xi:include href="systemd.link.xml" xpointer="path" />
98 <xi:include href="systemd.link.xml" xpointer="driver" />
99 <xi:include href="systemd.link.xml" xpointer="type" />
100 <xi:include href="systemd.link.xml" xpointer="kind" />
101 <xi:include href="systemd.link.xml" xpointer="property" />
102
103 <varlistentry>
104 <term><varname>Name=</varname></term>
105 <listitem>
106 <para>A whitespace-separated list of shell-style globs matching the device name, as exposed
107 by the udev property <literal>INTERFACE</literal>, or device's alternative names. If the
108 list is prefixed with a "!", the test is inverted.</para>
109
110 <xi:include href="version-info.xml" xpointer="v211"/>
111 </listitem>
112 </varlistentry>
113
114 <varlistentry>
115 <term><varname>WLANInterfaceType=</varname></term>
116 <listitem>
117 <para>A whitespace-separated list of wireless network type. Supported values are
118 <literal>ad-hoc</literal>, <literal>station</literal>, <literal>ap</literal>,
119 <literal>ap-vlan</literal>, <literal>wds</literal>, <literal>monitor</literal>,
120 <literal>mesh-point</literal>, <literal>p2p-client</literal>, <literal>p2p-go</literal>,
121 <literal>p2p-device</literal>, <literal>ocb</literal>, and <literal>nan</literal>. If the
122 list is prefixed with a "!", the test is inverted. </para>
123
124 <xi:include href="version-info.xml" xpointer="v244"/>
125 </listitem>
126 </varlistentry>
127
128 <varlistentry>
129 <term><varname>SSID=</varname></term>
130 <listitem>
131 <para>A whitespace-separated list of shell-style globs matching the SSID of the currently
132 connected wireless LAN. If the list is prefixed with a "!", the test is inverted.</para>
133
134 <xi:include href="version-info.xml" xpointer="v244"/>
135 </listitem>
136 </varlistentry>
137
138 <varlistentry>
139 <term><varname>BSSID=</varname></term>
140 <listitem>
141 <para>A whitespace-separated list of hardware address of the currently connected wireless
142 LAN. Use full colon-, hyphen- or dot-delimited hexadecimal. See the example in
143 <varname>MACAddress=</varname>. This option may appear more than once, in which case the
144 lists are merged. If the empty string is assigned to this option, the list is reset.</para>
145
146 <xi:include href="version-info.xml" xpointer="v244"/>
147 </listitem>
148 </varlistentry>
149
150 <xi:include href="systemd.link.xml" xpointer="host" />
151 <xi:include href="systemd.link.xml" xpointer="virtualization" />
152 <xi:include href="systemd.link.xml" xpointer="kernel-command-line" />
153 <xi:include href="systemd.link.xml" xpointer="kernel-version" />
154 <xi:include href="systemd.link.xml" xpointer="credential" />
155 <xi:include href="systemd.link.xml" xpointer="architecture" />
156 <xi:include href="systemd.link.xml" xpointer="firmware" />
157 </variablelist>
158 </refsect1>
159
160 <refsect1>
161 <title>[Link] Section Options</title>
162
163 <para>The [Link] section accepts the following keys:</para>
164
165 <variablelist class='network-directives'>
166 <varlistentry>
167 <term><varname>MACAddress=</varname></term>
168 <listitem>
169 <para>The hardware address to set for the device.</para>
170
171 <xi:include href="version-info.xml" xpointer="v218"/>
172 </listitem>
173 </varlistentry>
174
175 <varlistentry>
176 <term><varname>MTUBytes=</varname></term>
177 <listitem>
178 <para>The maximum transmission unit in bytes to set for the device. The usual suffixes K, M,
179 G, are supported and are understood to the base of 1024.</para>
180 <para>Note that if IPv6 is enabled on the interface, and the MTU is chosen below 1280 (the
181 minimum MTU for IPv6) it will automatically be increased to this value.</para>
182
183 <xi:include href="version-info.xml" xpointer="v218"/>
184 </listitem>
185 </varlistentry>
186
187 <varlistentry>
188 <term><varname>ARP=</varname></term>
189 <listitem>
190 <para>Takes a boolean. If set to true, the ARP (low-level Address Resolution Protocol)
191 for this interface is enabled. When unset, the kernel's default will be used.</para>
192 <para> For example, disabling ARP is useful when creating multiple MACVLAN or VLAN virtual
193 interfaces atop a single lower-level physical interface, which will then only serve as a
194 link/"bridge" device aggregating traffic to the same physical link and not participate in
195 the network otherwise. Defaults to unset.</para>
196
197 <xi:include href="version-info.xml" xpointer="v232"/>
198 </listitem>
199 </varlistentry>
200
201 <varlistentry>
202 <term><varname>Multicast=</varname></term>
203 <listitem>
204 <para>Takes a boolean. If set to true, the multicast flag on the device is enabled. Defaults
205 to unset.</para>
206
207 <xi:include href="version-info.xml" xpointer="v239"/>
208 </listitem>
209 </varlistentry>
210
211 <varlistentry>
212 <term><varname>AllMulticast=</varname></term>
213 <listitem>
214 <para>Takes a boolean. If set to true, the driver retrieves all multicast packets from the
215 network. This happens when multicast routing is enabled. Defaults to unset.</para>
216
217 <xi:include href="version-info.xml" xpointer="v239"/>
218 </listitem>
219 </varlistentry>
220
221 <varlistentry>
222 <term><varname>Promiscuous=</varname></term>
223 <listitem>
224 <para>Takes a boolean. If set to true, promiscuous mode of the interface is enabled. Defaults
225 to unset.</para>
226 <para>If this is set to false for the underlying link of a <literal>passthru</literal> mode
227 MACVLAN/MACVTAP, the virtual interface will be created with the <literal>nopromisc</literal>
228 flag set.</para>
229
230 <xi:include href="version-info.xml" xpointer="v248"/>
231 </listitem>
232 </varlistentry>
233
234 <varlistentry>
235 <term><varname>Unmanaged=</varname></term>
236 <listitem>
237 <para>Takes a boolean. When <literal>yes</literal>, no attempts are made to bring up or
238 configure matching links, equivalent to when there are no matching network files. Defaults to
239 <literal>no</literal>.</para>
240 <para>This is useful for preventing later matching network files from interfering with
241 certain interfaces that are fully controlled by other applications.</para>
242
243 <xi:include href="version-info.xml" xpointer="v233"/>
244 </listitem>
245 </varlistentry>
246
247 <varlistentry>
248 <term><varname>Group=</varname></term>
249 <listitem>
250 <para>Link groups are similar to port ranges found in managed switches. When network
251 interfaces are added to a numbered group, operations on all the interfaces from that group
252 can be performed at once. Takes an unsigned integer in the range 02147483647. Defaults to
253 unset.</para>
254
255 <xi:include href="version-info.xml" xpointer="v246"/>
256 </listitem>
257 </varlistentry>
258
259 <varlistentry>
260 <term><varname>RequiredForOnline=</varname></term>
261 <listitem>
262 <para>Takes a boolean, a minimum operational state (e.g., <literal>carrier</literal>), or a range
263 of operational state separated with a colon (e.g., <literal>degraded:routable</literal>).
264 Please see
265 <citerefentry><refentrytitle>networkctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>
266 for possible operational states. When <literal>yes</literal>, the network is deemed required
267 when determining whether the system is online (including when running
268 <command>systemd-networkd-wait-online</command>). When <literal>no</literal>, the network is
269 ignored when determining the online state. When a minimum operational state and an optional
270 maximum operational state are set, <command>systemd-networkd-wait-online</command> deems that the
271 interface is online when the operational state is in the specified range.</para>
272
273 <para>Defaults to <literal>yes</literal> when <varname>ActivationPolicy=</varname> is not
274 set, or set to <literal>up</literal>, <literal>always-up</literal>, or
275 <literal>bound</literal>. Defaults to <literal>no</literal> when
276 <varname>ActivationPolicy=</varname> is set to <literal>manual</literal> or
277 <literal>down</literal>. This is forced to <literal>no</literal> when
278 <varname>ActivationPolicy=</varname> is set to <literal>always-down</literal>.</para>
279
280 <para>The network will be brought up normally (as configured by
281 <varname>ActivationPolicy=</varname>), but in the event that there is no address being
282 assigned by DHCP or the cable is not plugged in, the link will simply remain offline and be
283 skipped automatically by <command>systemd-networkd-wait-online</command> if
284 <literal>RequiredForOnline=no</literal>.</para>
285
286 <para>The boolean value <literal>yes</literal> is translated as follows;
287 <variablelist>
288 <varlistentry>
289 <term><option>CAN devices</option></term>
290 <listitem>
291 <para><literal>carrier</literal>,</para>
292 <xi:include href="version-info.xml" xpointer="v256"/>
293 </listitem>
294 </varlistentry>
295 <varlistentry>
296 <term><option>Master devices, e.g. bond or bridge</option></term>
297 <listitem>
298 <para><literal>degraded-carrier</literal> with <varname>RequiredFamilyForOnline=any</varname>,</para>
299 <xi:include href="version-info.xml" xpointer="v256"/>
300 </listitem>
301 </varlistentry>
302 <varlistentry>
303 <term><option>Bonding port interfaces</option></term>
304 <listitem>
305 <para><literal>enslaved</literal>,</para>
306 <xi:include href="version-info.xml" xpointer="v256"/>
307 </listitem>
308 </varlistentry>
309 <varlistentry>
310 <term><option>Other interfaces</option></term>
311 <listitem>
312 <para><literal>degraded</literal>.</para>
313 <xi:include href="version-info.xml" xpointer="v236"/>
314 </listitem>
315 </varlistentry>
316 </variablelist>
317 </para>
318
319 <para>This setting can be overridden by the command line option for
320 <command>systemd-networkd-wait-online</command>. See
321 <citerefentry><refentrytitle>systemd-networkd-wait-online.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>
322 for more details.</para>
323
324 <xi:include href="version-info.xml" xpointer="v236"/>
325 </listitem>
326 </varlistentry>
327
328 <varlistentry>
329 <term><varname>RequiredFamilyForOnline=</varname></term>
330 <listitem>
331 <para>Takes an address family. When specified, an IP address in the given family is deemed
332 required when determining whether the link is online (including when running
333 <command>systemd-networkd-wait-online</command>). Takes one of <literal>ipv4</literal>,
334 <literal>ipv6</literal>, <literal>both</literal>, or <literal>any</literal>. Defaults to
335 <literal>no</literal>. Note that this option has no effect if
336 <literal>RequiredForOnline=no</literal>.</para>
337
338 <xi:include href="version-info.xml" xpointer="v249"/>
339 </listitem>
340 </varlistentry>
341
342 <varlistentry>
343 <term><varname>ActivationPolicy=</varname></term>
344 <listitem>
345 <para>Specifies the policy for <command>systemd-networkd</command> managing the link
346 administrative state. Specifically, this controls how <command>systemd-networkd</command>
347 changes the network device's <literal>IFF_UP</literal> flag, which is sometimes
348 controlled by system administrators by running e.g.,
349 <command>ip link set dev eth0 up</command> or <command>ip link set dev eth0 down</command>,
350 and can also be changed with <command>networkctl up eth0</command> or
351 <command>networkctl down eth0</command>.</para>
352
353 <para>Takes one of <literal>up</literal>, <literal>always-up</literal>,
354 <literal>manual</literal>, <literal>always-down</literal>, <literal>down</literal>,
355 or <literal>bound</literal>. When <literal>manual</literal>,
356 <command>systemd-networkd</command> will not change the link's admin state automatically;
357 the system administrator must bring the interface up or down manually, as desired. When
358 <literal>up</literal> (the default) or <literal>always-up</literal>, or
359 <literal>down</literal> or <literal>always-down</literal>,
360 <command>systemd-networkd</command> will set the link up or down, respectively, when the
361 interface is (re)configured. When <literal>always-up</literal> or
362 <literal>always-down</literal>, <command>systemd-networkd</command> will set the link up or
363 down, respectively, any time <command>systemd-networkd</command> detects a change in the
364 administrative state. When <varname>BindCarrier=</varname> is also set, this is automatically
365 set to <literal>bound</literal> and any other value is ignored.</para>
366
367 <para>When the policy is set to <literal>down</literal> or <literal>manual</literal>, the
368 default value of <varname>RequiredForOnline=</varname> is <literal>no</literal>. When the
369 policy is set to <literal>always-down</literal>, the value of
370 <varname>RequiredForOnline=</varname> forced to <literal>no</literal>.</para>
371
372 <para>The administrative state is not the same as the carrier state, so using
373 <literal>always-up</literal> does not mean the link will never lose carrier. The link carrier
374 depends on both the administrative state as well as the network device's physical connection.
375 However, to avoid reconfiguration failures, when using <literal>always-up</literal>,
376 <varname>IgnoreCarrierLoss=</varname> is forced to true.</para>
377
378 <xi:include href="version-info.xml" xpointer="v248"/>
379 </listitem>
380 </varlistentry>
381 </variablelist>
382 </refsect1>
383
384 <xi:include href="systemd.link.xml" xpointer="sr-iov" />
385
386 <refsect1>
387 <title>[Network] Section Options</title>
388
389 <para>The [Network] section accepts the following keys:</para>
390
391 <variablelist class='network-directives'>
392 <varlistentry>
393 <term><varname>Description=</varname></term>
394 <listitem>
395 <para>A description of the device. This is only used for presentation purposes.</para>
396
397 <xi:include href="version-info.xml" xpointer="v211"/>
398 </listitem>
399 </varlistentry>
400
401 <varlistentry>
402 <term><varname>DHCP=</varname></term>
403 <listitem>
404 <para>Enables DHCPv4 and/or DHCPv6 client support. Accepts <literal>yes</literal>,
405 <literal>no</literal>, <literal>ipv4</literal>, or <literal>ipv6</literal>. Defaults to
406 <literal>no</literal>.</para>
407
408 <para>Note that DHCPv6 will by default be triggered by Router Advertisements, if reception is
409 enabled, regardless of this parameter. By explicitly enabling DHCPv6 support here, the DHCPv6
410 client will be started in the mode specified by the <varname>WithoutRA=</varname> setting in the
411 [DHCPv6] section, regardless of the presence of routers on the link, or what flags the routers
412 pass. See <varname>IPv6AcceptRA=</varname>.</para>
413
414 <para>Furthermore, note that by default the domain name specified through DHCP is not used
415 for name resolution. See option <option>UseDomains=</option> below.</para>
416
417 <para>See the [DHCPv4] or [DHCPv6] sections below for further configuration options for the
418 DHCP client support.</para>
419
420 <xi:include href="version-info.xml" xpointer="v211"/>
421 </listitem>
422 </varlistentry>
423
424 <varlistentry>
425 <term><varname>DHCPServer=</varname></term>
426 <listitem>
427 <para>Takes a boolean. If set to <literal>yes</literal>, DHCPv4 server will be started.
428 Defaults to <literal>no</literal>. Further settings for the DHCP server may be set in the
429 [DHCPServer] section described below.</para>
430
431 <para>Even if this is enabled, the DHCP server will not be started automatically and wait for the
432 persistent storage being ready to load/save leases in the storage, unless
433 <varname>RelayTarget=</varname> or <varname>PersistLeases=no</varname> are specified in the
434 [DHCPServer] section. It will be started after
435 <filename>systemd-networkd-persistent-storage.service</filename> is started, which calls
436 <command>networkctl persistent-storage yes</command>. See
437 <citerefentry><refentrytitle>networkctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>
438 for more details.</para>
439
440 <xi:include href="version-info.xml" xpointer="v215"/>
441 </listitem>
442 </varlistentry>
443
444 <varlistentry>
445 <term><varname>LinkLocalAddressing=</varname></term>
446 <listitem>
447 <para>Enables link-local address autoconfiguration. Accepts <option>yes</option>,
448 <option>no</option>, <option>ipv4</option>, and <option>ipv6</option>. An IPv6 link-local
449 address is configured when <option>yes</option> or <option>ipv6</option>. An IPv4 link-local
450 address is configured when <option>yes</option> or <option>ipv4</option> and when DHCPv4
451 autoconfiguration has been unsuccessful for some time. (IPv4 link-local address
452 autoconfiguration will usually happen in parallel with repeated attempts to acquire a DHCPv4
453 lease).</para>
454
455 <para>Defaults to <option>no</option> when <varname>KeepMaster=</varname> or
456 <varname>Bridge=</varname> is set or when the specified
457 <varname>MACVLAN=</varname>/<varname>MACVTAP=</varname> has <varname>Mode=passthru</varname>,
458 or <option>ipv6</option> otherwise.</para>
459
460 <xi:include href="version-info.xml" xpointer="v219"/>
461 </listitem>
462 </varlistentry>
463
464 <varlistentry>
465 <term><varname>IPv6LinkLocalAddressGenerationMode=</varname></term>
466 <listitem>
467 <para>Specifies how IPv6 link-local address is generated. Takes one of
468 <literal>eui64</literal>, <literal>none</literal>, <literal>stable-privacy</literal> and
469 <literal>random</literal>. When unset, <literal>stable-privacy</literal> is used if
470 <varname>IPv6StableSecretAddress=</varname> is specified, and if not,
471 <literal>eui64</literal> is used. Note that if <varname>LinkLocalAddressing=</varname> is
472 <literal>no</literal> or <literal>ipv4</literal>, then
473 <varname>IPv6LinkLocalAddressGenerationMode=</varname> will be ignored. Also, even if
474 <varname>LinkLocalAddressing=</varname> is <literal>yes</literal> or <literal>ipv6</literal>,
475 setting <varname>IPv6LinkLocalAddressGenerationMode=none</varname>
476 disables to configure an IPv6 link-local address.</para>
477
478 <xi:include href="version-info.xml" xpointer="v246"/>
479 </listitem>
480 </varlistentry>
481
482 <varlistentry>
483 <term><varname>IPv6StableSecretAddress=</varname></term>
484 <listitem>
485 <para>Takes an IPv6 address. The specified address will be used as a stable secret for
486 generating IPv6 link-local address. If this setting is specified, and
487 <varname>IPv6LinkLocalAddressGenerationMode=</varname> is unset, then
488 <varname>IPv6LinkLocalAddressGenerationMode=stable-privacy</varname> is implied.
489 If this setting is not specified, and <literal>stable-privacy</literal> is set to
490 <varname>IPv6LinkLocalAddressGenerationMode=</varname>,
491 then a stable secret address will be generated from the local machine ID and the interface
492 name.</para>
493
494 <xi:include href="version-info.xml" xpointer="v249"/>
495 </listitem>
496 </varlistentry>
497
498 <varlistentry>
499 <term><varname>IPv4LLStartAddress=</varname></term>
500 <listitem>
501 <para>Specifies the first IPv4 link-local address to try. Takes an IPv4 address for example
502 169.254.1.2, from the link-local address range: 169.254.0.0/16 except for 169.254.0.0/24 and
503 169.254.255.0/24. This setting may be useful if the device should always have the same address
504 as long as there is no address conflict. When unset, a random address will be automatically
505 selected. Defaults to unset.</para>
506
507 <xi:include href="version-info.xml" xpointer="v252"/>
508 </listitem>
509 </varlistentry>
510
511 <varlistentry>
512 <term><varname>IPv4LLRoute=</varname></term>
513 <listitem>
514 <para>Takes a boolean. If set to true, sets up the route needed for non-IPv4LL hosts to
515 communicate with IPv4LL-only hosts. Defaults to false.</para>
516
517 <xi:include href="version-info.xml" xpointer="v216"/>
518 </listitem>
519 </varlistentry>
520
521 <varlistentry>
522 <term><varname>DefaultRouteOnDevice=</varname></term>
523 <listitem>
524 <para>Takes a boolean. If set to true, sets up the IPv4 default route bound to the interface.
525 Defaults to false. This is useful when creating routes on point-to-point interfaces. This is
526 equivalent to e.g. the following,
527 <programlisting>ip route add default dev veth99</programlisting>
528 or,
529 <programlisting>[Route]
530 Gateway=0.0.0.0</programlisting></para>
531 <para>Currently, there are no way to specify e.g., the table for the route configured by this
532 setting. To configure the default route with such an additional property, please use the
533 following instead:
534 <programlisting>[Route]
535 Gateway=0.0.0.0
536 Table=1234</programlisting></para>
537 <para>If you'd like to create an IPv6 default route bound to the interface, please use the
538 following:
539 <programlisting>[Route]
540 Gateway=::
541 Table=1234</programlisting></para>
542
543 <xi:include href="version-info.xml" xpointer="v243"/>
544 </listitem>
545 </varlistentry>
546
547 <varlistentry>
548 <term><varname>LLMNR=</varname></term>
549 <listitem>
550 <para>Takes a boolean or <literal>resolve</literal>. When true, enables
551 <ulink url="https://tools.ietf.org/html/rfc4795">Link-Local Multicast Name Resolution</ulink>
552 on the link. When set to <literal>resolve</literal>, only resolution is enabled, but not host
553 registration and announcement. Defaults to true. This setting is read by
554 <citerefentry><refentrytitle>systemd-resolved.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
555 </para>
556
557 <xi:include href="version-info.xml" xpointer="v216"/>
558 </listitem>
559 </varlistentry>
560
561 <varlistentry>
562 <term><varname>MulticastDNS=</varname></term>
563 <listitem>
564 <para>Takes a boolean or <literal>resolve</literal>. When true, enables
565 <ulink url="https://tools.ietf.org/html/rfc6762">Multicast DNS</ulink> support on the link.
566 When set to <literal>resolve</literal>, only resolution is enabled, but not host or service
567 registration and announcement. Defaults to false. This setting is read by
568 <citerefentry><refentrytitle>systemd-resolved.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
569 </para>
570
571 <xi:include href="version-info.xml" xpointer="v229"/>
572 </listitem>
573 </varlistentry>
574
575 <varlistentry>
576 <term><varname>DNSOverTLS=</varname></term>
577 <listitem>
578 <para>Takes a boolean or <literal>opportunistic</literal>. When true, enables
579 <ulink url="https://tools.ietf.org/html/rfc7858">DNS-over-TLS</ulink> support on the link.
580 When set to <literal>opportunistic</literal>, compatibility with non-DNS-over-TLS servers is
581 increased, by automatically turning off DNS-over-TLS servers in this case. This option
582 defines a per-interface setting for
583 <citerefentry><refentrytitle>resolved.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>'s
584 global <varname>DNSOverTLS=</varname> option. Defaults to unset, and the global setting will
585 be used. This setting is read by
586 <citerefentry><refentrytitle>systemd-resolved.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
587 </para>
588
589 <xi:include href="version-info.xml" xpointer="v239"/>
590 </listitem>
591 </varlistentry>
592
593 <varlistentry>
594 <term><varname>DNSSEC=</varname></term>
595 <listitem>
596 <para>Takes a boolean or <literal>allow-downgrade</literal>. When true, enables
597 <ulink url="https://tools.ietf.org/html/rfc4033">DNSSEC</ulink> DNS validation support on the
598 link. When set to <literal>allow-downgrade</literal>, compatibility with non-DNSSEC capable
599 networks is increased, by automatically turning off DNSSEC in this case. This option defines
600 a per-interface setting for
601 <citerefentry><refentrytitle>resolved.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>'s
602 global <varname>DNSSEC=</varname> option. Defaults to unset, and the global setting will be
603 used. This setting is read by
604 <citerefentry><refentrytitle>systemd-resolved.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
605 </para>
606
607 <xi:include href="version-info.xml" xpointer="v229"/>
608 </listitem>
609 </varlistentry>
610
611 <varlistentry>
612 <term><varname>DNSSECNegativeTrustAnchors=</varname></term>
613 <listitem>
614 <para>A space-separated list of DNSSEC negative trust anchor domains. If specified and DNSSEC
615 is enabled, look-ups done via the interface's DNS server will be subject to the list of
616 negative trust anchors, and not require authentication for the specified domains, or anything
617 below it. Use this to disable DNSSEC authentication for specific private domains, that cannot
618 be proven valid using the Internet DNS hierarchy. Defaults to the empty list. This setting is
619 read by
620 <citerefentry><refentrytitle>systemd-resolved.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
621 </para>
622
623 <xi:include href="version-info.xml" xpointer="v229"/>
624 </listitem>
625 </varlistentry>
626
627 <varlistentry>
628 <term><varname>LLDP=</varname></term>
629 <listitem>
630 <para>Controls support for Ethernet LLDP packet reception. LLDP is a link-layer protocol
631 commonly implemented on professional routers and bridges which announces which physical port
632 a system is connected to, as well as other related data. Accepts a boolean or the special
633 value <literal>routers-only</literal>. When true, incoming LLDP packets are accepted and a
634 database of all LLDP neighbors maintained. If <literal>routers-only</literal> is set only
635 LLDP data of various types of routers is collected and LLDP data about other types of devices
636 ignored (such as stations, telephones and others). If false, LLDP reception is disabled.
637 Defaults to <literal>routers-only</literal>. Use
638 <citerefentry><refentrytitle>networkctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>
639 to query the collected neighbor data. LLDP is only available on Ethernet links. See
640 <varname>EmitLLDP=</varname> below for enabling LLDP packet emission from the local system.
641 </para>
642
643 <xi:include href="version-info.xml" xpointer="v219"/>
644 </listitem>
645 </varlistentry>
646
647 <varlistentry>
648 <term><varname>EmitLLDP=</varname></term>
649 <listitem>
650 <para>Controls support for Ethernet LLDP packet emission. Accepts a boolean parameter or the
651 special values <literal>nearest-bridge</literal>, <literal>non-tpmr-bridge</literal> and
652 <literal>customer-bridge</literal>. Defaults to false, which turns off LLDP packet emission.
653 If not false, a short LLDP packet with information about the local system is sent out in
654 regular intervals on the link. The LLDP packet will contain information about the local
655 hostname, the local machine ID (as stored in
656 <citerefentry><refentrytitle>machine-id</refentrytitle><manvolnum>5</manvolnum></citerefentry>)
657 and the local interface name, as well as the pretty hostname of the system (as set in
658 <citerefentry><refentrytitle>machine-info</refentrytitle><manvolnum>5</manvolnum></citerefentry>).
659 LLDP emission is only available on Ethernet links. Note that this setting passes data
660 suitable for identification of host to the network and should thus not be enabled on
661 untrusted networks, where such identification data should not be made available. Use this
662 option to permit other systems to identify on which interfaces they are connected to this
663 system. The three special values control propagation of the LLDP packets. The
664 <literal>nearest-bridge</literal> setting permits propagation only to the nearest connected
665 bridge, <literal>non-tpmr-bridge</literal> permits propagation across Two-Port MAC Relays,
666 but not any other bridges, and <literal>customer-bridge</literal> permits propagation until
667 a customer bridge is reached. For details about these concepts, see
668 <ulink url="https://standards.ieee.org/findstds/standard/802.1AB-2016.html">IEEE 802.1AB-2016</ulink>.
669 Note that configuring this setting to true is equivalent to
670 <literal>nearest-bridge</literal>, the recommended and most restricted level of propagation.
671 See <varname>LLDP=</varname> above for an option to enable LLDP reception.</para>
672
673 <xi:include href="version-info.xml" xpointer="v230"/>
674 </listitem>
675 </varlistentry>
676
677 <varlistentry>
678 <term><varname>BindCarrier=</varname></term>
679 <listitem>
680 <para>A link name or a list of link names. When set, controls the behavior of the current
681 link. When all links in the list are in an operational down state, the current link is
682 brought down. When at least one link has carrier, the current interface is brought up.</para>
683
684 <para>This forces <varname>ActivationPolicy=</varname> to be set to <literal>bound</literal>.
685 </para>
686
687 <xi:include href="version-info.xml" xpointer="v220"/>
688 </listitem>
689 </varlistentry>
690
691 <varlistentry>
692 <term><varname>Address=</varname></term>
693 <listitem>
694 <para>A static IPv4 or IPv6 address and its prefix length, separated by a
695 <literal>/</literal> character. Specify this key more than once to configure several
696 addresses. The format of the address must be as described in
697 <citerefentry project='man-pages'><refentrytitle>inet_pton</refentrytitle><manvolnum>3</manvolnum></citerefentry>.
698 This is a short-hand for an [Address] section only containing an Address key (see below).
699 This option may be specified more than once.</para>
700
701 <para>If the specified address is <literal>0.0.0.0</literal> (for IPv4) or
702 <literal>::</literal> (for IPv6), a new address range of the requested size is automatically
703 allocated from a system-wide pool of unused ranges. Note that the prefix length must be equal
704 or larger than 8 for IPv4, and 64 for IPv6. The allocated range is checked against all
705 current network interfaces and all known network configuration files to avoid address range
706 conflicts. The default system-wide pool consists of 192.168.0.0/16, 172.16.0.0/12 and
707 10.0.0.0/8 for IPv4, and fd00::/8 for IPv6. This functionality is useful to manage a large
708 number of dynamically created network interfaces with the same network configuration and
709 automatic address range assignment.</para>
710
711 <para>If an empty string is specified, then the all previous assignments in both [Network] and
712 [Address] sections are cleared.</para>
713
714 <xi:include href="version-info.xml" xpointer="v211"/>
715 </listitem>
716 </varlistentry>
717
718 <varlistentry>
719 <term><varname>Gateway=</varname></term>
720 <listitem>
721 <para>The gateway address, which must be in the format described in
722 <citerefentry project='man-pages'><refentrytitle>inet_pton</refentrytitle><manvolnum>3</manvolnum></citerefentry>.
723 This is a short-hand for a [Route] section only containing a <varname>Gateway=</varname> key.
724 This option may be specified more than once.</para>
725
726 <xi:include href="version-info.xml" xpointer="v211"/>
727 </listitem>
728 </varlistentry>
729
730 <varlistentry>
731 <term><varname>DNS=</varname></term>
732 <listitem>
733 <para>A DNS server address, which must be in the format described in
734 <citerefentry project='man-pages'><refentrytitle>inet_pton</refentrytitle><manvolnum>3</manvolnum></citerefentry>.
735 This option may be specified more than once. Each address can optionally take a port number
736 separated with <literal>:</literal>, a network interface name or index separated with
737 <literal>%</literal>, and a Server Name Indication (SNI) separated with <literal>#</literal>.
738 When IPv6 address is specified with a port number, then the address must be in the square
739 brackets. That is, the acceptable full formats are
740 <literal>111.222.333.444:9953%ifname#example.com</literal> for IPv4 and
741 <literal>[1111:2222::3333]:9953%ifname#example.com</literal> for IPv6. If an empty string is
742 assigned, then the all previous assignments are cleared. This setting is read by
743 <citerefentry><refentrytitle>systemd-resolved.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
744 </para>
745
746 <xi:include href="version-info.xml" xpointer="v211"/>
747 </listitem>
748 </varlistentry>
749
750 <varlistentry>
751 <term><varname>UseDomains=</varname></term>
752 <listitem>
753 <para>Specifies the protocol-independent default value for the same settings in
754 [IPv6AcceptRA], [DHCPv4], and [DHCPv6] sections below. Takes a boolean, or the special value
755 <option>route</option>. See also the same setting in [DHCPv4] below. Defaults to unset.</para>
756
757 <xi:include href="version-info.xml" xpointer="v256"/>
758 </listitem>
759 </varlistentry>
760
761 <varlistentry>
762 <term><varname>Domains=</varname></term>
763 <listitem>
764 <para>A whitespace-separated list of domains which should be resolved using the DNS servers
765 on this link. Each item in the list should be a domain name, optionally prefixed with a tilde
766 (<literal>~</literal>). The domains with the prefix are called "routing-only domains". The
767 domains without the prefix are called "search domains" and are first used as search suffixes
768 for extending single-label hostnames (hostnames containing no dots) to become fully qualified
769 domain names (FQDNs). If a single-label hostname is resolved on this interface, each of the
770 specified search domains are appended to it in turn, converting it into a fully qualified
771 domain name, until one of them may be successfully resolved.</para>
772
773 <para>Both "search" and "routing-only" domains are used for routing of DNS queries: look-ups
774 for hostnames ending in those domains (hence also single label names, if any "search domains"
775 are listed), are routed to the DNS servers configured for this interface. The domain routing
776 logic is particularly useful on multi-homed hosts with DNS servers serving particular private
777 DNS zones on each interface.</para>
778
779 <para>The "routing-only" domain <literal>~.</literal> (the tilde indicating definition of a
780 routing domain, the dot referring to the DNS root domain which is the implied suffix of all
781 valid DNS names) has special effect. It causes all DNS traffic which does not match another
782 configured domain routing entry to be routed to DNS servers specified for this interface.
783 This setting is useful to prefer a certain set of DNS servers if a link on which they are
784 connected is available.</para>
785
786 <para>This setting is read by
787 <citerefentry><refentrytitle>systemd-resolved.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
788 "Search domains" correspond to the <varname>domain</varname> and <varname>search</varname>
789 entries in
790 <citerefentry project='man-pages'><refentrytitle>resolv.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
791 Domain name routing has no equivalent in the traditional glibc API, which has no concept of
792 domain name servers limited to a specific link.</para>
793
794 <xi:include href="version-info.xml" xpointer="v216"/>
795 </listitem>
796 </varlistentry>
797
798 <varlistentry>
799 <term><varname>DNSDefaultRoute=</varname></term>
800 <listitem>
801 <para>Takes a boolean argument. If true, this link's configured DNS servers are used for
802 resolving domain names that do not match any link's configured <varname>Domains=</varname>
803 setting. If false, this link's configured DNS servers are never used for such domains, and
804 are exclusively used for resolving names that match at least one of the domains configured on
805 this link. If not specified defaults to an automatic mode: queries not matching any link's
806 configured domains will be routed to this link if it has no routing-only domains configured.
807 </para>
808
809 <xi:include href="version-info.xml" xpointer="v240"/>
810 </listitem>
811 </varlistentry>
812
813 <varlistentry>
814 <term><varname>NTP=</varname></term>
815 <listitem>
816 <para>An NTP server address (either an IP address, or a hostname). This option may be
817 specified more than once. This setting is read by
818 <citerefentry><refentrytitle>systemd-timesyncd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
819 </para>
820
821 <xi:include href="version-info.xml" xpointer="v216"/>
822 </listitem>
823 </varlistentry>
824
825 <varlistentry>
826 <term><varname>IPv4Forwarding=</varname></term>
827 <listitem>
828 <para>Configures IPv4 packet forwarding for the interface. Takes a boolean value. This controls the
829 <filename>net.ipv4.conf.<replaceable>INTERFACE</replaceable>.forwarding</filename> sysctl option of
830 the network interface. See
831 <ulink url="https://docs.kernel.org/networking/ip-sysctl.html">IP Sysctl</ulink>
832 for more details about the sysctl option. Defaults to true if <varname>IPMasquerade=</varname> is
833 enabled for IPv4, otherwise the value specified to the same setting in
834 <citerefentry><refentrytitle>networkd.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>
835 will be used. If none of them are specified, the sysctl option will not be changed.</para>
836
837 <para>To control the global setting, use the same setting in
838 <citerefentry><refentrytitle>networkd.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
839 </para>
840
841 <xi:include href="version-info.xml" xpointer="v256"/>
842 </listitem>
843 </varlistentry>
844
845 <varlistentry>
846 <term><varname>IPv6Forwarding=</varname></term>
847 <listitem>
848 <para>Configures IPv6 packet forwarding for the interface. Takes a boolean value. This controls the
849 <filename>net.ipv6.conf.<replaceable>INTERFACE</replaceable>.forwarding</filename> sysctl option of
850 the network interface. See
851 <ulink url="https://docs.kernel.org/networking/ip-sysctl.html">IP Sysctl</ulink>
852 for more details about the sysctl option. Defaults to true if <varname>IPMasquerade=</varname> is
853 enabled for IPv6 or <varname>IPv6SendRA=</varname> is enabled, otherwise the value specified to the
854 same setting in
855 <citerefentry><refentrytitle>networkd.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>
856 will be used. If none of them are specified, the sysctl option will not be changed.</para>
857
858 <para>To control the global setting, use the same setting in
859 <citerefentry><refentrytitle>networkd.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
860 </para>
861
862 <xi:include href="version-info.xml" xpointer="v256"/>
863 </listitem>
864 </varlistentry>
865
866 <varlistentry>
867 <term><varname>IPMasquerade=</varname></term>
868 <listitem>
869 <para>Configures IP masquerading for the network interface. If enabled, packets forwarded
870 from the network interface will be appear as coming from the local host. Takes one of
871 <literal>ipv4</literal>, <literal>ipv6</literal>, <literal>both</literal>, or
872 <literal>no</literal>. Defaults to <literal>no</literal>.</para>
873 <para>Note. Any positive boolean values such as <literal>yes</literal> or
874 <literal>true</literal> are now deprecated. Please use one of the values above.</para>
875
876 <xi:include href="version-info.xml" xpointer="v219"/>
877 </listitem>
878 </varlistentry>
879
880 <varlistentry>
881 <term><varname>IPv6PrivacyExtensions=</varname></term>
882 <listitem>
883 <para>Configures use of stateless temporary addresses that change over time (see
884 <ulink url="https://tools.ietf.org/html/rfc4941">RFC 4941</ulink>,
885 Privacy Extensions for Stateless Address Autoconfiguration in IPv6). Takes a boolean or the
886 special values <literal>prefer-public</literal> and <literal>kernel</literal>. When true,
887 enables the privacy extensions and prefers temporary addresses over public addresses. When
888 <literal>prefer-public</literal>, enables the privacy extensions, but prefers public
889 addresses over temporary addresses. When false, the privacy extensions remain disabled. When
890 <literal>kernel</literal>, the kernel's default setting will be left in place. When unspecified,
891 the value specified in the same setting in
892 <citerefentry><refentrytitle>networkd.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
893 which defaults to <literal>no</literal>, will be used.</para>
894
895 <xi:include href="version-info.xml" xpointer="v222"/>
896 </listitem>
897 </varlistentry>
898
899 <varlistentry>
900 <term><varname>IPv6AcceptRA=</varname></term>
901 <listitem>
902 <para>Takes a boolean. Controls IPv6 Router Advertisement (RA) reception support for the interface.
903 If true, RAs are accepted; if false, RAs are ignored. When RAs are accepted, they may trigger the
904 start of the DHCPv6 client if the relevant flags are set in the RA data, or if no routers are found
905 on the link. Defaults to false for bridge devices, when IP forwarding is enabled,
906 <varname>IPv6SendRA=</varname> or <varname>KeepMaster=</varname> is enabled. Otherwise, enabled by
907 default. Cannot be enabled on devices aggregated in a bond device or when link-local addressing is
908 disabled.</para>
909
910 <para>Further settings for the IPv6 RA support may be configured in the [IPv6AcceptRA]
911 section, see below.</para>
912
913 <para>Also see
914 <ulink url="https://docs.kernel.org/networking/ip-sysctl.html">IP Sysctl</ulink>
915 in the kernel documentation regarding <literal>accept_ra</literal>, but note that systemd's
916 setting of <constant>1</constant> (i.e. true) corresponds to kernel's setting of
917 <constant>2</constant>.</para>
918
919 <para>Note that kernel's implementation of the IPv6 RA protocol is always disabled,
920 regardless of this setting. If this option is enabled, a userspace implementation of the IPv6
921 RA protocol is used, and the kernel's own implementation remains disabled, since
922 <command>systemd-networkd</command> needs to know all details supplied in the advertisements,
923 and these are not available from the kernel if the kernel's own implementation is used.
924 </para>
925
926 <xi:include href="version-info.xml" xpointer="v231"/>
927 </listitem>
928 </varlistentry>
929
930 <varlistentry>
931 <term><varname>IPv6DuplicateAddressDetection=</varname></term>
932 <listitem>
933 <para>Configures the amount of IPv6 Duplicate Address Detection (DAD) probes to send. When
934 unset, the kernel's default will be used.</para>
935
936 <xi:include href="version-info.xml" xpointer="v228"/>
937 </listitem>
938 </varlistentry>
939
940 <varlistentry>
941 <term><varname>IPv6HopLimit=</varname></term>
942 <listitem>
943 <para>Configures IPv6 Hop Limit. Takes an integer in the range 1255. For each router that
944 forwards the packet, the hop limit is decremented by 1. When the hop limit field reaches zero, the
945 packet is discarded. When unset, the kernel's default will be used.</para>
946
947 <xi:include href="version-info.xml" xpointer="v228"/>
948 </listitem>
949 </varlistentry>
950
951 <varlistentry>
952 <term><varname>IPv6RetransmissionTimeSec=</varname></term>
953 <listitem>
954 <para>Configures IPv6 Retransmission Time. The time between retransmitted Neighbor
955 Solicitation messages. Used by address resolution and the Neighbor Unreachability
956 Detection algorithm. A value of zero is ignored and the kernel's current value
957 will be used. Defaults to unset, and the kernel's current value will be used.</para>
958
959 <xi:include href="version-info.xml" xpointer="v256"/>
960 </listitem>
961 </varlistentry>
962
963 <varlistentry>
964 <term><varname>IPv4ReversePathFilter=</varname></term>
965 <listitem>
966 <para>Configure IPv4 Reverse Path Filtering. If enabled, when an IPv4 packet is received, the machine will first check
967 whether the <emphasis>source</emphasis> of the packet would be routed through the interface it came in. If there is no
968 route to the source on that interface, the machine will drop the packet. Takes one of
969 <literal>no</literal>, <literal>strict</literal>, or <literal>loose</literal>. When <literal>no</literal>,
970 no source validation will be done. When <literal>strict</literal>, mode each incoming packet is tested against the FIB and
971 if the incoming interface is not the best reverse path, the packet check will fail. By default failed packets are discarded.
972 When <literal>loose</literal>, mode each incoming packet's source address is tested against the FIB. The packet is dropped
973 only if the source address is not reachable via any interface on that router.
974 See <ulink url="https://tools.ietf.org/html/rfc1027">RFC 3704</ulink>.
975 When unset, the kernel's default will be used.</para>
976
977 <xi:include href="version-info.xml" xpointer="v255"/>
978 </listitem>
979 </varlistentry>
980
981 <varlistentry>
982 <term><varname>IPv4AcceptLocal=</varname></term>
983 <listitem>
984 <para>Takes a boolean. Accept packets with local source addresses. In combination with
985 suitable routing, this can be used to direct packets between two local interfaces over the
986 wire and have them accepted properly. When unset, the kernel's default will be used.</para>
987
988 <xi:include href="version-info.xml" xpointer="v246"/>
989 </listitem>
990 </varlistentry>
991
992 <varlistentry>
993 <term><varname>IPv4RouteLocalnet=</varname></term>
994 <listitem>
995 <para>Takes a boolean. When true, the kernel does not consider loopback addresses as martian
996 source or destination while routing. This enables the use of 127.0.0.0/8 for local routing
997 purposes. When unset, the kernel's default will be used.</para>
998
999 <xi:include href="version-info.xml" xpointer="v248"/>
1000 </listitem>
1001 </varlistentry>
1002
1003 <varlistentry>
1004 <term><varname>IPv4ProxyARP=</varname></term>
1005 <listitem>
1006 <para>Takes a boolean. Configures proxy ARP for IPv4. Proxy ARP is the technique in which one
1007 host, usually a router, answers ARP requests intended for another machine. By "faking" its
1008 identity, the router accepts responsibility for routing packets to the "real" destination.
1009 See <ulink url="https://tools.ietf.org/html/rfc1027">RFC 1027</ulink>. When unset, the
1010 kernel's default will be used.</para>
1011
1012 <xi:include href="version-info.xml" xpointer="v233"/>
1013 </listitem>
1014 </varlistentry>
1015
1016 <varlistentry>
1017 <term><varname>IPv4ProxyARPPrivateVLAN=</varname></term>
1018 <listitem>
1019 <para>Takes a boolean. Configures proxy ARP private VLAN for IPv4, also known as VLAN aggregation,
1020 private VLAN, source-port filtering, port-isolation, or MAC-forced forwarding.</para>
1021
1022 <para>This variant of the ARP proxy technique will allow the ARP proxy to reply back to the same
1023 interface.</para>
1024
1025 <para>See <ulink url="https://tools.ietf.org/html/rfc3069">RFC 3069</ulink>. When unset,
1026 the kernel's default will be used.</para>
1027 <xi:include href="version-info.xml" xpointer="v256"/>
1028 </listitem>
1029 </varlistentry>
1030
1031 <varlistentry>
1032 <term><varname>IPv6ProxyNDP=</varname></term>
1033 <listitem>
1034 <para>Takes a boolean. Configures proxy NDP for IPv6. Proxy NDP (Neighbor Discovery Protocol)
1035 is a technique for IPv6 to allow routing of addresses to a different destination when peers
1036 expect them to be present on a certain physical link. In this case a router answers Neighbour
1037 Advertisement messages intended for another machine by offering its own MAC address as
1038 destination. Unlike proxy ARP for IPv4, it is not enabled globally, but will only send
1039 Neighbour Advertisement messages for addresses in the IPv6 neighbor proxy table, which can
1040 also be shown by <command>ip -6 neighbour show proxy</command>. systemd-networkd will control
1041 the per-interface `proxy_ndp` switch for each configured interface depending on this option.
1042 When unset, the kernel's default will be used.</para>
1043
1044 <xi:include href="version-info.xml" xpointer="v234"/>
1045 </listitem>
1046 </varlistentry>
1047
1048 <varlistentry>
1049 <term><varname>IPv6ProxyNDPAddress=</varname></term>
1050 <listitem>
1051 <para>An IPv6 address, for which Neighbour Advertisement messages will be proxied. This
1052 option may be specified more than once. systemd-networkd will add the
1053 <varname>IPv6ProxyNDPAddress=</varname> entries to the kernel's IPv6 neighbor proxy table.
1054 This setting implies <varname>IPv6ProxyNDP=yes</varname> but has no effect if
1055 <varname>IPv6ProxyNDP=</varname> has been set to false. When unset, the kernel's default will
1056 be used.</para>
1057
1058 <xi:include href="version-info.xml" xpointer="v233"/>
1059 </listitem>
1060 </varlistentry>
1061
1062 <varlistentry>
1063 <term><varname>IPv6SendRA=</varname></term>
1064 <listitem>
1065 <para>Whether to enable or disable Router Advertisement sending on a link. Takes a boolean
1066 value. When enabled, prefixes configured in [IPv6Prefix] sections and routes configured in
1067 the [IPv6RoutePrefix] sections are distributed as defined in the [IPv6SendRA] section. If
1068 <varname>DHCPPrefixDelegation=</varname> is enabled, then the delegated prefixes are also
1069 distributed. See <varname>DHCPPrefixDelegation=</varname> setting and the [IPv6SendRA],
1070 [IPv6Prefix], [IPv6RoutePrefix], and [DHCPPrefixDelegation] sections for more configuration
1071 options.</para>
1072
1073 <xi:include href="version-info.xml" xpointer="v247"/>
1074 </listitem>
1075 </varlistentry>
1076
1077 <varlistentry>
1078 <term><varname>DHCPPrefixDelegation=</varname></term>
1079 <listitem>
1080 <para>Takes a boolean value. When enabled, requests subnet prefixes on another link via the DHCPv6
1081 protocol or via the 6RD option in the DHCPv4 protocol. An address within each delegated prefix will
1082 be assigned, and the prefixes will be announced through IPv6 Router Advertisement if
1083 <varname>IPv6SendRA=</varname> is enabled. This behaviour can be configured in the
1084 [DHCPPrefixDelegation] section. Defaults to disabled.</para>
1085
1086 <xi:include href="version-info.xml" xpointer="v250"/>
1087 </listitem>
1088 </varlistentry>
1089
1090 <varlistentry>
1091 <term><varname>IPv6MTUBytes=</varname></term>
1092 <listitem>
1093 <para>Configures IPv6 maximum transmission unit (MTU). An integer greater than or equal to
1094 1280 bytes. When unset, the kernel's default will be used.</para>
1095
1096 <xi:include href="version-info.xml" xpointer="v239"/>
1097 </listitem>
1098 </varlistentry>
1099
1100 <varlistentry>
1101 <term><varname>KeepMaster=</varname></term>
1102 <listitem>
1103 <para>Takes a boolean value. When enabled, the current master interface index will not be
1104 changed, and <varname>BatmanAdvanced=</varname>, <varname>Bond=</varname>,
1105 <varname>Bridge=</varname>, and <varname>VRF=</varname> settings are ignored. This may be
1106 useful when a netdev with a master interface is created by another program, e.g.
1107 <citerefentry><refentrytitle>systemd-nspawn</refentrytitle><manvolnum>1</manvolnum></citerefentry>.
1108 Defaults to false.</para>
1109
1110 <xi:include href="version-info.xml" xpointer="v250"/>
1111 </listitem>
1112 </varlistentry>
1113
1114 <varlistentry>
1115 <term><varname>BatmanAdvanced=</varname></term>
1116 <term><varname>Bond=</varname></term>
1117 <term><varname>Bridge=</varname></term>
1118 <term><varname>VRF=</varname></term>
1119 <listitem>
1120 <para>The name of the B.A.T.M.A.N. Advanced, bond, bridge, or VRF interface to add the link
1121 to. See
1122 <citerefentry><refentrytitle>systemd.netdev</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
1123 </para>
1124
1125 <xi:include href="version-info.xml" xpointer="v211"/>
1126 </listitem>
1127 </varlistentry>
1128
1129 <varlistentry>
1130 <term><varname>IPoIB=</varname></term>
1131 <term><varname>IPVLAN=</varname></term>
1132 <term><varname>IPVTAP=</varname></term>
1133 <term><varname>MACsec=</varname></term>
1134 <term><varname>MACVLAN=</varname></term>
1135 <term><varname>MACVTAP=</varname></term>
1136 <term><varname>Tunnel=</varname></term>
1137 <term><varname>VLAN=</varname></term>
1138 <term><varname>VXLAN=</varname></term>
1139 <term><varname>Xfrm=</varname></term>
1140 <listitem>
1141 <para>The name of an IPoIB, IPVLAN, IPVTAP, MACsec, MACVLAN, MACVTAP, tunnel, VLAN,
1142 VXLAN, or Xfrm to be created on the link. See
1143 <citerefentry><refentrytitle>systemd.netdev</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
1144 This option may be specified more than once.</para>
1145
1146 <xi:include href="version-info.xml" xpointer="v211"/>
1147 </listitem>
1148 </varlistentry>
1149
1150 <varlistentry>
1151 <term><varname>ActiveSlave=</varname></term>
1152 <listitem>
1153 <para>Takes a boolean. Specifies the new active slave. The <literal>ActiveSlave=</literal>
1154 option is only valid for following modes: <literal>active-backup</literal>,
1155 <literal>balance-alb</literal>, and <literal>balance-tlb</literal>. Defaults to false.</para>
1156
1157 <xi:include href="version-info.xml" xpointer="v235"/>
1158 </listitem>
1159 </varlistentry>
1160
1161 <varlistentry>
1162 <term><varname>PrimarySlave=</varname></term>
1163 <listitem>
1164 <para>Takes a boolean. Specifies which slave is the primary device. The specified device will
1165 always be the active slave while it is available. Only when the primary is off-line will
1166 alternate devices be used. This is useful when one slave is preferred over another, e.g.
1167 when one slave has higher throughput than another. The <literal>PrimarySlave=</literal>
1168 option is only valid for following modes: <literal>active-backup</literal>,
1169 <literal>balance-alb</literal>, and <literal>balance-tlb</literal>. Defaults to false.</para>
1170
1171 <xi:include href="version-info.xml" xpointer="v235"/>
1172 </listitem>
1173 </varlistentry>
1174
1175 <varlistentry>
1176 <term><varname>ConfigureWithoutCarrier=</varname></term>
1177 <listitem>
1178 <para>Takes a boolean. Allows networkd to configure a specific link even if it has no
1179 carrier. Defaults to false. If enabled, and the <varname>IgnoreCarrierLoss=</varname> setting
1180 is not explicitly set, then it is enabled as well.</para>
1181
1182 <xi:include href="version-info.xml" xpointer="v235"/>
1183 </listitem>
1184 </varlistentry>
1185
1186 <varlistentry>
1187 <term><varname>IgnoreCarrierLoss=</varname></term>
1188 <listitem>
1189 <para>Takes a boolean or a timespan. When true, <command>systemd-networkd</command> retains
1190 both the static and dynamic configuration of the interface even if its carrier is lost. When
1191 false, <command>systemd-networkd</command> drops both the static and dynamic configuration of
1192 the interface. When a timespan is specified, <command>systemd-networkd</command> waits for
1193 the specified timespan, and ignores the carrier loss if the link regain its carrier within
1194 the timespan. Setting 0 seconds is equivalent to <literal>no</literal>, and
1195 <literal>infinite</literal> is equivalent to <literal>yes</literal>.</para>
1196
1197 <para>Setting a finite timespan may be useful when e.g. in the following cases:
1198 <itemizedlist>
1199 <listitem>
1200 <para>A wireless interface connecting to a network which has multiple access points with
1201 the same SSID.</para>
1202 </listitem>
1203 <listitem>
1204 <para>Enslaving a wireless interface to a bond interface, which may disconnect from the
1205 connected access point and causes its carrier to be lost.</para>
1206 </listitem>
1207 <listitem>
1208 <para>The driver of the interface resets when the MTU is changed.</para>
1209 </listitem>
1210 </itemizedlist>
1211 </para>
1212
1213 <para>When <varname>Bond=</varname> is specified to a wireless interface, defaults to 3
1214 seconds. When the DHCPv4 client is enabled and <varname>UseMTU=</varname> in the [DHCPv4]
1215 section enabled, defaults to 5 seconds. Otherwise, defaults to the value specified with
1216 <varname>ConfigureWithoutCarrier=</varname>. When <varname>ActivationPolicy=</varname> is set
1217 to <literal>always-up</literal>, this is forced to <literal>yes</literal>, and ignored any
1218 user specified values.</para>
1219
1220 <xi:include href="version-info.xml" xpointer="v242"/>
1221 </listitem>
1222 </varlistentry>
1223
1224 <varlistentry>
1225 <term><varname>KeepConfiguration=</varname></term>
1226 <listitem>
1227 <para>Takes a boolean or one of <literal>static</literal>, <literal>dhcp-on-stop</literal>,
1228 <literal>dhcp</literal>. When <literal>static</literal>, <command>systemd-networkd</command>
1229 will not drop static addresses and routes on starting up process. When set to
1230 <literal>dhcp-on-stop</literal>, <command>systemd-networkd</command> will not drop addresses
1231 and routes on stopping the daemon. When <literal>dhcp</literal>,
1232 the addresses and routes provided by a DHCP server will never be dropped even if the DHCP
1233 lease expires. This is contrary to the DHCP specification, but may be the best choice if,
1234 e.g., the root filesystem relies on this connection. The setting <literal>dhcp</literal>
1235 implies <literal>dhcp-on-stop</literal>, and <literal>yes</literal> implies
1236 <literal>dhcp</literal> and <literal>static</literal>. Defaults to
1237 <literal>dhcp-on-stop</literal> when <command>systemd-networkd</command> is running in
1238 initrd, <literal>yes</literal> when the root filesystem is a network filesystem, and
1239 <literal>no</literal> otherwise.</para>
1240
1241 <xi:include href="version-info.xml" xpointer="v243"/>
1242 </listitem>
1243 </varlistentry>
1244 </variablelist>
1245 </refsect1>
1246
1247 <refsect1>
1248 <title>[Address] Section Options</title>
1249
1250 <para>An [Address] section accepts the following keys. Specify several [Address] sections to
1251 configure several addresses.</para>
1252
1253 <variablelist class='network-directives'>
1254 <varlistentry>
1255 <term><varname>Address=</varname></term>
1256 <listitem>
1257 <para>As in the [Network] section. This setting is mandatory. Each [Address] section can
1258 contain one <varname>Address=</varname> setting.</para>
1259
1260 <xi:include href="version-info.xml" xpointer="v211"/>
1261 </listitem>
1262 </varlistentry>
1263
1264 <varlistentry>
1265 <term><varname>Peer=</varname></term>
1266 <listitem>
1267 <para>The peer address in a point-to-point connection. Accepts the same format as the
1268 <varname>Address=</varname> setting.</para>
1269
1270 <xi:include href="version-info.xml" xpointer="v216"/>
1271 </listitem>
1272 </varlistentry>
1273
1274 <varlistentry>
1275 <term><varname>Broadcast=</varname></term>
1276 <listitem>
1277 <para>Takes an IPv4 address or boolean value. The address must be in the format described in
1278 <citerefentry project='man-pages'><refentrytitle>inet_pton</refentrytitle><manvolnum>3</manvolnum></citerefentry>.
1279 If set to true, then the IPv4 broadcast address will be derived from the
1280 <varname>Address=</varname> setting. If set to false, then the broadcast address will not be
1281 set. Defaults to true, except for wireguard interfaces, where it default to false.</para>
1282
1283 <xi:include href="version-info.xml" xpointer="v211"/>
1284 </listitem>
1285 </varlistentry>
1286
1287 <varlistentry>
1288 <term><varname>Label=</varname></term>
1289 <listitem>
1290 <para>Specifies the label for the IPv4 address. The label must be a 7-bit ASCII string with
1291 a length of 115 characters. Defaults to unset.</para>
1292
1293 <xi:include href="version-info.xml" xpointer="v211"/>
1294 </listitem>
1295 </varlistentry>
1296
1297 <varlistentry>
1298 <term><varname>PreferredLifetime=</varname></term>
1299 <listitem>
1300 <para>Allows the default "preferred lifetime" of the address to be overridden. Only three
1301 settings are accepted: <literal>forever</literal>, <literal>infinity</literal>, which is the
1302 default and means that the address never expires, and <literal>0</literal>, which means that
1303 the address is considered immediately "expired" and will not be used, unless explicitly
1304 requested. A setting of <option>PreferredLifetime=0</option> is useful for addresses which
1305 are added to be used only by a specific application, which is then configured to use them
1306 explicitly.</para>
1307
1308 <xi:include href="version-info.xml" xpointer="v230"/>
1309 </listitem>
1310 </varlistentry>
1311
1312 <varlistentry>
1313 <term><varname>Scope=</varname></term>
1314 <listitem>
1315 <para>The scope of the address, which can be <literal>global</literal> (valid everywhere on
1316 the network, even through a gateway), <literal>link</literal> (only valid on this device,
1317 will not traverse a gateway) or <literal>host</literal> (only valid within the device itself,
1318 e.g. 127.0.0.1) or an integer in the range 0255. Defaults to <literal>global</literal>.
1319 IPv4 only - IPv6 scope is automatically assigned by the kernel and cannot be set manually.
1320 </para>
1321
1322 <xi:include href="version-info.xml" xpointer="v235"/>
1323 </listitem>
1324 </varlistentry>
1325
1326 <varlistentry>
1327 <term><varname>RouteMetric=</varname></term>
1328 <listitem>
1329 <para>The metric of the prefix route, which is pointing to the subnet of the configured IP
1330 address, taking the configured prefix length into account. Takes an unsigned integer in the
1331 range 04294967295. When unset or set to 0, the kernel's default value is used. This
1332 setting will be ignored when <varname>AddPrefixRoute=</varname> is false.</para>
1333
1334 <xi:include href="version-info.xml" xpointer="v246"/>
1335 </listitem>
1336 </varlistentry>
1337
1338 <varlistentry>
1339 <term><varname>HomeAddress=</varname></term>
1340 <listitem>
1341 <para>Takes a boolean. Designates this address the "home address" as defined in
1342 <ulink url="https://tools.ietf.org/html/rfc6275">RFC 6275</ulink>. Supported only on IPv6.
1343 Defaults to false.</para>
1344
1345 <xi:include href="version-info.xml" xpointer="v232"/>
1346 </listitem>
1347 </varlistentry>
1348
1349 <varlistentry>
1350 <term><varname>DuplicateAddressDetection=</varname></term>
1351 <listitem>
1352 <para>Takes one of <literal>ipv4</literal>, <literal>ipv6</literal>, <literal>both</literal>,
1353 or <literal>none</literal>. When <literal>ipv4</literal>, performs IPv4 Address Conflict
1354 Detection. See <ulink url="https://tools.ietf.org/html/rfc5227">RFC 5227</ulink>.
1355 When <literal>ipv6</literal>, performs IPv6 Duplicate Address Detection. See
1356 <ulink url="https://tools.ietf.org/html/rfc4862">RFC 4862</ulink>. Defaults to
1357 <literal>ipv4</literal> for IPv4 link-local addresses, <literal>ipv6</literal> for IPv6
1358 addresses, and <literal>none</literal> otherwise.</para>
1359
1360 <xi:include href="version-info.xml" xpointer="v232"/>
1361 </listitem>
1362 </varlistentry>
1363
1364 <varlistentry>
1365 <term><varname>ManageTemporaryAddress=</varname></term>
1366 <listitem>
1367 <para>Takes a boolean. If true the kernel manage temporary addresses created from this one as
1368 template on behalf of Privacy Extensions
1369 <ulink url="https://tools.ietf.org/html/rfc3041">RFC 3041</ulink>. For this to become active,
1370 the use_tempaddr sysctl setting has to be set to a value greater than zero. The given address
1371 needs to have a prefix length of 64. This flag allows using privacy extensions in a manually
1372 configured network, just like if stateless auto-configuration was active. Defaults to false.
1373 </para>
1374
1375 <xi:include href="version-info.xml" xpointer="v232"/>
1376 </listitem>
1377 </varlistentry>
1378
1379 <varlistentry>
1380 <term><varname>AddPrefixRoute=</varname></term>
1381 <listitem>
1382 <para>Takes a boolean. When true, the prefix route for the address is automatically added.
1383 Defaults to true.</para>
1384
1385 <xi:include href="version-info.xml" xpointer="v245"/>
1386 </listitem>
1387 </varlistentry>
1388
1389 <varlistentry>
1390 <term><varname>AutoJoin=</varname></term>
1391 <listitem>
1392 <para>Takes a boolean. Joining multicast group on ethernet level via
1393 <command>ip maddr</command> command would not work if we have an Ethernet switch that does
1394 IGMP snooping since the switch would not replicate multicast packets on ports that did not
1395 have IGMP reports for the multicast addresses. Linux vxlan interfaces created via
1396 <command>ip link add vxlan</command> or networkd's netdev kind vxlan have the group option
1397 that enables them to do the required join. By extending <command>ip address</command> command
1398 with option <literal>autojoin</literal> we can get similar functionality for openvswitch (OVS)
1399 vxlan interfaces as well as other tunneling mechanisms that need to receive multicast traffic.
1400 Defaults to <literal>no</literal>.</para>
1401
1402 <xi:include href="version-info.xml" xpointer="v232"/>
1403 </listitem>
1404 </varlistentry>
1405
1406 <varlistentry>
1407 <term><varname>NetLabel=</varname><replaceable>label</replaceable></term>
1408 <listitem>
1409
1410 <para>This setting provides a method for integrating static and dynamic network configuration into
1411 Linux <ulink url="https://docs.kernel.org/netlabel/index.html">NetLabel</ulink> subsystem rules,
1412 used by <ulink url="https://en.wikipedia.org/wiki/Linux_Security_Modules">Linux Security Modules
1413 (LSMs)</ulink> for network access control. The label, with suitable LSM rules, can be used to
1414 control connectivity of (for example) a service with peers in the local network. At least with
1415 SELinux, only the ingress can be controlled but not egress. The benefit of using this setting is
1416 that it may be possible to apply interface independent part of NetLabel configuration at very early
1417 stage of system boot sequence, at the time when the network interfaces are not available yet, with
1418 <citerefentry
1419 project='man-pages'><refentrytitle>netlabelctl</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
1420 and the per-interface configuration with <command>systemd-networkd</command> once the interfaces
1421 appear later. Currently this feature is only implemented for SELinux.</para>
1422
1423 <para>The option expects a single NetLabel label. The label must conform to lexical restrictions of
1424 LSM labels. When an interface is configured with IP addresses, the addresses and subnetwork masks
1425 will be appended to the <ulink
1426 url="https://github.com/SELinuxProject/selinux-notebook/blob/main/src/network_support.md">NetLabel
1427 Fallback Peer Labeling</ulink> rules. They will be removed when the interface is
1428 deconfigured. Failures to manage the labels will be ignored.</para>
1429
1430 <warning>
1431 <para>Once labeling is enabled for network traffic, a lot of LSM access control points in
1432 Linux networking stack go from dormant to active. Care should be taken to avoid getting into a
1433 situation where for example remote connectivity is broken, when the security policy hasn't been
1434 updated to consider LSM per-packet access controls and no rules would allow any network
1435 traffic. Also note that additional configuration with <citerefentry
1436 project='man-pages'><refentrytitle>netlabelctl</refentrytitle><manvolnum>8</manvolnum></citerefentry>
1437 is needed.</para>
1438 </warning>
1439
1440 <para>Example:
1441 <programlisting>[Address]
1442 NetLabel=system_u:object_r:localnet_peer_t:s0</programlisting>
1443
1444 With the example rules applying for interface <literal>eth0</literal>, when the interface is
1445 configured with an IPv4 address of 10.0.0.123/8, <command>systemd-networkd</command> performs the
1446 equivalent of <command>netlabelctl</command> operation
1447
1448 <programlisting>netlabelctl unlbl add interface eth0 address:10.0.0.0/8 label:system_u:object_r:localnet_peer_t:s0</programlisting>
1449
1450 and the reverse operation when the IPv4 address is deconfigured. The configuration can be used with
1451 LSM rules; in case of SELinux to allow a SELinux domain to receive data from objects of SELinux
1452 <literal>peer</literal> class. For example:
1453
1454 <programlisting>type localnet_peer_t;
1455 allow my_server_t localnet_peer_t:peer recv;</programlisting>
1456
1457 The effect of the above configuration and rules (in absence of other rules as may be the case) is
1458 to only allow <literal>my_server_t</literal> (and nothing else) to receive data from local subnet
1459 10.0.0.0/8 of interface <literal>eth0</literal>.
1460 </para>
1461
1462 <xi:include href="version-info.xml" xpointer="v252"/>
1463 </listitem>
1464 </varlistentry>
1465
1466 <varlistentry>
1467 <term><varname>NFTSet=</varname><replaceable>source</replaceable>:<replaceable>family</replaceable>:<replaceable>table</replaceable>:<replaceable>set</replaceable></term>
1468 <listitem>
1469 <para>This setting provides a method for integrating network configuration into firewall rules with
1470 <ulink url="https://netfilter.org/projects/nftables/index.html">NFT</ulink> sets. The benefit of
1471 using the setting is that static network configuration (or dynamically obtained network addresses,
1472 see similar directives in other sections) can be used in firewall rules with the indirection of NFT
1473 set types. For example, access could be granted for hosts in the local subnetwork only. Firewall
1474 rules using IP address of an interface are also instantly updated when the network configuration
1475 changes, for example via DHCP.</para>
1476
1477 <para>This option expects a whitespace separated list of NFT set definitions. Each definition
1478 consists of a colon-separated tuple of source type (one of <literal>address</literal>,
1479 <literal>prefix</literal> or <literal>ifindex</literal>), NFT address family (one of
1480 <literal>arp</literal>, <literal>bridge</literal>, <literal>inet</literal>, <literal>ip</literal>,
1481 <literal>ip6</literal>, or <literal>netdev</literal>), table name and set name. The names of tables
1482 and sets must conform to lexical restrictions of NFT table names. The type of the element used in
1483 the NFT filter must match the type implied by the directive (<literal>address</literal>,
1484 <literal>prefix</literal> or <literal>ifindex</literal>) and address type (IPv4 or IPv6) as shown
1485 in the table below.</para>
1486
1487 <table>
1488 <title>Defined <varname>source type</varname> values</title>
1489 <tgroup cols='3'>
1490 <colspec colname='source type'/>
1491 <colspec colname='description'/>
1492 <colspec colname='NFT type name'/>
1493 <thead>
1494 <row>
1495 <entry>Source type</entry>
1496 <entry>Description</entry>
1497 <entry>Corresponding NFT type name</entry>
1498 </row>
1499 </thead>
1500
1501 <tbody>
1502 <row>
1503 <entry><literal>address</literal></entry>
1504 <entry>host IP address</entry>
1505 <entry><literal>ipv4_addr</literal> or <literal>ipv6_addr</literal></entry>
1506 </row>
1507 <row>
1508 <entry><literal>prefix</literal></entry>
1509 <entry>network prefix</entry>
1510 <entry><literal>ipv4_addr</literal> or <literal>ipv6_addr</literal>, with <literal>flags interval</literal></entry>
1511 </row>
1512 <row>
1513 <entry><literal>ifindex</literal></entry>
1514 <entry>interface index</entry>
1515 <entry><literal>iface_index</literal></entry>
1516 </row>
1517 </tbody>
1518 </tgroup>
1519 </table>
1520
1521 <para>When an interface is configured with IP addresses, the addresses, subnetwork masks or
1522 interface index will be appended to the NFT sets. The information will be removed when the
1523 interface is deconfigured. <command>systemd-networkd</command> only inserts elements to (or removes
1524 from) the sets, so the related NFT rules, tables and sets must be prepared elsewhere in
1525 advance. Failures to manage the sets will be ignored.</para>
1526
1527 <para>Example:
1528 <programlisting>[Address]
1529 NFTSet=prefix:netdev:filter:eth_ipv4_prefix</programlisting>
1530 Corresponding NFT rules:
1531 <programlisting>table netdev filter {
1532 set eth_ipv4_prefix {
1533 type ipv4_addr
1534 flags interval
1535 }
1536 chain eth_ingress {
1537 type filter hook ingress device "eth0" priority filter; policy drop;
1538 ip daddr != @eth_ipv4_prefix drop
1539 accept
1540 }
1541 }</programlisting>
1542 </para>
1543
1544 <xi:include href="version-info.xml" xpointer="v255"/>
1545 </listitem>
1546 </varlistentry>
1547 </variablelist>
1548 </refsect1>
1549
1550 <refsect1>
1551 <title>[Neighbor] Section Options</title>
1552
1553 <para>A [Neighbor] section accepts the following keys. The neighbor section adds a permanent,
1554 static entry to the neighbor table (IPv6) or ARP table (IPv4) for the given hardware address on the
1555 links matched for the network. Specify several [Neighbor] sections to configure several static
1556 neighbors.</para>
1557
1558 <variablelist class='network-directives'>
1559 <varlistentry>
1560 <term><varname>Address=</varname></term>
1561 <listitem>
1562 <para>The IP address of the neighbor.</para>
1563
1564 <xi:include href="version-info.xml" xpointer="v240"/>
1565 </listitem>
1566 </varlistentry>
1567
1568 <varlistentry>
1569 <term><varname>LinkLayerAddress=</varname></term>
1570 <listitem>
1571 <para>The link layer address (MAC address or IP address) of the neighbor.</para>
1572
1573 <xi:include href="version-info.xml" xpointer="v243"/>
1574 </listitem>
1575 </varlistentry>
1576 </variablelist>
1577 </refsect1>
1578
1579 <refsect1>
1580 <title>[IPv6AddressLabel] Section Options</title>
1581
1582 <para>An [IPv6AddressLabel] section accepts the following keys. Specify several [IPv6AddressLabel]
1583 sections to configure several address labels. IPv6 address labels are used for address selection.
1584 See <ulink url="https://tools.ietf.org/html/rfc3484">RFC 3484</ulink>. Precedence is managed by
1585 userspace, and only the label itself is stored in the kernel.</para>
1586
1587 <variablelist class='network-directives'>
1588 <varlistentry>
1589 <term><varname>Label=</varname></term>
1590 <listitem>
1591 <para>The label for the prefix, an unsigned integer in the range 04294967294. 0xffffffff is
1592 reserved. This setting is mandatory.</para>
1593
1594 <xi:include href="version-info.xml" xpointer="v234"/>
1595 </listitem>
1596 </varlistentry>
1597
1598 <varlistentry>
1599 <term><varname>Prefix=</varname></term>
1600 <listitem>
1601 <para>IPv6 prefix is an address with a prefix length, separated by a slash
1602 <literal>/</literal> character. This setting is mandatory. </para>
1603
1604 <xi:include href="version-info.xml" xpointer="v234"/>
1605 </listitem>
1606 </varlistentry>
1607 </variablelist>
1608 </refsect1>
1609
1610 <refsect1>
1611 <title>[RoutingPolicyRule] Section Options</title>
1612
1613 <para>An [RoutingPolicyRule] section accepts the following settings. Specify several
1614 [RoutingPolicyRule] sections to configure several rules.</para>
1615
1616 <variablelist class='network-directives'>
1617 <varlistentry>
1618 <term><varname>TypeOfService=</varname></term>
1619 <listitem>
1620 <para>
1621 This specifies the Type of Service (ToS) field of packets to match;
1622 it takes an unsigned integer in the range 0255.
1623 The field can be used to specify precedence (the first 3 bits) and ToS (the next 3 bits).
1624 The field can be also used to specify Differentiated Services Code Point (DSCP) (the first 6 bits) and
1625 Explicit Congestion Notification (ECN) (the last 2 bits).
1626 See <ulink url="https://en.wikipedia.org/wiki/Type_of_service">Type of Service</ulink>
1627 and <ulink url="https://en.wikipedia.org/wiki/Differentiated_services">Differentiated services</ulink>
1628 for more details.
1629 </para>
1630
1631 <xi:include href="version-info.xml" xpointer="v235"/>
1632 </listitem>
1633 </varlistentry>
1634
1635 <varlistentry>
1636 <term><varname>From=</varname></term>
1637 <listitem>
1638 <para>Specifies the source address prefix to match. Possibly followed by a slash and the
1639 prefix length.</para>
1640
1641 <xi:include href="version-info.xml" xpointer="v235"/>
1642 </listitem>
1643 </varlistentry>
1644
1645 <varlistentry>
1646 <term><varname>To=</varname></term>
1647 <listitem>
1648 <para>Specifies the destination address prefix to match. Possibly followed by a slash and the
1649 prefix length.</para>
1650
1651 <xi:include href="version-info.xml" xpointer="v235"/>
1652 </listitem>
1653 </varlistentry>
1654
1655 <varlistentry>
1656 <term><varname>FirewallMark=</varname></term>
1657 <listitem>
1658 <para>Specifies the iptables firewall mark value to match (a number in the range
1659 14294967295). Optionally, the firewall mask (also a number between 14294967295) can be
1660 suffixed with a slash (<literal>/</literal>), e.g., <literal>7/255</literal>.</para>
1661
1662 <xi:include href="version-info.xml" xpointer="v235"/>
1663 </listitem>
1664 </varlistentry>
1665
1666 <varlistentry>
1667 <term><varname>Table=</varname></term>
1668 <listitem>
1669 <para>Specifies the routing table identifier to look up if the rule selector matches. Takes
1670 one of predefined names <literal>default</literal>, <literal>main</literal>, and
1671 <literal>local</literal>, and names defined in <varname>RouteTable=</varname> in
1672 <citerefentry><refentrytitle>networkd.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
1673 or a number between 1 and 4294967295. Defaults to <literal>main</literal>.</para>
1674
1675 <xi:include href="version-info.xml" xpointer="v235"/>
1676 </listitem>
1677 </varlistentry>
1678
1679 <varlistentry>
1680 <term><varname>Priority=</varname></term>
1681 <listitem>
1682 <para>Specifies the priority of this rule. <varname>Priority=</varname> is an integer in the
1683 range 04294967295. Higher number means lower priority, and rules get processed in order of
1684 increasing number. Defaults to unset, and the kernel will pick a value dynamically.</para>
1685
1686 <xi:include href="version-info.xml" xpointer="v235"/>
1687 </listitem>
1688 </varlistentry>
1689
1690 <varlistentry>
1691 <term><varname>IncomingInterface=</varname></term>
1692 <listitem>
1693 <para>Specifies incoming device to match. If the interface is loopback, the rule only matches
1694 packets originating from this host.</para>
1695
1696 <xi:include href="version-info.xml" xpointer="v236"/>
1697 </listitem>
1698 </varlistentry>
1699
1700 <varlistentry>
1701 <term><varname>OutgoingInterface=</varname></term>
1702 <listitem>
1703 <para>Specifies the outgoing device to match. The outgoing interface is only available for
1704 packets originating from local sockets that are bound to a device.</para>
1705
1706 <xi:include href="version-info.xml" xpointer="v236"/>
1707 </listitem>
1708 </varlistentry>
1709
1710 <varlistentry>
1711 <term><varname>L3MasterDevice=</varname></term>
1712 <listitem>
1713 <para>A boolean. Specifies whether the rule is to direct lookups to the tables associated with
1714 level 3 master devices (also known as Virtual Routing and Forwarding or VRF devices).
1715 For further details see <ulink url="https://docs.kernel.org/networking/vrf.html">
1716 Virtual Routing and Forwarding (VRF)</ulink>. Defaults to false.</para>
1717
1718 <xi:include href="version-info.xml" xpointer="v256"/>
1719 </listitem>
1720 </varlistentry>
1721
1722 <varlistentry>
1723 <term><varname>SourcePort=</varname></term>
1724 <listitem>
1725 <para>Specifies the source IP port or IP port range match in forwarding information base
1726 (FIB) rules. A port range is specified by the lower and upper port separated by a dash.
1727 Defaults to unset.</para>
1728
1729 <xi:include href="version-info.xml" xpointer="v240"/>
1730 </listitem>
1731 </varlistentry>
1732
1733 <varlistentry>
1734 <term><varname>DestinationPort=</varname></term>
1735 <listitem>
1736 <para>Specifies the destination IP port or IP port range match in forwarding information base
1737 (FIB) rules. A port range is specified by the lower and upper port separated by a dash.
1738 Defaults to unset.</para>
1739
1740 <xi:include href="version-info.xml" xpointer="v240"/>
1741 </listitem>
1742 </varlistentry>
1743
1744 <varlistentry>
1745 <term><varname>IPProtocol=</varname></term>
1746 <listitem>
1747 <para>Specifies the IP protocol to match in forwarding information base (FIB) rules. Takes IP
1748 protocol name such as <literal>tcp</literal>, <literal>udp</literal> or
1749 <literal>sctp</literal>, or IP protocol number such as <literal>6</literal> for
1750 <literal>tcp</literal> or <literal>17</literal> for <literal>udp</literal>. Defaults to unset.
1751 </para>
1752
1753 <xi:include href="version-info.xml" xpointer="v240"/>
1754 </listitem>
1755 </varlistentry>
1756
1757 <varlistentry>
1758 <term><varname>InvertRule=</varname></term>
1759 <listitem>
1760 <para>A boolean. Specifies whether the rule is to be inverted. Defaults to false.</para>
1761
1762 <xi:include href="version-info.xml" xpointer="v240"/>
1763 </listitem>
1764 </varlistentry>
1765
1766 <varlistentry>
1767 <term><varname>Family=</varname></term>
1768 <listitem>
1769 <para>Takes a special value <literal>ipv4</literal>, <literal>ipv6</literal>, or
1770 <literal>both</literal>. By default, the address family is determined by the address
1771 specified in <varname>To=</varname> or <varname>From=</varname>. If neither
1772 <varname>To=</varname> nor <varname>From=</varname> are specified, then defaults to
1773 <literal>ipv4</literal>.</para>
1774
1775 <xi:include href="version-info.xml" xpointer="v243"/>
1776 </listitem>
1777 </varlistentry>
1778
1779 <varlistentry>
1780 <term><varname>User=</varname></term>
1781 <listitem>
1782 <para>Takes a username, a user ID, or a range of user IDs separated by a dash. Defaults to
1783 unset.</para>
1784
1785 <xi:include href="version-info.xml" xpointer="v245"/>
1786 </listitem>
1787 </varlistentry>
1788
1789 <varlistentry>
1790 <term><varname>SuppressPrefixLength=</varname></term>
1791 <listitem>
1792 <para>Takes a number <replaceable>N</replaceable> in the range 0128 and rejects routing
1793 decisions that have a prefix length of <replaceable>N</replaceable> or less. Defaults to
1794 unset.</para>
1795
1796 <xi:include href="version-info.xml" xpointer="v245"/>
1797 </listitem>
1798 </varlistentry>
1799
1800 <varlistentry>
1801 <term><varname>SuppressInterfaceGroup=</varname></term>
1802 <listitem>
1803 <para>Takes an integer in the range 02147483647 and rejects routing decisions that have
1804 an interface with the same group id. It has the same meaning as
1805 <option>suppress_ifgroup</option> in <command>ip rule</command>. Defaults to unset.</para>
1806
1807 <xi:include href="version-info.xml" xpointer="v250"/>
1808 </listitem>
1809 </varlistentry>
1810
1811 <varlistentry>
1812 <term><varname>Type=</varname></term>
1813 <listitem>
1814 <para>Specifies Routing Policy Database (RPDB) rule type. Takes one of
1815 <literal>blackhole</literal>, <literal>unreachable</literal> or <literal>prohibit</literal>.
1816 </para>
1817
1818 <xi:include href="version-info.xml" xpointer="v248"/>
1819 </listitem>
1820 </varlistentry>
1821 </variablelist>
1822 </refsect1>
1823
1824 <refsect1>
1825 <title>[NextHop] Section Options</title>
1826
1827 <para>The [NextHop] section is used to manipulate entries in the kernel's "nexthop" tables. The
1828 [NextHop] section accepts the following settings. Specify several [NextHop] sections to configure
1829 several hops.</para>
1830
1831 <variablelist class='network-directives'>
1832 <varlistentry>
1833 <term><varname>Id=</varname></term>
1834 <listitem>
1835 <para>The id of the next hop. Takes an integer in the range 14294967295.
1836 This is mandatory if <varname>ManageForeignNextHops=no</varname> is specified in
1837 <citerefentry><refentrytitle>networkd.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
1838 Otherwise, if unspecified, an unused ID will be automatically picked.</para>
1839
1840 <xi:include href="version-info.xml" xpointer="v244"/>
1841 </listitem>
1842 </varlistentry>
1843
1844 <varlistentry>
1845 <term><varname>Gateway=</varname></term>
1846 <listitem>
1847 <para>As in the [Network] section.</para>
1848
1849 <xi:include href="version-info.xml" xpointer="v244"/>
1850 </listitem>
1851 </varlistentry>
1852
1853 <varlistentry>
1854 <term><varname>Family=</varname></term>
1855 <listitem>
1856 <para>Takes one of the special values <literal>ipv4</literal> or <literal>ipv6</literal>.
1857 By default, the family is determined by the address specified in
1858 <varname>Gateway=</varname>. If <varname>Gateway=</varname> is not specified, then defaults
1859 to <literal>ipv4</literal>.</para>
1860
1861 <xi:include href="version-info.xml" xpointer="v248"/>
1862 </listitem>
1863 </varlistentry>
1864
1865 <varlistentry>
1866 <term><varname>OnLink=</varname></term>
1867 <listitem>
1868 <para>Takes a boolean. If set to true, the kernel does not have to check if the gateway is
1869 reachable directly by the current machine (i.e., attached to the local network), so that we
1870 can insert the nexthop in the kernel table without it being complained about. Defaults to
1871 <literal>no</literal>.</para>
1872
1873 <xi:include href="version-info.xml" xpointer="v248"/>
1874 </listitem>
1875 </varlistentry>
1876
1877 <varlistentry>
1878 <term><varname>Blackhole=</varname></term>
1879 <listitem>
1880 <para>Takes a boolean. If enabled, packets to the corresponding routes are discarded
1881 silently, and <varname>Gateway=</varname> cannot be specified. Defaults to
1882 <literal>no</literal>.</para>
1883
1884 <xi:include href="version-info.xml" xpointer="v248"/>
1885 </listitem>
1886 </varlistentry>
1887
1888 <varlistentry>
1889 <term><varname>Group=</varname></term>
1890 <listitem>
1891 <para>Takes a whitespace separated list of nexthop IDs. Each ID must be in the range
1892 14294967295. Optionally, each nexthop ID can take a weight after a colon
1893 (<literal><replaceable>id</replaceable><optional>:<replaceable>weight</replaceable></optional></literal>).
1894 The weight must be in the range 1255. If the weight is not specified, then it is assumed
1895 that the weight is 1. This setting cannot be specified with <varname>Gateway=</varname>,
1896 <varname>Family=</varname>, <varname>Blackhole=</varname>. This setting can be specified
1897 multiple times. If an empty string is assigned, then the all previous assignments are
1898 cleared. Defaults to unset.</para>
1899
1900 <xi:include href="version-info.xml" xpointer="v249"/>
1901 </listitem>
1902 </varlistentry>
1903 </variablelist>
1904 </refsect1>
1905
1906 <refsect1>
1907 <title>[Route] Section Options</title>
1908
1909 <para>The [Route] section accepts the following settings. Specify several [Route] sections to
1910 configure several routes.</para>
1911
1912 <variablelist class='network-directives'>
1913 <varlistentry>
1914 <term><varname>Gateway=</varname></term>
1915 <listitem>
1916 <para>Takes the gateway address or the special values <literal>_dhcp4</literal> and
1917 <literal>_ipv6ra</literal>. If <literal>_dhcp4</literal> or <literal>_ipv6ra</literal> is
1918 set, then the gateway address provided by DHCPv4 or IPv6 RA is used.</para>
1919
1920 <xi:include href="version-info.xml" xpointer="v211"/>
1921 </listitem>
1922 </varlistentry>
1923
1924 <varlistentry>
1925 <term><varname>GatewayOnLink=</varname></term>
1926 <listitem>
1927 <para>Takes a boolean. If set to true, the kernel does not have to check if the gateway is
1928 reachable directly by the current machine (i.e., attached to the local network), so that we
1929 can insert the route in the kernel table without it being complained about. Defaults to
1930 <literal>no</literal>.</para>
1931
1932 <xi:include href="version-info.xml" xpointer="v234"/>
1933 </listitem>
1934 </varlistentry>
1935
1936 <varlistentry>
1937 <term><varname>Destination=</varname></term>
1938 <listitem>
1939 <para>The destination prefix of the route. Possibly followed by a slash and the prefix
1940 length. If omitted, a full-length host route is assumed.</para>
1941
1942 <xi:include href="version-info.xml" xpointer="v211"/>
1943 </listitem>
1944 </varlistentry>
1945
1946 <varlistentry>
1947 <term><varname>Source=</varname></term>
1948 <listitem>
1949 <para>The source prefix of the route. Possibly followed by a slash and the prefix length. If
1950 omitted, a full-length host route is assumed.</para>
1951
1952 <xi:include href="version-info.xml" xpointer="v218"/>
1953 </listitem>
1954 </varlistentry>
1955
1956 <varlistentry>
1957 <term><varname>Metric=</varname></term>
1958 <listitem>
1959 <para>The metric of the route. Takes an unsigned integer in the range 04294967295. Defaults
1960 to unset, and the kernel's default will be used.</para>
1961
1962 <xi:include href="version-info.xml" xpointer="v216"/>
1963 </listitem>
1964 </varlistentry>
1965
1966 <varlistentry>
1967 <term><varname>IPv6Preference=</varname></term>
1968 <listitem>
1969 <para>Specifies the route preference as defined in
1970 <ulink url="https://tools.ietf.org/html/rfc4191">RFC 4191</ulink> for Router Discovery
1971 messages. Which can be one of <literal>low</literal> the route has a lowest priority,
1972 <literal>medium</literal> the route has a default priority or <literal>high</literal> the
1973 route has a highest priority.</para>
1974
1975 <xi:include href="version-info.xml" xpointer="v234"/>
1976 </listitem>
1977 </varlistentry>
1978
1979 <varlistentry>
1980 <term><varname>Scope=</varname></term>
1981 <listitem>
1982 <para>The scope of the IPv4 route, which can be <literal>global</literal>,
1983 <literal>site</literal>, <literal>link</literal>, <literal>host</literal>, or
1984 <literal>nowhere</literal>:</para>
1985 <itemizedlist>
1986 <listitem>
1987 <para><literal>global</literal> means the route can reach hosts more than one hop away.
1988 </para>
1989 </listitem>
1990
1991 <listitem>
1992 <para><literal>site</literal> means an interior route in the local autonomous system.
1993 </para>
1994 </listitem>
1995
1996 <listitem>
1997 <para><literal>link</literal> means the route can only reach hosts on the local network
1998 (one hop away).</para>
1999 </listitem>
2000
2001 <listitem>
2002 <para><literal>host</literal> means the route will not leave the local machine (used for
2003 internal addresses like 127.0.0.1).</para>
2004 </listitem>
2005
2006 <listitem>
2007 <para><literal>nowhere</literal> means the destination doesn't exist.</para>
2008 </listitem>
2009 </itemizedlist>
2010
2011 <para>For IPv4 route, defaults to <literal>host</literal> if <varname>Type=</varname> is
2012 <literal>local</literal> or <literal>nat</literal>, and <literal>link</literal> if
2013 <varname>Type=</varname> is <literal>broadcast</literal>, <literal>multicast</literal>,
2014 <literal>anycast</literal>, or <literal>unicast</literal>. In other cases,
2015 defaults to <literal>global</literal>. The value is not used for IPv6.</para>
2016
2017 <xi:include href="version-info.xml" xpointer="v219"/>
2018 </listitem>
2019 </varlistentry>
2020
2021 <varlistentry>
2022 <term><varname>PreferredSource=</varname></term>
2023 <listitem>
2024 <para>The preferred source address of the route. The address must be in the format described
2025 in
2026 <citerefentry project='man-pages'><refentrytitle>inet_pton</refentrytitle><manvolnum>3</manvolnum></citerefentry>.
2027 </para>
2028
2029 <xi:include href="version-info.xml" xpointer="v227"/>
2030 </listitem>
2031 </varlistentry>
2032
2033 <varlistentry>
2034 <term><varname>Table=</varname></term>
2035 <listitem>
2036 <para>The table identifier for the route. Takes one of predefined names
2037 <literal>default</literal>, <literal>main</literal>, and <literal>local</literal>, and names
2038 defined in <varname>RouteTable=</varname> in
2039 <citerefentry><refentrytitle>networkd.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
2040 or a number between 1 and 4294967295. The table can be retrieved using
2041 <command>ip route show table <replaceable>num</replaceable></command>. If unset and
2042 <varname>Type=</varname> is <literal>local</literal>, <literal>broadcast</literal>,
2043 <literal>anycast</literal>, or <literal>nat</literal>, then <literal>local</literal> is used.
2044 In other cases, defaults to <literal>main</literal>. Ignored if <varname>L3MasterDevice=</varname> is true.</para>
2045
2046 <xi:include href="version-info.xml" xpointer="v230"/>
2047 </listitem>
2048 </varlistentry>
2049
2050 <varlistentry>
2051 <term><varname>HopLimit=</varname></term>
2052 <listitem>
2053 <para>Configures per route hop limit. Takes an integer in the range 1255. See also
2054 <varname>IPv6HopLimit=</varname>.</para>
2055
2056 <xi:include href="version-info.xml" xpointer="v255"/>
2057 </listitem>
2058 </varlistentry>
2059
2060 <varlistentry>
2061 <term><varname>Protocol=</varname></term>
2062 <listitem>
2063 <para>The protocol identifier for the route. Takes a number between 0 and 255 or the special
2064 values <literal>kernel</literal>, <literal>boot</literal>, <literal>static</literal>,
2065 <literal>ra</literal> and <literal>dhcp</literal>. Defaults to <literal>static</literal>.
2066 </para>
2067
2068 <xi:include href="version-info.xml" xpointer="v234"/>
2069 </listitem>
2070 </varlistentry>
2071
2072 <varlistentry>
2073 <term><varname>Type=</varname></term>
2074 <listitem>
2075 <para>Specifies the type for the route. Takes one of <literal>unicast</literal>,
2076 <literal>local</literal>, <literal>broadcast</literal>, <literal>anycast</literal>,
2077 <literal>multicast</literal>, <literal>blackhole</literal>, <literal>unreachable</literal>,
2078 <literal>prohibit</literal>, <literal>throw</literal>, <literal>nat</literal>, and
2079 <literal>xresolve</literal>. If <literal>unicast</literal>, a regular route is defined, i.e.
2080 a route indicating the path to take to a destination network address. If
2081 <literal>blackhole</literal>, packets to the defined route are discarded silently. If
2082 <literal>unreachable</literal>, packets to the defined route are discarded and the ICMP
2083 message "Host Unreachable" is generated. If <literal>prohibit</literal>, packets to the
2084 defined route are discarded and the ICMP message "Communication Administratively Prohibited"
2085 is generated. If <literal>throw</literal>, route lookup in the current routing table will
2086 fail and the route selection process will return to Routing Policy Database (RPDB). Defaults
2087 to <literal>unicast</literal>.</para>
2088
2089 <xi:include href="version-info.xml" xpointer="v235"/>
2090 </listitem>
2091 </varlistentry>
2092
2093 <varlistentry>
2094 <term><varname>InitialCongestionWindow=</varname></term>
2095 <listitem>
2096 <para>The TCP initial congestion window is used during the start of a TCP connection.
2097 During the start of a TCP session, when a client requests a resource, the server's initial
2098 congestion window determines how many packets will be sent during the initial burst of data
2099 without waiting for acknowledgement. Takes a number between 1 and 1023. Note that 100 is
2100 considered an extremely large value for this option. When unset, the kernel's default
2101 (typically 10) will be used.</para>
2102
2103 <xi:include href="version-info.xml" xpointer="v237"/>
2104 </listitem>
2105 </varlistentry>
2106
2107 <varlistentry>
2108 <term><varname>InitialAdvertisedReceiveWindow=</varname></term>
2109 <listitem>
2110 <para>The TCP initial advertised receive window is the amount of receive data (in bytes)
2111 that can initially be buffered at one time on a connection. The sending host can send only
2112 that amount of data before waiting for an acknowledgment and window update from the
2113 receiving host. Takes a number between 1 and 1023. Note that 100 is considered an extremely
2114 large value for this option. When unset, the kernel's default will be used.</para>
2115
2116 <xi:include href="version-info.xml" xpointer="v237"/>
2117 </listitem>
2118 </varlistentry>
2119
2120 <varlistentry>
2121 <term><varname>QuickAck=</varname></term>
2122 <listitem>
2123 <para>Takes a boolean. When true, the TCP quick ACK mode for the route is enabled. When unset,
2124 the kernel's default will be used.</para>
2125
2126 <xi:include href="version-info.xml" xpointer="v237"/>
2127 </listitem>
2128 </varlistentry>
2129
2130 <varlistentry>
2131 <term><varname>FastOpenNoCookie=</varname></term>
2132 <listitem>
2133 <para>Takes a boolean. When true enables TCP fastopen without a cookie on a per-route basis.
2134 When unset, the kernel's default will be used.</para>
2135
2136 <xi:include href="version-info.xml" xpointer="v243"/>
2137 </listitem>
2138 </varlistentry>
2139
2140 <varlistentry>
2141 <term><varname>MTUBytes=</varname></term>
2142 <listitem>
2143 <para>The maximum transmission unit in bytes to set for the route. The usual suffixes K, M,
2144 G, are supported and are understood to the base of 1024.</para>
2145
2146 <xi:include href="version-info.xml" xpointer="v239"/>
2147 </listitem>
2148 </varlistentry>
2149
2150 <varlistentry>
2151 <term><varname>TCPAdvertisedMaximumSegmentSize=</varname></term>
2152 <listitem>
2153 <para>Specifies the Path MSS (in bytes) hints given on TCP layer. The usual suffixes K, M, G,
2154 are supported and are understood to the base of 1024. An unsigned integer in the range
2155 14294967294. When unset, the kernel's default will be used.</para>
2156
2157 <xi:include href="version-info.xml" xpointer="v248"/>
2158 </listitem>
2159 </varlistentry>
2160
2161 <varlistentry>
2162 <term><varname>TCPCongestionControlAlgorithm=</varname></term>
2163 <listitem>
2164 <para>Specifies the TCP congestion control algorithm for the route. Takes a name of the algorithm,
2165 e.g. <literal>bbr</literal>, <literal>dctcp</literal>, or <literal>vegas</literal>. When unset,
2166 the kernel's default will be used.</para>
2167
2168 <xi:include href="version-info.xml" xpointer="v252"/>
2169 </listitem>
2170 </varlistentry>
2171
2172 <varlistentry>
2173 <term><varname>TCPRetransmissionTimeoutSec=</varname></term>
2174 <listitem>
2175 <para>Specifies the TCP Retransmission Timeout (RTO) for the route. Takes time values in seconds.
2176 This value specifies the timeout of an alive TCP connection, when retransmissions remain
2177 unacknowledged. When unset, the kernel's default will be used.</para>
2178
2179 <xi:include href="version-info.xml" xpointer="v255"/>
2180 </listitem>
2181 </varlistentry>
2182
2183 <varlistentry>
2184 <term><varname>MultiPathRoute=<replaceable>address</replaceable>[@<replaceable>name</replaceable>] [<replaceable>weight</replaceable>]</varname></term>
2185 <listitem>
2186 <para>Configures multipath route. Multipath routing is the technique of using multiple
2187 alternative paths through a network. Takes gateway address. Optionally, takes a network
2188 interface name or index separated with <literal>@</literal>, and a weight in 1..256 for this
2189 multipath route separated with whitespace. This setting can be specified multiple times. If
2190 an empty string is assigned, then the all previous assignments are cleared.</para>
2191
2192 <xi:include href="version-info.xml" xpointer="v245"/>
2193 </listitem>
2194 </varlistentry>
2195
2196 <varlistentry>
2197 <term><varname>NextHop=</varname></term>
2198 <listitem>
2199 <para>Specifies the nexthop id. Takes an unsigned integer in the range 14294967295. If set,
2200 the corresponding [NextHop] section must be configured. Defaults to unset.</para>
2201
2202 <xi:include href="version-info.xml" xpointer="v248"/>
2203 </listitem>
2204 </varlistentry>
2205 </variablelist>
2206 </refsect1>
2207
2208 <refsect1>
2209 <title>[DHCPv4] Section Options</title>
2210
2211 <para>The [DHCPv4] section configures the DHCPv4 client, if it is enabled with the
2212 <varname>DHCP=</varname> setting described above:</para>
2213
2214 <variablelist class='network-directives'>
2215
2216 <!-- DHCP packet contents -->
2217
2218 <varlistentry>
2219 <term><varname>RequestAddress=</varname></term>
2220 <listitem>
2221 <para>Takes an IPv4 address. When specified, the Requested IP Address option (option code 50) is
2222 added with it to the initial DHCPDISCOVER message sent by the DHCP client. Defaults to unset, and
2223 an already assigned dynamic address to the interface is automatically picked.</para>
2224
2225 <xi:include href="version-info.xml" xpointer="v255"/>
2226 </listitem>
2227 </varlistentry>
2228
2229 <varlistentry>
2230 <term><varname>SendHostname=</varname></term>
2231 <listitem>
2232 <para>When true (the default), the machine's hostname (or the value specified with
2233 <varname>Hostname=</varname>, described below) will be sent to the DHCP server. Note that the
2234 hostname must consist only of 7-bit ASCII lower-case characters and no spaces or dots, and be
2235 formatted as a valid DNS domain name. Otherwise, the hostname is not sent even if this option
2236 is true.</para>
2237
2238 <xi:include href="version-info.xml" xpointer="v215"/>
2239 </listitem>
2240 </varlistentry>
2241
2242 <varlistentry>
2243 <term><varname>Hostname=</varname></term>
2244 <listitem>
2245 <para>Use this value for the hostname which is sent to the DHCP server, instead of machine's
2246 hostname. Note that the specified hostname must consist only of 7-bit ASCII lower-case
2247 characters and no spaces or dots, and be formatted as a valid DNS domain name.</para>
2248
2249 <xi:include href="version-info.xml" xpointer="v223"/>
2250 </listitem>
2251 </varlistentry>
2252
2253 <varlistentry>
2254 <term><varname>MUDURL=</varname></term>
2255 <listitem>
2256 <para>When configured, the specified Manufacturer Usage Description (MUD) URL will be sent
2257 to the DHCPv4 server. Takes a URL of length up to 255 characters. A superficial verification
2258 that the string is a valid URL will be performed. DHCPv4 clients are intended to have at most
2259 one MUD URL associated with them. See
2260 <ulink url="https://tools.ietf.org/html/rfc8520">RFC 8520</ulink>.</para>
2261
2262 <para>MUD is an embedded software standard defined by the IETF that allows IoT device makers
2263 to advertise device specifications, including the intended communication patterns for their
2264 device when it connects to the network. The network can then use this to author a
2265 context-specific access policy, so the device functions only within those parameters.</para>
2266
2267 <xi:include href="version-info.xml" xpointer="v246"/>
2268 </listitem>
2269 </varlistentry>
2270
2271 <varlistentry>
2272 <term><varname>ClientIdentifier=</varname></term>
2273 <listitem>
2274 <para>The DHCPv4 client identifier to use. Takes one of <option>mac</option> or
2275 <option>duid</option>. If set to <option>mac</option>, the MAC address of the link is used. If set
2276 to <option>duid</option>, an RFC4361-compliant Client ID, which is the combination of IAID and
2277 DUID, is used. IAID can be configured by <varname>IAID=</varname>. DUID can be configured by
2278 <varname>DUIDType=</varname> and <varname>DUIDRawData=</varname>. Defaults to
2279 <option>duid</option>.</para>
2280
2281 <xi:include href="version-info.xml" xpointer="v220"/>
2282 </listitem>
2283 </varlistentry>
2284
2285 <varlistentry>
2286 <term><varname>VendorClassIdentifier=</varname></term>
2287 <listitem>
2288 <para>The vendor class identifier used to identify vendor type and configuration.</para>
2289
2290 <xi:include href="version-info.xml" xpointer="v216"/>
2291 </listitem>
2292 </varlistentry>
2293
2294 <varlistentry>
2295 <term><varname>UserClass=</varname></term>
2296 <listitem>
2297 <para>A DHCPv4 client can use UserClass option to identify the type or category of user or
2298 applications it represents. The information contained in this option is a string that
2299 represents the user class of which the client is a member. Each class sets an identifying
2300 string of information to be used by the DHCP service to classify clients. Takes a
2301 whitespace-separated list of strings.</para>
2302
2303 <xi:include href="version-info.xml" xpointer="v239"/>
2304 </listitem>
2305 </varlistentry>
2306
2307 <varlistentry>
2308 <term><varname>DUIDType=</varname></term>
2309 <listitem>
2310 <para>Override the global <varname>DUIDType=</varname> setting for this network. See
2311 <citerefentry><refentrytitle>networkd.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>
2312 for a description of possible values.</para>
2313
2314 <xi:include href="version-info.xml" xpointer="v230"/>
2315 </listitem>
2316 </varlistentry>
2317
2318 <varlistentry>
2319 <term><varname>DUIDRawData=</varname></term>
2320 <listitem>
2321 <para>Override the global <varname>DUIDRawData=</varname> setting for this network. See
2322 <citerefentry><refentrytitle>networkd.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>
2323 for a description of possible values.</para>
2324
2325 <xi:include href="version-info.xml" xpointer="v230"/>
2326 </listitem>
2327 </varlistentry>
2328
2329 <varlistentry>
2330 <term><varname>IAID=</varname></term>
2331 <listitem>
2332 <para>The DHCP Identity Association Identifier (IAID) for the interface, a 32-bit unsigned
2333 integer.</para>
2334
2335 <xi:include href="version-info.xml" xpointer="v230"/>
2336 </listitem>
2337 </varlistentry>
2338
2339 <varlistentry>
2340 <term><varname>RapidCommit=</varname></term>
2341 <listitem>
2342 <para>Takes a boolean. The DHCPv4 client can obtain configuration parameters from a DHCPv4 server
2343 through a rapid two-message exchange (discover and ack). When the rapid commit option is set by
2344 both the DHCPv4 client and the DHCPv4 server, the two-message exchange is used. Otherwise, the
2345 four-message exchange (discover, offer, request, and ack) is used. The two-message exchange
2346 provides faster client configuration. See
2347 <ulink url="https://tools.ietf.org/html/rfc4039">RFC 4039</ulink> for details.
2348 Defaults to true when <varname>Anonymize=no</varname> and neither <varname>AllowList=</varname>
2349 nor <varname>DenyList=</varname> is specified, and false otherwise.</para>
2350
2351 <xi:include href="version-info.xml" xpointer="v255"/>
2352 </listitem>
2353 </varlistentry>
2354
2355 <varlistentry>
2356 <term><varname>Anonymize=</varname></term>
2357 <listitem>
2358 <para>Takes a boolean. When true, the options sent to the DHCP server will follow the
2359 <ulink url="https://tools.ietf.org/html/rfc7844">RFC 7844</ulink> (Anonymity Profiles for
2360 DHCP Clients) to minimize disclosure of identifying information. Defaults to false.</para>
2361
2362 <para>This option should only be set to true when <varname>MACAddressPolicy=</varname> is set
2363 to <option>random</option> (see
2364 <citerefentry><refentrytitle>systemd.link</refentrytitle><manvolnum>5</manvolnum></citerefentry>).
2365 </para>
2366
2367 <para>When true,
2368 <varname>ClientIdentifier=mac</varname>,
2369 <varname>RapidCommit=no</varname>,
2370 <varname>SendHostname=no</varname>,
2371 <varname>Use6RD=no</varname>,
2372 <varname>UseCaptivePortal=no</varname>,
2373 <varname>UseMTU=no</varname>,
2374 <varname>UseNTP=no</varname>,
2375 <varname>UseSIP=no</varname>, and
2376 <varname>UseTimezone=no</varname>
2377 are implied and these settings in the .network file are silently ignored. Also,
2378 <varname>Hostname=</varname>,
2379 <varname>MUDURL=</varname>,
2380 <varname>RequestAddress=</varname>,
2381 <varname>RequestOptions=</varname>,
2382 <varname>SendOption=</varname>,
2383 <varname>SendVendorOption=</varname>,
2384 <varname>UserClass=</varname>, and
2385 <varname>VendorClassIdentifier=</varname>
2386 are silently ignored.</para>
2387
2388 <para>With this option enabled DHCP requests will mimic those generated by Microsoft
2389 Windows, in order to reduce the ability to fingerprint and recognize installations. This
2390 means DHCP request sizes will grow and lease data will be more comprehensive than normally,
2391 though most of the requested data is not actually used.</para>
2392
2393 <xi:include href="version-info.xml" xpointer="v235"/>
2394 </listitem>
2395 </varlistentry>
2396
2397 <varlistentry>
2398 <term><varname>RequestOptions=</varname></term>
2399 <listitem>
2400 <para>Sets request options to be sent to the server in the DHCPv4 request options list. A
2401 whitespace-separated list of integers in the range 1254. Defaults to unset.</para>
2402
2403 <xi:include href="version-info.xml" xpointer="v244"/>
2404 </listitem>
2405 </varlistentry>
2406
2407 <varlistentry>
2408 <term><varname>SendOption=</varname></term>
2409 <listitem>
2410 <para>Send an arbitrary raw option in the DHCPv4 request. Takes a DHCP option number, data
2411 type and data separated with a colon
2412 (<literal><replaceable>option</replaceable>:<replaceable>type</replaceable>:<replaceable>value</replaceable></literal>).
2413 The option number must be an integer in the range 1254. The type takes one of
2414 <literal>uint8</literal>, <literal>uint16</literal>, <literal>uint32</literal>,
2415 <literal>ipv4address</literal>, or <literal>string</literal>. Special characters in the data
2416 string may be escaped using
2417 <ulink url="https://en.wikipedia.org/wiki/Escape_sequences_in_C#Table_of_escape_sequences">C-style
2418 escapes</ulink>. This setting can be specified multiple times. If an empty string is
2419 specified, then all options specified earlier are cleared. Defaults to unset.</para>
2420
2421 <xi:include href="version-info.xml" xpointer="v244"/>
2422 </listitem>
2423 </varlistentry>
2424
2425 <varlistentry>
2426 <term><varname>SendVendorOption=</varname></term>
2427 <listitem>
2428 <para>Send an arbitrary vendor option in the DHCPv4 request. Takes a DHCP option number, data
2429 type and data separated with a colon
2430 (<literal><replaceable>option</replaceable>:<replaceable>type</replaceable>:<replaceable>value</replaceable></literal>).
2431 The option number must be an integer in the range 1254. The type takes one of
2432 <literal>uint8</literal>, <literal>uint16</literal>, <literal>uint32</literal>,
2433 <literal>ipv4address</literal>, or <literal>string</literal>. Special characters in the data
2434 string may be escaped using
2435 <ulink url="https://en.wikipedia.org/wiki/Escape_sequences_in_C#Table_of_escape_sequences">C-style
2436 escapes</ulink>. This setting can be specified multiple times. If an empty string is specified,
2437 then all options specified earlier are cleared. Defaults to unset.</para>
2438
2439 <xi:include href="version-info.xml" xpointer="v246"/>
2440 </listitem>
2441 </varlistentry>
2442
2443 <varlistentry>
2444 <term><varname>IPServiceType=</varname></term>
2445 <listitem>
2446 <para>Takes one of the special values <literal>none</literal>, <literal>CS6</literal>, or
2447 <literal>CS4</literal>. When <literal>none</literal> no IP service type is set to the packet
2448 sent from the DHCPv4 client. When <literal>CS6</literal> (network control) or
2449 <literal>CS4</literal> (realtime), the corresponding service type will be set. Defaults to
2450 <literal>CS6</literal>.</para>
2451
2452 <xi:include href="version-info.xml" xpointer="v244"/>
2453 </listitem>
2454 </varlistentry>
2455
2456 <varlistentry>
2457 <term><varname>SocketPriority=</varname></term>
2458 <listitem>
2459 <para>The Linux socket option <constant>SO_PRIORITY</constant> applied to the raw IP socket used for
2460 initial DHCPv4 messages. Unset by default. Usual values range from 0 to 6.
2461 More details about <constant>SO_PRIORITY</constant> socket option in
2462 <citerefentry project='man-pages'><refentrytitle>socket</refentrytitle><manvolnum>7</manvolnum></citerefentry>.
2463 Can be used in conjunction with [VLAN] section <varname>EgressQOSMaps=</varname> setting of .netdev
2464 file to set the 802.1Q VLAN ethernet tagged header priority, see
2465 <citerefentry><refentrytitle>systemd.netdev</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
2466 </para>
2467
2468 <xi:include href="version-info.xml" xpointer="v253"/>
2469 </listitem>
2470 </varlistentry>
2471
2472 <!-- How to use the DHCP lease -->
2473
2474 <varlistentry>
2475 <term><varname>Label=</varname></term>
2476 <listitem>
2477 <para>Specifies the label for the IPv4 address received from the DHCP server. The label must
2478 be a 7-bit ASCII string with a length of 115 characters. Defaults to unset.</para>
2479
2480 <xi:include href="version-info.xml" xpointer="v250"/>
2481 </listitem>
2482 </varlistentry>
2483
2484 <varlistentry>
2485 <term><varname>UseDNS=</varname></term>
2486 <listitem>
2487 <para>When true (the default), the DNS servers received from the DHCP server will be used.
2488 </para>
2489
2490 <para>This corresponds to the <option>nameserver</option> option in
2491 <citerefentry project='man-pages'><refentrytitle>resolv.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
2492 </para>
2493
2494 <xi:include href="version-info.xml" xpointer="v211"/>
2495 </listitem>
2496 </varlistentry>
2497
2498 <varlistentry>
2499 <term><varname>RoutesToDNS=</varname></term>
2500 <listitem>
2501 <para>When true, the routes to the DNS servers received from the DHCP server will be
2502 configured. When <varname>UseDNS=</varname> is disabled, this setting is ignored. Defaults to
2503 true.</para>
2504
2505 <xi:include href="version-info.xml" xpointer="v243"/>
2506 </listitem>
2507 </varlistentry>
2508
2509 <varlistentry>
2510 <term><varname>UseNTP=</varname></term>
2511 <listitem>
2512 <para>When true (the default), the NTP servers received from the DHCP server will be used by
2513 <filename>systemd-timesyncd.service</filename>.</para>
2514
2515 <xi:include href="version-info.xml" xpointer="v220"/>
2516 </listitem>
2517 </varlistentry>
2518
2519 <varlistentry>
2520 <term><varname>RoutesToNTP=</varname></term>
2521 <listitem>
2522 <para>When true, the routes to the NTP servers received from the DHCP server will be
2523 configured. When <varname>UseNTP=</varname> is disabled, this setting is ignored. Defaults to
2524 true.</para>
2525
2526 <xi:include href="version-info.xml" xpointer="v249"/>
2527 </listitem>
2528 </varlistentry>
2529
2530 <varlistentry>
2531 <term><varname>UseSIP=</varname></term>
2532 <listitem>
2533 <para>When true (the default), the SIP servers received from the DHCP server will be collected
2534 and made available to client programs.</para>
2535
2536 <xi:include href="version-info.xml" xpointer="v244"/>
2537 </listitem>
2538 </varlistentry>
2539
2540 <varlistentry>
2541 <term><varname>UseCaptivePortal=</varname></term>
2542 <listitem>
2543 <para>When true (the default), the captive portal advertised by the DHCP server will be recorded
2544 and made available to client programs and displayed in the
2545 <citerefentry><refentrytitle>networkctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>
2546 status output per-link.</para>
2547
2548 <xi:include href="version-info.xml" xpointer="v254"/>
2549 </listitem>
2550 </varlistentry>
2551
2552 <varlistentry>
2553 <term><varname>UseMTU=</varname></term>
2554 <listitem>
2555 <para>When true, the interface maximum transmission unit from the DHCP server will be used on
2556 the current link. If <varname>MTUBytes=</varname> is set, then this setting is ignored.
2557 Defaults to false.</para>
2558
2559 <para>Note, some drivers will reset the interfaces if the MTU is changed. For such
2560 interfaces, please try to use <varname>IgnoreCarrierLoss=</varname> with a short timespan,
2561 e.g. <literal>3 seconds</literal>.</para>
2562
2563 <xi:include href="version-info.xml" xpointer="v211"/>
2564 </listitem>
2565 </varlistentry>
2566
2567 <varlistentry>
2568 <term><varname>UseHostname=</varname></term>
2569 <listitem>
2570 <para>When true (the default), the hostname received from the DHCP server will be set as the
2571 transient hostname of the system.</para>
2572
2573 <xi:include href="version-info.xml" xpointer="v211"/>
2574 </listitem>
2575 </varlistentry>
2576
2577 <varlistentry>
2578 <term><varname>UseDomains=</varname></term>
2579 <listitem>
2580 <para>Takes a boolean, or the special value <option>route</option>. When true, the domain name
2581 received from the DHCP server will be used as DNS search domain over this link, similarly to the
2582 effect of the <option>Domains=</option> setting. If set to <option>route</option>, the domain name
2583 received from the DHCP server will be used for routing DNS queries only, but not for searching,
2584 similarly to the effect of the <option>Domains=</option> setting when the argument is prefixed with
2585 <literal>~</literal>.</para>
2586
2587 <para>When unspecified, the value specified in the same setting in the [Network] section will be
2588 used. When it is unspecified, the value specified in the same setting in the [DHCPv4] section in
2589 <citerefentry><refentrytitle>networkd.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>
2590 will be used. When it is unspecified, the value specified in the same setting in the [Network]
2591 section in
2592 <citerefentry><refentrytitle>networkd.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>
2593 will be used. When none of them are specified, defaults to <literal>no</literal>.</para>
2594
2595 <para>It is recommended to enable this option only on trusted networks, as setting this
2596 affects resolution of all hostnames, in particular of single-label names. It is generally
2597 safer to use the supplied domain only as routing domain, rather than as search domain, in
2598 order to not have it affect local resolution of single-label names.</para>
2599
2600 <para>When set to true, this setting corresponds to the <option>domain</option> option in
2601 <citerefentry project='man-pages'><refentrytitle>resolv.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
2602 </para>
2603
2604 <xi:include href="version-info.xml" xpointer="v216"/>
2605 </listitem>
2606 </varlistentry>
2607
2608 <varlistentry>
2609 <term><varname>UseRoutes=</varname></term>
2610 <listitem>
2611 <para>When true (the default), the static routes will be requested from the DHCP server and
2612 added to the routing table with a metric of 1024, and a scope of <option>global</option>,
2613 <option>link</option> or <option>host</option>, depending on the route's destination and
2614 gateway. If the destination is on the local host, e.g., 127.x.x.x, or the same as the link's
2615 own address, the scope will be set to <option>host</option>. Otherwise if the gateway is null
2616 (a direct route), a <option>link</option> scope will be used. For anything else, scope
2617 defaults to <option>global</option>.</para>
2618
2619 <xi:include href="version-info.xml" xpointer="v215"/>
2620 </listitem>
2621 </varlistentry>
2622
2623 <varlistentry>
2624 <term><varname>RouteMetric=</varname></term>
2625 <listitem>
2626 <para>Set the routing metric for routes specified by the DHCP server (including the prefix
2627 route added for the specified prefix). Takes an unsigned integer in the range 04294967295.
2628 Defaults to 1024.</para>
2629
2630 <xi:include href="version-info.xml" xpointer="v217"/>
2631 </listitem>
2632 </varlistentry>
2633
2634 <varlistentry>
2635 <term><varname>RouteTable=<replaceable>num</replaceable></varname></term>
2636 <listitem>
2637 <para>The table identifier for DHCP routes. Takes one of predefined names
2638 <literal>default</literal>, <literal>main</literal>, and <literal>local</literal>, and names
2639 defined in <varname>RouteTable=</varname> in
2640 <citerefentry><refentrytitle>networkd.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
2641 or a number between 14294967295.</para>
2642
2643 <para>When used in combination with <varname>VRF=</varname>, the VRF's routing table is
2644 used when this parameter is not specified.</para>
2645
2646 <xi:include href="version-info.xml" xpointer="v232"/>
2647 </listitem>
2648 </varlistentry>
2649
2650 <varlistentry>
2651 <term><varname>RouteMTUBytes=</varname></term>
2652 <listitem>
2653 <para>Specifies the MTU for the DHCP routes. Please see the [Route] section for further
2654 details.</para>
2655
2656 <xi:include href="version-info.xml" xpointer="v245"/>
2657 </listitem>
2658 </varlistentry>
2659
2660 <varlistentry>
2661 <term><varname>QuickAck=</varname></term>
2662 <listitem>
2663 <para>Takes a boolean. When true, the TCP quick ACK mode is enabled for the routes configured by
2664 the acquired DHCPv4 lease. When unset, the kernel's default will be used.</para>
2665
2666 <xi:include href="version-info.xml" xpointer="v253"/>
2667 </listitem>
2668 </varlistentry>
2669
2670 <varlistentry>
2671 <term><varname>InitialCongestionWindow=</varname></term>
2672 <listitem>
2673 <para>As in the [Route] section.</para>
2674
2675 <xi:include href="version-info.xml" xpointer="v255"/>
2676 </listitem>
2677 </varlistentry>
2678
2679 <varlistentry>
2680 <term><varname>InitialAdvertisedReceiveWindow=</varname></term>
2681 <listitem>
2682 <para>As in the [Route] section.</para>
2683
2684 <xi:include href="version-info.xml" xpointer="v255"/>
2685 </listitem>
2686 </varlistentry>
2687
2688 <varlistentry>
2689 <term><varname>UseGateway=</varname></term>
2690 <listitem>
2691 <para>When true, and the DHCP server provides a Router option, the default gateway based on the
2692 router address will be configured. Defaults to unset, and the value specified with
2693 <varname>UseRoutes=</varname> will be used.</para>
2694
2695 <para>Note, when the server provides both the Router and Classless Static Routes option, and
2696 <varname>UseRoutes=</varname> is enabled, the Router option is always ignored regardless of this
2697 setting. See <ulink url="https://datatracker.ietf.org/doc/html/rfc3442">RFC 3442</ulink>.</para>
2698
2699 <xi:include href="version-info.xml" xpointer="v246"/>
2700 </listitem>
2701 </varlistentry>
2702
2703 <varlistentry>
2704 <term><varname>UseTimezone=</varname></term>
2705 <listitem><para>When true, the timezone received from the DHCP server will be set as timezone
2706 of the local system. Defaults to false.</para>
2707
2708 <xi:include href="version-info.xml" xpointer="v226"/></listitem>
2709 </varlistentry>
2710
2711 <varlistentry>
2712 <term><varname>Use6RD=</varname></term>
2713 <listitem>
2714 <para>When true, subnets of the received IPv6 prefix are assigned to downstream interfaces
2715 which enables <varname>DHCPPrefixDelegation=</varname>. See also
2716 <varname>DHCPPrefixDelegation=</varname> in the [Network] section, the [DHCPPrefixDelegation]
2717 section, and <ulink url="https://tools.ietf.org/html/rfc5969">RFC 5969</ulink>. Defaults to
2718 false.</para>
2719
2720 <xi:include href="version-info.xml" xpointer="v250"/>
2721 </listitem>
2722 </varlistentry>
2723
2724 <varlistentry>
2725 <term><varname>IPv6OnlyMode=</varname></term>
2726 <listitem>
2727 <para>When true, the DHCPv4 configuration will be delayed by the timespan provided by the DHCP
2728 server and skip to configure dynamic IPv4 network connectivity if IPv6 connectivity is provided
2729 within the timespan. See <ulink url="https://tools.ietf.org/html/rfc8925">RFC 8925</ulink>.
2730 Defaults to false.</para>
2731
2732 <xi:include href="version-info.xml" xpointer="v255"/>
2733 </listitem>
2734 </varlistentry>
2735
2736 <varlistentry>
2737 <term><varname>FallbackLeaseLifetimeSec=</varname></term>
2738 <listitem>
2739 <para>Allows one to set DHCPv4 lease lifetime when DHCPv4 server does not send the lease
2740 lifetime. Takes one of <literal>forever</literal> or <literal>infinity</literal>. If
2741 specified, the acquired address never expires. Defaults to unset.</para>
2742
2743 <xi:include href="version-info.xml" xpointer="v246"/>
2744 </listitem>
2745 </varlistentry>
2746
2747 <!-- How to communicate with the server -->
2748
2749 <varlistentry>
2750 <term><varname>RequestBroadcast=</varname></term>
2751 <listitem>
2752 <para>Request the server to use broadcast messages before the IP address has been configured.
2753 This is necessary for devices that cannot receive RAW packets, or that cannot receive packets
2754 at all before an IP address has been configured. On the other hand, this must not be enabled
2755 on networks where broadcasts are filtered out.</para>
2756
2757 <xi:include href="version-info.xml" xpointer="v216"/>
2758 </listitem>
2759 </varlistentry>
2760
2761 <varlistentry>
2762 <term><varname>MaxAttempts=</varname></term>
2763 <listitem>
2764 <para>Specifies how many times the DHCPv4 client configuration should be attempted. Takes a
2765 number or <literal>infinity</literal>. Defaults to <literal>infinity</literal>. Note that the
2766 time between retries is increased exponentially, up to approximately one per minute, so the
2767 network will not be overloaded even if this number is high. The default is suitable in most
2768 circumstances.</para>
2769
2770 <xi:include href="version-info.xml" xpointer="v243"/>
2771 </listitem>
2772 </varlistentry>
2773
2774 <varlistentry>
2775 <term><varname>ListenPort=</varname></term>
2776 <listitem>
2777 <para>Set the port from which the DHCP client packets originate.</para>
2778
2779 <xi:include href="version-info.xml" xpointer="v233"/>
2780 </listitem>
2781 </varlistentry>
2782
2783 <varlistentry>
2784 <term><varname>ServerPort=</varname></term>
2785 <listitem>
2786 <para>Set the port on which the DHCP server is listening.</para>
2787
2788 <xi:include href="version-info.xml" xpointer="v256"/>
2789 </listitem>
2790 </varlistentry>
2791
2792 <varlistentry>
2793 <term><varname>DenyList=</varname></term>
2794 <listitem>
2795 <para>A whitespace-separated list of IPv4 addresses. Each address can optionally take a
2796 prefix length after <literal>/</literal>. DHCP offers from servers in the list are rejected.
2797 Note that if <varname>AllowList=</varname> is configured then <varname>DenyList=</varname> is
2798 ignored.</para>
2799 <para>Note that this filters only DHCP offers, so the filtering may not work when
2800 <varname>RapidCommit=</varname> is enabled. See also <varname>RapidCommit=</varname> in the above.
2801 </para>
2802
2803 <xi:include href="version-info.xml" xpointer="v246"/>
2804 </listitem>
2805 </varlistentry>
2806
2807 <varlistentry>
2808 <term><varname>AllowList=</varname></term>
2809 <listitem>
2810 <para>A whitespace-separated list of IPv4 addresses. Each address can optionally take a
2811 prefix length after <literal>/</literal>. DHCP offers from servers in the list are accepted.
2812 </para>
2813 <para>Note that this filters only DHCP offers, so the filtering may not work when
2814 <varname>RapidCommit=</varname> is enabled. See also <varname>RapidCommit=</varname> in the above.
2815 </para>
2816
2817 <xi:include href="version-info.xml" xpointer="v246"/>
2818 </listitem>
2819 </varlistentry>
2820
2821 <varlistentry>
2822 <term><varname>SendRelease=</varname></term>
2823 <listitem>
2824 <para>When true, the DHCPv4 client sends a DHCP release packet when it stops. Defaults to
2825 true.</para>
2826
2827 <xi:include href="version-info.xml" xpointer="v243"/>
2828 </listitem>
2829 </varlistentry>
2830
2831 <varlistentry>
2832 <term><varname>SendDecline=</varname></term>
2833 <listitem>
2834 <para>A boolean. When true, <command>systemd-networkd</command> performs IPv4 Duplicate
2835 Address Detection to the acquired address by the DHCPv4 client. If duplicate is detected,
2836 the DHCPv4 client rejects the address by sending a <constant>DHCPDECLINE</constant> packet to
2837 the DHCP server, and tries to obtain an IP address again. See
2838 <ulink url="https://tools.ietf.org/html/rfc5227">RFC 5227</ulink>. Defaults to false.</para>
2839
2840 <xi:include href="version-info.xml" xpointer="v245"/>
2841 </listitem>
2842 </varlistentry>
2843
2844 <varlistentry>
2845 <term><varname>NetLabel=</varname></term>
2846 <listitem>
2847 <para>This applies the NetLabel for the addresses received with DHCP, like
2848 <varname>NetLabel=</varname> in [Address] section applies it to statically configured
2849 addresses. See <varname>NetLabel=</varname> in [Address] section for more details.</para>
2850
2851 <xi:include href="version-info.xml" xpointer="v252"/>
2852 </listitem>
2853 </varlistentry>
2854
2855 <varlistentry>
2856 <term><varname>NFTSet=</varname></term>
2857 <listitem>
2858 <para>This applies the NFT set for the network configuration received with DHCP, like
2859 <varname>NFTSet=</varname> in [Address] section applies it to static configuration. See
2860 <varname>NFTSet=</varname> in [Address] section for more details. For <literal>address</literal> or
2861 <literal>prefix</literal> source types, the type of the element used in the NFT filter must be
2862 <literal>ipv4_addr</literal>.</para>
2863
2864 <xi:include href="version-info.xml" xpointer="v255"/>
2865 </listitem>
2866 </varlistentry>
2867 </variablelist>
2868 </refsect1>
2869
2870 <refsect1>
2871 <title>[DHCPv6] Section Options</title>
2872
2873 <para>The [DHCPv6] section configures the DHCPv6 client, if it is enabled with the
2874 <varname>DHCP=</varname> setting described above, or invoked by the IPv6 Router Advertisement:
2875 </para>
2876
2877 <variablelist class='network-directives'>
2878
2879 <!-- DHCP packet contents -->
2880
2881 <varlistentry>
2882 <term><varname>MUDURL=</varname></term>
2883 <term><varname>IAID=</varname></term>
2884 <term><varname>DUIDType=</varname></term>
2885 <term><varname>DUIDRawData=</varname></term>
2886 <term><varname>RequestOptions=</varname></term>
2887 <listitem>
2888 <para>As in the [DHCPv4] section.</para>
2889
2890 <xi:include href="version-info.xml" xpointer="v246"/>
2891 </listitem>
2892 </varlistentry>
2893
2894 <varlistentry>
2895 <term><varname>SendOption=</varname></term>
2896 <listitem>
2897 <para>As in the [DHCPv4] section, however because DHCPv6 uses 16-bit fields to store option
2898 numbers, the option number is an integer in the range 165536.</para>
2899
2900 <xi:include href="version-info.xml" xpointer="v246"/>
2901 </listitem>
2902 </varlistentry>
2903
2904 <varlistentry>
2905 <term><varname>SendVendorOption=</varname></term>
2906 <listitem>
2907 <para>Send an arbitrary vendor option in the DHCPv6 request. Takes an enterprise identifier,
2908 DHCP option number, data type, and data separated with a colon
2909 (<literal><replaceable>enterprise identifier</replaceable>:<replaceable>option</replaceable>:<replaceable>type</replaceable>:<replaceable>value</replaceable></literal>).
2910 Enterprise identifier is an unsigned integer in the range 14294967294. The option number
2911 must be an integer in the range 1254. Data type takes one of <literal>uint8</literal>,
2912 <literal>uint16</literal>, <literal>uint32</literal>, <literal>ipv4address</literal>,
2913 <literal>ipv6address</literal>, or <literal>string</literal>. Special characters in the data
2914 string may be escaped using
2915 <ulink url="https://en.wikipedia.org/wiki/Escape_sequences_in_C#Table_of_escape_sequences">C-style
2916 escapes</ulink>. This setting can be specified multiple times. If an empty string is
2917 specified, then all options specified earlier are cleared. Defaults to unset.</para>
2918
2919 <xi:include href="version-info.xml" xpointer="v246"/>
2920 </listitem>
2921 </varlistentry>
2922
2923 <varlistentry>
2924 <term><varname>UserClass=</varname></term>
2925 <listitem>
2926 <para>A DHCPv6 client can use User Class option to identify the type or category of user or
2927 applications it represents. The information contained in this option is a string that
2928 represents the user class of which the client is a member. Each class sets an identifying
2929 string of information to be used by the DHCP service to classify clients. Special characters
2930 in the data string may be escaped using
2931 <ulink url="https://en.wikipedia.org/wiki/Escape_sequences_in_C#Table_of_escape_sequences">C-style
2932 escapes</ulink>. This setting can be specified multiple times. If an empty string is
2933 specified, then all options specified earlier are cleared. Takes a whitespace-separated list
2934 of strings. Note that currently <constant>NUL</constant> bytes are not allowed.</para>
2935
2936 <xi:include href="version-info.xml" xpointer="v246"/>
2937 </listitem>
2938 </varlistentry>
2939
2940 <varlistentry>
2941 <term><varname>VendorClass=</varname></term>
2942 <listitem>
2943 <para>A DHCPv6 client can use VendorClass option to identify the vendor that manufactured the
2944 hardware on which the client is running. The information contained in the data area of this
2945 option is contained in one or more opaque fields that identify details of the hardware
2946 configuration. Takes a whitespace-separated list of strings.</para>
2947
2948 <xi:include href="version-info.xml" xpointer="v246"/>
2949 </listitem>
2950 </varlistentry>
2951
2952 <varlistentry>
2953 <term><varname>PrefixDelegationHint=</varname></term>
2954 <listitem>
2955 <para>Takes an IPv6 address with prefix length in the same format as the
2956 <varname>Address=</varname> in the [Network] section. The DHCPv6 client will include a prefix
2957 hint in the DHCPv6 solicitation sent to the server. The prefix length must be in the range
2958 1128. Defaults to unset.</para>
2959
2960 <xi:include href="version-info.xml" xpointer="v244"/>
2961 </listitem>
2962 </varlistentry>
2963
2964 <varlistentry>
2965 <term><varname>RapidCommit=</varname></term>
2966 <listitem>
2967 <para>Takes a boolean. The DHCPv6 client can obtain configuration parameters from a DHCPv6 server
2968 through a rapid two-message exchange (solicit and reply). When the rapid commit option is set by
2969 both the DHCPv6 client and the DHCPv6 server, the two-message exchange is used. Otherwise, the
2970 four-message exchange (solicit, advertise, request, and reply) is used. The two-message exchange
2971 provides faster client configuration. See
2972 <ulink url="https://tools.ietf.org/html/rfc3315#section-17.2.1">RFC 3315</ulink> for details.
2973 Defaults to true, and the two-message exchange will be used if the server support it.</para>
2974
2975 <xi:include href="version-info.xml" xpointer="v252"/>
2976 </listitem>
2977 </varlistentry>
2978
2979 <varlistentry>
2980 <term><varname>SendHostname=</varname></term>
2981 <listitem>
2982 <para>When true (the default), the machine's hostname (or the value specified with
2983 <varname>Hostname=</varname>, described below) will be sent to the DHCPv6 server. Note that the
2984 hostname must consist only of 7-bit ASCII lower-case characters and no spaces or dots, and be
2985 formatted as a valid DNS domain name. Otherwise, the hostname is not sent even if this option
2986 is true.</para>
2987
2988 <xi:include href="version-info.xml" xpointer="v255"/>
2989 </listitem>
2990 </varlistentry>
2991
2992 <varlistentry>
2993 <term><varname>Hostname=</varname></term>
2994 <listitem>
2995 <para>Use this value for the hostname which is sent to the DHCPv6 server, instead of machine's
2996 hostname. Note that the specified hostname must consist only of 7-bit ASCII lower-case
2997 characters and no spaces or dots, and be formatted as a valid DNS domain name.</para>
2998
2999 <xi:include href="version-info.xml" xpointer="v255"/>
3000 </listitem>
3001 </varlistentry>
3002
3003 <!-- How to use the DHCP lease -->
3004
3005 <varlistentry>
3006 <term><varname>UseAddress=</varname></term>
3007 <listitem>
3008 <para>When true (the default), the IP addresses provided by the DHCPv6 server will be
3009 assigned.</para>
3010
3011 <xi:include href="version-info.xml" xpointer="v248"/>
3012 </listitem>
3013 </varlistentry>
3014
3015 <varlistentry>
3016 <term><varname>UseCaptivePortal=</varname></term>
3017 <listitem>
3018 <para>When true (the default), the captive portal advertised by the DHCPv6 server will be recorded
3019 and made available to client programs and displayed in the
3020 <citerefentry><refentrytitle>networkctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>
3021 status output per-link.</para>
3022
3023 <xi:include href="version-info.xml" xpointer="v254"/>
3024 </listitem>
3025 </varlistentry>
3026
3027 <varlistentry>
3028 <term><varname>UseDelegatedPrefix=</varname></term>
3029 <listitem>
3030 <para>When true (the default), the client will request the DHCPv6 server to delegate
3031 prefixes. If the server provides prefixes to be delegated, then subnets of the prefixes are
3032 assigned to the interfaces that have <varname>DHCPPrefixDelegation=yes</varname>.
3033 See also the <varname>DHCPPrefixDelegation=</varname> setting in the [Network] section,
3034 settings in the [DHCPPrefixDelegation] section, and
3035 <ulink url="https://www.rfc-editor.org/rfc/rfc8415.html#section-6.3">RFC 8415</ulink>.
3036 </para>
3037
3038 <xi:include href="version-info.xml" xpointer="v250"/>
3039 </listitem>
3040 </varlistentry>
3041
3042 <varlistentry>
3043 <term><varname>UseDNS=</varname></term>
3044 <term><varname>UseNTP=</varname></term>
3045 <term><varname>UseHostname=</varname></term>
3046 <term><varname>UseDomains=</varname></term>
3047 <term><varname>NetLabel=</varname></term>
3048 <term><varname>SendRelease=</varname></term>
3049 <listitem>
3050 <para>As in the [DHCPv4] section.</para>
3051
3052 <xi:include href="version-info.xml" xpointer="v243"/>
3053 </listitem>
3054 </varlistentry>
3055
3056 <varlistentry>
3057 <term><varname>NFTSet=</varname></term>
3058 <listitem>
3059 <para>This applies the NFT set for the network configuration received with DHCP, like
3060 <varname>NFTSet=</varname> in [Address] section applies it to static configuration. See
3061 <varname>NFTSet=</varname> in [Address] section for more details. For <literal>address</literal>
3062 or <literal>prefix</literal> source types, the type of the element used in the NFT filter must be
3063 <literal>ipv6_addr</literal>.</para>
3064
3065 <xi:include href="version-info.xml" xpointer="v255"/>
3066 </listitem>
3067 </varlistentry>
3068
3069 <!-- How to communicate with the server -->
3070
3071 <varlistentry>
3072 <term><varname>WithoutRA=</varname></term>
3073 <listitem>
3074 <para>Allows DHCPv6 client to start without router advertisements's
3075 <literal>managed</literal> or <literal>other configuration</literal> flag. Takes one of
3076 <literal>no</literal>, <literal>solicit</literal>, or
3077 <literal>information-request</literal>. If this is not specified,
3078 <literal>solicit</literal> is used when <varname>DHCPPrefixDelegation=</varname> is enabled
3079 and <varname>UplinkInterface=:self</varname> is specified in the [DHCPPrefixDelegation]
3080 section. Otherwise, defaults to <literal>no</literal>, and the DHCPv6 client will be started
3081 when an RA is received. See also the <varname>DHCPv6Client=</varname> setting in the
3082 [IPv6AcceptRA] section.</para>
3083
3084 <xi:include href="version-info.xml" xpointer="v246"/>
3085 </listitem>
3086 </varlistentry>
3087 </variablelist>
3088 </refsect1>
3089
3090 <refsect1>
3091 <title>[DHCPPrefixDelegation] Section Options</title>
3092 <para>The [DHCPPrefixDelegation] section configures subnet prefixes of the delegated prefixes
3093 acquired by a DHCPv6 client or by a DHCPv4 client through the 6RD option on another interface.
3094 The settings in this section are used only when the <varname>DHCPPrefixDelegation=</varname>
3095 setting in the [Network] section is enabled.</para>
3096
3097 <variablelist class='network-directives'>
3098 <varlistentry>
3099 <term><varname>UplinkInterface=</varname></term>
3100 <listitem>
3101 <para>Specifies the name or the index of the uplink interface, or one of the special values
3102 <literal>:self</literal> and <literal>:auto</literal>. When <literal>:self</literal>, the
3103 interface itself is considered the uplink interface, and
3104 <varname>WithoutRA=solicit</varname> is implied if the setting is not explicitly specified.
3105 When <literal>:auto</literal>, the first link which acquired prefixes to be delegated from
3106 the DHCPv6 or DHCPv4 server is selected. Defaults to <literal>:auto</literal>.</para>
3107
3108 <xi:include href="version-info.xml" xpointer="v250"/>
3109 </listitem>
3110 </varlistentry>
3111
3112 <varlistentry>
3113 <term><varname>SubnetId=</varname></term>
3114 <listitem>
3115 <para>Configure a specific subnet ID on the interface from a (previously) received prefix
3116 delegation. You can either set "auto" (the default) or a specific subnet ID (as defined in
3117 <ulink url="https://tools.ietf.org/html/rfc4291#section-2.5.4">RFC 4291</ulink>, section
3118 2.5.4), in which case the allowed value is hexadecimal, from 0 to 0x7fffffffffffffff
3119 inclusive.</para>
3120
3121 <xi:include href="version-info.xml" xpointer="v246"/>
3122 </listitem>
3123 </varlistentry>
3124
3125 <varlistentry>
3126 <term><varname>Announce=</varname></term>
3127 <listitem>
3128 <para>Takes a boolean. When enabled, and <varname>IPv6SendRA=</varname> in [Network] section
3129 is enabled, the delegated prefixes are distributed through the IPv6 Router Advertisement.
3130 This setting will be ignored when the <varname>DHCPPrefixDelegation=</varname> setting is
3131 enabled on the upstream interface. Defaults to yes.</para>
3132
3133 <xi:include href="version-info.xml" xpointer="v247"/>
3134 </listitem>
3135 </varlistentry>
3136
3137 <varlistentry>
3138 <term><varname>Assign=</varname></term>
3139 <listitem>
3140 <para>Takes a boolean. Specifies whether to add an address from the delegated prefixes which
3141 are received from the WAN interface by the DHCPv6 Prefix Delegation. When true (on LAN
3142 interface), the EUI-64 algorithm will be used by default to form an interface identifier from
3143 the delegated prefixes. See also <varname>Token=</varname> setting below. Defaults to yes.
3144 </para>
3145
3146 <xi:include href="version-info.xml" xpointer="v246"/>
3147 </listitem>
3148 </varlistentry>
3149
3150 <varlistentry>
3151 <term><varname>Token=</varname></term>
3152 <listitem>
3153 <para>Specifies an optional address generation mode for assigning an address in each
3154 delegated prefix. This accepts the same syntax as <varname>Token=</varname> in the
3155 [IPv6AcceptRA] section. If <varname>Assign=</varname> is set to false, then this setting will
3156 be ignored. Defaults to unset, which means the EUI-64 algorithm will be used.</para>
3157
3158 <xi:include href="version-info.xml" xpointer="v246"/>
3159 </listitem>
3160 </varlistentry>
3161
3162 <varlistentry>
3163 <term><varname>ManageTemporaryAddress=</varname></term>
3164 <listitem>
3165 <para>As in the [Address] section, but defaults to true.</para>
3166
3167 <xi:include href="version-info.xml" xpointer="v248"/>
3168 </listitem>
3169 </varlistentry>
3170
3171 <varlistentry>
3172 <term><varname>RouteMetric=</varname></term>
3173 <listitem>
3174 <para>The metric of the route to the delegated prefix subnet. Takes an unsigned integer in
3175 the range 04294967295. When set to 0, the kernel's default value is used. Defaults to 256.
3176 </para>
3177
3178 <xi:include href="version-info.xml" xpointer="v249"/>
3179 </listitem>
3180 </varlistentry>
3181
3182 <varlistentry>
3183 <term><varname>NetLabel=</varname></term>
3184 <listitem>
3185 <para>This applies the NetLabel for the addresses received with DHCP, like
3186 <varname>NetLabel=</varname> in [Address] section applies it to statically configured
3187 addresses. See <varname>NetLabel=</varname> in [Address] section for more details.</para>
3188
3189 <xi:include href="version-info.xml" xpointer="v252"/>
3190 </listitem>
3191 </varlistentry>
3192
3193 <varlistentry>
3194 <term><varname>NFTSet=</varname></term>
3195 <listitem>
3196 <para>This applies the NFT set for the network configuration received with DHCP, like
3197 <varname>NFTSet=</varname> in [Address] section applies it to static configuration. See
3198 <varname>NFTSet=</varname> in [Address] section for more details. For <literal>address</literal> or
3199 <literal>prefix</literal> source types, the type of the element used in the NFT filter must be
3200 <literal>ipv6_addr</literal>.</para>
3201
3202 <xi:include href="version-info.xml" xpointer="v255"/>
3203 </listitem>
3204 </varlistentry>
3205 </variablelist>
3206 </refsect1>
3207
3208 <refsect1>
3209 <title>[IPv6AcceptRA] Section Options</title>
3210 <para>The [IPv6AcceptRA] section configures the IPv6 Router Advertisement (RA) client, if it is enabled
3211 with the <varname>IPv6AcceptRA=</varname> setting described above:</para>
3212
3213 <variablelist class='network-directives'>
3214 <varlistentry>
3215 <term><varname>UseRedirect=</varname></term>
3216 <listitem>
3217 <para>When true (the default), Redirect message sent by the current first-hop router will be
3218 accepted, and configures routes to redirected nodes will be configured.</para>
3219
3220 <xi:include href="version-info.xml" xpointer="v256"/>
3221 </listitem>
3222 </varlistentry>
3223
3224 <varlistentry>
3225 <term><varname>Token=</varname></term>
3226 <listitem>
3227 <para>Specifies an optional address generation mode for the Stateless Address
3228 Autoconfiguration (SLAAC). The following values are supported:</para>
3229
3230 <variablelist>
3231 <varlistentry>
3232 <term><option>eui64</option></term>
3233 <listitem>
3234 <para>
3235 The EUI-64 algorithm will be used to generate an address for that prefix. Only
3236 supported by Ethernet or InfiniBand interfaces.
3237 </para>
3238
3239 <xi:include href="version-info.xml" xpointer="v250"/>
3240 </listitem>
3241 </varlistentry>
3242 <varlistentry>
3243 <term><option>static:<replaceable>ADDRESS</replaceable></option></term>
3244 <listitem>
3245 <para>
3246 An IPv6 address must be specified after a colon (<literal>:</literal>), and the
3247 lower bits of the supplied address are combined with the upper bits of a prefix
3248 received in a Router Advertisement (RA) message to form a complete address. Note
3249 that if multiple prefixes are received in an RA message, or in multiple RA messages,
3250 addresses will be formed from each of them using the supplied address. This mode
3251 implements SLAAC but uses a static interface identifier instead of an identifier
3252 generated by using the EUI-64 algorithm. Because the interface identifier is static,
3253 if Duplicate Address Detection detects that the computed address is a duplicate
3254 (in use by another node on the link), then this mode will fail to provide an address
3255 for that prefix. If an IPv6 address without mode is specified, then
3256 <literal>static</literal> mode is assumed.
3257 </para>
3258
3259 <xi:include href="version-info.xml" xpointer="v250"/>
3260 </listitem>
3261 </varlistentry>
3262 <varlistentry>
3263 <term><option>prefixstable[:<replaceable>ADDRESS</replaceable>][,<replaceable>UUID</replaceable>]</option></term>
3264 <listitem>
3265 <para>
3266 The algorithm specified in
3267 <ulink url="https://tools.ietf.org/html/rfc7217">RFC 7217</ulink> will be used to
3268 generate interface identifiers. This mode can optionally take an IPv6 address
3269 separated with a colon (<literal>:</literal>). If an IPv6 address is specified,
3270 then an interface identifier is generated only when a prefix received in an RA
3271 message matches the supplied address.
3272 </para>
3273 <para>
3274 This mode can also optionally take a non-null UUID in the format which
3275 <function>sd_id128_from_string()</function> accepts, e.g.
3276 <literal>86b123b969ba4b7eb8b3d8605123525a</literal> or
3277 <literal>86b123b9-69ba-4b7e-b8b3-d8605123525a</literal>. If a UUID is specified, the
3278 value is used as the secret key to generate interface identifiers. If not specified,
3279 then an application specific ID generated with the system's machine-ID will be used
3280 as the secret key. See
3281 <citerefentry><refentrytitle>sd-id128</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
3282 <citerefentry><refentrytitle>sd_id128_from_string</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
3283 and
3284 <citerefentry><refentrytitle>sd_id128_get_machine</refentrytitle><manvolnum>3</manvolnum></citerefentry>.
3285 </para>
3286 <para>
3287 Note that the <literal>prefixstable</literal> algorithm uses both the interface
3288 name and MAC address as input to the hash to compute the interface identifier, so
3289 if either of those are changed the resulting interface identifier (and address)
3290 will be changed, even if the prefix received in the RA message has not been
3291 changed.
3292 </para>
3293
3294 <xi:include href="version-info.xml" xpointer="v250"/>
3295 </listitem>
3296 </varlistentry>
3297 </variablelist>
3298
3299 <para>If no address generation mode is specified (which is the default), or a received
3300 prefix does not match any of the addresses provided in <literal>prefixstable</literal>
3301 mode, then the EUI-64 algorithm will be used for Ethernet or InfiniBand interfaces,
3302 otherwise <literal>prefixstable</literal> will be used to form an interface identifier for
3303 that prefix.</para>
3304
3305 <para>This setting can be specified multiple times. If an empty string is assigned, then
3306 the all previous assignments are cleared.</para>
3307
3308 <para>Examples:
3309 <programlisting>Token=eui64
3310 Token=::1a:2b:3c:4d
3311 Token=static:::1a:2b:3c:4d
3312 Token=prefixstable
3313 Token=prefixstable:2002:da8:1::</programlisting></para>
3314
3315 <xi:include href="version-info.xml" xpointer="v250"/>
3316 </listitem>
3317 </varlistentry>
3318
3319 <varlistentry>
3320 <term><varname>UseDNS=</varname></term>
3321 <listitem>
3322 <para>When true (the default), the DNS servers received in the Router Advertisement will be used.</para>
3323
3324 <para>This corresponds to the <option>nameserver</option> option in <citerefentry
3325 project='man-pages'><refentrytitle>resolv.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para>
3326
3327 <xi:include href="version-info.xml" xpointer="v231"/>
3328 </listitem>
3329 </varlistentry>
3330
3331 <varlistentry>
3332 <term><varname>UseDomains=</varname></term>
3333 <listitem>
3334 <para>Takes a boolean, or the special value <literal>route</literal>. When true, the domain name
3335 received via IPv6 Router Advertisement (RA) will be used as DNS search domain over this link,
3336 similarly to the effect of the <option>Domains=</option> setting. If set to
3337 <literal>route</literal>, the domain name received via IPv6 RA will be used for routing DNS queries
3338 only, but not for searching, similarly to the effect of the <option>Domains=</option> setting when
3339 the argument is prefixed with <literal>~</literal>. Defaults to false.</para>
3340
3341 <para>It is recommended to enable this option only on trusted networks, as setting this affects resolution
3342 of all hostnames, in particular of single-label names. It is generally safer to use the supplied domain
3343 only as routing domain, rather than as search domain, in order to not have it affect local resolution of
3344 single-label names.</para>
3345
3346 <para>When set to true, this setting corresponds to the <option>domain</option> option in <citerefentry
3347 project='man-pages'><refentrytitle>resolv.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para>
3348
3349 <xi:include href="version-info.xml" xpointer="v231"/>
3350 </listitem>
3351 </varlistentry>
3352
3353 <varlistentry>
3354 <term><varname>RouteTable=<replaceable>num</replaceable></varname></term>
3355 <listitem>
3356 <para>The table identifier for the routes received in the Router Advertisement. Takes one of
3357 predefined names <literal>default</literal>, <literal>main</literal>, and <literal>local</literal>,
3358 and names defined in <varname>RouteTable=</varname> in
3359 <citerefentry><refentrytitle>networkd.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
3360 or a number between 14294967295.</para>
3361
3362 <para>When used in combination with <varname>VRF=</varname>, the VRF's routing table is
3363 used when this parameter is not specified.</para>
3364
3365 <xi:include href="version-info.xml" xpointer="v232"/>
3366 </listitem>
3367 </varlistentry>
3368
3369 <varlistentry>
3370 <term><varname>RouteMetric=</varname></term>
3371 <listitem>
3372 <para>Set the routing metric for the routes received in the Router Advertisement. Takes an unsigned
3373 integer in the range 04294967295, or three unsigned integer separated with <literal>:</literal>,
3374 in that case the first one is used when the router preference is high, the second is for medium
3375 preference, and the last is for low preference
3376 (<literal><replaceable>high</replaceable>:<replaceable>medium</replaceable>:<replaceable>low</replaceable></literal>).
3377 Defaults to <literal>512:1024:2048</literal>.</para>
3378
3379 <xi:include href="version-info.xml" xpointer="v249"/>
3380 </listitem>
3381 </varlistentry>
3382
3383 <varlistentry>
3384 <term><varname>QuickAck=</varname></term>
3385 <listitem>
3386 <para>Takes a boolean. When true, the TCP quick ACK mode is enabled for the routes configured by
3387 the received RAs. When unset, the kernel's default will be used.</para>
3388
3389 <xi:include href="version-info.xml" xpointer="v253"/>
3390 </listitem>
3391 </varlistentry>
3392
3393 <varlistentry>
3394 <term><varname>UseMTU=</varname></term>
3395 <listitem>
3396 <para>Takes a boolean. When true, the MTU received in the Router Advertisement will be
3397 used. Defaults to true.</para>
3398
3399 <xi:include href="version-info.xml" xpointer="v250"/>
3400 </listitem>
3401 </varlistentry>
3402
3403 <varlistentry>
3404 <term><varname>UseHopLimit=</varname></term>
3405 <listitem>
3406 <para>Takes a boolean. When true, the hop limit received in the Router Advertisement will be set to routes
3407 configured based on the advertisement. See also <varname>IPv6HopLimit=</varname>. Defaults to true.</para>
3408
3409 <xi:include href="version-info.xml" xpointer="v255"/>
3410 </listitem>
3411 </varlistentry>
3412
3413 <varlistentry>
3414 <term><varname>UseReachableTime=</varname></term>
3415 <listitem>
3416 <para>Takes a boolean. When true, the reachable time received in the Router Advertisement will be
3417 set on the interface receiving the advertisement. It is used as the base timespan of the validity
3418 of a neighbor entry. Defaults to true.</para>
3419
3420 <xi:include href="version-info.xml" xpointer="v256"/>
3421 </listitem>
3422 </varlistentry>
3423
3424 <varlistentry>
3425 <term><varname>UseRetransmissionTime=</varname></term>
3426 <listitem>
3427 <para>Takes a boolean. When true, the retransmission time received in the Router Advertisement will be set
3428 on the interface receiving the advertisement. It is used as the time between retransmissions of Neighbor
3429 Solicitation messages to a neighbor when resolving the address or when probing the reachability of a neighbor.
3430 Defaults to true.</para>
3431
3432 <xi:include href="version-info.xml" xpointer="v256"/>
3433 </listitem>
3434 </varlistentry>
3435
3436 <varlistentry>
3437 <term><varname>UseGateway=</varname></term>
3438 <listitem>
3439 <para>When true (the default), the router address will be configured as the default gateway.
3440 </para>
3441
3442 <xi:include href="version-info.xml" xpointer="v250"/>
3443 </listitem>
3444 </varlistentry>
3445
3446 <varlistentry>
3447 <term><varname>UseRoutePrefix=</varname></term>
3448 <listitem>
3449 <para>When true (the default), the routes corresponding to the route prefixes received in
3450 the Router Advertisement will be configured.</para>
3451
3452 <xi:include href="version-info.xml" xpointer="v250"/>
3453 </listitem>
3454 </varlistentry>
3455
3456 <varlistentry>
3457 <term><varname>UseCaptivePortal=</varname></term>
3458 <listitem>
3459 <para>When true (the default), the captive portal received in the Router Advertisement will be recorded
3460 and made available to client programs and displayed in the
3461 <citerefentry><refentrytitle>networkctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>
3462 status output per-link.</para>
3463
3464 <xi:include href="version-info.xml" xpointer="v254"/>
3465 </listitem>
3466 </varlistentry>
3467
3468 <varlistentry>
3469 <term><varname>UsePREF64=</varname></term>
3470 <listitem>
3471 <para>When true, the IPv6 PREF64 (or NAT64) prefixes received in the Router Advertisement will be
3472 recorded and made available to client programs and displayed in the
3473 <citerefentry><refentrytitle>networkctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>
3474 status output per-link. See <ulink url="https://tools.ietf.org/html/rfc8781">RFC 8781</ulink>.
3475 Defaults to false.</para>
3476
3477 <xi:include href="version-info.xml" xpointer="v255"/>
3478 </listitem>
3479 </varlistentry>
3480
3481 <varlistentry>
3482 <term><varname>UseAutonomousPrefix=</varname></term>
3483 <listitem>
3484 <para>When true (the default), the autonomous prefix received in the Router Advertisement will be used and take
3485 precedence over any statically configured ones.</para>
3486
3487 <xi:include href="version-info.xml" xpointer="v242"/>
3488 </listitem>
3489 </varlistentry>
3490
3491 <varlistentry>
3492 <term><varname>UseOnLinkPrefix=</varname></term>
3493 <listitem>
3494 <para>When true (the default), the onlink prefix received in the Router Advertisement will be
3495 used and takes precedence over any statically configured ones.</para>
3496
3497 <xi:include href="version-info.xml" xpointer="v242"/>
3498 </listitem>
3499 </varlistentry>
3500
3501 <varlistentry>
3502 <term><varname>RouterDenyList=</varname></term>
3503 <listitem>
3504 <para>A whitespace-separated list of IPv6 router addresses. Each address can optionally
3505 take a prefix length after <literal>/</literal>. Any information advertised by the listed
3506 router is ignored.</para>
3507
3508 <xi:include href="version-info.xml" xpointer="v248"/>
3509 </listitem>
3510 </varlistentry>
3511
3512 <varlistentry>
3513 <term><varname>RouterAllowList=</varname></term>
3514 <listitem>
3515 <para>A whitespace-separated list of IPv6 router addresses. Each address can optionally
3516 take a prefix length after <literal>/</literal>. Only information advertised by the listed
3517 router is accepted. Note that if <varname>RouterAllowList=</varname> is configured then
3518 <varname>RouterDenyList=</varname> is ignored.</para>
3519
3520 <xi:include href="version-info.xml" xpointer="v248"/>
3521 </listitem>
3522 </varlistentry>
3523
3524 <varlistentry>
3525 <term><varname>PrefixDenyList=</varname></term>
3526 <listitem>
3527 <para>A whitespace-separated list of IPv6 prefixes. Each prefix can optionally take its
3528 prefix length after <literal>/</literal>. IPv6 prefixes supplied via router advertisements
3529 in the list are ignored.</para>
3530
3531 <xi:include href="version-info.xml" xpointer="v248"/>
3532 </listitem>
3533 </varlistentry>
3534
3535 <varlistentry>
3536 <term><varname>PrefixAllowList=</varname></term>
3537 <listitem>
3538 <para>A whitespace-separated list of IPv6 prefixes. Each prefix can optionally take its
3539 prefix length after <literal>/</literal>. IPv6 prefixes supplied via router advertisements
3540 in the list are allowed. Note that if <varname>PrefixAllowList=</varname> is configured
3541 then <varname>PrefixDenyList=</varname> is ignored.</para>
3542
3543 <xi:include href="version-info.xml" xpointer="v248"/>
3544 </listitem>
3545 </varlistentry>
3546
3547 <varlistentry>
3548 <term><varname>RouteDenyList=</varname></term>
3549 <listitem>
3550 <para>A whitespace-separated list of IPv6 route prefixes. Each prefix can optionally take
3551 its prefix length after <literal>/</literal>. IPv6 route prefixes supplied via router
3552 advertisements in the list are ignored.</para>
3553
3554 <xi:include href="version-info.xml" xpointer="v248"/>
3555 </listitem>
3556 </varlistentry>
3557
3558 <varlistentry>
3559 <term><varname>RouteAllowList=</varname></term>
3560 <listitem>
3561 <para>A whitespace-separated list of IPv6 route prefixes. Each prefix can optionally take
3562 its prefix length after <literal>/</literal>. IPv6 route prefixes supplied via router
3563 advertisements in the list are allowed. Note that if <varname>RouteAllowList=</varname> is
3564 configured then <varname>RouteDenyList=</varname> is ignored.</para>
3565
3566 <xi:include href="version-info.xml" xpointer="v248"/>
3567 </listitem>
3568 </varlistentry>
3569
3570 <varlistentry>
3571 <term><varname>DHCPv6Client=</varname></term>
3572 <listitem>
3573 <para>Takes a boolean, or the special value <literal>always</literal>. When true, the
3574 DHCPv6 client will be started in <literal>solicit</literal> mode if the RA has the
3575 <literal>managed</literal> flag or <literal>information-request</literal> mode if the RA
3576 lacks the <literal>managed</literal> flag but has the
3577 <literal>other configuration</literal> flag. If set to <literal>always</literal>, the
3578 DHCPv6 client will be started in <literal>solicit</literal> mode when an RA is received,
3579 even if neither the <literal>managed</literal> nor the
3580 <literal>other configuration</literal> flag is set in the RA. This will be ignored when
3581 <varname>WithoutRA=</varname> in the [DHCPv6] section is enabled, or
3582 <varname>UplinkInterface=:self</varname> in the [DHCPPrefixDelegation] section is
3583 specified. Defaults to true.</para>
3584
3585 <xi:include href="version-info.xml" xpointer="v246"/>
3586 </listitem>
3587 </varlistentry>
3588
3589 <varlistentry>
3590 <term><varname>NetLabel=</varname></term>
3591 <listitem>
3592 <para>This applies the NetLabel for the addresses received with RA, like
3593 <varname>NetLabel=</varname> in [Address] section applies it to statically configured
3594 addresses. See <varname>NetLabel=</varname> in [Address] section for more details.</para>
3595
3596 <xi:include href="version-info.xml" xpointer="v252"/>
3597 </listitem>
3598 </varlistentry>
3599
3600 <varlistentry>
3601 <term><varname>NFTSet=</varname></term>
3602 <listitem>
3603 <para>This applies the NFT set for the network configuration received with RA, like
3604 <varname>NFTSet=</varname> in [Address] section applies it to static configuration. See
3605 <varname>NFTSet=</varname> in [Address] section for more details. For <literal>address</literal> or
3606 <literal>prefix</literal> source types, the type of the element used in the NFT filter must be
3607 <literal>ipv6_addr</literal>.</para>
3608
3609 <xi:include href="version-info.xml" xpointer="v255"/>
3610 </listitem>
3611 </varlistentry>
3612 </variablelist>
3613 </refsect1>
3614
3615 <refsect1>
3616 <title>[DHCPServer] Section Options</title>
3617 <para>The [DHCPServer] section contains settings for the DHCP server, if enabled via the
3618 <varname>DHCPServer=</varname> option described above:</para>
3619
3620 <variablelist class='network-directives'>
3621
3622 <varlistentry>
3623 <term><varname>ServerAddress=</varname></term>
3624 <listitem>
3625 <para>Specifies the server address for the DHCP server. Takes an IPv4 address with prefix length
3626 separated with a slash, e.g. <literal>192.168.0.1/24</literal>. Defaults to unset, and one of
3627 static IPv4 addresses configured in [Network] or [Address] section will be automatically selected.
3628 This setting may be useful when the interface on which the DHCP server is running has multiple
3629 static IPv4 addresses.</para>
3630 <para>This implies <varname>Address=</varname> in [Network] or [Address] section with the same
3631 address and prefix length. That is,
3632 <programlisting>[Network]
3633 DHCPServer=yes
3634 Address=192.168.0.1/24
3635 Address=192.168.0.2/24
3636 [DHCPServer]
3637 ServerAddress=192.168.0.1/24</programlisting>
3638 or
3639 <programlisting>[Network]
3640 DHCPServer=yes
3641 [Address]
3642 Address=192.168.0.1/24
3643 [Address]
3644 Address=192.168.0.2/24
3645 [DHCPServer]
3646 ServerAddress=192.168.0.1/24</programlisting>
3647 are equivalent to the following:
3648 <programlisting>[Network]
3649 DHCPServer=yes
3650 Address=192.168.0.2/24
3651 [DHCPServer]
3652 ServerAddress=192.168.0.1/24</programlisting>
3653 </para>
3654 <para>Since version 255, like the <varname>Address=</varname> setting in [Network] or [Address]
3655 section, this also supports a null address, e.g. <literal>0.0.0.0/24</literal>, and an unused
3656 address will be automatically selected. For more details about the automatic address selection,
3657 see <varname>Address=</varname> setting in [Network] section in the above.</para>
3658
3659 <xi:include href="version-info.xml" xpointer="v249"/>
3660 </listitem>
3661 </varlistentry>
3662
3663 <varlistentry>
3664 <term><varname>PoolOffset=</varname></term>
3665 <term><varname>PoolSize=</varname></term>
3666
3667 <listitem><para>Configures the pool of addresses to hand out. The pool
3668 is a contiguous sequence of IP addresses in the subnet configured for
3669 the server address, which does not include the subnet nor the broadcast
3670 address. <varname>PoolOffset=</varname> takes the offset of the pool
3671 from the start of subnet, or zero to use the default value.
3672 <varname>PoolSize=</varname> takes the number of IP addresses in the
3673 pool or zero to use the default value. By default, the pool starts at
3674 the first address after the subnet address and takes up the rest of
3675 the subnet, excluding the broadcast address. If the pool includes
3676 the server address (the default), this is reserved and not handed
3677 out to clients.</para>
3678
3679 <xi:include href="version-info.xml" xpointer="v226"/></listitem>
3680 </varlistentry>
3681
3682 <varlistentry>
3683 <term><varname>DefaultLeaseTimeSec=</varname></term>
3684 <term><varname>MaxLeaseTimeSec=</varname></term>
3685
3686 <listitem><para>Control the default and maximum DHCP lease
3687 time to pass to clients. These settings take time values in seconds or
3688 another common time unit, depending on the suffix. The default
3689 lease time is used for clients that did not ask for a specific
3690 lease time. If a client asks for a lease time longer than the
3691 maximum lease time, it is automatically shortened to the
3692 specified time. The default lease time defaults to 1h, the
3693 maximum lease time to 12h. Shorter lease times are beneficial
3694 if the configuration data in DHCP leases changes frequently
3695 and clients shall learn the new settings with shorter
3696 latencies. Longer lease times reduce the generated DHCP
3697 network traffic.</para>
3698
3699 <xi:include href="version-info.xml" xpointer="v226"/></listitem>
3700 </varlistentry>
3701
3702 <varlistentry>
3703 <term><varname>UplinkInterface=</varname></term>
3704 <listitem><para>Specifies the name or the index of the uplink interface, or one of the special
3705 values <literal>:none</literal> and <literal>:auto</literal>. When emitting DNS, NTP, or SIP
3706 servers is enabled but no servers are specified, the servers configured in the uplink interface
3707 will be emitted. When <literal>:auto</literal>, the link which has a default gateway with the
3708 highest priority will be automatically selected. When <literal>:none</literal>, no uplink
3709 interface will be selected. Defaults to <literal>:auto</literal>.</para>
3710
3711 <xi:include href="version-info.xml" xpointer="v249"/></listitem>
3712 </varlistentry>
3713
3714 <varlistentry>
3715 <term><varname>EmitDNS=</varname></term>
3716 <term><varname>DNS=</varname></term>
3717
3718 <listitem><para><varname>EmitDNS=</varname> takes a boolean. Configures whether the DHCP leases
3719 handed out to clients shall contain DNS server information. Defaults to <literal>yes</literal>.
3720 The DNS servers to pass to clients may be configured with the <varname>DNS=</varname> option,
3721 which takes a list of IPv4 addresses, or special value <literal>_server_address</literal> which
3722 will be converted to the address used by the DHCP server.</para>
3723
3724 <para>If the <varname>EmitDNS=</varname> option is enabled but no servers configured, the
3725 servers are automatically propagated from an "uplink" interface that has appropriate servers
3726 set. The "uplink" interface is determined by the default route of the system with the highest
3727 priority. Note that this information is acquired at the time the lease is handed out, and does
3728 not take uplink interfaces into account that acquire DNS server information at a later point.
3729 If no suitable uplink interface is found the DNS server data from
3730 <filename>/etc/resolv.conf</filename> is used. Also, note that the leases are not refreshed if
3731 the uplink network configuration changes. To ensure clients regularly acquire the most current
3732 uplink DNS server information, it is thus advisable to shorten the DHCP lease time via
3733 <varname>MaxLeaseTimeSec=</varname> described above.</para>
3734
3735 <para>This setting can be specified multiple times. If an empty string is specified, then all
3736 DNS servers specified earlier are cleared.</para>
3737
3738 <xi:include href="version-info.xml" xpointer="v226"/></listitem>
3739 </varlistentry>
3740
3741 <varlistentry>
3742 <term><varname>EmitNTP=</varname></term>
3743 <term><varname>NTP=</varname></term>
3744 <term><varname>EmitSIP=</varname></term>
3745 <term><varname>SIP=</varname></term>
3746 <term><varname>EmitPOP3=</varname></term>
3747 <term><varname>POP3=</varname></term>
3748 <term><varname>EmitSMTP=</varname></term>
3749 <term><varname>SMTP=</varname></term>
3750 <term><varname>EmitLPR=</varname></term>
3751 <term><varname>LPR=</varname></term>
3752
3753 <listitem><para>Similar to the <varname>EmitDNS=</varname> and <varname>DNS=</varname> settings
3754 described above, these settings configure whether and what server information for the indicate
3755 protocol shall be emitted as part of the DHCP lease. The same syntax, propagation semantics and
3756 defaults apply as for <varname>EmitDNS=</varname> and <varname>DNS=</varname>.</para>
3757
3758 <xi:include href="version-info.xml" xpointer="v226"/></listitem>
3759 </varlistentry>
3760
3761 <varlistentry>
3762 <term><varname>EmitRouter=</varname></term>
3763 <term><varname>Router=</varname></term>
3764
3765 <listitem><para>The <varname>EmitRouter=</varname> setting takes a boolean value, and configures
3766 whether the DHCP lease should contain the router option. The <varname>Router=</varname> setting
3767 takes an IPv4 address, and configures the router address to be emitted. When the
3768 <varname>Router=</varname> setting is not specified, then the server address will be used for
3769 the router option. When the <varname>EmitRouter=</varname> setting is disabled, the
3770 <varname>Router=</varname> setting will be ignored. The <varname>EmitRouter=</varname> setting
3771 defaults to true, and the <varname>Router=</varname> setting defaults to unset.
3772 </para>
3773
3774 <xi:include href="version-info.xml" xpointer="v230"/></listitem>
3775 </varlistentry>
3776
3777 <varlistentry>
3778 <term><varname>EmitTimezone=</varname></term>
3779 <term><varname>Timezone=</varname></term>
3780
3781 <listitem><para>Takes a boolean. Configures whether the DHCP leases handed out
3782 to clients shall contain timezone information. Defaults to <literal>yes</literal>. The
3783 <varname>Timezone=</varname> setting takes a timezone string
3784 (such as <literal>Europe/Berlin</literal> or
3785 <literal>UTC</literal>) to pass to clients. If no explicit
3786 timezone is set, the system timezone of the local host is
3787 propagated, as determined by the
3788 <filename>/etc/localtime</filename> symlink.</para>
3789
3790 <xi:include href="version-info.xml" xpointer="v226"/></listitem>
3791 </varlistentry>
3792
3793 <varlistentry>
3794 <term><varname>BootServerAddress=</varname></term>
3795
3796 <listitem>
3797 <para>Takes an IPv4 address of the boot server used by e.g. PXE boot systems. When specified, this
3798 address is sent in the <option>siaddr</option> field of the DHCP message header. See <ulink
3799 url="https://www.rfc-editor.org/rfc/rfc2131.html">RFC 2131</ulink> for more details. Defaults to
3800 unset.</para>
3801
3802 <xi:include href="version-info.xml" xpointer="v251"/>
3803 </listitem>
3804 </varlistentry>
3805
3806 <varlistentry>
3807 <term><varname>BootServerName=</varname></term>
3808
3809 <listitem>
3810 <para>Takes a name of the boot server used by e.g. PXE boot systems. When specified, this name is
3811 sent in the DHCP option 66 ("TFTP server name"). See <ulink
3812 url="https://www.rfc-editor.org/rfc/rfc2132.html">RFC 2132</ulink> for more details. Defaults to
3813 unset.</para>
3814
3815 <para>Note that typically setting one of <varname>BootServerName=</varname> or
3816 <varname>BootServerAddress=</varname> is sufficient, but both can be set too, if desired.</para>
3817
3818 <xi:include href="version-info.xml" xpointer="v251"/>
3819 </listitem>
3820 </varlistentry>
3821
3822 <varlistentry>
3823 <term><varname>BootFilename=</varname></term>
3824
3825 <listitem>
3826 <para>Takes a path or URL to a file loaded by e.g. a PXE boot loader. When specified, this path is
3827 sent in the DHCP option 67 ("Bootfile name"). See <ulink
3828 url="https://www.rfc-editor.org/rfc/rfc2132.html">RFC 2132</ulink> for more details. Defaults to
3829 unset.</para>
3830
3831 <xi:include href="version-info.xml" xpointer="v251"/>
3832 </listitem>
3833 </varlistentry>
3834
3835 <varlistentry>
3836 <term><varname>IPv6OnlyPreferredSec=</varname></term>
3837
3838 <listitem>
3839 <para>Takes a timespan. Controls the
3840 <ulink url="https://tools.ietf.org/html/rfc8925">RFC 8925</ulink> IPv6-Only Preferred option.
3841 Specifies the DHCPv4 option to indicate that a host supports an IPv6-only mode and is willing to
3842 forgo obtaining an IPv4 address if the network provides IPv6 connectivity. Defaults to unset, and
3843 not send the option. The minimum allowed value is 300 seconds.</para>
3844
3845 <xi:include href="version-info.xml" xpointer="v255"/>
3846 </listitem>
3847 </varlistentry>
3848
3849 <varlistentry>
3850 <term><varname>SendOption=</varname></term>
3851 <listitem>
3852 <para>Send a raw option with value via DHCPv4 server. Takes a DHCP option number, data type
3853 and data (<literal><replaceable>option</replaceable>:<replaceable>type</replaceable>:<replaceable>value</replaceable></literal>).
3854 The option number is an integer in the range 1254. The type takes one of <literal>uint8</literal>,
3855 <literal>uint16</literal>, <literal>uint32</literal>, <literal>ipv4address</literal>, <literal>ipv6address</literal>, or
3856 <literal>string</literal>. Special characters in the data string may be escaped using
3857 <ulink url="https://en.wikipedia.org/wiki/Escape_sequences_in_C#Table_of_escape_sequences">C-style
3858 escapes</ulink>. This setting can be specified multiple times. If an empty string is specified,
3859 then all options specified earlier are cleared. Defaults to unset.</para>
3860
3861 <xi:include href="version-info.xml" xpointer="v244"/>
3862 </listitem>
3863 </varlistentry>
3864
3865 <varlistentry>
3866 <term><varname>SendVendorOption=</varname></term>
3867 <listitem>
3868 <para>Send a vendor option with value via DHCPv4 server. Takes a DHCP option number, data type
3869 and data (<literal><replaceable>option</replaceable>:<replaceable>type</replaceable>:<replaceable>value</replaceable></literal>).
3870 The option number is an integer in the range 1254. The type takes one of <literal>uint8</literal>,
3871 <literal>uint16</literal>, <literal>uint32</literal>, <literal>ipv4address</literal>, or
3872 <literal>string</literal>. Special characters in the data string may be escaped using
3873 <ulink url="https://en.wikipedia.org/wiki/Escape_sequences_in_C#Table_of_escape_sequences">C-style
3874 escapes</ulink>. This setting can be specified multiple times. If an empty string is specified,
3875 then all options specified earlier are cleared. Defaults to unset.</para>
3876
3877 <xi:include href="version-info.xml" xpointer="v246"/>
3878 </listitem>
3879 </varlistentry>
3880 <varlistentry>
3881 <term><varname>BindToInterface=</varname></term>
3882 <listitem>
3883 <para>Takes a boolean value. When <literal>yes</literal>, DHCP server socket will be bound
3884 to its network interface and all socket communication will be restricted to this interface.
3885 Defaults to <literal>yes</literal>, except if <varname>RelayTarget=</varname> is used (see below),
3886 in which case it defaults to <literal>no</literal>.</para>
3887
3888 <xi:include href="version-info.xml" xpointer="v249"/>
3889 </listitem>
3890 </varlistentry>
3891 <varlistentry>
3892 <term><varname>RelayTarget=</varname></term>
3893 <listitem>
3894 <para>Takes an IPv4 address, which must be in the format described in
3895 <citerefentry project='man-pages'><refentrytitle>inet_pton</refentrytitle><manvolnum>3</manvolnum></citerefentry>.
3896 Turns this DHCP server into a DHCP relay agent. See <ulink url="https://tools.ietf.org/html/rfc1542">RFC 1542</ulink>.
3897 The address is the address of DHCP server or another relay agent to forward DHCP messages to and from.</para>
3898
3899 <xi:include href="version-info.xml" xpointer="v249"/>
3900 </listitem>
3901 </varlistentry>
3902 <varlistentry>
3903 <term><varname>RelayAgentCircuitId=</varname></term>
3904 <listitem>
3905 <para>Specifies value for Agent Circuit ID suboption of Relay Agent Information option.
3906 Takes a string, which must be in the format <literal>string:<replaceable>value</replaceable></literal>,
3907 where <literal><replaceable>value</replaceable></literal> should be replaced with the value of the suboption.
3908 Defaults to unset (means no Agent Circuit ID suboption is generated).
3909 Ignored if <varname>RelayTarget=</varname> is not specified.</para>
3910
3911 <xi:include href="version-info.xml" xpointer="v249"/>
3912 </listitem>
3913 </varlistentry>
3914 <varlistentry>
3915 <term><varname>RelayAgentRemoteId=</varname></term>
3916 <listitem>
3917 <para>Specifies value for Agent Remote ID suboption of Relay Agent Information option.
3918 Takes a string, which must be in the format <literal>string:<replaceable>value</replaceable></literal>,
3919 where <literal><replaceable>value</replaceable></literal> should be replaced with the value of the suboption.
3920 Defaults to unset (means no Agent Remote ID suboption is generated).
3921 Ignored if <varname>RelayTarget=</varname> is not specified.</para>
3922
3923 <xi:include href="version-info.xml" xpointer="v249"/>
3924 </listitem>
3925 </varlistentry>
3926
3927 <varlistentry>
3928 <term><varname>RapidCommit=</varname></term>
3929 <listitem>
3930 <para>Takes a boolean. When true, the server supports
3931 <ulink url="https://datatracker.ietf.org/doc/html/rfc4039">RFC 4039</ulink>. When a client sends
3932 a DHCPDISCOVER message with the Rapid Commit option to the server, then the server will reply with
3933 a DHCPACK message to the client, instead of DHCPOFFER. Defaults to true.</para>
3934
3935 <xi:include href="version-info.xml" xpointer="v255"/>
3936 </listitem>
3937 </varlistentry>
3938
3939 <varlistentry>
3940 <term><varname>PersistLeases=</varname></term>
3941 <listitem>
3942 <para>Takes a boolean. When true, the DHCP server will load and save leases in the persistent
3943 storage. When false, the DHCP server will neither load nor save leases in the persistent storage.
3944 Hence, bound leases will be lost when the interface is reconfigured e.g. by
3945 <command>networkctl reconfigure</command>, or <filename>systemd-networkd.service</filename>
3946 is restarted. That may cause address conflict on the network. So, please take an extra care when
3947 disable this setting. When unspecified, the value specified in the same setting in
3948 <citerefentry><refentrytitle>networkd.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
3949 which defaults to <literal>yes</literal>, will be used.</para>
3950
3951 <xi:include href="version-info.xml" xpointer="v256"/>
3952 </listitem>
3953 </varlistentry>
3954
3955 </variablelist>
3956 </refsect1>
3957
3958 <refsect1>
3959 <title>[DHCPServerStaticLease] Section Options</title>
3960 <para>The <literal>[DHCPServerStaticLease]</literal> section configures a static DHCP lease to assign a
3961 fixed IPv4 address to a specific device based on its MAC address. This section can be specified multiple
3962 times.</para>
3963
3964 <variablelist class='network-directives'>
3965 <varlistentry>
3966 <term><varname>MACAddress=</varname></term>
3967
3968 <listitem><para>The hardware address of a device to match. This key is mandatory.</para>
3969
3970 <xi:include href="version-info.xml" xpointer="v249"/></listitem>
3971 </varlistentry>
3972
3973 <varlistentry>
3974 <term><varname>Address=</varname></term>
3975
3976 <listitem><para>The IPv4 address that should be assigned to the device that was matched with
3977 <varname>MACAddress=</varname>. This key is mandatory.</para>
3978
3979 <xi:include href="version-info.xml" xpointer="v249"/></listitem>
3980 </varlistentry>
3981 </variablelist>
3982 </refsect1>
3983
3984 <refsect1>
3985 <title>[IPv6SendRA] Section Options</title>
3986 <para>The [IPv6SendRA] section contains settings for sending IPv6 Router Advertisements and whether
3987 to act as a router, if enabled via the <varname>IPv6SendRA=</varname> option described above. IPv6
3988 network prefixes or routes are defined with one or more [IPv6Prefix] or [IPv6RoutePrefix] sections.
3989 </para>
3990
3991 <variablelist class='network-directives'>
3992
3993 <varlistentry>
3994 <term><varname>Managed=</varname></term>
3995 <term><varname>OtherInformation=</varname></term>
3996
3997 <listitem><para>Takes a boolean. Controls whether a DHCPv6 server is used to acquire IPv6
3998 addresses on the network link when <varname>Managed=</varname>
3999 is set to <literal>true</literal> or if only additional network
4000 information can be obtained via DHCPv6 for the network link when
4001 <varname>OtherInformation=</varname> is set to
4002 <literal>true</literal>. Both settings default to
4003 <literal>false</literal>, which means that a DHCPv6 server is not being
4004 used.</para>
4005
4006 <xi:include href="version-info.xml" xpointer="v235"/></listitem>
4007 </varlistentry>
4008
4009 <varlistentry>
4010 <term><varname>RouterLifetimeSec=</varname></term>
4011
4012 <listitem><para>Takes a timespan. Configures the IPv6 router lifetime in seconds. The value must be 0
4013 seconds, or between 4 seconds and 9000 seconds. When set to 0, the host is not acting as a router.
4014 Defaults to 1800 seconds (30 minutes).</para>
4015
4016 <xi:include href="version-info.xml" xpointer="v235"/>
4017 </listitem>
4018 </varlistentry>
4019
4020 <varlistentry>
4021 <term><varname>ReachableTimeSec=</varname></term>
4022
4023 <listitem>
4024 <para>Configures the time, used in the Neighbor Unreachability Detection algorithm, for which
4025 clients can assume a neighbor is reachable after having received a reachability confirmation. Takes
4026 a time span in the range 04294967295 ms. When 0, clients will handle it as if the value wasn't
4027 specified. Defaults to 0.</para>
4028
4029 <xi:include href="version-info.xml" xpointer="v256"/>
4030 </listitem>
4031 </varlistentry>
4032
4033 <varlistentry>
4034 <term><varname>RetransmitSec=</varname></term>
4035
4036 <listitem>
4037 <para>Configures the time, used in the Neighbor Unreachability Detection algorithm, for which
4038 clients can use as retransmit time on address resolution and the Neighbor Unreachability Detection
4039 algorithm. Takes a time span in the range 04294967295 ms. When 0, clients will handle it as if
4040 the value wasn't specified. Defaults to 0.</para>
4041
4042 <xi:include href="version-info.xml" xpointer="v255"/>
4043 </listitem>
4044 </varlistentry>
4045
4046 <varlistentry>
4047 <term><varname>RouterPreference=</varname></term>
4048
4049 <listitem><para>Configures IPv6 router preference if
4050 <varname>RouterLifetimeSec=</varname> is non-zero. Valid values are
4051 <literal>high</literal>, <literal>medium</literal> and
4052 <literal>low</literal>, with <literal>normal</literal> and
4053 <literal>default</literal> added as synonyms for
4054 <literal>medium</literal> just to make configuration easier. See
4055 <ulink url="https://tools.ietf.org/html/rfc4191">RFC 4191</ulink>
4056 for details. Defaults to <literal>medium</literal>.</para>
4057
4058 <xi:include href="version-info.xml" xpointer="v235"/></listitem>
4059 </varlistentry>
4060
4061 <varlistentry>
4062 <term><varname>HopLimit=</varname></term>
4063 <listitem>
4064 <para>Configures hop limit. Takes an integer in the range 0255. See also
4065 <varname>IPv6HopLimit=</varname>.</para>
4066
4067 <xi:include href="version-info.xml" xpointer="v255"/>
4068 </listitem>
4069 </varlistentry>
4070
4071 <varlistentry>
4072 <term><varname>UplinkInterface=</varname></term>
4073 <listitem><para>Specifies the name or the index of the uplink interface, or one of the special
4074 values <literal>:none</literal> and <literal>:auto</literal>. When emitting DNS servers or
4075 search domains is enabled but no servers are specified, the servers configured in the uplink
4076 interface will be emitted. When <literal>:auto</literal>, the value specified to the same
4077 setting in the [DHCPPrefixDelegation] section will be used if
4078 <varname>DHCPPrefixDelegation=</varname> is enabled, otherwise the link which has a default
4079 gateway with the highest priority will be automatically selected. When <literal>:none</literal>,
4080 no uplink interface will be selected. Defaults to <literal>:auto</literal>.</para>
4081
4082 <xi:include href="version-info.xml" xpointer="v250"/></listitem>
4083 </varlistentry>
4084
4085 <varlistentry>
4086 <term><varname>EmitDNS=</varname></term>
4087 <term><varname>DNS=</varname></term>
4088
4089 <listitem><para><varname>DNS=</varname> specifies a list of recursive DNS server IPv6 addresses
4090 that are distributed via Router Advertisement messages when <varname>EmitDNS=</varname> is true.
4091 <varname>DNS=</varname> also takes special value <literal>_link_local</literal>; in that case
4092 the IPv6 link-local address is distributed. If <varname>DNS=</varname> is empty, DNS servers are
4093 read from the [Network] section. If the [Network] section does not contain any DNS servers
4094 either, DNS servers from the uplink interface specified in <varname>UplinkInterface=</varname>
4095 will be used. When <varname>EmitDNS=</varname> is false, no DNS server information is sent in
4096 Router Advertisement messages. <varname>EmitDNS=</varname> defaults to true.</para>
4097
4098 <xi:include href="version-info.xml" xpointer="v235"/></listitem>
4099 </varlistentry>
4100
4101 <varlistentry>
4102 <term><varname>EmitDomains=</varname></term>
4103 <term><varname>Domains=</varname></term>
4104
4105 <listitem><para>A list of DNS search domains distributed via Router Advertisement messages when
4106 <varname>EmitDomains=</varname> is true. If <varname>Domains=</varname> is empty, DNS search
4107 domains are read from the [Network] section. If the [Network] section does not contain any DNS
4108 search domains either, DNS search domains from the uplink interface specified in
4109 <varname>UplinkInterface=</varname> will be used. When <varname>EmitDomains=</varname> is false,
4110 no DNS search domain information is sent in Router Advertisement messages.
4111 <varname>EmitDomains=</varname> defaults to true.</para>
4112
4113 <xi:include href="version-info.xml" xpointer="v235"/></listitem>
4114 </varlistentry>
4115
4116 <varlistentry>
4117 <term><varname>DNSLifetimeSec=</varname></term>
4118
4119 <listitem><para>Lifetime in seconds for the DNS server addresses listed in
4120 <varname>DNS=</varname> and search domains listed in <varname>Domains=</varname>. Defaults to
4121 3600 seconds (one hour).</para>
4122
4123 <xi:include href="version-info.xml" xpointer="v235"/></listitem>
4124 </varlistentry>
4125
4126 <varlistentry>
4127 <term><varname>HomeAgent=</varname></term>
4128
4129 <listitem><para>Takes a boolean. Specifies that IPv6 router advertisements which indicate to hosts that
4130 the router acts as a Home Agent and includes a Home Agent option. Defaults to false. See
4131 <ulink url="https://tools.ietf.org/html/rfc6275">RFC 6275</ulink> for further details.</para>
4132
4133 <xi:include href="version-info.xml" xpointer="v255"/>
4134 </listitem>
4135 </varlistentry>
4136
4137 <varlistentry>
4138 <term><varname>HomeAgentLifetimeSec=</varname></term>
4139
4140 <listitem><para>Takes a timespan. Specifies the lifetime of the Home Agent. An integer, the default unit is seconds,
4141 in the range 165535. Defaults to the value set to <varname>RouterLifetimeSec=</varname>.</para>
4142
4143 <xi:include href="version-info.xml" xpointer="v255"/>
4144 </listitem>
4145 </varlistentry>
4146
4147 <varlistentry>
4148 <term><varname>HomeAgentPreference=</varname></term>
4149
4150 <listitem><para>Configures IPv6 Home Agent preference. Takes an integer in the range 065535.
4151 Defaults to 0.</para>
4152
4153 <xi:include href="version-info.xml" xpointer="v255"/>
4154 </listitem>
4155 </varlistentry>
4156
4157 </variablelist>
4158 </refsect1>
4159
4160 <refsect1>
4161 <title>[IPv6Prefix] Section Options</title>
4162 <para>One or more [IPv6Prefix] sections contain the IPv6 prefixes that are announced via Router
4163 Advertisements. See <ulink url="https://tools.ietf.org/html/rfc4861">RFC 4861</ulink> for further
4164 details.</para>
4165
4166 <variablelist class='network-directives'>
4167
4168 <varlistentry>
4169 <term><varname>AddressAutoconfiguration=</varname></term>
4170 <term><varname>OnLink=</varname></term>
4171
4172 <listitem><para>Takes a boolean to specify whether IPv6 addresses can be
4173 autoconfigured with this prefix and whether the prefix can be used for
4174 onlink determination. Both settings default to <literal>true</literal>
4175 in order to ease configuration.
4176 </para>
4177
4178 <xi:include href="version-info.xml" xpointer="v235"/></listitem>
4179 </varlistentry>
4180
4181 <varlistentry>
4182 <term><varname>Prefix=</varname></term>
4183
4184 <listitem><para>The IPv6 prefix that is to be distributed to hosts. Similarly to configuring static
4185 IPv6 addresses, the setting is configured as an IPv6 prefix and its prefix length, separated by a
4186 <literal>/</literal> character. Use multiple [IPv6Prefix] sections to configure multiple IPv6
4187 prefixes since prefix lifetimes, address autoconfiguration and onlink status may differ from one
4188 prefix to another.</para>
4189
4190 <xi:include href="version-info.xml" xpointer="v235"/></listitem>
4191 </varlistentry>
4192
4193 <varlistentry>
4194 <term><varname>PreferredLifetimeSec=</varname></term>
4195 <term><varname>ValidLifetimeSec=</varname></term>
4196
4197 <listitem><para>Preferred and valid lifetimes for the prefix measured in seconds.
4198 <varname>PreferredLifetimeSec=</varname> defaults to 1800 seconds (30 minutes) and
4199 <varname>ValidLifetimeSec=</varname> defaults to 3600 seconds (one hour).</para>
4200
4201 <xi:include href="version-info.xml" xpointer="v235"/></listitem>
4202 </varlistentry>
4203
4204 <varlistentry>
4205 <term><varname>Assign=</varname></term>
4206 <listitem><para>Takes a boolean. When true, adds an address from the prefix. Default to false.
4207 </para>
4208
4209 <xi:include href="version-info.xml" xpointer="v246"/></listitem>
4210 </varlistentry>
4211
4212 <varlistentry>
4213 <term><varname>Token=</varname></term>
4214 <listitem>
4215 <para>Specifies an optional address generation mode for assigning an address in each
4216 prefix. This accepts the same syntax as <varname>Token=</varname> in the [IPv6AcceptRA]
4217 section. If <varname>Assign=</varname> is set to false, then this setting will be ignored.
4218 Defaults to unset, which means the EUI-64 algorithm will be used.</para>
4219
4220 <xi:include href="version-info.xml" xpointer="v250"/>
4221 </listitem>
4222 </varlistentry>
4223
4224 <varlistentry>
4225 <term><varname>RouteMetric=</varname></term>
4226 <listitem>
4227 <para>The metric of the prefix route. Takes an unsigned integer in the range 04294967295.
4228 When unset or set to 0, the kernel's default value is used. This setting is ignored when
4229 <varname>Assign=</varname> is false.</para>
4230
4231 <xi:include href="version-info.xml" xpointer="v249"/>
4232 </listitem>
4233 </varlistentry>
4234 </variablelist>
4235 </refsect1>
4236
4237 <refsect1>
4238 <title>[IPv6RoutePrefix] Section Options</title>
4239 <para>One or more [IPv6RoutePrefix] sections contain the IPv6
4240 prefix routes that are announced via Router Advertisements. See
4241 <ulink url="https://tools.ietf.org/html/rfc4191">RFC 4191</ulink>
4242 for further details.</para>
4243
4244 <variablelist class='network-directives'>
4245
4246 <varlistentry>
4247 <term><varname>Route=</varname></term>
4248
4249 <listitem><para>The IPv6 route that is to be distributed to hosts. Similarly to configuring static
4250 IPv6 routes, the setting is configured as an IPv6 prefix routes and its prefix route length,
4251 separated by a <literal>/</literal> character. Use multiple [IPv6RoutePrefix] sections to configure
4252 multiple IPv6 prefix routes.</para>
4253
4254 <xi:include href="version-info.xml" xpointer="v244"/></listitem>
4255 </varlistentry>
4256
4257 <varlistentry>
4258 <term><varname>LifetimeSec=</varname></term>
4259
4260 <listitem><para>Lifetime for the route prefix measured in seconds.
4261 <varname>LifetimeSec=</varname> defaults to 3600 seconds (one hour).</para>
4262
4263 <xi:include href="version-info.xml" xpointer="v244"/></listitem>
4264 </varlistentry>
4265
4266 </variablelist>
4267 </refsect1>
4268
4269 <refsect1>
4270 <title>[IPv6PREF64Prefix] Section Options</title>
4271 <para>One or more [IPv6PREF64Prefix] sections contain the IPv6 PREF64 (or NAT64) prefixes that are announced via Router
4272 Advertisements. See <ulink url="https://tools.ietf.org/html/rfc8781">RFC 8781</ulink> for further
4273 details.</para>
4274
4275 <variablelist class='network-directives'>
4276
4277 <varlistentry>
4278 <term><varname>Prefix=</varname></term>
4279
4280 <listitem><para>The IPv6 PREF64 (or NAT64) prefix that is to be distributed to hosts. The setting holds
4281 an IPv6 prefix that should be set up for NAT64 translation (PLAT) to allow 464XLAT on the network segment.
4282 Use multiple [IPv6PREF64Prefix] sections to configure multiple IPv6 prefixes since prefix lifetime may differ
4283 from one prefix to another. The prefix is an address with a prefix length, separated by a slash
4284 <literal>/</literal> character. Valid NAT64 prefix length are 96, 64, 56, 48, 40, and 32 bits.</para>
4285
4286 <xi:include href="version-info.xml" xpointer="v255"/></listitem></varlistentry>
4287
4288 <varlistentry>
4289 <term><varname>LifetimeSec=</varname></term>
4290 <listitem><para>Lifetime for the prefix measured in seconds. Should be greater than or equal to <varname>RouterLifetimeSec=</varname>.
4291 <varname>LifetimeSec=</varname> defaults to 1800 seconds.</para>
4292
4293 <xi:include href="version-info.xml" xpointer="v255"/></listitem>
4294 </varlistentry>
4295 </variablelist>
4296 </refsect1>
4297
4298 <refsect1>
4299 <title>[Bridge] Section Options</title>
4300 <para>The [Bridge] section accepts the following keys:</para>
4301
4302 <variablelist class='network-directives'>
4303 <varlistentry>
4304 <term><varname>UnicastFlood=</varname></term>
4305 <listitem>
4306 <para>Takes a boolean. Controls whether the bridge should flood
4307 traffic for which an FDB entry is missing and the destination
4308 is unknown through this port. When unset, the kernel's default will be used.
4309 </para>
4310
4311 <xi:include href="version-info.xml" xpointer="v223"/>
4312 </listitem>
4313 </varlistentry>
4314 <varlistentry>
4315 <term><varname>MulticastFlood=</varname></term>
4316 <listitem>
4317 <para>Takes a boolean. Controls whether the bridge should flood
4318 traffic for which an MDB entry is missing and the destination
4319 is unknown through this port. When unset, the kernel's default will be used.
4320 </para>
4321
4322 <xi:include href="version-info.xml" xpointer="v242"/>
4323 </listitem>
4324 </varlistentry>
4325 <varlistentry>
4326 <term><varname>MulticastToUnicast=</varname></term>
4327 <listitem>
4328 <para>Takes a boolean. Multicast to unicast works on top of the multicast snooping feature of
4329 the bridge. Which means unicast copies are only delivered to hosts which are interested in it.
4330 When unset, the kernel's default will be used.
4331 </para>
4332
4333 <xi:include href="version-info.xml" xpointer="v240"/>
4334 </listitem>
4335 </varlistentry>
4336 <varlistentry>
4337 <term><varname>NeighborSuppression=</varname></term>
4338 <listitem>
4339 <para>Takes a boolean. Configures whether ARP and ND neighbor suppression is enabled for
4340 this port. When unset, the kernel's default will be used.
4341 </para>
4342
4343 <xi:include href="version-info.xml" xpointer="v242"/>
4344 </listitem>
4345 </varlistentry>
4346 <varlistentry>
4347 <term><varname>Learning=</varname></term>
4348 <listitem>
4349 <para>Takes a boolean. Configures whether MAC address learning is enabled for
4350 this port. When unset, the kernel's default will be used.
4351 </para>
4352
4353 <xi:include href="version-info.xml" xpointer="v242"/>
4354 </listitem>
4355 </varlistentry>
4356 <varlistentry>
4357 <term><varname>HairPin=</varname></term>
4358 <listitem>
4359 <para>Takes a boolean. Configures whether traffic may be sent back out of the port on which it
4360 was received. When this flag is false, then the bridge will not forward traffic back out of the
4361 receiving port. When unset, the kernel's default will be used.</para>
4362
4363 <xi:include href="version-info.xml" xpointer="v223"/>
4364 </listitem>
4365 </varlistentry>
4366 <varlistentry>
4367 <term><varname>Isolated=</varname></term>
4368 <listitem>
4369 <para>Takes a boolean. Configures whether this port is isolated or not. Within a bridge,
4370 isolated ports can only communicate with non-isolated ports. When set to true, this port can only
4371 communicate with other ports whose Isolated setting is false. When set to false, this port
4372 can communicate with any other ports. When unset, the kernel's default will be used.</para>
4373
4374 <xi:include href="version-info.xml" xpointer="v251"/>
4375 </listitem>
4376 </varlistentry>
4377 <varlistentry>
4378 <term><varname>UseBPDU=</varname></term>
4379 <listitem>
4380 <para>Takes a boolean. Configures whether STP Bridge Protocol Data Units will be
4381 processed by the bridge port. When unset, the kernel's default will be used.</para>
4382
4383 <xi:include href="version-info.xml" xpointer="v223"/>
4384 </listitem>
4385 </varlistentry>
4386 <varlistentry>
4387 <term><varname>FastLeave=</varname></term>
4388 <listitem>
4389 <para>Takes a boolean. This flag allows the bridge to immediately stop multicast
4390 traffic on a port that receives an IGMP Leave message. It is only used with
4391 IGMP snooping if enabled on the bridge. When unset, the kernel's default will be used.</para>
4392
4393 <xi:include href="version-info.xml" xpointer="v223"/>
4394 </listitem>
4395 </varlistentry>
4396 <varlistentry>
4397 <term><varname>AllowPortToBeRoot=</varname></term>
4398 <listitem>
4399 <para>Takes a boolean. Configures whether a given port is allowed to
4400 become a root port. Only used when STP is enabled on the bridge.
4401 When unset, the kernel's default will be used.</para>
4402
4403 <xi:include href="version-info.xml" xpointer="v223"/>
4404 </listitem>
4405 </varlistentry>
4406 <varlistentry>
4407 <term><varname>ProxyARP=</varname></term>
4408 <listitem>
4409 <para>Takes a boolean. Configures whether proxy ARP to be enabled on this port.
4410 When unset, the kernel's default will be used.</para>
4411
4412 <xi:include href="version-info.xml" xpointer="v243"/>
4413 </listitem>
4414 </varlistentry>
4415 <varlistentry>
4416 <term><varname>ProxyARPWiFi=</varname></term>
4417 <listitem>
4418 <para>Takes a boolean. Configures whether proxy ARP to be enabled on this port
4419 which meets extended requirements by IEEE 802.11 and Hotspot 2.0 specifications.
4420 When unset, the kernel's default will be used.</para>
4421
4422 <xi:include href="version-info.xml" xpointer="v243"/>
4423 </listitem>
4424 </varlistentry>
4425 <varlistentry>
4426 <term><varname>MulticastRouter=</varname></term>
4427 <listitem>
4428 <para>Configures this port for having multicast routers attached. A port with a multicast
4429 router will receive all multicast traffic. Takes one of <literal>no</literal>
4430 to disable multicast routers on this port, <literal>query</literal> to let the system detect
4431 the presence of routers, <literal>permanent</literal> to permanently enable multicast traffic
4432 forwarding on this port, or <literal>temporary</literal> to enable multicast routers temporarily
4433 on this port, not depending on incoming queries. When unset, the kernel's default will be used.</para>
4434
4435 <xi:include href="version-info.xml" xpointer="v243"/>
4436 </listitem>
4437 </varlistentry>
4438 <varlistentry>
4439 <term><varname>Cost=</varname></term>
4440 <listitem>
4441 <para>Sets the "cost" of sending packets of this interface.
4442 Each port in a bridge may have a different speed and the cost
4443 is used to decide which link to use. Faster interfaces
4444 should have lower costs. It is an integer value between 1 and
4445 65535.</para>
4446
4447 <xi:include href="version-info.xml" xpointer="v218"/>
4448 </listitem>
4449 </varlistentry>
4450 <varlistentry>
4451 <term><varname>Priority=</varname></term>
4452 <listitem>
4453 <para>Sets the "priority" of sending packets on this interface.
4454 Each port in a bridge may have a different priority which is used
4455 to decide which link to use. Lower value means higher priority.
4456 It is an integer value between 0 to 63. Networkd does not set any
4457 default, meaning the kernel default value of 32 is used.</para>
4458
4459 <xi:include href="version-info.xml" xpointer="v234"/>
4460 </listitem>
4461 </varlistentry>
4462 </variablelist>
4463 </refsect1>
4464
4465 <refsect1>
4466 <title>[BridgeFDB] Section Options</title>
4467
4468 <para>The [BridgeFDB] section manages the forwarding database table of a port and accepts the following
4469 keys. Specify several [BridgeFDB] sections to configure several static MAC table entries.</para>
4470
4471 <variablelist class='network-directives'>
4472 <varlistentry>
4473 <term><varname>MACAddress=</varname></term>
4474 <listitem>
4475 <para>As in the [Network] section. This key is mandatory.</para>
4476
4477 <xi:include href="version-info.xml" xpointer="v219"/>
4478 </listitem>
4479 </varlistentry>
4480 <varlistentry>
4481 <term><varname>Destination=</varname></term>
4482 <listitem>
4483 <para>Takes an IP address of the destination VXLAN tunnel endpoint.</para>
4484
4485 <xi:include href="version-info.xml" xpointer="v243"/>
4486 </listitem>
4487 </varlistentry>
4488 <varlistentry>
4489 <term><varname>VLANId=</varname></term>
4490 <listitem>
4491 <para>The VLAN ID for the new static MAC table entry. If
4492 omitted, no VLAN ID information is appended to the new static MAC
4493 table entry.</para>
4494
4495 <xi:include href="version-info.xml" xpointer="v219"/>
4496 </listitem>
4497 </varlistentry>
4498 <varlistentry>
4499 <term><varname>VNI=</varname></term>
4500 <listitem>
4501 <para>The VXLAN Network Identifier (or VXLAN Segment ID) to use to connect to
4502 the remote VXLAN tunnel endpoint. Takes a number in the range 116777215.
4503 Defaults to unset.</para>
4504
4505 <xi:include href="version-info.xml" xpointer="v243"/>
4506 </listitem>
4507 </varlistentry>
4508 <varlistentry>
4509 <term><varname>AssociatedWith=</varname></term>
4510 <listitem>
4511 <para>Specifies where the address is associated with. Takes one of <literal>use</literal>,
4512 <literal>self</literal>, <literal>master</literal> or <literal>router</literal>.
4513 <literal>use</literal> means the address is in use. User space can use this option to
4514 indicate to the kernel that the fdb entry is in use. <literal>self</literal> means
4515 the address is associated with the port drivers fdb. Usually hardware. <literal>master</literal>
4516 means the address is associated with master devices fdb. <literal>router</literal> means
4517 the destination address is associated with a router. Note that it's valid if the referenced
4518 device is a VXLAN type device and has route shortcircuit enabled. Defaults to <literal>self</literal>.</para>
4519
4520 <xi:include href="version-info.xml" xpointer="v243"/>
4521 </listitem>
4522 </varlistentry>
4523 <varlistentry>
4524 <term><varname>OutgoingInterface=</varname></term>
4525 <listitem>
4526 <para>Specifies the name or index of the outgoing interface for the VXLAN device driver to
4527 reach the remote VXLAN tunnel endpoint. Defaults to unset.</para>
4528
4529 <xi:include href="version-info.xml" xpointer="v249"/>
4530 </listitem>
4531 </varlistentry>
4532 </variablelist>
4533 </refsect1>
4534
4535 <refsect1>
4536 <title>[BridgeMDB] Section Options</title>
4537 <para>The [BridgeMDB] section manages the multicast membership entries forwarding database table of a port and accepts the following
4538 keys. Specify several [BridgeMDB] sections to configure several permanent multicast membership entries.</para>
4539
4540 <variablelist class='network-directives'>
4541 <varlistentry>
4542 <term><varname>MulticastGroupAddress=</varname></term>
4543 <listitem>
4544 <para>Specifies the IPv4 or IPv6 multicast group address to add. This setting is mandatory.</para>
4545
4546 <xi:include href="version-info.xml" xpointer="v247"/>
4547 </listitem>
4548 </varlistentry>
4549 <varlistentry>
4550 <term><varname>VLANId=</varname></term>
4551 <listitem>
4552 <para>The VLAN ID for the new entry. Valid ranges are 0 (no VLAN) to 4094. Optional, defaults to 0.</para>
4553
4554 <xi:include href="version-info.xml" xpointer="v247"/>
4555 </listitem>
4556 </varlistentry>
4557 </variablelist>
4558 </refsect1>
4559
4560 <refsect1>
4561 <title>[LLDP] Section Options</title>
4562 <para>The [LLDP] section manages the Link Layer Discovery Protocol (LLDP) and accepts the following
4563 keys:</para>
4564
4565 <variablelist class='network-directives'>
4566 <varlistentry>
4567 <term><varname>MUDURL=</varname></term>
4568 <listitem>
4569 <para>When configured, the specified Manufacturer Usage Descriptions (MUD) URL will be sent in
4570 LLDP packets. The syntax and semantics are the same as for <varname>MUDURL=</varname> in the
4571 [DHCPv4] section described above.</para>
4572
4573 <para>The MUD URLs received via LLDP packets are saved and can be read using the
4574 <function>sd_lldp_neighbor_get_mud_url()</function> function.</para>
4575
4576 <xi:include href="version-info.xml" xpointer="v246"/>
4577 </listitem>
4578 </varlistentry>
4579 </variablelist>
4580 </refsect1>
4581
4582 <refsect1>
4583 <title>[CAN] Section Options</title>
4584 <para>The [CAN] section manages the Controller Area Network (CAN bus) and accepts the
4585 following keys:</para>
4586 <variablelist class='network-directives'>
4587 <varlistentry>
4588 <term><varname>BitRate=</varname></term>
4589 <listitem>
4590 <para>The bitrate of CAN device in bits per second. The usual SI prefixes (K, M) with the base of 1000 can
4591 be used here. Takes a number in the range 14294967295.</para>
4592
4593 <xi:include href="version-info.xml" xpointer="v239"/>
4594 </listitem>
4595 </varlistentry>
4596 <varlistentry>
4597 <term><varname>SamplePoint=</varname></term>
4598 <listitem>
4599 <para>Optional sample point in percent with one decimal (e.g. <literal>75%</literal>,
4600 <literal>87.5%</literal>) or permille (e.g. <literal>875</literal>). This will be ignored when
4601 <varname>BitRate=</varname> is unspecified.</para>
4602
4603 <xi:include href="version-info.xml" xpointer="v239"/>
4604 </listitem>
4605 </varlistentry>
4606 <varlistentry>
4607 <term><varname>TimeQuantaNSec=</varname></term>
4608 <term><varname>PropagationSegment=</varname></term>
4609 <term><varname>PhaseBufferSegment1=</varname></term>
4610 <term><varname>PhaseBufferSegment2=</varname></term>
4611 <term><varname>SyncJumpWidth=</varname></term>
4612 <listitem>
4613 <para>Specifies the time quanta, propagation segment, phase buffer segment 1 and 2, and the
4614 synchronization jump width, which allow one to define the CAN bit-timing in a hardware
4615 independent format as proposed by the Bosch CAN 2.0 Specification.
4616 <varname>TimeQuantaNSec=</varname> takes a timespan in nanoseconds.
4617 <varname>PropagationSegment=</varname>, <varname>PhaseBufferSegment1=</varname>,
4618 <varname>PhaseBufferSegment2=</varname>, and <varname>SyncJumpWidth=</varname> take number
4619 of time quantum specified in <varname>TimeQuantaNSec=</varname> and must be an unsigned
4620 integer in the range 04294967295. These settings except for
4621 <varname>SyncJumpWidth=</varname> will be ignored when <varname>BitRate=</varname> is
4622 specified.</para>
4623
4624 <xi:include href="version-info.xml" xpointer="v250"/>
4625 </listitem>
4626 </varlistentry>
4627 <varlistentry>
4628 <term><varname>DataBitRate=</varname></term>
4629 <term><varname>DataSamplePoint=</varname></term>
4630 <listitem>
4631 <para>The bitrate and sample point for the data phase, if CAN-FD is used. These settings are
4632 analogous to the <varname>BitRate=</varname> and <varname>SamplePoint=</varname> keys.</para>
4633
4634 <xi:include href="version-info.xml" xpointer="v246"/>
4635 </listitem>
4636 </varlistentry>
4637 <varlistentry>
4638 <term><varname>DataTimeQuantaNSec=</varname></term>
4639 <term><varname>DataPropagationSegment=</varname></term>
4640 <term><varname>DataPhaseBufferSegment1=</varname></term>
4641 <term><varname>DataPhaseBufferSegment2=</varname></term>
4642 <term><varname>DataSyncJumpWidth=</varname></term>
4643 <listitem>
4644 <para>Specifies the time quanta, propagation segment, phase buffer segment 1 and 2, and the
4645 synchronization jump width for the data phase, if CAN-FD is used. These settings are
4646 analogous to the <varname>TimeQuantaNSec=</varname> or related settings.</para>
4647
4648 <xi:include href="version-info.xml" xpointer="v250"/>
4649 </listitem>
4650 </varlistentry>
4651 <varlistentry>
4652 <term><varname>FDMode=</varname></term>
4653 <listitem>
4654 <para>Takes a boolean. When <literal>yes</literal>, CAN-FD mode is enabled for the interface.
4655 Note, that a bitrate and optional sample point should also be set for the CAN-FD data phase using
4656 the <varname>DataBitRate=</varname> and <varname>DataSamplePoint=</varname> keys, or
4657 <varname>DataTimeQuanta=</varname> and related settings.</para>
4658
4659 <xi:include href="version-info.xml" xpointer="v246"/>
4660 </listitem>
4661 </varlistentry>
4662 <varlistentry>
4663 <term><varname>FDNonISO=</varname></term>
4664 <listitem>
4665 <para>Takes a boolean. When <literal>yes</literal>, non-ISO CAN-FD mode is enabled for the
4666 interface. When unset, the kernel's default will be used.</para>
4667
4668 <xi:include href="version-info.xml" xpointer="v246"/>
4669 </listitem>
4670 </varlistentry>
4671 <varlistentry>
4672 <term><varname>RestartSec=</varname></term>
4673 <listitem>
4674 <para>Automatic restart delay time. If set to a non-zero value, a restart of the CAN controller will be
4675 triggered automatically in case of a bus-off condition after the specified delay time. Subsecond delays can
4676 be specified using decimals (e.g. <literal>0.1s</literal>) or a <literal>ms</literal> or
4677 <literal>us</literal> postfix. Using <literal>infinity</literal> or <literal>0</literal> will turn the
4678 automatic restart off. By default automatic restart is disabled.</para>
4679
4680 <xi:include href="version-info.xml" xpointer="v239"/>
4681 </listitem>
4682 </varlistentry>
4683 <varlistentry>
4684 <term><varname>Termination=</varname></term>
4685 <listitem>
4686 <para>Takes a boolean or a termination resistor value in ohm in the range 065535. When
4687 <literal>yes</literal>, the termination resistor is set to 120 ohm. When
4688 <literal>no</literal> or <literal>0</literal> is set, the termination resistor is disabled.
4689 When unset, the kernel's default will be used.</para>
4690
4691 <xi:include href="version-info.xml" xpointer="v246"/>
4692 </listitem>
4693 </varlistentry>
4694 <varlistentry>
4695 <term><varname>TripleSampling=</varname></term>
4696 <listitem>
4697 <para>Takes a boolean. When <literal>yes</literal>, three samples (instead of one) are used to determine
4698 the value of a received bit by majority rule. When unset, the kernel's default will be used.</para>
4699
4700 <xi:include href="version-info.xml" xpointer="v242"/>
4701 </listitem>
4702 </varlistentry>
4703 <varlistentry>
4704 <term><varname>BusErrorReporting=</varname></term>
4705 <listitem>
4706 <para>Takes a boolean. When <literal>yes</literal>, reporting of CAN bus errors is activated
4707 (those include single bit, frame format, and bit stuffing errors, unable to send dominant bit,
4708 unable to send recessive bit, bus overload, active error announcement, error occurred on
4709 transmission). When unset, the kernel's default will be used. Note: in case of a CAN bus with a
4710 single CAN device, sending a CAN frame may result in a huge number of CAN bus errors.</para>
4711
4712 <xi:include href="version-info.xml" xpointer="v248"/>
4713 </listitem>
4714 </varlistentry>
4715 <varlistentry>
4716 <term><varname>ListenOnly=</varname></term>
4717 <listitem>
4718 <para>Takes a boolean. When <literal>yes</literal>, listen-only mode is enabled. When the
4719 interface is in listen-only mode, the interface neither transmit CAN frames nor send ACK
4720 bit. Listen-only mode is important to debug CAN networks without interfering with the
4721 communication or acknowledge the CAN frame. When unset, the kernel's default will be used.
4722 </para>
4723
4724 <xi:include href="version-info.xml" xpointer="v246"/>
4725 </listitem>
4726 </varlistentry>
4727 <varlistentry>
4728 <term><varname>Loopback=</varname></term>
4729 <listitem>
4730 <para>Takes a boolean. When <literal>yes</literal>, loopback mode is enabled. When the
4731 loopback mode is enabled, the interface treats messages transmitted by itself as received
4732 messages. The loopback mode is important to debug CAN networks. When unset, the kernel's
4733 default will be used.</para>
4734
4735 <xi:include href="version-info.xml" xpointer="v250"/>
4736 </listitem>
4737 </varlistentry>
4738 <varlistentry>
4739 <term><varname>OneShot=</varname></term>
4740 <listitem>
4741 <para>Takes a boolean. When <literal>yes</literal>, one-shot mode is enabled. When unset,
4742 the kernel's default will be used.</para>
4743
4744 <xi:include href="version-info.xml" xpointer="v250"/>
4745 </listitem>
4746 </varlistentry>
4747 <varlistentry>
4748 <term><varname>PresumeAck=</varname></term>
4749 <listitem>
4750 <para>Takes a boolean. When <literal>yes</literal>, the interface will ignore missing CAN
4751 ACKs. When unset, the kernel's default will be used.</para>
4752
4753 <xi:include href="version-info.xml" xpointer="v250"/>
4754 </listitem>
4755 </varlistentry>
4756 <varlistentry>
4757 <term><varname>ClassicDataLengthCode=</varname></term>
4758 <listitem>
4759 <para>Takes a boolean. When <literal>yes</literal>, the interface will handle the 4bit data
4760 length code (DLC). When unset, the kernel's default will be used.</para>
4761
4762 <xi:include href="version-info.xml" xpointer="v250"/>
4763 </listitem>
4764 </varlistentry>
4765 </variablelist>
4766 </refsect1>
4767
4768 <refsect1>
4769 <title>[IPoIB] Section Options</title>
4770 <para>The [IPoIB] section manages the IP over Infiniband and accepts the following keys:</para>
4771
4772 <variablelist class='network-directives'>
4773 <xi:include href="systemd.netdev.xml" xpointer="ipoib_mode" />
4774 <xi:include href="systemd.netdev.xml" xpointer="ipoib_umcast" />
4775 </variablelist>
4776 </refsect1>
4777
4778 <refsect1>
4779 <title>[QDisc] Section Options</title>
4780 <para>The [QDisc] section manages the traffic control queueing discipline (qdisc).</para>
4781
4782 <variablelist class='network-directives'>
4783 <varlistentry>
4784 <term><varname>Parent=</varname></term>
4785 <listitem>
4786 <para>Specifies the parent Queueing Discipline (qdisc). Takes one of <literal>clsact</literal>
4787 or <literal>ingress</literal>. This is mandatory.</para>
4788
4789 <xi:include href="version-info.xml" xpointer="v244"/>
4790 </listitem>
4791 </varlistentry>
4792
4793 <xi:include href="tc.xml" xpointer="qdisc-handle" />
4794 </variablelist>
4795 </refsect1>
4796
4797 <refsect1>
4798 <title>[NetworkEmulator] Section Options</title>
4799 <para>The [NetworkEmulator] section manages the queueing discipline (qdisc) of the network emulator. It
4800 can be used to configure the kernel packet scheduler and simulate packet delay and loss for UDP or TCP
4801 applications, or limit the bandwidth usage of a particular service to simulate internet connections.
4802 </para>
4803
4804 <variablelist class='network-directives'>
4805 <xi:include href="tc.xml" xpointer="qdisc-parent" />
4806 <xi:include href="tc.xml" xpointer="qdisc-handle" />
4807
4808 <varlistentry>
4809 <term><varname>DelaySec=</varname></term>
4810 <listitem>
4811 <para>Specifies the fixed amount of delay to be added to all packets going out of the
4812 interface. Defaults to unset.</para>
4813
4814 <xi:include href="version-info.xml" xpointer="v245"/>
4815 </listitem>
4816 </varlistentry>
4817
4818 <varlistentry>
4819 <term><varname>DelayJitterSec=</varname></term>
4820 <listitem>
4821 <para>Specifies the chosen delay to be added to the packets outgoing to the network
4822 interface. Defaults to unset.</para>
4823
4824 <xi:include href="version-info.xml" xpointer="v245"/>
4825 </listitem>
4826 </varlistentry>
4827
4828 <varlistentry>
4829 <term><varname>PacketLimit=</varname></term>
4830 <listitem>
4831 <para>Specifies the maximum number of packets the qdisc may hold queued at a time.
4832 An unsigned integer in the range 04294967294. Defaults to 1000.</para>
4833
4834 <xi:include href="version-info.xml" xpointer="v245"/>
4835 </listitem>
4836 </varlistentry>
4837
4838 <varlistentry>
4839 <term><varname>LossRate=</varname></term>
4840 <listitem>
4841 <para>Specifies an independent loss probability to be added to the packets outgoing from the
4842 network interface. Takes a percentage value, suffixed with "%". Defaults to unset.</para>
4843
4844 <xi:include href="version-info.xml" xpointer="v245"/>
4845 </listitem>
4846 </varlistentry>
4847
4848 <varlistentry>
4849 <term><varname>DuplicateRate=</varname></term>
4850 <listitem>
4851 <para>Specifies that the chosen percent of packets is duplicated before queuing them.
4852 Takes a percentage value, suffixed with "%". Defaults to unset.</para>
4853
4854 <xi:include href="version-info.xml" xpointer="v245"/>
4855 </listitem>
4856 </varlistentry>
4857 </variablelist>
4858 </refsect1>
4859
4860 <refsect1>
4861 <title>[TokenBucketFilter] Section Options</title>
4862 <para>The [TokenBucketFilter] section manages the queueing discipline (qdisc) of token bucket filter
4863 (tbf).</para>
4864
4865 <variablelist class='network-directives'>
4866 <xi:include href="tc.xml" xpointer="qdisc-parent" />
4867 <xi:include href="tc.xml" xpointer="qdisc-handle" />
4868
4869 <varlistentry>
4870 <term><varname>LatencySec=</varname></term>
4871 <listitem>
4872 <para>Specifies the latency parameter, which specifies the maximum amount of time a
4873 packet can sit in the Token Bucket Filter (TBF). Defaults to unset.</para>
4874
4875 <xi:include href="version-info.xml" xpointer="v245"/>
4876 </listitem>
4877 </varlistentry>
4878
4879 <varlistentry>
4880 <term><varname>LimitBytes=</varname></term>
4881 <listitem>
4882 <para>Takes the number of bytes that can be queued waiting for tokens to become available.
4883 When the size is suffixed with K, M, or G, it is parsed as Kilobytes, Megabytes, or Gigabytes,
4884 respectively, to the base of 1024. Defaults to unset.</para>
4885
4886 <xi:include href="version-info.xml" xpointer="v246"/>
4887 </listitem>
4888 </varlistentry>
4889
4890 <varlistentry>
4891 <term><varname>BurstBytes=</varname></term>
4892 <listitem>
4893 <para>Specifies the size of the bucket. This is the maximum amount of bytes that tokens
4894 can be available for instantaneous transfer. When the size is suffixed with K, M, or G, it is
4895 parsed as Kilobytes, Megabytes, or Gigabytes, respectively, to the base of 1024. Defaults to
4896 unset.</para>
4897
4898 <xi:include href="version-info.xml" xpointer="v246"/>
4899 </listitem>
4900 </varlistentry>
4901
4902 <varlistentry>
4903 <term><varname>Rate=</varname></term>
4904 <listitem>
4905 <para>Specifies the device specific bandwidth. When suffixed with K, M, or G, the specified
4906 bandwidth is parsed as Kilobits, Megabits, or Gigabits, respectively, to the base of 1000.
4907 Defaults to unset.</para>
4908
4909 <xi:include href="version-info.xml" xpointer="v245"/>
4910 </listitem>
4911 </varlistentry>
4912
4913 <varlistentry>
4914 <term><varname>MPUBytes=</varname></term>
4915 <listitem>
4916 <para>The Minimum Packet Unit (MPU) determines the minimal token usage (specified in bytes)
4917 for a packet. When suffixed with K, M, or G, the specified size is parsed as Kilobytes,
4918 Megabytes, or Gigabytes, respectively, to the base of 1024. Defaults to zero.</para>
4919
4920 <xi:include href="version-info.xml" xpointer="v245"/>
4921 </listitem>
4922 </varlistentry>
4923
4924 <varlistentry>
4925 <term><varname>PeakRate=</varname></term>
4926 <listitem>
4927 <para>Takes the maximum depletion rate of the bucket. When suffixed with K, M, or G, the
4928 specified size is parsed as Kilobits, Megabits, or Gigabits, respectively, to the base of
4929 1000. Defaults to unset.</para>
4930
4931 <xi:include href="version-info.xml" xpointer="v245"/>
4932 </listitem>
4933 </varlistentry>
4934
4935 <varlistentry>
4936 <term><varname>MTUBytes=</varname></term>
4937 <listitem>
4938 <para>Specifies the size of the peakrate bucket. When suffixed with K, M, or G, the specified
4939 size is parsed as Kilobytes, Megabytes, or Gigabytes, respectively, to the base of 1024.
4940 Defaults to unset.</para>
4941
4942 <xi:include href="version-info.xml" xpointer="v245"/>
4943 </listitem>
4944 </varlistentry>
4945 </variablelist>
4946 </refsect1>
4947
4948 <refsect1>
4949 <title>[PIE] Section Options</title>
4950 <para>The [PIE] section manages the queueing discipline (qdisc) of Proportional Integral
4951 controller-Enhanced (PIE).</para>
4952
4953 <variablelist class='network-directives'>
4954 <xi:include href="tc.xml" xpointer="qdisc-parent" />
4955 <xi:include href="tc.xml" xpointer="qdisc-handle" />
4956
4957 <varlistentry>
4958 <term><varname>PacketLimit=</varname></term>
4959 <listitem>
4960 <para>Specifies the hard limit on the queue size in number of packets. When this limit is reached,
4961 incoming packets are dropped. An unsigned integer in the range 14294967294. Defaults to unset and
4962 kernel's default is used.</para>
4963
4964 <xi:include href="version-info.xml" xpointer="v246"/>
4965 </listitem>
4966 </varlistentry>
4967 </variablelist>
4968 </refsect1>
4969
4970 <refsect1>
4971 <title>[FlowQueuePIE] Section Options</title>
4972 <para>The <literal>[FlowQueuePIE]</literal> section manages the queueing discipline
4973 (qdisc) of Flow Queue Proportional Integral controller-Enhanced (fq_pie).</para>
4974
4975 <variablelist class='network-directives'>
4976 <xi:include href="tc.xml" xpointer="qdisc-parent" />
4977 <xi:include href="tc.xml" xpointer="qdisc-handle" />
4978
4979 <varlistentry>
4980 <term><varname>PacketLimit=</varname></term>
4981 <listitem>
4982 <para>Specifies the hard limit on the queue size in number of packets. When this limit is reached,
4983 incoming packets are dropped. An unsigned integer ranges 1 to 4294967294. Defaults to unset and
4984 kernel's default is used.</para>
4985
4986 <xi:include href="version-info.xml" xpointer="v247"/>
4987 </listitem>
4988 </varlistentry>
4989 </variablelist>
4990 </refsect1>
4991
4992 <refsect1>
4993 <title>[StochasticFairBlue] Section Options</title>
4994 <para>The [StochasticFairBlue] section manages the queueing discipline (qdisc) of stochastic fair blue
4995 (sfb).</para>
4996
4997 <variablelist class='network-directives'>
4998 <xi:include href="tc.xml" xpointer="qdisc-parent" />
4999 <xi:include href="tc.xml" xpointer="qdisc-handle" />
5000
5001 <varlistentry>
5002 <term><varname>PacketLimit=</varname></term>
5003 <listitem>
5004 <para>Specifies the hard limit on the queue size in number of packets. When this limit is reached,
5005 incoming packets are dropped. An unsigned integer in the range 04294967294. Defaults to unset and
5006 kernel's default is used.</para>
5007
5008 <xi:include href="version-info.xml" xpointer="v246"/>
5009 </listitem>
5010 </varlistentry>
5011 </variablelist>
5012 </refsect1>
5013
5014 <refsect1>
5015 <title>[StochasticFairnessQueueing] Section Options</title>
5016 <para>The [StochasticFairnessQueueing] section manages the queueing discipline (qdisc) of stochastic
5017 fairness queueing (sfq).</para>
5018
5019 <variablelist class='network-directives'>
5020 <xi:include href="tc.xml" xpointer="qdisc-parent" />
5021 <xi:include href="tc.xml" xpointer="qdisc-handle" />
5022
5023 <varlistentry>
5024 <term><varname>PerturbPeriodSec=</varname></term>
5025 <listitem>
5026 <para>Specifies the interval in seconds for queue algorithm perturbation. Defaults to unset.</para>
5027
5028 <xi:include href="version-info.xml" xpointer="v245"/>
5029 </listitem>
5030 </varlistentry>
5031 </variablelist>
5032 </refsect1>
5033
5034 <refsect1>
5035 <title>[BFIFO] Section Options</title>
5036 <para>The [BFIFO] section manages the queueing discipline (qdisc) of Byte limited Packet First In First
5037 Out (bfifo).</para>
5038
5039 <variablelist class='network-directives'>
5040 <xi:include href="tc.xml" xpointer="qdisc-parent" />
5041 <xi:include href="tc.xml" xpointer="qdisc-handle" />
5042
5043 <varlistentry>
5044 <term><varname>LimitBytes=</varname></term>
5045 <listitem>
5046 <para>Specifies the hard limit in bytes on the FIFO buffer size. The size limit prevents overflow
5047 in case the kernel is unable to dequeue packets as quickly as it receives them. When this limit is
5048 reached, incoming packets are dropped. When suffixed with K, M, or G, the specified size is parsed
5049 as Kilobytes, Megabytes, or Gigabytes, respectively, to the base of 1024. Defaults to unset and
5050 kernel default is used.</para>
5051
5052 <xi:include href="version-info.xml" xpointer="v246"/>
5053 </listitem>
5054 </varlistentry>
5055 </variablelist>
5056 </refsect1>
5057
5058 <refsect1>
5059 <title>[PFIFO] Section Options</title>
5060 <para>The [PFIFO] section manages the queueing discipline (qdisc) of Packet First In First Out
5061 (pfifo).</para>
5062
5063 <variablelist class='network-directives'>
5064 <xi:include href="tc.xml" xpointer="qdisc-parent" />
5065 <xi:include href="tc.xml" xpointer="qdisc-handle" />
5066
5067 <varlistentry>
5068 <term><varname>PacketLimit=</varname></term>
5069 <listitem>
5070 <para>Specifies the hard limit on the number of packets in the FIFO queue. The size limit prevents
5071 overflow in case the kernel is unable to dequeue packets as quickly as it receives them. When this
5072 limit is reached, incoming packets are dropped. An unsigned integer in the range
5073 04294967294. Defaults to unset and kernel's default is used.</para>
5074
5075 <xi:include href="version-info.xml" xpointer="v246"/>
5076 </listitem>
5077 </varlistentry>
5078 </variablelist>
5079 </refsect1>
5080
5081 <refsect1>
5082 <title>[PFIFOHeadDrop] Section Options</title>
5083 <para>The [PFIFOHeadDrop] section manages the queueing discipline (qdisc) of Packet First In First Out
5084 Head Drop (pfifo_head_drop).</para>
5085
5086 <variablelist class='network-directives'>
5087 <xi:include href="tc.xml" xpointer="qdisc-parent" />
5088 <xi:include href="tc.xml" xpointer="qdisc-handle" />
5089
5090 <varlistentry>
5091 <term><varname>PacketLimit=</varname></term>
5092 <listitem>
5093 <para>As in [PFIFO] section.</para>
5094
5095 <xi:include href="version-info.xml" xpointer="v246"/></listitem>
5096 </varlistentry>
5097 </variablelist>
5098 </refsect1>
5099
5100 <refsect1>
5101 <title>[PFIFOFast] Section Options</title>
5102 <para>The [PFIFOFast] section manages the queueing discipline (qdisc) of Packet First In First Out Fast
5103 (pfifo_fast).</para>
5104
5105 <variablelist class='network-directives'>
5106 <xi:include href="tc.xml" xpointer="qdisc-parent" />
5107 <xi:include href="tc.xml" xpointer="qdisc-handle" />
5108 </variablelist>
5109 </refsect1>
5110
5111 <refsect1>
5112 <title>[CAKE] Section Options</title>
5113 <para>The [CAKE] section manages the queueing discipline (qdisc) of Common Applications Kept Enhanced
5114 (CAKE).</para>
5115
5116 <variablelist class='network-directives'>
5117 <xi:include href="tc.xml" xpointer="qdisc-parent" />
5118 <xi:include href="tc.xml" xpointer="qdisc-handle" />
5119
5120 <varlistentry>
5121 <term><varname>Bandwidth=</varname></term>
5122 <listitem>
5123 <para>Specifies the shaper bandwidth. When suffixed with K, M, or G, the specified size is
5124 parsed as Kilobits, Megabits, or Gigabits, respectively, to the base of 1000. Defaults to
5125 unset and kernel's default is used.</para>
5126
5127 <xi:include href="version-info.xml" xpointer="v246"/>
5128 </listitem>
5129 </varlistentry>
5130
5131 <varlistentry>
5132 <term><varname>AutoRateIngress=</varname></term>
5133 <listitem>
5134 <para>Takes a boolean value. Enables automatic capacity estimation based on traffic arriving
5135 at this qdisc. This is most likely to be useful with cellular links, which tend to change
5136 quality randomly. If this setting is enabled, the <varname>Bandwidth=</varname> setting is
5137 used as an initial estimate. Defaults to unset, and the kernel's default is used.</para>
5138
5139 <xi:include href="version-info.xml" xpointer="v250"/>
5140 </listitem>
5141 </varlistentry>
5142
5143 <varlistentry>
5144 <term><varname>OverheadBytes=</varname></term>
5145 <listitem>
5146 <para>Specifies that bytes to be addeded to the size of each packet. Bytes may be negative.
5147 Takes an integer in the range -64256. Defaults to unset and kernel's default is used.
5148 </para>
5149
5150 <xi:include href="version-info.xml" xpointer="v246"/>
5151 </listitem>
5152 </varlistentry>
5153
5154 <varlistentry>
5155 <term><varname>MPUBytes=</varname></term>
5156 <listitem>
5157 <para>Rounds each packet (including overhead) up to the specified bytes. Takes an integer in
5158 the range 1256. Defaults to unset and kernel's default is used.</para>
5159
5160 <xi:include href="version-info.xml" xpointer="v250"/>
5161 </listitem>
5162 </varlistentry>
5163
5164 <varlistentry>
5165 <term><varname>CompensationMode=</varname></term>
5166 <listitem>
5167 <para>Takes one of <literal>none</literal>, <literal>atm</literal>, or <literal>ptm</literal>.
5168 Specifies the compensation mode for overhead calculation. When <literal>none</literal>, no
5169 compensation is taken into account. When <literal>atm</literal>, enables the compensation for
5170 ATM cell framing, which is normally found on ADSL links. When <literal>ptm</literal>, enables
5171 the compensation for PTM encoding, which is normally found on VDSL2 links and uses a 64b/65b
5172 encoding scheme. Defaults to unset and the kernel's default is used.</para>
5173
5174 <xi:include href="version-info.xml" xpointer="v250"/>
5175 </listitem>
5176 </varlistentry>
5177
5178 <varlistentry>
5179 <term><varname>UseRawPacketSize=</varname></term>
5180 <listitem>
5181 <para>Takes a boolean value. When true, the packet size reported by the Linux kernel will be
5182 used, instead of the underlying IP packet size. Defaults to unset, and the kernel's default
5183 is used.</para>
5184
5185 <xi:include href="version-info.xml" xpointer="v250"/>
5186 </listitem>
5187 </varlistentry>
5188
5189 <varlistentry>
5190 <term><varname>FlowIsolationMode=</varname></term>
5191 <listitem>
5192 <para>CAKE places packets from different flows into different queues, then packets from each
5193 queue are delivered fairly. This specifies whether the fairness is based on source address,
5194 destination address, individual flows, or any combination of those. The available values are:
5195 </para>
5196
5197 <variablelist>
5198 <varlistentry>
5199 <term><option>none</option></term>
5200 <listitem><para>
5201 The flow isolation is disabled, and all traffic passes through a single queue.
5202 </para>
5203
5204 <xi:include href="version-info.xml" xpointer="v250"/></listitem>
5205 </varlistentry>
5206 <varlistentry>
5207 <term><option>src-host</option></term>
5208 <listitem><para>
5209 Flows are defined only by source address. Equivalent to the <literal>srchost</literal>
5210 option for <command>tc qdisc</command> command. See also
5211 <citerefentry project='man-pages'><refentrytitle>tc-cake</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
5212 </para>
5213
5214 <xi:include href="version-info.xml" xpointer="v250"/></listitem>
5215 </varlistentry>
5216 <varlistentry>
5217 <term><option>dst-host</option></term>
5218 <listitem><para>
5219 Flows are defined only by destination address. Equivalent to the
5220 <literal>dsthost</literal> option for <command>tc qdisc</command> command. See also
5221 <citerefentry project='man-pages'><refentrytitle>tc-cake</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
5222 </para>
5223
5224 <xi:include href="version-info.xml" xpointer="v250"/></listitem>
5225 </varlistentry>
5226 <varlistentry>
5227 <term><option>hosts</option></term>
5228 <listitem><para>
5229 Flows are defined by source-destination host pairs. Equivalent to the same option for
5230 <command>tc qdisc</command> command. See also
5231 <citerefentry project='man-pages'><refentrytitle>tc-cake</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
5232 </para>
5233
5234 <xi:include href="version-info.xml" xpointer="v250"/></listitem>
5235 </varlistentry>
5236 <varlistentry>
5237 <term><option>flows</option></term>
5238 <listitem><para>
5239 Flows are defined by the entire 5-tuple of source address, destination address,
5240 transport protocol, source port and destination port. Equivalent to the same option for
5241 <command>tc qdisc</command> command. See also
5242 <citerefentry project='man-pages'><refentrytitle>tc-cake</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
5243 </para>
5244
5245 <xi:include href="version-info.xml" xpointer="v250"/></listitem>
5246 </varlistentry>
5247 <varlistentry>
5248 <term><option>dual-src-host</option></term>
5249 <listitem><para>
5250 Flows are defined by the 5-tuple (see <literal>flows</literal> in the above), and
5251 fairness is applied first over source addresses, then over individual flows. Equivalent
5252 to the <literal>dual-srchost</literal> option for <command>tc qdisc</command> command.
5253 See also
5254 <citerefentry project='man-pages'><refentrytitle>tc-cake</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
5255 </para>
5256
5257 <xi:include href="version-info.xml" xpointer="v250"/></listitem>
5258 </varlistentry>
5259 <varlistentry>
5260 <term><option>dual-dst-host</option></term>
5261 <listitem><para>
5262 Flows are defined by the 5-tuple (see <literal>flows</literal> in the above), and
5263 fairness is applied first over destination addresses, then over individual flows.
5264 Equivalent to the <literal>dual-dsthost</literal> option for
5265 <command>tc qdisc</command> command. See also
5266 <citerefentry project='man-pages'><refentrytitle>tc-cake</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
5267 </para>
5268
5269 <xi:include href="version-info.xml" xpointer="v250"/></listitem>
5270 </varlistentry>
5271 <varlistentry>
5272 <term><option>triple</option></term>
5273 <listitem><para>
5274 Flows are defined by the 5-tuple (see <literal>flows</literal>), and fairness is
5275 applied over source and destination addresses, and also over individual flows.
5276 Equivalent to the <literal>triple-isolate</literal> option for
5277 <command>tc qdisc</command> command. See also
5278 <citerefentry project='man-pages'><refentrytitle>tc-cake</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
5279 </para>
5280
5281 <xi:include href="version-info.xml" xpointer="v250"/></listitem>
5282 </varlistentry>
5283 </variablelist>
5284
5285 <para>Defaults to unset and the kernel's default is used.</para>
5286
5287 <xi:include href="version-info.xml" xpointer="v250"/>
5288 </listitem>
5289 </varlistentry>
5290
5291 <varlistentry>
5292 <term><varname>NAT=</varname></term>
5293 <listitem>
5294 <para>Takes a boolean value. When true, CAKE performs a NAT lookup before applying
5295 flow-isolation rules, to determine the true addresses and port numbers of the packet, to
5296 improve fairness between hosts inside the NAT. This has no practical effect when
5297 <varname>FlowIsolationMode=</varname> is <literal>none</literal> or <literal>flows</literal>,
5298 or if NAT is performed on a different host. Defaults to unset, and the kernel's default is
5299 used.</para>
5300
5301 <xi:include href="version-info.xml" xpointer="v250"/>
5302 </listitem>
5303 </varlistentry>
5304
5305 <varlistentry>
5306 <term><varname>PriorityQueueingPreset=</varname></term>
5307 <listitem>
5308 <para>CAKE divides traffic into <literal>tins</literal>, and each tin has its own independent
5309 set of flow-isolation queues, bandwidth threshold, and priority. This specifies the preset of
5310 tin profiles. The available values are:</para>
5311
5312 <variablelist>
5313 <varlistentry>
5314 <term><option>besteffort</option></term>
5315 <listitem><para>
5316 Disables priority queueing by placing all traffic in one tin.
5317 </para>
5318
5319 <xi:include href="version-info.xml" xpointer="v250"/></listitem>
5320 </varlistentry>
5321 <varlistentry>
5322 <term><option>precedence</option></term>
5323 <listitem><para>
5324 Enables priority queueing based on the legacy interpretation of TOS
5325 <literal>Precedence</literal> field. Use of this preset on the modern Internet is
5326 firmly discouraged.
5327 </para>
5328
5329 <xi:include href="version-info.xml" xpointer="v250"/></listitem>
5330 </varlistentry>
5331 <varlistentry>
5332 <term><option>diffserv8</option></term>
5333 <listitem><para>
5334 Enables priority queueing based on the Differentiated Service
5335 (<literal>DiffServ</literal>) field with eight tins: Background Traffic, High
5336 Throughput, Best Effort, Video Streaming, Low Latency Transactions, Interactive Shell,
5337 Minimum Latency, and Network Control.
5338 </para>
5339
5340 <xi:include href="version-info.xml" xpointer="v250"/></listitem>
5341 </varlistentry>
5342 <varlistentry>
5343 <term><option>diffserv4</option></term>
5344 <listitem><para>
5345 Enables priority queueing based on the Differentiated Service
5346 (<literal>DiffServ</literal>) field with four tins: Background Traffic, Best Effort,
5347 Streaming Media, and Latency Sensitive.
5348 </para>
5349
5350 <xi:include href="version-info.xml" xpointer="v250"/></listitem>
5351 </varlistentry>
5352 <varlistentry>
5353 <term><option>diffserv3</option></term>
5354 <listitem><para>
5355 Enables priority queueing based on the Differentiated Service
5356 (<literal>DiffServ</literal>) field with three tins: Background Traffic, Best Effort,
5357 and Latency Sensitive.
5358 </para>
5359
5360 <xi:include href="version-info.xml" xpointer="v250"/></listitem>
5361 </varlistentry>
5362 </variablelist>
5363
5364 <para>Defaults to unset, and the kernel's default is used.</para>
5365
5366 <xi:include href="version-info.xml" xpointer="v250"/>
5367 </listitem>
5368 </varlistentry>
5369
5370 <varlistentry>
5371 <term><varname>FirewallMark=</varname></term>
5372 <listitem>
5373 <para>Takes an integer in the range 14294967295. When specified, firewall-mark-based
5374 overriding of CAKE's tin selection is enabled. Defaults to unset, and the kernel's default is
5375 used.</para>
5376
5377 <xi:include href="version-info.xml" xpointer="v250"/>
5378 </listitem>
5379 </varlistentry>
5380
5381 <varlistentry>
5382 <term><varname>Wash=</varname></term>
5383 <listitem>
5384 <para>Takes a boolean value. When true, CAKE clears the DSCP fields, except for ECN bits, of
5385 any packet passing through CAKE. Defaults to unset, and the kernel's default is used.</para>
5386
5387 <xi:include href="version-info.xml" xpointer="v250"/>
5388 </listitem>
5389 </varlistentry>
5390
5391 <varlistentry>
5392 <term><varname>SplitGSO=</varname></term>
5393 <listitem>
5394 <para>Takes a boolean value. When true, CAKE will split General Segmentation Offload (GSO)
5395 super-packets into their on-the-wire components and dequeue them individually. Defaults to
5396 unset, and the kernel's default is used.</para>
5397
5398 <xi:include href="version-info.xml" xpointer="v250"/>
5399 </listitem>
5400 </varlistentry>
5401
5402 <varlistentry>
5403 <term><varname>RTTSec=</varname></term>
5404 <listitem>
5405 <para>Specifies the RTT for the filter. Takes a timespan. Typical values are e.g. 100us for
5406 extremely high-performance 10GigE+ networks like datacentre, 1ms for non-WiFi LAN connections,
5407 100ms for typical internet connections. Defaults to unset, and the kernel's default will be used.
5408 </para>
5409
5410 <xi:include href="version-info.xml" xpointer="v253"/>
5411 </listitem>
5412 </varlistentry>
5413
5414 <varlistentry>
5415 <term><varname>AckFilter=</varname></term>
5416 <listitem>
5417 <para>Takes a boolean value, or special value <literal>aggressive</literal>. If enabled, ACKs in
5418 each flow are queued and redundant ACKs to the upstream are dropped. If yes, the filter will always
5419 keep at least two redundant ACKs in the queue, while in <literal>aggressive</literal> mode, it will
5420 filter down to a single ACK. This may improve download throughput on links with very asymmetrical
5421 rate limits. Defaults to unset, and the kernel's default will be used.</para>
5422
5423 <xi:include href="version-info.xml" xpointer="v253"/>
5424 </listitem>
5425 </varlistentry>
5426
5427 </variablelist>
5428 </refsect1>
5429
5430 <refsect1>
5431 <title>[ControlledDelay] Section Options</title>
5432 <para>The [ControlledDelay] section manages the queueing discipline (qdisc) of
5433 controlled delay (CoDel).</para>
5434
5435 <variablelist class='network-directives'>
5436 <xi:include href="tc.xml" xpointer="qdisc-parent" />
5437 <xi:include href="tc.xml" xpointer="qdisc-handle" />
5438
5439 <varlistentry>
5440 <term><varname>PacketLimit=</varname></term>
5441 <listitem>
5442 <para>Specifies the hard limit on the queue size in number of packets. When this limit is reached,
5443 incoming packets are dropped. An unsigned integer in the range 04294967294. Defaults to unset and
5444 kernel's default is used.</para>
5445
5446 <xi:include href="version-info.xml" xpointer="v245"/>
5447 </listitem>
5448 </varlistentry>
5449
5450 <varlistentry>
5451 <term><varname>TargetSec=</varname></term>
5452 <listitem>
5453 <para>Takes a timespan. Specifies the acceptable minimum standing/persistent queue delay.
5454 Defaults to unset and kernel's default is used.</para>
5455
5456 <xi:include href="version-info.xml" xpointer="v245"/>
5457 </listitem>
5458 </varlistentry>
5459
5460 <varlistentry>
5461 <term><varname>IntervalSec=</varname></term>
5462 <listitem>
5463 <para>Takes a timespan. This is used to ensure that the measured minimum delay does not
5464 become too stale. Defaults to unset and kernel's default is used.</para>
5465
5466 <xi:include href="version-info.xml" xpointer="v245"/>
5467 </listitem>
5468 </varlistentry>
5469
5470 <varlistentry>
5471 <term><varname>ECN=</varname></term>
5472 <listitem>
5473 <para>Takes a boolean. This can be used to mark packets instead of dropping them. Defaults to
5474 unset and kernel's default is used.</para>
5475
5476 <xi:include href="version-info.xml" xpointer="v245"/>
5477 </listitem>
5478 </varlistentry>
5479
5480 <varlistentry>
5481 <term><varname>CEThresholdSec=</varname></term>
5482 <listitem>
5483 <para>Takes a timespan. This sets a threshold above which all packets are marked with ECN
5484 Congestion Experienced (CE). Defaults to unset and kernel's default is used.</para>
5485
5486 <xi:include href="version-info.xml" xpointer="v245"/>
5487 </listitem>
5488 </varlistentry>
5489 </variablelist>
5490 </refsect1>
5491
5492 <refsect1>
5493 <title>[DeficitRoundRobinScheduler] Section Options</title>
5494 <para>The [DeficitRoundRobinScheduler] section manages the queueing discipline (qdisc) of Deficit Round
5495 Robin Scheduler (DRR).</para>
5496
5497 <variablelist class='network-directives'>
5498 <xi:include href="tc.xml" xpointer="qdisc-parent" />
5499 <xi:include href="tc.xml" xpointer="qdisc-handle" />
5500 </variablelist>
5501 </refsect1>
5502
5503 <refsect1>
5504 <title>[DeficitRoundRobinSchedulerClass] Section Options</title>
5505 <para>The [DeficitRoundRobinSchedulerClass] section manages the traffic control class of Deficit Round
5506 Robin Scheduler (DRR).</para>
5507
5508 <variablelist class='network-directives'>
5509 <xi:include href="tc.xml" xpointer="tclass-parent" />
5510 <xi:include href="tc.xml" xpointer="tclass-classid" />
5511
5512 <varlistentry>
5513 <term><varname>QuantumBytes=</varname></term>
5514 <listitem>
5515 <para>Specifies the amount of bytes a flow is allowed to dequeue before the scheduler moves
5516 to the next class. When suffixed with K, M, or G, the specified size is parsed as Kilobytes,
5517 Megabytes, or Gigabytes, respectively, to the base of 1024. Defaults to the MTU of the
5518 interface.</para>
5519
5520 <xi:include href="version-info.xml" xpointer="v246"/>
5521 </listitem>
5522 </varlistentry>
5523
5524 </variablelist>
5525 </refsect1>
5526
5527 <refsect1>
5528 <title>[EnhancedTransmissionSelection] Section Options</title>
5529 <para>The [EnhancedTransmissionSelection] section manages the queueing discipline (qdisc) of Enhanced
5530 Transmission Selection (ETS).</para>
5531
5532 <variablelist class='network-directives'>
5533 <xi:include href="tc.xml" xpointer="qdisc-parent" />
5534 <xi:include href="tc.xml" xpointer="qdisc-handle" />
5535
5536 <varlistentry>
5537 <term><varname>Bands=</varname></term>
5538 <listitem>
5539 <para>Specifies the number of bands. An unsigned integer in the range 116. This value has to be at
5540 least large enough to cover the strict bands specified through the <varname>StrictBands=</varname>
5541 and bandwidth-sharing bands specified in <varname>QuantumBytes=</varname>.</para>
5542
5543 <xi:include href="version-info.xml" xpointer="v246"/>
5544 </listitem>
5545 </varlistentry>
5546
5547 <varlistentry>
5548 <term><varname>StrictBands=</varname></term>
5549 <listitem>
5550 <para>Specifies the number of bands that should be created in strict mode. An unsigned integer in
5551 the range 116.</para>
5552
5553 <xi:include href="version-info.xml" xpointer="v246"/>
5554 </listitem>
5555 </varlistentry>
5556
5557 <varlistentry>
5558 <term><varname>QuantumBytes=</varname></term>
5559 <listitem>
5560 <para>Specifies the white-space separated list of quantum used in band-sharing bands. When
5561 suffixed with K, M, or G, the specified size is parsed as Kilobytes, Megabytes, or Gigabytes,
5562 respectively, to the base of 1024. This setting can be specified multiple times. If an empty
5563 string is assigned, then the all previous assignments are cleared.</para>
5564
5565 <xi:include href="version-info.xml" xpointer="v246"/>
5566 </listitem>
5567 </varlistentry>
5568
5569 <varlistentry>
5570 <term><varname>PriorityMap=</varname></term>
5571 <listitem>
5572 <para>The priority map maps the priority of a packet to a band. The argument is a whitespace
5573 separated list of numbers. The first number indicates which band the packets with priority 0 should
5574 be put to, the second is for priority 1, and so on. There can be up to 16 numbers in the list. If
5575 there are fewer, the default band that traffic with one of the unmentioned priorities goes to is
5576 the last one. Each band number must be in the range 0255. This setting can be specified multiple
5577 times. If an empty string is assigned, then the all previous assignments are cleared.</para>
5578
5579 <xi:include href="version-info.xml" xpointer="v246"/>
5580 </listitem>
5581 </varlistentry>
5582 </variablelist>
5583 </refsect1>
5584
5585 <refsect1>
5586 <title>[GenericRandomEarlyDetection] Section Options</title>
5587 <para>The [GenericRandomEarlyDetection] section manages the queueing discipline (qdisc) of Generic Random
5588 Early Detection (GRED).</para>
5589
5590 <variablelist class='network-directives'>
5591 <xi:include href="tc.xml" xpointer="qdisc-parent" />
5592 <xi:include href="tc.xml" xpointer="qdisc-handle" />
5593
5594 <varlistentry>
5595 <term><varname>VirtualQueues=</varname></term>
5596 <listitem>
5597 <para>Specifies the number of virtual queues. Takes an integer in the range 116. Defaults to unset
5598 and kernel's default is used.</para>
5599
5600 <xi:include href="version-info.xml" xpointer="v246"/>
5601 </listitem>
5602 </varlistentry>
5603
5604 <varlistentry>
5605 <term><varname>DefaultVirtualQueue=</varname></term>
5606 <listitem>
5607 <para>Specifies the number of default virtual queue. This must be less than <varname>VirtualQueue=</varname>.
5608 Defaults to unset and kernel's default is used.</para>
5609
5610 <xi:include href="version-info.xml" xpointer="v246"/>
5611 </listitem>
5612 </varlistentry>
5613
5614 <varlistentry>
5615 <term><varname>GenericRIO=</varname></term>
5616 <listitem>
5617 <para>Takes a boolean. It turns on the RIO-like buffering scheme. Defaults to
5618 unset and kernel's default is used.</para>
5619
5620 <xi:include href="version-info.xml" xpointer="v246"/>
5621 </listitem>
5622 </varlistentry>
5623 </variablelist>
5624 </refsect1>
5625
5626 <refsect1>
5627 <title>[FairQueueingControlledDelay] Section Options</title>
5628 <para>The [FairQueueingControlledDelay] section manages the queueing discipline (qdisc) of fair queuing
5629 controlled delay (FQ-CoDel).</para>
5630
5631 <variablelist class='network-directives'>
5632 <xi:include href="tc.xml" xpointer="qdisc-parent" />
5633 <xi:include href="tc.xml" xpointer="qdisc-handle" />
5634
5635 <varlistentry>
5636 <term><varname>PacketLimit=</varname></term>
5637 <listitem>
5638 <para>Specifies the hard limit on the real queue size. When this limit is reached, incoming packets are
5639 dropped. Defaults to unset and kernel's default is used.</para>
5640
5641 <xi:include href="version-info.xml" xpointer="v245"/>
5642 </listitem>
5643 </varlistentry>
5644
5645 <varlistentry>
5646 <term><varname>MemoryLimitBytes=</varname></term>
5647 <listitem>
5648 <para>Specifies the limit on the total number of bytes that can be queued in this FQ-CoDel instance.
5649 When suffixed with K, M, or G, the specified size is parsed as Kilobytes, Megabytes, or Gigabytes,
5650 respectively, to the base of 1024. Defaults to unset and kernel's default is used.</para>
5651
5652 <xi:include href="version-info.xml" xpointer="v246"/>
5653 </listitem>
5654 </varlistentry>
5655
5656 <varlistentry>
5657 <term><varname>Flows=</varname></term>
5658 <listitem>
5659 <para>Specifies the number of flows into which the incoming packets are classified.
5660 Defaults to unset and kernel's default is used.</para>
5661
5662 <xi:include href="version-info.xml" xpointer="v245"/>
5663 </listitem>
5664 </varlistentry>
5665
5666 <varlistentry>
5667 <term><varname>TargetSec=</varname></term>
5668 <listitem>
5669 <para>Takes a timespan. Specifies the acceptable minimum standing/persistent queue delay.
5670 Defaults to unset and kernel's default is used.</para>
5671
5672 <xi:include href="version-info.xml" xpointer="v245"/>
5673 </listitem>
5674 </varlistentry>
5675
5676 <varlistentry>
5677 <term><varname>IntervalSec=</varname></term>
5678 <listitem>
5679 <para>Takes a timespan. This is used to ensure that the measured minimum delay does not
5680 become too stale. Defaults to unset and kernel's default is used.</para>
5681
5682 <xi:include href="version-info.xml" xpointer="v245"/>
5683 </listitem>
5684 </varlistentry>
5685
5686 <varlistentry>
5687 <term><varname>QuantumBytes=</varname></term>
5688 <listitem>
5689 <para>Specifies the number of bytes used as the "deficit" in the fair queuing algorithm timespan.
5690 When suffixed with K, M, or G, the specified size is parsed as Kilobytes, Megabytes, or Gigabytes,
5691 respectively, to the base of 1024. Defaults to unset and kernel's default is used.</para>
5692
5693 <xi:include href="version-info.xml" xpointer="v246"/>
5694 </listitem>
5695 </varlistentry>
5696
5697 <varlistentry>
5698 <term><varname>ECN=</varname></term>
5699 <listitem>
5700 <para>Takes a boolean. This can be used to mark packets instead of dropping them. Defaults to
5701 unset and kernel's default is used.</para>
5702
5703 <xi:include href="version-info.xml" xpointer="v245"/>
5704 </listitem>
5705 </varlistentry>
5706
5707 <varlistentry>
5708 <term><varname>CEThresholdSec=</varname></term>
5709 <listitem>
5710 <para>Takes a timespan. This sets a threshold above which all packets are marked with ECN
5711 Congestion Experienced (CE). Defaults to unset and kernel's default is used.</para>
5712
5713 <xi:include href="version-info.xml" xpointer="v245"/>
5714 </listitem>
5715 </varlistentry>
5716 </variablelist>
5717 </refsect1>
5718
5719 <refsect1>
5720 <title>[FairQueueing] Section Options</title>
5721 <para>The [FairQueueing] section manages the queueing discipline (qdisc) of fair queue traffic policing
5722 (FQ).</para>
5723
5724 <variablelist class='network-directives'>
5725 <xi:include href="tc.xml" xpointer="qdisc-parent" />
5726 <xi:include href="tc.xml" xpointer="qdisc-handle" />
5727
5728 <varlistentry>
5729 <term><varname>PacketLimit=</varname></term>
5730 <listitem>
5731 <para>Specifies the hard limit on the real queue size. When this limit is reached, incoming packets are
5732 dropped. Defaults to unset and kernel's default is used.</para>
5733
5734 <xi:include href="version-info.xml" xpointer="v245"/>
5735 </listitem>
5736 </varlistentry>
5737
5738 <varlistentry>
5739 <term><varname>FlowLimit=</varname></term>
5740 <listitem>
5741 <para>Specifies the hard limit on the maximum number of packets queued per flow. Defaults to
5742 unset and kernel's default is used.</para>
5743
5744 <xi:include href="version-info.xml" xpointer="v245"/>
5745 </listitem>
5746 </varlistentry>
5747
5748 <varlistentry>
5749 <term><varname>QuantumBytes=</varname></term>
5750 <listitem>
5751 <para>Specifies the credit per dequeue RR round, i.e. the amount of bytes a flow is allowed
5752 to dequeue at once. When suffixed with K, M, or G, the specified size is parsed as Kilobytes,
5753 Megabytes, or Gigabytes, respectively, to the base of 1024. Defaults to unset and kernel's
5754 default is used.</para>
5755
5756 <xi:include href="version-info.xml" xpointer="v246"/>
5757 </listitem>
5758 </varlistentry>
5759
5760 <varlistentry>
5761 <term><varname>InitialQuantumBytes=</varname></term>
5762 <listitem>
5763 <para>Specifies the initial sending rate credit, i.e. the amount of bytes a new flow is
5764 allowed to dequeue initially. When suffixed with K, M, or G, the specified size is parsed as
5765 Kilobytes, Megabytes, or Gigabytes, respectively, to the base of 1024. Defaults to unset and
5766 kernel's default is used.</para>
5767
5768 <xi:include href="version-info.xml" xpointer="v245"/>
5769 </listitem>
5770 </varlistentry>
5771
5772 <varlistentry>
5773 <term><varname>MaximumRate=</varname></term>
5774 <listitem>
5775 <para>Specifies the maximum sending rate of a flow. When suffixed with K, M, or G, the
5776 specified size is parsed as Kilobits, Megabits, or Gigabits, respectively, to the base of
5777 1000. Defaults to unset and kernel's default is used.</para>
5778
5779 <xi:include href="version-info.xml" xpointer="v245"/>
5780 </listitem>
5781 </varlistentry>
5782
5783 <varlistentry>
5784 <term><varname>Buckets=</varname></term>
5785 <listitem>
5786 <para>Specifies the size of the hash table used for flow lookups. Defaults to unset and
5787 kernel's default is used.</para>
5788
5789 <xi:include href="version-info.xml" xpointer="v245"/>
5790 </listitem>
5791 </varlistentry>
5792
5793 <varlistentry>
5794 <term><varname>OrphanMask=</varname></term>
5795 <listitem>
5796 <para>Takes an unsigned integer. For packets not owned by a socket, fq is able to mask a part
5797 of hash and reduce number of buckets associated with the traffic. Defaults to unset and
5798 kernel's default is used.</para>
5799
5800 <xi:include href="version-info.xml" xpointer="v245"/>
5801 </listitem>
5802 </varlistentry>
5803
5804 <varlistentry>
5805 <term><varname>Pacing=</varname></term>
5806 <listitem>
5807 <para>Takes a boolean, and enables or disables flow pacing. Defaults to unset and kernel's
5808 default is used.</para>
5809
5810 <xi:include href="version-info.xml" xpointer="v245"/>
5811 </listitem>
5812 </varlistentry>
5813
5814 <varlistentry>
5815 <term><varname>CEThresholdSec=</varname></term>
5816 <listitem>
5817 <para>Takes a timespan. This sets a threshold above which all packets are marked with ECN
5818 Congestion Experienced (CE). Defaults to unset and kernel's default is used.</para>
5819
5820 <xi:include href="version-info.xml" xpointer="v245"/>
5821 </listitem>
5822 </varlistentry>
5823 </variablelist>
5824 </refsect1>
5825
5826 <refsect1>
5827 <title>[TrivialLinkEqualizer] Section Options</title>
5828 <para>The [TrivialLinkEqualizer] section manages the queueing discipline (qdisc) of trivial link
5829 equalizer (teql).</para>
5830
5831 <variablelist class='network-directives'>
5832 <xi:include href="tc.xml" xpointer="qdisc-parent" />
5833 <xi:include href="tc.xml" xpointer="qdisc-handle" />
5834
5835 <varlistentry>
5836 <term><varname>Id=</varname></term>
5837 <listitem>
5838 <para>Specifies the interface ID <literal>N</literal> of teql. Defaults to <literal>0</literal>.
5839 Note that when teql is used, currently, the module <constant>sch_teql</constant> with
5840 <constant>max_equalizers=N+1</constant> option must be loaded before
5841 <command>systemd-networkd</command> is started.</para>
5842
5843 <xi:include href="version-info.xml" xpointer="v245"/>
5844 </listitem>
5845 </varlistentry>
5846 </variablelist>
5847 </refsect1>
5848
5849 <refsect1>
5850 <title>[HierarchyTokenBucket] Section Options</title>
5851 <para>The [HierarchyTokenBucket] section manages the queueing discipline (qdisc) of hierarchy token
5852 bucket (htb).</para>
5853
5854 <variablelist class='network-directives'>
5855 <xi:include href="tc.xml" xpointer="qdisc-parent" />
5856 <xi:include href="tc.xml" xpointer="qdisc-handle" />
5857
5858 <varlistentry>
5859 <term><varname>DefaultClass=</varname></term>
5860 <listitem>
5861 <para>Takes the minor id in hexadecimal of the default class. Unclassified traffic gets sent
5862 to the class. Defaults to unset.</para>
5863
5864 <xi:include href="version-info.xml" xpointer="v246"/>
5865 </listitem>
5866 </varlistentry>
5867
5868 <varlistentry>
5869 <term><varname>RateToQuantum=</varname></term>
5870 <listitem>
5871 <para>Takes an unsigned integer. The DRR quantums are calculated by dividing the value
5872 configured in <varname>Rate=</varname> by <varname>RateToQuantum=</varname>.</para>
5873
5874 <xi:include href="version-info.xml" xpointer="v246"/>
5875 </listitem>
5876 </varlistentry>
5877 </variablelist>
5878 </refsect1>
5879
5880 <refsect1>
5881 <title>[HierarchyTokenBucketClass] Section Options</title>
5882 <para>The [HierarchyTokenBucketClass] section manages the traffic control class of hierarchy token bucket
5883 (htb).</para>
5884
5885 <variablelist class='network-directives'>
5886 <xi:include href="tc.xml" xpointer="tclass-parent" />
5887 <xi:include href="tc.xml" xpointer="tclass-classid" />
5888
5889 <varlistentry>
5890 <term><varname>Priority=</varname></term>
5891 <listitem>
5892 <para>Specifies the priority of the class. In the round-robin process, classes with the lowest
5893 priority field are tried for packets first.</para>
5894
5895 <xi:include href="version-info.xml" xpointer="v246"/>
5896 </listitem>
5897 </varlistentry>
5898
5899 <varlistentry>
5900 <term><varname>QuantumBytes=</varname></term>
5901 <listitem>
5902 <para>Specifies how many bytes to serve from leaf at once. When suffixed with K, M, or G, the
5903 specified size is parsed as Kilobytes, Megabytes, or Gigabytes, respectively, to the base of
5904 1024.</para>
5905
5906 <xi:include href="version-info.xml" xpointer="v246"/>
5907 </listitem>
5908 </varlistentry>
5909
5910 <varlistentry>
5911 <term><varname>MTUBytes=</varname></term>
5912 <listitem>
5913 <para>Specifies the maximum packet size we create. When suffixed with K, M, or G, the specified
5914 size is parsed as Kilobytes, Megabytes, or Gigabytes, respectively, to the base of 1024.</para>
5915
5916 <xi:include href="version-info.xml" xpointer="v246"/>
5917 </listitem>
5918 </varlistentry>
5919
5920 <varlistentry>
5921 <term><varname>OverheadBytes=</varname></term>
5922 <listitem>
5923 <para>Takes an unsigned integer which specifies per-packet size overhead used in rate
5924 computations. When suffixed with K, M, or G, the specified size is parsed as Kilobytes,
5925 Megabytes, or Gigabytes, respectively, to the base of 1024.</para>
5926
5927 <xi:include href="version-info.xml" xpointer="v246"/>
5928 </listitem>
5929 </varlistentry>
5930
5931 <varlistentry>
5932 <term><varname>Rate=</varname></term>
5933 <listitem>
5934 <para>Specifies the maximum rate this class and all its children are guaranteed. When suffixed
5935 with K, M, or G, the specified size is parsed as Kilobits, Megabits, or Gigabits, respectively,
5936 to the base of 1000. This setting is mandatory.</para>
5937
5938 <xi:include href="version-info.xml" xpointer="v246"/>
5939 </listitem>
5940 </varlistentry>
5941
5942 <varlistentry>
5943 <term><varname>CeilRate=</varname></term>
5944 <listitem>
5945 <para>Specifies the maximum rate at which a class can send, if its parent has bandwidth to spare.
5946 When suffixed with K, M, or G, the specified size is parsed as Kilobits, Megabits, or Gigabits,
5947 respectively, to the base of 1000. When unset, the value specified with <varname>Rate=</varname>
5948 is used.</para>
5949
5950 <xi:include href="version-info.xml" xpointer="v246"/>
5951 </listitem>
5952 </varlistentry>
5953
5954 <varlistentry>
5955 <term><varname>BufferBytes=</varname></term>
5956 <listitem>
5957 <para>Specifies the maximum bytes burst which can be accumulated during idle period. When suffixed
5958 with K, M, or G, the specified size is parsed as Kilobytes, Megabytes, or Gigabytes, respectively,
5959 to the base of 1024.</para>
5960
5961 <xi:include href="version-info.xml" xpointer="v246"/>
5962 </listitem>
5963 </varlistentry>
5964
5965 <varlistentry>
5966 <term><varname>CeilBufferBytes=</varname></term>
5967 <listitem>
5968 <para>Specifies the maximum bytes burst for ceil which can be accumulated during idle period.
5969 When suffixed with K, M, or G, the specified size is parsed as Kilobytes, Megabytes, or Gigabytes,
5970 respectively, to the base of 1024.</para>
5971
5972 <xi:include href="version-info.xml" xpointer="v246"/>
5973 </listitem>
5974 </varlistentry>
5975 </variablelist>
5976 </refsect1>
5977
5978 <refsect1>
5979 <title>[HeavyHitterFilter] Section Options</title>
5980 <para>The [HeavyHitterFilter] section manages the queueing discipline (qdisc) of Heavy Hitter Filter
5981 (hhf).</para>
5982
5983 <variablelist class='network-directives'>
5984 <xi:include href="tc.xml" xpointer="qdisc-parent" />
5985 <xi:include href="tc.xml" xpointer="qdisc-handle" />
5986
5987 <varlistentry>
5988 <term><varname>PacketLimit=</varname></term>
5989 <listitem>
5990 <para>Specifies the hard limit on the queue size in number of packets. When this limit is reached,
5991 incoming packets are dropped. An unsigned integer in the range 04294967294. Defaults to unset and
5992 kernel's default is used.</para>
5993
5994 <xi:include href="version-info.xml" xpointer="v246"/>
5995 </listitem>
5996 </varlistentry>
5997 </variablelist>
5998 </refsect1>
5999
6000 <refsect1>
6001 <title>[QuickFairQueueing] Section Options</title>
6002 <para>The [QuickFairQueueing] section manages the queueing discipline (qdisc) of Quick Fair Queueing
6003 (QFQ).</para>
6004
6005 <variablelist class='network-directives'>
6006 <xi:include href="tc.xml" xpointer="qdisc-parent" />
6007 <xi:include href="tc.xml" xpointer="qdisc-handle" />
6008 </variablelist>
6009 </refsect1>
6010
6011 <refsect1>
6012 <title>[QuickFairQueueingClass] Section Options</title>
6013 <para>The [QuickFairQueueingClass] section manages the traffic control class of Quick Fair Queueing
6014 (qfq).</para>
6015
6016 <variablelist class='network-directives'>
6017 <xi:include href="tc.xml" xpointer="tclass-parent" />
6018 <xi:include href="tc.xml" xpointer="tclass-classid" />
6019
6020 <varlistentry>
6021 <term><varname>Weight=</varname></term>
6022 <listitem>
6023 <para>Specifies the weight of the class. Takes an integer in the range 11023. Defaults to
6024 unset in which case the kernel default is used.</para>
6025
6026 <xi:include href="version-info.xml" xpointer="v246"/>
6027 </listitem>
6028 </varlistentry>
6029
6030 <varlistentry>
6031 <term><varname>MaxPacketBytes=</varname></term>
6032 <listitem>
6033 <para>Specifies the maximum packet size in bytes for the class. When suffixed with K, M, or G, the
6034 specified size is parsed as Kilobytes, Megabytes, or Gigabytes, respectively, to the base of
6035 1024. When unset, the kernel default is used.</para>
6036
6037 <xi:include href="version-info.xml" xpointer="v246"/>
6038 </listitem>
6039 </varlistentry>
6040 </variablelist>
6041 </refsect1>
6042
6043 <refsect1>
6044 <title>[BridgeVLAN] Section Options</title>
6045 <para>
6046 The [BridgeVLAN] section manages the VLAN ID configurations of a bridge master or port, and accepts the
6047 following keys. To make the settings in this section take an effect,
6048 <varname>VLANFiltering=</varname> option has to be enabled on the bridge master, see the [Bridge]
6049 section in
6050 <citerefentry><refentrytitle>systemd.netdev</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
6051 If at least one valid settings specified in this section in a .network file for an interface, all
6052 assigned VLAN IDs on the interface that are not configured in the .network file will be removed. If
6053 VLAN IDs on an interface need to be managed by other tools, then the settings in this section cannot
6054 be used in the matching .network file.
6055 </para>
6056
6057 <variablelist class='network-directives'>
6058 <varlistentry>
6059 <term><varname>VLAN=</varname></term>
6060 <listitem>
6061 <para>The VLAN ID allowed on the port. This can be either a single ID or a range M-N. Takes an
6062 integer in the range 14094. This setting can be specified multiple times. If an empty string is
6063 assigned, then the all previous assignments are cleared.</para>
6064
6065 <xi:include href="version-info.xml" xpointer="v231"/>
6066 </listitem>
6067 </varlistentry>
6068 <varlistentry>
6069 <term><varname>EgressUntagged=</varname></term>
6070 <listitem>
6071 <para>The VLAN ID specified here will be used to untag frames on egress. Configuring
6072 <varname>EgressUntagged=</varname> implicates the use of <varname>VLAN=</varname> above and will
6073 enable the VLAN ID for ingress as well. This can be either a single ID or a range M-N. This
6074 setting can be specified multiple times. If an empty string is assigned, then the all previous
6075 assignments are cleared.</para>
6076
6077 <xi:include href="version-info.xml" xpointer="v231"/>
6078 </listitem>
6079 </varlistentry>
6080 <varlistentry>
6081 <term><varname>PVID=</varname></term>
6082 <listitem>
6083 <para>The port VLAN ID specified here is assigned to all untagged frames at ingress. Takes an
6084 VLAN ID or negative boolean value (e.g. <literal>no</literal>). When false, the currently
6085 assigned port VLAN ID will be dropped. Configuring <varname>PVID=</varname> implicates the use of
6086 <varname>VLAN=</varname> setting in the above and will enable the VLAN ID for ingress as well.
6087 Defaults to unset, and will keep the assigned port VLAN ID if exists.</para>
6088
6089 <xi:include href="version-info.xml" xpointer="v231"/>
6090 </listitem>
6091 </varlistentry>
6092 </variablelist>
6093 </refsect1>
6094
6095 <refsect1>
6096 <title>Examples</title>
6097 <example>
6098 <title>Static network configuration</title>
6099
6100 <programlisting># /etc/systemd/network/50-static.network
6101 [Match]
6102 Name=enp2s0
6103
6104 [Network]
6105 Address=192.168.0.15/24
6106 Gateway=192.168.0.1</programlisting>
6107
6108 <para>This brings interface <literal>enp2s0</literal> up with a static address. The
6109 specified gateway will be used for a default route.</para>
6110 </example>
6111
6112 <example>
6113 <title>DHCP on ethernet links</title>
6114
6115 <programlisting># /etc/systemd/network/80-dhcp.network
6116 [Match]
6117 Name=en*
6118
6119 [Network]
6120 DHCP=yes</programlisting>
6121
6122 <para>This will enable DHCPv4 and DHCPv6 on all interfaces with names starting with
6123 <literal>en</literal> (i.e. ethernet interfaces).</para>
6124 </example>
6125
6126 <example>
6127 <title>IPv6 Prefix Delegation (DHCPv6 PD)</title>
6128
6129 <programlisting># /etc/systemd/network/55-dhcpv6-pd-upstream.network
6130 [Match]
6131 Name=enp1s0
6132
6133 [Network]
6134 DHCP=ipv6
6135
6136 # The below setting is optional, to also assign an address in the delegated prefix
6137 # to the upstream interface. If not necessary, then comment out the line below and
6138 # the [DHCPPrefixDelegation] section.
6139 DHCPPrefixDelegation=yes
6140
6141 # If the upstream network provides Router Advertisement with Managed bit set,
6142 # then comment out the line below and WithoutRA= setting in the [DHCPv6] section.
6143 IPv6AcceptRA=no
6144
6145 [DHCPv6]
6146 WithoutRA=solicit
6147
6148 [DHCPPrefixDelegation]
6149 UplinkInterface=:self
6150 SubnetId=0
6151 Announce=no</programlisting>
6152
6153 <programlisting># /etc/systemd/network/55-dhcpv6-pd-downstream.network
6154 [Match]
6155 Name=enp2s0
6156
6157 [Network]
6158 DHCPPrefixDelegation=yes
6159 IPv6SendRA=yes
6160
6161 # It is expected that the host is acting as a router. So, usually it is not
6162 # necessary to receive Router Advertisement from other hosts in the downstream network.
6163 IPv6AcceptRA=no
6164
6165 [DHCPPrefixDelegation]
6166 UplinkInterface=enp1s0
6167 SubnetId=1
6168 Announce=yes</programlisting>
6169
6170 <para>This will enable DHCPv6-PD on the interface enp1s0 as an upstream interface where the
6171 DHCPv6 client is running and enp2s0 as a downstream interface where the prefix is delegated to.
6172 The delegated prefixes are distributed by IPv6 Router Advertisement on the downstream network.
6173 </para>
6174 </example>
6175
6176 <example>
6177 <title>IPv6 Prefix Delegation (DHCPv4 6RD)</title>
6178
6179 <programlisting># /etc/systemd/network/55-dhcpv4-6rd-upstream.network
6180 [Match]
6181 Name=enp1s0
6182
6183 [Network]
6184 DHCP=ipv4
6185
6186 # When DHCPv4-6RD is used, the upstream network does not support IPv6.
6187 # Hence, it is not necessary to wait for Router Advertisement, which is enabled by default.
6188 IPv6AcceptRA=no
6189
6190 [DHCPv4]
6191 Use6RD=yes</programlisting>
6192
6193 <programlisting># /etc/systemd/network/55-dhcpv4-6rd-downstream.network
6194 [Match]
6195 Name=enp2s0
6196
6197 [Network]
6198 DHCPPrefixDelegation=yes
6199 IPv6SendRA=yes
6200
6201 # It is expected that the host is acting as a router. So, usually it is not
6202 # necessary to receive Router Advertisement from other hosts in the downstream network.
6203 IPv6AcceptRA=no
6204
6205 [DHCPPrefixDelegation]
6206 UplinkInterface=enp1s0
6207 SubnetId=1
6208 Announce=yes</programlisting>
6209
6210 <para>This will enable DHCPv4-6RD on the interface enp1s0 as an upstream interface where the
6211 DHCPv4 client is running and enp2s0 as a downstream interface where the prefix is delegated to.
6212 The delegated prefixes are distributed by IPv6 Router Advertisement on the downstream network.
6213 </para>
6214 </example>
6215
6216 <example>
6217 <title>A bridge with two enslaved links</title>
6218
6219 <programlisting># /etc/systemd/network/25-bridge-static.netdev
6220 [NetDev]
6221 Name=bridge0
6222 Kind=bridge</programlisting>
6223
6224 <programlisting># /etc/systemd/network/25-bridge-static.network
6225 [Match]
6226 Name=bridge0
6227
6228 [Network]
6229 Address=192.168.0.15/24
6230 Gateway=192.168.0.1
6231 DNS=192.168.0.1</programlisting>
6232
6233 <programlisting># /etc/systemd/network/25-bridge-slave-interface-1.network
6234 [Match]
6235 Name=enp2s0
6236
6237 [Network]
6238 Bridge=bridge0</programlisting>
6239
6240 <programlisting># /etc/systemd/network/25-bridge-slave-interface-2.network
6241 [Match]
6242 Name=wlp3s0
6243
6244 [Network]
6245 Bridge=bridge0</programlisting>
6246
6247 <para>This creates a bridge and attaches devices <literal>enp2s0</literal> and
6248 <literal>wlp3s0</literal> to it. The bridge will have the specified static address
6249 and network assigned, and a default route via the specified gateway will be
6250 added. The specified DNS server will be added to the global list of DNS resolvers.
6251 </para>
6252 </example>
6253
6254 <example>
6255 <title>Bridge port with VLAN forwarding</title>
6256
6257 <programlisting>
6258 # /etc/systemd/network/25-bridge-slave-interface-1.network
6259 [Match]
6260 Name=enp2s0
6261
6262 [Network]
6263 Bridge=bridge0
6264
6265 [BridgeVLAN]
6266 VLAN=1-32
6267 PVID=42
6268 EgressUntagged=42
6269
6270 [BridgeVLAN]
6271 VLAN=100-200
6272
6273 [BridgeVLAN]
6274 EgressUntagged=300-400</programlisting>
6275
6276 <para>This overrides the configuration specified in the previous example for the
6277 interface <literal>enp2s0</literal>, and enables VLAN on that bridge port. VLAN IDs
6278 1-32, 42, 100-400 will be allowed. Packets tagged with VLAN IDs 42, 300-400 will be
6279 untagged when they leave on this interface. Untagged packets which arrive on this
6280 interface will be assigned VLAN ID 42.</para>
6281 </example>
6282
6283 <example>
6284 <title>Various tunnels</title>
6285
6286 <programlisting>/etc/systemd/network/25-tunnels.network
6287 [Match]
6288 Name=ens1
6289
6290 [Network]
6291 Tunnel=ipip-tun
6292 Tunnel=sit-tun
6293 Tunnel=gre-tun
6294 Tunnel=vti-tun
6295 </programlisting>
6296
6297 <programlisting>/etc/systemd/network/25-tunnel-ipip.netdev
6298 [NetDev]
6299 Name=ipip-tun
6300 Kind=ipip
6301 </programlisting>
6302
6303 <programlisting>/etc/systemd/network/25-tunnel-sit.netdev
6304 [NetDev]
6305 Name=sit-tun
6306 Kind=sit
6307 </programlisting>
6308
6309 <programlisting>/etc/systemd/network/25-tunnel-gre.netdev
6310 [NetDev]
6311 Name=gre-tun
6312 Kind=gre
6313 </programlisting>
6314
6315 <programlisting>/etc/systemd/network/25-tunnel-vti.netdev
6316 [NetDev]
6317 Name=vti-tun
6318 Kind=vti
6319 </programlisting>
6320
6321 <para>This will bring interface <literal>ens1</literal> up and create an IPIP tunnel,
6322 a SIT tunnel, a GRE tunnel, and a VTI tunnel using it.</para>
6323 </example>
6324
6325 <example>
6326 <title>A bond device</title>
6327
6328 <programlisting># /etc/systemd/network/30-bond1.network
6329 [Match]
6330 Name=bond1
6331
6332 [Network]
6333 DHCP=ipv6
6334 </programlisting>
6335
6336 <programlisting># /etc/systemd/network/30-bond1.netdev
6337 [NetDev]
6338 Name=bond1
6339 Kind=bond
6340 </programlisting>
6341
6342 <programlisting># /etc/systemd/network/30-bond1-dev1.network
6343 [Match]
6344 MACAddress=52:54:00:e9:64:41
6345
6346 [Network]
6347 Bond=bond1
6348 </programlisting>
6349
6350 <programlisting># /etc/systemd/network/30-bond1-dev2.network
6351 [Match]
6352 MACAddress=52:54:00:e9:64:42
6353
6354 [Network]
6355 Bond=bond1
6356 </programlisting>
6357
6358 <para>This will create a bond device <literal>bond1</literal> and enslave the two
6359 devices with MAC addresses 52:54:00:e9:64:41 and 52:54:00:e9:64:42 to it. IPv6 DHCP
6360 will be used to acquire an address.</para>
6361 </example>
6362
6363 <example>
6364 <title>Virtual Routing and Forwarding (VRF)</title>
6365 <para>Add the <literal>bond1</literal> interface to the VRF master interface
6366 <literal>vrf1</literal>. This will redirect routes generated on this interface to be
6367 within the routing table defined during VRF creation. For kernels before 4.8 traffic
6368 won't be redirected towards the VRFs routing table unless specific ip-rules are added.
6369 </para>
6370 <programlisting># /etc/systemd/network/25-vrf.network
6371 [Match]
6372 Name=bond1
6373
6374 [Network]
6375 VRF=vrf1
6376 </programlisting>
6377 </example>
6378
6379 <example>
6380 <title>MacVTap</title>
6381 <para>This brings up a network interface <literal>macvtap-test</literal>
6382 and attaches it to <literal>enp0s25</literal>.</para>
6383 <programlisting># /usr/lib/systemd/network/25-macvtap.network
6384 [Match]
6385 Name=enp0s25
6386
6387 [Network]
6388 MACVTAP=macvtap-test
6389 </programlisting>
6390 </example>
6391
6392 <example>
6393 <title>A Xfrm interface with physical underlying device.</title>
6394
6395 <programlisting># /etc/systemd/network/27-xfrm.netdev
6396 [NetDev]
6397 Name=xfrm0
6398 Kind=xfrm
6399
6400 [Xfrm]
6401 InterfaceId=7</programlisting>
6402
6403 <programlisting># /etc/systemd/network/27-eth0.network
6404 [Match]
6405 Name=eth0
6406
6407 [Network]
6408 Xfrm=xfrm0</programlisting>
6409
6410 <para>This creates a <literal>xfrm0</literal> interface and binds it to the <literal>eth0</literal> device.
6411 This allows hardware based ipsec offloading to the <literal>eth0</literal> nic.
6412 If offloading is not needed, xfrm interfaces can be assigned to the <literal>lo</literal> device.
6413 </para>
6414 </example>
6415 </refsect1>
6416
6417 <refsect1>
6418 <title>See Also</title>
6419 <para><simplelist type="inline">
6420 <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member>
6421 <member><citerefentry><refentrytitle>systemd-networkd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member>
6422 <member><citerefentry><refentrytitle>systemd.link</refentrytitle><manvolnum>5</manvolnum></citerefentry></member>
6423 <member><citerefentry><refentrytitle>systemd.netdev</refentrytitle><manvolnum>5</manvolnum></citerefentry></member>
6424 <member><citerefentry><refentrytitle>systemd-network-generator.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member>
6425 <member><citerefentry><refentrytitle>systemd-resolved.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member>
6426 </simplelist></para>
6427 </refsect1>
6428
6429 </refentry>