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