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