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