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+ -->
6 <refentry id=
"systemd.netdev" conditional='ENABLE_NETWORKD'
>
9 <title>systemd.network
</title>
10 <productname>systemd
</productname>
14 <refentrytitle>systemd.netdev
</refentrytitle>
15 <manvolnum>5</manvolnum>
19 <refname>systemd.netdev
</refname>
20 <refpurpose>Virtual Network Device configuration
</refpurpose>
24 <para><filename><replaceable>netdev
</replaceable>.netdev
</filename></para>
28 <title>Description
</title>
30 <para>A plain ini-style text file that encodes configuration about a virtual network device, used by
31 <citerefentry><refentrytitle>systemd-networkd
</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
32 See
<citerefentry><refentrytitle>systemd.syntax
</refentrytitle><manvolnum>7</manvolnum></citerefentry>
33 for a general description of the syntax.
</para>
35 <para>The main Virtual Network Device file must have the extension
<filename>.netdev
</filename>;
36 other extensions are ignored. Virtual network devices are created as soon as networkd is
37 started. If a netdev with the specified name already exists, networkd will use that as-is rather
38 than create its own. Note that the settings of the pre-existing netdev will not be changed by
41 <para>The
<filename>.netdev
</filename> files are read from the files located in the system
42 network directory
<filename>/usr/lib/systemd/network
</filename>, the volatile runtime network
43 directory
<filename>/run/systemd/network
</filename> and the local administration network
44 directory
<filename>/etc/systemd/network
</filename>. All configuration files are collectively
45 sorted and processed in lexical order, regardless of the directories in which they live.
46 However, files with identical filenames replace each other. Files in
<filename>/etc
</filename>
47 have the highest priority, files in
<filename>/run
</filename> take precedence over files with
48 the same name in
<filename>/usr/lib
</filename>. This can be used to override a system-supplied
49 configuration file with a local file if needed. As a special case, an empty file (file size
0)
50 or symlink with the same name pointing to
<filename>/dev/null
</filename> disables the
51 configuration file entirely (it is
"masked").
</para>
53 <para>Along with the netdev file
<filename>foo.netdev
</filename>, a
"drop-in" directory
54 <filename>foo.netdev.d/
</filename> may exist. All files with the suffix
<literal>.conf
</literal>
55 from this directory will be parsed after the file itself is parsed. This is useful to alter or
56 add configuration settings, without having to modify the main configuration file. Each drop-in
57 file must have appropriate section headers.
</para>
59 <para>In addition to
<filename>/etc/systemd/network
</filename>, drop-in
<literal>.d
</literal>
60 directories can be placed in
<filename>/usr/lib/systemd/network
</filename> or
61 <filename>/run/systemd/network
</filename> directories. Drop-in files in
62 <filename>/etc
</filename> take precedence over those in
<filename>/run
</filename> which in turn
63 take precedence over those in
<filename>/usr/lib
</filename>. Drop-in files under any of these
64 directories take precedence over the main netdev file wherever located. (Of course, since
65 <filename>/run
</filename> is temporary and
<filename>/usr/lib
</filename> is for vendors, it is
66 unlikely drop-ins should be used in either of those places.)
</para>
70 <title>Supported netdev kinds
</title>
72 <para>The following kinds of virtual network devices may be
73 configured in
<filename>.netdev
</filename> files:
</para>
76 <title>Supported kinds of virtual network devices
</title>
79 <colspec colname='kind'
/>
80 <colspec colname='explanation'
/>
83 <entry>Description
</entry>
86 <row><entry><varname>bond
</varname></entry>
87 <entry>A bond device is an aggregation of all its slave devices. See
<ulink url=
"https://www.kernel.org/doc/Documentation/networking/bonding.txt">Linux Ethernet Bonding Driver HOWTO
</ulink> for details.Local configuration
</entry></row>
89 <row><entry><varname>bridge
</varname></entry>
90 <entry>A bridge device is a software switch, and each of its slave devices and the bridge itself are ports of the switch.
</entry></row>
92 <row><entry><varname>dummy
</varname></entry>
93 <entry>A dummy device drops all packets sent to it.
</entry></row>
95 <row><entry><varname>gre
</varname></entry>
96 <entry>A Level
3 GRE tunnel over IPv4. See
<ulink url=
"https://tools.ietf.org/html/rfc2784">RFC
2784</ulink> for details.
</entry></row>
98 <row><entry><varname>gretap
</varname></entry>
99 <entry>A Level
2 GRE tunnel over IPv4.
</entry></row>
101 <row><entry><varname>erspan
</varname></entry>
102 <entry>ERSPAN mirrors traffic on one or more source ports and delivers the mirrored traffic to one or more destination ports on another switch. The traffic is encapsulated in generic routing encapsulation (GRE) and is therefore routable across a layer
3 network between the source switch and the destination switch.
</entry></row>
104 <row><entry><varname>ip6gre
</varname></entry>
105 <entry>A Level
3 GRE tunnel over IPv6.
</entry></row>
107 <row><entry><varname>ip6tnl
</varname></entry>
108 <entry>An IPv4 or IPv6 tunnel over IPv6
</entry></row>
110 <row><entry><varname>ip6gretap
</varname></entry>
111 <entry>A Level
2 GRE tunnel over IPv6.
</entry></row>
113 <row><entry><varname>ipip
</varname></entry>
114 <entry>An IPv4 over IPv4 tunnel.
</entry></row>
116 <row><entry><varname>ipvlan
</varname></entry>
117 <entry>An IPVLAN device is a stacked device which receives packets from its underlying device based on IP address filtering.
</entry></row>
119 <row><entry><varname>ipvtap
</varname></entry>
120 <entry>An IPVTAP device is a stacked device which receives packets from its underlying device based on IP address filtering and can be accessed using the tap user space interface.
</entry></row>
122 <row><entry><varname>macvlan
</varname></entry>
123 <entry>A macvlan device is a stacked device which receives packets from its underlying device based on MAC address filtering.
</entry></row>
125 <row><entry><varname>macvtap
</varname></entry>
126 <entry>A macvtap device is a stacked device which receives packets from its underlying device based on MAC address filtering.
</entry></row>
128 <row><entry><varname>sit
</varname></entry>
129 <entry>An IPv6 over IPv4 tunnel.
</entry></row>
131 <row><entry><varname>tap
</varname></entry>
132 <entry>A persistent Level
2 tunnel between a network device and a device node.
</entry></row>
134 <row><entry><varname>tun
</varname></entry>
135 <entry>A persistent Level
3 tunnel between a network device and a device node.
</entry></row>
137 <row><entry><varname>veth
</varname></entry>
138 <entry>An Ethernet tunnel between a pair of network devices.
</entry></row>
140 <row><entry><varname>vlan
</varname></entry>
141 <entry>A VLAN is a stacked device which receives packets from its underlying device based on VLAN tagging. See
<ulink url=
"http://www.ieee802.org/1/pages/802.1Q.html">IEEE
802.1Q
</ulink> for details.
</entry></row>
143 <row><entry><varname>vti
</varname></entry>
144 <entry>An IPv4 over IPSec tunnel.
</entry></row>
146 <row><entry><varname>vti6
</varname></entry>
147 <entry>An IPv6 over IPSec tunnel.
</entry></row>
149 <row><entry><varname>vxlan
</varname></entry>
150 <entry>A virtual extensible LAN (vxlan), for connecting Cloud computing deployments.
</entry></row>
152 <row><entry><varname>geneve
</varname></entry>
153 <entry>A GEneric NEtwork Virtualization Encapsulation (GENEVE) netdev driver.
</entry></row>
155 <row><entry><varname>l2tp
</varname></entry>
156 <entry>A Layer
2 Tunneling Protocol (L2TP) is a tunneling protocol used to support virtual private networks (VPNs) or as part of the delivery of services by ISPs. It does not provide any encryption or confidentiality by itself
</entry></row>
158 <row><entry><varname>macsec
</varname></entry>
159 <entry>Media Access Control Security (MACsec) is an
802.1AE IEEE industry-standard security technology that provides secure communication for all traffic on Ethernet links. MACsec provides point-to-point security on Ethernet links between directly connected nodes and is capable of identifying and preventing most security threats.
</entry></row>
161 <row><entry><varname>vrf
</varname></entry>
162 <entry>A Virtual Routing and Forwarding (
<ulink url=
"https://www.kernel.org/doc/Documentation/networking/vrf.txt">VRF
</ulink>) interface to create separate routing and forwarding domains.
</entry></row>
164 <row><entry><varname>vcan
</varname></entry>
165 <entry>The virtual CAN driver (vcan). Similar to the network loopback devices, vcan offers a virtual local CAN interface.
</entry></row>
167 <row><entry><varname>vxcan
</varname></entry>
168 <entry>The virtual CAN tunnel driver (vxcan). Similar to the virtual ethernet driver veth, vxcan implements a local CAN traffic tunnel between two virtual CAN network devices. When creating a vxcan, two vxcan devices are created as pair. When one end receives the packet it appears on its pair and vice versa. The vxcan can be used for cross namespace communication.
171 <row><entry><varname>wireguard
</varname></entry>
172 <entry>WireGuard Secure Network Tunnel.
</entry></row>
174 <row><entry><varname>nlmon
</varname></entry>
175 <entry>A Netlink monitor device. Use an nlmon device when you want to monitor system Netlink messages.
</entry></row>
177 <row><entry><varname>fou
</varname></entry>
178 <entry>Foo-over-UDP tunneling.
</entry></row>
180 <row><entry><varname>xfrm
</varname></entry>
181 <entry>A virtual tunnel interface like vti/vti6 but with several advantages.
</entry></row>
183 <row><entry><varname>ifb
</varname></entry>
184 <entry> The Intermediate Functional Block (ifb) pseudo network interface acts as a QoS concentrator for multiple different sources of traffic.
</entry></row>
186 <row><entry><varname>bareudp
</varname></entry>
187 <entry> Bare UDP tunnels provide a generic L3 encapsulation support for tunnelling different L3 protocols like MPLS, IP etc. inside of an UDP tunnel.
</entry></row>
195 <title>[Match] Section Options
</title>
197 <para>A virtual network device is only created if the
198 [Match] section matches the current
199 environment, or if the section is empty. The following keys are
202 <variablelist class='network-directives'
>
204 <term><varname>Host=
</varname></term>
206 <para>Matches against the hostname or machine ID of the host. See
207 <literal>ConditionHost=
</literal> in
208 <citerefentry><refentrytitle>systemd.unit
</refentrytitle><manvolnum>5</manvolnum></citerefentry>
209 for details. When prefixed with an exclamation mark (
<literal>!
</literal>), the result is negated.
210 If an empty string is assigned, then previously assigned value is cleared.
215 <term><varname>Virtualization=
</varname></term>
217 <para>Checks whether the system is executed in a virtualized environment and optionally test
218 whether it is a specific implementation. See
<literal>ConditionVirtualization=
</literal> in
219 <citerefentry><refentrytitle>systemd.unit
</refentrytitle><manvolnum>5</manvolnum></citerefentry>
220 for details. When prefixed with an exclamation mark (
<literal>!
</literal>), the result is negated.
221 If an empty string is assigned, then previously assigned value is cleared.
226 <term><varname>KernelCommandLine=
</varname></term>
228 <para>Checks whether a specific kernel command line option is set. See
229 <literal>ConditionKernelCommandLine=
</literal> in
230 <citerefentry><refentrytitle>systemd.unit
</refentrytitle><manvolnum>5</manvolnum></citerefentry>
231 for details. When prefixed with an exclamation mark (
<literal>!
</literal>), the result is negated.
232 If an empty string is assigned, then previously assigned value is cleared.
237 <term><varname>KernelVersion=
</varname></term>
239 <para>Checks whether the kernel version (as reported by
<command>uname -r
</command>) matches a
240 certain expression. See
<literal>ConditionKernelVersion=
</literal> in
241 <citerefentry><refentrytitle>systemd.unit
</refentrytitle><manvolnum>5</manvolnum></citerefentry>
242 for details. When prefixed with an exclamation mark (
<literal>!
</literal>), the result is negated.
243 If an empty string is assigned, then previously assigned value is cleared.
248 <term><varname>Architecture=
</varname></term>
250 <para>Checks whether the system is running on a specific architecture. See
251 <literal>ConditionArchitecture=
</literal> in
252 <citerefentry><refentrytitle>systemd.unit
</refentrytitle><manvolnum>5</manvolnum></citerefentry>
253 for details. When prefixed with an exclamation mark (
<literal>!
</literal>), the result is negated.
254 If an empty string is assigned, then previously assigned value is cleared.
262 <title>[NetDev] Section Options
</title>
264 <para>The [NetDev] section accepts the
265 following keys:
</para>
267 <variablelist class='network-directives'
>
269 <term><varname>Description=
</varname></term>
271 <para>A free-form description of the netdev.
</para>
275 <term><varname>Name=
</varname></term>
277 <para>The interface name used when creating the netdev.
278 This setting is compulsory.
</para>
282 <term><varname>Kind=
</varname></term>
284 <para>The netdev kind. This setting is compulsory. See the
285 <literal>Supported netdev kinds
</literal> section for the
290 <term><varname>MTUBytes=
</varname></term>
292 <para>The maximum transmission unit in bytes to set for the device. The usual suffixes K, M, G
293 are supported and are understood to the base of
1024. For
<literal>tun
</literal> or
294 <literal>tap
</literal> devices,
<varname>MTUBytes=
</varname> setting is not currently supported in
295 [NetDev] section. Please specify it in [Link] section of
297 <citerefentry><refentrytitle>systemd.network
</refentrytitle><manvolnum>5</manvolnum></citerefentry>
302 <term><varname>MACAddress=
</varname></term>
304 <para>The MAC address to use for the device. For
<literal>tun
</literal> or
<literal>tap
</literal>
305 devices, setting
<varname>MACAddress=
</varname> in the [NetDev] section is not
306 supported. Please specify it in [Link] section of the corresponding
307 <citerefentry><refentrytitle>systemd.network
</refentrytitle><manvolnum>5</manvolnum></citerefentry>
308 file. If this option is not set,
<literal>vlan
</literal> devices inherit the MAC address of the
309 physical interface. For other kind of netdevs, if this option is not set, then MAC address is
310 generated based on the interface name and the
311 <citerefentry><refentrytitle>machine-id
</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
319 <title>[Bridge] Section Options
</title>
321 <para>The [Bridge] section only applies for
322 netdevs of kind
<literal>bridge
</literal>, and accepts the
323 following keys:
</para>
325 <variablelist class='network-directives'
>
327 <term><varname>HelloTimeSec=
</varname></term>
329 <para>HelloTimeSec specifies the number of seconds between two hello packets
330 sent out by the root bridge and the designated bridges. Hello packets are
331 used to communicate information about the topology throughout the entire
332 bridged local area network.
</para>
336 <term><varname>MaxAgeSec=
</varname></term>
338 <para>MaxAgeSec specifies the number of seconds of maximum message age.
339 If the last seen (received) hello packet is more than this number of
340 seconds old, the bridge in question will start the takeover procedure
341 in attempt to become the Root Bridge itself.
</para>
345 <term><varname>ForwardDelaySec=
</varname></term>
347 <para>ForwardDelaySec specifies the number of seconds spent in each
348 of the Listening and Learning states before the Forwarding state is entered.
</para>
352 <term><varname>AgeingTimeSec=
</varname></term>
354 <para>This specifies the number of seconds a MAC Address will be kept in
355 the forwarding database after having a packet received from this MAC Address.
</para>
359 <term><varname>Priority=
</varname></term>
361 <para>The priority of the bridge. An integer between
0 and
65535. A lower value
362 means higher priority. The bridge having the lowest priority will be elected as root bridge.
</para>
366 <term><varname>GroupForwardMask=
</varname></term>
368 <para>A
16-bit bitmask represented as an integer which allows forwarding of link
369 local frames with
802.1D reserved addresses (
01:
80:C2:
00:
00:
0X). A logical AND
370 is performed between the specified bitmask and the exponentiation of
2^X, the
371 lower nibble of the last octet of the MAC address. For example, a value of
8
372 would allow forwarding of frames addressed to
01:
80:C2:
00:
00:
03 (
802.1X PAE).
</para>
376 <term><varname>DefaultPVID=
</varname></term>
378 <para>This specifies the default port VLAN ID of a newly attached bridge port.
379 Set this to an integer in the range
1–
4094 or
<literal>none
</literal> to disable the PVID.
</para>
383 <term><varname>MulticastQuerier=
</varname></term>
385 <para>Takes a boolean. This setting controls the IFLA_BR_MCAST_QUERIER option in the kernel.
386 If enabled, the kernel will send general ICMP queries from a zero source address.
387 This feature should allow faster convergence on startup, but it causes some
388 multicast-aware switches to misbehave and disrupt forwarding of multicast packets.
389 When unset, the kernel's default will be used.
394 <term><varname>MulticastSnooping=
</varname></term>
396 <para>Takes a boolean. This setting controls the IFLA_BR_MCAST_SNOOPING option in the kernel.
397 If enabled, IGMP snooping monitors the Internet Group Management Protocol (IGMP) traffic
398 between hosts and multicast routers. When unset, the kernel's default will be used.
403 <term><varname>VLANFiltering=
</varname></term>
405 <para>Takes a boolean. This setting controls the IFLA_BR_VLAN_FILTERING option in the kernel.
406 If enabled, the bridge will be started in VLAN-filtering mode. When unset, the kernel's default will be used.
411 <term><varname>VLANProtocol=
</varname></term>
413 <para>Allows setting the protocol used for VLAN filtering. Takes
414 <option>802.1q
</option> or,
415 <option>802.1ad
</option>, and defaults to unset and kernel's default is used.
420 <term><varname>STP=
</varname></term>
422 <para>Takes a boolean. This enables the bridge's Spanning Tree Protocol (STP).
423 When unset, the kernel's default will be used.
428 <term><varname>MulticastIGMPVersion=
</varname></term>
430 <para>Allows changing bridge's multicast Internet Group Management Protocol (IGMP) version.
431 Takes an integer
2 or
3. When unset, the kernel's default will be used.
439 <title>[VLAN] Section Options
</title>
441 <para>The [VLAN] section only applies for
442 netdevs of kind
<literal>vlan
</literal>, and accepts the
443 following key:
</para>
445 <variablelist class='network-directives'
>
447 <term><varname>Id=
</varname></term>
449 <para>The VLAN ID to use. An integer in the range
0–
4094.
450 This setting is compulsory.
</para>
454 <term><varname>GVRP=
</varname></term>
456 <para>Takes a boolean. The Generic VLAN Registration Protocol (GVRP) is a protocol that
457 allows automatic learning of VLANs on a network.
458 When unset, the kernel's default will be used.
463 <term><varname>MVRP=
</varname></term>
465 <para>Takes a boolean. Multiple VLAN Registration Protocol (MVRP) formerly known as GARP VLAN
466 Registration Protocol (GVRP) is a standards-based Layer
2 network protocol,
467 for automatic configuration of VLAN information on switches. It was defined
468 in the
802.1ak amendment to
802.1Q-
2005. When unset, the kernel's default will be used.
473 <term><varname>LooseBinding=
</varname></term>
475 <para>Takes a boolean. The VLAN loose binding mode, in which only the operational state is passed
476 from the parent to the associated VLANs, but the VLAN device state is not changed.
477 When unset, the kernel's default will be used.
</para>
481 <term><varname>ReorderHeader=
</varname></term>
483 <para>Takes a boolean. When enabled, the VLAN reorder header is used and VLAN interfaces behave
484 like physical interfaces. When unset, the kernel's default will be used.
</para>
491 <title>[MACVLAN] Section Options
</title>
493 <para>The [MACVLAN] section only applies for
494 netdevs of kind
<literal>macvlan
</literal>, and accepts the
495 following key:
</para>
497 <variablelist class='network-directives'
>
499 <term><varname>Mode=
</varname></term>
501 <para>The MACVLAN mode to use. The supported options are
502 <literal>private
</literal>,
503 <literal>vepa
</literal>,
504 <literal>bridge
</literal>,
505 <literal>passthru
</literal>, and
506 <literal>source
</literal>.
511 <term><varname>SourceMACAddress=
</varname></term>
513 <para>A whitespace-separated list of remote hardware addresses allowed on the MACVLAN. This
514 option only has an effect in source mode. Use full colon-, hyphen- or dot-delimited
515 hexadecimal. This option may appear more than once, in which case the lists are merged. If
516 the empty string is assigned to this option, the list of hardware addresses defined prior
517 to this is reset. Defaults to unset.
</para>
524 <title>[MACVTAP] Section Options
</title>
526 <para>The [MACVTAP] section applies for
527 netdevs of kind
<literal>macvtap
</literal> and accepts the
528 same key as [MACVLAN].
</para>
532 <title>[IPVLAN] Section Options
</title>
534 <para>The [IPVLAN] section only applies for
535 netdevs of kind
<literal>ipvlan
</literal>, and accepts the
536 following key:
</para>
538 <variablelist class='network-directives'
>
540 <term><varname>Mode=
</varname></term>
542 <para>The IPVLAN mode to use. The supported options are
543 <literal>L2
</literal>,
<literal>L3
</literal> and
<literal>L3S
</literal>.
548 <term><varname>Flags=
</varname></term>
550 <para>The IPVLAN flags to use. The supported options are
551 <literal>bridge
</literal>,
<literal>private
</literal> and
<literal>vepa
</literal>.
559 <title>[IPVTAP] Section Options
</title>
561 <para>The [IPVTAP] section only applies for
562 netdevs of kind
<literal>ipvtap
</literal> and accepts the
563 same key as [IPVLAN].
</para>
567 <title>[VXLAN] Section Options
</title>
569 <para>The [VXLAN] section only applies for
570 netdevs of kind
<literal>vxlan
</literal>, and accepts the
571 following keys:
</para>
573 <variablelist class='network-directives'
>
575 <term><varname>VNI=
</varname></term>
577 <para>The VXLAN Network Identifier (or VXLAN Segment ID). Takes a number in the range
1-
16777215.
</para>
581 <term><varname>Remote=
</varname></term>
583 <para>Configures destination IP address.
</para>
587 <term><varname>Local=
</varname></term>
589 <para>Configures local IP address.
</para>
593 <term><varname>Group=
</varname></term>
595 <para>Configures VXLAN multicast group IP address. All members of a VXLAN must use the same
596 multicast group address.
</para>
600 <term><varname>TOS=
</varname></term>
602 <para>The Type Of Service byte value for a vxlan interface.
</para>
606 <term><varname>TTL=
</varname></term>
608 <para>A fixed Time To Live N on Virtual eXtensible Local Area Network packets.
609 Takes
<literal>inherit
</literal> or a number in the range
0–
255.
0 is a special
610 value meaning inherit the inner protocol's TTL value.
<literal>inherit
</literal>
611 means that it will inherit the outer protocol's TTL value.
</para>
615 <term><varname>MacLearning=
</varname></term>
617 <para>Takes a boolean. When true, enables dynamic MAC learning
618 to discover remote MAC addresses.
</para>
622 <term><varname>FDBAgeingSec=
</varname></term>
624 <para>The lifetime of Forwarding Database entry learnt by
625 the kernel, in seconds.
</para>
629 <term><varname>MaximumFDBEntries=
</varname></term>
631 <para>Configures maximum number of FDB entries.
</para>
635 <term><varname>ReduceARPProxy=
</varname></term>
637 <para>Takes a boolean. When true, bridge-connected VXLAN tunnel
638 endpoint answers ARP requests from the local bridge on behalf
639 of remote Distributed Overlay Virtual Ethernet
640 <ulink url=
"https://en.wikipedia.org/wiki/Distributed_Overlay_Virtual_Ethernet">
641 (DVOE)
</ulink> clients. Defaults to false.
</para>
645 <term><varname>L2MissNotification=
</varname></term>
647 <para>Takes a boolean. When true, enables netlink LLADDR miss
648 notifications.
</para>
652 <term><varname>L3MissNotification=
</varname></term>
654 <para>Takes a boolean. When true, enables netlink IP address miss notifications.
</para>
658 <term><varname>RouteShortCircuit=
</varname></term>
660 <para>Takes a boolean. When true, route short circuiting is turned
665 <term><varname>UDPChecksum=
</varname></term>
667 <para>Takes a boolean. When true, transmitting UDP checksums when doing VXLAN/IPv4 is turned on.
</para>
671 <term><varname>UDP6ZeroChecksumTx=
</varname></term>
673 <para>Takes a boolean. When true, sending zero checksums in VXLAN/IPv6 is turned on.
</para>
677 <term><varname>UDP6ZeroChecksumRx=
</varname></term>
679 <para>Takes a boolean. When true, receiving zero checksums in VXLAN/IPv6 is turned on.
</para>
683 <term><varname>RemoteChecksumTx=
</varname></term>
685 <para>Takes a boolean. When true, remote transmit checksum offload of VXLAN is turned on.
</para>
689 <term><varname>RemoteChecksumRx=
</varname></term>
691 <para>Takes a boolean. When true, remote receive checksum offload in VXLAN is turned on.
</para>
695 <term><varname>GroupPolicyExtension=
</varname></term>
697 <para>Takes a boolean. When true, it enables Group Policy VXLAN extension security label mechanism
698 across network peers based on VXLAN. For details about the Group Policy VXLAN, see the
699 <ulink url=
"https://tools.ietf.org/html/draft-smith-vxlan-group-policy">
700 VXLAN Group Policy
</ulink> document. Defaults to false.
</para>
704 <term><varname>GenericProtocolExtension=
</varname></term>
706 <para>Takes a boolean. When true, Generic Protocol Extension extends the existing VXLAN protocol
707 to provide protocol typing, OAM, and versioning capabilities. For details about the VXLAN GPE
708 Header, see the
<ulink url=
"https://tools.ietf.org/html/draft-ietf-nvo3-vxlan-gpe-07">
709 Generic Protocol Extension for VXLAN
</ulink> document. If destination port is not specified and
710 Generic Protocol Extension is set then default port of
4790 is used. Defaults to false.
</para>
714 <term><varname>DestinationPort=
</varname></term>
716 <para>Configures the default destination UDP port on a per-device basis.
717 If destination port is not specified then Linux kernel default will be used.
718 Set destination port
4789 to get the IANA assigned value. If not set or if the
719 destination port is assigned the empty string the default port of
4789 is used.
</para>
723 <term><varname>PortRange=
</varname></term>
725 <para>Configures VXLAN port range. VXLAN bases source
726 UDP port based on flow to help the receiver to be able
727 to load balance based on outer header flow. It
728 restricts the port range to the normal UDP local
729 ports, and allows overriding via configuration.
</para>
733 <term><varname>FlowLabel=
</varname></term>
735 <para>Specifies the flow label to use in outgoing packets.
736 The valid range is
0-
1048575.
741 <term><varname>IPDoNotFragment=
</varname></term>
743 <para>Allows setting the IPv4 Do not Fragment (DF) bit in outgoing packets, or to inherit its
744 value from the IPv4 inner header. Takes a boolean value, or
<literal>inherit
</literal>. Set
745 to
<literal>inherit
</literal> if the encapsulated protocol is IPv6. When unset, the kernel's
746 default will be used.
</para>
753 <title>[GENEVE] Section Options
</title>
755 <para>The [GENEVE] section only applies for
756 netdevs of kind
<literal>geneve
</literal>, and accepts the
757 following keys:
</para>
759 <variablelist class='network-directives'
>
761 <term><varname>Id=
</varname></term>
763 <para>Specifies the Virtual Network Identifier (VNI) to use. Ranges [
0-
16777215]. This field is mandatory.
</para>
767 <term><varname>Remote=
</varname></term>
769 <para>Specifies the unicast destination IP address to use in outgoing packets.
</para>
773 <term><varname>TOS=
</varname></term>
775 <para>Specifies the TOS value to use in outgoing packets. Ranges [
1-
255].
</para>
779 <term><varname>TTL=
</varname></term>
781 <para>Accepts the same values as in the [VXLAN] section, except that when unset
782 or set to
0, the kernel's default will be used, meaning that packet TTL will be set from
783 <filename>/proc/sys/net/ipv4/ip_default_ttl
</filename>.
</para>
787 <term><varname>UDPChecksum=
</varname></term>
789 <para>Takes a boolean. When true, specifies that UDP checksum is calculated for transmitted packets
794 <term><varname>UDP6ZeroChecksumTx=
</varname></term>
796 <para>Takes a boolean. When true, skip UDP checksum calculation for transmitted packets over IPv6.
</para>
800 <term><varname>UDP6ZeroChecksumRx=
</varname></term>
802 <para>Takes a boolean. When true, allows incoming UDP packets over IPv6 with zero checksum field.
</para>
806 <term><varname>DestinationPort=
</varname></term>
808 <para>Specifies destination port. Defaults to
6081. If not set or assigned the empty string, the default
809 port of
6081 is used.
</para>
813 <term><varname>FlowLabel=
</varname></term>
815 <para>Specifies the flow label to use in outgoing packets.
</para>
819 <term><varname>IPDoNotFragment=
</varname></term>
821 <para>Accepts the same key in [VXLAN] section.
</para>
825 <term><varname>Independent=
</varname></term>
827 <para>Takes a boolean. When true, the vxlan interface is created without underlying interfaces.
828 Defaults to
<literal>false
</literal>.
</para>
835 <title>[BareUDP] Section Options
</title>
837 <para>The [BareUDP] section only applies for
838 netdevs of kind
<literal>bareudp
</literal>, and accepts the
839 following keys:
</para>
841 <variablelist class='network-directives'
>
843 <term><varname>DestinationPort=
</varname></term>
845 <para>Specifies the destination UDP port (in range
1…
65535). This is mandatory.
</para>
850 <term><varname>EtherType=
</varname></term>
852 <para>Specifies the L3 protocol. Takes one of
<literal>ipv4
</literal>,
<literal>ipv6
</literal>,
<literal>mpls-uc
</literal>
853 or
<literal>mpls-mc
</literal>. This is mandatory.
</para>
860 <title>[L2TP] Section Options
</title>
862 <para>The [L2TP] section only applies for
863 netdevs of kind
<literal>l2tp
</literal>, and accepts the
864 following keys:
</para>
866 <variablelist class='network-directives'
>
868 <term><varname>TunnelId=
</varname></term>
870 <para>Specifies the tunnel identifier. Takes an number in the range
1–
4294967295. The value used
871 must match the
<literal>PeerTunnelId=
</literal> value being used at the peer. This setting is
876 <term><varname>PeerTunnelId=
</varname></term>
878 <para>Specifies the peer tunnel id. Takes a number in the range
1—
4294967295. The value used must
879 match the
<literal>PeerTunnelId=
</literal> value being used at the peer. This setting is
884 <term><varname>Remote=
</varname></term>
886 <para>Specifies the IP address of the remote peer. This setting is compulsory.
</para>
890 <term><varname>Local=
</varname></term>
892 <para>Specifies the IP address of the local interface. Takes an IP address, or the special values
893 <literal>auto
</literal>,
<literal>static
</literal>, or
<literal>dynamic
</literal>. When an address
894 is set, then the local interface must have the address. If
<literal>auto
</literal>, then one of the
895 addresses on the local interface is used. Similarly, if
<literal>static
</literal> or
896 <literal>dynamic
</literal> is set, then one of the static or dynamic addresses on the local
897 interface is used. Defaults to
<literal>auto
</literal>.
</para>
901 <term><varname>EncapsulationType=
</varname></term>
903 <para>Specifies the encapsulation type of the tunnel. Takes one of
<literal>udp
</literal> or
904 <literal>ip
</literal>.
</para>
908 <term><varname>UDPSourcePort=
</varname></term>
910 <para>Specifies the UDP source port to be used for the tunnel. When UDP encapsulation is selected
911 it's mandatory. Ignored when IP encapsulation is selected.
</para>
915 <term><varname>UDPDestinationPort=
</varname></term>
917 <para>Specifies destination port. When UDP encapsulation is selected it's mandatory. Ignored when IP
918 encapsulation is selected.
</para>
922 <term><varname>UDPChecksum=
</varname></term>
924 <para>Takes a boolean. When true, specifies that UDP checksum is calculated for transmitted packets
929 <term><varname>UDP6ZeroChecksumTx=
</varname></term>
931 <para>Takes a boolean. When true, skip UDP checksum calculation for transmitted packets over IPv6.
</para>
935 <term><varname>UDP6ZeroChecksumRx=
</varname></term>
937 <para>Takes a boolean. When true, allows incoming UDP packets over IPv6 with zero checksum field.
</para>
944 <title>[L2TPSession] Section Options
</title>
946 <para>The [L2TPSession] section only applies for
947 netdevs of kind
<literal>l2tp
</literal>, and accepts the
948 following keys:
</para>
949 <variablelist class='network-directives'
>
951 <term><varname>Name=
</varname></term>
953 <para>Specifies the name of the session. This setting is compulsory.
</para>
957 <term><varname>SessionId=
</varname></term>
959 <para>Specifies the session identifier. Takes an number in the range
1–
4294967295. The value used
960 must match the
<literal>SessionId=
</literal> value being used at the peer. This setting is
965 <term><varname>PeerSessionId=
</varname></term>
967 <para>Specifies the peer session identifier. Takes an number in the range
1–
4294967295.
968 The value used must match the
<literal>PeerSessionId=
</literal> value being used at the peer.
969 This setting is compulsory.
</para>
973 <term><varname>Layer2SpecificHeader=
</varname></term>
975 <para>Specifies layer2specific header type of the session. One of
<literal>none
</literal> or
<literal>default
</literal>. Defaults to
<literal>default
</literal>.
</para>
982 <title>[MACsec] Section Options
</title>
984 <para>The [MACsec] section only applies for network devices of kind
985 <literal>macsec
</literal>, and accepts the following keys:
</para>
987 <variablelist class='network-directives'
>
989 <term><varname>Port=
</varname></term>
991 <para>Specifies the port to be used for the MACsec transmit channel. The port is used to make
992 secure channel identifier (SCI). Takes a value between
1 and
65535. Defaults to unset.
997 <term><varname>Encrypt=
</varname></term>
999 <para>Takes a boolean. When true, enable encryption. Defaults to unset.
</para>
1006 <title>[MACsecReceiveChannel] Section Options
</title>
1007 <para>The [MACsecReceiveChannel] section only applies for network devices of
1008 kind
<literal>macsec
</literal>, and accepts the following keys:
</para>
1010 <variablelist class='network-directives'
>
1012 <term><varname>Port=
</varname></term>
1014 <para>Specifies the port to be used for the MACsec receive channel. The port is used to make
1015 secure channel identifier (SCI). Takes a value between
1 and
65535. This option is
1016 compulsory, and is not set by default.
</para>
1020 <term><varname>MACAddress=
</varname></term>
1022 <para>Specifies the MAC address to be used for the MACsec receive channel. The MAC address
1023 used to make secure channel identifier (SCI). This setting is compulsory, and is not set by
1031 <title>[MACsecTransmitAssociation] Section Options
</title>
1033 <para>The [MACsecTransmitAssociation] section only applies for network devices
1034 of kind
<literal>macsec
</literal>, and accepts the following keys:
</para>
1036 <variablelist class='network-directives'
>
1038 <term><varname>PacketNumber=
</varname></term>
1040 <para>Specifies the packet number to be used for replay protection and the construction of
1041 the initialization vector (along with the secure channel identifier [SCI]). Takes a value
1042 between
1-
4,
294,
967,
295. Defaults to unset.
1047 <term><varname>KeyId=
</varname></term>
1049 <para>Specifies the identification for the key. Takes a number between
0-
255. This option
1050 is compulsory, and is not set by default.
</para>
1054 <term><varname>Key=
</varname></term>
1056 <para>Specifies the encryption key used in the transmission channel. The same key must be
1057 configured on the peer’s matching receive channel. This setting is compulsory, and is not set
1058 by default. Takes a
128-bit key encoded in a hexadecimal string, for example
1059 <literal>dffafc8d7b9a43d5b9a3dfbbf6a30c16
</literal>.
</para>
1063 <term><varname>KeyFile=
</varname></term>
1065 <para>Takes a absolute path to a file which contains a
128-bit key encoded in a hexadecimal string,
1066 which will be used in the transmission channel. When this option is specified,
1067 <varname>Key=
</varname> is ignored. Note that the file must be readable by the user
1068 <literal>systemd-network
</literal>, so it should be, e.g., owned by
1069 <literal>root:systemd-network
</literal> with a
<literal>0640</literal> file mode. If the path
1070 refers to an
<constant>AF_UNIX
</constant> stream socket in the file system a connection is made to
1071 it and the key read from it.
</para>
1075 <term><varname>Activate=
</varname></term>
1077 <para>Takes a boolean. If enabled, then the security association is activated. Defaults to
1082 <term><varname>UseForEncoding=
</varname></term>
1084 <para>Takes a boolean. If enabled, then the security association is used for encoding. Only
1085 one [MACsecTransmitAssociation] section can enable this option. When enabled,
1086 <varname>Activate=yes
</varname> is implied. Defaults to unset.
</para>
1093 <title>[MACsecReceiveAssociation] Section Options
</title>
1095 <para>The [MACsecReceiveAssociation] section only applies for
1096 network devices of kind
<literal>macsec
</literal>, and accepts the
1097 following keys:
</para>
1099 <variablelist class='network-directives'
>
1101 <term><varname>Port=
</varname></term>
1103 <para>Accepts the same key in [MACsecReceiveChannel] section.
</para>
1107 <term><varname>MACAddress=
</varname></term>
1109 <para>Accepts the same key in [MACsecReceiveChannel] section.
</para>
1113 <term><varname>PacketNumber=
</varname></term>
1115 <para>Accepts the same key in [MACsecTransmitAssociation] section.
</para>
1119 <term><varname>KeyId=
</varname></term>
1121 <para>Accepts the same key in [MACsecTransmitAssociation] section.
</para>
1125 <term><varname>Key=
</varname></term>
1127 <para>Accepts the same key in [MACsecTransmitAssociation] section.
</para>
1131 <term><varname>KeyFile=
</varname></term>
1133 <para>Accepts the same key in [MACsecTransmitAssociation] section.
</para>
1137 <term><varname>Activate=
</varname></term>
1139 <para>Accepts the same key in [MACsecTransmitAssociation] section.
</para>
1146 <title>[Tunnel] Section Options
</title>
1148 <para>The [Tunnel] section only applies for
1150 <literal>ipip
</literal>,
1151 <literal>sit
</literal>,
1152 <literal>gre
</literal>,
1153 <literal>gretap
</literal>,
1154 <literal>ip6gre
</literal>,
1155 <literal>ip6gretap
</literal>,
1156 <literal>vti
</literal>,
1157 <literal>vti6
</literal>,
1158 <literal>ip6tnl
</literal>, and
1159 <literal>erspan
</literal> and accepts
1160 the following keys:
</para>
1162 <variablelist class='network-directives'
>
1164 <term><varname>Local=
</varname></term>
1166 <para>A static local address for tunneled packets. It must be an address on another interface of
1167 this host, or the special value
<literal>any
</literal>.
</para>
1171 <term><varname>Remote=
</varname></term>
1173 <para>The remote endpoint of the tunnel. Takes an IP address or the special value
1174 <literal>any
</literal>.
</para>
1178 <term><varname>TOS=
</varname></term>
1180 <para>The Type Of Service byte value for a tunnel interface.
1181 For details about the TOS, see the
1182 <ulink url=
"http://tools.ietf.org/html/rfc1349"> Type of
1183 Service in the Internet Protocol Suite
</ulink> document.
1188 <term><varname>TTL=
</varname></term>
1190 <para>A fixed Time To Live N on tunneled packets. N is a
1191 number in the range
1–
255.
0 is a special value meaning that
1192 packets inherit the TTL value. The default value for IPv4
1193 tunnels is
0 (inherit). The default value for IPv6 tunnels is
1198 <term><varname>DiscoverPathMTU=
</varname></term>
1200 <para>Takes a boolean. When true, enables Path MTU Discovery on
1205 <term><varname>IPv6FlowLabel=
</varname></term>
1207 <para>Configures the
20-bit flow label (see
<ulink url=
"https://tools.ietf.org/html/rfc6437">
1208 RFC
6437</ulink>) field in the IPv6 header (see
<ulink url=
"https://tools.ietf.org/html/rfc2460">
1209 RFC
2460</ulink>), which is used by a node to label packets of a flow.
1210 It is only used for IPv6 tunnels.
1211 A flow label of zero is used to indicate packets that have
1213 It can be configured to a value in the range
0–
0xFFFFF, or be
1214 set to
<literal>inherit
</literal>, in which case the original flowlabel is used.
</para>
1218 <term><varname>CopyDSCP=
</varname></term>
1220 <para>Takes a boolean. When true, the Differentiated Service Code
1221 Point (DSCP) field will be copied to the inner header from
1222 outer header during the decapsulation of an IPv6 tunnel
1223 packet. DSCP is a field in an IP packet that enables different
1224 levels of service to be assigned to network traffic.
1225 Defaults to
<literal>no
</literal>.
1230 <term><varname>EncapsulationLimit=
</varname></term>
1232 <para>The Tunnel Encapsulation Limit option specifies how many additional
1233 levels of encapsulation are permitted to be prepended to the packet.
1234 For example, a Tunnel Encapsulation Limit option containing a limit
1235 value of zero means that a packet carrying that option may not enter
1236 another tunnel before exiting the current tunnel.
1237 (see
<ulink url=
"https://tools.ietf.org/html/rfc2473#section-4.1.1"> RFC
2473</ulink>).
1238 The valid range is
0–
255 and
<literal>none
</literal>. Defaults to
4.
1243 <term><varname>Key=
</varname></term>
1245 <para>The
<varname>Key=
</varname> parameter specifies the same key to use in
1246 both directions (
<varname>InputKey=
</varname> and
<varname>OutputKey=
</varname>).
1247 The
<varname>Key=
</varname> is either a number or an IPv4 address-like dotted quad.
1248 It is used as mark-configured SAD/SPD entry as part of the lookup key (both in data
1249 and control path) in IP XFRM (framework used to implement IPsec protocol).
1250 See
<ulink url=
"http://man7.org/linux/man-pages/man8/ip-xfrm.8.html">
1251 ip-xfrm — transform configuration
</ulink> for details. It is only used for VTI/VTI6,
1252 GRE, GRETAP, and ERSPAN tunnels.
</para>
1256 <term><varname>InputKey=
</varname></term>
1258 <para>The
<varname>InputKey=
</varname> parameter specifies the key to use for input.
1259 The format is same as
<varname>Key=
</varname>. It is only used for VTI/VTI6, GRE, GRETAP,
1260 and ERSPAN tunnels.
</para>
1264 <term><varname>OutputKey=
</varname></term>
1266 <para>The
<varname>OutputKey=
</varname> parameter specifies the key to use for output.
1267 The format is same as
<varname>Key=
</varname>. It is only used for VTI/VTI6, GRE, GRETAP,
1268 and ERSPAN tunnels.
</para>
1272 <term><varname>Mode=
</varname></term>
1274 <para>An
<literal>ip6tnl
</literal> tunnel can be in one of three
1276 <literal>ip6ip6
</literal> for IPv6 over IPv6,
1277 <literal>ipip6
</literal> for IPv4 over IPv6 or
1278 <literal>any
</literal> for either.
1283 <term><varname>Independent=
</varname></term>
1285 <para>Takes a boolean. When true tunnel does not require .network file. Created as
"tunnel@NONE".
1286 Defaults to
<literal>false
</literal>.
1291 <term><varname>AssignToLoopback=
</varname></term>
1293 <para>Takes a boolean. If set to
<literal>yes
</literal>, the loopback interface
<literal>lo
</literal>
1294 is used as the underlying device of the tunnel interface. Defaults to
<literal>no
</literal>.
</para>
1298 <term><varname>AllowLocalRemote=
</varname></term>
1300 <para>Takes a boolean. When true allows tunnel traffic on
<varname>ip6tnl
</varname> devices where the remote endpoint is a local host address.
1301 When unset, the kernel's default will be used.
1306 <term><varname>FooOverUDP=
</varname></term>
1308 <para>Takes a boolean. Specifies whether
<varname>FooOverUDP=
</varname> tunnel is to be configured.
1309 Defaults to false. This takes effects only for IPIP, SIT, GRE, and GRETAP tunnels.
1310 For more detail information see
1311 <ulink url=
"https://lwn.net/Articles/614348">Foo over UDP
</ulink></para>
1315 <term><varname>FOUDestinationPort=
</varname></term>
1317 <para>This setting specifies the UDP destination port for encapsulation.
1318 This field is mandatory when
<varname>FooOverUDP=yes
</varname>, and is not set by default.
</para>
1322 <term><varname>FOUSourcePort=
</varname></term>
1324 <para>This setting specifies the UDP source port for encapsulation. Defaults to
<constant>0</constant>
1325 — that is, the source port for packets is left to the network stack to decide.
</para>
1329 <term><varname>Encapsulation=
</varname></term>
1331 <para>Accepts the same key as in the [FooOverUDP] section.
</para>
1335 <term><varname>IPv6RapidDeploymentPrefix=
</varname></term>
1337 <para>Reconfigure the tunnel for
<ulink url=
"https://tools.ietf.org/html/rfc5569">IPv6 Rapid
1338 Deployment
</ulink>, also known as
6rd. The value is an ISP-specific IPv6 prefix with a non-zero length. Only
1339 applicable to SIT tunnels.
</para>
1343 <term><varname>ISATAP=
</varname></term>
1345 <para>Takes a boolean. If set, configures the tunnel as Intra-Site Automatic Tunnel Addressing Protocol (ISATAP) tunnel.
1346 Only applicable to SIT tunnels. When unset, the kernel's default will be used.
</para>
1350 <term><varname>SerializeTunneledPackets=
</varname></term>
1352 <para>Takes a boolean. If set to yes, then packets are serialized. Only applies for GRE,
1353 GRETAP, and ERSPAN tunnels. When unset, the kernel's default will be used.
1358 <term><varname>ERSPANIndex=
</varname></term>
1360 <para>Specifies the ERSPAN index field for the interface, an integer in the range
1-
1048575 associated with
1361 the ERSPAN traffic's source port and direction. This field is mandatory.
1369 <title>[FooOverUDP] Section Options
</title>
1371 <para>The [FooOverUDP] section only applies for
1372 netdevs of kind
<literal>fou
</literal> and accepts the
1373 following keys:
</para>
1375 <variablelist class='network-directives'
>
1377 <term><varname>Encapsulation=
</varname></term>
1379 <para>Specifies the encapsulation mechanism used to store networking packets of various protocols
1380 inside the UDP packets. Supports the following values:
1382 <literal>FooOverUDP
</literal> provides the simplest no frills model of UDP encapsulation, it simply
1383 encapsulates packets directly in the UDP payload.
<literal>GenericUDPEncapsulation
</literal> is a
1384 generic and extensible encapsulation, it allows encapsulation of packets for any IP protocol and
1385 optional data as part of the encapsulation. For more detailed information see
<ulink
1386 url=
"https://lwn.net/Articles/615044">Generic UDP Encapsulation
</ulink>. Defaults to
1387 <literal>FooOverUDP
</literal>.
1392 <term><varname>Port=
</varname></term>
1394 <para>Specifies the port number, where the IP encapsulation packets will arrive. Please take note
1395 that the packets will arrive with the encapsulation will be removed. Then they will be manually fed
1396 back into the network stack, and sent ahead for delivery to the real destination. This option is
1401 <term><varname>PeerPort=
</varname></term>
1403 <para>Specifies the peer port number. Defaults to unset. Note that when peer port is set
1404 <literal>Peer=
</literal> address is mandatory.
</para>
1408 <term><varname>Protocol=
</varname></term>
1410 <para>The
<varname>Protocol=
</varname> specifies the protocol number of the packets arriving
1411 at the UDP port. When
<varname>Encapsulation=FooOverUDP
</varname>, this field is mandatory
1412 and is not set by default. Takes an IP protocol name such as
<literal>gre
</literal> or
1413 <literal>ipip
</literal>, or an integer within the range
1-
255. When
1414 <varname>Encapsulation=GenericUDPEncapsulation
</varname>, this must not be specified.
</para>
1418 <term><varname>Peer=
</varname></term>
1420 <para>Configures peer IP address. Note that when peer address is set
<literal>PeerPort=
</literal>
1421 is mandatory.
</para>
1425 <term><varname>Local=
</varname></term>
1427 <para>Configures local IP address.
</para>
1434 <title>[Peer] Section Options
</title>
1436 <para>The [Peer] section only applies for
1437 netdevs of kind
<literal>veth
</literal> and accepts the
1438 following keys:
</para>
1440 <variablelist class='network-directives'
>
1442 <term><varname>Name=
</varname></term>
1444 <para>The interface name used when creating the netdev.
1445 This setting is compulsory.
</para>
1449 <term><varname>MACAddress=
</varname></term>
1451 <para>The peer MACAddress, if not set, it is generated in
1452 the same way as the MAC address of the main
1460 <title>[VXCAN] Section Options
</title>
1462 <para>The [VXCAN] section only applies for
1463 netdevs of kind
<literal>vxcan
</literal> and accepts the
1464 following key:
</para>
1466 <variablelist class='network-directives'
>
1468 <term><varname>Peer=
</varname></term>
1470 <para>The peer interface name used when creating the netdev.
1471 This setting is compulsory.
</para>
1478 <title>[Tun] Section Options
</title>
1480 <para>The [Tun] section only applies for
1481 netdevs of kind
<literal>tun
</literal>, and accepts the following
1484 <variablelist class='network-directives'
>
1486 <term><varname>MultiQueue=
</varname></term>
1487 <listitem><para>Takes a boolean. Configures whether
1488 to use multiple file descriptors (queues) to parallelize
1489 packets sending and receiving. Defaults to
1490 <literal>no
</literal>.
</para>
1494 <term><varname>PacketInfo=
</varname></term>
1495 <listitem><para>Takes a boolean. Configures whether
1496 packets should be prepended with four extra bytes (two flag
1497 bytes and two protocol bytes). If disabled, it indicates that
1498 the packets will be pure IP packets. Defaults to
1499 <literal>no
</literal>.
</para>
1503 <term><varname>VNetHeader=
</varname></term>
1504 <listitem><para>Takes a boolean. Configures
1505 IFF_VNET_HDR flag for a tun or tap device. It allows sending
1506 and receiving larger Generic Segmentation Offload (GSO)
1507 packets. This may increase throughput significantly.
1509 <literal>no
</literal>.
</para>
1513 <term><varname>User=
</varname></term>
1514 <listitem><para>User to grant access to the
1515 <filename>/dev/net/tun
</filename> device.
</para>
1519 <term><varname>Group=
</varname></term>
1520 <listitem><para>Group to grant access to the
1521 <filename>/dev/net/tun
</filename> device.
</para>
1528 <title>[Tap] Section Options
</title>
1530 <para>The [Tap] section only applies for
1531 netdevs of kind
<literal>tap
</literal>, and accepts the same keys
1532 as the [Tun] section.
</para>
1536 <title>[WireGuard] Section Options
</title>
1538 <para>The [WireGuard] section accepts the following
1541 <variablelist class='network-directives'
>
1543 <term><varname>PrivateKey=
</varname></term>
1545 <para>The Base64 encoded private key for the interface. It can be
1546 generated using the
<command>wg genkey
</command> command
1547 (see
<citerefentry project=
"wireguard"><refentrytitle>wg
</refentrytitle><manvolnum>8</manvolnum></citerefentry>).
1548 This option or
<varname>PrivateKeyFile=
</varname> is mandatory to use WireGuard.
1549 Note that because this information is secret, you may want to set
1550 the permissions of the .netdev file to be owned by
<literal>root:systemd-network
</literal>
1551 with a
<literal>0640</literal> file mode.
</para>
1555 <term><varname>PrivateKeyFile=
</varname></term>
1557 <para>Takes an absolute path to a file which contains the Base64 encoded private key for the
1558 interface. When this option is specified, then
<varname>PrivateKey=
</varname> is ignored. Note
1559 that the file must be readable by the user
<literal>systemd-network
</literal>, so it should be,
1560 e.g., owned by
<literal>root:systemd-network
</literal> with a
<literal>0640</literal> file mode. If
1561 the path refers to an
<constant>AF_UNIX
</constant> stream socket in the file system a connection is
1562 made to it and the key read from it.
</para>
1566 <term><varname>ListenPort=
</varname></term>
1568 <para>Sets UDP port for listening. Takes either value between
1 and
65535
1569 or
<literal>auto
</literal>. If
<literal>auto
</literal> is specified,
1570 the port is automatically generated based on interface name.
1571 Defaults to
<literal>auto
</literal>.
</para>
1575 <term><varname>FirewallMark=
</varname></term>
1577 <para>Sets a firewall mark on outgoing WireGuard packets from this interface. Takes a number between
1 and
4294967295.
</para>
1584 <title>[WireGuardPeer] Section Options
</title>
1586 <para>The [WireGuardPeer] section accepts the following
1589 <variablelist class='network-directives'
>
1591 <term><varname>PublicKey=
</varname></term>
1593 <para>Sets a Base64 encoded public key calculated by
<command>wg pubkey
</command>
1594 (see
<citerefentry project=
"wireguard"><refentrytitle>wg
</refentrytitle><manvolnum>8</manvolnum></citerefentry>)
1595 from a private key, and usually transmitted out of band to the
1596 author of the configuration file. This option is mandatory for this
1601 <term><varname>PresharedKey=
</varname></term>
1603 <para>Optional preshared key for the interface. It can be generated
1604 by the
<command>wg genpsk
</command> command. This option adds an
1605 additional layer of symmetric-key cryptography to be mixed into the
1606 already existing public-key cryptography, for post-quantum
1608 Note that because this information is secret, you may want to set
1609 the permissions of the .netdev file to be owned by
<literal>root:systemd-network
</literal>
1610 with a
<literal>0640</literal> file mode.
</para>
1614 <term><varname>PresharedKeyFile=
</varname></term>
1616 <para>Takes an absolute path to a file which contains the Base64 encoded preshared key for the
1617 peer. When this option is specified, then
<varname>PresharedKey=
</varname> is ignored. Note that
1618 the file must be readable by the user
<literal>systemd-network
</literal>, so it should be, e.g.,
1619 owned by
<literal>root:systemd-network
</literal> with a
<literal>0640</literal> file mode. If the
1620 path refers to an
<constant>AF_UNIX
</constant> stream socket in the file system a connection is
1621 made to it and the key read from it.
</para>
1625 <term><varname>AllowedIPs=
</varname></term>
1627 <para>Sets a comma-separated list of IP (v4 or v6) addresses with CIDR masks
1628 from which this peer is allowed to send incoming traffic and to
1629 which outgoing traffic for this peer is directed. The catch-all
1630 0.0.0.0/
0 may be specified for matching all IPv4 addresses, and
1631 ::/
0 may be specified for matching all IPv6 addresses.
</para>
1635 <term><varname>Endpoint=
</varname></term>
1637 <para>Sets an endpoint IP address or hostname, followed by a colon, and then
1638 a port number. This endpoint will be updated automatically once to
1639 the most recent source IP address and port of correctly
1640 authenticated packets from the peer at configuration time.
</para>
1644 <term><varname>PersistentKeepalive=
</varname></term>
1646 <para>Sets a seconds interval, between
1 and
65535 inclusive, of how often
1647 to send an authenticated empty packet to the peer for the purpose
1648 of keeping a stateful firewall or NAT mapping valid persistently.
1649 For example, if the interface very rarely sends traffic, but it
1650 might at anytime receive traffic from a peer, and it is behind NAT,
1651 the interface might benefit from having a persistent keepalive
1652 interval of
25 seconds. If set to
0 or
"off", this option is
1653 disabled. By default or when unspecified, this option is off.
1654 Most users will not need this.
</para>
1661 <title>[Bond] Section Options
</title>
1663 <para>The [Bond] section accepts the following
1666 <variablelist class='network-directives'
>
1668 <term><varname>Mode=
</varname></term>
1670 <para>Specifies one of the bonding policies. The default is
1671 <literal>balance-rr
</literal> (round robin). Possible values are
1672 <literal>balance-rr
</literal>,
1673 <literal>active-backup
</literal>,
1674 <literal>balance-xor
</literal>,
1675 <literal>broadcast
</literal>,
1676 <literal>802.3ad
</literal>,
1677 <literal>balance-tlb
</literal>, and
1678 <literal>balance-alb
</literal>.
1684 <term><varname>TransmitHashPolicy=
</varname></term>
1686 <para>Selects the transmit hash policy to use for slave
1687 selection in balance-xor,
802.3ad, and tlb modes. Possible
1689 <literal>layer2
</literal>,
1690 <literal>layer3+
4</literal>,
1691 <literal>layer2+
3</literal>,
1692 <literal>encap2+
3</literal>, and
1693 <literal>encap3+
4</literal>.
1699 <term><varname>LACPTransmitRate=
</varname></term>
1701 <para>Specifies the rate with which link partner transmits
1702 Link Aggregation Control Protocol Data Unit packets in
1703 802.3ad mode. Possible values are
<literal>slow
</literal>,
1704 which requests partner to transmit LACPDUs every
30 seconds,
1705 and
<literal>fast
</literal>, which requests partner to
1706 transmit LACPDUs every second. The default value is
1707 <literal>slow
</literal>.
</para>
1712 <term><varname>MIIMonitorSec=
</varname></term>
1714 <para>Specifies the frequency that Media Independent
1715 Interface link monitoring will occur. A value of zero
1716 disables MII link monitoring. This value is rounded down to
1717 the nearest millisecond. The default value is
0.
</para>
1722 <term><varname>UpDelaySec=
</varname></term>
1724 <para>Specifies the delay before a link is enabled after a
1725 link up status has been detected. This value is rounded down
1726 to a multiple of MIIMonitorSec. The default value is
1732 <term><varname>DownDelaySec=
</varname></term>
1734 <para>Specifies the delay before a link is disabled after a
1735 link down status has been detected. This value is rounded
1736 down to a multiple of MIIMonitorSec. The default value is
1742 <term><varname>LearnPacketIntervalSec=
</varname></term>
1744 <para>Specifies the number of seconds between instances where the bonding
1745 driver sends learning packets to each slave peer switch.
1746 The valid range is
1–
0x7fffffff; the default value is
1. This option
1747 has an effect only for the balance-tlb and balance-alb modes.
</para>
1752 <term><varname>AdSelect=
</varname></term>
1754 <para>Specifies the
802.3ad aggregation selection logic to use. Possible values are
1755 <literal>stable
</literal>,
1756 <literal>bandwidth
</literal> and
1757 <literal>count
</literal>.
1763 <term><varname>AdActorSystemPriority=
</varname></term>
1765 <para>Specifies the
802.3ad actor system priority. Takes a number in the range
1—
65535.
</para>
1770 <term><varname>AdUserPortKey=
</varname></term>
1772 <para>Specifies the
802.3ad user defined portion of the port key. Takes a number in the range
1778 <term><varname>AdActorSystem=
</varname></term>
1780 <para>Specifies the
802.3ad system mac address. This can not be either NULL or Multicast.
</para>
1785 <term><varname>FailOverMACPolicy=
</varname></term>
1787 <para>Specifies whether the active-backup mode should set all slaves to
1788 the same MAC address at the time of enslavement or, when enabled, to perform special handling of the
1789 bond's MAC address in accordance with the selected policy. The default policy is none.
1791 <literal>none
</literal>,
1792 <literal>active
</literal> and
1793 <literal>follow
</literal>.
1799 <term><varname>ARPValidate=
</varname></term>
1801 <para>Specifies whether or not ARP probes and replies should be
1802 validated in any mode that supports ARP monitoring, or whether
1803 non-ARP traffic should be filtered (disregarded) for link
1804 monitoring purposes. Possible values are
1805 <literal>none
</literal>,
1806 <literal>active
</literal>,
1807 <literal>backup
</literal> and
1808 <literal>all
</literal>.
1814 <term><varname>ARPIntervalSec=
</varname></term>
1816 <para>Specifies the ARP link monitoring frequency. A value of
0 disables ARP monitoring. The
1817 default value is
0, and the default unit seconds.
1823 <term><varname>ARPIPTargets=
</varname></term>
1825 <para>Specifies the IP addresses to use as ARP monitoring peers when
1826 ARPIntervalSec is greater than
0. These are the targets of the ARP request
1827 sent to determine the health of the link to the targets.
1828 Specify these values in IPv4 dotted decimal format. At least one IP
1829 address must be given for ARP monitoring to function. The
1830 maximum number of targets that can be specified is
16. The
1831 default value is no IP addresses.
1837 <term><varname>ARPAllTargets=
</varname></term>
1839 <para>Specifies the quantity of ARPIPTargets that must be reachable
1840 in order for the ARP monitor to consider a slave as being up.
1841 This option affects only active-backup mode for slaves with
1842 ARPValidate enabled. Possible values are
1843 <literal>any
</literal> and
1844 <literal>all
</literal>.
1850 <term><varname>PrimaryReselectPolicy=
</varname></term>
1852 <para>Specifies the reselection policy for the primary slave. This
1853 affects how the primary slave is chosen to become the active slave
1854 when failure of the active slave or recovery of the primary slave
1855 occurs. This option is designed to prevent flip-flopping between
1856 the primary slave and other slaves. Possible values are
1857 <literal>always
</literal>,
1858 <literal>better
</literal> and
1859 <literal>failure
</literal>.
1865 <term><varname>ResendIGMP=
</varname></term>
1867 <para>Specifies the number of IGMP membership reports to be issued after
1868 a failover event. One membership report is issued immediately after
1869 the failover, subsequent packets are sent in each
200ms interval.
1870 The valid range is
0–
255. Defaults to
1. A value of
0
1871 prevents the IGMP membership report from being issued in response
1872 to the failover event.
1878 <term><varname>PacketsPerSlave=
</varname></term>
1880 <para>Specify the number of packets to transmit through a slave before
1881 moving to the next one. When set to
0, then a slave is chosen at
1882 random. The valid range is
0–
65535. Defaults to
1. This option
1883 only has effect when in balance-rr mode.
1889 <term><varname>GratuitousARP=
</varname></term>
1891 <para>Specify the number of peer notifications (gratuitous ARPs and
1892 unsolicited IPv6 Neighbor Advertisements) to be issued after a
1893 failover event. As soon as the link is up on the new slave,
1894 a peer notification is sent on the bonding device and each
1895 VLAN sub-device. This is repeated at each link monitor interval
1896 (ARPIntervalSec or MIIMonitorSec, whichever is active) if the number is
1897 greater than
1. The valid range is
0–
255. The default value is
1.
1898 These options affect only the active-backup mode.
1904 <term><varname>AllSlavesActive=
</varname></term>
1906 <para>Takes a boolean. Specifies that duplicate frames (received on inactive ports)
1907 should be dropped when false, or delivered when true. Normally, bonding will drop
1908 duplicate frames (received on inactive ports), which is desirable for
1909 most users. But there are some times it is nice to allow duplicate
1910 frames to be delivered. The default value is false (drop duplicate frames
1911 received on inactive ports).
1917 <term><varname>DynamicTransmitLoadBalancing=
</varname></term>
1919 <para>Takes a boolean. Specifies if dynamic shuffling of flows is enabled. Applies only
1920 for balance-tlb mode. Defaults to unset.
1926 <term><varname>MinLinks=
</varname></term>
1928 <para>Specifies the minimum number of links that must be active before
1929 asserting carrier. The default value is
0.
1935 <para>For more detail information see
1936 <ulink url=
"https://www.kernel.org/doc/Documentation/networking/bonding.txt">
1937 Linux Ethernet Bonding Driver HOWTO
</ulink></para>
1941 <title>[Xfrm] Section Options
</title>
1943 <para>The [Xfrm] section accepts the following
1946 <variablelist class='network-directives'
>
1948 <term><varname>InterfaceId=
</varname></term>
1950 <para>Sets the ID/key of the xfrm interface which needs to be associated with a SA/policy.
1951 Can be decimal or hexadecimal, valid range is
0-
0xffffffff, defaults to
0.
</para>
1955 <term><varname>Independent=
</varname></term>
1957 <para>Takes a boolean. If set to
<literal>no
</literal>, the xfrm interface should have an
1958 underlying device which can be used for hardware offloading. Defaults to
<literal>no
</literal>.
1959 See
<citerefentry><refentrytitle>systemd.network
</refentrytitle><manvolnum>5</manvolnum></citerefentry>
1960 for how to configure the underlying device.
</para>
1965 <para>For more detail information see
1966 <ulink url=
"https://lwn.net/Articles/757391">Virtual XFRM Interfaces
</ulink>.
</para>
1970 <title>[VRF] Section Options
</title>
1971 <para>The [VRF] section only applies for
1972 netdevs of kind
<literal>vrf
</literal> and accepts the
1973 following key:
</para>
1975 <variablelist class='network-directives'
>
1977 <term><varname>Table=
</varname></term>
1979 <para>The numeric routing table identifier. This setting is compulsory.
</para>
1986 <title>Examples
</title>
1988 <title>/etc/systemd/network/
25-bridge.netdev
</title>
1990 <programlisting>[NetDev]
1992 Kind=bridge
</programlisting>
1996 <title>/etc/systemd/network/
25-vlan1.netdev
</title>
1998 <programlisting>[Match]
2006 Id=
1</programlisting>
2009 <title>/etc/systemd/network/
25-ipip.netdev
</title>
2010 <programlisting>[NetDev]
2016 Local=
192.168.223.238
2017 Remote=
192.169.224.239
2018 TTL=
64</programlisting>
2021 <title>/etc/systemd/network/
1-fou-tunnel.netdev
</title>
2022 <programlisting>[NetDev]
2032 <title>/etc/systemd/network/
25-fou-ipip.netdev
</title>
2033 <programlisting>[NetDev]
2040 Remote=
10.65.208.211
2042 FOUDestinationPort=
5555
2046 <title>/etc/systemd/network/
25-tap.netdev
</title>
2047 <programlisting>[NetDev]
2053 PacketInfo=yes
</programlisting> </example>
2056 <title>/etc/systemd/network/
25-sit.netdev
</title>
2057 <programlisting>[NetDev]
2064 Remote=
10.65.223.239</programlisting>
2068 <title>/etc/systemd/network/
25-
6rd.netdev
</title>
2069 <programlisting>[NetDev]
2076 IPv6RapidDeploymentPrefix=
2602::/
24</programlisting>
2080 <title>/etc/systemd/network/
25-gre.netdev
</title>
2081 <programlisting>[NetDev]
2088 Remote=
10.65.223.239</programlisting>
2092 <title>/etc/systemd/network/
25-ip6gre.netdev
</title>
2093 <programlisting>[NetDev]
2098 Key=
123</programlisting>
2102 <title>/etc/systemd/network/
25-vti.netdev
</title>
2104 <programlisting>[NetDev]
2111 Remote=
10.65.223.239</programlisting>
2115 <title>/etc/systemd/network/
25-veth.netdev
</title>
2116 <programlisting>[NetDev]
2121 Name=veth-peer
</programlisting>
2125 <title>/etc/systemd/network/
25-bond.netdev
</title>
2126 <programlisting>[NetDev]
2132 TransmitHashPolicy=layer3+
4
2134 LACPTransmitRate=fast
2139 <title>/etc/systemd/network/
25-dummy.netdev
</title>
2140 <programlisting>[NetDev]
2143 MACAddress=
12:
34:
56:
78:
9a:bc
</programlisting>
2146 <title>/etc/systemd/network/
25-vrf.netdev
</title>
2147 <para>Create a VRF interface with table
42.
</para>
2148 <programlisting>[NetDev]
2153 Table=
42</programlisting>
2157 <title>/etc/systemd/network/
25-macvtap.netdev
</title>
2158 <para>Create a MacVTap device.
</para>
2159 <programlisting>[NetDev]
2165 <title>/etc/systemd/network/
25-wireguard.netdev
</title>
2166 <programlisting>[NetDev]
2171 PrivateKey=EEGlnEPYJV//kbvvIqxKkQwOiS+UENyPncC4bF46ong=
2175 PublicKey=RDf+LSpeEre7YEIKaxg+wbpsNV7du+ktR99uBEtIiCA=
2176 AllowedIPs=fd31:bf08:
57cb::/
48,
192.168.26.0/
24
2177 Endpoint=wireguard.example.com:
51820</programlisting>
2181 <title>/etc/systemd/network/
27-xfrm.netdev
</title>
2182 <programlisting>[NetDev]
2187 Independent=yes
</programlisting>
2192 <title>See Also
</title>
2194 <citerefentry><refentrytitle>systemd
</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
2195 <citerefentry><refentrytitle>systemd-networkd
</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
2196 <citerefentry><refentrytitle>systemd.link
</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
2197 <citerefentry><refentrytitle>systemd.network
</refentrytitle><manvolnum>5</manvolnum></citerefentry>
projects / thirdparty / systemd.git / blob