]> git.ipfire.org Git - thirdparty/systemd.git/blame - man/systemd.netdev.xml
sd-netlink: Add supprt for geneve properties
[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>
4cc0fd75
SS
658 <varlistentry>
659 <term><varname>GenericProtocolExtension=</varname></term>
660 <listitem>
661 <para>Takes a boolean. When true, Generic Protocol Extension extends the existing VXLAN protocol
662 to provide protocol typing, OAM, and versioning capabilities. For details about the VXLAN GPE
663 Header, see the <ulink url="https://tools.ietf.org/html/draft-ietf-nvo3-vxlan-gpe-07">
1c8b0ecc
SS
664 Generic Protocol Extension for VXLAN </ulink> document. If destination port is not specified and
665 Generic Protocol Extension is set then default port of 4790 is used. Defaults to false.</para>
4cc0fd75
SS
666 </listitem>
667 </varlistentry>
ea0288d1
SS
668 <varlistentry>
669 <term><varname>DestinationPort=</varname></term>
670 <listitem>
671 <para>Configures the default destination UDP port on a per-device basis.
672 If destination port is not specified then Linux kernel default will be used.
98616735
SS
673 Set destination port 4789 to get the IANA assigned value. If not set or if the
674 destination port is assigned the empty string the default port of 4789 is used.</para>
ea0288d1
SS
675 </listitem>
676 </varlistentry>
677 <varlistentry>
678 <term><varname>PortRange=</varname></term>
679 <listitem>
680 <para>Configures VXLAN port range. VXLAN bases source
681 UDP port based on flow to help the receiver to be able
682 to load balance based on outer header flow. It
683 restricts the port range to the normal UDP local
684 ports, and allows overriding via configuration.</para>
685 </listitem>
686 </varlistentry>
d8653945
SS
687 <varlistentry>
688 <term><varname>FlowLabel=</varname></term>
689 <listitem>
690 <para>Specifies the flow label to use in outgoing packets.
691 The valid range is 0-1048575.
692 </para>
693 </listitem>
1189c00a
SS
694 </varlistentry>
695 <varlistentry>
696 <term><varname>IPDoNotFragment=</varname></term>
697 <listitem>
698 <para>Allows to set the IPv4 Do not Fragment (DF) bit in outgoing packets, or to inherit its
699 value from the IPv4 inner header. Takes a boolean value, or <literal>inherit</literal>. Set
700 to <literal>inherit</literal> if the encapsulated protocol is IPv6. When unset, the kernel's
701 default will be used.</para>
702 </listitem>
d8653945 703 </varlistentry>
798d3a52
ZJS
704 </variablelist>
705 </refsect1>
6598e046
SS
706 <refsect1>
707 <title>[GENEVE] Section Options</title>
708 <para>The <literal>[GENEVE]</literal> section only applies for
709 netdevs of kind <literal>geneve</literal>, and accepts the
710 following keys:</para>
711
712 <variablelist class='network-directives'>
713 <varlistentry>
714 <term><varname>Id=</varname></term>
715 <listitem>
785889e5 716 <para>Specifies the Virtual Network Identifier (VNI) to use. Ranges [0-16777215].</para>
6598e046
SS
717 </listitem>
718 </varlistentry>
719 <varlistentry>
720 <term><varname>Remote=</varname></term>
721 <listitem>
722 <para>Specifies the unicast destination IP address to use in outgoing packets.</para>
723 </listitem>
724 </varlistentry>
725 <varlistentry>
726 <term><varname>TOS=</varname></term>
727 <listitem>
98616735 728 <para>Specifies the TOS value to use in outgoing packets. Ranges [1-255].</para>
6598e046
SS
729 </listitem>
730 </varlistentry>
731 <varlistentry>
732 <term><varname>TTL=</varname></term>
733 <listitem>
98616735 734 <para>Specifies the TTL value to use in outgoing packets. Ranges [1-255].</para>
6598e046
SS
735 </listitem>
736 </varlistentry>
737 <varlistentry>
738 <term><varname>UDPChecksum=</varname></term>
739 <listitem>
9b6ffef3 740 <para>Takes a boolean. When true, specifies if UDP checksum is calculated for transmitted packets over IPv4.</para>
6598e046
SS
741 </listitem>
742 </varlistentry>
743 <varlistentry>
744 <term><varname>UDP6ZeroChecksumTx=</varname></term>
745 <listitem>
9b6ffef3 746 <para>Takes a boolean. When true, skip UDP checksum calculation for transmitted packets over IPv6.</para>
6598e046
SS
747 </listitem>
748 </varlistentry>
749 <varlistentry>
750 <term><varname>UDP6ZeroChecksumRx=</varname></term>
751 <listitem>
9b6ffef3 752 <para>Takes a boolean. When true, allows incoming UDP packets over IPv6 with zero checksum field.</para>
6598e046
SS
753 </listitem>
754 </varlistentry>
755 <varlistentry>
756 <term><varname>DestinationPort=</varname></term>
757 <listitem>
98616735
SS
758 <para>Specifies destination port. Defaults to 6081. If not set or assigned the empty string, the default
759 port of 6081 is used.</para>
6598e046
SS
760 </listitem>
761 </varlistentry>
762 <varlistentry>
763 <term><varname>FlowLabel=</varname></term>
764 <listitem>
765 <para>Specifies the flow label to use in outgoing packets.</para>
766 </listitem>
767 </varlistentry>
768 </variablelist>
769 </refsect1>
3a56e697
SS
770 <refsect1>
771 <title>[L2TP] Section Options</title>
772 <para>The <literal>[L2TP]</literal> section only applies for
773 netdevs of kind <literal>l2tp</literal>, and accepts the
774 following keys:</para>
775
776 <variablelist class='network-directives'>
777 <varlistentry>
778 <term><varname>TunnelId=</varname></term>
779 <listitem>
780 <para>Specifies the tunnel id. The value used must match the <literal>PeerTunnelId=</literal> value being used at the peer.
781 Ranges a number between 1 and 4294967295). This option is compulsory.</para>
782 </listitem>
783 </varlistentry>
784 <varlistentry>
785 <term><varname>PeerTunnelId=</varname></term>
786 <listitem>
787 <para>Specifies the peer tunnel id. The value used must match the <literal>PeerTunnelId=</literal> value being used at the peer.
788 Ranges a number between 1 and 4294967295). This option is compulsory.</para>
789 </listitem>
790 </varlistentry>
791 <varlistentry>
792 <term><varname>Remote=</varname></term>
793 <listitem>
794 <para>Specifies the IP address of the remote peer. This option is compulsory.</para>
795 </listitem>
796 </varlistentry>
797 <varlistentry>
798 <term><varname>Local=</varname></term>
799 <listitem>
d053d08a
YW
800 <para>Specifies the IP address of the local interface. Takes an IP address, or the special values
801 <literal>auto</literal>, <literal>static</literal>, or <literal>dynamic</literal>. When an address
802 is set, then the local interface must have the address. If <literal>auto</literal>, then one of the
803 addresses on the local interface is used. Similarly, if <literal>static</literal> or
804 <literal>dynamic</literal> is set, then one of the static or dynamic addresses on the local
805 interface is used. Defaults to <literal>auto</literal>.</para>
3a56e697
SS
806 </listitem>
807 </varlistentry>
808 <varlistentry>
809 <term><varname>EncapsulationType=</varname></term>
810 <listitem>
811 <para>Specifies the encapsulation type of the tunnel. Takes one of <literal>udp</literal> or <literal>ip</literal>.</para>
812 </listitem>
813 </varlistentry>
814 <varlistentry>
815 <term><varname>UDPSourcePort=</varname></term>
816 <listitem>
817 <para>Specifies the UDP source port to be used for the tunnel. When UDP encapsulation is selected it's mandotory. Ignored when ip
818 encapsulation is selected.</para>
819 </listitem>
820 </varlistentry>
821 <varlistentry>
822 <term><varname>DestinationPort=</varname></term>
823 <listitem>
824 <para>Specifies destination port. When UDP encapsulation is selected it's mandotory. Ignored when ip
825 encapsulation is selected.</para>
826 </listitem>
827 </varlistentry>
828 <varlistentry>
829 <term><varname>UDPChecksum=</varname></term>
830 <listitem>
831 <para>Takes a boolean. When true, specifies if UDP checksum is calculated for transmitted packets over IPv4.</para>
832 </listitem>
833 </varlistentry>
834 <varlistentry>
835 <term><varname>UDP6ZeroChecksumTx=</varname></term>
836 <listitem>
837 <para>Takes a boolean. When true, skip UDP checksum calculation for transmitted packets over IPv6.</para>
838 </listitem>
839 </varlistentry>
840 <varlistentry>
841 <term><varname>UDP6ZeroChecksumRx=</varname></term>
842 <listitem>
843 <para>Takes a boolean. When true, allows incoming UDP packets over IPv6 with zero checksum field.</para>
844 </listitem>
845 </varlistentry>
846 </variablelist>
847 </refsect1>
848 <refsect1>
849 <title>[L2TPSession] Section Options</title>
850 <para>The <literal>[L2TPSession]</literal> section only applies for
851 netdevs of kind <literal>l2tp</literal>, and accepts the
852 following keys:</para>
853 <variablelist class='network-directives'>
854 <varlistentry>
855 <term><varname>Name=</varname></term>
856 <listitem>
5238e957 857 <para>Specifies the name of the session. This option is compulsory.</para>
3a56e697
SS
858 </listitem>
859 </varlistentry>
860 <varlistentry>
861 <term><varname>SessionId=</varname></term>
862 <listitem>
5238e957 863 <para>Specifies the session id. The value used must match the <literal>SessionId=</literal> value being used at the peer.
3a56e697
SS
864 Ranges a number between 1 and 4294967295). This option is compulsory.</para>
865 </listitem>
866 </varlistentry>
867 <varlistentry>
868 <term><varname>PeerSessionId=</varname></term>
869 <listitem>
870 <para>Specifies the peer session id. The value used must match the <literal>PeerSessionId=</literal> value being used at the peer.
871 Ranges a number between 1 and 4294967295). This option is compulsory.</para>
872 </listitem>
873 </varlistentry>
874 <varlistentry>
875 <term><varname>Layer2SpecificHeader=</varname></term>
876 <listitem>
877 <para>Specifies layer2specific header type of the session. One of <literal>none</literal> or <literal>default</literal>. Defaults to <literal>default</literal>.</para>
878 </listitem>
879 </varlistentry>
880 </variablelist>
881 </refsect1>
81962db7
SS
882 <refsect1>
883 <title>[MACsec] Section Options</title>
884 <para>The <literal>[MACsec]</literal> section only applies for network devices of kind
885 <literal>macsec</literal>, and accepts the following keys:</para>
886
887 <variablelist class='network-directives'>
888 <varlistentry>
889 <term><varname>Port=</varname></term>
890 <listitem>
891 <para>Specifies the port to be used for the MACsec transmit channel. The port is used to make
892 secure channel identifier (SCI). Takes a value between 1 and 65535. Defaults to unset.
893 </para>
894 </listitem>
895 </varlistentry>
896 <varlistentry>
897 <term><varname>Encrypt=</varname></term>
898 <listitem>
899 <para>Takes a boolean. When true, enable encryption. Defaults to unset.</para>
900 </listitem>
901 </varlistentry>
902 </variablelist>
903 </refsect1>
904 <refsect1>
905 <title>[MACsecReceiveChannel] Section Options</title>
906 <para>The <literal>[MACsecReceiveChannel]</literal> section only applies for network devices of
907 kind <literal>macsec</literal>, and accepts the following keys:</para>
908
909 <variablelist class='network-directives'>
910 <varlistentry>
911 <term><varname>Port=</varname></term>
912 <listitem>
913 <para>Specifies the port to be used for the MACsec receive channel. The port is used to make
914 secure channel identifier (SCI). Takes a value between 1 and 65535. This option is
915 compulsory, and is not set by default.</para>
916 </listitem>
917 </varlistentry>
918 <varlistentry>
919 <term><varname>MACAddress=</varname></term>
920 <listitem>
921 <para>Specifies the MAC address to be used for the MACsec receive channel. The MAC address
922 used to make secure channel identifier (SCI). This option is compulsory, and is not set by
923 default.</para>
924 </listitem>
925 </varlistentry>
926 </variablelist>
927 </refsect1>
928 <refsect1>
929 <title>[MACsecTransmitAssociation] Section Options</title>
930 <para>The <literal>[MACsecTransmitAssociation]</literal> section only applies for network devices
931 of kind <literal>macsec</literal>, and accepts the following keys:</para>
932
933 <variablelist class='network-directives'>
934 <varlistentry>
935 <term><varname>PacketNumber=</varname></term>
936 <listitem>
937 <para>Specifies the packet number to be used for replay protection and the construction of
938 the initialization vector (along with the secure channel identifier [SCI]). Takes a value
939 between 1-4,294,967,295. Defaults to unset.
940 </para>
941 </listitem>
942 </varlistentry>
943 <varlistentry>
944 <term><varname>KeyId=</varname></term>
945 <listitem>
946 <para>Specifies the identification for the key. Takes a number between 0-255. This option
947 is compulsory, and is not set by default.</para>
948 </listitem>
949 </varlistentry>
950 <varlistentry>
951 <term><varname>Key=</varname></term>
952 <listitem>
953 <para>Specifies the encryption key used in the transmission channel. The same key must be
954 configured on the peer’s matching receive channel. This option is compulsory, and is not set
955 by default. Takes a 128-bit key encoded in a hexadecimal string, for example
956 <literal>dffafc8d7b9a43d5b9a3dfbbf6a30c16</literal>.</para>
957 </listitem>
958 </varlistentry>
eb4705fb
YW
959 <varlistentry>
960 <term><varname>KeyFile=</varname></term>
961 <listitem>
962 <para>Takes a absolute path to a file which contains a 128-bit key encoded in a hexadecimal
963 string, which will be used in the transmission channel. When this option is specified,
964 <varname>Key=</varname> is ignored. Note that the file must be readable by the user
965 <literal>systemd-network</literal>, so it should be, e.g., owned by
966 <literal>root:systemd-network</literal> with a <literal>0640</literal> file mode.</para>
967 </listitem>
968 </varlistentry>
a7b9c52f
YW
969 <varlistentry>
970 <term><varname>Activate=</varname></term>
971 <listitem>
972 <para>Takes a boolean. If enabled, then the security association is activated. Defaults to
973 unset.</para>
974 </listitem>
975 </varlistentry>
b0e13c31
YW
976 <varlistentry>
977 <term><varname>UseForEncoding=</varname></term>
978 <listitem>
979 <para>Takes a boolean. If enabled, then the security association is used for encoding. Only
980 one <literal>[MACsecTransmitAssociation]</literal> section can enable this option. When enabled,
981 <varname>Activate=yes</varname> is implied. Defaults to unset.</para>
982 </listitem>
983 </varlistentry>
81962db7
SS
984 </variablelist>
985 </refsect1>
986 <refsect1>
987 <title>[MACsecReceiveAssociation] Section Options</title>
988 <para>The <literal>[MACsecReceiveAssociation]</literal> section only applies for
989 network devices of kind <literal>macsec</literal>, and accepts the
990 following keys:</para>
991
992 <variablelist class='network-directives'>
993 <varlistentry>
994 <term><varname>Port=</varname></term>
995 <listitem>
996 <para>Accepts the same key in <literal>[MACsecReceiveChannel]</literal> section.</para>
997 </listitem>
998 </varlistentry>
999 <varlistentry>
1000 <term><varname>MACAddress=</varname></term>
1001 <listitem>
1002 <para>Accepts the same key in <literal>[MACsecReceiveChannel]</literal> section.</para>
1003 </listitem>
1004 </varlistentry>
1005 <varlistentry>
1006 <term><varname>PacketNumber=</varname></term>
1007 <listitem>
1008 <para>Accepts the same key in <literal>[MACsecTransmitAssociation]</literal> section.</para>
1009 </listitem>
1010 </varlistentry>
1011 <varlistentry>
1012 <term><varname>KeyId=</varname></term>
1013 <listitem>
1014 <para>Accepts the same key in <literal>[MACsecTransmitAssociation]</literal> section.</para>
1015 </listitem>
1016 </varlistentry>
1017 <varlistentry>
1018 <term><varname>Key=</varname></term>
1019 <listitem>
1020 <para>Accepts the same key in <literal>[MACsecTransmitAssociation]</literal> section.</para>
1021 </listitem>
1022 </varlistentry>
eb4705fb
YW
1023 <varlistentry>
1024 <term><varname>KeyFile=</varname></term>
1025 <listitem>
1026 <para>Accepts the same key in <literal>[MACsecTransmitAssociation]</literal> section.</para>
1027 </listitem>
1028 </varlistentry>
a7b9c52f
YW
1029 <varlistentry>
1030 <term><varname>Activate=</varname></term>
1031 <listitem>
1032 <para>Accepts the same key in <literal>[MACsecTransmitAssociation]</literal> section.</para>
1033 </listitem>
1034 </varlistentry>
81962db7
SS
1035 </variablelist>
1036 </refsect1>
798d3a52
ZJS
1037 <refsect1>
1038 <title>[Tunnel] Section Options</title>
1039
1040 <para>The <literal>[Tunnel]</literal> section only applies for
1041 netdevs of kind
1042 <literal>ipip</literal>,
1043 <literal>sit</literal>,
1044 <literal>gre</literal>,
1045 <literal>gretap</literal>,
1046 <literal>ip6gre</literal>,
1047 <literal>ip6gretap</literal>,
5cc0748e 1048 <literal>vti</literal>,
af555aa3
YW
1049 <literal>vti6</literal>,
1050 <literal>ip6tnl</literal>, and
1051 <literal>erspan</literal> and accepts
798d3a52
ZJS
1052 the following keys:</para>
1053
1054 <variablelist class='network-directives'>
1055 <varlistentry>
1056 <term><varname>Local=</varname></term>
1057 <listitem>
8643885f
YW
1058 <para>A static local address for tunneled packets. It must be an address on another interface of
1059 this host, or the special value <literal>any</literal>.</para>
798d3a52
ZJS
1060 </listitem>
1061 </varlistentry>
1062 <varlistentry>
1063 <term><varname>Remote=</varname></term>
1064 <listitem>
8643885f
YW
1065 <para>The remote endpoint of the tunnel. Takes an IP address or the special value
1066 <literal>any</literal>.</para>
798d3a52
ZJS
1067 </listitem>
1068 </varlistentry>
1069 <varlistentry>
1070 <term><varname>TOS=</varname></term>
1071 <listitem>
1072 <para>The Type Of Service byte value for a tunnel interface.
b938cb90 1073 For details about the TOS, see the
798d3a52
ZJS
1074 <ulink url="http://tools.ietf.org/html/rfc1349"> Type of
1075 Service in the Internet Protocol Suite </ulink> document.
1076 </para>
1077 </listitem>
1078 </varlistentry>
1079 <varlistentry>
1080 <term><varname>TTL=</varname></term>
1081 <listitem>
1082 <para>A fixed Time To Live N on tunneled packets. N is a
b938cb90 1083 number in the range 1–255. 0 is a special value meaning that
798d3a52 1084 packets inherit the TTL value. The default value for IPv4
b938cb90 1085 tunnels is: inherit. The default value for IPv6 tunnels is
798d3a52
ZJS
1086 64.</para>
1087 </listitem>
1088 </varlistentry>
1089 <varlistentry>
1090 <term><varname>DiscoverPathMTU=</varname></term>
1091 <listitem>
9b6ffef3 1092 <para>Takes a boolean. When true, enables Path MTU Discovery on
798d3a52
ZJS
1093 the tunnel.</para>
1094 </listitem>
1095 </varlistentry>
276de526
SS
1096 <varlistentry>
1097 <term><varname>IPv6FlowLabel=</varname></term>
1098 <listitem>
a8eaaee7 1099 <para>Configures the 20-bit flow label (see <ulink url="https://tools.ietf.org/html/rfc6437">
276de526 1100 RFC 6437</ulink>) field in the IPv6 header (see <ulink url="https://tools.ietf.org/html/rfc2460">
a8eaaee7
JE
1101 RFC 2460</ulink>), which is used by a node to label packets of a flow.
1102 It is only used for IPv6 tunnels.
1103 A flow label of zero is used to indicate packets that have
1104 not been labeled.
1105 It can be configured to a value in the range 0–0xFFFFF, or be
1106 set to <literal>inherit</literal>, in which case the original flowlabel is used.</para>
276de526
SS
1107 </listitem>
1108 </varlistentry>
9b0ca30a 1109 <varlistentry>
a9b70f9d 1110 <term><varname>CopyDSCP=</varname></term>
9b0ca30a 1111 <listitem>
9b6ffef3 1112 <para>Takes a boolean. When true, the Differentiated Service Code
3cf4bcab 1113 Point (DSCP) field will be copied to the inner header from
a9b70f9d 1114 outer header during the decapsulation of an IPv6 tunnel
3cf4bcab
ZJS
1115 packet. DSCP is a field in an IP packet that enables different
1116 levels of service to be assigned to network traffic.
1117 Defaults to <literal>no</literal>.
9b0ca30a
SS
1118 </para>
1119 </listitem>
1120 </varlistentry>
dae398a8
SS
1121 <varlistentry>
1122 <term><varname>EncapsulationLimit=</varname></term>
1123 <listitem>
1124 <para>The Tunnel Encapsulation Limit option specifies how many additional
1125 levels of encapsulation are permitted to be prepended to the packet.
1126 For example, a Tunnel Encapsulation Limit option containing a limit
1127 value of zero means that a packet carrying that option may not enter
1128 another tunnel before exiting the current tunnel.
1129 (see <ulink url="https://tools.ietf.org/html/rfc2473#section-4.1.1"> RFC 2473</ulink>).
b938cb90 1130 The valid range is 0–255 and <literal>none</literal>. Defaults to 4.
dae398a8
SS
1131 </para>
1132 </listitem>
1133 </varlistentry>
1d710029
SS
1134 <varlistentry>
1135 <term><varname>Key=</varname></term>
1136 <listitem>
1137 <para>The <varname>Key=</varname> parameter specifies the same key to use in
1138 both directions (<varname>InputKey=</varname> and <varname>OutputKey=</varname>).
1139 The <varname>Key=</varname> is either a number or an IPv4 address-like dotted quad.
1140 It is used as mark-configured SAD/SPD entry as part of the lookup key (both in data
1141 and control path) in ip xfrm (framework used to implement IPsec protocol).
1142 See <ulink url="http://man7.org/linux/man-pages/man8/ip-xfrm.8.html">
c65c01c4
YW
1143 ip-xfrm — transform configuration</ulink> for details. It is only used for VTI/VTI6,
1144 GRE, GRETAP, and ERSPAN tunnels.</para>
1d710029
SS
1145 </listitem>
1146 </varlistentry>
1147 <varlistentry>
1148 <term><varname>InputKey=</varname></term>
1149 <listitem>
1150 <para>The <varname>InputKey=</varname> parameter specifies the key to use for input.
c65c01c4
YW
1151 The format is same as <varname>Key=</varname>. It is only used for VTI/VTI6, GRE, GRETAP,
1152 and ERSPAN tunnels.</para>
1d710029
SS
1153 </listitem>
1154 </varlistentry>
1155 <varlistentry>
1156 <term><varname>OutputKey=</varname></term>
1157 <listitem>
1158 <para>The <varname>OutputKey=</varname> parameter specifies the key to use for output.
c65c01c4
YW
1159 The format is same as <varname>Key=</varname>. It is only used for VTI/VTI6, GRE, GRETAP,
1160 and ERSPAN tunnels.</para>
1d710029
SS
1161 </listitem>
1162 </varlistentry>
798d3a52
ZJS
1163 <varlistentry>
1164 <term><varname>Mode=</varname></term>
1165 <listitem>
a8eaaee7 1166 <para>An <literal>ip6tnl</literal> tunnel can be in one of three
798d3a52
ZJS
1167 modes
1168 <literal>ip6ip6</literal> for IPv6 over IPv6,
1169 <literal>ipip6</literal> for IPv4 over IPv6 or
1170 <literal>any</literal> for either.
1171 </para>
1172 </listitem>
1173 </varlistentry>
4d7fa6de
SS
1174 <varlistentry>
1175 <term><varname>Independent=</varname></term>
1176 <listitem>
9b6ffef3 1177 <para>Takes a boolean. When true tunnel does not require .network file. Created as "tunnel@NONE".
4d7fa6de
SS
1178 Defaults to <literal>false</literal>.
1179 </para>
1180 </listitem>
1181 </varlistentry>
3a4f3e42
SS
1182 <varlistentry>
1183 <term><varname>AllowLocalRemote=</varname></term>
1184 <listitem>
9b6ffef3 1185 <para>Takes a boolean. When true allows tunnel traffic on <varname>ip6tnl</varname> devices where the remote endpoint is a local host address.
025314d9 1186 When unset, the kernel's default will be used.
3a4f3e42
SS
1187 </para>
1188 </listitem>
1189 </varlistentry>
53cb501a
SS
1190 <varlistentry>
1191 <term><varname>FooOverUDP=</varname></term>
1192 <listitem>
9b6ffef3 1193 <para>Takes a boolean. Specifies whether <varname>FooOverUDP=</varname> tunnel is to be configured.
0b145817
YW
1194 Defaults to false. This takes effects only for IPIP, SIT, GRE, and GRETAP tunnels.
1195 For more detail information see
53cb501a
SS
1196 <ulink url="https://lwn.net/Articles/614348">Foo over UDP</ulink></para>
1197 </listitem>
1198 </varlistentry>
1199 <varlistentry>
1200 <term><varname>FOUDestinationPort=</varname></term>
1201 <listitem>
6f520e74 1202 <para>This setting specifies the UDP destination port for encapsulation.
0b145817 1203 This field is mandatory when <varname>FooOverUDP=yes</varname>, and is not set by default.</para>
53cb501a
SS
1204 </listitem>
1205 </varlistentry>
1206 <varlistentry>
1207 <term><varname>FOUSourcePort=</varname></term>
1208 <listitem>
6f520e74
ZJS
1209 <para>This setting specifies the UDP source port for encapsulation. Defaults to <constant>0</constant>
1210 — that is, the source port for packets is left to the network stack to decide.</para>
53cb501a
SS
1211 </listitem>
1212 </varlistentry>
1213 <varlistentry>
1214 <term><varname>Encapsulation=</varname></term>
1215 <listitem>
0b145817 1216 <para>Accepts the same key as in the <literal>[FooOverUDP]</literal> section.</para>
53cb501a
SS
1217 </listitem>
1218 </varlistentry>
d067cab3
DA
1219 <varlistentry>
1220 <term><varname>IPv6RapidDeploymentPrefix=</varname></term>
1221 <listitem>
1222 <para>Reconfigure the tunnel for <ulink url="https://tools.ietf.org/html/rfc5569">IPv6 Rapid
1223 Deployment</ulink>, also known as 6rd. The value is an ISP-specific IPv6 prefix with a non-zero length. Only
1224 applicable to SIT tunnels.</para>
1225 </listitem>
1226 </varlistentry>
918049ad
SS
1227 <varlistentry>
1228 <term><varname>ISATAP=</varname></term>
1229 <listitem>
1230 <para>Takes a boolean. If set, configures the tunnel as Intra-Site Automatic Tunnel Addressing Protocol (ISATAP) tunnel.
1231 Only applicable to SIT tunnels. When unset, the kernel's default will be used.</para>
1232 </listitem>
1233 </varlistentry>
2266864b
SS
1234 <varlistentry>
1235 <term><varname>SerializeTunneledPackets=</varname></term>
1236 <listitem>
c65c01c4
YW
1237 <para>Takes a boolean. If set to yes, then packets are serialized. Only applies for GRE,
1238 GRETAP, and ERSPAN tunnels. When unset, the kernel's default will be used.
2266864b
SS
1239 </para>
1240 </listitem>
1241 </varlistentry>
1242 <varlistentry>
1243 <term><varname>ERSPANIndex=</varname></term>
1244 <listitem>
1245 <para>Specifies the ERSPAN index field for the interface, an integer in the range 1-1048575 associated with
1246 the ERSPAN traffic's source port and direction. This field is mandatory.
1247 </para>
1248 </listitem>
1249 </varlistentry>
798d3a52
ZJS
1250 </variablelist>
1251 </refsect1>
53cb501a
SS
1252
1253 <refsect1>
1254 <title>[FooOverUDP] Section Options</title>
1255
1256 <para>The <literal>[FooOverUDP]</literal> section only applies for
1257 netdevs of kind <literal>fou</literal> and accepts the
1258 following keys:</para>
1259
1260 <variablelist class='network-directives'>
53cb501a
SS
1261 <varlistentry>
1262 <term><varname>Encapsulation=</varname></term>
1263 <listitem>
1264 <para>Specifies the encapsulation mechanism used to store networking packets of various protocols inside the UDP packets. Supports the following values:
1265
1266 <literal>FooOverUDP</literal> provides the simplest no frills model of UDP encapsulation, it simply encapsulates
1267 packets directly in the UDP payload.
1268 <literal>GenericUDPEncapsulation</literal> is a generic and extensible encapsulation, it allows encapsulation of packets for any IP
1269 protocol and optional data as part of the encapsulation.
1270 For more detailed information see <ulink url="https://lwn.net/Articles/615044">Generic UDP Encapsulation</ulink>.
1271 Defaults to <literal>FooOverUDP</literal>.
1272 </para>
1273 </listitem>
1274 </varlistentry>
1275 <varlistentry>
1276 <term><varname>Port=</varname></term>
1277 <listitem>
1278 <para>Specifies the port number, where the IP encapsulation packets will arrive. Please take note that the packets
1279 will arrive with the encapsulation will be removed. Then they will be manually fed back into the network stack, and sent ahead
1280 for delivery to the real destination. This option is mandatory.</para>
1281 </listitem>
1282 </varlistentry>
0b145817
YW
1283 <varlistentry>
1284 <term><varname>Protocol=</varname></term>
1285 <listitem>
1286 <para>The <varname>Protocol=</varname> specifies the protocol number of the packets arriving
1287 at the UDP port. When <varname>Encapsulation=FooOverUDP</varname>, this field is mandatory
1288 and is not set by default. Takes an IP protocol name such as <literal>gre</literal> or
1289 <literal>ipip</literal>, or an integer within the range 1-255. When
1290 <varname>Encapsulation=GenericUDPEncapsulation</varname>, this must not be specified.</para>
1291 </listitem>
1292 </varlistentry>
1293 </variablelist>
53cb501a 1294 </refsect1>
798d3a52
ZJS
1295 <refsect1>
1296 <title>[Peer] Section Options</title>
1297
1298 <para>The <literal>[Peer]</literal> section only applies for
1299 netdevs of kind <literal>veth</literal> and accepts the
a8eaaee7 1300 following keys:</para>
798d3a52
ZJS
1301
1302 <variablelist class='network-directives'>
1303 <varlistentry>
1304 <term><varname>Name=</varname></term>
1305 <listitem>
1306 <para>The interface name used when creating the netdev.
1307 This option is compulsory.</para>
1308 </listitem>
1309 </varlistentry>
1310 <varlistentry>
1311 <term><varname>MACAddress=</varname></term>
1312 <listitem>
b938cb90 1313 <para>The peer MACAddress, if not set, it is generated in
798d3a52
ZJS
1314 the same way as the MAC address of the main
1315 interface.</para>
1316 </listitem>
1317 </varlistentry>
1318 </variablelist>
1319 </refsect1>
d6df583c
SS
1320 <refsect1>
1321 <title>[VXCAN] Section Options</title>
1322 <para>The <literal>[VXCAN]</literal> section only applies for
1323 netdevs of kind <literal>vxcan</literal> and accepts the
1324 following key:</para>
1325
1326 <variablelist class='network-directives'>
1327 <varlistentry>
1328 <term><varname>Peer=</varname></term>
1329 <listitem>
1330 <para>The peer interface name used when creating the netdev.
1331 This option is compulsory.</para>
1332 </listitem>
1333 </varlistentry>
1334 </variablelist>
1335 </refsect1>
798d3a52
ZJS
1336 <refsect1>
1337 <title>[Tun] Section Options</title>
1338
1339 <para>The <literal>[Tun]</literal> section only applies for
1340 netdevs of kind <literal>tun</literal>, and accepts the following
1341 keys:</para>
1342
1343 <variablelist class='network-directives'>
1344 <varlistentry>
1345 <term><varname>OneQueue=</varname></term>
9b6ffef3 1346 <listitem><para>Takes a boolean. Configures whether
798d3a52
ZJS
1347 all packets are queued at the device (enabled), or a fixed
1348 number of packets are queued at the device and the rest at the
1349 <literal>qdisc</literal>. Defaults to
1350 <literal>no</literal>.</para>
1351 </listitem>
1352 </varlistentry>
1353 <varlistentry>
1354 <term><varname>MultiQueue=</varname></term>
9b6ffef3 1355 <listitem><para>Takes a boolean. Configures whether
798d3a52
ZJS
1356 to use multiple file descriptors (queues) to parallelize
1357 packets sending and receiving. Defaults to
1358 <literal>no</literal>.</para>
1359 </listitem>
1360 </varlistentry>
1361 <varlistentry>
1362 <term><varname>PacketInfo=</varname></term>
9b6ffef3 1363 <listitem><para>Takes a boolean. Configures whether
ff9b60f3 1364 packets should be prepended with four extra bytes (two flag
b938cb90 1365 bytes and two protocol bytes). If disabled, it indicates that
798d3a52
ZJS
1366 the packets will be pure IP packets. Defaults to
1367 <literal>no</literal>.</para>
1368 </listitem>
1369 </varlistentry>
43f78da4 1370 <varlistentry>
2aba142e 1371 <term><varname>VNetHeader=</varname></term>
9b6ffef3 1372 <listitem><para>Takes a boolean. Configures
43f78da4
SS
1373 IFF_VNET_HDR flag for a tap device. It allows sending
1374 and receiving larger Generic Segmentation Offload (GSO)
1375 packets. This may increase throughput significantly.
1376 Defaults to
1377 <literal>no</literal>.</para>
1378 </listitem>
1379 </varlistentry>
798d3a52
ZJS
1380 <varlistentry>
1381 <term><varname>User=</varname></term>
1382 <listitem><para>User to grant access to the
1383 <filename>/dev/net/tun</filename> device.</para>
1384 </listitem>
1385 </varlistentry>
1386 <varlistentry>
1387 <term><varname>Group=</varname></term>
1388 <listitem><para>Group to grant access to the
1389 <filename>/dev/net/tun</filename> device.</para>
1390 </listitem>
1391 </varlistentry>
1392
1393 </variablelist>
1394
1395 </refsect1>
1396
1397 <refsect1>
1398 <title>[Tap] Section Options</title>
1399
1400 <para>The <literal>[Tap]</literal> section only applies for
1401 netdevs of kind <literal>tap</literal>, and accepts the same keys
1402 as the <literal>[Tun]</literal> section.</para>
1403 </refsect1>
1404
e5719363
JT
1405 <refsect1>
1406 <title>[WireGuard] Section Options</title>
1407
1408 <para>The <literal>[WireGuard]</literal> section accepts the following
1409 keys:</para>
1410
1411 <variablelist class='network-directives'>
1412 <varlistentry>
1413 <term><varname>PrivateKey=</varname></term>
1414 <listitem>
1415 <para>The Base64 encoded private key for the interface. It can be
1416 generated using the <command>wg genkey</command> command
1417 (see <citerefentry project="wireguard"><refentrytitle>wg</refentrytitle><manvolnum>8</manvolnum></citerefentry>).
76df7779 1418 This option or <varname>PrivateKeyFile=</varname> is mandatory to use WireGuard.
a8d6dbed 1419 Note that because this information is secret, you may want to set
bd277f53 1420 the permissions of the .netdev file to be owned by <literal>root:systemd-network</literal>
a8d6dbed 1421 with a <literal>0640</literal> file mode.</para>
e5719363
JT
1422 </listitem>
1423 </varlistentry>
76df7779
YW
1424 <varlistentry>
1425 <term><varname>PrivateKeyFile=</varname></term>
1426 <listitem>
a3945c63 1427 <para>Takes an absolute path to a file which contains the Base64 encoded private key for the interface.
cb31e7c8 1428 When this option is specified, then <varname>PrivateKey=</varname> is ignored.
76df7779
YW
1429 Note that the file must be readable by the user <literal>systemd-network</literal>, so it
1430 should be, e.g., owned by <literal>root:systemd-network</literal> with a
1431 <literal>0640</literal> file mode.</para>
1432 </listitem>
1433 </varlistentry>
e5719363
JT
1434 <varlistentry>
1435 <term><varname>ListenPort=</varname></term>
1436 <listitem>
1437 <para>Sets UDP port for listening. Takes either value between 1 and 65535
1438 or <literal>auto</literal>. If <literal>auto</literal> is specified,
1439 the port is automatically generated based on interface name.
1440 Defaults to <literal>auto</literal>.</para>
1441 </listitem>
1442 </varlistentry>
1443 <varlistentry>
1c30b174 1444 <term><varname>FirewallMark=</varname></term>
e5719363 1445 <listitem>
1c30b174 1446 <para>Sets a firewall mark on outgoing WireGuard packets from this interface. Takes a number between 1 and 4294967295.</para>
e5719363
JT
1447 </listitem>
1448 </varlistentry>
1449 </variablelist>
1450 </refsect1>
1451
1452 <refsect1>
1453 <title>[WireGuardPeer] Section Options</title>
1454
1455 <para>The <literal>[WireGuardPeer]</literal> section accepts the following
1456 keys:</para>
1457
1458 <variablelist class='network-directives'>
1459 <varlistentry>
1460 <term><varname>PublicKey=</varname></term>
1461 <listitem>
1462 <para>Sets a Base64 encoded public key calculated by <command>wg pubkey</command>
1463 (see <citerefentry project="wireguard"><refentrytitle>wg</refentrytitle><manvolnum>8</manvolnum></citerefentry>)
1464 from a private key, and usually transmitted out of band to the
1465 author of the configuration file. This option is mandatory for this
1466 section.</para>
1467 </listitem>
1468 </varlistentry>
1469 <varlistentry>
1470 <term><varname>PresharedKey=</varname></term>
1471 <listitem>
1472 <para>Optional preshared key for the interface. It can be generated
1473 by the <command>wg genpsk</command> command. This option adds an
1474 additional layer of symmetric-key cryptography to be mixed into the
1475 already existing public-key cryptography, for post-quantum
a8d6dbed
JD
1476 resistance.
1477 Note that because this information is secret, you may want to set
1478 the permissions of the .netdev file to be owned by <literal>root:systemd-networkd</literal>
1479 with a <literal>0640</literal> file mode.</para>
e5719363
JT
1480 </listitem>
1481 </varlistentry>
a3945c63
YW
1482 <varlistentry>
1483 <term><varname>PresharedKeyFile=</varname></term>
1484 <listitem>
1485 <para>Takes an absolute path to a file which contains the Base64 encoded preshared key for the
1486 peer. When this option is specified, then <varname>PresharedKey=</varname> is ignored.
1487 Note that the file must be readable by the user <literal>systemd-network</literal>, so it
1488 should be, e.g., owned by <literal>root:systemd-network</literal> with a
1489 <literal>0640</literal> file mode.</para>
1490 </listitem>
1491 </varlistentry>
e5719363
JT
1492 <varlistentry>
1493 <term><varname>AllowedIPs=</varname></term>
1494 <listitem>
1495 <para>Sets a comma-separated list of IP (v4 or v6) addresses with CIDR masks
1496 from which this peer is allowed to send incoming traffic and to
1497 which outgoing traffic for this peer is directed. The catch-all
1498 0.0.0.0/0 may be specified for matching all IPv4 addresses, and
1499 ::/0 may be specified for matching all IPv6 addresses. </para>
1500 </listitem>
1501 </varlistentry>
1502 <varlistentry>
1503 <term><varname>Endpoint=</varname></term>
1504 <listitem>
1505 <para>Sets an endpoint IP address or hostname, followed by a colon, and then
1506 a port number. This endpoint will be updated automatically once to
1507 the most recent source IP address and port of correctly
1508 authenticated packets from the peer at configuration time.</para>
1509 </listitem>
1510 </varlistentry>
1511 <varlistentry>
1512 <term><varname>PersistentKeepalive=</varname></term>
1513 <listitem>
1514 <para>Sets a seconds interval, between 1 and 65535 inclusive, of how often
1515 to send an authenticated empty packet to the peer for the purpose
1516 of keeping a stateful firewall or NAT mapping valid persistently.
1517 For example, if the interface very rarely sends traffic, but it
1518 might at anytime receive traffic from a peer, and it is behind NAT,
1519 the interface might benefit from having a persistent keepalive
1520 interval of 25 seconds. If set to 0 or "off", this option is
1521 disabled. By default or when unspecified, this option is off.
1522 Most users will not need this.</para>
1523 </listitem>
1524 </varlistentry>
1525 </variablelist>
1526 </refsect1>
1527
798d3a52
ZJS
1528 <refsect1>
1529 <title>[Bond] Section Options</title>
1530
1531 <para>The <literal>[Bond]</literal> section accepts the following
1532 key:</para>
1533
1534 <variablelist class='network-directives'>
1535 <varlistentry>
1536 <term><varname>Mode=</varname></term>
1537 <listitem>
1538 <para>Specifies one of the bonding policies. The default is
1539 <literal>balance-rr</literal> (round robin). Possible values are
1540 <literal>balance-rr</literal>,
1541 <literal>active-backup</literal>,
1542 <literal>balance-xor</literal>,
1543 <literal>broadcast</literal>,
1544 <literal>802.3ad</literal>,
1545 <literal>balance-tlb</literal>, and
1546 <literal>balance-alb</literal>.
1547 </para>
1548 </listitem>
1549 </varlistentry>
1550
1551 <varlistentry>
1552 <term><varname>TransmitHashPolicy=</varname></term>
1553 <listitem>
1554 <para>Selects the transmit hash policy to use for slave
1555 selection in balance-xor, 802.3ad, and tlb modes. Possible
1556 values are
1557 <literal>layer2</literal>,
1558 <literal>layer3+4</literal>,
1559 <literal>layer2+3</literal>,
4d89618a 1560 <literal>encap2+3</literal>, and
798d3a52
ZJS
1561 <literal>encap3+4</literal>.
1562 </para>
1563 </listitem>
1564 </varlistentry>
1565
1566 <varlistentry>
1567 <term><varname>LACPTransmitRate=</varname></term>
1568 <listitem>
1569 <para>Specifies the rate with which link partner transmits
1570 Link Aggregation Control Protocol Data Unit packets in
1571 802.3ad mode. Possible values are <literal>slow</literal>,
1572 which requests partner to transmit LACPDUs every 30 seconds,
1573 and <literal>fast</literal>, which requests partner to
1574 transmit LACPDUs every second. The default value is
1575 <literal>slow</literal>.</para>
1576 </listitem>
1577 </varlistentry>
1578
1579 <varlistentry>
1580 <term><varname>MIIMonitorSec=</varname></term>
1581 <listitem>
1582 <para>Specifies the frequency that Media Independent
1583 Interface link monitoring will occur. A value of zero
dd2b607b 1584 disables MII link monitoring. This value is rounded down to
798d3a52
ZJS
1585 the nearest millisecond. The default value is 0.</para>
1586 </listitem>
1587 </varlistentry>
1588
1589 <varlistentry>
1590 <term><varname>UpDelaySec=</varname></term>
1591 <listitem>
1592 <para>Specifies the delay before a link is enabled after a
1593 link up status has been detected. This value is rounded down
1594 to a multiple of MIIMonitorSec. The default value is
1595 0.</para>
1596 </listitem>
1597 </varlistentry>
1598
1599 <varlistentry>
1600 <term><varname>DownDelaySec=</varname></term>
1601 <listitem>
1602 <para>Specifies the delay before a link is disabled after a
1603 link down status has been detected. This value is rounded
1604 down to a multiple of MIIMonitorSec. The default value is
1605 0.</para>
1606 </listitem>
1607 </varlistentry>
1608
81bd37a8 1609 <varlistentry>
38422da7 1610 <term><varname>LearnPacketIntervalSec=</varname></term>
81bd37a8
SS
1611 <listitem>
1612 <para>Specifies the number of seconds between instances where the bonding
a8eaaee7
JE
1613 driver sends learning packets to each slave peer switch.
1614 The valid range is 1–0x7fffffff; the default value is 1. This option
1615 has an effect only for the balance-tlb and balance-alb modes.</para>
81bd37a8
SS
1616 </listitem>
1617 </varlistentry>
1618
1619 <varlistentry>
1620 <term><varname>AdSelect=</varname></term>
1621 <listitem>
1622 <para>Specifies the 802.3ad aggregation selection logic to use. Possible values are
1623 <literal>stable</literal>,
a8eaaee7
JE
1624 <literal>bandwidth</literal> and
1625 <literal>count</literal>.
81bd37a8
SS
1626 </para>
1627 </listitem>
1628 </varlistentry>
1629
99f68ef0 1630 <varlistentry>
db688b7e 1631 <term><varname>AdActorSystemPriority=</varname></term>
99f68ef0 1632 <listitem>
db688b7e 1633 <para>Specifies the 802.3ad actor system priority. Ranges [1-65535].</para>
99f68ef0
TJ
1634 </listitem>
1635 </varlistentry>
1636
1637 <varlistentry>
1638 <term><varname>AdUserPortKey=</varname></term>
1639 <listitem>
1640 <para>Specifies the 802.3ad user defined portion of the port key. Ranges [0-1023].</para>
1641 </listitem>
1642 </varlistentry>
1643
1644 <varlistentry>
1645 <term><varname>AdActorSystem=</varname></term>
1646 <listitem>
1647 <para>Specifies the 802.3ad system mac address. This can not be either NULL or Multicast.</para>
1648 </listitem>
1649 </varlistentry>
1650
81bd37a8 1651 <varlistentry>
38422da7 1652 <term><varname>FailOverMACPolicy=</varname></term>
81bd37a8 1653 <listitem>
a8eaaee7
JE
1654 <para>Specifies whether the active-backup mode should set all slaves to
1655 the same MAC address at the time of enslavement or, when enabled, to perform special handling of the
81bd37a8
SS
1656 bond's MAC address in accordance with the selected policy. The default policy is none.
1657 Possible values are
1658 <literal>none</literal>,
a8eaaee7
JE
1659 <literal>active</literal> and
1660 <literal>follow</literal>.
81bd37a8
SS
1661 </para>
1662 </listitem>
1663 </varlistentry>
1664
1665 <varlistentry>
38422da7 1666 <term><varname>ARPValidate=</varname></term>
81bd37a8
SS
1667 <listitem>
1668 <para>Specifies whether or not ARP probes and replies should be
38422da7 1669 validated in any mode that supports ARP monitoring, or whether
81bd37a8
SS
1670 non-ARP traffic should be filtered (disregarded) for link
1671 monitoring purposes. Possible values are
1672 <literal>none</literal>,
1673 <literal>active</literal>,
a8eaaee7
JE
1674 <literal>backup</literal> and
1675 <literal>all</literal>.
81bd37a8
SS
1676 </para>
1677 </listitem>
1678 </varlistentry>
1679
1680 <varlistentry>
38422da7 1681 <term><varname>ARPIntervalSec=</varname></term>
81bd37a8
SS
1682 <listitem>
1683 <para>Specifies the ARP link monitoring frequency in milliseconds.
1684 A value of 0 disables ARP monitoring. The default value is 0.
1685 </para>
1686 </listitem>
1687 </varlistentry>
1688
1689 <varlistentry>
38422da7 1690 <term><varname>ARPIPTargets=</varname></term>
81bd37a8
SS
1691 <listitem>
1692 <para>Specifies the IP addresses to use as ARP monitoring peers when
38422da7 1693 ARPIntervalSec is greater than 0. These are the targets of the ARP request
81bd37a8 1694 sent to determine the health of the link to the targets.
a8eaaee7 1695 Specify these values in IPv4 dotted decimal format. At least one IP
81bd37a8
SS
1696 address must be given for ARP monitoring to function. The
1697 maximum number of targets that can be specified is 16. The
1698 default value is no IP addresses.
1699 </para>
1700 </listitem>
1701 </varlistentry>
1702
1703 <varlistentry>
38422da7 1704 <term><varname>ARPAllTargets=</varname></term>
81bd37a8 1705 <listitem>
38422da7 1706 <para>Specifies the quantity of ARPIPTargets that must be reachable
81bd37a8
SS
1707 in order for the ARP monitor to consider a slave as being up.
1708 This option affects only active-backup mode for slaves with
38422da7 1709 ARPValidate enabled. Possible values are
a8eaaee7
JE
1710 <literal>any</literal> and
1711 <literal>all</literal>.
81bd37a8
SS
1712 </para>
1713 </listitem>
1714 </varlistentry>
1715
1716 <varlistentry>
38422da7 1717 <term><varname>PrimaryReselectPolicy=</varname></term>
81bd37a8
SS
1718 <listitem>
1719 <para>Specifies the reselection policy for the primary slave. This
1720 affects how the primary slave is chosen to become the active slave
1721 when failure of the active slave or recovery of the primary slave
1722 occurs. This option is designed to prevent flip-flopping between
1723 the primary slave and other slaves. Possible values are
1724 <literal>always</literal>,
a8eaaee7
JE
1725 <literal>better</literal> and
1726 <literal>failure</literal>.
81bd37a8
SS
1727 </para>
1728 </listitem>
1729 </varlistentry>
1730
1731 <varlistentry>
1732 <term><varname>ResendIGMP=</varname></term>
1733 <listitem>
1734 <para>Specifies the number of IGMP membership reports to be issued after
1735 a failover event. One membership report is issued immediately after
1736 the failover, subsequent packets are sent in each 200ms interval.
b938cb90 1737 The valid range is 0–255. Defaults to 1. A value of 0
81bd37a8
SS
1738 prevents the IGMP membership report from being issued in response
1739 to the failover event.
1740 </para>
1741 </listitem>
1742 </varlistentry>
1743
1744 <varlistentry>
1745 <term><varname>PacketsPerSlave=</varname></term>
1746 <listitem>
b938cb90
JE
1747 <para>Specify the number of packets to transmit through a slave before
1748 moving to the next one. When set to 0, then a slave is chosen at
1749 random. The valid range is 0–65535. Defaults to 1. This option
a8eaaee7 1750 only has effect when in balance-rr mode.
81bd37a8
SS
1751 </para>
1752 </listitem>
1753 </varlistentry>
1754
1755 <varlistentry>
38422da7 1756 <term><varname>GratuitousARP=</varname></term>
81bd37a8
SS
1757 <listitem>
1758 <para>Specify the number of peer notifications (gratuitous ARPs and
1759 unsolicited IPv6 Neighbor Advertisements) to be issued after a
b938cb90 1760 failover event. As soon as the link is up on the new slave,
81bd37a8
SS
1761 a peer notification is sent on the bonding device and each
1762 VLAN sub-device. This is repeated at each link monitor interval
38422da7 1763 (ARPIntervalSec or MIIMonitorSec, whichever is active) if the number is
a8eaaee7 1764 greater than 1. The valid range is 0–255. The default value is 1.
38422da7 1765 These options affect only the active-backup mode.
81bd37a8
SS
1766 </para>
1767 </listitem>
1768 </varlistentry>
1769
1770 <varlistentry>
1771 <term><varname>AllSlavesActive=</varname></term>
1772 <listitem>
9b6ffef3 1773 <para>Takes a boolean. Specifies that duplicate frames (received on inactive ports)
a8eaaee7 1774 should be dropped when false, or delivered when true. Normally, bonding will drop
81bd37a8
SS
1775 duplicate frames (received on inactive ports), which is desirable for
1776 most users. But there are some times it is nice to allow duplicate
1777 frames to be delivered. The default value is false (drop duplicate frames
1778 received on inactive ports).
1779 </para>
1780 </listitem>
1781 </varlistentry>
1782
fde60a42
SS
1783 <varlistentry>
1784 <term><varname>DynamicTransmitLoadBalancing=</varname></term>
1785 <listitem>
1786 <para>Takes a boolean. Specifies if dynamic shuffling of flows is enabled. Applies only
1787 for balance-tlb mode. Defaults to unset.
1788 </para>
1789 </listitem>
1790 </varlistentry>
1791
81bd37a8
SS
1792 <varlistentry>
1793 <term><varname>MinLinks=</varname></term>
1794 <listitem>
1795 <para>Specifies the minimum number of links that must be active before
1796 asserting carrier. The default value is 0.
1797 </para>
1798 </listitem>
1799 </varlistentry>
798d3a52 1800 </variablelist>
81bd37a8
SS
1801
1802 <para>For more detail information see
1803 <ulink url="https://www.kernel.org/doc/Documentation/networking/bonding.txt">
1804 Linux Ethernet Bonding Driver HOWTO</ulink></para>
1805
798d3a52
ZJS
1806 </refsect1>
1807
1808 <refsect1>
48847676 1809 <title>Examples</title>
798d3a52 1810 <example>
6c1695be 1811 <title>/etc/systemd/network/25-bridge.netdev</title>
798d3a52
ZJS
1812
1813 <programlisting>[NetDev]
eac684ef
TG
1814Name=bridge0
1815Kind=bridge</programlisting>
798d3a52 1816 </example>
eac684ef 1817
798d3a52 1818 <example>
6c1695be 1819 <title>/etc/systemd/network/25-vlan1.netdev</title>
eac684ef 1820
798d3a52 1821 <programlisting>[Match]
eac684ef
TG
1822Virtualization=no
1823
1824[NetDev]
1825Name=vlan1
1826Kind=vlan
1827
1828[VLAN]
1829Id=1</programlisting>
798d3a52
ZJS
1830 </example>
1831 <example>
6c1695be 1832 <title>/etc/systemd/network/25-ipip.netdev</title>
798d3a52 1833 <programlisting>[NetDev]
b35a2909
TG
1834Name=ipip-tun
1835Kind=ipip
1836MTUBytes=1480
1837
1838[Tunnel]
1839Local=192.168.223.238
1840Remote=192.169.224.239
1841TTL=64</programlisting>
798d3a52 1842 </example>
53cb501a
SS
1843 <example>
1844 <title>/etc/systemd/network/1-fou-tunnel.netdev</title>
1845 <programlisting>[NetDev]
1846Name=fou-tun
1847Kind=fou
1848
1849[FooOverUDP]
1850Port=5555
1851Protocol=4
1852 </programlisting>
1853 </example>
1854 <example>
1855 <title>/etc/systemd/network/25-fou-ipip.netdev</title>
1856 <programlisting>[NetDev]
53cb501a
SS
1857Name=ipip-tun
1858Kind=ipip
1859
1860[Tunnel]
964c4eda 1861Independent=yes
53cb501a
SS
1862Local=10.65.208.212
1863Remote=10.65.208.211
964c4eda 1864FooOverUDP=yes
53cb501a
SS
1865FOUDestinationPort=5555
1866 </programlisting>
1867 </example>
798d3a52 1868 <example>
6c1695be 1869 <title>/etc/systemd/network/25-tap.netdev</title>
798d3a52 1870 <programlisting>[NetDev]
30ae9dfd
SS
1871Name=tap-test
1872Kind=tap
1873
1874[Tap]
964c4eda
LP
1875MultiQueue=yes
1876PacketInfo=yes</programlisting> </example>
eac684ef 1877
798d3a52 1878 <example>
6c1695be 1879 <title>/etc/systemd/network/25-sit.netdev</title>
798d3a52 1880 <programlisting>[NetDev]
b35a2909
TG
1881Name=sit-tun
1882Kind=sit
1883MTUBytes=1480
1884
1885[Tunnel]
1886Local=10.65.223.238
1887Remote=10.65.223.239</programlisting>
798d3a52 1888 </example>
eac684ef 1889
d067cab3
DA
1890 <example>
1891 <title>/etc/systemd/network/25-6rd.netdev</title>
1892 <programlisting>[NetDev]
1893Name=6rd-tun
1894Kind=sit
1895MTUBytes=1480
1896
1897[Tunnel]
1898Local=10.65.223.238
1899IPv6RapidDeploymentPrefix=2602::/24</programlisting>
1900 </example>
1901
798d3a52 1902 <example>
6c1695be 1903 <title>/etc/systemd/network/25-gre.netdev</title>
798d3a52 1904 <programlisting>[NetDev]
b35a2909
TG
1905Name=gre-tun
1906Kind=gre
1907MTUBytes=1480
1908
1909[Tunnel]
1910Local=10.65.223.238
1911Remote=10.65.223.239</programlisting>
798d3a52 1912 </example>
b35a2909 1913
798d3a52 1914 <example>
6c1695be 1915 <title>/etc/systemd/network/25-vti.netdev</title>
b35a2909 1916
798d3a52 1917 <programlisting>[NetDev]
b35a2909
TG
1918Name=vti-tun
1919Kind=vti
1920MTUBytes=1480
1921
1922[Tunnel]
1923Local=10.65.223.238
1924Remote=10.65.223.239</programlisting>
798d3a52 1925 </example>
b35a2909 1926
798d3a52 1927 <example>
6c1695be 1928 <title>/etc/systemd/network/25-veth.netdev</title>
798d3a52 1929 <programlisting>[NetDev]
b35a2909
TG
1930Name=veth-test
1931Kind=veth
1932
1933[Peer]
1934Name=veth-peer</programlisting>
798d3a52 1935 </example>
b35a2909 1936
d94facdc 1937 <example>
6c1695be 1938 <title>/etc/systemd/network/25-bond.netdev</title>
d94facdc
MH
1939 <programlisting>[NetDev]
1940Name=bond1
1941Kind=bond
1942
1943[Bond]
1944Mode=802.3ad
1945TransmitHashPolicy=layer3+4
1946MIIMonitorSec=1s
1947LACPTransmitRate=fast
1948</programlisting>
1949 </example>
1950
798d3a52 1951 <example>
6c1695be 1952 <title>/etc/systemd/network/25-dummy.netdev</title>
798d3a52 1953 <programlisting>[NetDev]
9e358851
TG
1954Name=dummy-test
1955Kind=dummy
1956MACAddress=12:34:56:78:9a:bc</programlisting>
798d3a52 1957 </example>
20897a0d
AR
1958 <example>
1959 <title>/etc/systemd/network/25-vrf.netdev</title>
037a3ded 1960 <para>Create a VRF interface with table 42.</para>
20897a0d
AR
1961 <programlisting>[NetDev]
1962Name=vrf-test
1963Kind=vrf
798d3a52 1964
20897a0d 1965[VRF]
362f6336 1966Table=42</programlisting>
20897a0d 1967 </example>
42125eda
SS
1968
1969 <example>
1970 <title>/etc/systemd/network/25-macvtap.netdev</title>
1971 <para>Create a MacVTap device.</para>
1972 <programlisting>[NetDev]
1973Name=macvtap-test
1974Kind=macvtap
1975 </programlisting>
1976 </example>
e5719363
JT
1977 <example>
1978 <title>/etc/systemd/network/25-wireguard.netdev</title>
1979 <programlisting>[NetDev]
1980Name=wg0
1981Kind=wireguard
1982
1983[WireGuard]
1984PrivateKey=EEGlnEPYJV//kbvvIqxKkQwOiS+UENyPncC4bF46ong=
1985ListenPort=51820
1986
1987[WireGuardPeer]
1988PublicKey=RDf+LSpeEre7YEIKaxg+wbpsNV7du+ktR99uBEtIiCA=
1989AllowedIPs=fd31:bf08:57cb::/48,192.168.26.0/24
1990Endpoint=wireguard.example.com:51820</programlisting>
1991 </example>
798d3a52
ZJS
1992 </refsect1>
1993 <refsect1>
1994 <title>See Also</title>
1995 <para>
1996 <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
1997 <citerefentry><refentrytitle>systemd-networkd</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
1998 <citerefentry><refentrytitle>systemd.link</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
1999 <citerefentry><refentrytitle>systemd.network</refentrytitle><manvolnum>5</manvolnum></citerefentry>
2000 </para>
2001 </refsect1>
eac684ef
TG
2002
2003</refentry>