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