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