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