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