]> git.ipfire.org Git - thirdparty/systemd.git/blame - man/systemd.netdev.xml
networkd: VXLan Make group and remote variable separate
[thirdparty/systemd.git] / man / systemd.netdev.xml
CommitLineData
eac684ef 1<?xml version='1.0'?> <!--*-nxml-*-->
3a54a157 2<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
12b42c76 3 "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
0307f791 4<!-- SPDX-License-Identifier: LGPL-2.1+ -->
eac684ef
TG
5
6<refentry id="systemd.netdev" conditional='ENABLE_NETWORKD'>
7
798d3a52
ZJS
8 <refentryinfo>
9 <title>systemd.network</title>
10 <productname>systemd</productname>
798d3a52
ZJS
11 </refentryinfo>
12
13 <refmeta>
14 <refentrytitle>systemd.netdev</refentrytitle>
15 <manvolnum>5</manvolnum>
16 </refmeta>
17
18 <refnamediv>
19 <refname>systemd.netdev</refname>
20 <refpurpose>Virtual Network Device configuration</refpurpose>
21 </refnamediv>
22
23 <refsynopsisdiv>
24 <para><filename><replaceable>netdev</replaceable>.netdev</filename></para>
25 </refsynopsisdiv>
26
27 <refsect1>
28 <title>Description</title>
29
30 <para>Network setup is performed by
31 <citerefentry><refentrytitle>systemd-networkd</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
32 </para>
33
bac150e9
ZJS
34 <para>The main Virtual Network Device file must have the extension <filename>.netdev</filename>;
35 other extensions are ignored. Virtual network devices are created as soon as networkd is
36 started. If a netdev with the specified name already exists, networkd will use that as-is rather
37 than create its own. Note that the settings of the pre-existing netdev will not be changed by
798d3a52
ZJS
38 networkd.</para>
39
bac150e9
ZJS
40 <para>The <filename>.netdev</filename> files are read from the files located in the system
41 network directory <filename>/usr/lib/systemd/network</filename>, the volatile runtime network
42 directory <filename>/run/systemd/network</filename> and the local administration network
43 directory <filename>/etc/systemd/network</filename>. All configuration files are collectively
44 sorted and processed in lexical order, regardless of the directories in which they live.
45 However, files with identical filenames replace each other. Files in <filename>/etc</filename>
46 have the highest priority, files in <filename>/run</filename> take precedence over files with
47 the same name in <filename>/usr/lib</filename>. This can be used to override a system-supplied
48 configuration file with a local file if needed. As a special case, an empty file (file size 0)
49 or symlink with the same name pointing to <filename>/dev/null</filename> disables the
50 configuration file entirely (it is "masked").</para>
51
52 <para>Along with the netdev file <filename>foo.netdev</filename>, a "drop-in" directory
53 <filename>foo.netdev.d/</filename> may exist. All files with the suffix <literal>.conf</literal>
54 from this directory will be parsed after the file itself is parsed. This is useful to alter or
55 add configuration settings, without having to modify the main configuration file. Each drop-in
56 file must have appropriate section headers.</para>
57
58 <para>In addition to <filename>/etc/systemd/network</filename>, drop-in <literal>.d</literal>
59 directories can be placed in <filename>/usr/lib/systemd/network</filename> or
60 <filename>/run/systemd/network</filename> directories. Drop-in files in
61 <filename>/etc</filename> take precedence over those in <filename>/run</filename> which in turn
62 take precedence over those in <filename>/usr/lib</filename>. Drop-in files under any of these
63 directories take precedence over the main netdev file wherever located. (Of course, since
64 <filename>/run</filename> is temporary and <filename>/usr/lib</filename> is for vendors, it is
65 unlikely drop-ins should be used in either of those places.)</para>
798d3a52
ZJS
66 </refsect1>
67
68 <refsect1>
69 <title>Supported netdev kinds</title>
70
71 <para>The following kinds of virtual network devices may be
72 configured in <filename>.netdev</filename> files:</para>
73
74 <table>
75 <title>Supported kinds of virtual network devices</title>
76
77 <tgroup cols='2'>
78 <colspec colname='kind' />
79 <colspec colname='explanation' />
80 <thead><row>
81 <entry>Kind</entry>
82 <entry>Description</entry>
83 </row></thead>
84 <tbody>
85 <row><entry><varname>bond</varname></entry>
86 <entry>A bond device is an aggregation of all its slave devices. See <ulink url="https://www.kernel.org/doc/Documentation/networking/bonding.txt">Linux Ethernet Bonding Driver HOWTO</ulink> for details.Local configuration</entry></row>
87
88 <row><entry><varname>bridge</varname></entry>
a8eaaee7 89 <entry>A bridge device is a software switch, and each of its slave devices and the bridge itself are ports of the switch.</entry></row>
798d3a52
ZJS
90
91 <row><entry><varname>dummy</varname></entry>
92 <entry>A dummy device drops all packets sent to it.</entry></row>
93
94 <row><entry><varname>gre</varname></entry>
95 <entry>A Level 3 GRE tunnel over IPv4. See <ulink url="https://tools.ietf.org/html/rfc2784">RFC 2784</ulink> for details.</entry></row>
96
97 <row><entry><varname>gretap</varname></entry>
98 <entry>A Level 2 GRE tunnel over IPv4.</entry></row>
99
2266864b 100 <row><entry><varname>erspan</varname></entry>
d653a359 101 <entry>ERSPAN mirrors traffic on one or more source ports and delivers the mirrored traffic to one or more destination ports on another switch. The traffic is encapsulated in generic routing encapsulation (GRE) and is therefore routable across a layer 3 network between the source switch and the destination switch.</entry></row>
2266864b 102
798d3a52
ZJS
103 <row><entry><varname>ip6gre</varname></entry>
104 <entry>A Level 3 GRE tunnel over IPv6.</entry></row>
105
106 <row><entry><varname>ip6tnl</varname></entry>
107 <entry>An IPv4 or IPv6 tunnel over IPv6</entry></row>
108
109 <row><entry><varname>ip6gretap</varname></entry>
037a3ded 110 <entry>A Level 2 GRE tunnel over IPv6.</entry></row>
798d3a52
ZJS
111
112 <row><entry><varname>ipip</varname></entry>
113 <entry>An IPv4 over IPv4 tunnel.</entry></row>
114
115 <row><entry><varname>ipvlan</varname></entry>
116 <entry>An ipvlan device is a stacked device which receives packets from its underlying device based on IP address filtering.</entry></row>
117
118 <row><entry><varname>macvlan</varname></entry>
119 <entry>A macvlan device is a stacked device which receives packets from its underlying device based on MAC address filtering.</entry></row>
120
0371f2df
SS
121 <row><entry><varname>macvtap</varname></entry>
122 <entry>A macvtap device is a stacked device which receives packets from its underlying device based on MAC address filtering.</entry></row>
123
798d3a52
ZJS
124 <row><entry><varname>sit</varname></entry>
125 <entry>An IPv6 over IPv4 tunnel.</entry></row>
126
127 <row><entry><varname>tap</varname></entry>
128 <entry>A persistent Level 2 tunnel between a network device and a device node.</entry></row>
129
130 <row><entry><varname>tun</varname></entry>
131 <entry>A persistent Level 3 tunnel between a network device and a device node.</entry></row>
132
133 <row><entry><varname>veth</varname></entry>
a8eaaee7 134 <entry>An Ethernet tunnel between a pair of network devices.</entry></row>
798d3a52
ZJS
135
136 <row><entry><varname>vlan</varname></entry>
137 <entry>A VLAN is a stacked device which receives packets from its underlying device based on VLAN tagging. See <ulink url="http://www.ieee802.org/1/pages/802.1Q.html">IEEE 802.1Q</ulink> for details.</entry></row>
138
139 <row><entry><varname>vti</varname></entry>
140 <entry>An IPv4 over IPSec tunnel.</entry></row>
141
5cc0748e
SS
142 <row><entry><varname>vti6</varname></entry>
143 <entry>An IPv6 over IPSec tunnel.</entry></row>
144
798d3a52
ZJS
145 <row><entry><varname>vxlan</varname></entry>
146 <entry>A virtual extensible LAN (vxlan), for connecting Cloud computing deployments.</entry></row>
20897a0d 147
6598e046
SS
148 <row><entry><varname>geneve</varname></entry>
149 <entry>A GEneric NEtwork Virtualization Encapsulation (GENEVE) netdev driver.</entry></row>
150
3a56e697
SS
151 <row><entry><varname>l2tp</varname></entry>
152 <entry>A Layer 2 Tunneling Protocol (L2TP) is a tunneling protocol used to support virtual private networks (VPNs) or as part of the delivery of services by ISPs. It does not provide any encryption or confidentiality by itself</entry></row>
153
81962db7
SS
154 <row><entry><varname>macsec</varname></entry>
155 <entry>Media Access Control Security (MACsec) is an 802.1AE IEEE industry-standard security technology that provides secure communication for all traffic on Ethernet links. MACsec provides point-to-point security on Ethernet links between directly connected nodes and is capable of identifying and preventing most security threats.</entry></row>
156
20897a0d 157 <row><entry><varname>vrf</varname></entry>
92c918b0
SS
158 <entry>A Virtual Routing and Forwarding (<ulink url="https://www.kernel.org/doc/Documentation/networking/vrf.txt">VRF</ulink>) interface to create separate routing and forwarding domains.</entry></row>
159
160 <row><entry><varname>vcan</varname></entry>
ba9fa3bc 161 <entry>The virtual CAN driver (vcan). Similar to the network loopback devices, vcan offers a virtual local CAN interface.</entry></row>
20897a0d 162
d6df583c
SS
163 <row><entry><varname>vxcan</varname></entry>
164 <entry>The virtual CAN tunnel driver (vxcan). Similar to the virtual ethernet driver veth, vxcan implements a local CAN traffic tunnel between two virtual CAN network devices. When creating a vxcan, two vxcan devices are created as pair. When one end receives the packet it appears on its pair and vice versa. The vxcan can be used for cross namespace communication.
165 </entry></row>
166
e5719363
JT
167 <row><entry><varname>wireguard</varname></entry>
168 <entry>WireGuard Secure Network Tunnel.</entry></row>
169
56e7fb50
SS
170 <row><entry><varname>netdevsim</varname></entry>
171 <entry> A simulator. This simulated networking device is used for testing various networking APIs and at this time is particularly focused on testing hardware offloading related interfaces.</entry></row>
53cb501a
SS
172
173 <row><entry><varname>fou</varname></entry>
174 <entry>Foo-over-UDP tunneling.</entry></row>
175
798d3a52
ZJS
176 </tbody>
177 </tgroup>
178 </table>
179
180 </refsect1>
181
182 <refsect1>
183 <title>[Match] Section Options</title>
184
185 <para>A virtual network device is only created if the
186 <literal>[Match]</literal> section matches the current
187 environment, or if the section is empty. The following keys are
188 accepted:</para>
189
190 <variablelist class='network-directives'>
191 <varlistentry>
192 <term><varname>Host=</varname></term>
193 <listitem>
d689bbca
YW
194 <para>Matches against the hostname or machine ID of the host. See
195 <literal>ConditionHost=</literal> in
798d3a52 196 <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>
d689bbca
YW
197 for details. When prefixed with an exclamation mark (<literal>!</literal>), the result is negated.
198 If an empty string is assigned, then previously assigned value is cleared.
798d3a52
ZJS
199 </para>
200 </listitem>
201 </varlistentry>
202 <varlistentry>
203 <term><varname>Virtualization=</varname></term>
204 <listitem>
d689bbca
YW
205 <para>Checks whether the system is executed in a virtualized environment and optionally test
206 whether it is a specific implementation. See <literal>ConditionVirtualization=</literal> in
798d3a52 207 <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>
d689bbca
YW
208 for details. When prefixed with an exclamation mark (<literal>!</literal>), the result is negated.
209 If an empty string is assigned, then previously assigned value is cleared.
798d3a52
ZJS
210 </para>
211 </listitem>
212 </varlistentry>
213 <varlistentry>
214 <term><varname>KernelCommandLine=</varname></term>
215 <listitem>
d689bbca 216 <para>Checks whether a specific kernel command line option is set. See
798d3a52
ZJS
217 <literal>ConditionKernelCommandLine=</literal> in
218 <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>
d689bbca
YW
219 for details. When prefixed with an exclamation mark (<literal>!</literal>), the result is negated.
220 If an empty string is assigned, then previously assigned value is cleared.
798d3a52
ZJS
221 </para>
222 </listitem>
223 </varlistentry>
5022f08a
LP
224 <varlistentry>
225 <term><varname>KernelVersion=</varname></term>
226 <listitem>
d689bbca
YW
227 <para>Checks whether the kernel version (as reported by <command>uname -r</command>) matches a
228 certain expression. See <literal>ConditionKernelVersion=</literal> in
229 <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>
230 for details. When prefixed with an exclamation mark (<literal>!</literal>), the result is negated.
231 If an empty string is assigned, then previously assigned value is cleared.
5022f08a
LP
232 </para>
233 </listitem>
234 </varlistentry>
798d3a52
ZJS
235 <varlistentry>
236 <term><varname>Architecture=</varname></term>
237 <listitem>
d689bbca
YW
238 <para>Checks whether the system is running on a specific architecture. See
239 <literal>ConditionArchitecture=</literal> in
798d3a52 240 <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>
d689bbca
YW
241 for details. When prefixed with an exclamation mark (<literal>!</literal>), the result is negated.
242 If an empty string is assigned, then previously assigned value is cleared.
798d3a52
ZJS
243 </para>
244 </listitem>
245 </varlistentry>
246 </variablelist>
247
248 </refsect1>
249
250 <refsect1>
251 <title>[NetDev] Section Options</title>
252
253 <para>The <literal>[NetDev]</literal> section accepts the
254 following keys:</para>
255
256 <variablelist class='network-directives'>
257 <varlistentry>
258 <term><varname>Description=</varname></term>
259 <listitem>
260 <para>A free-form description of the netdev.</para>
261 </listitem>
262 </varlistentry>
263 <varlistentry>
264 <term><varname>Name=</varname></term>
265 <listitem>
266 <para>The interface name used when creating the netdev.
267 This option is compulsory.</para>
268 </listitem>
269 </varlistentry>
270 <varlistentry>
271 <term><varname>Kind=</varname></term>
272 <listitem>
273 <para>The netdev kind. This option is compulsory. See the
274 <literal>Supported netdev kinds</literal> section for the
275 valid keys.</para>
276 </listitem>
277 </varlistentry>
278 <varlistentry>
279 <term><varname>MTUBytes=</varname></term>
280 <listitem>
48847676
YW
281 <para>The maximum transmission unit in bytes to set for the device. The usual suffixes K, M, G,
282 are supported and are understood to the base of 1024. For <literal>tun</literal> or
283 <literal>tap</literal> devices, <varname>MTUBytes=</varname> setting is not currently supported in
284 <literal>[NetDev]</literal> section. Please specify it in <literal>[Link]</literal> section of
285 corresponding
286 <citerefentry><refentrytitle>systemd.network</refentrytitle><manvolnum>5</manvolnum></citerefentry>
287 files.</para>
798d3a52
ZJS
288 </listitem>
289 </varlistentry>
290 <varlistentry>
291 <term><varname>MACAddress=</varname></term>
292 <listitem>
a61b550c
YW
293 <para>The MAC address to use for the device. For <literal>tun</literal> or <literal>tap</literal>
294 devices, setting <varname>MACAddress=</varname> in the <literal>[NetDev]</literal> section is not
295 supported. Please specify it in <literal>[Link]</literal> section of the corresponding
48847676 296 <citerefentry><refentrytitle>systemd.network</refentrytitle><manvolnum>5</manvolnum></citerefentry>
a61b550c
YW
297 file. If this option is not set, <literal>vlan</literal> devices inherit the MAC address of the
298 physical interface. For other kind of netdevs, if this option is not set, then MAC address is
299 generated based on the interface name and the
300 <citerefentry><refentrytitle>machine-id</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
301 </para>
798d3a52
ZJS
302 </listitem>
303 </varlistentry>
304 </variablelist>
305 </refsect1>
306
3428fe07
SS
307 <refsect1>
308 <title>[Bridge] Section Options</title>
309
310 <para>The <literal>[Bridge]</literal> section only applies for
311 netdevs of kind <literal>bridge</literal>, and accepts the
a8eaaee7 312 following keys:</para>
3428fe07
SS
313
314 <variablelist class='network-directives'>
315 <varlistentry>
316 <term><varname>HelloTimeSec=</varname></term>
317 <listitem>
a8eaaee7 318 <para>HelloTimeSec specifies the number of seconds between two hello packets
3428fe07
SS
319 sent out by the root bridge and the designated bridges. Hello packets are
320 used to communicate information about the topology throughout the entire
321 bridged local area network.</para>
322 </listitem>
323 </varlistentry>
324 <varlistentry>
325 <term><varname>MaxAgeSec=</varname></term>
326 <listitem>
327 <para>MaxAgeSec specifies the number of seconds of maximum message age.
328 If the last seen (received) hello packet is more than this number of
329 seconds old, the bridge in question will start the takeover procedure
330 in attempt to become the Root Bridge itself.</para>
331 </listitem>
332 </varlistentry>
333 <varlistentry>
334 <term><varname>ForwardDelaySec=</varname></term>
335 <listitem>
336 <para>ForwardDelaySec specifies the number of seconds spent in each
337 of the Listening and Learning states before the Forwarding state is entered.</para>
338 </listitem>
339 </varlistentry>
c7440e74
TJ
340 <varlistentry>
341 <term><varname>AgeingTimeSec=</varname></term>
342 <listitem>
343 <para>This specifies the number of seconds a MAC Address will be kept in
d23a0044 344 the forwarding database after having a packet received from this MAC Address.</para>
c7440e74
TJ
345 </listitem>
346 </varlistentry>
347 <varlistentry>
348 <term><varname>Priority=</varname></term>
349 <listitem>
350 <para>The priority of the bridge. An integer between 0 and 65535. A lower value
351 means higher priority. The bridge having the lowest priority will be elected as root bridge.</para>
352 </listitem>
353 </varlistentry>
c4819961
JC
354 <varlistentry>
355 <term><varname>GroupForwardMask=</varname></term>
356 <listitem>
357 <para>A 16-bit bitmask represented as an integer which allows forwarding of link
358 local frames with 802.1D reserved addresses (01:80:C2:00:00:0X). A logical AND
359 is performed between the specified bitmask and the exponentiation of 2^X, the
360 lower nibble of the last octet of the MAC address. For example, a value of 8
361 would allow forwarding of frames addressed to 01:80:C2:00:00:03 (802.1X PAE).</para>
362 </listitem>
363 </varlistentry>
c7440e74
TJ
364 <varlistentry>
365 <term><varname>DefaultPVID=</varname></term>
366 <listitem>
0d6c68eb
TJ
367 <para>This specifies the default port VLAN ID of a newly attached bridge port.
368 Set this to an integer in the range 1–4094 or <literal>none</literal> to disable the PVID.</para>
c7440e74
TJ
369 </listitem>
370 </varlistentry>
3fef7a3f
SS
371 <varlistentry>
372 <term><varname>MulticastQuerier=</varname></term>
373 <listitem>
9b6ffef3 374 <para>Takes a boolean. This setting controls the IFLA_BR_MCAST_QUERIER option in the kernel.
3fef7a3f
SS
375 If enabled, the kernel will send general ICMP queries from a zero source address.
376 This feature should allow faster convergence on startup, but it causes some
377 multicast-aware switches to misbehave and disrupt forwarding of multicast packets.
025314d9 378 When unset, the kernel's default will be used.
3fef7a3f
SS
379 </para>
380 </listitem>
381 </varlistentry>
6df6d898
SS
382 <varlistentry>
383 <term><varname>MulticastSnooping=</varname></term>
384 <listitem>
9b6ffef3 385 <para>Takes a boolean. This setting controls the IFLA_BR_MCAST_SNOOPING option in the kernel.
6df6d898 386 If enabled, IGMP snooping monitors the Internet Group Management Protocol (IGMP) traffic
025314d9 387 between hosts and multicast routers. When unset, the kernel's default will be used.
6df6d898
SS
388 </para>
389 </listitem>
390 </varlistentry>
c6f8d17d
TJ
391 <varlistentry>
392 <term><varname>VLANFiltering=</varname></term>
393 <listitem>
9b6ffef3 394 <para>Takes a boolean. This setting controls the IFLA_BR_VLAN_FILTERING option in the kernel.
025314d9 395 If enabled, the bridge will be started in VLAN-filtering mode. When unset, the kernel's default will be used.
c6f8d17d
TJ
396 </para>
397 </listitem>
398 </varlistentry>
b760a9af
SS
399 <varlistentry>
400 <term><varname>STP=</varname></term>
401 <listitem>
9b6ffef3 402 <para>Takes a boolean. This enables the bridge's Spanning Tree Protocol (STP).
025314d9 403 When unset, the kernel's default will be used.
b760a9af
SS
404 </para>
405 </listitem>
406 </varlistentry>
3428fe07 407 </variablelist>
3428fe07
SS
408 </refsect1>
409
798d3a52
ZJS
410 <refsect1>
411 <title>[VLAN] Section Options</title>
412
413 <para>The <literal>[VLAN]</literal> section only applies for
414 netdevs of kind <literal>vlan</literal>, and accepts the
415 following key:</para>
416
417 <variablelist class='network-directives'>
418 <varlistentry>
419 <term><varname>Id=</varname></term>
420 <listitem>
421 <para>The VLAN ID to use. An integer in the range 0–4094.
422 This option is compulsory.</para>
423 </listitem>
424 </varlistentry>
c8b21184
SS
425 <varlistentry>
426 <term><varname>GVRP=</varname></term>
427 <listitem>
9b6ffef3
YW
428 <para>Takes a boolean. The Generic VLAN Registration Protocol (GVRP) is a protocol that
429 allows automatic learning of VLANs on a network.
025314d9
YW
430 When unset, the kernel's default will be used.
431 </para>
c8b21184
SS
432 </listitem>
433 </varlistentry>
6c1ff21b
SS
434 <varlistentry>
435 <term><varname>MVRP=</varname></term>
436 <listitem>
9b6ffef3 437 <para>Takes a boolean. Multiple VLAN Registration Protocol (MVRP) formerly known as GARP VLAN
6c1ff21b
SS
438 Registration Protocol (GVRP) is a standards-based Layer 2 network protocol,
439 for automatic configuration of VLAN information on switches. It was defined
9b6ffef3 440 in the 802.1ak amendment to 802.1Q-2005. When unset, the kernel's default will be used.
025314d9 441 </para>
6c1ff21b
SS
442 </listitem>
443 </varlistentry>
444 <varlistentry>
445 <term><varname>LooseBinding=</varname></term>
446 <listitem>
9b6ffef3 447 <para>Takes a boolean. The VLAN loose binding mode, in which only the operational state is passed
6c1ff21b 448 from the parent to the associated VLANs, but the VLAN device state is not changed.
9b6ffef3 449 When unset, the kernel's default will be used.</para>
6c1ff21b
SS
450 </listitem>
451 </varlistentry>
452 <varlistentry>
453 <term><varname>ReorderHeader=</varname></term>
454 <listitem>
9b6ffef3
YW
455 <para>Takes a boolean. The VLAN reorder header is set VLAN interfaces behave like physical interfaces.
456 When unset, the kernel's default will be used.</para>
6c1ff21b
SS
457 </listitem>
458 </varlistentry>
798d3a52 459 </variablelist>
798d3a52
ZJS
460 </refsect1>
461
462 <refsect1>
463 <title>[MACVLAN] Section Options</title>
464
465 <para>The <literal>[MACVLAN]</literal> section only applies for
466 netdevs of kind <literal>macvlan</literal>, and accepts the
467 following key:</para>
468
469 <variablelist class='network-directives'>
470 <varlistentry>
471 <term><varname>Mode=</varname></term>
472 <listitem>
473 <para>The MACVLAN mode to use. The supported options are
474 <literal>private</literal>,
475 <literal>vepa</literal>,
476 <literal>bridge</literal>, and
477 <literal>passthru</literal>.
478 </para>
479 </listitem>
480 </varlistentry>
481 </variablelist>
482
483 </refsect1>
484
0371f2df
SS
485 <refsect1>
486 <title>[MACVTAP] Section Options</title>
487
488 <para>The <literal>[MACVTAP]</literal> section applies for
489 netdevs of kind <literal>macvtap</literal> and accepts the
96d49011 490 same key as <literal>[MACVLAN]</literal>.</para>
0371f2df
SS
491
492 </refsect1>
493
798d3a52
ZJS
494 <refsect1>
495 <title>[IPVLAN] Section Options</title>
496
497 <para>The <literal>[IPVLAN]</literal> section only applies for
498 netdevs of kind <literal>ipvlan</literal>, and accepts the
499 following key:</para>
500
501 <variablelist class='network-directives'>
502 <varlistentry>
503 <term><varname>Mode=</varname></term>
504 <listitem>
505 <para>The IPVLAN mode to use. The supported options are
d384826f
SS
506 <literal>L2</literal>,<literal>L3</literal> and <literal>L3S</literal>.
507 </para>
508 </listitem>
509 </varlistentry>
510 <varlistentry>
511 <term><varname>Flags=</varname></term>
512 <listitem>
513 <para>The IPVLAN flags to use. The supported options are
514 <literal>bridge</literal>,<literal>private</literal> and <literal>vepa</literal>.
798d3a52
ZJS
515 </para>
516 </listitem>
517 </varlistentry>
518 </variablelist>
519
520 </refsect1>
521
522 <refsect1>
523 <title>[VXLAN] Section Options</title>
524 <para>The <literal>[VXLAN]</literal> section only applies for
525 netdevs of kind <literal>vxlan</literal>, and accepts the
526 following keys:</para>
527
528 <variablelist class='network-directives'>
529 <varlistentry>
6f213e4a 530 <term><varname>VNI=</varname></term>
798d3a52 531 <listitem>
6f213e4a 532 <para>The VXLAN Network Identifier (or VXLAN Segment ID). Takes a number in the range 1-16777215.</para>
798d3a52
ZJS
533 </listitem>
534 </varlistentry>
535 <varlistentry>
d35e5d37 536 <term><varname>Remote=</varname></term>
798d3a52 537 <listitem>
bf443be9 538 <para>Configures destination IP address.</para>
798d3a52
ZJS
539 </listitem>
540 </varlistentry>
541 <varlistentry>
d35e5d37
SS
542 <term><varname>Local=</varname></term>
543 <listitem>
544 <para>Configures local IP address.</para>
545 </listitem>
83cb24ac
SS
546 </varlistentry>
547 <varlistentry>
548 <term><varname>Group=</varname></term>
549 <listitem>
550 <para>Configures VXLAN multicast group IP address. All members of a VXLAN must use the same multicast group address.</para>
551 </listitem>
d35e5d37
SS
552 </varlistentry>
553 <varlistentry>
798d3a52
ZJS
554 <term><varname>TOS=</varname></term>
555 <listitem>
556 <para>The Type Of Service byte value for a vxlan interface.</para>
557 </listitem>
558 </varlistentry>
559 <varlistentry>
560 <term><varname>TTL=</varname></term>
561 <listitem>
562 <para>A fixed Time To Live N on Virtual eXtensible Local
b938cb90 563 Area Network packets. N is a number in the range 1–255. 0
798d3a52
ZJS
564 is a special value meaning that packets inherit the TTL
565 value.</para>
566 </listitem>
567 </varlistentry>
568 <varlistentry>
569 <term><varname>MacLearning=</varname></term>
570 <listitem>
9b6ffef3 571 <para>Takes a boolean. When true, enables dynamic MAC learning
798d3a52
ZJS
572 to discover remote MAC addresses.</para>
573 </listitem>
574 </varlistentry>
575 <varlistentry>
576 <term><varname>FDBAgeingSec=</varname></term>
577 <listitem>
578 <para>The lifetime of Forwarding Database entry learnt by
b938cb90 579 the kernel, in seconds.</para>
798d3a52
ZJS
580 </listitem>
581 </varlistentry>
582 <varlistentry>
3d276dd2
SS
583 <term><varname>MaximumFDBEntries=</varname></term>
584 <listitem>
585 <para>Configures maximum number of FDB entries.</para>
586 </listitem>
587 </varlistentry>
798d3a52 588 <varlistentry>
7dd6974c 589 <term><varname>ReduceARPProxy=</varname></term>
798d3a52 590 <listitem>
9b6ffef3 591 <para>Takes a boolean. When true, bridge-connected VXLAN tunnel
7dd6974c
SS
592 endpoint answers ARP requests from the local bridge on behalf
593 of remote Distributed Overlay Virtual Ethernet
594 <ulink url="https://en.wikipedia.org/wiki/Distributed_Overlay_Virtual_Ethernet">
595 (DVOE)</ulink> clients. Defaults to false.</para>
798d3a52
ZJS
596 </listitem>
597 </varlistentry>
598 <varlistentry>
599 <term><varname>L2MissNotification=</varname></term>
600 <listitem>
9b6ffef3 601 <para>Takes a boolean. When true, enables netlink LLADDR miss
798d3a52
ZJS
602 notifications.</para>
603 </listitem>
604 </varlistentry>
605 <varlistentry>
606 <term><varname>L3MissNotification=</varname></term>
607 <listitem>
9b6ffef3 608 <para>Takes a boolean. When true, enables netlink IP address miss
798d3a52
ZJS
609 notifications.</para>
610 </listitem>
611 </varlistentry>
612 <varlistentry>
613 <term><varname>RouteShortCircuit=</varname></term>
614 <listitem>
9b6ffef3 615 <para>Takes a boolean. When true, route short circuiting is turned
798d3a52
ZJS
616 on.</para>
617 </listitem>
618 </varlistentry>
cffacc74 619 <varlistentry>
53c06862 620 <term><varname>UDPChecksum=</varname></term>
cffacc74 621 <listitem>
9b6ffef3 622 <para>Takes a boolean. When true, transmitting UDP checksums when doing VXLAN/IPv4 is turned on.</para>
cffacc74
SS
623 </listitem>
624 </varlistentry>
625 <varlistentry>
626 <term><varname>UDP6ZeroChecksumTx=</varname></term>
627 <listitem>
9b6ffef3 628 <para>Takes a boolean. When true, sending zero checksums in VXLAN/IPv6 is turned on.</para>
cffacc74
SS
629 </listitem>
630 </varlistentry>
631 <varlistentry>
53c06862 632 <term><varname>UDP6ZeroChecksumRx=</varname></term>
cffacc74 633 <listitem>
9b6ffef3 634 <para>Takes a boolean. When true, receiving zero checksums in VXLAN/IPv6 is turned on.</para>
16441027
SS
635 </listitem>
636 </varlistentry>
637 <varlistentry>
53c06862 638 <term><varname>RemoteChecksumTx=</varname></term>
16441027 639 <listitem>
9b6ffef3 640 <para>Takes a boolean. When true, remote transmit checksum offload of VXLAN is turned on.</para>
16441027
SS
641 </listitem>
642 </varlistentry>
643 <varlistentry>
53c06862 644 <term><varname>RemoteChecksumRx=</varname></term>
16441027 645 <listitem>
9b6ffef3 646 <para>Takes a boolean. When true, remote receive checksum offload in VXLAN is turned on.</para>
cffacc74
SS
647 </listitem>
648 </varlistentry>
8b414e52
SS
649 <varlistentry>
650 <term><varname>GroupPolicyExtension=</varname></term>
651 <listitem>
9b6ffef3 652 <para>Takes a boolean. When true, it enables Group Policy VXLAN extension security label mechanism
b938cb90 653 across network peers based on VXLAN. For details about the Group Policy VXLAN, see the
8b414e52
SS
654 <ulink url="https://tools.ietf.org/html/draft-smith-vxlan-group-policy">
655 VXLAN Group Policy </ulink> document. Defaults to false.</para>
656 </listitem>
657 </varlistentry>
ea0288d1
SS
658 <varlistentry>
659 <term><varname>DestinationPort=</varname></term>
660 <listitem>
661 <para>Configures the default destination UDP port on a per-device basis.
662 If destination port is not specified then Linux kernel default will be used.
98616735
SS
663 Set destination port 4789 to get the IANA assigned value. If not set or if the
664 destination port is assigned the empty string the default port of 4789 is used.</para>
ea0288d1
SS
665 </listitem>
666 </varlistentry>
667 <varlistentry>
668 <term><varname>PortRange=</varname></term>
669 <listitem>
670 <para>Configures VXLAN port range. VXLAN bases source
671 UDP port based on flow to help the receiver to be able
672 to load balance based on outer header flow. It
673 restricts the port range to the normal UDP local
674 ports, and allows overriding via configuration.</para>
675 </listitem>
676 </varlistentry>
d8653945
SS
677 <varlistentry>
678 <term><varname>FlowLabel=</varname></term>
679 <listitem>
680 <para>Specifies the flow label to use in outgoing packets.
681 The valid range is 0-1048575.
682 </para>
683 </listitem>
684 </varlistentry>
798d3a52
ZJS
685 </variablelist>
686 </refsect1>
6598e046
SS
687 <refsect1>
688 <title>[GENEVE] Section Options</title>
689 <para>The <literal>[GENEVE]</literal> section only applies for
690 netdevs of kind <literal>geneve</literal>, and accepts the
691 following keys:</para>
692
693 <variablelist class='network-directives'>
694 <varlistentry>
695 <term><varname>Id=</varname></term>
696 <listitem>
785889e5 697 <para>Specifies the Virtual Network Identifier (VNI) to use. Ranges [0-16777215].</para>
6598e046
SS
698 </listitem>
699 </varlistentry>
700 <varlistentry>
701 <term><varname>Remote=</varname></term>
702 <listitem>
703 <para>Specifies the unicast destination IP address to use in outgoing packets.</para>
704 </listitem>
705 </varlistentry>
706 <varlistentry>
707 <term><varname>TOS=</varname></term>
708 <listitem>
98616735 709 <para>Specifies the TOS value to use in outgoing packets. Ranges [1-255].</para>
6598e046
SS
710 </listitem>
711 </varlistentry>
712 <varlistentry>
713 <term><varname>TTL=</varname></term>
714 <listitem>
98616735 715 <para>Specifies the TTL value to use in outgoing packets. Ranges [1-255].</para>
6598e046
SS
716 </listitem>
717 </varlistentry>
718 <varlistentry>
719 <term><varname>UDPChecksum=</varname></term>
720 <listitem>
9b6ffef3 721 <para>Takes a boolean. When true, specifies if UDP checksum is calculated for transmitted packets over IPv4.</para>
6598e046
SS
722 </listitem>
723 </varlistentry>
724 <varlistentry>
725 <term><varname>UDP6ZeroChecksumTx=</varname></term>
726 <listitem>
9b6ffef3 727 <para>Takes a boolean. When true, skip UDP checksum calculation for transmitted packets over IPv6.</para>
6598e046
SS
728 </listitem>
729 </varlistentry>
730 <varlistentry>
731 <term><varname>UDP6ZeroChecksumRx=</varname></term>
732 <listitem>
9b6ffef3 733 <para>Takes a boolean. When true, allows incoming UDP packets over IPv6 with zero checksum field.</para>
6598e046
SS
734 </listitem>
735 </varlistentry>
736 <varlistentry>
737 <term><varname>DestinationPort=</varname></term>
738 <listitem>
98616735
SS
739 <para>Specifies destination port. Defaults to 6081. If not set or assigned the empty string, the default
740 port of 6081 is used.</para>
6598e046
SS
741 </listitem>
742 </varlistentry>
743 <varlistentry>
744 <term><varname>FlowLabel=</varname></term>
745 <listitem>
746 <para>Specifies the flow label to use in outgoing packets.</para>
747 </listitem>
748 </varlistentry>
749 </variablelist>
750 </refsect1>
3a56e697
SS
751 <refsect1>
752 <title>[L2TP] Section Options</title>
753 <para>The <literal>[L2TP]</literal> section only applies for
754 netdevs of kind <literal>l2tp</literal>, and accepts the
755 following keys:</para>
756
757 <variablelist class='network-directives'>
758 <varlistentry>
759 <term><varname>TunnelId=</varname></term>
760 <listitem>
761 <para>Specifies the tunnel id. The value used must match the <literal>PeerTunnelId=</literal> value being used at the peer.
762 Ranges a number between 1 and 4294967295). This option is compulsory.</para>
763 </listitem>
764 </varlistentry>
765 <varlistentry>
766 <term><varname>PeerTunnelId=</varname></term>
767 <listitem>
768 <para>Specifies the peer tunnel id. The value used must match the <literal>PeerTunnelId=</literal> value being used at the peer.
769 Ranges a number between 1 and 4294967295). This option is compulsory.</para>
770 </listitem>
771 </varlistentry>
772 <varlistentry>
773 <term><varname>Remote=</varname></term>
774 <listitem>
775 <para>Specifies the IP address of the remote peer. This option is compulsory.</para>
776 </listitem>
777 </varlistentry>
778 <varlistentry>
779 <term><varname>Local=</varname></term>
780 <listitem>
d053d08a
YW
781 <para>Specifies the IP address of the local interface. Takes an IP address, or the special values
782 <literal>auto</literal>, <literal>static</literal>, or <literal>dynamic</literal>. When an address
783 is set, then the local interface must have the address. If <literal>auto</literal>, then one of the
784 addresses on the local interface is used. Similarly, if <literal>static</literal> or
785 <literal>dynamic</literal> is set, then one of the static or dynamic addresses on the local
786 interface is used. Defaults to <literal>auto</literal>.</para>
3a56e697
SS
787 </listitem>
788 </varlistentry>
789 <varlistentry>
790 <term><varname>EncapsulationType=</varname></term>
791 <listitem>
792 <para>Specifies the encapsulation type of the tunnel. Takes one of <literal>udp</literal> or <literal>ip</literal>.</para>
793 </listitem>
794 </varlistentry>
795 <varlistentry>
796 <term><varname>UDPSourcePort=</varname></term>
797 <listitem>
798 <para>Specifies the UDP source port to be used for the tunnel. When UDP encapsulation is selected it's mandotory. Ignored when ip
799 encapsulation is selected.</para>
800 </listitem>
801 </varlistentry>
802 <varlistentry>
803 <term><varname>DestinationPort=</varname></term>
804 <listitem>
805 <para>Specifies destination port. When UDP encapsulation is selected it's mandotory. Ignored when ip
806 encapsulation is selected.</para>
807 </listitem>
808 </varlistentry>
809 <varlistentry>
810 <term><varname>UDPChecksum=</varname></term>
811 <listitem>
812 <para>Takes a boolean. When true, specifies if UDP checksum is calculated for transmitted packets over IPv4.</para>
813 </listitem>
814 </varlistentry>
815 <varlistentry>
816 <term><varname>UDP6ZeroChecksumTx=</varname></term>
817 <listitem>
818 <para>Takes a boolean. When true, skip UDP checksum calculation for transmitted packets over IPv6.</para>
819 </listitem>
820 </varlistentry>
821 <varlistentry>
822 <term><varname>UDP6ZeroChecksumRx=</varname></term>
823 <listitem>
824 <para>Takes a boolean. When true, allows incoming UDP packets over IPv6 with zero checksum field.</para>
825 </listitem>
826 </varlistentry>
827 </variablelist>
828 </refsect1>
829 <refsect1>
830 <title>[L2TPSession] Section Options</title>
831 <para>The <literal>[L2TPSession]</literal> section only applies for
832 netdevs of kind <literal>l2tp</literal>, and accepts the
833 following keys:</para>
834 <variablelist class='network-directives'>
835 <varlistentry>
836 <term><varname>Name=</varname></term>
837 <listitem>
5238e957 838 <para>Specifies the name of the session. This option is compulsory.</para>
3a56e697
SS
839 </listitem>
840 </varlistentry>
841 <varlistentry>
842 <term><varname>SessionId=</varname></term>
843 <listitem>
5238e957 844 <para>Specifies the session id. The value used must match the <literal>SessionId=</literal> value being used at the peer.
3a56e697
SS
845 Ranges a number between 1 and 4294967295). This option is compulsory.</para>
846 </listitem>
847 </varlistentry>
848 <varlistentry>
849 <term><varname>PeerSessionId=</varname></term>
850 <listitem>
851 <para>Specifies the peer session id. The value used must match the <literal>PeerSessionId=</literal> value being used at the peer.
852 Ranges a number between 1 and 4294967295). This option is compulsory.</para>
853 </listitem>
854 </varlistentry>
855 <varlistentry>
856 <term><varname>Layer2SpecificHeader=</varname></term>
857 <listitem>
858 <para>Specifies layer2specific header type of the session. One of <literal>none</literal> or <literal>default</literal>. Defaults to <literal>default</literal>.</para>
859 </listitem>
860 </varlistentry>
861 </variablelist>
862 </refsect1>
81962db7
SS
863 <refsect1>
864 <title>[MACsec] Section Options</title>
865 <para>The <literal>[MACsec]</literal> section only applies for network devices of kind
866 <literal>macsec</literal>, and accepts the following keys:</para>
867
868 <variablelist class='network-directives'>
869 <varlistentry>
870 <term><varname>Port=</varname></term>
871 <listitem>
872 <para>Specifies the port to be used for the MACsec transmit channel. The port is used to make
873 secure channel identifier (SCI). Takes a value between 1 and 65535. Defaults to unset.
874 </para>
875 </listitem>
876 </varlistentry>
877 <varlistentry>
878 <term><varname>Encrypt=</varname></term>
879 <listitem>
880 <para>Takes a boolean. When true, enable encryption. Defaults to unset.</para>
881 </listitem>
882 </varlistentry>
883 </variablelist>
884 </refsect1>
885 <refsect1>
886 <title>[MACsecReceiveChannel] Section Options</title>
887 <para>The <literal>[MACsecReceiveChannel]</literal> section only applies for network devices of
888 kind <literal>macsec</literal>, and accepts the following keys:</para>
889
890 <variablelist class='network-directives'>
891 <varlistentry>
892 <term><varname>Port=</varname></term>
893 <listitem>
894 <para>Specifies the port to be used for the MACsec receive channel. The port is used to make
895 secure channel identifier (SCI). Takes a value between 1 and 65535. This option is
896 compulsory, and is not set by default.</para>
897 </listitem>
898 </varlistentry>
899 <varlistentry>
900 <term><varname>MACAddress=</varname></term>
901 <listitem>
902 <para>Specifies the MAC address to be used for the MACsec receive channel. The MAC address
903 used to make secure channel identifier (SCI). This option is compulsory, and is not set by
904 default.</para>
905 </listitem>
906 </varlistentry>
907 </variablelist>
908 </refsect1>
909 <refsect1>
910 <title>[MACsecTransmitAssociation] Section Options</title>
911 <para>The <literal>[MACsecTransmitAssociation]</literal> section only applies for network devices
912 of kind <literal>macsec</literal>, and accepts the following keys:</para>
913
914 <variablelist class='network-directives'>
915 <varlistentry>
916 <term><varname>PacketNumber=</varname></term>
917 <listitem>
918 <para>Specifies the packet number to be used for replay protection and the construction of
919 the initialization vector (along with the secure channel identifier [SCI]). Takes a value
920 between 1-4,294,967,295. Defaults to unset.
921 </para>
922 </listitem>
923 </varlistentry>
924 <varlistentry>
925 <term><varname>KeyId=</varname></term>
926 <listitem>
927 <para>Specifies the identification for the key. Takes a number between 0-255. This option
928 is compulsory, and is not set by default.</para>
929 </listitem>
930 </varlistentry>
931 <varlistentry>
932 <term><varname>Key=</varname></term>
933 <listitem>
934 <para>Specifies the encryption key used in the transmission channel. The same key must be
935 configured on the peer’s matching receive channel. This option is compulsory, and is not set
936 by default. Takes a 128-bit key encoded in a hexadecimal string, for example
937 <literal>dffafc8d7b9a43d5b9a3dfbbf6a30c16</literal>.</para>
938 </listitem>
939 </varlistentry>
eb4705fb
YW
940 <varlistentry>
941 <term><varname>KeyFile=</varname></term>
942 <listitem>
943 <para>Takes a absolute path to a file which contains a 128-bit key encoded in a hexadecimal
944 string, which will be used in the transmission channel. When this option is specified,
945 <varname>Key=</varname> is ignored. Note that the file must be readable by the user
946 <literal>systemd-network</literal>, so it should be, e.g., owned by
947 <literal>root:systemd-network</literal> with a <literal>0640</literal> file mode.</para>
948 </listitem>
949 </varlistentry>
a7b9c52f
YW
950 <varlistentry>
951 <term><varname>Activate=</varname></term>
952 <listitem>
953 <para>Takes a boolean. If enabled, then the security association is activated. Defaults to
954 unset.</para>
955 </listitem>
956 </varlistentry>
b0e13c31
YW
957 <varlistentry>
958 <term><varname>UseForEncoding=</varname></term>
959 <listitem>
960 <para>Takes a boolean. If enabled, then the security association is used for encoding. Only
961 one <literal>[MACsecTransmitAssociation]</literal> section can enable this option. When enabled,
962 <varname>Activate=yes</varname> is implied. Defaults to unset.</para>
963 </listitem>
964 </varlistentry>
81962db7
SS
965 </variablelist>
966 </refsect1>
967 <refsect1>
968 <title>[MACsecReceiveAssociation] Section Options</title>
969 <para>The <literal>[MACsecReceiveAssociation]</literal> section only applies for
970 network devices of kind <literal>macsec</literal>, and accepts the
971 following keys:</para>
972
973 <variablelist class='network-directives'>
974 <varlistentry>
975 <term><varname>Port=</varname></term>
976 <listitem>
977 <para>Accepts the same key in <literal>[MACsecReceiveChannel]</literal> section.</para>
978 </listitem>
979 </varlistentry>
980 <varlistentry>
981 <term><varname>MACAddress=</varname></term>
982 <listitem>
983 <para>Accepts the same key in <literal>[MACsecReceiveChannel]</literal> section.</para>
984 </listitem>
985 </varlistentry>
986 <varlistentry>
987 <term><varname>PacketNumber=</varname></term>
988 <listitem>
989 <para>Accepts the same key in <literal>[MACsecTransmitAssociation]</literal> section.</para>
990 </listitem>
991 </varlistentry>
992 <varlistentry>
993 <term><varname>KeyId=</varname></term>
994 <listitem>
995 <para>Accepts the same key in <literal>[MACsecTransmitAssociation]</literal> section.</para>
996 </listitem>
997 </varlistentry>
998 <varlistentry>
999 <term><varname>Key=</varname></term>
1000 <listitem>
1001 <para>Accepts the same key in <literal>[MACsecTransmitAssociation]</literal> section.</para>
1002 </listitem>
1003 </varlistentry>
eb4705fb
YW
1004 <varlistentry>
1005 <term><varname>KeyFile=</varname></term>
1006 <listitem>
1007 <para>Accepts the same key in <literal>[MACsecTransmitAssociation]</literal> section.</para>
1008 </listitem>
1009 </varlistentry>
a7b9c52f
YW
1010 <varlistentry>
1011 <term><varname>Activate=</varname></term>
1012 <listitem>
1013 <para>Accepts the same key in <literal>[MACsecTransmitAssociation]</literal> section.</para>
1014 </listitem>
1015 </varlistentry>
81962db7
SS
1016 </variablelist>
1017 </refsect1>
798d3a52
ZJS
1018 <refsect1>
1019 <title>[Tunnel] Section Options</title>
1020
1021 <para>The <literal>[Tunnel]</literal> section only applies for
1022 netdevs of kind
1023 <literal>ipip</literal>,
1024 <literal>sit</literal>,
1025 <literal>gre</literal>,
1026 <literal>gretap</literal>,
1027 <literal>ip6gre</literal>,
1028 <literal>ip6gretap</literal>,
5cc0748e 1029 <literal>vti</literal>,
af555aa3
YW
1030 <literal>vti6</literal>,
1031 <literal>ip6tnl</literal>, and
1032 <literal>erspan</literal> and accepts
798d3a52
ZJS
1033 the following keys:</para>
1034
1035 <variablelist class='network-directives'>
1036 <varlistentry>
1037 <term><varname>Local=</varname></term>
1038 <listitem>
8643885f
YW
1039 <para>A static local address for tunneled packets. It must be an address on another interface of
1040 this host, or the special value <literal>any</literal>.</para>
798d3a52
ZJS
1041 </listitem>
1042 </varlistentry>
1043 <varlistentry>
1044 <term><varname>Remote=</varname></term>
1045 <listitem>
8643885f
YW
1046 <para>The remote endpoint of the tunnel. Takes an IP address or the special value
1047 <literal>any</literal>.</para>
798d3a52
ZJS
1048 </listitem>
1049 </varlistentry>
1050 <varlistentry>
1051 <term><varname>TOS=</varname></term>
1052 <listitem>
1053 <para>The Type Of Service byte value for a tunnel interface.
b938cb90 1054 For details about the TOS, see the
798d3a52
ZJS
1055 <ulink url="http://tools.ietf.org/html/rfc1349"> Type of
1056 Service in the Internet Protocol Suite </ulink> document.
1057 </para>
1058 </listitem>
1059 </varlistentry>
1060 <varlistentry>
1061 <term><varname>TTL=</varname></term>
1062 <listitem>
1063 <para>A fixed Time To Live N on tunneled packets. N is a
b938cb90 1064 number in the range 1–255. 0 is a special value meaning that
798d3a52 1065 packets inherit the TTL value. The default value for IPv4
b938cb90 1066 tunnels is: inherit. The default value for IPv6 tunnels is
798d3a52
ZJS
1067 64.</para>
1068 </listitem>
1069 </varlistentry>
1070 <varlistentry>
1071 <term><varname>DiscoverPathMTU=</varname></term>
1072 <listitem>
9b6ffef3 1073 <para>Takes a boolean. When true, enables Path MTU Discovery on
798d3a52
ZJS
1074 the tunnel.</para>
1075 </listitem>
1076 </varlistentry>
276de526
SS
1077 <varlistentry>
1078 <term><varname>IPv6FlowLabel=</varname></term>
1079 <listitem>
a8eaaee7 1080 <para>Configures the 20-bit flow label (see <ulink url="https://tools.ietf.org/html/rfc6437">
276de526 1081 RFC 6437</ulink>) field in the IPv6 header (see <ulink url="https://tools.ietf.org/html/rfc2460">
a8eaaee7
JE
1082 RFC 2460</ulink>), which is used by a node to label packets of a flow.
1083 It is only used for IPv6 tunnels.
1084 A flow label of zero is used to indicate packets that have
1085 not been labeled.
1086 It can be configured to a value in the range 0–0xFFFFF, or be
1087 set to <literal>inherit</literal>, in which case the original flowlabel is used.</para>
276de526
SS
1088 </listitem>
1089 </varlistentry>
9b0ca30a 1090 <varlistentry>
a9b70f9d 1091 <term><varname>CopyDSCP=</varname></term>
9b0ca30a 1092 <listitem>
9b6ffef3 1093 <para>Takes a boolean. When true, the Differentiated Service Code
3cf4bcab 1094 Point (DSCP) field will be copied to the inner header from
a9b70f9d 1095 outer header during the decapsulation of an IPv6 tunnel
3cf4bcab
ZJS
1096 packet. DSCP is a field in an IP packet that enables different
1097 levels of service to be assigned to network traffic.
1098 Defaults to <literal>no</literal>.
9b0ca30a
SS
1099 </para>
1100 </listitem>
1101 </varlistentry>
dae398a8
SS
1102 <varlistentry>
1103 <term><varname>EncapsulationLimit=</varname></term>
1104 <listitem>
1105 <para>The Tunnel Encapsulation Limit option specifies how many additional
1106 levels of encapsulation are permitted to be prepended to the packet.
1107 For example, a Tunnel Encapsulation Limit option containing a limit
1108 value of zero means that a packet carrying that option may not enter
1109 another tunnel before exiting the current tunnel.
1110 (see <ulink url="https://tools.ietf.org/html/rfc2473#section-4.1.1"> RFC 2473</ulink>).
b938cb90 1111 The valid range is 0–255 and <literal>none</literal>. Defaults to 4.
dae398a8
SS
1112 </para>
1113 </listitem>
1114 </varlistentry>
1d710029
SS
1115 <varlistentry>
1116 <term><varname>Key=</varname></term>
1117 <listitem>
1118 <para>The <varname>Key=</varname> parameter specifies the same key to use in
1119 both directions (<varname>InputKey=</varname> and <varname>OutputKey=</varname>).
1120 The <varname>Key=</varname> is either a number or an IPv4 address-like dotted quad.
1121 It is used as mark-configured SAD/SPD entry as part of the lookup key (both in data
1122 and control path) in ip xfrm (framework used to implement IPsec protocol).
1123 See <ulink url="http://man7.org/linux/man-pages/man8/ip-xfrm.8.html">
c65c01c4
YW
1124 ip-xfrm — transform configuration</ulink> for details. It is only used for VTI/VTI6,
1125 GRE, GRETAP, and ERSPAN tunnels.</para>
1d710029
SS
1126 </listitem>
1127 </varlistentry>
1128 <varlistentry>
1129 <term><varname>InputKey=</varname></term>
1130 <listitem>
1131 <para>The <varname>InputKey=</varname> parameter specifies the key to use for input.
c65c01c4
YW
1132 The format is same as <varname>Key=</varname>. It is only used for VTI/VTI6, GRE, GRETAP,
1133 and ERSPAN tunnels.</para>
1d710029
SS
1134 </listitem>
1135 </varlistentry>
1136 <varlistentry>
1137 <term><varname>OutputKey=</varname></term>
1138 <listitem>
1139 <para>The <varname>OutputKey=</varname> parameter specifies the key to use for output.
c65c01c4
YW
1140 The format is same as <varname>Key=</varname>. It is only used for VTI/VTI6, GRE, GRETAP,
1141 and ERSPAN tunnels.</para>
1d710029
SS
1142 </listitem>
1143 </varlistentry>
798d3a52
ZJS
1144 <varlistentry>
1145 <term><varname>Mode=</varname></term>
1146 <listitem>
a8eaaee7 1147 <para>An <literal>ip6tnl</literal> tunnel can be in one of three
798d3a52
ZJS
1148 modes
1149 <literal>ip6ip6</literal> for IPv6 over IPv6,
1150 <literal>ipip6</literal> for IPv4 over IPv6 or
1151 <literal>any</literal> for either.
1152 </para>
1153 </listitem>
1154 </varlistentry>
4d7fa6de
SS
1155 <varlistentry>
1156 <term><varname>Independent=</varname></term>
1157 <listitem>
9b6ffef3 1158 <para>Takes a boolean. When true tunnel does not require .network file. Created as "tunnel@NONE".
4d7fa6de
SS
1159 Defaults to <literal>false</literal>.
1160 </para>
1161 </listitem>
1162 </varlistentry>
3a4f3e42
SS
1163 <varlistentry>
1164 <term><varname>AllowLocalRemote=</varname></term>
1165 <listitem>
9b6ffef3 1166 <para>Takes a boolean. When true allows tunnel traffic on <varname>ip6tnl</varname> devices where the remote endpoint is a local host address.
025314d9 1167 When unset, the kernel's default will be used.
3a4f3e42
SS
1168 </para>
1169 </listitem>
1170 </varlistentry>
53cb501a
SS
1171 <varlistentry>
1172 <term><varname>FooOverUDP=</varname></term>
1173 <listitem>
9b6ffef3 1174 <para>Takes a boolean. Specifies whether <varname>FooOverUDP=</varname> tunnel is to be configured.
0b145817
YW
1175 Defaults to false. This takes effects only for IPIP, SIT, GRE, and GRETAP tunnels.
1176 For more detail information see
53cb501a
SS
1177 <ulink url="https://lwn.net/Articles/614348">Foo over UDP</ulink></para>
1178 </listitem>
1179 </varlistentry>
1180 <varlistentry>
1181 <term><varname>FOUDestinationPort=</varname></term>
1182 <listitem>
6f520e74 1183 <para>This setting specifies the UDP destination port for encapsulation.
0b145817 1184 This field is mandatory when <varname>FooOverUDP=yes</varname>, and is not set by default.</para>
53cb501a
SS
1185 </listitem>
1186 </varlistentry>
1187 <varlistentry>
1188 <term><varname>FOUSourcePort=</varname></term>
1189 <listitem>
6f520e74
ZJS
1190 <para>This setting specifies the UDP source port for encapsulation. Defaults to <constant>0</constant>
1191 — that is, the source port for packets is left to the network stack to decide.</para>
53cb501a
SS
1192 </listitem>
1193 </varlistentry>
1194 <varlistentry>
1195 <term><varname>Encapsulation=</varname></term>
1196 <listitem>
0b145817 1197 <para>Accepts the same key as in the <literal>[FooOverUDP]</literal> section.</para>
53cb501a
SS
1198 </listitem>
1199 </varlistentry>
d067cab3
DA
1200 <varlistentry>
1201 <term><varname>IPv6RapidDeploymentPrefix=</varname></term>
1202 <listitem>
1203 <para>Reconfigure the tunnel for <ulink url="https://tools.ietf.org/html/rfc5569">IPv6 Rapid
1204 Deployment</ulink>, also known as 6rd. The value is an ISP-specific IPv6 prefix with a non-zero length. Only
1205 applicable to SIT tunnels.</para>
1206 </listitem>
1207 </varlistentry>
918049ad
SS
1208 <varlistentry>
1209 <term><varname>ISATAP=</varname></term>
1210 <listitem>
1211 <para>Takes a boolean. If set, configures the tunnel as Intra-Site Automatic Tunnel Addressing Protocol (ISATAP) tunnel.
1212 Only applicable to SIT tunnels. When unset, the kernel's default will be used.</para>
1213 </listitem>
1214 </varlistentry>
2266864b
SS
1215 <varlistentry>
1216 <term><varname>SerializeTunneledPackets=</varname></term>
1217 <listitem>
c65c01c4
YW
1218 <para>Takes a boolean. If set to yes, then packets are serialized. Only applies for GRE,
1219 GRETAP, and ERSPAN tunnels. When unset, the kernel's default will be used.
2266864b
SS
1220 </para>
1221 </listitem>
1222 </varlistentry>
1223 <varlistentry>
1224 <term><varname>ERSPANIndex=</varname></term>
1225 <listitem>
1226 <para>Specifies the ERSPAN index field for the interface, an integer in the range 1-1048575 associated with
1227 the ERSPAN traffic's source port and direction. This field is mandatory.
1228 </para>
1229 </listitem>
1230 </varlistentry>
798d3a52
ZJS
1231 </variablelist>
1232 </refsect1>
53cb501a
SS
1233
1234 <refsect1>
1235 <title>[FooOverUDP] Section Options</title>
1236
1237 <para>The <literal>[FooOverUDP]</literal> section only applies for
1238 netdevs of kind <literal>fou</literal> and accepts the
1239 following keys:</para>
1240
1241 <variablelist class='network-directives'>
53cb501a
SS
1242 <varlistentry>
1243 <term><varname>Encapsulation=</varname></term>
1244 <listitem>
1245 <para>Specifies the encapsulation mechanism used to store networking packets of various protocols inside the UDP packets. Supports the following values:
1246
1247 <literal>FooOverUDP</literal> provides the simplest no frills model of UDP encapsulation, it simply encapsulates
1248 packets directly in the UDP payload.
1249 <literal>GenericUDPEncapsulation</literal> is a generic and extensible encapsulation, it allows encapsulation of packets for any IP
1250 protocol and optional data as part of the encapsulation.
1251 For more detailed information see <ulink url="https://lwn.net/Articles/615044">Generic UDP Encapsulation</ulink>.
1252 Defaults to <literal>FooOverUDP</literal>.
1253 </para>
1254 </listitem>
1255 </varlistentry>
1256 <varlistentry>
1257 <term><varname>Port=</varname></term>
1258 <listitem>
1259 <para>Specifies the port number, where the IP encapsulation packets will arrive. Please take note that the packets
1260 will arrive with the encapsulation will be removed. Then they will be manually fed back into the network stack, and sent ahead
1261 for delivery to the real destination. This option is mandatory.</para>
1262 </listitem>
1263 </varlistentry>
0b145817
YW
1264 <varlistentry>
1265 <term><varname>Protocol=</varname></term>
1266 <listitem>
1267 <para>The <varname>Protocol=</varname> specifies the protocol number of the packets arriving
1268 at the UDP port. When <varname>Encapsulation=FooOverUDP</varname>, this field is mandatory
1269 and is not set by default. Takes an IP protocol name such as <literal>gre</literal> or
1270 <literal>ipip</literal>, or an integer within the range 1-255. When
1271 <varname>Encapsulation=GenericUDPEncapsulation</varname>, this must not be specified.</para>
1272 </listitem>
1273 </varlistentry>
1274 </variablelist>
53cb501a 1275 </refsect1>
798d3a52
ZJS
1276 <refsect1>
1277 <title>[Peer] Section Options</title>
1278
1279 <para>The <literal>[Peer]</literal> section only applies for
1280 netdevs of kind <literal>veth</literal> and accepts the
a8eaaee7 1281 following keys:</para>
798d3a52
ZJS
1282
1283 <variablelist class='network-directives'>
1284 <varlistentry>
1285 <term><varname>Name=</varname></term>
1286 <listitem>
1287 <para>The interface name used when creating the netdev.
1288 This option is compulsory.</para>
1289 </listitem>
1290 </varlistentry>
1291 <varlistentry>
1292 <term><varname>MACAddress=</varname></term>
1293 <listitem>
b938cb90 1294 <para>The peer MACAddress, if not set, it is generated in
798d3a52
ZJS
1295 the same way as the MAC address of the main
1296 interface.</para>
1297 </listitem>
1298 </varlistentry>
1299 </variablelist>
1300 </refsect1>
d6df583c
SS
1301 <refsect1>
1302 <title>[VXCAN] Section Options</title>
1303 <para>The <literal>[VXCAN]</literal> section only applies for
1304 netdevs of kind <literal>vxcan</literal> and accepts the
1305 following key:</para>
1306
1307 <variablelist class='network-directives'>
1308 <varlistentry>
1309 <term><varname>Peer=</varname></term>
1310 <listitem>
1311 <para>The peer interface name used when creating the netdev.
1312 This option is compulsory.</para>
1313 </listitem>
1314 </varlistentry>
1315 </variablelist>
1316 </refsect1>
798d3a52
ZJS
1317 <refsect1>
1318 <title>[Tun] Section Options</title>
1319
1320 <para>The <literal>[Tun]</literal> section only applies for
1321 netdevs of kind <literal>tun</literal>, and accepts the following
1322 keys:</para>
1323
1324 <variablelist class='network-directives'>
1325 <varlistentry>
1326 <term><varname>OneQueue=</varname></term>
9b6ffef3 1327 <listitem><para>Takes a boolean. Configures whether
798d3a52
ZJS
1328 all packets are queued at the device (enabled), or a fixed
1329 number of packets are queued at the device and the rest at the
1330 <literal>qdisc</literal>. Defaults to
1331 <literal>no</literal>.</para>
1332 </listitem>
1333 </varlistentry>
1334 <varlistentry>
1335 <term><varname>MultiQueue=</varname></term>
9b6ffef3 1336 <listitem><para>Takes a boolean. Configures whether
798d3a52
ZJS
1337 to use multiple file descriptors (queues) to parallelize
1338 packets sending and receiving. Defaults to
1339 <literal>no</literal>.</para>
1340 </listitem>
1341 </varlistentry>
1342 <varlistentry>
1343 <term><varname>PacketInfo=</varname></term>
9b6ffef3 1344 <listitem><para>Takes a boolean. Configures whether
ff9b60f3 1345 packets should be prepended with four extra bytes (two flag
b938cb90 1346 bytes and two protocol bytes). If disabled, it indicates that
798d3a52
ZJS
1347 the packets will be pure IP packets. Defaults to
1348 <literal>no</literal>.</para>
1349 </listitem>
1350 </varlistentry>
43f78da4 1351 <varlistentry>
2aba142e 1352 <term><varname>VNetHeader=</varname></term>
9b6ffef3 1353 <listitem><para>Takes a boolean. Configures
43f78da4
SS
1354 IFF_VNET_HDR flag for a tap device. It allows sending
1355 and receiving larger Generic Segmentation Offload (GSO)
1356 packets. This may increase throughput significantly.
1357 Defaults to
1358 <literal>no</literal>.</para>
1359 </listitem>
1360 </varlistentry>
798d3a52
ZJS
1361 <varlistentry>
1362 <term><varname>User=</varname></term>
1363 <listitem><para>User to grant access to the
1364 <filename>/dev/net/tun</filename> device.</para>
1365 </listitem>
1366 </varlistentry>
1367 <varlistentry>
1368 <term><varname>Group=</varname></term>
1369 <listitem><para>Group to grant access to the
1370 <filename>/dev/net/tun</filename> device.</para>
1371 </listitem>
1372 </varlistentry>
1373
1374 </variablelist>
1375
1376 </refsect1>
1377
1378 <refsect1>
1379 <title>[Tap] Section Options</title>
1380
1381 <para>The <literal>[Tap]</literal> section only applies for
1382 netdevs of kind <literal>tap</literal>, and accepts the same keys
1383 as the <literal>[Tun]</literal> section.</para>
1384 </refsect1>
1385
e5719363
JT
1386 <refsect1>
1387 <title>[WireGuard] Section Options</title>
1388
1389 <para>The <literal>[WireGuard]</literal> section accepts the following
1390 keys:</para>
1391
1392 <variablelist class='network-directives'>
1393 <varlistentry>
1394 <term><varname>PrivateKey=</varname></term>
1395 <listitem>
1396 <para>The Base64 encoded private key for the interface. It can be
1397 generated using the <command>wg genkey</command> command
1398 (see <citerefentry project="wireguard"><refentrytitle>wg</refentrytitle><manvolnum>8</manvolnum></citerefentry>).
76df7779 1399 This option or <varname>PrivateKeyFile=</varname> is mandatory to use WireGuard.
a8d6dbed 1400 Note that because this information is secret, you may want to set
bd277f53 1401 the permissions of the .netdev file to be owned by <literal>root:systemd-network</literal>
a8d6dbed 1402 with a <literal>0640</literal> file mode.</para>
e5719363
JT
1403 </listitem>
1404 </varlistentry>
76df7779
YW
1405 <varlistentry>
1406 <term><varname>PrivateKeyFile=</varname></term>
1407 <listitem>
a3945c63 1408 <para>Takes an absolute path to a file which contains the Base64 encoded private key for the interface.
cb31e7c8 1409 When this option is specified, then <varname>PrivateKey=</varname> is ignored.
76df7779
YW
1410 Note that the file must be readable by the user <literal>systemd-network</literal>, so it
1411 should be, e.g., owned by <literal>root:systemd-network</literal> with a
1412 <literal>0640</literal> file mode.</para>
1413 </listitem>
1414 </varlistentry>
e5719363
JT
1415 <varlistentry>
1416 <term><varname>ListenPort=</varname></term>
1417 <listitem>
1418 <para>Sets UDP port for listening. Takes either value between 1 and 65535
1419 or <literal>auto</literal>. If <literal>auto</literal> is specified,
1420 the port is automatically generated based on interface name.
1421 Defaults to <literal>auto</literal>.</para>
1422 </listitem>
1423 </varlistentry>
1424 <varlistentry>
1c30b174 1425 <term><varname>FirewallMark=</varname></term>
e5719363 1426 <listitem>
1c30b174 1427 <para>Sets a firewall mark on outgoing WireGuard packets from this interface. Takes a number between 1 and 4294967295.</para>
e5719363
JT
1428 </listitem>
1429 </varlistentry>
1430 </variablelist>
1431 </refsect1>
1432
1433 <refsect1>
1434 <title>[WireGuardPeer] Section Options</title>
1435
1436 <para>The <literal>[WireGuardPeer]</literal> section accepts the following
1437 keys:</para>
1438
1439 <variablelist class='network-directives'>
1440 <varlistentry>
1441 <term><varname>PublicKey=</varname></term>
1442 <listitem>
1443 <para>Sets a Base64 encoded public key calculated by <command>wg pubkey</command>
1444 (see <citerefentry project="wireguard"><refentrytitle>wg</refentrytitle><manvolnum>8</manvolnum></citerefentry>)
1445 from a private key, and usually transmitted out of band to the
1446 author of the configuration file. This option is mandatory for this
1447 section.</para>
1448 </listitem>
1449 </varlistentry>
1450 <varlistentry>
1451 <term><varname>PresharedKey=</varname></term>
1452 <listitem>
1453 <para>Optional preshared key for the interface. It can be generated
1454 by the <command>wg genpsk</command> command. This option adds an
1455 additional layer of symmetric-key cryptography to be mixed into the
1456 already existing public-key cryptography, for post-quantum
a8d6dbed
JD
1457 resistance.
1458 Note that because this information is secret, you may want to set
1459 the permissions of the .netdev file to be owned by <literal>root:systemd-networkd</literal>
1460 with a <literal>0640</literal> file mode.</para>
e5719363
JT
1461 </listitem>
1462 </varlistentry>
a3945c63
YW
1463 <varlistentry>
1464 <term><varname>PresharedKeyFile=</varname></term>
1465 <listitem>
1466 <para>Takes an absolute path to a file which contains the Base64 encoded preshared key for the
1467 peer. When this option is specified, then <varname>PresharedKey=</varname> is ignored.
1468 Note that the file must be readable by the user <literal>systemd-network</literal>, so it
1469 should be, e.g., owned by <literal>root:systemd-network</literal> with a
1470 <literal>0640</literal> file mode.</para>
1471 </listitem>
1472 </varlistentry>
e5719363
JT
1473 <varlistentry>
1474 <term><varname>AllowedIPs=</varname></term>
1475 <listitem>
1476 <para>Sets a comma-separated list of IP (v4 or v6) addresses with CIDR masks
1477 from which this peer is allowed to send incoming traffic and to
1478 which outgoing traffic for this peer is directed. The catch-all
1479 0.0.0.0/0 may be specified for matching all IPv4 addresses, and
1480 ::/0 may be specified for matching all IPv6 addresses. </para>
1481 </listitem>
1482 </varlistentry>
1483 <varlistentry>
1484 <term><varname>Endpoint=</varname></term>
1485 <listitem>
1486 <para>Sets an endpoint IP address or hostname, followed by a colon, and then
1487 a port number. This endpoint will be updated automatically once to
1488 the most recent source IP address and port of correctly
1489 authenticated packets from the peer at configuration time.</para>
1490 </listitem>
1491 </varlistentry>
1492 <varlistentry>
1493 <term><varname>PersistentKeepalive=</varname></term>
1494 <listitem>
1495 <para>Sets a seconds interval, between 1 and 65535 inclusive, of how often
1496 to send an authenticated empty packet to the peer for the purpose
1497 of keeping a stateful firewall or NAT mapping valid persistently.
1498 For example, if the interface very rarely sends traffic, but it
1499 might at anytime receive traffic from a peer, and it is behind NAT,
1500 the interface might benefit from having a persistent keepalive
1501 interval of 25 seconds. If set to 0 or "off", this option is
1502 disabled. By default or when unspecified, this option is off.
1503 Most users will not need this.</para>
1504 </listitem>
1505 </varlistentry>
1506 </variablelist>
1507 </refsect1>
1508
798d3a52
ZJS
1509 <refsect1>
1510 <title>[Bond] Section Options</title>
1511
1512 <para>The <literal>[Bond]</literal> section accepts the following
1513 key:</para>
1514
1515 <variablelist class='network-directives'>
1516 <varlistentry>
1517 <term><varname>Mode=</varname></term>
1518 <listitem>
1519 <para>Specifies one of the bonding policies. The default is
1520 <literal>balance-rr</literal> (round robin). Possible values are
1521 <literal>balance-rr</literal>,
1522 <literal>active-backup</literal>,
1523 <literal>balance-xor</literal>,
1524 <literal>broadcast</literal>,
1525 <literal>802.3ad</literal>,
1526 <literal>balance-tlb</literal>, and
1527 <literal>balance-alb</literal>.
1528 </para>
1529 </listitem>
1530 </varlistentry>
1531
1532 <varlistentry>
1533 <term><varname>TransmitHashPolicy=</varname></term>
1534 <listitem>
1535 <para>Selects the transmit hash policy to use for slave
1536 selection in balance-xor, 802.3ad, and tlb modes. Possible
1537 values are
1538 <literal>layer2</literal>,
1539 <literal>layer3+4</literal>,
1540 <literal>layer2+3</literal>,
4d89618a 1541 <literal>encap2+3</literal>, and
798d3a52
ZJS
1542 <literal>encap3+4</literal>.
1543 </para>
1544 </listitem>
1545 </varlistentry>
1546
1547 <varlistentry>
1548 <term><varname>LACPTransmitRate=</varname></term>
1549 <listitem>
1550 <para>Specifies the rate with which link partner transmits
1551 Link Aggregation Control Protocol Data Unit packets in
1552 802.3ad mode. Possible values are <literal>slow</literal>,
1553 which requests partner to transmit LACPDUs every 30 seconds,
1554 and <literal>fast</literal>, which requests partner to
1555 transmit LACPDUs every second. The default value is
1556 <literal>slow</literal>.</para>
1557 </listitem>
1558 </varlistentry>
1559
1560 <varlistentry>
1561 <term><varname>MIIMonitorSec=</varname></term>
1562 <listitem>
1563 <para>Specifies the frequency that Media Independent
1564 Interface link monitoring will occur. A value of zero
dd2b607b 1565 disables MII link monitoring. This value is rounded down to
798d3a52
ZJS
1566 the nearest millisecond. The default value is 0.</para>
1567 </listitem>
1568 </varlistentry>
1569
1570 <varlistentry>
1571 <term><varname>UpDelaySec=</varname></term>
1572 <listitem>
1573 <para>Specifies the delay before a link is enabled after a
1574 link up status has been detected. This value is rounded down
1575 to a multiple of MIIMonitorSec. The default value is
1576 0.</para>
1577 </listitem>
1578 </varlistentry>
1579
1580 <varlistentry>
1581 <term><varname>DownDelaySec=</varname></term>
1582 <listitem>
1583 <para>Specifies the delay before a link is disabled after a
1584 link down status has been detected. This value is rounded
1585 down to a multiple of MIIMonitorSec. The default value is
1586 0.</para>
1587 </listitem>
1588 </varlistentry>
1589
81bd37a8 1590 <varlistentry>
38422da7 1591 <term><varname>LearnPacketIntervalSec=</varname></term>
81bd37a8
SS
1592 <listitem>
1593 <para>Specifies the number of seconds between instances where the bonding
a8eaaee7
JE
1594 driver sends learning packets to each slave peer switch.
1595 The valid range is 1–0x7fffffff; the default value is 1. This option
1596 has an effect only for the balance-tlb and balance-alb modes.</para>
81bd37a8
SS
1597 </listitem>
1598 </varlistentry>
1599
1600 <varlistentry>
1601 <term><varname>AdSelect=</varname></term>
1602 <listitem>
1603 <para>Specifies the 802.3ad aggregation selection logic to use. Possible values are
1604 <literal>stable</literal>,
a8eaaee7
JE
1605 <literal>bandwidth</literal> and
1606 <literal>count</literal>.
81bd37a8
SS
1607 </para>
1608 </listitem>
1609 </varlistentry>
1610
99f68ef0 1611 <varlistentry>
db688b7e 1612 <term><varname>AdActorSystemPriority=</varname></term>
99f68ef0 1613 <listitem>
db688b7e 1614 <para>Specifies the 802.3ad actor system priority. Ranges [1-65535].</para>
99f68ef0
TJ
1615 </listitem>
1616 </varlistentry>
1617
1618 <varlistentry>
1619 <term><varname>AdUserPortKey=</varname></term>
1620 <listitem>
1621 <para>Specifies the 802.3ad user defined portion of the port key. Ranges [0-1023].</para>
1622 </listitem>
1623 </varlistentry>
1624
1625 <varlistentry>
1626 <term><varname>AdActorSystem=</varname></term>
1627 <listitem>
1628 <para>Specifies the 802.3ad system mac address. This can not be either NULL or Multicast.</para>
1629 </listitem>
1630 </varlistentry>
1631
81bd37a8 1632 <varlistentry>
38422da7 1633 <term><varname>FailOverMACPolicy=</varname></term>
81bd37a8 1634 <listitem>
a8eaaee7
JE
1635 <para>Specifies whether the active-backup mode should set all slaves to
1636 the same MAC address at the time of enslavement or, when enabled, to perform special handling of the
81bd37a8
SS
1637 bond's MAC address in accordance with the selected policy. The default policy is none.
1638 Possible values are
1639 <literal>none</literal>,
a8eaaee7
JE
1640 <literal>active</literal> and
1641 <literal>follow</literal>.
81bd37a8
SS
1642 </para>
1643 </listitem>
1644 </varlistentry>
1645
1646 <varlistentry>
38422da7 1647 <term><varname>ARPValidate=</varname></term>
81bd37a8
SS
1648 <listitem>
1649 <para>Specifies whether or not ARP probes and replies should be
38422da7 1650 validated in any mode that supports ARP monitoring, or whether
81bd37a8
SS
1651 non-ARP traffic should be filtered (disregarded) for link
1652 monitoring purposes. Possible values are
1653 <literal>none</literal>,
1654 <literal>active</literal>,
a8eaaee7
JE
1655 <literal>backup</literal> and
1656 <literal>all</literal>.
81bd37a8
SS
1657 </para>
1658 </listitem>
1659 </varlistentry>
1660
1661 <varlistentry>
38422da7 1662 <term><varname>ARPIntervalSec=</varname></term>
81bd37a8
SS
1663 <listitem>
1664 <para>Specifies the ARP link monitoring frequency in milliseconds.
1665 A value of 0 disables ARP monitoring. The default value is 0.
1666 </para>
1667 </listitem>
1668 </varlistentry>
1669
1670 <varlistentry>
38422da7 1671 <term><varname>ARPIPTargets=</varname></term>
81bd37a8
SS
1672 <listitem>
1673 <para>Specifies the IP addresses to use as ARP monitoring peers when
38422da7 1674 ARPIntervalSec is greater than 0. These are the targets of the ARP request
81bd37a8 1675 sent to determine the health of the link to the targets.
a8eaaee7 1676 Specify these values in IPv4 dotted decimal format. At least one IP
81bd37a8
SS
1677 address must be given for ARP monitoring to function. The
1678 maximum number of targets that can be specified is 16. The
1679 default value is no IP addresses.
1680 </para>
1681 </listitem>
1682 </varlistentry>
1683
1684 <varlistentry>
38422da7 1685 <term><varname>ARPAllTargets=</varname></term>
81bd37a8 1686 <listitem>
38422da7 1687 <para>Specifies the quantity of ARPIPTargets that must be reachable
81bd37a8
SS
1688 in order for the ARP monitor to consider a slave as being up.
1689 This option affects only active-backup mode for slaves with
38422da7 1690 ARPValidate enabled. Possible values are
a8eaaee7
JE
1691 <literal>any</literal> and
1692 <literal>all</literal>.
81bd37a8
SS
1693 </para>
1694 </listitem>
1695 </varlistentry>
1696
1697 <varlistentry>
38422da7 1698 <term><varname>PrimaryReselectPolicy=</varname></term>
81bd37a8
SS
1699 <listitem>
1700 <para>Specifies the reselection policy for the primary slave. This
1701 affects how the primary slave is chosen to become the active slave
1702 when failure of the active slave or recovery of the primary slave
1703 occurs. This option is designed to prevent flip-flopping between
1704 the primary slave and other slaves. Possible values are
1705 <literal>always</literal>,
a8eaaee7
JE
1706 <literal>better</literal> and
1707 <literal>failure</literal>.
81bd37a8
SS
1708 </para>
1709 </listitem>
1710 </varlistentry>
1711
1712 <varlistentry>
1713 <term><varname>ResendIGMP=</varname></term>
1714 <listitem>
1715 <para>Specifies the number of IGMP membership reports to be issued after
1716 a failover event. One membership report is issued immediately after
1717 the failover, subsequent packets are sent in each 200ms interval.
b938cb90 1718 The valid range is 0–255. Defaults to 1. A value of 0
81bd37a8
SS
1719 prevents the IGMP membership report from being issued in response
1720 to the failover event.
1721 </para>
1722 </listitem>
1723 </varlistentry>
1724
1725 <varlistentry>
1726 <term><varname>PacketsPerSlave=</varname></term>
1727 <listitem>
b938cb90
JE
1728 <para>Specify the number of packets to transmit through a slave before
1729 moving to the next one. When set to 0, then a slave is chosen at
1730 random. The valid range is 0–65535. Defaults to 1. This option
a8eaaee7 1731 only has effect when in balance-rr mode.
81bd37a8
SS
1732 </para>
1733 </listitem>
1734 </varlistentry>
1735
1736 <varlistentry>
38422da7 1737 <term><varname>GratuitousARP=</varname></term>
81bd37a8
SS
1738 <listitem>
1739 <para>Specify the number of peer notifications (gratuitous ARPs and
1740 unsolicited IPv6 Neighbor Advertisements) to be issued after a
b938cb90 1741 failover event. As soon as the link is up on the new slave,
81bd37a8
SS
1742 a peer notification is sent on the bonding device and each
1743 VLAN sub-device. This is repeated at each link monitor interval
38422da7 1744 (ARPIntervalSec or MIIMonitorSec, whichever is active) if the number is
a8eaaee7 1745 greater than 1. The valid range is 0–255. The default value is 1.
38422da7 1746 These options affect only the active-backup mode.
81bd37a8
SS
1747 </para>
1748 </listitem>
1749 </varlistentry>
1750
1751 <varlistentry>
1752 <term><varname>AllSlavesActive=</varname></term>
1753 <listitem>
9b6ffef3 1754 <para>Takes a boolean. Specifies that duplicate frames (received on inactive ports)
a8eaaee7 1755 should be dropped when false, or delivered when true. Normally, bonding will drop
81bd37a8
SS
1756 duplicate frames (received on inactive ports), which is desirable for
1757 most users. But there are some times it is nice to allow duplicate
1758 frames to be delivered. The default value is false (drop duplicate frames
1759 received on inactive ports).
1760 </para>
1761 </listitem>
1762 </varlistentry>
1763
fde60a42
SS
1764 <varlistentry>
1765 <term><varname>DynamicTransmitLoadBalancing=</varname></term>
1766 <listitem>
1767 <para>Takes a boolean. Specifies if dynamic shuffling of flows is enabled. Applies only
1768 for balance-tlb mode. Defaults to unset.
1769 </para>
1770 </listitem>
1771 </varlistentry>
1772
81bd37a8
SS
1773 <varlistentry>
1774 <term><varname>MinLinks=</varname></term>
1775 <listitem>
1776 <para>Specifies the minimum number of links that must be active before
1777 asserting carrier. The default value is 0.
1778 </para>
1779 </listitem>
1780 </varlistentry>
798d3a52 1781 </variablelist>
81bd37a8
SS
1782
1783 <para>For more detail information see
1784 <ulink url="https://www.kernel.org/doc/Documentation/networking/bonding.txt">
1785 Linux Ethernet Bonding Driver HOWTO</ulink></para>
1786
798d3a52
ZJS
1787 </refsect1>
1788
1789 <refsect1>
48847676 1790 <title>Examples</title>
798d3a52 1791 <example>
6c1695be 1792 <title>/etc/systemd/network/25-bridge.netdev</title>
798d3a52
ZJS
1793
1794 <programlisting>[NetDev]
eac684ef
TG
1795Name=bridge0
1796Kind=bridge</programlisting>
798d3a52 1797 </example>
eac684ef 1798
798d3a52 1799 <example>
6c1695be 1800 <title>/etc/systemd/network/25-vlan1.netdev</title>
eac684ef 1801
798d3a52 1802 <programlisting>[Match]
eac684ef
TG
1803Virtualization=no
1804
1805[NetDev]
1806Name=vlan1
1807Kind=vlan
1808
1809[VLAN]
1810Id=1</programlisting>
798d3a52
ZJS
1811 </example>
1812 <example>
6c1695be 1813 <title>/etc/systemd/network/25-ipip.netdev</title>
798d3a52 1814 <programlisting>[NetDev]
b35a2909
TG
1815Name=ipip-tun
1816Kind=ipip
1817MTUBytes=1480
1818
1819[Tunnel]
1820Local=192.168.223.238
1821Remote=192.169.224.239
1822TTL=64</programlisting>
798d3a52 1823 </example>
53cb501a
SS
1824 <example>
1825 <title>/etc/systemd/network/1-fou-tunnel.netdev</title>
1826 <programlisting>[NetDev]
1827Name=fou-tun
1828Kind=fou
1829
1830[FooOverUDP]
1831Port=5555
1832Protocol=4
1833 </programlisting>
1834 </example>
1835 <example>
1836 <title>/etc/systemd/network/25-fou-ipip.netdev</title>
1837 <programlisting>[NetDev]
53cb501a
SS
1838Name=ipip-tun
1839Kind=ipip
1840
1841[Tunnel]
964c4eda 1842Independent=yes
53cb501a
SS
1843Local=10.65.208.212
1844Remote=10.65.208.211
964c4eda 1845FooOverUDP=yes
53cb501a
SS
1846FOUDestinationPort=5555
1847 </programlisting>
1848 </example>
798d3a52 1849 <example>
6c1695be 1850 <title>/etc/systemd/network/25-tap.netdev</title>
798d3a52 1851 <programlisting>[NetDev]
30ae9dfd
SS
1852Name=tap-test
1853Kind=tap
1854
1855[Tap]
964c4eda
LP
1856MultiQueue=yes
1857PacketInfo=yes</programlisting> </example>
eac684ef 1858
798d3a52 1859 <example>
6c1695be 1860 <title>/etc/systemd/network/25-sit.netdev</title>
798d3a52 1861 <programlisting>[NetDev]
b35a2909
TG
1862Name=sit-tun
1863Kind=sit
1864MTUBytes=1480
1865
1866[Tunnel]
1867Local=10.65.223.238
1868Remote=10.65.223.239</programlisting>
798d3a52 1869 </example>
eac684ef 1870
d067cab3
DA
1871 <example>
1872 <title>/etc/systemd/network/25-6rd.netdev</title>
1873 <programlisting>[NetDev]
1874Name=6rd-tun
1875Kind=sit
1876MTUBytes=1480
1877
1878[Tunnel]
1879Local=10.65.223.238
1880IPv6RapidDeploymentPrefix=2602::/24</programlisting>
1881 </example>
1882
798d3a52 1883 <example>
6c1695be 1884 <title>/etc/systemd/network/25-gre.netdev</title>
798d3a52 1885 <programlisting>[NetDev]
b35a2909
TG
1886Name=gre-tun
1887Kind=gre
1888MTUBytes=1480
1889
1890[Tunnel]
1891Local=10.65.223.238
1892Remote=10.65.223.239</programlisting>
798d3a52 1893 </example>
b35a2909 1894
798d3a52 1895 <example>
6c1695be 1896 <title>/etc/systemd/network/25-vti.netdev</title>
b35a2909 1897
798d3a52 1898 <programlisting>[NetDev]
b35a2909
TG
1899Name=vti-tun
1900Kind=vti
1901MTUBytes=1480
1902
1903[Tunnel]
1904Local=10.65.223.238
1905Remote=10.65.223.239</programlisting>
798d3a52 1906 </example>
b35a2909 1907
798d3a52 1908 <example>
6c1695be 1909 <title>/etc/systemd/network/25-veth.netdev</title>
798d3a52 1910 <programlisting>[NetDev]
b35a2909
TG
1911Name=veth-test
1912Kind=veth
1913
1914[Peer]
1915Name=veth-peer</programlisting>
798d3a52 1916 </example>
b35a2909 1917
d94facdc 1918 <example>
6c1695be 1919 <title>/etc/systemd/network/25-bond.netdev</title>
d94facdc
MH
1920 <programlisting>[NetDev]
1921Name=bond1
1922Kind=bond
1923
1924[Bond]
1925Mode=802.3ad
1926TransmitHashPolicy=layer3+4
1927MIIMonitorSec=1s
1928LACPTransmitRate=fast
1929</programlisting>
1930 </example>
1931
798d3a52 1932 <example>
6c1695be 1933 <title>/etc/systemd/network/25-dummy.netdev</title>
798d3a52 1934 <programlisting>[NetDev]
9e358851
TG
1935Name=dummy-test
1936Kind=dummy
1937MACAddress=12:34:56:78:9a:bc</programlisting>
798d3a52 1938 </example>
20897a0d
AR
1939 <example>
1940 <title>/etc/systemd/network/25-vrf.netdev</title>
037a3ded 1941 <para>Create a VRF interface with table 42.</para>
20897a0d
AR
1942 <programlisting>[NetDev]
1943Name=vrf-test
1944Kind=vrf
798d3a52 1945
20897a0d 1946[VRF]
362f6336 1947Table=42</programlisting>
20897a0d 1948 </example>
42125eda
SS
1949
1950 <example>
1951 <title>/etc/systemd/network/25-macvtap.netdev</title>
1952 <para>Create a MacVTap device.</para>
1953 <programlisting>[NetDev]
1954Name=macvtap-test
1955Kind=macvtap
1956 </programlisting>
1957 </example>
e5719363
JT
1958 <example>
1959 <title>/etc/systemd/network/25-wireguard.netdev</title>
1960 <programlisting>[NetDev]
1961Name=wg0
1962Kind=wireguard
1963
1964[WireGuard]
1965PrivateKey=EEGlnEPYJV//kbvvIqxKkQwOiS+UENyPncC4bF46ong=
1966ListenPort=51820
1967
1968[WireGuardPeer]
1969PublicKey=RDf+LSpeEre7YEIKaxg+wbpsNV7du+ktR99uBEtIiCA=
1970AllowedIPs=fd31:bf08:57cb::/48,192.168.26.0/24
1971Endpoint=wireguard.example.com:51820</programlisting>
1972 </example>
798d3a52
ZJS
1973 </refsect1>
1974 <refsect1>
1975 <title>See Also</title>
1976 <para>
1977 <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
1978 <citerefentry><refentrytitle>systemd-networkd</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
1979 <citerefentry><refentrytitle>systemd.link</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
1980 <citerefentry><refentrytitle>systemd.network</refentrytitle><manvolnum>5</manvolnum></citerefentry>
1981 </para>
1982 </refsect1>
eac684ef
TG
1983
1984</refentry>