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