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