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