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