]> git.ipfire.org Git - thirdparty/systemd.git/blob - man/systemd.network.xml
networkd: RPDB rule - add support to configure inverted rule.
[thirdparty/systemd.git] / man / systemd.network.xml
1 <?xml version='1.0'?>
2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
3 "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
4
5 <!--
6 SPDX-License-Identifier: LGPL-2.1+
7 -->
8
9 <refentry id="systemd.network" conditional='ENABLE_NETWORKD'>
10
11 <refentryinfo>
12 <title>systemd.network</title>
13 <productname>systemd</productname>
14 </refentryinfo>
15
16 <refmeta>
17 <refentrytitle>systemd.network</refentrytitle>
18 <manvolnum>5</manvolnum>
19 </refmeta>
20
21 <refnamediv>
22 <refname>systemd.network</refname>
23 <refpurpose>Network configuration</refpurpose>
24 </refnamediv>
25
26 <refsynopsisdiv>
27 <para><filename><replaceable>network</replaceable>.network</filename></para>
28 </refsynopsisdiv>
29
30 <refsect1>
31 <title>Description</title>
32
33 <para>Network setup is performed by
34 <citerefentry><refentrytitle>systemd-networkd</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
35 </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
41 network directory <filename>/usr/lib/systemd/network</filename>, the volatile runtime network
42 directory <filename>/run/systemd/network</filename> and the local administration network
43 directory <filename>/etc/systemd/network</filename>. All configuration files are collectively
44 sorted and processed in lexical order, regardless of the directories in which they live.
45 However, files with identical filenames replace each other. Files in <filename>/etc</filename>
46 have the highest priority, files in <filename>/run</filename> take precedence over files with
47 the same name in <filename>/usr/lib</filename>. This can be used to override a system-supplied
48 configuration file with a local file if needed. As a special case, an empty file (file size 0)
49 or symlink with the same name pointing to <filename>/dev/null</filename> disables the
50 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 netdev file wherever located. (Of course, since
64 <filename>/run</filename> is temporary and <filename>/usr/lib</filename> is for vendors, it is
65 unlikely drop-ins should be used in either of those places.)</para>
66
67 <para>Note that an interface without any static IPv6 addresses configured, and neither DHCPv6
68 nor IPv6LL enabled, shall be considered to have no IPv6 support. IPv6 will be automatically
69 disabled for that interface by writing "1" to
70 <filename>/proc/sys/net/ipv6/conf/<replaceable>ifname</replaceable>/disable_ipv6</filename>.
71 </para>
72 </refsect1>
73
74 <refsect1>
75 <title>[Match] Section Options</title>
76
77 <para>The network file contains a <literal>[Match]</literal>
78 section, which determines if a given network file may be applied
79 to a given device; and a <literal>[Network]</literal> section
80 specifying how the device should be configured. The first (in
81 lexical order) of the network files that matches a given device
82 is applied, all later files are ignored, even if they match as
83 well.</para>
84
85 <para>A network file is said to match a device if each of the
86 entries in the <literal>[Match]</literal> section matches, or if
87 the section is empty. The following keys are accepted:</para>
88
89 <variablelist class='network-directives'>
90 <varlistentry>
91 <term><varname>MACAddress=</varname></term>
92 <listitem>
93 <para>A whitespace-separated list of hardware addresses. Use full colon-, hyphen- or dot-delimited hexadecimal. See the example below.
94 This option may appear more than one, in which case the lists are merged. If the empty string is assigned to this option, the list
95 of hardware addresses defined prior to this is reset.</para>
96
97 <para>Example:
98 <programlisting>MACAddress=01:23:45:67:89:ab 00-11-22-33-44-55 AABB.CCDD.EEFF</programlisting></para>
99 </listitem>
100 </varlistentry>
101 <varlistentry>
102 <term><varname>Path=</varname></term>
103 <listitem>
104 <para>A whitespace-separated list of shell-style globs
105 matching the persistent path, as exposed by the udev
106 property <literal>ID_PATH</literal>. If the list is
107 prefixed with a "!", the test is inverted; i.e. it is
108 true when <literal>ID_PATH</literal> does not match any
109 item in the list.</para>
110 </listitem>
111 </varlistentry>
112 <varlistentry>
113 <term><varname>Driver=</varname></term>
114 <listitem>
115 <para>A whitespace-separated list of shell-style globs
116 matching the driver currently bound to the device, as
117 exposed by the udev property <literal>DRIVER</literal>
118 of its parent device, or if that is not set the driver
119 as exposed by <literal>ethtool -i</literal> of the
120 device itself. If the list is prefixed with a "!", the
121 test is inverted.</para>
122 </listitem>
123 </varlistentry>
124 <varlistentry>
125 <term><varname>Type=</varname></term>
126 <listitem>
127 <para>A whitespace-separated list of shell-style globs
128 matching the device type, as exposed by the udev property
129 <literal>DEVTYPE</literal>. If the list is prefixed with
130 a "!", the test is inverted.</para>
131 </listitem>
132 </varlistentry>
133 <varlistentry>
134 <term><varname>Name=</varname></term>
135 <listitem>
136 <para>A whitespace-separated list of shell-style globs
137 matching the device name, as exposed by the udev property
138 <literal>INTERFACE</literal>. If the list is prefixed
139 with a "!", the test is inverted.</para>
140 </listitem>
141 </varlistentry>
142 <varlistentry>
143 <term><varname>Host=</varname></term>
144 <listitem>
145 <para>Matches against the hostname or machine ID of the
146 host. See <literal>ConditionHost=</literal> in
147 <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>
148 for details.
149 </para>
150 </listitem>
151 </varlistentry>
152 <varlistentry>
153 <term><varname>Virtualization=</varname></term>
154 <listitem>
155 <para>Checks whether the system is executed in a virtualized
156 environment and optionally test whether it is a specific
157 implementation. See <literal>ConditionVirtualization=</literal> in
158 <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>
159 for details.
160 </para>
161 </listitem>
162 </varlistentry>
163 <varlistentry>
164 <term><varname>KernelCommandLine=</varname></term>
165 <listitem>
166 <para>Checks whether a specific kernel command line option is
167 set (or if prefixed with the exclamation mark unset). See
168 <literal>ConditionKernelCommandLine=</literal> in
169 <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>
170 for details.
171 </para>
172 </listitem>
173 </varlistentry>
174 <varlistentry>
175 <term><varname>KernelVersion=</varname></term>
176 <listitem>
177 <para>Checks whether the kernel version (as reported by <command>uname -r</command>) matches a certain
178 expression (or if prefixed with the exclamation mark does not match it). See
179 <literal>ConditionKernelVersion=</literal> in
180 <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry> for
181 details.
182 </para>
183 </listitem>
184 </varlistentry>
185 <varlistentry>
186 <term><varname>Architecture=</varname></term>
187 <listitem>
188 <para>Checks whether the system is running on a specific
189 architecture. See <literal>ConditionArchitecture=</literal> in
190 <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>
191 for details.
192 </para>
193 </listitem>
194 </varlistentry>
195 </variablelist>
196
197 </refsect1>
198
199 <refsect1>
200 <title>[Link] Section Options</title>
201
202 <para> The <literal>[Link]</literal> section accepts the following keys:</para>
203
204 <variablelist class='network-directives'>
205 <varlistentry>
206 <term><varname>MACAddress=</varname></term>
207 <listitem>
208 <para>The hardware address to set for the device.</para>
209 </listitem>
210 </varlistentry>
211 <varlistentry>
212 <term><varname>MTUBytes=</varname></term>
213 <listitem>
214 <para>The maximum transmission unit in bytes to set for the
215 device. The usual suffixes K, M, G, are supported and are
216 understood to the base of 1024.</para>
217 <para>Note that if IPv6 is enabled on the interface, and the MTU is chosen
218 below 1280 (the minimum MTU for IPv6) it will automatically be increased to this value.</para>
219 </listitem>
220 </varlistentry>
221 <varlistentry>
222 <term><varname>ARP=</varname></term>
223 <listitem>
224 <para>Takes a boolean. If set to true, the ARP (low-level Address Resolution Protocol)
225 for this interface is enabled. When unset, the kernel's default will be used.</para>
226 <para> For example, disabling ARP is useful when creating multiple MACVLAN or VLAN virtual
227 interfaces atop a single lower-level physical interface, which will then only serve as a
228 link/"bridge" device aggregating traffic to the same physical link and not participate in
229 the network otherwise.</para>
230 </listitem>
231 </varlistentry>
232 <varlistentry>
233 <term><varname>Multicast=</varname></term>
234 <listitem>
235 <para>Takes a boolean. If set to true, the multicast flag on the device is enabled.</para>
236 </listitem>
237 </varlistentry>
238 <varlistentry>
239 <term><varname>AllMulticast=</varname></term>
240 <listitem>
241 <para>Takes a boolean. If set to true, the driver retrieves all multicast packets from the network.
242 This happens when multicast routing is enabled.</para>
243 </listitem>
244 </varlistentry>
245 <varlistentry>
246 <term><varname>Unmanaged=</varname></term>
247 <listitem>
248 <para>Takes a boolean. When <literal>yes</literal>, no attempts are
249 made to bring up or configure matching links, equivalent to
250 when there are no matching network files. Defaults to
251 <literal>no</literal>.</para>
252 <para>This is useful for preventing later matching network
253 files from interfering with certain interfaces that are fully
254 controlled by other applications.</para>
255 </listitem>
256 </varlistentry>
257 <varlistentry>
258 <term><varname>RequiredForOnline=</varname></term>
259 <listitem>
260 <para>Takes a boolean. When <literal>yes</literal>, the network is deemed
261 required when determining whether the system is online when running
262 <literal>systemd-networkd-wait-online</literal>.
263 When <literal>no</literal>, the network is ignored when checking for
264 online state. Defaults to <literal>yes</literal>.</para>
265 <para>The network will be brought up normally in all cases, but in
266 the event that there is no address being assigned by DHCP or the
267 cable is not plugged in, the link will simply remain offline and be
268 skipped automatically by <literal>systemd-networkd-wait-online</literal>
269 if <literal>RequiredForOnline=no</literal>.</para>
270 </listitem>
271 </varlistentry>
272 </variablelist>
273 </refsect1>
274
275 <refsect1>
276 <title>[Network] Section Options</title>
277
278 <para>The <literal>[Network]</literal> section accepts the following keys:</para>
279
280 <variablelist class='network-directives'>
281 <varlistentry>
282 <term><varname>Description=</varname></term>
283 <listitem>
284 <para>A description of the device. This is only used for
285 presentation purposes.</para>
286 </listitem>
287 </varlistentry>
288 <varlistentry>
289 <term><varname>DHCP=</varname></term>
290 <listitem>
291 <para>Enables DHCPv4 and/or DHCPv6 client support. Accepts
292 <literal>yes</literal>, <literal>no</literal>,
293 <literal>ipv4</literal>, or <literal>ipv6</literal>. Defaults
294 to <literal>no</literal>.</para>
295
296 <para>Note that DHCPv6 will by default be triggered by Router
297 Advertisement, if that is enabled, regardless of this parameter.
298 By enabling DHCPv6 support explicitly, the DHCPv6 client will
299 be started regardless of the presence of routers on the link,
300 or what flags the routers pass. See
301 <literal>IPv6AcceptRA=</literal>.</para>
302
303 <para>Furthermore, note that by default the domain name
304 specified through DHCP is not used for name resolution.
305 See option <option>UseDomains=</option> below.</para>
306
307 <para>See the <literal>[DHCP]</literal> section below for further configuration options for the DHCP client
308 support.</para>
309 </listitem>
310 </varlistentry>
311 <varlistentry>
312 <term><varname>DHCPServer=</varname></term>
313 <listitem>
314 <para>Takes a boolean. If set to <literal>yes</literal>, DHCPv4 server will be start. Defaults
315 to <literal>no</literal>. Further settings for the DHCP
316 server may be set in the <literal>[DHCPServer]</literal>
317 section described below.</para>
318 </listitem>
319 </varlistentry>
320 <varlistentry>
321 <term><varname>LinkLocalAddressing=</varname></term>
322 <listitem>
323 <para>Enables link-local address autoconfiguration. Accepts
324 <literal>yes</literal>, <literal>no</literal>,
325 <literal>ipv4</literal>, or <literal>ipv6</literal>. Defaults to
326 <literal>ipv6</literal>.</para>
327 </listitem>
328 </varlistentry>
329 <varlistentry>
330 <term><varname>IPv4LLRoute=</varname></term>
331 <listitem>
332 <para>Takes a boolean. If set to true, sets up the route needed for
333 non-IPv4LL hosts to communicate with IPv4LL-only hosts. Defaults
334 to false.
335 </para>
336 </listitem>
337 </varlistentry>
338 <varlistentry>
339 <term><varname>IPv6Token=</varname></term>
340 <listitem>
341 <para>An IPv6 address with the top 64 bits unset. When set, indicates the
342 64-bit interface part of SLAAC IPv6 addresses for this link. Note that
343 the token is only ever used for SLAAC, and not for DHCPv6 addresses, even
344 in the case DHCP is requested by router advertisement. By default, the
345 token is autogenerated.</para>
346 </listitem>
347 </varlistentry>
348 <varlistentry>
349 <term><varname>LLMNR=</varname></term>
350 <listitem>
351 <para>Takes a boolean or <literal>resolve</literal>. When true,
352 enables <ulink
353 url="https://tools.ietf.org/html/rfc4795">Link-Local
354 Multicast Name Resolution</ulink> on the link. When set to
355 <literal>resolve</literal>, only resolution is enabled,
356 but not host registration and announcement. Defaults to
357 true. This setting is read by
358 <citerefentry><refentrytitle>systemd-resolved.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
359 </listitem>
360 </varlistentry>
361 <varlistentry>
362 <term><varname>MulticastDNS=</varname></term>
363 <listitem>
364 <para>Takes a boolean or <literal>resolve</literal>. When true,
365 enables <ulink
366 url="https://tools.ietf.org/html/rfc6762">Multicast
367 DNS</ulink> support on the link. When set to
368 <literal>resolve</literal>, only resolution is enabled,
369 but not host or service registration and
370 announcement. Defaults to false. This setting is read by
371 <citerefentry><refentrytitle>systemd-resolved.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
372 </listitem>
373 </varlistentry>
374 <varlistentry>
375 <term><varname>DNSOverTLS=</varname></term>
376 <listitem>
377 <para>Takes false or
378 <literal>opportunistic</literal>. When set to <literal>opportunistic</literal>, enables
379 <ulink
380 url="https://tools.ietf.org/html/rfc7858">DNS-over-TLS</ulink>
381 support on the link. This option defines a
382 per-interface setting for
383 <citerefentry><refentrytitle>resolved.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>'s
384 global <varname>DNSOverTLS=</varname> option. Defaults to
385 false. This setting is read by
386 <citerefentry><refentrytitle>systemd-resolved.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
387 </listitem>
388 </varlistentry>
389 <varlistentry>
390 <term><varname>DNSSEC=</varname></term>
391 <listitem>
392 <para>Takes a boolean. or
393 <literal>allow-downgrade</literal>. When true, enables
394 <ulink
395 url="https://tools.ietf.org/html/rfc4033">DNSSEC</ulink>
396 DNS validation support on the link. When set to
397 <literal>allow-downgrade</literal>, compatibility with
398 non-DNSSEC capable networks is increased, by automatically
399 turning off DNSSEC in this case. This option defines a
400 per-interface setting for
401 <citerefentry><refentrytitle>resolved.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>'s
402 global <varname>DNSSEC=</varname> option. Defaults to
403 false. This setting is read by
404 <citerefentry><refentrytitle>systemd-resolved.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
405 </listitem>
406 </varlistentry>
407 <varlistentry>
408 <term><varname>DNSSECNegativeTrustAnchors=</varname></term>
409 <listitem><para>A space-separated list of DNSSEC negative
410 trust anchor domains. If specified and DNSSEC is enabled,
411 look-ups done via the interface's DNS server will be subject
412 to the list of negative trust anchors, and not require
413 authentication for the specified domains, or anything below
414 it. Use this to disable DNSSEC authentication for specific
415 private domains, that cannot be proven valid using the
416 Internet DNS hierarchy. Defaults to the empty list. This
417 setting is read by
418 <citerefentry><refentrytitle>systemd-resolved.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
419 </listitem>
420 </varlistentry>
421 <varlistentry>
422 <term><varname>LLDP=</varname></term>
423 <listitem>
424 <para>Controls support for Ethernet LLDP packet reception. LLDP is a link-layer protocol commonly
425 implemented on professional routers and bridges which announces which physical port a system is connected
426 to, as well as other related data. Accepts a boolean or the special value
427 <literal>routers-only</literal>. When true, incoming LLDP packets are accepted and a database of all LLDP
428 neighbors maintained. If <literal>routers-only</literal> is set only LLDP data of various types of routers
429 is collected and LLDP data about other types of devices ignored (such as stations, telephones and
430 others). If false, LLDP reception is disabled. Defaults to <literal>routers-only</literal>. Use
431 <citerefentry><refentrytitle>networkctl</refentrytitle><manvolnum>1</manvolnum></citerefentry> to query the
432 collected neighbor data. LLDP is only available on Ethernet links. See <varname>EmitLLDP=</varname> below
433 for enabling LLDP packet emission from the local system.
434 </para>
435 </listitem>
436 </varlistentry>
437 <varlistentry>
438 <term><varname>EmitLLDP=</varname></term>
439 <listitem>
440 <para>Controls support for Ethernet LLDP packet emission. Accepts a boolean parameter or the special values
441 <literal>nearest-bridge</literal>, <literal>non-tpmr-bridge</literal> and
442 <literal>customer-bridge</literal>. Defaults to false, which turns off LLDP packet emission. If not false,
443 a short LLDP packet with information about the local system is sent out in regular intervals on the
444 link. The LLDP packet will contain information about the local host name, the local machine ID (as stored
445 in <citerefentry><refentrytitle>machine-id</refentrytitle><manvolnum>5</manvolnum></citerefentry>) and the
446 local interface name, as well as the pretty hostname of the system (as set in
447 <citerefentry><refentrytitle>machine-info</refentrytitle><manvolnum>5</manvolnum></citerefentry>). LLDP
448 emission is only available on Ethernet links. Note that this setting passes data suitable for
449 identification of host to the network and should thus not be enabled on untrusted networks, where such
450 identification data should not be made available. Use this option to permit other systems to identify on
451 which interfaces they are connected to this system. The three special values control propagation of the
452 LLDP packets. The <literal>nearest-bridge</literal> setting permits propagation only to the nearest
453 connected bridge, <literal>non-tpmr-bridge</literal> permits propagation across Two-Port MAC Relays, but
454 not any other bridges, and <literal>customer-bridge</literal> permits propagation until a customer bridge
455 is reached. For details about these concepts, see <ulink
456 url="https://standards.ieee.org/findstds/standard/802.1AB-2016.html">IEEE 802.1AB-2016</ulink>. Note that
457 configuring this setting to true is equivalent to <literal>nearest-bridge</literal>, the recommended and
458 most restricted level of propagation. See <varname>LLDP=</varname> above for an option to enable LLDP
459 reception.</para>
460 </listitem>
461 </varlistentry>
462 <varlistentry>
463 <term><varname>BindCarrier=</varname></term>
464 <listitem>
465 <para>A link name or a list of link names. When set, controls the behavior of the current
466 link. When all links in the list are in an operational down state, the current link is brought
467 down. When at least one link has carrier, the current interface is brought up.
468 </para>
469 </listitem>
470 </varlistentry>
471 <varlistentry>
472 <term><varname>Address=</varname></term>
473 <listitem>
474 <para>A static IPv4 or IPv6 address and its prefix length,
475 separated by a <literal>/</literal> character. Specify
476 this key more than once to configure several addresses.
477 The format of the address must be as described in
478 <citerefentry project='man-pages'><refentrytitle>inet_pton</refentrytitle><manvolnum>3</manvolnum></citerefentry>.
479 This is a short-hand for an [Address] section only
480 containing an Address key (see below). This option may be
481 specified more than once.
482 </para>
483
484 <para>If the specified address is 0.0.0.0 (for IPv4) or
485 [::] (for IPv6), a new address range of the requested size
486 is automatically allocated from a system-wide pool of
487 unused ranges. The allocated range is checked against all
488 current network interfaces and all known network
489 configuration files to avoid address range conflicts. The
490 default system-wide pool consists of 192.168.0.0/16,
491 172.16.0.0/12 and 10.0.0.0/8 for IPv4, and fc00::/7 for
492 IPv6. This functionality is useful to manage a large
493 number of dynamically created network interfaces with the
494 same network configuration and automatic address range
495 assignment.</para>
496
497 </listitem>
498 </varlistentry>
499 <varlistentry>
500 <term><varname>Gateway=</varname></term>
501 <listitem>
502 <para>The gateway address, which must be in the format
503 described in
504 <citerefentry project='man-pages'><refentrytitle>inet_pton</refentrytitle><manvolnum>3</manvolnum></citerefentry>.
505 This is a short-hand for a [Route] section only containing
506 a Gateway key. This option may be specified more than
507 once.</para>
508 </listitem>
509 </varlistentry>
510 <varlistentry>
511 <term><varname>DNS=</varname></term>
512 <listitem>
513 <para>A DNS server address, which must be in the format
514 described in
515 <citerefentry project='man-pages'><refentrytitle>inet_pton</refentrytitle><manvolnum>3</manvolnum></citerefentry>.
516 This option may be specified more than once. This setting is read by
517 <citerefentry><refentrytitle>systemd-resolved.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
518 </listitem>
519 </varlistentry>
520 <varlistentry>
521 <term><varname>Domains=</varname></term>
522 <listitem>
523 <para>A list of domains which should be resolved using the DNS servers on this link. Each item in the list
524 should be a domain name, optionally prefixed with a tilde (<literal>~</literal>). The domains with the
525 prefix are called "routing-only domains". The domains without the prefix are called "search domains" and
526 are first used as search suffixes for extending single-label host names (host names containing no dots) to
527 become fully qualified domain names (FQDNs). If a single-label host name is resolved on this interface,
528 each of the specified search domains are appended to it in turn, converting it into a fully qualified
529 domain name, until one of them may be successfully resolved.</para>
530
531 <para>Both "search" and "routing-only" domains are used for routing of DNS queries: look-ups for host names
532 ending in those domains (hence also single label names, if any "search domains" are listed), are routed to
533 the DNS servers configured for this interface. The domain routing logic is particularly useful on
534 multi-homed hosts with DNS servers serving particular private DNS zones on each interface.</para>
535
536 <para>The "routing-only" domain <literal>~.</literal> (the tilde indicating definition of a routing domain,
537 the dot referring to the DNS root domain which is the implied suffix of all valid DNS names) has special
538 effect. It causes all DNS traffic which does not match another configured domain routing entry to be routed
539 to DNS servers specified for this interface. This setting is useful to prefer a certain set of DNS servers
540 if a link on which they are connected is available.</para>
541
542 <para>This setting is read by
543 <citerefentry><refentrytitle>systemd-resolved.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
544 "Search domains" correspond to the <varname>domain</varname> and <varname>search</varname> entries in
545 <citerefentry project='man-pages'><refentrytitle>resolv.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
546 Domain name routing has no equivalent in the traditional glibc API, which has no concept of domain
547 name servers limited to a specific link.</para>
548 </listitem>
549 </varlistentry>
550 <varlistentry>
551 <term><varname>NTP=</varname></term>
552 <listitem>
553 <para>An NTP server address. This option may be specified more than once. This setting is read by
554 <citerefentry><refentrytitle>systemd-timesyncd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
555 </listitem>
556 </varlistentry>
557 <varlistentry>
558 <term><varname>IPForward=</varname></term>
559 <listitem><para>Configures IP packet forwarding for the
560 system. If enabled, incoming packets on any network
561 interface will be forwarded to any other interfaces
562 according to the routing table. Takes a boolean,
563 or the values <literal>ipv4</literal> or
564 <literal>ipv6</literal>, which only enable IP packet
565 forwarding for the specified address family. This controls
566 the <filename>net.ipv4.ip_forward</filename> and
567 <filename>net.ipv6.conf.all.forwarding</filename> sysctl
568 options of the network interface (see <ulink
569 url="https://www.kernel.org/doc/Documentation/networking/ip-sysctl.txt">ip-sysctl.txt</ulink>
570 for details about sysctl options). Defaults to
571 <literal>no</literal>.</para>
572
573 <para>Note: this setting controls a global kernel option,
574 and does so one way only: if a network that has this setting
575 enabled is set up the global setting is turned on. However,
576 it is never turned off again, even after all networks with
577 this setting enabled are shut down again.</para>
578
579 <para>To allow IP packet forwarding only between specific
580 network interfaces use a firewall.</para>
581 </listitem>
582 </varlistentry>
583 <varlistentry>
584 <term><varname>IPMasquerade=</varname></term>
585 <listitem><para>Configures IP masquerading for the network
586 interface. If enabled, packets forwarded from the network
587 interface will be appear as coming from the local host.
588 Takes a boolean argument. Implies
589 <varname>IPForward=ipv4</varname>. Defaults to
590 <literal>no</literal>.</para></listitem>
591 </varlistentry>
592 <varlistentry>
593 <term><varname>IPv6PrivacyExtensions=</varname></term>
594 <listitem><para>Configures use of stateless temporary
595 addresses that change over time (see <ulink
596 url="https://tools.ietf.org/html/rfc4941">RFC 4941</ulink>,
597 Privacy Extensions for Stateless Address Autoconfiguration
598 in IPv6). Takes a boolean or the special values
599 <literal>prefer-public</literal> and
600 <literal>kernel</literal>. When true, enables the privacy
601 extensions and prefers temporary addresses over public
602 addresses. When <literal>prefer-public</literal>, enables the
603 privacy extensions, but prefers public addresses over
604 temporary addresses. When false, the privacy extensions
605 remain disabled. When <literal>kernel</literal>, the kernel's
606 default setting will be left in place. Defaults to
607 <literal>no</literal>.</para></listitem>
608 </varlistentry>
609 <varlistentry>
610 <term><varname>IPv6AcceptRA=</varname></term>
611 <listitem><para>Takes a boolean. Controls IPv6 Router Advertisement (RA) reception support for the interface.
612 If true, RAs are accepted; if false, RAs are ignored, independently of the local forwarding state.
613 If unset, the kernel's default is used, and RAs are accepted only when local forwarding
614 is disabled for that interface. When RAs are accepted, they may trigger the start of the DHCPv6 client if
615 the relevant flags are set in the RA data, or if no routers are found on the link.</para>
616
617 <para>Further settings for the IPv6 RA support may be configured in the
618 <literal>[IPv6AcceptRA]</literal> section, see below.</para>
619
620 <para>Also see <ulink
621 url="https://www.kernel.org/doc/Documentation/networking/ip-sysctl.txt">ip-sysctl.txt</ulink> in the kernel
622 documentation regarding <literal>accept_ra</literal>, but note that systemd's setting of
623 <constant>1</constant> (i.e. true) corresponds to kernel's setting of <constant>2</constant>.</para>
624 </listitem>
625 </varlistentry>
626 <varlistentry>
627 <term><varname>IPv6DuplicateAddressDetection=</varname></term>
628 <listitem><para>Configures the amount of IPv6 Duplicate
629 Address Detection (DAD) probes to send. When unset, the kernel's default will be used.
630 </para></listitem>
631 </varlistentry>
632 <varlistentry>
633 <term><varname>IPv6HopLimit=</varname></term>
634 <listitem><para>Configures IPv6 Hop Limit. For each router that
635 forwards the packet, the hop limit is decremented by 1. When the
636 hop limit field reaches zero, the packet is discarded.
637 When unset, the kernel's default will be used.
638 </para></listitem>
639 </varlistentry>
640 <varlistentry>
641 <term><varname>IPv4ProxyARP=</varname></term>
642 <listitem><para>Takes a boolean. Configures proxy ARP for IPv4. Proxy ARP is the technique in which one host,
643 usually a router, answers ARP requests intended for another machine. By "faking" its identity,
644 the router accepts responsibility for routing packets to the "real" destination. (see <ulink
645 url="https://tools.ietf.org/html/rfc1027">RFC 1027</ulink>.
646 When unset, the kernel's default will be used.
647 </para></listitem>
648 </varlistentry>
649 <varlistentry>
650 <term><varname>IPv6ProxyNDP=</varname></term>
651 <listitem><para>Takes a boolean. Configures proxy NDP for IPv6. Proxy NDP (Neighbor Discovery
652 Protocol) is a technique for IPv6 to allow routing of addresses to a different
653 destination when peers expect them to be present on a certain physical link.
654 In this case a router answers Neighbour Advertisement messages intended for
655 another machine by offering its own MAC address as destination.
656 Unlike proxy ARP for IPv4, it is not enabled globally, but will only send Neighbour
657 Advertisement messages for addresses in the IPv6 neighbor proxy table,
658 which can also be shown by <command>ip -6 neighbour show proxy</command>.
659 systemd-networkd will control the per-interface `proxy_ndp` switch for each configured
660 interface depending on this option.
661 When unset, the kernel's default will be used.
662 </para></listitem>
663 </varlistentry>
664 <varlistentry>
665 <term><varname>IPv6ProxyNDPAddress=</varname></term>
666 <listitem><para>An IPv6 address, for which Neighbour Advertisement messages will be
667 proxied. This option may be specified more than once. systemd-networkd will add the
668 <option>IPv6ProxyNDPAddress=</option> entries to the kernel's IPv6 neighbor proxy table.
669 This option implies <option>IPv6ProxyNDP=yes</option> but has no effect if
670 <option>IPv6ProxyNDP</option> has been set to false. When unset, the kernel's default will be used.
671 </para></listitem>
672 </varlistentry>
673 <varlistentry>
674 <term><varname>IPv6PrefixDelegation=</varname></term>
675 <listitem><para>Whether to enable or disable Router Advertisement sending on a link.
676 Allowed values are <literal>static</literal> which distributes prefixes as defined in
677 the <literal>[IPv6PrefixDelegation]</literal> and any <literal>[IPv6Prefix]</literal>
678 sections, <literal>dhcpv6</literal> which requests prefixes using a DHCPv6 client
679 configured for another link and any values configured in the
680 <literal>[IPv6PrefixDelegation]</literal> section while ignoring all static prefix
681 configuration sections, <literal>yes</literal> which uses both static configuration
682 and DHCPv6, and <literal>false</literal> which turns off IPv6 prefix delegation
683 altogether. Defaults to <literal>false</literal>. See the
684 <literal>[IPv6PrefixDelegation]</literal> and the <literal>[IPv6Prefix]</literal>
685 sections for more configuration options.
686 </para></listitem>
687 </varlistentry>
688 <varlistentry>
689 <term><varname>IPv6MTUBytes=</varname></term>
690 <listitem><para>Configures IPv6 maximum transmission unit (MTU).
691 An integer greater than or equal to 1280 bytes. When unset, the kernel's default will be used.
692 </para></listitem>
693 </varlistentry>
694 <varlistentry>
695 <term><varname>Bridge=</varname></term>
696 <listitem>
697 <para>The name of the bridge to add the link to. See
698 <citerefentry><refentrytitle>systemd.netdev</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
699 </para>
700 </listitem>
701 </varlistentry>
702 <varlistentry>
703 <term><varname>Bond=</varname></term>
704 <listitem>
705 <para>The name of the bond to add the link to. See
706 <citerefentry><refentrytitle>systemd.netdev</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
707 </para>
708 </listitem>
709 </varlistentry>
710 <varlistentry>
711 <term><varname>VRF=</varname></term>
712 <listitem>
713 <para>The name of the VRF to add the link to. See
714 <citerefentry><refentrytitle>systemd.netdev</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
715 </para>
716 </listitem>
717 </varlistentry>
718 <varlistentry>
719 <term><varname>VLAN=</varname></term>
720 <listitem>
721 <para>The name of a VLAN to create on the link. See
722 <citerefentry><refentrytitle>systemd.netdev</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
723 This option may be specified more than once.</para>
724 </listitem>
725 </varlistentry>
726 <varlistentry>
727 <term><varname>IPVLAN=</varname></term>
728 <listitem>
729 <para>The name of a IPVLAN to create on the link. See
730 <citerefentry><refentrytitle>systemd.netdev</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
731 This option may be specified more than once.</para>
732 </listitem>
733 </varlistentry>
734 <varlistentry>
735 <term><varname>MACVLAN=</varname></term>
736 <listitem>
737 <para>The name of a MACVLAN to create on the link. See
738 <citerefentry><refentrytitle>systemd.netdev</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
739 This option may be specified more than once.</para>
740 </listitem>
741 </varlistentry>
742 <varlistentry>
743 <term><varname>VXLAN=</varname></term>
744 <listitem>
745 <para>The name of a VXLAN to create on the link. See
746 <citerefentry><refentrytitle>systemd.netdev</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
747 This option may be specified more than once.</para>
748 </listitem>
749 </varlistentry>
750 <varlistentry>
751 <term><varname>Tunnel=</varname></term>
752 <listitem>
753 <para>The name of a Tunnel to create on the link. See
754 <citerefentry><refentrytitle>systemd.netdev</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
755 This option may be specified more than once.</para>
756 </listitem>
757 </varlistentry>
758 <varlistentry>
759 <term><varname>ActiveSlave=</varname></term>
760 <listitem>
761 <para>Takes a boolean. Specifies the new active slave. The <literal>ActiveSlave=</literal>
762 option is only valid for following modes:
763 <literal>active-backup</literal>,
764 <literal>balance-alb</literal> and
765 <literal>balance-tlb</literal>. Defaults to false.
766 </para>
767 </listitem>
768 </varlistentry>
769 <varlistentry>
770 <term><varname>PrimarySlave=</varname></term>
771 <listitem>
772 <para>Takes a boolean. Specifies which slave is the primary device. The specified
773 device will always be the active slave while it is available. Only when the
774 primary is off-line will alternate devices be used. This is useful when
775 one slave is preferred over another, e.g. when one slave has higher throughput
776 than another. The <literal>PrimarySlave=</literal> option is only valid for
777 following modes:
778 <literal>active-backup</literal>,
779 <literal>balance-alb</literal> and
780 <literal>balance-tlb</literal>. Defaults to false.
781 </para>
782 </listitem>
783 </varlistentry>
784 <varlistentry>
785 <term><varname>ConfigureWithoutCarrier=</varname></term>
786 <listitem>
787 <para>Takes a boolean. Allows networkd to configure a specific link even if it has no carrier.
788 Defaults to false.
789 </para>
790 </listitem>
791 </varlistentry>
792 </variablelist>
793
794 </refsect1>
795
796 <refsect1>
797 <title>[Address] Section Options</title>
798
799 <para>An <literal>[Address]</literal> section accepts the
800 following keys. Specify several <literal>[Address]</literal>
801 sections to configure several addresses.</para>
802
803 <variablelist class='network-directives'>
804 <varlistentry>
805 <term><varname>Address=</varname></term>
806 <listitem>
807 <para>As in the <literal>[Network]</literal> section. This
808 key is mandatory.</para>
809 </listitem>
810 </varlistentry>
811 <varlistentry>
812 <term><varname>Peer=</varname></term>
813 <listitem>
814 <para>The peer address in a point-to-point connection.
815 Accepts the same format as the <literal>Address</literal>
816 key.</para>
817 </listitem>
818 </varlistentry>
819 <varlistentry>
820 <term><varname>Broadcast=</varname></term>
821 <listitem>
822 <para>The broadcast address, which must be in the format
823 described in
824 <citerefentry project='man-pages'><refentrytitle>inet_pton</refentrytitle><manvolnum>3</manvolnum></citerefentry>.
825 This key only applies to IPv4 addresses. If it is not
826 given, it is derived from the <literal>Address</literal>
827 key.</para>
828 </listitem>
829 </varlistentry>
830 <varlistentry>
831 <term><varname>Label=</varname></term>
832 <listitem>
833 <para>An address label.</para>
834 </listitem>
835 </varlistentry>
836 <varlistentry>
837 <term><varname>PreferredLifetime=</varname></term>
838 <listitem>
839 <para>Allows the default "preferred lifetime" of the address to be overridden.
840 Only three settings are accepted: <literal>forever</literal> or <literal>infinity</literal>
841 which is the default and means that the address never expires, and <literal>0</literal> which means
842 that the address is considered immediately "expired" and will not be used,
843 unless explicitly requested. A setting of PreferredLifetime=0 is useful for
844 addresses which are added to be used only by a specific application,
845 which is then configured to use them explicitly.</para>
846 </listitem>
847 </varlistentry>
848 <varlistentry>
849 <term><varname>Scope=</varname></term>
850 <listitem>
851 <para>The scope of the address, which can be <literal>global</literal>,
852 <literal>link</literal> or <literal>host</literal> or an unsigned integer ranges 0 to 255.
853 Defaults to <literal>global</literal>.</para>
854 </listitem>
855 </varlistentry>
856 <varlistentry>
857 <term><varname>HomeAddress=</varname></term>
858 <listitem>
859 <para>Takes a boolean. Designates this address the "home address" as defined in
860 <ulink url="https://tools.ietf.org/html/rfc6275">RFC 6275</ulink>.
861 Supported only on IPv6. Defaults to false.</para>
862 </listitem>
863 </varlistentry>
864 <varlistentry>
865 <term><varname>DuplicateAddressDetection=</varname></term>
866 <listitem>
867 <para>Takes a boolean. Do not perform Duplicate Address Detection
868 <ulink url="https://tools.ietf.org/html/rfc4862">RFC 4862</ulink> when adding this address.
869 Supported only on IPv6. Defaults to false.</para>
870 </listitem>
871 </varlistentry>
872 <varlistentry>
873 <term><varname>ManageTemporaryAddress=</varname></term>
874 <listitem>
875 <para>Takes a boolean. If true the kernel manage temporary addresses created
876 from this one as template on behalf of Privacy Extensions
877 <ulink url="https://tools.ietf.org/html/rfc3041">RFC 3041</ulink>. For this to become
878 active, the use_tempaddr sysctl setting has to be set to a value greater than zero.
879 The given address needs to have a prefix length of 64. This flag allows to use privacy
880 extensions in a manually configured network, just like if stateless auto-configuration
881 was active. Defaults to false. </para>
882 </listitem>
883 </varlistentry>
884 <varlistentry>
885 <term><varname>PrefixRoute=</varname></term>
886 <listitem>
887 <para>Takes a boolean. When adding or modifying an IPv6 address, the userspace
888 application needs a way to suppress adding a prefix route. This is for example relevant
889 together with IFA_F_MANAGERTEMPADDR, where userspace creates autoconf generated addresses,
890 but depending on on-link, no route for the prefix should be added. Defaults to false.</para>
891 </listitem>
892 </varlistentry>
893 <varlistentry>
894 <term><varname>AutoJoin=</varname></term>
895 <listitem>
896 <para>Takes a boolean. Joining multicast group on ethernet level via
897 <command>ip maddr</command> command would not work if we have an Ethernet switch that does
898 IGMP snooping since the switch would not replicate multicast packets on ports that did not
899 have IGMP reports for the multicast addresses. Linux vxlan interfaces created via
900 <command>ip link add vxlan</command> or networkd's netdev kind vxlan have the group option
901 that enables then to do the required join. By extending ip address command with option
902 <literal>autojoin</literal> we can get similar functionality for openvswitch (OVS) vxlan
903 interfaces as well as other tunneling mechanisms that need to receive multicast traffic.
904 Defaults to <literal>no</literal>.</para>
905 </listitem>
906 </varlistentry>
907 </variablelist>
908 </refsect1>
909
910 <refsect1>
911 <title>[IPv6AddressLabel] Section Options</title>
912
913 <para>An <literal>[IPv6AddressLabel]</literal> section accepts the
914 following keys. Specify several <literal>[IPv6AddressLabel]</literal>
915 sections to configure several address labels. IPv6 address labels are
916 used for address selection. See <ulink url="https://tools.ietf.org/html/rfc3484">RFC 3484</ulink>.
917 Precedence is managed by userspace, and only the label itself is stored in the kernel</para>
918
919 <variablelist class='network-directives'>
920 <varlistentry>
921 <term><varname>Label=</varname></term>
922 <listitem>
923 <para> The label for the prefix (an unsigned integer) ranges 0 to 4294967294.
924 0xffffffff is reserved. This key is mandatory.</para>
925 </listitem>
926 </varlistentry>
927 <varlistentry>
928 <term><varname>Prefix=</varname></term>
929 <listitem>
930 <para>IPv6 prefix is an address with a prefix length, separated by a slash <literal>/</literal> character.
931 This key is mandatory. </para>
932 </listitem>
933 </varlistentry>
934 </variablelist>
935 </refsect1>
936
937 <refsect1>
938 <title>[RoutingPolicyRule] Section Options</title>
939
940 <para>An <literal>[RoutingPolicyRule]</literal> section accepts the
941 following keys. Specify several <literal>[RoutingPolicyRule]</literal>
942 sections to configure several rules.</para>
943
944 <variablelist class='network-directives'>
945 <varlistentry>
946 <term><varname>TypeOfService=</varname></term>
947 <listitem>
948 <para>Specifies the type of service to match a number between 0 to 255.</para>
949 </listitem>
950 </varlistentry>
951 <varlistentry>
952 <term><varname>From=</varname></term>
953 <listitem>
954 <para>Specifies the source address prefix to match. Possibly followed by a slash and the prefix length.</para>
955 </listitem>
956 </varlistentry>
957 <varlistentry>
958 <term><varname>To=</varname></term>
959 <listitem>
960 <para>Specifies the destination address prefix to match. Possibly followed by a slash and the prefix length.</para>
961 </listitem>
962 </varlistentry>
963 <varlistentry>
964 <term><varname>FirewallMark=</varname></term>
965 <listitem>
966 <para>Specifies the iptables firewall mark value to match (a number between 1 and 4294967295).</para>
967 </listitem>
968 </varlistentry>
969 <varlistentry>
970 <term><varname>Table=</varname></term>
971 <listitem>
972 <para>Specifies the routing table identifier to lookup if the rule
973 selector matches. The table identifier for a route (a number between 1 and 4294967295).</para>
974 </listitem>
975 </varlistentry>
976 <varlistentry>
977 <term><varname>Priority=</varname></term>
978 <listitem>
979 <para>Specifies the priority of this rule. <varname>Priority=</varname> is an unsigned
980 integer. Higher number means lower priority, and rules get processed in order of increasing number.</para>
981 </listitem>
982 </varlistentry>
983 <varlistentry>
984 <term><varname>IncomingInterface=</varname></term>
985 <listitem>
986 <para>Specifies incoming device to match. If the interface is loopback, the rule only matches packets originating from this host.</para>
987 </listitem>
988 </varlistentry>
989 <varlistentry>
990 <term><varname>OutgoingInterface=</varname></term>
991 <listitem>
992 <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>
993 </listitem>
994 </varlistentry>
995 <varlistentry>
996 <term><varname>SourcePort=</varname></term>
997 <listitem>
998 <para>Specifies the source IP port or IP port range match in forwarding information base (FIB) rules.
999 A port range is specified by the lower and upper port separated by a dash. Defaults to unset.</para>
1000 </listitem>
1001 </varlistentry>
1002 <varlistentry>
1003 <term><varname>DestinationPort=</varname></term>
1004 <listitem>
1005 <para>Specifies the destination IP port or IP port range match in forwarding information base (FIB) rules.
1006 A port range is specified by the lower and upper port separated by a dash. Defaults to unset.</para>
1007 </listitem>
1008 </varlistentry>
1009 <varlistentry>
1010 <term><varname>IPProtocol=</varname></term>
1011 <listitem>
1012 <para>Specifies the IP protocol to match in forwarding information base (FIB) rules. Takes IP protocol name such as <literal>tcp</literal>,
1013 <literal>udp</literal> or <literal>sctp</literal>, or IP protocol number such as <literal>6</literal> for <literal>tcp</literal> or
1014 <literal>17</literal> for <literal>udp</literal>.
1015 Defaults to unset.</para>
1016 </listitem>
1017 </varlistentry>
1018 <varlistentry>
1019 <term><varname>InvertRule=</varname></term>
1020 <listitem>
1021 <para>A boolean. Specifies wheather the rule to be inverted. Defaults to false.</para>
1022 </listitem>
1023 </varlistentry>
1024 </variablelist>
1025 </refsect1>
1026
1027 <refsect1>
1028 <title>[Route] Section Options</title>
1029 <para>The <literal>[Route]</literal> section accepts the
1030 following keys. Specify several <literal>[Route]</literal>
1031 sections to configure several routes.</para>
1032
1033 <variablelist class='network-directives'>
1034 <varlistentry>
1035 <term><varname>Gateway=</varname></term>
1036 <listitem>
1037 <para>As in the <literal>[Network]</literal> section.</para>
1038 </listitem>
1039 </varlistentry>
1040 <varlistentry>
1041 <term><varname>GatewayOnlink=</varname></term>
1042 <listitem>
1043 <para>Takes a boolean. If set to true, the kernel does not have
1044 to check if the gateway is reachable directly by the current machine (i.e., the kernel does
1045 not need to check if the gateway is attached to the local network), so that we can insert the
1046 route in the kernel table without it being complained about. Defaults to <literal>no</literal>.
1047 </para>
1048 </listitem>
1049 </varlistentry>
1050 <varlistentry>
1051 <term><varname>Destination=</varname></term>
1052 <listitem>
1053 <para>The destination prefix of the route. Possibly
1054 followed by a slash and the prefix length. If omitted, a
1055 full-length host route is assumed.</para>
1056 </listitem>
1057 </varlistentry>
1058 <varlistentry>
1059 <term><varname>Source=</varname></term>
1060 <listitem>
1061 <para>The source prefix of the route. Possibly followed by
1062 a slash and the prefix length. If omitted, a full-length
1063 host route is assumed.</para>
1064 </listitem>
1065 </varlistentry>
1066 <varlistentry>
1067 <term><varname>Metric=</varname></term>
1068 <listitem>
1069 <para>The metric of the route (an unsigned integer).</para>
1070 </listitem>
1071 </varlistentry>
1072 <varlistentry>
1073 <term><varname>IPv6Preference=</varname></term>
1074 <listitem>
1075 <para>Specifies the route preference as defined in <ulink
1076 url="https://tools.ietf.org/html/rfc4191">RFC4191</ulink> for Router Discovery messages.
1077 Which can be one of <literal>low</literal> the route has a lowest priority,
1078 <literal>medium</literal> the route has a default priority or
1079 <literal>high</literal> the route has a highest priority.</para>
1080 </listitem>
1081 </varlistentry>
1082 <varlistentry>
1083 <term><varname>Scope=</varname></term>
1084 <listitem>
1085 <para>The scope of the route, which can be <literal>global</literal>,
1086 <literal>link</literal> or <literal>host</literal>. Defaults to
1087 <literal>global</literal>.</para>
1088 </listitem>
1089 </varlistentry>
1090 <varlistentry>
1091 <term><varname>PreferredSource=</varname></term>
1092 <listitem>
1093 <para>The preferred source address of the route. The address
1094 must be in the format described in
1095 <citerefentry project='man-pages'><refentrytitle>inet_pton</refentrytitle><manvolnum>3</manvolnum></citerefentry>.</para>
1096 </listitem>
1097 </varlistentry>
1098 <varlistentry>
1099 <term><varname>Table=<replaceable>num</replaceable></varname></term>
1100 <listitem>
1101 <para>The table identifier for the route (a number between 1 and 4294967295, or 0 to unset).
1102 The table can be retrieved using <command>ip route show table <replaceable>num</replaceable></command>.
1103 </para>
1104 </listitem>
1105 </varlistentry>
1106 <varlistentry>
1107 <term><varname>Protocol=</varname></term>
1108 <listitem>
1109 <para>The protocol identifier for the route. Takes a number between 0 and 255 or the special values
1110 <literal>kernel</literal>, <literal>boot</literal> and <literal>static</literal>. Defaults to
1111 <literal>static</literal>.
1112 </para>
1113 </listitem>
1114 </varlistentry>
1115 <varlistentry>
1116 <term><varname>Type=</varname></term>
1117 <listitem>
1118 <para>Specifies the type for the route. If <literal>unicast</literal>, a regular route is defined, i.e. a
1119 route indicating the path to take to a destination network address. If <literal>blackhole</literal>, packets
1120 to the defined route are discarded silently. If <literal>unreachable</literal>, packets to the defined route
1121 are discarded and the ICMP message "Host Unreachable" is generated. If <literal>prohibit</literal>, packets
1122 to the defined route are discarded and the ICMP message "Communication Administratively Prohibited" is
1123 generated. If <literal>throw</literal>, route lookup in the current routing table will fail and the route
1124 selection process will return to Routing Policy Database (RPDB). Defaults to <literal>unicast</literal>.
1125 </para>
1126 </listitem>
1127 </varlistentry>
1128 <varlistentry>
1129 <term><varname>InitialCongestionWindow=</varname></term>
1130 <listitem>
1131 <para>The TCP initial congestion window is used during the start of a TCP connection. During the start of a TCP
1132 session, when a client requests a resource, the server's initial congestion window determines how many data bytes
1133 will be sent during the initial burst of data. Takes a size in bytes between 1 and 4294967295 (2^32 - 1). The usual
1134 suffixes K, M, G are supported and are understood to the base of 1024. When unset, the kernel's default will be used.
1135 </para>
1136 </listitem>
1137 </varlistentry>
1138 <varlistentry>
1139 <term><varname>InitialAdvertisedReceiveWindow=</varname></term>
1140 <listitem>
1141 <para>The TCP initial advertised receive window is the amount of receive data (in bytes) that can initally be buffered at one time
1142 on a connection. The sending host can send only that amount of data before waiting for an acknowledgment and window update
1143 from the receiving host. Takes a size in bytes between 1 and 4294967295 (2^32 - 1). The usual suffixes K, M, G are supported
1144 and are understood to the base of 1024. When unset, the kernel's default will be used.
1145 </para>
1146 </listitem>
1147 </varlistentry>
1148 <varlistentry>
1149 <term><varname>QuickAck=</varname></term>
1150 <listitem>
1151 <para>Takes a boolean. When true enables TCP quick ack mode for the route. When unset, the kernel's default will be used.
1152 </para>
1153 </listitem>
1154 </varlistentry>
1155 <varlistentry>
1156 <term><varname>MTUBytes=</varname></term>
1157 <listitem>
1158 <para>The maximum transmission unit in bytes to set for the
1159 route. The usual suffixes K, M, G, are supported and are
1160 understood to the base of 1024.</para>
1161 <para>Note that if IPv6 is enabled on the interface, and the MTU is chosen
1162 below 1280 (the minimum MTU for IPv6) it will automatically be increased to this value.</para>
1163 </listitem>
1164 </varlistentry>
1165 </variablelist>
1166 </refsect1>
1167
1168 <refsect1>
1169 <title>[DHCP] Section Options</title>
1170 <para>The <literal>[DHCP]</literal> section configures the
1171 DHCPv4 and DHCP6 client, if it is enabled with the
1172 <varname>DHCP=</varname> setting described above:</para>
1173
1174 <variablelist class='network-directives'>
1175 <varlistentry>
1176 <term><varname>UseDNS=</varname></term>
1177 <listitem>
1178 <para>When true (the default), the DNS servers received
1179 from the DHCP server will be used and take precedence over
1180 any statically configured ones.</para>
1181
1182 <para>This corresponds to the <option>nameserver</option>
1183 option in <citerefentry
1184 project='man-pages'><refentrytitle>resolv.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para>
1185 </listitem>
1186 </varlistentry>
1187 <varlistentry>
1188 <term><varname>UseNTP=</varname></term>
1189 <listitem>
1190 <para>When true (the default), the NTP servers received
1191 from the DHCP server will be used by systemd-timesyncd
1192 and take precedence over any statically configured ones.</para>
1193 </listitem>
1194 </varlistentry>
1195 <varlistentry>
1196 <term><varname>UseMTU=</varname></term>
1197 <listitem>
1198 <para>When true, the interface maximum transmission unit
1199 from the DHCP server will be used on the current link.
1200 If <varname>MTUBytes=</varname> is set, then this setting is ignored.
1201 Defaults to false.</para>
1202 </listitem>
1203 </varlistentry>
1204 <varlistentry>
1205 <term><varname>Anonymize=</varname></term>
1206 <listitem>
1207 <para>Takes a boolean. When true, the options sent to the DHCP server will
1208 follow the <ulink url="https://tools.ietf.org/html/rfc7844">RFC 7844</ulink>
1209 (Anonymity Profiles for DHCP Clients) to minimize disclosure of identifying information.
1210 Defaults to false.</para>
1211
1212 <para>This option should only be set to true when
1213 <varname>MACAddressPolicy=</varname> is set to <literal>random</literal>
1214 (see <citerefentry
1215 project='man-pages'><refentrytitle>systemd.link</refentrytitle><manvolnum>5</manvolnum></citerefentry>).</para>
1216
1217 <para>Note that this configuration will overwrite others.
1218 In concrete, the following variables will be ignored:
1219 <varname>SendHostname=</varname>, <varname>ClientIdentifier=</varname>,
1220 <varname>UseRoutes=</varname>, <varname>SendHostname=</varname>,
1221 <varname>UseMTU=</varname>, <varname>VendorClassIdentifier=</varname>,
1222 <varname>UseTimezone=</varname>.</para>
1223 </listitem>
1224 </varlistentry>
1225 <varlistentry>
1226 <term><varname>SendHostname=</varname></term>
1227 <listitem>
1228 <para>When true (the default), the machine's hostname will be sent to the DHCP server.
1229 Note that the machine's hostname must consist only of 7-bit ASCII lower-case characters and
1230 no spaces or dots, and be formatted as a valid DNS domain name. Otherwise, the hostname is not
1231 sent even if this is set to true.</para>
1232 </listitem>
1233 </varlistentry>
1234 <varlistentry>
1235 <term><varname>UseHostname=</varname></term>
1236 <listitem>
1237 <para>When true (the default), the hostname received from
1238 the DHCP server will be set as the transient hostname of the system.
1239 </para>
1240 </listitem>
1241 </varlistentry>
1242 <varlistentry>
1243 <term><varname>Hostname=</varname></term>
1244 <listitem>
1245 <para>Use this value for the hostname which is sent to the DHCP server, instead of machine's hostname.
1246 Note that the specified hostname must consist only of 7-bit ASCII lower-case characters and
1247 no spaces or dots, and be formatted as a valid DNS domain name.</para>
1248 </listitem>
1249 </varlistentry>
1250 <varlistentry>
1251 <term><varname>UseDomains=</varname></term>
1252 <listitem>
1253 <para>Takes a boolean, or the special value <literal>route</literal>. When true, the domain name
1254 received from the DHCP server will be used as DNS search domain over this link, similar to the effect of
1255 the <option>Domains=</option> setting. If set to <literal>route</literal>, the domain name received from
1256 the DHCP server will be used for routing DNS queries only, but not for searching, similar to the effect of
1257 the <option>Domains=</option> setting when the argument is prefixed with <literal>~</literal>. Defaults to
1258 false.</para>
1259
1260 <para>It is recommended to enable this option only on trusted networks, as setting this affects resolution
1261 of all host names, in particular of single-label names. It is generally safer to use the supplied domain
1262 only as routing domain, rather than as search domain, in order to not have it affect local resolution of
1263 single-label names.</para>
1264
1265 <para>When set to true, this setting corresponds to the <option>domain</option> option in <citerefentry
1266 project='man-pages'><refentrytitle>resolv.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para>
1267 </listitem>
1268 </varlistentry>
1269 <varlistentry>
1270 <term><varname>UseRoutes=</varname></term>
1271 <listitem>
1272 <para>When true (the default), the static routes will be requested from the DHCP server and added to the
1273 routing table with a metric of 1024, and a scope of "global", "link" or "host", depending on the route's
1274 destination and gateway. If the destination is on the local host, e.g., 127.x.x.x, or the same as the
1275 link's own address, the scope will be set to "host". Otherwise if the gateway is null (a direct route), a
1276 "link" scope will be used. For anything else, scope defaults to "global".</para>
1277 </listitem>
1278 </varlistentry>
1279
1280 <varlistentry>
1281 <term><varname>UseTimezone=</varname></term>
1282
1283 <listitem><para>When true, the timezone received from the
1284 DHCP server will be set as timezone of the local
1285 system. Defaults to <literal>no</literal>.</para></listitem>
1286 </varlistentry>
1287
1288 <varlistentry>
1289 <term><varname>CriticalConnection=</varname></term>
1290 <listitem>
1291 <para>When true, the connection will never be torn down
1292 even if the DHCP lease expires. This is contrary to the
1293 DHCP specification, but may be the best choice if, say,
1294 the root filesystem relies on this connection. Defaults to
1295 false.</para>
1296 </listitem>
1297 </varlistentry>
1298
1299 <varlistentry>
1300 <term><varname>ClientIdentifier=</varname></term>
1301 <listitem>
1302 <para>The DHCPv4 client identifier to use. Takes one of <literal>mac</literal>, <literal>duid</literal> or <literal>duid-only</literal>.
1303 If set to <literal>mac</literal>, the MAC address of the link is used.
1304 If set to <literal>duid</literal>, an RFC4361-compliant Client ID, which is the combination of IAID and DUID (see below), is used.
1305 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.
1306 Defaults to <literal>duid</literal>.</para>
1307 </listitem>
1308 </varlistentry>
1309
1310 <varlistentry>
1311 <term><varname>VendorClassIdentifier=</varname></term>
1312 <listitem>
1313 <para>The vendor class identifier used to identify vendor
1314 type and configuration.</para>
1315 </listitem>
1316 </varlistentry>
1317
1318 <varlistentry>
1319 <term><varname>UserClass=</varname></term>
1320 <listitem>
1321 <para>A DHCPv4 client can use UserClass option to identify the type or category of user or applications
1322 it represents. The information contained in this option is a string that represents the user class of which
1323 the client is a member. Each class sets an identifying string of information to be used by the DHCP
1324 service to classify clients. Takes a whitespace-separated list of strings.</para>
1325 </listitem>
1326 </varlistentry>
1327
1328 <varlistentry>
1329 <term><varname>DUIDType=</varname></term>
1330 <listitem>
1331 <para>Override the global <varname>DUIDType</varname> setting for this network. See
1332 <citerefentry><refentrytitle>networkd.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>
1333 for a description of possible values.</para>
1334 </listitem>
1335 </varlistentry>
1336
1337 <varlistentry>
1338 <term><varname>DUIDRawData=</varname></term>
1339 <listitem>
1340 <para>Override the global <varname>DUIDRawData</varname> setting for this network. See
1341 <citerefentry><refentrytitle>networkd.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>
1342 for a description of possible values.</para>
1343 </listitem>
1344 </varlistentry>
1345
1346 <varlistentry>
1347 <term><varname>IAID=</varname></term>
1348 <listitem>
1349 <para>The DHCP Identity Association Identifier (IAID) for the interface, a 32-bit unsigned integer.</para>
1350 </listitem>
1351 </varlistentry>
1352
1353 <varlistentry>
1354 <term><varname>RequestBroadcast=</varname></term>
1355 <listitem>
1356 <para>Request the server to use broadcast messages before
1357 the IP address has been configured. This is necessary for
1358 devices that cannot receive RAW packets, or that cannot
1359 receive packets at all before an IP address has been
1360 configured. On the other hand, this must not be enabled on
1361 networks where broadcasts are filtered out.</para>
1362 </listitem>
1363 </varlistentry>
1364
1365 <varlistentry>
1366 <term><varname>RouteMetric=</varname></term>
1367 <listitem>
1368 <para>Set the routing metric for routes specified by the
1369 DHCP server.</para>
1370 </listitem>
1371 </varlistentry>
1372
1373 <varlistentry>
1374 <term><varname>RouteTable=<replaceable>num</replaceable></varname></term>
1375 <listitem>
1376 <para>The table identifier for DHCP routes (a number between 1 and 4294967295, or 0 to unset).
1377 The table can be retrieved using <command>ip route show table <replaceable>num</replaceable></command>.
1378 </para>
1379 <para>When used in combination with <varname>VRF=</varname> the
1380 VRF's routing table is used unless this parameter is specified.
1381 </para>
1382 </listitem>
1383 </varlistentry>
1384
1385 <varlistentry>
1386 <term><varname>ListenPort=</varname></term>
1387 <listitem>
1388 <para>Allow setting custom port for the DHCP client to listen on.</para>
1389 </listitem>
1390 </varlistentry>
1391
1392 <varlistentry>
1393 <term><varname>RapidCommit=</varname></term>
1394 <listitem>
1395 <para>Takes a boolean. The DHCPv6 client can obtain configuration parameters from a DHCPv6 server through
1396 a rapid two-message exchange (solicit and reply). When the rapid commit option is enabled by both
1397 the DHCPv6 client and the DHCPv6 server, the two-message exchange is used, rather than the default
1398 four-method exchange (solicit, advertise, request, and reply). The two-message exchange provides
1399 faster client configuration and is beneficial in environments in which networks are under a heavy load.
1400 See <ulink url="https://tools.ietf.org/html/rfc3315#section-17.2.1">RFC 3315</ulink> for details.
1401 Defaults to true.</para>
1402 </listitem>
1403 </varlistentry>
1404
1405 <varlistentry>
1406 <term><varname>ForceDHCPv6PDOtherInformation=</varname></term>
1407 <listitem>
1408 <para>Takes a boolean that enforces DHCPv6 stateful mode when the 'Other information' bit is set in
1409 Router Advertisement messages. By default setting only the 'O' bit in Router Advertisements
1410 makes DHCPv6 request network information in a stateless manner using a two-message Information
1411 Request and Information Reply message exchange.
1412 <ulink url="https://tools.ietf.org/html/rfc7084">RFC 7084</ulink>, requirement WPD-4, updates
1413 this behavior for a Customer Edge router so that stateful DHCPv6 Prefix Delegation is also
1414 requested when only the 'O' bit is set in Router Advertisements. This option enables such a CE
1415 behavior as it is impossible to automatically distinguish the intention of the 'O' bit otherwise.
1416 By default this option is set to 'false', enable it if no prefixes are delegated when the device
1417 should be acting as a CE router.</para>
1418 </listitem>
1419 </varlistentry>
1420
1421 </variablelist>
1422 </refsect1>
1423
1424 <refsect1>
1425 <title>[IPv6AcceptRA] Section Options</title>
1426 <para>The <literal>[IPv6AcceptRA]</literal> section configures the IPv6 Router Advertisement
1427 (RA) client, if it is enabled with the <varname>IPv6AcceptRA=</varname> setting described
1428 above:</para>
1429
1430 <variablelist class='network-directives'>
1431 <varlistentry>
1432 <term><varname>UseDNS=</varname></term>
1433 <listitem>
1434 <para>When true (the default), the DNS servers received in the Router Advertisement will be used and take
1435 precedence over any statically configured ones.</para>
1436
1437 <para>This corresponds to the <option>nameserver</option> option in <citerefentry
1438 project='man-pages'><refentrytitle>resolv.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para>
1439 </listitem>
1440 </varlistentry>
1441
1442 <varlistentry>
1443 <term><varname>UseDomains=</varname></term>
1444 <listitem>
1445 <para>Takes a boolean, or the special value <literal>route</literal>. When true, the domain name
1446 received via IPv6 Router Advertisement (RA) will be used as DNS search domain over this link, similar to
1447 the effect of the <option>Domains=</option> setting. If set to <literal>route</literal>, the domain name
1448 received via IPv6 RA will be used for routing DNS queries only, but not for searching, similar to the
1449 effect of the <option>Domains=</option> setting when the argument is prefixed with
1450 <literal>~</literal>. Defaults to false.</para>
1451
1452 <para>It is recommended to enable this option only on trusted networks, as setting this affects resolution
1453 of all host names, in particular of single-label names. It is generally safer to use the supplied domain
1454 only as routing domain, rather than as search domain, in order to not have it affect local resolution of
1455 single-label names.</para>
1456
1457 <para>When set to true, this setting corresponds to the <option>domain</option> option in <citerefentry
1458 project='man-pages'><refentrytitle>resolv.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para>
1459 </listitem>
1460 </varlistentry>
1461
1462 <varlistentry>
1463 <term><varname>RouteTable=<replaceable>num</replaceable></varname></term>
1464 <listitem>
1465 <para>The table identifier for the routes received in the Router Advertisement
1466 (a number between 1 and 4294967295, or 0 to unset).
1467 The table can be retrieved using <command>ip route show table <replaceable>num</replaceable></command>.
1468 </para>
1469 </listitem>
1470 </varlistentry>
1471 </variablelist>
1472 </refsect1>
1473
1474 <refsect1>
1475 <title>[DHCPServer] Section Options</title>
1476 <para>The <literal>[DHCPServer]</literal> section contains
1477 settings for the DHCP server, if enabled via the
1478 <varname>DHCPServer=</varname> option described above:</para>
1479
1480 <variablelist class='network-directives'>
1481
1482 <varlistentry>
1483 <term><varname>PoolOffset=</varname></term>
1484 <term><varname>PoolSize=</varname></term>
1485
1486 <listitem><para>Configures the pool of addresses to hand out. The pool
1487 is a contiguous sequence of IP addresses in the subnet configured for
1488 the server address, which does not include the subnet nor the broadcast
1489 address. <varname>PoolOffset=</varname> takes the offset of the pool
1490 from the start of subnet, or zero to use the default value.
1491 <varname>PoolSize=</varname> takes the number of IP addresses in the
1492 pool or zero to use the default value. By default, the pool starts at
1493 the first address after the subnet address and takes up the rest of
1494 the subnet, excluding the broadcast address. If the pool includes
1495 the server address (the default), this is reserved and not handed
1496 out to clients.</para></listitem>
1497 </varlistentry>
1498
1499 <varlistentry>
1500 <term><varname>DefaultLeaseTimeSec=</varname></term>
1501 <term><varname>MaxLeaseTimeSec=</varname></term>
1502
1503 <listitem><para>Control the default and maximum DHCP lease
1504 time to pass to clients. These settings take time values in seconds or
1505 another common time unit, depending on the suffix. The default
1506 lease time is used for clients that did not ask for a specific
1507 lease time. If a client asks for a lease time longer than the
1508 maximum lease time, it is automatically shortened to the
1509 specified time. The default lease time defaults to 1h, the
1510 maximum lease time to 12h. Shorter lease times are beneficial
1511 if the configuration data in DHCP leases changes frequently
1512 and clients shall learn the new settings with shorter
1513 latencies. Longer lease times reduce the generated DHCP
1514 network traffic.</para></listitem>
1515 </varlistentry>
1516
1517 <varlistentry>
1518 <term><varname>EmitDNS=</varname></term>
1519 <term><varname>DNS=</varname></term>
1520
1521 <listitem><para>Takes a boolean. Configures whether the DHCP leases handed out
1522 to clients shall contain DNS server information. Defaults to <literal>yes</literal>.
1523 The DNS servers to pass to clients may be configured with the
1524 <varname>DNS=</varname> option, which takes a list of IPv4
1525 addresses. If the <varname>EmitDNS=</varname> option is
1526 enabled but no servers configured, the servers are
1527 automatically propagated from an "uplink" interface that has
1528 appropriate servers set. The "uplink" interface is determined
1529 by the default route of the system with the highest
1530 priority. Note that this information is acquired at the time
1531 the lease is handed out, and does not take uplink interfaces
1532 into account that acquire DNS or NTP server information at a
1533 later point. DNS server propagation does not take
1534 <filename>/etc/resolv.conf</filename> into account. Also, note
1535 that the leases are not refreshed if the uplink network
1536 configuration changes. To ensure clients regularly acquire the
1537 most current uplink DNS server information, it is thus
1538 advisable to shorten the DHCP lease time via
1539 <varname>MaxLeaseTimeSec=</varname> described
1540 above.</para></listitem>
1541 </varlistentry>
1542
1543 <varlistentry>
1544 <term><varname>EmitNTP=</varname></term>
1545 <term><varname>NTP=</varname></term>
1546
1547 <listitem><para>Similar to the <varname>EmitDNS=</varname> and
1548 <varname>DNS=</varname> settings described above, these
1549 settings configure whether and what NTP server information
1550 shall be emitted as part of the DHCP lease. The same syntax,
1551 propagation semantics and defaults apply as for
1552 <varname>EmitDNS=</varname> and
1553 <varname>DNS=</varname>.</para></listitem>
1554 </varlistentry>
1555
1556 <varlistentry>
1557 <term><varname>EmitRouter=</varname></term>
1558
1559 <listitem><para>Similar to the <varname>EmitDNS=</varname>
1560 setting described above, this setting configures whether the
1561 DHCP lease should contain the router option. The same syntax,
1562 propagation semantics and defaults apply as for
1563 <varname>EmitDNS=</varname>.</para></listitem>
1564 </varlistentry>
1565
1566 <varlistentry>
1567 <term><varname>EmitTimezone=</varname></term>
1568 <term><varname>Timezone=</varname></term>
1569
1570 <listitem><para>Takes a boolean. Configures whether the DHCP leases handed out
1571 to clients shall contain timezone information. Defaults to <literal>yes</literal>. The
1572 <varname>Timezone=</varname> setting takes a timezone string
1573 (such as <literal>Europe/Berlin</literal> or
1574 <literal>UTC</literal>) to pass to clients. If no explicit
1575 timezone is set, the system timezone of the local host is
1576 propagated, as determined by the
1577 <filename>/etc/localtime</filename> symlink.</para></listitem>
1578 </varlistentry>
1579
1580 </variablelist>
1581 </refsect1>
1582
1583 <refsect1>
1584 <title>[IPv6PrefixDelegation] Section Options</title>
1585 <para>The <literal>[IPv6PrefixDelegation]</literal> section contains
1586 settings for sending IPv6 Router Advertisements and whether to act as
1587 a router, if enabled via the <varname>IPv6PrefixDelegation=</varname>
1588 option described above. IPv6 network prefixes are defined with one or
1589 more <literal>[IPv6Prefix]</literal> sections.</para>
1590
1591 <variablelist class='network-directives'>
1592
1593 <varlistentry>
1594 <term><varname>Managed=</varname></term>
1595 <term><varname>OtherInformation=</varname></term>
1596
1597 <listitem><para>Takes a boolean. Controls whether a DHCPv6 server is used to acquire IPv6
1598 addresses on the network link when <varname>Managed=</varname>
1599 is set to <literal>true</literal> or if only additional network
1600 information can be obtained via DHCPv6 for the network link when
1601 <varname>OtherInformation=</varname> is set to
1602 <literal>true</literal>. Both settings default to
1603 <literal>false</literal>, which means that a DHCPv6 server is not being
1604 used.</para></listitem>
1605 </varlistentry>
1606
1607 <varlistentry>
1608 <term><varname>RouterLifetimeSec=</varname></term>
1609
1610 <listitem><para>Takes a timespan. Configures the IPv6 router lifetime in seconds. If set,
1611 this host also announces itself in Router Advertisements as an IPv6
1612 router for the network link. When unset, the host is not acting as a router.</para>
1613 </listitem>
1614 </varlistentry>
1615
1616 <varlistentry>
1617 <term><varname>RouterPreference=</varname></term>
1618
1619 <listitem><para>Configures IPv6 router preference if
1620 <varname>RouterLifetimeSec=</varname> is non-zero. Valid values are
1621 <literal>high</literal>, <literal>medium</literal> and
1622 <literal>low</literal>, with <literal>normal</literal> and
1623 <literal>default</literal> added as synonyms for
1624 <literal>medium</literal> just to make configuration easier. See
1625 <ulink url="https://tools.ietf.org/html/rfc4191">RFC 4191</ulink>
1626 for details. Defaults to <literal>medium</literal>.</para></listitem>
1627 </varlistentry>
1628
1629 <varlistentry>
1630 <term><varname>EmitDNS=</varname></term>
1631 <term><varname>DNS=</varname></term>
1632
1633 <listitem><para><varname>DNS=</varname> specifies a list of recursive
1634 DNS server IPv6 addresses that distributed via Router Advertisement
1635 messages when <varname>EmitDNS=</varname> is true. If <varname>DNS=
1636 </varname> is empty, DNS servers are read from the
1637 <literal>[Network]</literal> section. If the
1638 <literal>[Network]</literal> section does not contain any DNS servers
1639 either, DNS servers from the uplink with the highest priority default
1640 route are used. When <varname>EmitDNS=</varname> is false, no DNS server
1641 information is sent in Router Advertisement messages.
1642 <varname>EmitDNS=</varname> defaults to true.
1643 </para></listitem>
1644 </varlistentry>
1645
1646 <varlistentry>
1647 <term><varname>EmitDomains=</varname></term>
1648 <term><varname>Domains=</varname></term>
1649
1650 <listitem><para>A list of DNS search domains distributed via Router
1651 Advertisement messages when <varname>EmitDomains=</varname> is true. If
1652 <varname>Domains=</varname> is empty, DNS search domains are read from the
1653 <literal>[Network]</literal> section. If the <literal>[Network]</literal>
1654 section does not contain any DNS search domains either, DNS search
1655 domains from the uplink with the highest priority default route are
1656 used. When <varname>EmitDomains=</varname> is false, no DNS search domain
1657 information is sent in Router Advertisement messages.
1658 <varname>EmitDomains=</varname> defaults to true.
1659 </para></listitem>
1660 </varlistentry>
1661
1662 <varlistentry>
1663 <term><varname>DNSLifetimeSec=</varname></term>
1664
1665 <listitem><para>Lifetime in seconds for the DNS server addresses listed
1666 in <varname>DNS=</varname> and search domains listed in
1667 <varname>Domains=</varname>.</para></listitem>
1668 </varlistentry>
1669
1670 </variablelist>
1671 </refsect1>
1672
1673 <refsect1>
1674 <title>[IPv6Prefix] Section Options</title>
1675 <para>One or more <literal>[IPv6Prefix]</literal> sections contain the IPv6
1676 prefixes that are announced via Router Advertisements. See
1677 <ulink url="https://tools.ietf.org/html/rfc4861">RFC 4861</ulink>
1678 for further details.</para>
1679
1680 <variablelist class='network-directives'>
1681
1682 <varlistentry>
1683 <term><varname>AddressAutoconfiguration=</varname></term>
1684 <term><varname>OnLink=</varname></term>
1685
1686 <listitem><para>Takes a boolean to specify whether IPv6 addresses can be
1687 autoconfigured with this prefix and whether the prefix can be used for
1688 onlink determination. Both settings default to <literal>true</literal>
1689 in order to ease configuration.
1690 </para></listitem>
1691 </varlistentry>
1692
1693 <varlistentry>
1694 <term><varname>Prefix=</varname></term>
1695
1696 <listitem><para>The IPv6 prefix that is to be distributed to hosts.
1697 Similarly to configuring static IPv6 addresses, the setting is
1698 configured as an IPv6 prefix and its prefix length, separated by a
1699 <literal>/</literal> character. Use multiple
1700 <literal>[IPv6Prefix]</literal> sections to configure multiple IPv6
1701 prefixes since prefix lifetimes, address autoconfiguration and onlink
1702 status may differ from one prefix to another.</para></listitem>
1703 </varlistentry>
1704
1705 <varlistentry>
1706 <term><varname>PreferredLifetimeSec=</varname></term>
1707 <term><varname>ValidLifetimeSec=</varname></term>
1708
1709 <listitem><para>Preferred and valid lifetimes for the prefix measured in
1710 seconds. <varname>PreferredLifetimeSec=</varname> defaults to 604800
1711 seconds (one week) and <varname>ValidLifetimeSec=</varname> defaults
1712 to 2592000 seconds (30 days).</para></listitem>
1713 </varlistentry>
1714
1715 </variablelist>
1716 </refsect1>
1717
1718 <refsect1>
1719 <title>[Bridge] Section Options</title>
1720 <para>The <literal>[Bridge]</literal> section accepts the
1721 following keys.</para>
1722 <variablelist class='network-directives'>
1723 <varlistentry>
1724 <term><varname>UnicastFlood=</varname></term>
1725 <listitem>
1726 <para>Takes a boolean. Controls whether the bridge should flood
1727 traffic for which an FDB entry is missing and the destination
1728 is unknown through this port. When unset, the kernel's default will be used.
1729 </para>
1730 </listitem>
1731 </varlistentry>
1732 <varlistentry>
1733 <term><varname>HairPin=</varname></term>
1734 <listitem>
1735 <para>Takes a boolean. Configures whether traffic may be sent back
1736 out of the port on which it was received. When this flag is false, and the bridge
1737 will not forward traffic back out of the receiving port.
1738 When unset, the kernel's default will be used.</para>
1739 </listitem>
1740 </varlistentry>
1741 <varlistentry>
1742 <term><varname>UseBPDU=</varname></term>
1743 <listitem>
1744 <para>Takes a boolean. Configures whether STP Bridge Protocol Data Units will be
1745 processed by the bridge port. When unset, the kernel's default will be used.</para>
1746 </listitem>
1747 </varlistentry>
1748 <varlistentry>
1749 <term><varname>FastLeave=</varname></term>
1750 <listitem>
1751 <para>Takes a boolean. This flag allows the bridge to immediately stop multicast
1752 traffic on a port that receives an IGMP Leave message. It is only used with
1753 IGMP snooping if enabled on the bridge. When unset, the kernel's default will be used.</para>
1754 </listitem>
1755 </varlistentry>
1756 <varlistentry>
1757 <term><varname>AllowPortToBeRoot=</varname></term>
1758 <listitem>
1759 <para>Takes a boolean. Configures whether a given port is allowed to
1760 become a root port. Only used when STP is enabled on the bridge.
1761 When unset, the kernel's default will be used.</para>
1762 </listitem>
1763 </varlistentry>
1764 <varlistentry>
1765 <term><varname>Cost=</varname></term>
1766 <listitem>
1767 <para>Sets the "cost" of sending packets of this interface.
1768 Each port in a bridge may have a different speed and the cost
1769 is used to decide which link to use. Faster interfaces
1770 should have lower costs. It is an integer value between 1 and
1771 65535.</para>
1772 </listitem>
1773 </varlistentry>
1774 <varlistentry>
1775 <term><varname>Priority=</varname></term>
1776 <listitem>
1777 <para>Sets the "priority" of sending packets on this interface.
1778 Each port in a bridge may have a different priority which is used
1779 to decide which link to use. Lower value means higher priority.
1780 It is an integer value between 0 to 63. Networkd does not set any
1781 default, meaning the kernel default value of 32 is used.</para>
1782 </listitem>
1783 </varlistentry>
1784 </variablelist>
1785 </refsect1>
1786 <refsect1>
1787 <title>[BridgeFDB] Section Options</title>
1788 <para>The <literal>[BridgeFDB]</literal> section manages the
1789 forwarding database table of a port and accepts the following
1790 keys. Specify several <literal>[BridgeFDB]</literal> sections to
1791 configure several static MAC table entries.</para>
1792
1793 <variablelist class='network-directives'>
1794 <varlistentry>
1795 <term><varname>MACAddress=</varname></term>
1796 <listitem>
1797 <para>As in the <literal>[Network]</literal> section. This
1798 key is mandatory.</para>
1799 </listitem>
1800 </varlistentry>
1801 <varlistentry>
1802 <term><varname>VLANId=</varname></term>
1803 <listitem>
1804 <para>The VLAN ID for the new static MAC table entry. If
1805 omitted, no VLAN ID information is appended to the new static MAC
1806 table entry.</para>
1807 </listitem>
1808 </varlistentry>
1809 </variablelist>
1810 </refsect1>
1811
1812 <refsect1>
1813 <title>[CAN] Section Options</title>
1814 <para>The <literal>[CAN]</literal> section manages the Controller Area Network (CAN bus) and accepts the
1815 following keys.</para>
1816 <variablelist class='network-directives'>
1817 <varlistentry>
1818 <term><varname>BitRate=</varname></term>
1819 <listitem>
1820 <para>The bitrate of CAN device in bits per second. The usual SI prefixes (K, M) with the base of 1000 can
1821 be used here.</para>
1822 </listitem>
1823 </varlistentry>
1824 <varlistentry>
1825 <term><varname>SamplePoint=</varname></term>
1826 <listitem>
1827 <para>Optional sample point in percent with one decimal (e.g. <literal>75%</literal>,
1828 <literal>87.5%</literal>) or permille (e.g. <literal>875‰</literal>).</para>
1829 </listitem>
1830 </varlistentry>
1831 <varlistentry>
1832 <term><varname>RestartSec=</varname></term>
1833 <listitem>
1834 <para>Automatic restart delay time. If set to a non-zero value, a restart of the CAN controller will be
1835 triggered automatically in case of a bus-off condition after the specified delay time. Subsecond delays can
1836 be specified using decimals (e.g. <literal>0.1s</literal>) or a <literal>ms</literal> or
1837 <literal>us</literal> postfix. Using <literal>infinity</literal> or <literal>0</literal> will turn the
1838 automatic restart off. By default automatic restart is disabled.</para>
1839 </listitem>
1840 </varlistentry>
1841 </variablelist>
1842 </refsect1>
1843
1844 <refsect1>
1845 <title>[BridgeVLAN] Section Options</title>
1846 <para>The <literal>[BridgeVLAN]</literal> section manages the VLAN ID configuration of a bridge port and accepts
1847 the following keys. Specify several <literal>[BridgeVLAN]</literal> sections to configure several VLAN entries.
1848 The <varname>VLANFiltering=</varname> option has to be enabled, see <literal>[Bridge]</literal> section in
1849 <citerefentry><refentrytitle>systemd.netdev</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para>
1850
1851 <variablelist class='network-directives'>
1852 <varlistentry>
1853 <term><varname>VLAN=</varname></term>
1854 <listitem>
1855 <para>The VLAN ID allowed on the port. This can be either a single ID or a range M-N. VLAN IDs are valid
1856 from 1 to 4094.</para>
1857 </listitem>
1858 </varlistentry>
1859 <varlistentry>
1860 <term><varname>EgressUntagged=</varname></term>
1861 <listitem>
1862 <para>The VLAN ID specified here will be used to untag frames on egress. Configuring
1863 <varname>EgressUntagged=</varname> implicates the use of <varname>VLAN=</varname> above and will enable the
1864 VLAN ID for ingress as well. This can be either a single ID or a range M-N.</para>
1865 </listitem>
1866 </varlistentry>
1867 <varlistentry>
1868 <term><varname>PVID=</varname></term>
1869 <listitem>
1870 <para>The Port VLAN ID specified here is assigned to all untagged frames at ingress.
1871 <varname>PVID=</varname> can be used only once. Configuring <varname>PVID=</varname> implicates the use of
1872 <varname>VLAN=</varname> above and will enable the VLAN ID for ingress as well.</para>
1873 </listitem>
1874 </varlistentry>
1875 </variablelist>
1876 </refsect1>
1877
1878 <refsect1>
1879 <title>Examples</title>
1880 <example>
1881 <title>Static network configuration</title>
1882
1883 <programlisting># /etc/systemd/network/50-static.network
1884 [Match]
1885 Name=enp2s0
1886
1887 [Network]
1888 Address=192.168.0.15/24
1889 Gateway=192.168.0.1</programlisting>
1890
1891 <para>This brings interface <literal>enp2s0</literal> up with a static address. The
1892 specified gateway will be used for a default route.</para>
1893 </example>
1894
1895 <example>
1896 <title>DHCP on ethernet links</title>
1897
1898 <programlisting># /etc/systemd/network/80-dhcp.network
1899 [Match]
1900 Name=en*
1901
1902 [Network]
1903 DHCP=yes</programlisting>
1904
1905 <para>This will enable DHCPv4 and DHCPv6 on all interfaces with names starting with
1906 <literal>en</literal> (i.e. ethernet interfaces).</para>
1907 </example>
1908
1909 <example>
1910 <title>A bridge with two enslaved links</title>
1911
1912 <programlisting># /etc/systemd/network/25-bridge-static.network
1913 [Match]
1914 Name=bridge0
1915
1916 [Network]
1917 Address=192.168.0.15/24
1918 Gateway=192.168.0.1
1919 DNS=192.168.0.1</programlisting>
1920
1921 <programlisting># /etc/systemd/network/25-bridge-slave-interface-1.network
1922 [Match]
1923 Name=enp2s0
1924
1925 [Network]
1926 Bridge=bridge0</programlisting>
1927
1928 <programlisting># /etc/systemd/network/25-bridge-slave-interface-2.network
1929 [Match]
1930 Name=wlp3s0
1931
1932 [Network]
1933 Bridge=bridge0</programlisting>
1934
1935 <para>This creates a bridge and attaches devices <literal>enp2s0</literal> and
1936 <literal>wlp3s0</literal> to it. The bridge will have the specified static address
1937 and network assigned, and a default route via the specified gateway will be
1938 added. The specified DNS server will be added to the global list of DNS resolvers.
1939 </para>
1940 </example>
1941
1942 <example>
1943 <title></title>
1944
1945 <programlisting>
1946 # /etc/systemd/network/20-bridge-slave-interface-vlan.network
1947 [Match]
1948 Name=enp2s0
1949
1950 [Network]
1951 Bridge=bridge0
1952
1953 [BridgeVLAN]
1954 VLAN=1-32
1955 PVID=42
1956 EgressUntagged=42
1957
1958 [BridgeVLAN]
1959 VLAN=100-200
1960
1961 [BridgeVLAN]
1962 EgressUntagged=300-400</programlisting>
1963
1964 <para>This overrides the configuration specified in the previous example for the
1965 interface <literal>enp2s0</literal>, and enables VLAN on that bridge port. VLAN IDs
1966 1-32, 42, 100-400 will be allowed. Packets tagged with VLAN IDs 42, 300-400 will be
1967 untagged when they leave on this interface. Untagged packets which arrive on this
1968 interface will be assigned VLAN ID 42.</para>
1969 </example>
1970
1971 <example>
1972 <title>Various tunnels</title>
1973
1974 <programlisting>/etc/systemd/network/25-tunnels.network
1975 [Match]
1976 Name=ens1
1977
1978 [Network]
1979 Tunnel=ipip-tun
1980 Tunnel=sit-tun
1981 Tunnel=gre-tun
1982 Tunnel=vti-tun
1983 </programlisting>
1984
1985 <programlisting>/etc/systemd/network/25-tunnel-ipip.netdev
1986 [NetDev]
1987 Name=ipip-tun
1988 Kind=ipip
1989 </programlisting>
1990
1991 <programlisting>/etc/systemd/network/25-tunnel-sit.netdev
1992 [NetDev]
1993 Name=sit-tun
1994 Kind=sit
1995 </programlisting>
1996
1997 <programlisting>/etc/systemd/network/25-tunnel-gre.netdev
1998 [NetDev]
1999 Name=gre-tun
2000 Kind=gre
2001 </programlisting>
2002
2003 <programlisting>/etc/systemd/network/25-tunnel-vti.netdev
2004 [NetDev]
2005 Name=vti-tun
2006 Kind=vti
2007 </programlisting>
2008
2009 <para>This will bring interface <literal>ens1</literal> up and create an IPIP tunnel,
2010 a SIT tunnel, a GRE tunnel, and a VTI tunnel using it.</para>
2011 </example>
2012
2013 <example>
2014 <title>A bond device</title>
2015
2016 <programlisting># /etc/systemd/network/30-bond1.network
2017 [Match]
2018 Name=bond1
2019
2020 [Network]
2021 DHCP=ipv6
2022 </programlisting>
2023
2024 <programlisting># /etc/systemd/network/30-bond1.netdev
2025 [NetDev]
2026 Name=bond1
2027 Kind=bond
2028 </programlisting>
2029
2030 <programlisting># /etc/systemd/network/30-bond1-dev1.network
2031 [Match]
2032 MACAddress=52:54:00:e9:64:41
2033
2034 [Network]
2035 Bond=bond1
2036 </programlisting>
2037
2038 <programlisting># /etc/systemd/network/30-bond1-dev2.network
2039 [Match]
2040 MACAddress=52:54:00:e9:64:42
2041
2042 [Network]
2043 Bond=bond1
2044 </programlisting>
2045
2046 <para>This will create a bond device <literal>bond1</literal> and enslave the two
2047 devices with MAC addresses 52:54:00:e9:64:41 and 52:54:00:e9:64:42 to it. IPv6 DHCP
2048 will be used to acquire an address.</para>
2049 </example>
2050
2051 <example>
2052 <title>Virtual Routing and Forwarding (VRF)</title>
2053 <para>Add the <literal>bond1</literal> interface to the VRF master interface
2054 <literal>vrf1</literal>. This will redirect routes generated on this interface to be
2055 within the routing table defined during VRF creation. For kernels before 4.8 traffic
2056 won't be redirected towards the VRFs routing table unless specific ip-rules are added.
2057 </para>
2058 <programlisting># /etc/systemd/network/25-vrf.network
2059 [Match]
2060 Name=bond1
2061
2062 [Network]
2063 VRF=vrf1
2064 </programlisting>
2065 </example>
2066
2067 <example>
2068 <title>MacVTap</title>
2069 <para>This brings up a network interface <literal>macvtap-test</literal>
2070 and attaches it to <literal>enp0s25</literal>.</para>
2071 <programlisting># /usr/lib/systemd/network/25-macvtap.network
2072 [Match]
2073 Name=enp0s25
2074
2075 [Network]
2076 MACVTAP=macvtap-test
2077 </programlisting>
2078 </example>
2079 </refsect1>
2080
2081 <refsect1>
2082 <title>See Also</title>
2083 <para>
2084 <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
2085 <citerefentry><refentrytitle>systemd-networkd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
2086 <citerefentry><refentrytitle>systemd.link</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
2087 <citerefentry><refentrytitle>systemd.netdev</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
2088 <citerefentry><refentrytitle>systemd-resolved.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>
2089 </para>
2090 </refsect1>
2091
2092 </refentry>