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