]> git.ipfire.org Git - thirdparty/systemd.git/blob - man/systemd.netdev.xml
Merge pull request #23893 from yuwata/core-mount-re-read-mountinfo
[thirdparty/systemd.git] / man / systemd.netdev.xml
1 <?xml version='1.0'?> <!--*-nxml-*-->
2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3 "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
4 <!-- SPDX-License-Identifier: LGPL-2.1-or-later -->
5
6 <refentry id="systemd.netdev" conditional='ENABLE_NETWORKD'
7 xmlns:xi="http://www.w3.org/2001/XInclude">
8
9 <refentryinfo>
10 <title>systemd.network</title>
11 <productname>systemd</productname>
12 </refentryinfo>
13
14 <refmeta>
15 <refentrytitle>systemd.netdev</refentrytitle>
16 <manvolnum>5</manvolnum>
17 </refmeta>
18
19 <refnamediv>
20 <refname>systemd.netdev</refname>
21 <refpurpose>Virtual Network Device configuration</refpurpose>
22 </refnamediv>
23
24 <refsynopsisdiv>
25 <para><filename><replaceable>netdev</replaceable>.netdev</filename></para>
26 </refsynopsisdiv>
27
28 <refsect1>
29 <title>Description</title>
30
31 <para>A plain ini-style text file that encodes configuration about a virtual network device, used by
32 <citerefentry><refentrytitle>systemd-networkd</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
33 See <citerefentry><refentrytitle>systemd.syntax</refentrytitle><manvolnum>7</manvolnum></citerefentry>
34 for a general description of the syntax.</para>
35
36 <para>The main Virtual Network Device file must have the extension <filename>.netdev</filename>;
37 other extensions are ignored. Virtual network devices are created as soon as networkd is
38 started. If a netdev with the specified name already exists, networkd will use that as-is rather
39 than create its own. Note that the settings of the pre-existing netdev will not be changed by
40 networkd.</para>
41
42 <para>The <filename>.netdev</filename> files are read from the files located in the system network
43 directory <filename>/usr/lib/systemd/network</filename> and
44 <filename>/usr/local/lib/systemd/network</filename>, the volatile runtime network directory
45 <filename>/run/systemd/network</filename> and the local administration network directory
46 <filename>/etc/systemd/network</filename>. All configuration files are collectively sorted and
47 processed in alphanumeric order, regardless of the directories in which they live. However, files
48 with identical filenames replace each other. It is recommended that each filename is prefixed with
49 a number (e.g. <filename>10-vlan.netdev</filename>). Otherwise, <filename>.netdev</filename> files
50 generated by
51 <citerefentry><refentrytitle>systemd-network-generator.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>
52 may take precedence over user configured files. Files in <filename>/etc/</filename> have the
53 highest priority, files in <filename>/run/</filename> take precedence over files with the same name
54 in <filename>/usr/lib/</filename>. This can be used to override a system-supplied configuration
55 file with a local file if needed. As a special case, an empty file (file size 0) or symlink with
56 the same name pointing to <filename>/dev/null</filename> disables the configuration file entirely
57 (it is "masked").</para>
58
59 <para>Along with the netdev file <filename>foo.netdev</filename>, a "drop-in" directory
60 <filename>foo.netdev.d/</filename> may exist. All files with the suffix <literal>.conf</literal>
61 from this directory will be merged in the alphanumeric order and parsed after the main file itself
62 has been parsed. This is useful to alter or add configuration settings, without having to modify
63 the main configuration file. Each drop-in file must have appropriate section headers.</para>
64
65 <para>In addition to <filename>/etc/systemd/network</filename>, drop-in <literal>.d</literal>
66 directories can be placed in <filename>/usr/lib/systemd/network</filename> or
67 <filename>/run/systemd/network</filename> directories. Drop-in files in
68 <filename>/etc/</filename> take precedence over those in <filename>/run/</filename> which in turn
69 take precedence over those in <filename>/usr/lib/</filename>. Drop-in files under any of these
70 directories take precedence over the main netdev file wherever located. (Of course, since
71 <filename>/run/</filename> is temporary and <filename>/usr/lib/</filename> is for vendors, it is
72 unlikely drop-ins should be used in either of those places.)</para>
73 </refsect1>
74
75 <refsect1>
76 <title>Supported netdev kinds</title>
77
78 <para>The following kinds of virtual network devices may be
79 configured in <filename>.netdev</filename> files:</para>
80
81 <table>
82 <title>Supported kinds of virtual network devices</title>
83
84 <tgroup cols='2'>
85 <colspec colname='kind' />
86 <colspec colname='explanation' />
87 <thead><row>
88 <entry>Kind</entry>
89 <entry>Description</entry>
90 </row></thead>
91 <tbody>
92 <row><entry><varname>bond</varname></entry>
93 <entry>A bond device is an aggregation of all its slave devices. See <ulink url="https://docs.kernel.org/networking/bonding.html">Linux Ethernet Bonding Driver HOWTO</ulink> for details.</entry></row>
94
95 <row><entry><varname>bridge</varname></entry>
96 <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>
97
98 <row><entry><varname>dummy</varname></entry>
99 <entry>A dummy device drops all packets sent to it.</entry></row>
100
101 <row><entry><varname>gre</varname></entry>
102 <entry>A Level 3 GRE tunnel over IPv4. See <ulink url="https://tools.ietf.org/html/rfc2784">RFC 2784</ulink> for details. Name <literal>gre0</literal> should not be used, as the kernel creates a device with this name when the corresponding kernel module is loaded.</entry></row>
103
104 <row><entry><varname>gretap</varname></entry>
105 <entry>A Level 2 GRE tunnel over IPv4. Name <literal>gretap0</literal> should not be used, as the kernel creates a device with this name when the corresponding kernel module is loaded.</entry></row>
106
107 <row><entry><varname>erspan</varname></entry>
108 <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. Name <literal>erspan0</literal> should not be used, as the kernel creates a device with this name when the corresponding kernel module is loaded.</entry></row>
109
110 <row><entry><varname>ip6gre</varname></entry>
111 <entry>A Level 3 GRE tunnel over IPv6.</entry></row>
112
113 <row><entry><varname>ip6tnl</varname></entry>
114 <entry>An IPv4 or IPv6 tunnel over IPv6</entry></row>
115
116 <row><entry><varname>ip6gretap</varname></entry>
117 <entry>A Level 2 GRE tunnel over IPv6.</entry></row>
118
119 <row><entry><varname>ipip</varname></entry>
120 <entry>An IPv4 over IPv4 tunnel.</entry></row>
121
122 <row><entry><varname>ipvlan</varname></entry>
123 <entry>An IPVLAN device is a stacked device which receives packets from its underlying device based on IP address filtering.</entry></row>
124
125 <row><entry><varname>ipvtap</varname></entry>
126 <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>
127
128 <row><entry><varname>macvlan</varname></entry>
129 <entry>A macvlan device is a stacked device which receives packets from its underlying device based on MAC address filtering.</entry></row>
130
131 <row><entry><varname>macvtap</varname></entry>
132 <entry>A macvtap device is a stacked device which receives packets from its underlying device based on MAC address filtering.</entry></row>
133
134 <row><entry><varname>sit</varname></entry>
135 <entry>An IPv6 over IPv4 tunnel.</entry></row>
136
137 <row><entry><varname>tap</varname></entry>
138 <entry>A persistent Level 2 tunnel between a network device and a device node.</entry></row>
139
140 <row><entry><varname>tun</varname></entry>
141 <entry>A persistent Level 3 tunnel between a network device and a device node.</entry></row>
142
143 <row><entry><varname>veth</varname></entry>
144 <entry>An Ethernet tunnel between a pair of network devices.</entry></row>
145
146 <row><entry><varname>vlan</varname></entry>
147 <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>
148
149 <row><entry><varname>vti</varname></entry>
150 <entry>An IPv4 over IPSec tunnel.</entry></row>
151
152 <row><entry><varname>vti6</varname></entry>
153 <entry>An IPv6 over IPSec tunnel.</entry></row>
154
155 <row><entry><varname>vxlan</varname></entry>
156 <entry>A virtual extensible LAN (vxlan), for connecting Cloud computing deployments.</entry></row>
157
158 <row><entry><varname>geneve</varname></entry>
159 <entry>A GEneric NEtwork Virtualization Encapsulation (GENEVE) netdev driver.</entry></row>
160
161 <row><entry><varname>l2tp</varname></entry>
162 <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>
163
164 <row><entry><varname>macsec</varname></entry>
165 <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>
166
167 <row><entry><varname>vrf</varname></entry>
168 <entry>A Virtual Routing and Forwarding (<ulink url="https://docs.kernel.org/networking/vrf.html">VRF</ulink>) interface to create separate routing and forwarding domains.</entry></row>
169
170 <row><entry><varname>vcan</varname></entry>
171 <entry>The virtual CAN driver (vcan). Similar to the network loopback devices, vcan offers a virtual local CAN interface.</entry></row>
172
173 <row><entry><varname>vxcan</varname></entry>
174 <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.
175 </entry></row>
176
177 <row><entry><varname>wireguard</varname></entry>
178 <entry>WireGuard Secure Network Tunnel.</entry></row>
179
180 <row><entry><varname>nlmon</varname></entry>
181 <entry>A Netlink monitor device. Use an nlmon device when you want to monitor system Netlink messages.</entry></row>
182
183 <row><entry><varname>fou</varname></entry>
184 <entry>Foo-over-UDP tunneling.</entry></row>
185
186 <row><entry><varname>xfrm</varname></entry>
187 <entry>A virtual tunnel interface like vti/vti6 but with several advantages.</entry></row>
188
189 <row><entry><varname>ifb</varname></entry>
190 <entry>The Intermediate Functional Block (ifb) pseudo network interface acts as a QoS concentrator for multiple different sources of traffic.</entry></row>
191
192 <row><entry><varname>bareudp</varname></entry>
193 <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>
194
195 <row><entry><varname>batadv</varname></entry>
196 <entry><ulink url="https://www.open-mesh.org/projects/open-mesh/wiki">B.A.T.M.A.N. Advanced</ulink> is a routing protocol for multi-hop mobile ad-hoc networks which operates on layer 2.</entry></row>
197
198 <row><entry><varname>ipoib</varname></entry>
199 <entry>An IP over Infiniband subinterface.</entry></row>
200
201 <row><entry><varname>wlan</varname></entry>
202 <entry>A virtual wireless network (WLAN) interface.</entry></row>
203 </tbody>
204 </tgroup>
205 </table>
206
207 </refsect1>
208
209 <refsect1>
210 <title>[Match] Section Options</title>
211
212 <para>A virtual network device is only created if the [Match] section matches the current
213 environment, or if the section is empty. The following keys are accepted:</para>
214
215 <variablelist class='network-directives'>
216 <xi:include href="systemd.link.xml" xpointer="host" />
217 <xi:include href="systemd.link.xml" xpointer="virtualization" />
218 <xi:include href="systemd.link.xml" xpointer="kernel-command-line" />
219 <xi:include href="systemd.link.xml" xpointer="kernel-version" />
220 <xi:include href="systemd.link.xml" xpointer="credential" />
221 <xi:include href="systemd.link.xml" xpointer="architecture" />
222 <xi:include href="systemd.link.xml" xpointer="firmware" />
223 </variablelist>
224 </refsect1>
225
226 <refsect1>
227 <title>[NetDev] Section Options</title>
228
229 <para>The [NetDev] section accepts the
230 following keys:</para>
231
232 <variablelist class='network-directives'>
233 <varlistentry>
234 <term><varname>Description=</varname></term>
235 <listitem>
236 <para>A free-form description of the netdev.</para>
237 </listitem>
238 </varlistentry>
239 <varlistentry>
240 <term><varname>Name=</varname></term>
241 <listitem>
242 <para>The interface name used when creating the netdev.
243 This setting is compulsory.</para>
244 </listitem>
245 </varlistentry>
246 <varlistentry>
247 <term><varname>Kind=</varname></term>
248 <listitem>
249 <para>The netdev kind. This setting is compulsory. See the
250 <literal>Supported netdev kinds</literal> section for the
251 valid keys.</para>
252 </listitem>
253 </varlistentry>
254 <varlistentry>
255 <term><varname>MTUBytes=</varname></term>
256 <listitem>
257 <para>The maximum transmission unit in bytes to set for the device. The usual suffixes K, M, G
258 are supported and are understood to the base of 1024. For <literal>tun</literal> or
259 <literal>tap</literal> devices, <varname>MTUBytes=</varname> setting is not currently supported in
260 [NetDev] section. Please specify it in [Link] section of
261 corresponding
262 <citerefentry><refentrytitle>systemd.network</refentrytitle><manvolnum>5</manvolnum></citerefentry>
263 files.</para>
264 </listitem>
265 </varlistentry>
266 <varlistentry>
267 <term><varname>MACAddress=</varname></term>
268 <listitem>
269 <para>Specifies the MAC address to use for the device, or takes the special value
270 <literal>none</literal>. When <literal>none</literal>, <command>systemd-networkd</command>
271 does not request the MAC address for the device, and the kernel will assign a random MAC
272 address. For <literal>tun</literal>, <literal>tap</literal>, or <literal>l2tp</literal>
273 devices, the <varname>MACAddress=</varname> setting in the [NetDev] section is not
274 supported and will be ignored. Please specify it in the [Link] section of the corresponding
275 <citerefentry><refentrytitle>systemd.network</refentrytitle><manvolnum>5</manvolnum></citerefentry>
276 file. If this option is not set, <literal>vlan</literal> device inherits the MAC address of
277 the master interface. For other kind of netdevs, if this option is not set, then the MAC
278 address is generated based on the interface name and the
279 <citerefentry><refentrytitle>machine-id</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
280 </para>
281 <para>Note, even if <literal>none</literal> is specified, <command>systemd-udevd</command>
282 will assign the persistent MAC address for the device, as <filename>99-default.link</filename>
283 has <varname>MACAddressPolicy=persistent</varname>. So, it is also necessary to create a
284 custom .link file for the device, if the MAC address assignment is not desired.</para>
285 </listitem>
286 </varlistentry>
287 </variablelist>
288 </refsect1>
289
290 <refsect1>
291 <title>[Bridge] Section Options</title>
292
293 <para>The [Bridge] section only applies for
294 netdevs of kind <literal>bridge</literal>, and accepts the
295 following keys:</para>
296
297 <variablelist class='network-directives'>
298 <varlistentry>
299 <term><varname>HelloTimeSec=</varname></term>
300 <listitem>
301 <para>HelloTimeSec specifies the number of seconds between two hello packets
302 sent out by the root bridge and the designated bridges. Hello packets are
303 used to communicate information about the topology throughout the entire
304 bridged local area network.</para>
305 </listitem>
306 </varlistentry>
307 <varlistentry>
308 <term><varname>MaxAgeSec=</varname></term>
309 <listitem>
310 <para>MaxAgeSec specifies the number of seconds of maximum message age.
311 If the last seen (received) hello packet is more than this number of
312 seconds old, the bridge in question will start the takeover procedure
313 in attempt to become the Root Bridge itself.</para>
314 </listitem>
315 </varlistentry>
316 <varlistentry>
317 <term><varname>ForwardDelaySec=</varname></term>
318 <listitem>
319 <para>ForwardDelaySec specifies the number of seconds spent in each
320 of the Listening and Learning states before the Forwarding state is entered.</para>
321 </listitem>
322 </varlistentry>
323 <varlistentry>
324 <term><varname>AgeingTimeSec=</varname></term>
325 <listitem>
326 <para>This specifies the number of seconds a MAC Address will be kept in
327 the forwarding database after having a packet received from this MAC Address.</para>
328 </listitem>
329 </varlistentry>
330 <varlistentry>
331 <term><varname>Priority=</varname></term>
332 <listitem>
333 <para>The priority of the bridge. An integer between 0 and 65535. A lower value
334 means higher priority. The bridge having the lowest priority will be elected as root bridge.</para>
335 </listitem>
336 </varlistentry>
337 <varlistentry>
338 <term><varname>GroupForwardMask=</varname></term>
339 <listitem>
340 <para>A 16-bit bitmask represented as an integer which allows forwarding of link
341 local frames with 802.1D reserved addresses (01:80:C2:00:00:0X). A logical AND
342 is performed between the specified bitmask and the exponentiation of 2^X, the
343 lower nibble of the last octet of the MAC address. For example, a value of 8
344 would allow forwarding of frames addressed to 01:80:C2:00:00:03 (802.1X PAE).</para>
345 </listitem>
346 </varlistentry>
347 <varlistentry>
348 <term><varname>DefaultPVID=</varname></term>
349 <listitem>
350 <para>This specifies the default port VLAN ID of a newly attached bridge port.
351 Set this to an integer in the range 1…4094 or <literal>none</literal> to disable the PVID.</para>
352 </listitem>
353 </varlistentry>
354 <varlistentry>
355 <term><varname>MulticastQuerier=</varname></term>
356 <listitem>
357 <para>Takes a boolean. This setting controls the IFLA_BR_MCAST_QUERIER option in the kernel.
358 If enabled, the kernel will send general ICMP queries from a zero source address.
359 This feature should allow faster convergence on startup, but it causes some
360 multicast-aware switches to misbehave and disrupt forwarding of multicast packets.
361 When unset, the kernel's default will be used.
362 </para>
363 </listitem>
364 </varlistentry>
365 <varlistentry>
366 <term><varname>MulticastSnooping=</varname></term>
367 <listitem>
368 <para>Takes a boolean. This setting controls the IFLA_BR_MCAST_SNOOPING option in the kernel.
369 If enabled, IGMP snooping monitors the Internet Group Management Protocol (IGMP) traffic
370 between hosts and multicast routers. When unset, the kernel's default will be used.
371 </para>
372 </listitem>
373 </varlistentry>
374 <varlistentry>
375 <term><varname>VLANFiltering=</varname></term>
376 <listitem>
377 <para>Takes a boolean. This setting controls the IFLA_BR_VLAN_FILTERING option in the kernel.
378 If enabled, the bridge will be started in VLAN-filtering mode. When unset, the kernel's default will be used.
379 </para>
380 </listitem>
381 </varlistentry>
382 <varlistentry>
383 <term><varname>VLANProtocol=</varname></term>
384 <listitem>
385 <para>Allows setting the protocol used for VLAN filtering. Takes
386 <option>802.1q</option> or,
387 <option>802.1ad</option>, and defaults to unset and kernel's default is used.
388 </para>
389 </listitem>
390 </varlistentry>
391 <varlistentry>
392 <term><varname>STP=</varname></term>
393 <listitem>
394 <para>Takes a boolean. This enables the bridge's Spanning Tree Protocol (STP).
395 When unset, the kernel's default will be used.
396 </para>
397 </listitem>
398 </varlistentry>
399 <varlistentry>
400 <term><varname>MulticastIGMPVersion=</varname></term>
401 <listitem>
402 <para>Allows changing bridge's multicast Internet Group Management Protocol (IGMP) version.
403 Takes an integer 2 or 3. When unset, the kernel's default will be used.
404 </para>
405 </listitem>
406 </varlistentry>
407 </variablelist>
408 </refsect1>
409
410 <refsect1>
411 <title>[VLAN] Section Options</title>
412
413 <para>The [VLAN] section only applies for
414 netdevs of kind <literal>vlan</literal>, and accepts the
415 following key:</para>
416
417 <variablelist class='network-directives'>
418 <varlistentry>
419 <term><varname>Id=</varname></term>
420 <listitem>
421 <para>The VLAN ID to use. An integer in the range 0…4094.
422 This setting is compulsory.</para>
423 </listitem>
424 </varlistentry>
425 <varlistentry>
426 <term><varname>Protocol=</varname></term>
427 <listitem>
428 <para>Allows setting the protocol used for the VLAN interface. Takes <literal>802.1q</literal> or,
429 <literal>802.1ad</literal>, and defaults to unset and kernel's default is used.</para>
430 </listitem>
431 </varlistentry>
432 <varlistentry>
433 <term><varname>GVRP=</varname></term>
434 <listitem>
435 <para>Takes a boolean. The Generic VLAN Registration Protocol (GVRP) is a protocol that
436 allows automatic learning of VLANs on a network.
437 When unset, the kernel's default will be used.
438 </para>
439 </listitem>
440 </varlistentry>
441 <varlistentry>
442 <term><varname>MVRP=</varname></term>
443 <listitem>
444 <para>Takes a boolean. Multiple VLAN Registration Protocol (MVRP) formerly known as GARP VLAN
445 Registration Protocol (GVRP) is a standards-based Layer 2 network protocol,
446 for automatic configuration of VLAN information on switches. It was defined
447 in the 802.1ak amendment to 802.1Q-2005. When unset, the kernel's default will be used.
448 </para>
449 </listitem>
450 </varlistentry>
451 <varlistentry>
452 <term><varname>LooseBinding=</varname></term>
453 <listitem>
454 <para>Takes a boolean. The VLAN loose binding mode, in which only the operational state is passed
455 from the parent to the associated VLANs, but the VLAN device state is not changed.
456 When unset, the kernel's default will be used.</para>
457 </listitem>
458 </varlistentry>
459 <varlistentry>
460 <term><varname>ReorderHeader=</varname></term>
461 <listitem>
462 <para>Takes a boolean. When enabled, the VLAN reorder header is used and VLAN interfaces behave
463 like physical interfaces. When unset, the kernel's default will be used.</para>
464 </listitem>
465 </varlistentry>
466 <varlistentry>
467 <term><varname>EgressQOSMaps=</varname></term>
468 <term><varname>IngressQOSMaps=</varname></term>
469 <listitem>
470 <para>Defines a mapping of Linux internal packet priority (<constant>SO_PRIORITY</constant>)
471 to VLAN header PCP field for outgoing and incoming frames, respectively. Takes a
472 whitespace-separated list of integer pairs, where each integer must be in the range
473 1…4294967294, in the format <literal>from</literal>-<literal>to</literal>, e.g.,
474 <literal>21-7 45-5</literal>. Note that <literal>from</literal> must be greater than or equal
475 to <literal>to</literal>. When unset, the kernel's default will be used.</para>
476 </listitem>
477 </varlistentry>
478 </variablelist>
479 </refsect1>
480
481 <refsect1>
482 <title>[MACVLAN] Section Options</title>
483
484 <para>The [MACVLAN] section only applies for
485 netdevs of kind <literal>macvlan</literal>, and accepts the
486 following key:</para>
487
488 <variablelist class='network-directives'>
489 <varlistentry>
490 <term><varname>Mode=</varname></term>
491 <listitem>
492 <para>The MACVLAN mode to use. The supported options are
493 <literal>private</literal>,
494 <literal>vepa</literal>,
495 <literal>bridge</literal>,
496 <literal>passthru</literal>, and
497 <literal>source</literal>.
498 </para>
499 </listitem>
500 </varlistentry>
501 <varlistentry>
502 <term><varname>SourceMACAddress=</varname></term>
503 <listitem>
504 <para>A whitespace-separated list of remote hardware addresses allowed on the MACVLAN. This
505 option only has an effect in source mode. Use full colon-, hyphen- or dot-delimited
506 hexadecimal. This option may appear more than once, in which case the lists are merged. If
507 the empty string is assigned to this option, the list of hardware addresses defined prior
508 to this is reset. Defaults to unset.</para>
509 </listitem>
510 </varlistentry>
511 <varlistentry>
512 <term><varname>BroadcastMulticastQueueLength=</varname></term>
513 <listitem>
514 <para>Specifies the length of the receive queue for broadcast/multicast packets. An unsigned
515 integer in the range 0…4294967294. Defaults to unset.</para>
516 </listitem>
517 </varlistentry>
518 </variablelist>
519 </refsect1>
520
521 <refsect1>
522 <title>[MACVTAP] Section Options</title>
523
524 <para>The [MACVTAP] section applies for netdevs of kind <literal>macvtap</literal> and accepts the same
525 keys as [MACVLAN].</para>
526 </refsect1>
527
528 <refsect1>
529 <title>[IPVLAN] Section Options</title>
530
531 <para>The [IPVLAN] section only applies for
532 netdevs of kind <literal>ipvlan</literal>, and accepts the
533 following key:</para>
534
535 <variablelist class='network-directives'>
536 <varlistentry>
537 <term><varname>Mode=</varname></term>
538 <listitem>
539 <para>The IPVLAN mode to use. The supported options are
540 <literal>L2</literal>,<literal>L3</literal> and <literal>L3S</literal>.
541 </para>
542 </listitem>
543 </varlistentry>
544 <varlistentry>
545 <term><varname>Flags=</varname></term>
546 <listitem>
547 <para>The IPVLAN flags to use. The supported options are
548 <literal>bridge</literal>,<literal>private</literal> and <literal>vepa</literal>.
549 </para>
550 </listitem>
551 </varlistentry>
552 </variablelist>
553 </refsect1>
554
555 <refsect1>
556 <title>[IPVTAP] Section Options</title>
557
558 <para>The [IPVTAP] section only applies for netdevs of kind <literal>ipvtap</literal> and accepts the
559 same keys as [IPVLAN].</para>
560 </refsect1>
561
562 <refsect1>
563 <title>[VXLAN] Section Options</title>
564
565 <para>The [VXLAN] section only applies for
566 netdevs of kind <literal>vxlan</literal>, and accepts the
567 following keys:</para>
568
569 <variablelist class='network-directives'>
570 <varlistentry>
571 <term><varname>VNI=</varname></term>
572 <listitem>
573 <para>The VXLAN Network Identifier (or VXLAN Segment ID). Takes a number in the range 1…16777215.</para>
574 </listitem>
575 </varlistentry>
576 <varlistentry>
577 <term><varname>Remote=</varname></term>
578 <listitem>
579 <para>Configures destination IP address.</para>
580 </listitem>
581 </varlistentry>
582 <varlistentry>
583 <term><varname>Local=</varname></term>
584 <listitem>
585 <para>Configures local IP address. It must be an address on the underlying interface of the
586 VXLAN interface, or one of the special values <literal>ipv4_link_local</literal>,
587 <literal>ipv6_link_local</literal>, <literal>dhcp4</literal>, <literal>dhcp6</literal>, and
588 <literal>slaac</literal>. If one of the special values is specified, an address which matches
589 the corresponding type on the underlying interface will be used. Defaults to unset.</para>
590 </listitem>
591 </varlistentry>
592 <varlistentry>
593 <term><varname>Group=</varname></term>
594 <listitem>
595 <para>Configures VXLAN multicast group IP address. All members of a VXLAN must use the same
596 multicast group address.</para>
597 </listitem>
598 </varlistentry>
599 <varlistentry>
600 <term><varname>TOS=</varname></term>
601 <listitem>
602 <para>The Type Of Service byte value for a vxlan interface.</para>
603 </listitem>
604 </varlistentry>
605 <varlistentry>
606 <term><varname>TTL=</varname></term>
607 <listitem>
608 <para>A fixed Time To Live N on Virtual eXtensible Local Area Network packets.
609 Takes <literal>inherit</literal> or a number in the range 0…255. 0 is a special
610 value meaning inherit the inner protocol's TTL value. <literal>inherit</literal>
611 means that it will inherit the outer protocol's TTL value.</para>
612 </listitem>
613 </varlistentry>
614 <varlistentry>
615 <term><varname>MacLearning=</varname></term>
616 <listitem>
617 <para>Takes a boolean. When true, enables dynamic MAC learning
618 to discover remote MAC addresses.</para>
619 </listitem>
620 </varlistentry>
621 <varlistentry>
622 <term><varname>FDBAgeingSec=</varname></term>
623 <listitem>
624 <para>The lifetime of Forwarding Database entry learnt by
625 the kernel, in seconds.</para>
626 </listitem>
627 </varlistentry>
628 <varlistentry>
629 <term><varname>MaximumFDBEntries=</varname></term>
630 <listitem>
631 <para>Configures maximum number of FDB entries.</para>
632 </listitem>
633 </varlistentry>
634 <varlistentry>
635 <term><varname>ReduceARPProxy=</varname></term>
636 <listitem>
637 <para>Takes a boolean. When true, bridge-connected VXLAN tunnel
638 endpoint answers ARP requests from the local bridge on behalf
639 of remote Distributed Overlay Virtual Ethernet
640 <ulink url="https://en.wikipedia.org/wiki/Distributed_Overlay_Virtual_Ethernet">
641 (DOVE)</ulink> clients. Defaults to false.</para>
642 </listitem>
643 </varlistentry>
644 <varlistentry>
645 <term><varname>L2MissNotification=</varname></term>
646 <listitem>
647 <para>Takes a boolean. When true, enables netlink LLADDR miss
648 notifications.</para>
649 </listitem>
650 </varlistentry>
651 <varlistentry>
652 <term><varname>L3MissNotification=</varname></term>
653 <listitem>
654 <para>Takes a boolean. When true, enables netlink IP address miss notifications.</para>
655 </listitem>
656 </varlistentry>
657 <varlistentry>
658 <term><varname>RouteShortCircuit=</varname></term>
659 <listitem>
660 <para>Takes a boolean. When true, route short circuiting is turned
661 on.</para>
662 </listitem>
663 </varlistentry>
664 <varlistentry>
665 <term><varname>UDPChecksum=</varname></term>
666 <listitem>
667 <para>Takes a boolean. When true, transmitting UDP checksums when doing VXLAN/IPv4 is turned on.</para>
668 </listitem>
669 </varlistentry>
670 <varlistentry>
671 <term><varname>UDP6ZeroChecksumTx=</varname></term>
672 <listitem>
673 <para>Takes a boolean. When true, sending zero checksums in VXLAN/IPv6 is turned on.</para>
674 </listitem>
675 </varlistentry>
676 <varlistentry>
677 <term><varname>UDP6ZeroChecksumRx=</varname></term>
678 <listitem>
679 <para>Takes a boolean. When true, receiving zero checksums in VXLAN/IPv6 is turned on.</para>
680 </listitem>
681 </varlistentry>
682 <varlistentry>
683 <term><varname>RemoteChecksumTx=</varname></term>
684 <listitem>
685 <para>Takes a boolean. When true, remote transmit checksum offload of VXLAN is turned on.</para>
686 </listitem>
687 </varlistentry>
688 <varlistentry>
689 <term><varname>RemoteChecksumRx=</varname></term>
690 <listitem>
691 <para>Takes a boolean. When true, remote receive checksum offload in VXLAN is turned on.</para>
692 </listitem>
693 </varlistentry>
694 <varlistentry>
695 <term><varname>GroupPolicyExtension=</varname></term>
696 <listitem>
697 <para>Takes a boolean. When true, it enables Group Policy VXLAN extension security label mechanism
698 across network peers based on VXLAN. For details about the Group Policy VXLAN, see the
699 <ulink url="https://tools.ietf.org/html/draft-smith-vxlan-group-policy">
700 VXLAN Group Policy </ulink> document. Defaults to false.</para>
701 </listitem>
702 </varlistentry>
703 <varlistentry>
704 <term><varname>GenericProtocolExtension=</varname></term>
705 <listitem>
706 <para>Takes a boolean. When true, Generic Protocol Extension extends the existing VXLAN protocol
707 to provide protocol typing, OAM, and versioning capabilities. For details about the VXLAN GPE
708 Header, see the <ulink url="https://tools.ietf.org/html/draft-ietf-nvo3-vxlan-gpe-07">
709 Generic Protocol Extension for VXLAN </ulink> document. If destination port is not specified and
710 Generic Protocol Extension is set then default port of 4790 is used. Defaults to false.</para>
711 </listitem>
712 </varlistentry>
713 <varlistentry>
714 <term><varname>DestinationPort=</varname></term>
715 <listitem>
716 <para>Configures the default destination UDP port. If the destination port is not specified then
717 Linux kernel default will be used. Set to 4789 to get the IANA assigned value.</para>
718 </listitem>
719 </varlistentry>
720 <varlistentry>
721 <term><varname>PortRange=</varname></term>
722 <listitem>
723 <para>Configures the source port range for the VXLAN. The kernel assigns the source UDP port based
724 on the flow to help the receiver to do load balancing. When this option is not set, the normal
725 range of local UDP ports is used.</para>
726 </listitem>
727 </varlistentry>
728 <varlistentry>
729 <term><varname>FlowLabel=</varname></term>
730 <listitem>
731 <para>Specifies the flow label to use in outgoing packets.
732 The valid range is 0-1048575.
733 </para>
734 </listitem>
735 </varlistentry>
736 <varlistentry>
737 <term><varname>IPDoNotFragment=</varname></term>
738 <listitem>
739 <para>Allows setting the IPv4 Do not Fragment (DF) bit in outgoing packets, or to inherit its
740 value from the IPv4 inner header. Takes a boolean value, or <literal>inherit</literal>. Set
741 to <literal>inherit</literal> if the encapsulated protocol is IPv6. When unset, the kernel's
742 default will be used.</para>
743 </listitem>
744 </varlistentry>
745 <varlistentry>
746 <term><varname>Independent=</varname></term>
747 <listitem>
748 <para>Takes a boolean. When true, the vxlan interface is created without any underlying network
749 interface. Defaults to false, which means that a .network file that requests this VXLAN interface
750 using <varname>VXLAN=</varname> is required for the VXLAN to be created.</para>
751 </listitem>
752 </varlistentry>
753 </variablelist>
754 </refsect1>
755
756 <refsect1>
757 <title>[GENEVE] Section Options</title>
758
759 <para>The [GENEVE] section only applies for
760 netdevs of kind <literal>geneve</literal>, and accepts the
761 following keys:</para>
762
763 <variablelist class='network-directives'>
764 <varlistentry>
765 <term><varname>Id=</varname></term>
766 <listitem>
767 <para>Specifies the Virtual Network Identifier (VNI) to use, a number between 0 and 16777215. This
768 field is mandatory.</para>
769 </listitem>
770 </varlistentry>
771 <varlistentry>
772 <term><varname>Remote=</varname></term>
773 <listitem>
774 <para>Specifies the unicast destination IP address to use in outgoing packets.</para>
775 </listitem>
776 </varlistentry>
777 <varlistentry>
778 <term><varname>TOS=</varname></term>
779 <listitem>
780 <para>Specifies the TOS value to use in outgoing packets. Takes a number between 1 and 255.</para>
781 </listitem>
782 </varlistentry>
783 <varlistentry>
784 <term><varname>TTL=</varname></term>
785 <listitem>
786 <para>Accepts the same values as in the [VXLAN] section, except that when unset
787 or set to 0, the kernel's default will be used, meaning that packet TTL will be set from
788 <filename>/proc/sys/net/ipv4/ip_default_ttl</filename>.</para>
789 </listitem>
790 </varlistentry>
791 <varlistentry>
792 <term><varname>UDPChecksum=</varname></term>
793 <listitem>
794 <para>Takes a boolean. When true, specifies that UDP checksum is calculated for transmitted packets
795 over IPv4.</para>
796 </listitem>
797 </varlistentry>
798 <varlistentry>
799 <term><varname>UDP6ZeroChecksumTx=</varname></term>
800 <listitem>
801 <para>Takes a boolean. When true, skip UDP checksum calculation for transmitted packets over IPv6.</para>
802 </listitem>
803 </varlistentry>
804 <varlistentry>
805 <term><varname>UDP6ZeroChecksumRx=</varname></term>
806 <listitem>
807 <para>Takes a boolean. When true, allows incoming UDP packets over IPv6 with zero checksum field.</para>
808 </listitem>
809 </varlistentry>
810 <varlistentry>
811 <term><varname>DestinationPort=</varname></term>
812 <listitem>
813 <para>Specifies destination port. Defaults to 6081. If not set or assigned the empty string, the default
814 port of 6081 is used.</para>
815 </listitem>
816 </varlistentry>
817 <varlistentry>
818 <term><varname>FlowLabel=</varname></term>
819 <listitem>
820 <para>Specifies the flow label to use in outgoing packets.</para>
821 </listitem>
822 </varlistentry>
823 <varlistentry>
824 <term><varname>IPDoNotFragment=</varname></term>
825 <listitem>
826 <para>Accepts the same key as in [VXLAN] section.</para>
827 </listitem>
828 </varlistentry>
829 </variablelist>
830 </refsect1>
831
832 <refsect1>
833 <title>[BareUDP] Section Options</title>
834
835 <para>The [BareUDP] section only applies for
836 netdevs of kind <literal>bareudp</literal>, and accepts the
837 following keys:</para>
838
839 <variablelist class='network-directives'>
840 <varlistentry>
841 <term><varname>DestinationPort=</varname></term>
842 <listitem>
843 <para>Specifies the destination UDP port (in range 1…65535). This is mandatory.</para>
844 </listitem>
845 </varlistentry>
846
847 <varlistentry>
848 <term><varname>EtherType=</varname></term>
849 <listitem>
850 <para>Specifies the L3 protocol. Takes one of <literal>ipv4</literal>, <literal>ipv6</literal>, <literal>mpls-uc</literal>
851 or <literal>mpls-mc</literal>. This is mandatory.</para>
852 </listitem>
853 </varlistentry>
854 </variablelist>
855 </refsect1>
856
857 <refsect1>
858 <title>[L2TP] Section Options</title>
859
860 <para>The [L2TP] section only applies for
861 netdevs of kind <literal>l2tp</literal>, and accepts the
862 following keys:</para>
863
864 <variablelist class='network-directives'>
865 <varlistentry>
866 <term><varname>TunnelId=</varname></term>
867 <listitem>
868 <para>Specifies the tunnel identifier. Takes an number in the range 1…4294967295. The value used
869 must match the <literal>PeerTunnelId=</literal> value being used at the peer. This setting is
870 compulsory.</para>
871 </listitem>
872 </varlistentry>
873 <varlistentry>
874 <term><varname>PeerTunnelId=</varname></term>
875 <listitem>
876 <para>Specifies the peer tunnel id. Takes a number in the range 1…4294967295. The value used must
877 match the <literal>TunnelId=</literal> value being used at the peer. This setting is compulsory.
878 </para>
879 </listitem>
880 </varlistentry>
881 <varlistentry>
882 <term><varname>Remote=</varname></term>
883 <listitem>
884 <para>Specifies the IP address of the remote peer. This setting is compulsory.</para>
885 </listitem>
886 </varlistentry>
887 <varlistentry>
888 <term><varname>Local=</varname></term>
889 <listitem>
890 <para>Specifies the IP address of a local interface. Takes an IP address, or the special
891 values <literal>auto</literal>, <literal>static</literal>, or <literal>dynamic</literal>.
892 Optionally a name of a local interface can be specified after <literal>@</literal>, e.g.
893 <literal>192.168.0.1@eth0</literal> or <literal>auto@eth0</literal>. When an address is
894 specified, then a local or specified interface must have the address, and the remote address
895 must be accessible through the local address. If <literal>auto</literal>, then one of the
896 addresses on a local or specified interface which is accessible to the remote address will be
897 used. Similarly, if <literal>static</literal> or <literal>dynamic</literal> is set, then one
898 of the static or dynamic addresses will be used. Defaults to <literal>auto</literal>.</para>
899 </listitem>
900 </varlistentry>
901 <varlistentry>
902 <term><varname>EncapsulationType=</varname></term>
903 <listitem>
904 <para>Specifies the encapsulation type of the tunnel. Takes one of <literal>udp</literal> or
905 <literal>ip</literal>.</para>
906 </listitem>
907 </varlistentry>
908 <varlistentry>
909 <term><varname>UDPSourcePort=</varname></term>
910 <listitem>
911 <para>Specifies the UDP source port to be used for the tunnel. When UDP encapsulation is selected
912 it's mandatory. Ignored when IP encapsulation is selected.</para>
913 </listitem>
914 </varlistentry>
915 <varlistentry>
916 <term><varname>UDPDestinationPort=</varname></term>
917 <listitem>
918 <para>Specifies destination port. When UDP encapsulation is selected it's mandatory. Ignored when IP
919 encapsulation is selected.</para>
920 </listitem>
921 </varlistentry>
922 <varlistentry>
923 <term><varname>UDPChecksum=</varname></term>
924 <listitem>
925 <para>Takes a boolean. When true, specifies that UDP checksum is calculated for transmitted packets
926 over IPv4.</para>
927 </listitem>
928 </varlistentry>
929 <varlistentry>
930 <term><varname>UDP6ZeroChecksumTx=</varname></term>
931 <listitem>
932 <para>Takes a boolean. When true, skip UDP checksum calculation for transmitted packets over IPv6.</para>
933 </listitem>
934 </varlistentry>
935 <varlistentry>
936 <term><varname>UDP6ZeroChecksumRx=</varname></term>
937 <listitem>
938 <para>Takes a boolean. When true, allows incoming UDP packets over IPv6 with zero checksum field.</para>
939 </listitem>
940 </varlistentry>
941 </variablelist>
942 </refsect1>
943
944 <refsect1>
945 <title>[L2TPSession] Section Options</title>
946
947 <para>The [L2TPSession] section only applies for
948 netdevs of kind <literal>l2tp</literal>, and accepts the
949 following keys:</para>
950 <variablelist class='network-directives'>
951 <varlistentry>
952 <term><varname>Name=</varname></term>
953 <listitem>
954 <para>Specifies the name of the session. This setting is compulsory.</para>
955 </listitem>
956 </varlistentry>
957 <varlistentry>
958 <term><varname>SessionId=</varname></term>
959 <listitem>
960 <para>Specifies the session identifier. Takes an number in the range 1…4294967295. The value used
961 must match the <literal>SessionId=</literal> value being used at the peer. This setting is
962 compulsory.</para>
963 </listitem>
964 </varlistentry>
965 <varlistentry>
966 <term><varname>PeerSessionId=</varname></term>
967 <listitem>
968 <para>Specifies the peer session identifier. Takes an number in the range 1…4294967295.
969 The value used must match the <literal>PeerSessionId=</literal> value being used at the peer.
970 This setting is compulsory.</para>
971 </listitem>
972 </varlistentry>
973 <varlistentry>
974 <term><varname>Layer2SpecificHeader=</varname></term>
975 <listitem>
976 <para>Specifies layer2specific header type of the session. One of <literal>none</literal> or <literal>default</literal>. Defaults to <literal>default</literal>.</para>
977 </listitem>
978 </varlistentry>
979 </variablelist>
980 </refsect1>
981
982 <refsect1>
983 <title>[MACsec] Section Options</title>
984
985 <para>The [MACsec] section only applies for network devices of kind
986 <literal>macsec</literal>, and accepts the following keys:</para>
987
988 <variablelist class='network-directives'>
989 <varlistentry>
990 <term><varname>Port=</varname></term>
991 <listitem>
992 <para>Specifies the port to be used for the MACsec transmit channel. The port is used to make
993 secure channel identifier (SCI). Takes a value between 1 and 65535. Defaults to unset.
994 </para>
995 </listitem>
996 </varlistentry>
997 <varlistentry>
998 <term><varname>Encrypt=</varname></term>
999 <listitem>
1000 <para>Takes a boolean. When true, enable encryption. Defaults to unset.</para>
1001 </listitem>
1002 </varlistentry>
1003 </variablelist>
1004 </refsect1>
1005
1006 <refsect1>
1007 <title>[MACsecReceiveChannel] Section Options</title>
1008 <para>The [MACsecReceiveChannel] section only applies for network devices of
1009 kind <literal>macsec</literal>, and accepts the following keys:</para>
1010
1011 <variablelist class='network-directives'>
1012 <varlistentry>
1013 <term><varname>Port=</varname></term>
1014 <listitem>
1015 <para>Specifies the port to be used for the MACsec receive channel. The port is used to make
1016 secure channel identifier (SCI). Takes a value between 1 and 65535. This option is
1017 compulsory, and is not set by default.</para>
1018 </listitem>
1019 </varlistentry>
1020 <varlistentry>
1021 <term><varname>MACAddress=</varname></term>
1022 <listitem>
1023 <para>Specifies the MAC address to be used for the MACsec receive channel. The MAC address
1024 used to make secure channel identifier (SCI). This setting is compulsory, and is not set by
1025 default.</para>
1026 </listitem>
1027 </varlistentry>
1028 </variablelist>
1029 </refsect1>
1030
1031 <refsect1>
1032 <title>[MACsecTransmitAssociation] Section Options</title>
1033
1034 <para>The [MACsecTransmitAssociation] section only applies for network devices
1035 of kind <literal>macsec</literal>, and accepts the following keys:</para>
1036
1037 <variablelist class='network-directives'>
1038 <varlistentry>
1039 <term><varname>PacketNumber=</varname></term>
1040 <listitem>
1041 <para>Specifies the packet number to be used for replay protection and the construction of
1042 the initialization vector (along with the secure channel identifier [SCI]). Takes a value
1043 between 1-4,294,967,295. Defaults to unset.
1044 </para>
1045 </listitem>
1046 </varlistentry>
1047 <varlistentry>
1048 <term><varname>KeyId=</varname></term>
1049 <listitem>
1050 <para>Specifies the identification for the key. Takes a number between 0-255. This option
1051 is compulsory, and is not set by default.</para>
1052 </listitem>
1053 </varlistentry>
1054 <varlistentry>
1055 <term><varname>Key=</varname></term>
1056 <listitem>
1057 <para>Specifies the encryption key used in the transmission channel. The same key must be
1058 configured on the peer’s matching receive channel. This setting is compulsory, and is not set
1059 by default. Takes a 128-bit key encoded in a hexadecimal string, for example
1060 <literal>dffafc8d7b9a43d5b9a3dfbbf6a30c16</literal>.</para>
1061 </listitem>
1062 </varlistentry>
1063 <varlistentry>
1064 <term><varname>KeyFile=</varname></term>
1065 <listitem>
1066 <para>Takes an absolute path to a file which contains a 128-bit key encoded in a hexadecimal string,
1067 which will be used in the transmission channel. When this option is specified,
1068 <varname>Key=</varname> is ignored. Note that the file must be readable by the user
1069 <literal>systemd-network</literal>, so it should be, e.g., owned by
1070 <literal>root:systemd-network</literal> with a <literal>0640</literal> file mode. If the path
1071 refers to an <constant>AF_UNIX</constant> stream socket in the file system a connection is made to
1072 it and the key read from it.</para>
1073 </listitem>
1074 </varlistentry>
1075 <varlistentry>
1076 <term><varname>Activate=</varname></term>
1077 <listitem>
1078 <para>Takes a boolean. If enabled, then the security association is activated. Defaults to
1079 unset.</para>
1080 </listitem>
1081 </varlistentry>
1082 <varlistentry>
1083 <term><varname>UseForEncoding=</varname></term>
1084 <listitem>
1085 <para>Takes a boolean. If enabled, then the security association is used for encoding. Only
1086 one [MACsecTransmitAssociation] section can enable this option. When enabled,
1087 <varname>Activate=yes</varname> is implied. Defaults to unset.</para>
1088 </listitem>
1089 </varlistentry>
1090 </variablelist>
1091 </refsect1>
1092
1093 <refsect1>
1094 <title>[MACsecReceiveAssociation] Section Options</title>
1095
1096 <para>The [MACsecReceiveAssociation] section only applies for
1097 network devices of kind <literal>macsec</literal>, and accepts the
1098 following keys:</para>
1099
1100 <variablelist class='network-directives'>
1101 <varlistentry>
1102 <term><varname>Port=</varname></term>
1103 <listitem>
1104 <para>Accepts the same key as in [MACsecReceiveChannel] section.</para>
1105 </listitem>
1106 </varlistentry>
1107 <varlistentry>
1108 <term><varname>MACAddress=</varname></term>
1109 <listitem>
1110 <para>Accepts the same key as in [MACsecReceiveChannel] section.</para>
1111 </listitem>
1112 </varlistentry>
1113 <varlistentry>
1114 <term><varname>PacketNumber=</varname></term>
1115 <listitem>
1116 <para>Accepts the same key as in [MACsecTransmitAssociation] section.</para>
1117 </listitem>
1118 </varlistentry>
1119 <varlistentry>
1120 <term><varname>KeyId=</varname></term>
1121 <listitem>
1122 <para>Accepts the same key as in [MACsecTransmitAssociation] section.</para>
1123 </listitem>
1124 </varlistentry>
1125 <varlistentry>
1126 <term><varname>Key=</varname></term>
1127 <listitem>
1128 <para>Accepts the same key as in [MACsecTransmitAssociation] section.</para>
1129 </listitem>
1130 </varlistentry>
1131 <varlistentry>
1132 <term><varname>KeyFile=</varname></term>
1133 <listitem>
1134 <para>Accepts the same key as in [MACsecTransmitAssociation] section.</para>
1135 </listitem>
1136 </varlistentry>
1137 <varlistentry>
1138 <term><varname>Activate=</varname></term>
1139 <listitem>
1140 <para>Accepts the same key as in [MACsecTransmitAssociation] section.</para>
1141 </listitem>
1142 </varlistentry>
1143 </variablelist>
1144 </refsect1>
1145
1146 <refsect1>
1147 <title>[Tunnel] Section Options</title>
1148
1149 <para>The [Tunnel] section only applies for
1150 netdevs of kind
1151 <literal>ipip</literal>,
1152 <literal>sit</literal>,
1153 <literal>gre</literal>,
1154 <literal>gretap</literal>,
1155 <literal>ip6gre</literal>,
1156 <literal>ip6gretap</literal>,
1157 <literal>vti</literal>,
1158 <literal>vti6</literal>,
1159 <literal>ip6tnl</literal>, and
1160 <literal>erspan</literal> and accepts
1161 the following keys:</para>
1162
1163 <variablelist class='network-directives'>
1164 <varlistentry>
1165 <term><varname>External=</varname></term>
1166 <listitem>
1167 <para>Takes a boolean value. When true, then the tunnel is externally controlled, which is
1168 also known as collect metadata mode, and most settings below like <varname>Local=</varname>
1169 or <varname>Remote=</varname> are ignored. This implies <varname>Independent=</varname>.
1170 Defaults to false.</para>
1171 </listitem>
1172 </varlistentry>
1173 <varlistentry>
1174 <term><varname>Local=</varname></term>
1175 <listitem>
1176 <para>A static local address for tunneled packets. It must be an address on another interface
1177 of this host, or one of the special values <literal>any</literal>,
1178 <literal>ipv4_link_local</literal>, <literal>ipv6_link_local</literal>,
1179 <literal>dhcp4</literal>, <literal>dhcp6</literal>, and <literal>slaac</literal>. If one
1180 of the special values except for <literal>any</literal> is specified, an address which
1181 matches the corresponding type on the underlying interface will be used. Defaults to
1182 <literal>any</literal>.</para>
1183 </listitem>
1184 </varlistentry>
1185 <varlistentry>
1186 <term><varname>Remote=</varname></term>
1187 <listitem>
1188 <para>The remote endpoint of the tunnel. Takes an IP address or the special value
1189 <literal>any</literal>.</para>
1190 </listitem>
1191 </varlistentry>
1192 <varlistentry>
1193 <term><varname>TOS=</varname></term>
1194 <listitem>
1195 <para>The Type Of Service byte value for a tunnel interface.
1196 For details about the TOS, see the
1197 <ulink url="http://tools.ietf.org/html/rfc1349"> Type of
1198 Service in the Internet Protocol Suite </ulink> document.
1199 </para>
1200 </listitem>
1201 </varlistentry>
1202 <varlistentry>
1203 <term><varname>TTL=</varname></term>
1204 <listitem>
1205 <para>A fixed Time To Live N on tunneled packets. N is a
1206 number in the range 1…255. 0 is a special value meaning that
1207 packets inherit the TTL value. The default value for IPv4
1208 tunnels is 0 (inherit). The default value for IPv6 tunnels is
1209 64.</para>
1210 </listitem>
1211 </varlistentry>
1212 <varlistentry>
1213 <term><varname>DiscoverPathMTU=</varname></term>
1214 <listitem>
1215 <para>Takes a boolean. When true, enables Path MTU Discovery on
1216 the tunnel.</para>
1217 </listitem>
1218 </varlistentry>
1219 <varlistentry>
1220 <term><varname>IPv6FlowLabel=</varname></term>
1221 <listitem>
1222 <para>Configures the 20-bit flow label (see <ulink url="https://tools.ietf.org/html/rfc6437">
1223 RFC 6437</ulink>) field in the IPv6 header (see <ulink url="https://tools.ietf.org/html/rfc2460">
1224 RFC 2460</ulink>), which is used by a node to label packets of a flow.
1225 It is only used for IPv6 tunnels.
1226 A flow label of zero is used to indicate packets that have
1227 not been labeled.
1228 It can be configured to a value in the range 0…0xFFFFF, or be
1229 set to <literal>inherit</literal>, in which case the original flowlabel is used.</para>
1230 </listitem>
1231 </varlistentry>
1232 <varlistentry>
1233 <term><varname>CopyDSCP=</varname></term>
1234 <listitem>
1235 <para>Takes a boolean. When true, the Differentiated Service Code
1236 Point (DSCP) field will be copied to the inner header from
1237 outer header during the decapsulation of an IPv6 tunnel
1238 packet. DSCP is a field in an IP packet that enables different
1239 levels of service to be assigned to network traffic.
1240 Defaults to <literal>no</literal>.
1241 </para>
1242 </listitem>
1243 </varlistentry>
1244 <varlistentry>
1245 <term><varname>EncapsulationLimit=</varname></term>
1246 <listitem>
1247 <para>The Tunnel Encapsulation Limit option specifies how many additional
1248 levels of encapsulation are permitted to be prepended to the packet.
1249 For example, a Tunnel Encapsulation Limit option containing a limit
1250 value of zero means that a packet carrying that option may not enter
1251 another tunnel before exiting the current tunnel.
1252 (see <ulink url="https://tools.ietf.org/html/rfc2473#section-4.1.1"> RFC 2473</ulink>).
1253 The valid range is 0…255 and <literal>none</literal>. Defaults to 4.
1254 </para>
1255 </listitem>
1256 </varlistentry>
1257 <varlistentry>
1258 <term><varname>Key=</varname></term>
1259 <listitem>
1260 <para>The <varname>Key=</varname> parameter specifies the same key to use in
1261 both directions (<varname>InputKey=</varname> and <varname>OutputKey=</varname>).
1262 The <varname>Key=</varname> is either a number or an IPv4 address-like dotted quad.
1263 It is used as mark-configured SAD/SPD entry as part of the lookup key (both in data
1264 and control path) in IP XFRM (framework used to implement IPsec protocol).
1265 See <ulink url="https://man7.org/linux/man-pages/man8/ip-xfrm.8.html">
1266 ip-xfrm — transform configuration</ulink> for details. It is only used for VTI/VTI6,
1267 GRE, GRETAP, and ERSPAN tunnels.</para>
1268 </listitem>
1269 </varlistentry>
1270 <varlistentry>
1271 <term><varname>InputKey=</varname></term>
1272 <listitem>
1273 <para>The <varname>InputKey=</varname> parameter specifies the key to use for input.
1274 The format is same as <varname>Key=</varname>. It is only used for VTI/VTI6, GRE, GRETAP,
1275 and ERSPAN tunnels.</para>
1276 </listitem>
1277 </varlistentry>
1278 <varlistentry>
1279 <term><varname>OutputKey=</varname></term>
1280 <listitem>
1281 <para>The <varname>OutputKey=</varname> parameter specifies the key to use for output.
1282 The format is same as <varname>Key=</varname>. It is only used for VTI/VTI6, GRE, GRETAP,
1283 and ERSPAN tunnels.</para>
1284 </listitem>
1285 </varlistentry>
1286 <varlistentry>
1287 <term><varname>Mode=</varname></term>
1288 <listitem>
1289 <para>An <literal>ip6tnl</literal> tunnel can be in one of three
1290 modes
1291 <literal>ip6ip6</literal> for IPv6 over IPv6,
1292 <literal>ipip6</literal> for IPv4 over IPv6 or
1293 <literal>any</literal> for either.
1294 </para>
1295 </listitem>
1296 </varlistentry>
1297 <varlistentry>
1298 <term><varname>Independent=</varname></term>
1299 <listitem>
1300 <para>Takes a boolean. When false (the default), the tunnel is always created over some network
1301 device, and a .network file that requests this tunnel using <varname>Tunnel=</varname> is required
1302 for the tunnel to be created. When true, the tunnel is created independently of any network as
1303 "tunnel@NONE".</para>
1304 </listitem>
1305 </varlistentry>
1306 <varlistentry>
1307 <term><varname>AssignToLoopback=</varname></term>
1308 <listitem>
1309 <para>Takes a boolean. If set to <literal>yes</literal>, the loopback interface <literal>lo</literal>
1310 is used as the underlying device of the tunnel interface. Defaults to <literal>no</literal>.</para>
1311 </listitem>
1312 </varlistentry>
1313 <varlistentry>
1314 <term><varname>AllowLocalRemote=</varname></term>
1315 <listitem>
1316 <para>Takes a boolean. When true allows tunnel traffic on <varname>ip6tnl</varname> devices where the remote endpoint is a local host address.
1317 When unset, the kernel's default will be used.
1318 </para>
1319 </listitem>
1320 </varlistentry>
1321 <varlistentry>
1322 <term><varname>FooOverUDP=</varname></term>
1323 <listitem>
1324 <para>Takes a boolean. Specifies whether <varname>FooOverUDP=</varname> tunnel is to be configured.
1325 Defaults to false. This takes effects only for IPIP, SIT, GRE, and GRETAP tunnels.
1326 For more detail information see
1327 <ulink url="https://lwn.net/Articles/614348">Foo over UDP</ulink></para>
1328 </listitem>
1329 </varlistentry>
1330 <varlistentry>
1331 <term><varname>FOUDestinationPort=</varname></term>
1332 <listitem>
1333 <para>This setting specifies the UDP destination port for encapsulation.
1334 This field is mandatory when <varname>FooOverUDP=yes</varname>, and is not set by default.</para>
1335 </listitem>
1336 </varlistentry>
1337 <varlistentry>
1338 <term><varname>FOUSourcePort=</varname></term>
1339 <listitem>
1340 <para>This setting specifies the UDP source port for encapsulation. Defaults to <constant>0</constant>
1341 — that is, the source port for packets is left to the network stack to decide.</para>
1342 </listitem>
1343 </varlistentry>
1344 <varlistentry>
1345 <term><varname>Encapsulation=</varname></term>
1346 <listitem>
1347 <para>Accepts the same key as in the [FooOverUDP] section.</para>
1348 </listitem>
1349 </varlistentry>
1350 <varlistentry>
1351 <term><varname>IPv6RapidDeploymentPrefix=</varname></term>
1352 <listitem>
1353 <para>Reconfigure the tunnel for <ulink url="https://tools.ietf.org/html/rfc5569">IPv6 Rapid
1354 Deployment</ulink>, also known as 6rd. The value is an ISP-specific IPv6 prefix with a non-zero length. Only
1355 applicable to SIT tunnels.</para>
1356 </listitem>
1357 </varlistentry>
1358 <varlistentry>
1359 <term><varname>ISATAP=</varname></term>
1360 <listitem>
1361 <para>Takes a boolean. If set, configures the tunnel as Intra-Site Automatic Tunnel Addressing Protocol (ISATAP) tunnel.
1362 Only applicable to SIT tunnels. When unset, the kernel's default will be used.</para>
1363 </listitem>
1364 </varlistentry>
1365 <varlistentry>
1366 <term><varname>SerializeTunneledPackets=</varname></term>
1367 <listitem>
1368 <para>Takes a boolean. If set to yes, then packets are serialized. Only applies for GRE,
1369 GRETAP, and ERSPAN tunnels. When unset, the kernel's default will be used.
1370 </para>
1371 </listitem>
1372 </varlistentry>
1373 <varlistentry>
1374 <term><varname>ERSPANVersion=</varname></term>
1375 <listitem>
1376 <para>Specifies the ERSPAN version number. Takes 0 for version 0 (a.k.a. type I), 1 for version 1
1377 (a.k.a. type II), or 2 for version 2 (a.k.a. type III). Defaults to 1.</para>
1378 </listitem>
1379 </varlistentry>
1380 <varlistentry>
1381 <term><varname>ERSPANIndex=</varname></term>
1382 <listitem>
1383 <para>Specifies the ERSPAN v1 index field for the interface. Takes an integer in the range
1384 0…1048575, which is associated with the ERSPAN traffic's source port and direction. Only used when
1385 <varname>ERSPANVersion=1</varname>. Defaults to 0.</para>
1386 </listitem>
1387 </varlistentry>
1388 <varlistentry>
1389 <term><varname>ERSPANDirection=</varname></term>
1390 <listitem>
1391 <para>Specifies the ERSPAN v2 mirrored traffic's direction. Takes <literal>ingress</literal> or
1392 <literal>egress</literal>. Only used when <varname>ERSPANVersion=2</varname>. Defaults to
1393 <literal>ingress</literal>.</para>
1394 </listitem>
1395 </varlistentry>
1396 <varlistentry>
1397 <term><varname>ERSPANHardwareId=</varname></term>
1398 <listitem>
1399 <para>Specifies an unique identifier of the ERSPAN v2 engine. Takes an integer in the range 0…63.
1400 Only used when <varname>ERSPANVersion=2</varname>. Defaults to 0.</para>
1401 </listitem>
1402 </varlistentry>
1403 </variablelist>
1404 </refsect1>
1405
1406 <refsect1>
1407 <title>[FooOverUDP] Section Options</title>
1408
1409 <para>The [FooOverUDP] section only applies for
1410 netdevs of kind <literal>fou</literal> and accepts the
1411 following keys:</para>
1412
1413 <variablelist class='network-directives'>
1414 <varlistentry>
1415 <term><varname>Encapsulation=</varname></term>
1416 <listitem>
1417 <para>Specifies the encapsulation mechanism used to store networking packets of various protocols
1418 inside the UDP packets. Supports the following values:
1419
1420 <literal>FooOverUDP</literal> provides the simplest no-frills model of UDP encapsulation, it simply
1421 encapsulates packets directly in the UDP payload. <literal>GenericUDPEncapsulation</literal> is a
1422 generic and extensible encapsulation, it allows encapsulation of packets for any IP protocol and
1423 optional data as part of the encapsulation. For more detailed information see <ulink
1424 url="https://lwn.net/Articles/615044">Generic UDP Encapsulation</ulink>. Defaults to
1425 <literal>FooOverUDP</literal>.
1426 </para>
1427 </listitem>
1428 </varlistentry>
1429 <varlistentry>
1430 <term><varname>Port=</varname></term>
1431 <listitem>
1432 <para>Specifies the port number where the encapsulated packets will arrive. Those packets will be
1433 removed and manually fed back into the network stack with the encapsulation removed to be sent to
1434 the real destination. This option is mandatory.</para>
1435 </listitem>
1436 </varlistentry>
1437 <varlistentry>
1438 <term><varname>PeerPort=</varname></term>
1439 <listitem>
1440 <para>Specifies the peer port number. Defaults to unset. Note that when peer port is set
1441 <literal>Peer=</literal> address is mandatory.</para>
1442 </listitem>
1443 </varlistentry>
1444 <varlistentry>
1445 <term><varname>Protocol=</varname></term>
1446 <listitem>
1447 <para>The <varname>Protocol=</varname> specifies the protocol number of the packets arriving
1448 at the UDP port. When <varname>Encapsulation=FooOverUDP</varname>, this field is mandatory
1449 and is not set by default. Takes an IP protocol name such as <literal>gre</literal> or
1450 <literal>ipip</literal>, or an integer within the range 1…255. When
1451 <varname>Encapsulation=GenericUDPEncapsulation</varname>, this must not be specified.</para>
1452 </listitem>
1453 </varlistentry>
1454 <varlistentry>
1455 <term><varname>Peer=</varname></term>
1456 <listitem>
1457 <para>Configures peer IP address. Note that when peer address is set <literal>PeerPort=</literal>
1458 is mandatory.</para>
1459 </listitem>
1460 </varlistentry>
1461 <varlistentry>
1462 <term><varname>Local=</varname></term>
1463 <listitem>
1464 <para>Configures local IP address.</para>
1465 </listitem>
1466 </varlistentry>
1467 </variablelist>
1468 </refsect1>
1469
1470 <refsect1>
1471 <title>[Peer] Section Options</title>
1472
1473 <para>The [Peer] section only applies for
1474 netdevs of kind <literal>veth</literal> and accepts the
1475 following keys:</para>
1476
1477 <variablelist class='network-directives'>
1478 <varlistentry>
1479 <term><varname>Name=</varname></term>
1480 <listitem>
1481 <para>The interface name used when creating the netdev.
1482 This setting is compulsory.</para>
1483 </listitem>
1484 </varlistentry>
1485 <varlistentry>
1486 <term><varname>MACAddress=</varname></term>
1487 <listitem>
1488 <para>The peer MACAddress, if not set, it is generated in
1489 the same way as the MAC address of the main
1490 interface.</para>
1491 </listitem>
1492 </varlistentry>
1493 </variablelist>
1494 </refsect1>
1495
1496 <refsect1>
1497 <title>[VXCAN] Section Options</title>
1498
1499 <para>The [VXCAN] section only applies for
1500 netdevs of kind <literal>vxcan</literal> and accepts the
1501 following key:</para>
1502
1503 <variablelist class='network-directives'>
1504 <varlistentry>
1505 <term><varname>Peer=</varname></term>
1506 <listitem>
1507 <para>The peer interface name used when creating the netdev.
1508 This setting is compulsory.</para>
1509 </listitem>
1510 </varlistentry>
1511 </variablelist>
1512 </refsect1>
1513
1514 <refsect1>
1515 <title>[Tun] Section Options</title>
1516
1517 <para>The [Tun] section only applies for
1518 netdevs of kind <literal>tun</literal>, and accepts the following
1519 keys:</para>
1520
1521 <variablelist class='network-directives'>
1522 <varlistentry>
1523 <term><varname>MultiQueue=</varname></term>
1524 <listitem><para>Takes a boolean. Configures whether
1525 to use multiple file descriptors (queues) to parallelize
1526 packets sending and receiving. Defaults to
1527 <literal>no</literal>.</para>
1528 </listitem>
1529 </varlistentry>
1530 <varlistentry>
1531 <term><varname>PacketInfo=</varname></term>
1532 <listitem><para>Takes a boolean. Configures whether
1533 packets should be prepended with four extra bytes (two flag
1534 bytes and two protocol bytes). If disabled, it indicates that
1535 the packets will be pure IP packets. Defaults to
1536 <literal>no</literal>.</para>
1537 </listitem>
1538 </varlistentry>
1539 <varlistentry>
1540 <term><varname>VNetHeader=</varname></term>
1541 <listitem><para>Takes a boolean. Configures
1542 IFF_VNET_HDR flag for a tun or tap device. It allows sending
1543 and receiving larger Generic Segmentation Offload (GSO)
1544 packets. This may increase throughput significantly.
1545 Defaults to
1546 <literal>no</literal>.</para>
1547 </listitem>
1548 </varlistentry>
1549 <varlistentry>
1550 <term><varname>User=</varname></term>
1551 <listitem><para>User to grant access to the
1552 <filename>/dev/net/tun</filename> device.</para>
1553 </listitem>
1554 </varlistentry>
1555 <varlistentry>
1556 <term><varname>Group=</varname></term>
1557 <listitem><para>Group to grant access to the
1558 <filename>/dev/net/tun</filename> device.</para>
1559 </listitem>
1560 </varlistentry>
1561 <varlistentry>
1562 <term><varname>KeepCarrier=</varname></term>
1563 <listitem>
1564 <para>Takes a boolean. If enabled, to make the interface maintain its carrier status, the file
1565 descriptor of the interface is kept open. This may be useful to keep the interface in running
1566 state, for example while the backing process is temporarily shutdown. Defaults to
1567 <literal>no</literal>.</para>
1568 </listitem>
1569 </varlistentry>
1570 </variablelist>
1571 </refsect1>
1572
1573 <refsect1>
1574 <title>[Tap] Section Options</title>
1575
1576 <para>The [Tap] section only applies for
1577 netdevs of kind <literal>tap</literal>, and accepts the same keys
1578 as the [Tun] section.</para>
1579 </refsect1>
1580
1581 <refsect1>
1582 <title>[WireGuard] Section Options</title>
1583
1584 <para>The [WireGuard] section accepts the following
1585 keys:</para>
1586
1587 <variablelist class='network-directives'>
1588 <varlistentry>
1589 <term><varname>PrivateKey=</varname></term>
1590 <listitem>
1591 <para>The Base64 encoded private key for the interface. It can be
1592 generated using the <command>wg genkey</command> command
1593 (see <citerefentry project="wireguard"><refentrytitle>wg</refentrytitle><manvolnum>8</manvolnum></citerefentry>).
1594 This option or <varname>PrivateKeyFile=</varname> is mandatory to use WireGuard.
1595 Note that because this information is secret, you may want to set
1596 the permissions of the .netdev file to be owned by <literal>root:systemd-network</literal>
1597 with a <literal>0640</literal> file mode.</para>
1598 </listitem>
1599 </varlistentry>
1600 <varlistentry>
1601 <term><varname>PrivateKeyFile=</varname></term>
1602 <listitem>
1603 <para>Takes an absolute path to a file which contains the Base64 encoded private key for the
1604 interface. When this option is specified, then <varname>PrivateKey=</varname> is ignored. Note
1605 that the file must be readable by the user <literal>systemd-network</literal>, so it should be,
1606 e.g., owned by <literal>root:systemd-network</literal> with a <literal>0640</literal> file mode. If
1607 the path refers to an <constant>AF_UNIX</constant> stream socket in the file system a connection is
1608 made to it and the key read from it.</para>
1609 </listitem>
1610 </varlistentry>
1611 <varlistentry>
1612 <term><varname>ListenPort=</varname></term>
1613 <listitem>
1614 <para>Sets UDP port for listening. Takes either value between 1 and 65535
1615 or <literal>auto</literal>. If <literal>auto</literal> is specified,
1616 the port is automatically generated based on interface name.
1617 Defaults to <literal>auto</literal>.</para>
1618 </listitem>
1619 </varlistentry>
1620 <varlistentry>
1621 <term><varname>FirewallMark=</varname></term>
1622 <listitem>
1623 <para>Sets a firewall mark on outgoing WireGuard packets from this interface. Takes a number between 1 and 4294967295.</para>
1624 </listitem>
1625 </varlistentry>
1626 <varlistentry>
1627 <term><varname>RouteTable=</varname></term>
1628 <listitem>
1629 <para>The table identifier for the routes to the addresses specified in the
1630 <varname>AllowedIPs=</varname>. Takes a negative boolean value, one of the predefined names
1631 <literal>default</literal>, <literal>main</literal>, and <literal>local</literal>, names
1632 defined in <varname>RouteTable=</varname> in
1633 <citerefentry><refentrytitle>networkd.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
1634 or a number in the range 1…4294967295. When <literal>off</literal> the routes to the
1635 addresses specified in the <varname>AllowedIPs=</varname> setting will not be configured.
1636 Defaults to false. This setting will be ignored when the same setting is specified in the
1637 [WireGuardPeer] section.</para>
1638 </listitem>
1639 </varlistentry>
1640 <varlistentry>
1641 <term><varname>RouteMetric=</varname></term>
1642 <listitem>
1643 <para>The priority of the routes to the addresses specified in the
1644 <varname>AllowedIPs=</varname>. Takes an integer in the range 0…4294967295. Defaults to 0
1645 for IPv4 addresses, and 1024 for IPv6 addresses. This setting will be ignored when the same
1646 setting is specified in the [WireGuardPeer] section.</para>
1647 </listitem>
1648 </varlistentry>
1649 </variablelist>
1650 </refsect1>
1651
1652 <refsect1>
1653 <title>[WireGuardPeer] Section Options</title>
1654
1655 <para>The [WireGuardPeer] section accepts the following
1656 keys:</para>
1657
1658 <variablelist class='network-directives'>
1659 <varlistentry>
1660 <term><varname>PublicKey=</varname></term>
1661 <listitem>
1662 <para>Sets a Base64 encoded public key calculated by <command>wg pubkey</command>
1663 (see <citerefentry project="wireguard"><refentrytitle>wg</refentrytitle><manvolnum>8</manvolnum></citerefentry>)
1664 from a private key, and usually transmitted out of band to the
1665 author of the configuration file. This option is mandatory for this
1666 section.</para>
1667 </listitem>
1668 </varlistentry>
1669 <varlistentry>
1670 <term><varname>PresharedKey=</varname></term>
1671 <listitem>
1672 <para>Optional preshared key for the interface. It can be generated
1673 by the <command>wg genpsk</command> command. This option adds an
1674 additional layer of symmetric-key cryptography to be mixed into the
1675 already existing public-key cryptography, for post-quantum
1676 resistance.
1677 Note that because this information is secret, you may want to set
1678 the permissions of the .netdev file to be owned by <literal>root:systemd-network</literal>
1679 with a <literal>0640</literal> file mode.</para>
1680 </listitem>
1681 </varlistentry>
1682 <varlistentry>
1683 <term><varname>PresharedKeyFile=</varname></term>
1684 <listitem>
1685 <para>Takes an absolute path to a file which contains the Base64 encoded preshared key for the
1686 peer. When this option is specified, then <varname>PresharedKey=</varname> is ignored. Note that
1687 the file must be readable by the user <literal>systemd-network</literal>, so it should be, e.g.,
1688 owned by <literal>root:systemd-network</literal> with a <literal>0640</literal> file mode. If the
1689 path refers to an <constant>AF_UNIX</constant> stream socket in the file system a connection is
1690 made to it and the key read from it.</para>
1691 </listitem>
1692 </varlistentry>
1693 <varlistentry>
1694 <term><varname>AllowedIPs=</varname></term>
1695 <listitem>
1696 <para>Sets a comma-separated list of IP (v4 or v6) addresses with CIDR masks
1697 from which this peer is allowed to send incoming traffic and to
1698 which outgoing traffic for this peer is directed.</para>
1699
1700 <para>The catch-all 0.0.0.0/0 may be specified for matching all IPv4 addresses,
1701 and ::/0 may be specified for matching all IPv6 addresses.</para>
1702
1703 <para>Note that this only affects <emphasis>routing inside the network interface itself</emphasis>,
1704 i.e. the packets that pass through the tunnel itself. To cause packets to be sent via the tunnel in
1705 the first place, an appropriate route needs to be added as well — either in the
1706 <literal>[Routes]</literal> section on the <literal>.network</literal> matching the wireguard
1707 interface, or externally to <filename>systemd-networkd</filename>.</para>
1708 </listitem>
1709 </varlistentry>
1710 <varlistentry>
1711 <term><varname>Endpoint=</varname></term>
1712 <listitem>
1713 <para>Sets an endpoint IP address or hostname, followed by a colon, and then
1714 a port number. This endpoint will be updated automatically once to
1715 the most recent source IP address and port of correctly
1716 authenticated packets from the peer at configuration time.</para>
1717 </listitem>
1718 </varlistentry>
1719 <varlistentry>
1720 <term><varname>PersistentKeepalive=</varname></term>
1721 <listitem>
1722 <para>Sets a seconds interval, between 1 and 65535 inclusive, of how often
1723 to send an authenticated empty packet to the peer for the purpose
1724 of keeping a stateful firewall or NAT mapping valid persistently.
1725 For example, if the interface very rarely sends traffic, but it
1726 might at anytime receive traffic from a peer, and it is behind NAT,
1727 the interface might benefit from having a persistent keepalive
1728 interval of 25 seconds. If set to 0 or "off", this option is
1729 disabled. By default or when unspecified, this option is off.
1730 Most users will not need this.</para>
1731 </listitem>
1732 </varlistentry>
1733 <varlistentry>
1734 <term><varname>RouteTable=</varname></term>
1735 <listitem>
1736 <para>The table identifier for the routes to the addresses specified in the
1737 <varname>AllowedIPs=</varname>. Takes a negative boolean value, one of the predefined names
1738 <literal>default</literal>, <literal>main</literal>, and <literal>local</literal>, names
1739 defined in <varname>RouteTable=</varname> in
1740 <citerefentry><refentrytitle>networkd.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
1741 or a number in the range 1…4294967295. Defaults to unset, and the value specified in the
1742 same setting in the [WireGuard] section will be used.</para>
1743 </listitem>
1744 </varlistentry>
1745 <varlistentry>
1746 <term><varname>RouteMetric=</varname></term>
1747 <listitem>
1748 <para>The priority of the routes to the addresses specified in the
1749 <varname>AllowedIPs=</varname>. Takes an integer in the range 0…4294967295. Defaults to
1750 unset, and the value specified in the same setting in the [WireGuard] section will be used.
1751 </para>
1752 </listitem>
1753 </varlistentry>
1754 </variablelist>
1755 </refsect1>
1756
1757 <refsect1>
1758 <title>[Bond] Section Options</title>
1759
1760 <para>The [Bond] section accepts the following
1761 key:</para>
1762
1763 <variablelist class='network-directives'>
1764 <varlistentry>
1765 <term><varname>Mode=</varname></term>
1766 <listitem>
1767 <para>Specifies one of the bonding policies. The default is
1768 <literal>balance-rr</literal> (round robin). Possible values are
1769 <literal>balance-rr</literal>,
1770 <literal>active-backup</literal>,
1771 <literal>balance-xor</literal>,
1772 <literal>broadcast</literal>,
1773 <literal>802.3ad</literal>,
1774 <literal>balance-tlb</literal>, and
1775 <literal>balance-alb</literal>.
1776 </para>
1777 </listitem>
1778 </varlistentry>
1779
1780 <varlistentry>
1781 <term><varname>TransmitHashPolicy=</varname></term>
1782 <listitem>
1783 <para>Selects the transmit hash policy to use for slave
1784 selection in balance-xor, 802.3ad, and tlb modes. Possible
1785 values are
1786 <literal>layer2</literal>,
1787 <literal>layer3+4</literal>,
1788 <literal>layer2+3</literal>,
1789 <literal>encap2+3</literal>, and
1790 <literal>encap3+4</literal>.
1791 </para>
1792 </listitem>
1793 </varlistentry>
1794
1795 <varlistentry>
1796 <term><varname>LACPTransmitRate=</varname></term>
1797 <listitem>
1798 <para>Specifies the rate with which link partner transmits
1799 Link Aggregation Control Protocol Data Unit packets in
1800 802.3ad mode. Possible values are <literal>slow</literal>,
1801 which requests partner to transmit LACPDUs every 30 seconds,
1802 and <literal>fast</literal>, which requests partner to
1803 transmit LACPDUs every second. The default value is
1804 <literal>slow</literal>.</para>
1805 </listitem>
1806 </varlistentry>
1807
1808 <varlistentry>
1809 <term><varname>MIIMonitorSec=</varname></term>
1810 <listitem>
1811 <para>Specifies the frequency that Media Independent
1812 Interface link monitoring will occur. A value of zero
1813 disables MII link monitoring. This value is rounded down to
1814 the nearest millisecond. The default value is 0.</para>
1815 </listitem>
1816 </varlistentry>
1817
1818 <varlistentry>
1819 <term><varname>UpDelaySec=</varname></term>
1820 <listitem>
1821 <para>Specifies the delay before a link is enabled after a
1822 link up status has been detected. This value is rounded down
1823 to a multiple of <varname>MIIMonitorSec=</varname>. The default value is
1824 0.</para>
1825 </listitem>
1826 </varlistentry>
1827
1828 <varlistentry>
1829 <term><varname>DownDelaySec=</varname></term>
1830 <listitem>
1831 <para>Specifies the delay before a link is disabled after a
1832 link down status has been detected. This value is rounded
1833 down to a multiple of <varname>MIIMonitorSec=</varname>. The default value is
1834 0.</para>
1835 </listitem>
1836 </varlistentry>
1837
1838 <varlistentry>
1839 <term><varname>LearnPacketIntervalSec=</varname></term>
1840 <listitem>
1841 <para>Specifies the number of seconds between instances where the bonding
1842 driver sends learning packets to each slave peer switch.
1843 The valid range is 1…0x7fffffff; the default value is 1. This option
1844 has an effect only for the balance-tlb and balance-alb modes.</para>
1845 </listitem>
1846 </varlistentry>
1847
1848 <varlistentry>
1849 <term><varname>AdSelect=</varname></term>
1850 <listitem>
1851 <para>Specifies the 802.3ad aggregation selection logic to use. Possible values are
1852 <literal>stable</literal>,
1853 <literal>bandwidth</literal> and
1854 <literal>count</literal>.
1855 </para>
1856 </listitem>
1857 </varlistentry>
1858
1859 <varlistentry>
1860 <term><varname>AdActorSystemPriority=</varname></term>
1861 <listitem>
1862 <para>Specifies the 802.3ad actor system priority. Takes a number in the range 1…65535.</para>
1863 </listitem>
1864 </varlistentry>
1865
1866 <varlistentry>
1867 <term><varname>AdUserPortKey=</varname></term>
1868 <listitem>
1869 <para>Specifies the 802.3ad user defined portion of the port key. Takes a number in the range
1870 0…1023.</para>
1871 </listitem>
1872 </varlistentry>
1873
1874 <varlistentry>
1875 <term><varname>AdActorSystem=</varname></term>
1876 <listitem>
1877 <para>Specifies the 802.3ad system MAC address. This cannot be a null or multicast address.
1878 </para>
1879 </listitem>
1880 </varlistentry>
1881
1882 <varlistentry>
1883 <term><varname>FailOverMACPolicy=</varname></term>
1884 <listitem>
1885 <para>Specifies whether the active-backup mode should set all slaves to
1886 the same MAC address at the time of enslavement or, when enabled, to perform special handling of the
1887 bond's MAC address in accordance with the selected policy. The default policy is none.
1888 Possible values are
1889 <literal>none</literal>,
1890 <literal>active</literal> and
1891 <literal>follow</literal>.
1892 </para>
1893 </listitem>
1894 </varlistentry>
1895
1896 <varlistentry>
1897 <term><varname>ARPValidate=</varname></term>
1898 <listitem>
1899 <para>Specifies whether or not ARP probes and replies should be
1900 validated in any mode that supports ARP monitoring, or whether
1901 non-ARP traffic should be filtered (disregarded) for link
1902 monitoring purposes. Possible values are
1903 <literal>none</literal>,
1904 <literal>active</literal>,
1905 <literal>backup</literal> and
1906 <literal>all</literal>.
1907 </para>
1908 </listitem>
1909 </varlistentry>
1910
1911 <varlistentry>
1912 <term><varname>ARPIntervalSec=</varname></term>
1913 <listitem>
1914 <para>Specifies the ARP link monitoring frequency. A value of 0 disables ARP monitoring. The
1915 default value is 0, and the default unit seconds.
1916 </para>
1917 </listitem>
1918 </varlistentry>
1919
1920 <varlistentry>
1921 <term><varname>ARPIPTargets=</varname></term>
1922 <listitem>
1923 <para>Specifies the IP addresses to use as ARP monitoring peers when
1924 <varname>ARPIntervalSec=</varname> is greater than 0. These are the targets of the ARP
1925 request sent to determine the health of the link to the targets.
1926 Specify these values in IPv4 dotted decimal format. At least one IP
1927 address must be given for ARP monitoring to function. The
1928 maximum number of targets that can be specified is 16. The
1929 default value is no IP addresses.
1930 </para>
1931 </listitem>
1932 </varlistentry>
1933
1934 <varlistentry>
1935 <term><varname>ARPAllTargets=</varname></term>
1936 <listitem>
1937 <para>Specifies the quantity of <varname>ARPIPTargets=</varname> that must be reachable
1938 in order for the ARP monitor to consider a slave as being up.
1939 This option affects only active-backup mode for slaves with
1940 ARPValidate enabled. Possible values are
1941 <literal>any</literal> and
1942 <literal>all</literal>.
1943 </para>
1944 </listitem>
1945 </varlistentry>
1946
1947 <varlistentry>
1948 <term><varname>PrimaryReselectPolicy=</varname></term>
1949 <listitem>
1950 <para>Specifies the reselection policy for the primary slave. This
1951 affects how the primary slave is chosen to become the active slave
1952 when failure of the active slave or recovery of the primary slave
1953 occurs. This option is designed to prevent flip-flopping between
1954 the primary slave and other slaves. Possible values are
1955 <literal>always</literal>,
1956 <literal>better</literal> and
1957 <literal>failure</literal>.
1958 </para>
1959 </listitem>
1960 </varlistentry>
1961
1962 <varlistentry>
1963 <term><varname>ResendIGMP=</varname></term>
1964 <listitem>
1965 <para>Specifies the number of IGMP membership reports to be issued after
1966 a failover event. One membership report is issued immediately after
1967 the failover, subsequent packets are sent in each 200ms interval.
1968 The valid range is 0…255. Defaults to 1. A value of 0
1969 prevents the IGMP membership report from being issued in response
1970 to the failover event.
1971 </para>
1972 </listitem>
1973 </varlistentry>
1974
1975 <varlistentry>
1976 <term><varname>PacketsPerSlave=</varname></term>
1977 <listitem>
1978 <para>Specify the number of packets to transmit through a slave before
1979 moving to the next one. When set to 0, then a slave is chosen at
1980 random. The valid range is 0…65535. Defaults to 1. This option
1981 only has effect when in balance-rr mode.
1982 </para>
1983 </listitem>
1984 </varlistentry>
1985
1986 <varlistentry>
1987 <term><varname>GratuitousARP=</varname></term>
1988 <listitem>
1989 <para>Specify the number of peer notifications (gratuitous ARPs and
1990 unsolicited IPv6 Neighbor Advertisements) to be issued after a
1991 failover event. As soon as the link is up on the new slave,
1992 a peer notification is sent on the bonding device and each
1993 VLAN sub-device. This is repeated at each link monitor interval
1994 (ARPIntervalSec or MIIMonitorSec, whichever is active) if the number is
1995 greater than 1. The valid range is 0…255. The default value is 1.
1996 These options affect only the active-backup mode.
1997 </para>
1998 </listitem>
1999 </varlistentry>
2000
2001 <varlistentry>
2002 <term><varname>AllSlavesActive=</varname></term>
2003 <listitem>
2004 <para>Takes a boolean. Specifies that duplicate frames (received on inactive ports)
2005 should be dropped when false, or delivered when true. Normally, bonding will drop
2006 duplicate frames (received on inactive ports), which is desirable for
2007 most users. But there are some times it is nice to allow duplicate
2008 frames to be delivered. The default value is false (drop duplicate frames
2009 received on inactive ports).
2010 </para>
2011 </listitem>
2012 </varlistentry>
2013
2014 <varlistentry>
2015 <term><varname>DynamicTransmitLoadBalancing=</varname></term>
2016 <listitem>
2017 <para>Takes a boolean. Specifies if dynamic shuffling of flows is enabled. Applies only
2018 for balance-tlb mode. Defaults to unset.
2019 </para>
2020 </listitem>
2021 </varlistentry>
2022
2023 <varlistentry>
2024 <term><varname>MinLinks=</varname></term>
2025 <listitem>
2026 <para>Specifies the minimum number of links that must be active before
2027 asserting carrier. The default value is 0.
2028 </para>
2029 </listitem>
2030 </varlistentry>
2031 </variablelist>
2032
2033 <para>For more detail information see
2034 <ulink url="https://docs.kernel.org/networking/bonding.html">
2035 Linux Ethernet Bonding Driver HOWTO</ulink></para>
2036 </refsect1>
2037
2038 <refsect1>
2039 <title>[Xfrm] Section Options</title>
2040
2041 <para>The [Xfrm] section accepts the following
2042 keys:</para>
2043
2044 <variablelist class='network-directives'>
2045 <varlistentry>
2046 <term><varname>InterfaceId=</varname></term>
2047 <listitem>
2048 <para>Sets the ID/key of the xfrm interface which needs to be associated with a SA/policy.
2049 Can be decimal or hexadecimal, valid range is 1-0xffffffff. This is mandatory.</para>
2050 </listitem>
2051 </varlistentry>
2052 <varlistentry>
2053 <term><varname>Independent=</varname></term>
2054 <listitem>
2055 <para>Takes a boolean. If false (the default), the xfrm interface must have an underlying device
2056 which can be used for hardware offloading.</para>
2057 </listitem>
2058 </varlistentry>
2059 </variablelist>
2060
2061 <para>For more detail information see
2062 <ulink url="https://lwn.net/Articles/757391">Virtual XFRM Interfaces</ulink>.</para>
2063 </refsect1>
2064
2065 <refsect1>
2066 <title>[VRF] Section Options</title>
2067 <para>The [VRF] section only applies for
2068 netdevs of kind <literal>vrf</literal> and accepts the
2069 following key:</para>
2070
2071 <variablelist class='network-directives'>
2072 <varlistentry>
2073 <term><varname>Table=</varname></term>
2074 <listitem>
2075 <para>The numeric routing table identifier. This setting is compulsory.</para>
2076 </listitem>
2077 </varlistentry>
2078 </variablelist>
2079 </refsect1>
2080
2081 <refsect1>
2082 <title>[BatmanAdvanced] Section Options</title>
2083
2084 <para>The [BatmanAdvanced] section only applies for netdevs of kind <literal>batadv</literal> and accepts
2085 the following keys:</para>
2086
2087 <variablelist class='network-directives'>
2088 <varlistentry>
2089 <term><varname>GatewayMode=</varname></term>
2090 <listitem>
2091 <para>Takes one of <literal>off</literal>, <literal>server</literal>, or <literal>client</literal>.
2092 A batman-adv node can either run in server mode (sharing its internet
2093 connection with the mesh) or in client mode (searching for the most suitable internet connection
2094 in the mesh) or having the gateway support turned off entirely (which is the default setting).
2095 </para>
2096 </listitem>
2097 </varlistentry>
2098 <varlistentry>
2099 <term><varname>Aggregation=</varname></term>
2100 <listitem>
2101 <para>Takes a boolean value. Enables or disables aggregation of originator messages. Defaults to
2102 true.
2103 </para>
2104 </listitem>
2105 </varlistentry>
2106 <varlistentry>
2107 <term><varname>BridgeLoopAvoidance=</varname></term>
2108 <listitem>
2109 <para>Takes a boolean value. Enables or disables avoidance of loops on bridges. Defaults to true.
2110 </para>
2111 </listitem>
2112 </varlistentry>
2113 <varlistentry>
2114 <term><varname>DistributedArpTable=</varname></term>
2115 <listitem>
2116 <para>Takes a boolean value. Enables or disables the distributed ARP table. Defaults to true.</para>
2117 </listitem>
2118 </varlistentry>
2119 <varlistentry>
2120 <term><varname>Fragmentation=</varname></term>
2121 <listitem>
2122 <para>Takes a boolean value. Enables or disables fragmentation. Defaults to true.</para>
2123 </listitem>
2124 </varlistentry>
2125 <varlistentry>
2126 <term><varname>HopPenalty=</varname></term>
2127 <listitem>
2128 <para>The hop penalty setting allows one to modify
2129 <citerefentry project='mankier'><refentrytitle>batctl</refentrytitle><manvolnum>8</manvolnum></citerefentry>
2130 preference for multihop routes vs. short routes. This integer value is applied to the
2131 TQ (Transmit Quality) of each forwarded OGM (Originator Message), thereby propagating the
2132 cost of an extra hop (the packet has to be received and retransmitted which costs airtime).
2133 A higher hop penalty will make it more unlikely that other nodes will choose this node as
2134 intermediate hop towards any given destination. The default hop penalty of '15' is a reasonable
2135 value for most setups and probably does not need to be changed. However, mobile nodes could
2136 choose a value of 255 (maximum value) to avoid being chosen as a router by other nodes.
2137 The minimum value is 0.
2138 </para>
2139 </listitem>
2140 </varlistentry>
2141 <varlistentry>
2142 <term><varname>OriginatorIntervalSec=</varname></term>
2143 <listitem>
2144 <para>The value specifies the interval in seconds, unless another time unit is specified in which
2145 batman-adv floods the network with its protocol information.
2146 See <citerefentry><refentrytitle>systemd.time</refentrytitle><manvolnum>7</manvolnum></citerefentry>
2147 for more information.</para>
2148 </listitem>
2149 </varlistentry>
2150 <varlistentry>
2151 <term><varname>GatewayBandwidthDown=</varname></term>
2152 <listitem>
2153 <para>If the node is a server, this
2154 parameter is used to inform other nodes in the network about
2155 this node's internet connection download bandwidth in bits per second. Just enter any number
2156 suffixed with K, M, G or T (base 1000) and the batman-adv
2157 module will propagate the entered value in the mesh.</para>
2158 </listitem>
2159 </varlistentry>
2160 <varlistentry>
2161 <term><varname>GatewayBandwidthUp=</varname></term>
2162 <listitem>
2163 <para>If the node is a server, this
2164 parameter is used to inform other nodes in the network about
2165 this node's internet connection upload bandwidth in bits per second. Just enter any number
2166 suffixed with K, M, G or T (base 1000) and the batman-adv
2167 module will propagate the entered value in the mesh.</para>
2168 </listitem>
2169 </varlistentry>
2170 <varlistentry>
2171 <term><varname>RoutingAlgorithm=</varname></term>
2172 <listitem>
2173 <para>This can be either <literal>batman-v</literal> or <literal>batman-iv</literal> and describes which routing_algo
2174 of <citerefentry project='mankier'><refentrytitle>batctl</refentrytitle><manvolnum>8</manvolnum></citerefentry> to use. The algorithm
2175 cannot be changed after interface creation. Defaults to <literal>batman-v</literal>.
2176 </para>
2177 </listitem>
2178 </varlistentry>
2179 </variablelist>
2180 </refsect1>
2181
2182 <refsect1>
2183 <title>[IPoIB] Section Options</title>
2184 <para>The [IPoIB] section only applies for netdevs of kind <literal>ipoib</literal> and accepts the
2185 following keys:</para>
2186
2187 <variablelist class='network-directives'>
2188 <varlistentry>
2189 <term><varname>PartitionKey=</varname></term>
2190 <listitem>
2191 <para>Takes an integer in the range 1…0xffff, except for 0x8000. Defaults to unset, and the
2192 kernel's default is used.</para>
2193 </listitem>
2194 </varlistentry>
2195
2196 <varlistentry id='ipoib_mode'>
2197 <term><varname>Mode=</varname></term>
2198 <listitem>
2199 <para>Takes one of the special values <literal>datagram</literal> or
2200 <literal>connected</literal>. Defaults to unset, and the kernel's default is used.</para>
2201
2202 <para>When <literal>datagram</literal>, the Infiniband unreliable datagram (UD) transport is
2203 used, and so the interface MTU is equal to the IB L2 MTU minus the IPoIB encapsulation
2204 header (4 bytes). For example, in a typical IB fabric with a 2K MTU, the IPoIB MTU will be
2205 2048 - 4 = 2044 bytes.</para>
2206
2207 <para>When <literal>connected</literal>, the Infiniband reliable connected (RC) transport is
2208 used. Connected mode takes advantage of the connected nature of the IB transport and allows
2209 an MTU up to the maximal IP packet size of 64K, which reduces the number of IP packets needed
2210 for handling large UDP datagrams, TCP segments, etc and increases the performance for large
2211 messages.</para>
2212 </listitem>
2213 </varlistentry>
2214
2215 <varlistentry id='ipoib_umcast'>
2216 <term><varname>IgnoreUserspaceMulticastGroup=</varname></term>
2217 <listitem>
2218 <para>Takes an boolean value. When true, the kernel ignores multicast groups handled by
2219 userspace. Defaults to unset, and the kernel's default is used.</para>
2220 </listitem>
2221 </varlistentry>
2222 </variablelist>
2223 </refsect1>
2224
2225 <refsect1>
2226 <title>[WLAN] Section Options</title>
2227 <para>The [WLAN] section only applies to WLAN interfaces, and accepts the following keys:</para>
2228
2229 <variablelist class='network-directives'>
2230 <varlistentry>
2231 <term><varname>PhysicalDevice=</varname></term>
2232 <listitem>
2233 <para>Specifies the name or index of the physical WLAN device (e.g. <literal>0</literal> or
2234 <literal>phy0</literal>). The list of the physical WLAN devices that exist on the host can be
2235 obtained by <command>iw phy</command> command. This option is mandatory.</para>
2236 </listitem>
2237 </varlistentry>
2238
2239 <varlistentry>
2240 <term><varname>Type=</varname></term>
2241 <listitem>
2242 <para>Specifies the type of the interface. Takes one of the <literal>ad-hoc</literal>,
2243 <literal>station</literal>, <literal>ap</literal>, <literal>ap-vlan</literal>,
2244 <literal>wds</literal>, <literal>monitor</literal>, <literal>mesh-point</literal>,
2245 <literal>p2p-client</literal>, <literal>p2p-go</literal>, <literal>p2p-device</literal>,
2246 <literal>ocb</literal>, and <literal>nan</literal>. This option is mandatory.</para>
2247 </listitem>
2248 </varlistentry>
2249
2250 <varlistentry>
2251 <term><varname>WDS=</varname></term>
2252 <listitem>
2253 <para>Enables the Wireless Distribution System (WDS) mode on the interface. The mode is also
2254 known as the <literal>4 address mode</literal>. Takes a boolean value. Defaults to unset, and
2255 the kernel's default will be used.</para>
2256 </listitem>
2257 </varlistentry>
2258 </variablelist>
2259 </refsect1>
2260
2261 <refsect1>
2262 <title>Examples</title>
2263 <example>
2264 <title>/etc/systemd/network/25-bridge.netdev</title>
2265
2266 <programlisting>[NetDev]
2267 Name=bridge0
2268 Kind=bridge</programlisting>
2269 </example>
2270
2271 <example>
2272 <title>/etc/systemd/network/25-vlan1.netdev</title>
2273
2274 <programlisting>[Match]
2275 Virtualization=no
2276
2277 [NetDev]
2278 Name=vlan1
2279 Kind=vlan
2280
2281 [VLAN]
2282 Id=1</programlisting>
2283 </example>
2284 <example>
2285 <title>/etc/systemd/network/25-ipip.netdev</title>
2286 <programlisting>[NetDev]
2287 Name=ipip-tun
2288 Kind=ipip
2289 MTUBytes=1480
2290
2291 [Tunnel]
2292 Local=192.168.223.238
2293 Remote=192.169.224.239
2294 TTL=64</programlisting>
2295 </example>
2296 <example>
2297 <title>/etc/systemd/network/1-fou-tunnel.netdev</title>
2298 <programlisting>[NetDev]
2299 Name=fou-tun
2300 Kind=fou
2301
2302 [FooOverUDP]
2303 Port=5555
2304 Protocol=4
2305 </programlisting>
2306 </example>
2307 <example>
2308 <title>/etc/systemd/network/25-fou-ipip.netdev</title>
2309 <programlisting>[NetDev]
2310 Name=ipip-tun
2311 Kind=ipip
2312
2313 [Tunnel]
2314 Independent=yes
2315 Local=10.65.208.212
2316 Remote=10.65.208.211
2317 FooOverUDP=yes
2318 FOUDestinationPort=5555
2319 </programlisting>
2320 </example>
2321 <example>
2322 <title>/etc/systemd/network/25-tap.netdev</title>
2323 <programlisting>[NetDev]
2324 Name=tap-test
2325 Kind=tap
2326
2327 [Tap]
2328 MultiQueue=yes
2329 PacketInfo=yes</programlisting> </example>
2330
2331 <example>
2332 <title>/etc/systemd/network/25-sit.netdev</title>
2333 <programlisting>[NetDev]
2334 Name=sit-tun
2335 Kind=sit
2336 MTUBytes=1480
2337
2338 [Tunnel]
2339 Local=10.65.223.238
2340 Remote=10.65.223.239</programlisting>
2341 </example>
2342
2343 <example>
2344 <title>/etc/systemd/network/25-6rd.netdev</title>
2345 <programlisting>[NetDev]
2346 Name=6rd-tun
2347 Kind=sit
2348 MTUBytes=1480
2349
2350 [Tunnel]
2351 Local=10.65.223.238
2352 IPv6RapidDeploymentPrefix=2602::/24</programlisting>
2353 </example>
2354
2355 <example>
2356 <title>/etc/systemd/network/25-gre.netdev</title>
2357 <programlisting>[NetDev]
2358 Name=gre-tun
2359 Kind=gre
2360 MTUBytes=1480
2361
2362 [Tunnel]
2363 Local=10.65.223.238
2364 Remote=10.65.223.239</programlisting>
2365 </example>
2366
2367 <example>
2368 <title>/etc/systemd/network/25-ip6gre.netdev</title>
2369 <programlisting>[NetDev]
2370 Name=ip6gre-tun
2371 Kind=ip6gre
2372
2373 [Tunnel]
2374 Key=123</programlisting>
2375 </example>
2376
2377 <example>
2378 <title>/etc/systemd/network/25-vti.netdev</title>
2379
2380 <programlisting>[NetDev]
2381 Name=vti-tun
2382 Kind=vti
2383 MTUBytes=1480
2384
2385 [Tunnel]
2386 Local=10.65.223.238
2387 Remote=10.65.223.239</programlisting>
2388 </example>
2389
2390 <example>
2391 <title>/etc/systemd/network/25-veth.netdev</title>
2392 <programlisting>[NetDev]
2393 Name=veth-test
2394 Kind=veth
2395
2396 [Peer]
2397 Name=veth-peer</programlisting>
2398 </example>
2399
2400 <example>
2401 <title>/etc/systemd/network/25-bond.netdev</title>
2402 <programlisting>[NetDev]
2403 Name=bond1
2404 Kind=bond
2405
2406 [Bond]
2407 Mode=802.3ad
2408 TransmitHashPolicy=layer3+4
2409 MIIMonitorSec=1s
2410 LACPTransmitRate=fast
2411 </programlisting>
2412 </example>
2413
2414 <example>
2415 <title>/etc/systemd/network/25-dummy.netdev</title>
2416 <programlisting>[NetDev]
2417 Name=dummy-test
2418 Kind=dummy
2419 MACAddress=12:34:56:78:9a:bc</programlisting>
2420 </example>
2421 <example>
2422 <title>/etc/systemd/network/25-vrf.netdev</title>
2423 <para>Create a VRF interface with table 42.</para>
2424 <programlisting>[NetDev]
2425 Name=vrf-test
2426 Kind=vrf
2427
2428 [VRF]
2429 Table=42</programlisting>
2430 </example>
2431
2432 <example>
2433 <title>/etc/systemd/network/25-macvtap.netdev</title>
2434 <para>Create a MacVTap device.</para>
2435 <programlisting>[NetDev]
2436 Name=macvtap-test
2437 Kind=macvtap
2438 </programlisting>
2439 </example>
2440 <example>
2441 <title>/etc/systemd/network/25-wireguard.netdev</title>
2442 <programlisting>[NetDev]
2443 Name=wg0
2444 Kind=wireguard
2445
2446 [WireGuard]
2447 PrivateKey=EEGlnEPYJV//kbvvIqxKkQwOiS+UENyPncC4bF46ong=
2448 ListenPort=51820
2449
2450 [WireGuardPeer]
2451 PublicKey=RDf+LSpeEre7YEIKaxg+wbpsNV7du+ktR99uBEtIiCA=
2452 AllowedIPs=fd31:bf08:57cb::/48,192.168.26.0/24
2453 Endpoint=wireguard.example.com:51820</programlisting>
2454 </example>
2455
2456 <example>
2457 <title>/etc/systemd/network/27-xfrm.netdev</title>
2458 <programlisting>[NetDev]
2459 Name=xfrm0
2460 Kind=xfrm
2461
2462 [Xfrm]
2463 Independent=yes</programlisting>
2464 </example>
2465 </refsect1>
2466
2467 <refsect1>
2468 <title>See Also</title>
2469 <para>
2470 <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
2471 <citerefentry><refentrytitle>systemd-networkd</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
2472 <citerefentry><refentrytitle>systemd.link</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
2473 <citerefentry><refentrytitle>systemd.network</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
2474 <citerefentry><refentrytitle>systemd-network-generator.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>
2475 </para>
2476 </refsect1>
2477
2478 </refentry>