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 -->
6 <refentry id=
"systemd.netdev" conditional='ENABLE_NETWORKD'
7 xmlns:
xi=
"http://www.w3.org/2001/XInclude">
10 <title>systemd.network
</title>
11 <productname>systemd
</productname>
15 <refentrytitle>systemd.netdev
</refentrytitle>
16 <manvolnum>5</manvolnum>
20 <refname>systemd.netdev
</refname>
21 <refpurpose>Virtual Network Device configuration
</refpurpose>
25 <para><filename><replaceable>netdev
</replaceable>.netdev
</filename></para>
29 <title>Description
</title>
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>
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
42 <para>The
<filename>.netdev
</filename> files are read from the files located in the system network
43 directory
<filename>/usr/lib/systemd/network
</filename> and
44 <filename>/usr/local/lib/systemd/network
</filename>, the volatile runtime network directory
45 <filename>/run/systemd/network
</filename> and the local administration network directory
46 <filename>/etc/systemd/network
</filename>. All configuration files are collectively sorted and
47 processed in alphanumeric order, regardless of the directories in which they live. However, files
48 with identical filenames replace each other. It is recommended that each filename is prefixed with
49 a number (e.g.
<filename>10-vlan.netdev
</filename>). Otherwise,
<filename>.netdev
</filename> files
51 <citerefentry><refentrytitle>systemd-network-generator.service
</refentrytitle><manvolnum>8</manvolnum></citerefentry>
52 may take precedence over user configured files. Files in
<filename>/etc/
</filename> have the
53 highest priority, files in
<filename>/run/
</filename> take precedence over files with the same name
54 in
<filename>/usr/lib/
</filename>. This can be used to override a system-supplied configuration
55 file with a local file if needed. As a special case, an empty file (file size
0) or symlink with
56 the same name pointing to
<filename>/dev/null
</filename> disables the configuration file entirely
57 (it is
"masked").
</para>
59 <para>Along with the netdev file
<filename>foo.netdev
</filename>, a
"drop-in" directory
60 <filename>foo.netdev.d/
</filename> may exist. All files with the suffix
<literal>.conf
</literal>
61 from this directory will be merged in the alphanumeric order and parsed after the main file itself
62 has been parsed. This is useful to alter or add configuration settings, without having to modify
63 the main configuration file. Each drop-in file must have appropriate section headers.
</para>
65 <para>In addition to
<filename>/etc/systemd/network
</filename>, drop-in
<literal>.d
</literal>
66 directories can be placed in
<filename>/usr/lib/systemd/network
</filename> or
67 <filename>/run/systemd/network
</filename> directories. Drop-in files in
68 <filename>/etc/
</filename> take precedence over those in
<filename>/run/
</filename> which in turn
69 take precedence over those in
<filename>/usr/lib/
</filename>. Drop-in files under any of these
70 directories take precedence over the main netdev file wherever located. (Of course, since
71 <filename>/run/
</filename> is temporary and
<filename>/usr/lib/
</filename> is for vendors, it is
72 unlikely drop-ins should be used in either of those places.)
</para>
76 <title>Supported netdev kinds
</title>
78 <para>The following kinds of virtual network devices may be
79 configured in
<filename>.netdev
</filename> files:
</para>
82 <title>Supported kinds of virtual network devices
</title>
85 <colspec colname='kind'
/>
86 <colspec colname='explanation'
/>
89 <entry>Description
</entry>
92 <row><entry><varname>bond
</varname></entry>
93 <entry>A bond device is an aggregation of all its slave devices. See
<ulink url=
"https://docs.kernel.org/networking/bonding.html">Linux Ethernet Bonding Driver HOWTO
</ulink> for details.
</entry></row>
95 <row><entry><varname>bridge
</varname></entry>
96 <entry>A bridge device is a software switch, and each of its slave devices and the bridge itself are ports of the switch.
</entry></row>
98 <row><entry><varname>dummy
</varname></entry>
99 <entry>A dummy device drops all packets sent to it.
</entry></row>
101 <row><entry><varname>gre
</varname></entry>
102 <entry>A Level
3 GRE tunnel over IPv4. See
<ulink url=
"https://tools.ietf.org/html/rfc2784">RFC
2784</ulink> for details. Name
<literal>gre0
</literal> should not be used, as the kernel creates a device with this name when the corresponding kernel module is loaded.
</entry></row>
104 <row><entry><varname>gretap
</varname></entry>
105 <entry>A Level
2 GRE tunnel over IPv4. Name
<literal>gretap0
</literal> should not be used, as the kernel creates a device with this name when the corresponding kernel module is loaded.
</entry></row>
107 <row><entry><varname>erspan
</varname></entry>
108 <entry>ERSPAN mirrors traffic on one or more source ports and delivers the mirrored traffic to one or more destination ports on another switch. The traffic is encapsulated in generic routing encapsulation (GRE) and is therefore routable across a layer
3 network between the source switch and the destination switch. Name
<literal>erspan0
</literal> should not be used, as the kernel creates a device with this name when the corresponding kernel module is loaded.
</entry></row>
110 <row><entry><varname>ip6gre
</varname></entry>
111 <entry>A Level
3 GRE tunnel over IPv6.
</entry></row>
113 <row><entry><varname>ip6tnl
</varname></entry>
114 <entry>An IPv4 or IPv6 tunnel over IPv6
</entry></row>
116 <row><entry><varname>ip6gretap
</varname></entry>
117 <entry>A Level
2 GRE tunnel over IPv6.
</entry></row>
119 <row><entry><varname>ipip
</varname></entry>
120 <entry>An IPv4 over IPv4 tunnel.
</entry></row>
122 <row><entry><varname>ipvlan
</varname></entry>
123 <entry>An IPVLAN device is a stacked device which receives packets from its underlying device based on IP address filtering.
</entry></row>
125 <row><entry><varname>ipvtap
</varname></entry>
126 <entry>An IPVTAP device is a stacked device which receives packets from its underlying device based on IP address filtering and can be accessed using the tap user space interface.
</entry></row>
128 <row><entry><varname>macvlan
</varname></entry>
129 <entry>A macvlan device is a stacked device which receives packets from its underlying device based on MAC address filtering.
</entry></row>
131 <row><entry><varname>macvtap
</varname></entry>
132 <entry>A macvtap device is a stacked device which receives packets from its underlying device based on MAC address filtering.
</entry></row>
134 <row><entry><varname>sit
</varname></entry>
135 <entry>An IPv6 over IPv4 tunnel.
</entry></row>
137 <row><entry><varname>tap
</varname></entry>
138 <entry>A persistent Level
2 tunnel between a network device and a device node.
</entry></row>
140 <row><entry><varname>tun
</varname></entry>
141 <entry>A persistent Level
3 tunnel between a network device and a device node.
</entry></row>
143 <row><entry><varname>veth
</varname></entry>
144 <entry>An Ethernet tunnel between a pair of network devices.
</entry></row>
146 <row><entry><varname>vlan
</varname></entry>
147 <entry>A VLAN is a stacked device which receives packets from its underlying device based on VLAN tagging. See
<ulink url=
"http://www.ieee802.org/1/pages/802.1Q.html">IEEE
802.1Q
</ulink> for details.
</entry></row>
149 <row><entry><varname>vti
</varname></entry>
150 <entry>An IPv4 over IPSec tunnel.
</entry></row>
152 <row><entry><varname>vti6
</varname></entry>
153 <entry>An IPv6 over IPSec tunnel.
</entry></row>
155 <row><entry><varname>vxlan
</varname></entry>
156 <entry>A virtual extensible LAN (vxlan), for connecting Cloud computing deployments.
</entry></row>
158 <row><entry><varname>geneve
</varname></entry>
159 <entry>A GEneric NEtwork Virtualization Encapsulation (GENEVE) netdev driver.
</entry></row>
161 <row><entry><varname>l2tp
</varname></entry>
162 <entry>A Layer
2 Tunneling Protocol (L2TP) is a tunneling protocol used to support virtual private networks (VPNs) or as part of the delivery of services by ISPs. It does not provide any encryption or confidentiality by itself
</entry></row>
164 <row><entry><varname>macsec
</varname></entry>
165 <entry>Media Access Control Security (MACsec) is an
802.1AE IEEE industry-standard security technology that provides secure communication for all traffic on Ethernet links. MACsec provides point-to-point security on Ethernet links between directly connected nodes and is capable of identifying and preventing most security threats.
</entry></row>
167 <row><entry><varname>vrf
</varname></entry>
168 <entry>A Virtual Routing and Forwarding (
<ulink url=
"https://docs.kernel.org/networking/vrf.html">VRF
</ulink>) interface to create separate routing and forwarding domains.
</entry></row>
170 <row><entry><varname>vcan
</varname></entry>
171 <entry>The virtual CAN driver (vcan). Similar to the network loopback devices, vcan offers a virtual local CAN interface.
</entry></row>
173 <row><entry><varname>vxcan
</varname></entry>
174 <entry>The virtual CAN tunnel driver (vxcan). Similar to the virtual ethernet driver veth, vxcan implements a local CAN traffic tunnel between two virtual CAN network devices. When creating a vxcan, two vxcan devices are created as pair. When one end receives the packet it appears on its pair and vice versa. The vxcan can be used for cross namespace communication.
177 <row><entry><varname>wireguard
</varname></entry>
178 <entry>WireGuard Secure Network Tunnel.
</entry></row>
180 <row><entry><varname>nlmon
</varname></entry>
181 <entry>A Netlink monitor device. Use an nlmon device when you want to monitor system Netlink messages.
</entry></row>
183 <row><entry><varname>fou
</varname></entry>
184 <entry>Foo-over-UDP tunneling.
</entry></row>
186 <row><entry><varname>xfrm
</varname></entry>
187 <entry>A virtual tunnel interface like vti/vti6 but with several advantages.
</entry></row>
189 <row><entry><varname>ifb
</varname></entry>
190 <entry>The Intermediate Functional Block (ifb) pseudo network interface acts as a QoS concentrator for multiple different sources of traffic.
</entry></row>
192 <row><entry><varname>bareudp
</varname></entry>
193 <entry>Bare UDP tunnels provide a generic L3 encapsulation support for tunnelling different L3 protocols like MPLS, IP etc. inside of a UDP tunnel.
</entry></row>
195 <row><entry><varname>batadv
</varname></entry>
196 <entry><ulink url=
"https://www.open-mesh.org/projects/open-mesh/wiki">B.A.T.M.A.N. Advanced
</ulink> is a routing protocol for multi-hop mobile ad-hoc networks which operates on layer
2.
</entry></row>
198 <row><entry><varname>ipoib
</varname></entry>
199 <entry>An IP over Infiniband subinterface.
</entry></row>
201 <row><entry><varname>wlan
</varname></entry>
202 <entry>A virtual wireless network (WLAN) interface.
</entry></row>
210 <title>[Match] Section Options
</title>
212 <para>A virtual network device is only created if the [Match] section matches the current
213 environment, or if the section is empty. The following keys are accepted:
</para>
215 <variablelist class='network-directives'
>
216 <xi:include href=
"systemd.link.xml" xpointer=
"host" />
217 <xi:include href=
"systemd.link.xml" xpointer=
"virtualization" />
218 <xi:include href=
"systemd.link.xml" xpointer=
"kernel-command-line" />
219 <xi:include href=
"systemd.link.xml" xpointer=
"kernel-version" />
220 <xi:include href=
"systemd.link.xml" xpointer=
"credential" />
221 <xi:include href=
"systemd.link.xml" xpointer=
"architecture" />
222 <xi:include href=
"systemd.link.xml" xpointer=
"firmware" />
227 <title>[NetDev] Section Options
</title>
229 <para>The [NetDev] section accepts the
230 following keys:
</para>
232 <variablelist class='network-directives'
>
234 <term><varname>Description=
</varname></term>
236 <para>A free-form description of the netdev.
</para>
238 <xi:include href=
"version-info.xml" xpointer=
"v215"/>
242 <term><varname>Name=
</varname></term>
244 <para>The interface name used when creating the netdev.
245 This setting is compulsory.
</para>
249 <term><varname>Kind=
</varname></term>
251 <para>The netdev kind. This setting is compulsory. See the
252 <literal>Supported netdev kinds
</literal> section for the
257 <term><varname>MTUBytes=
</varname></term>
259 <para>The maximum transmission unit in bytes to set for the device. The usual suffixes K, M, G
260 are supported and are understood to the base of
1024. For
<literal>tun
</literal> or
261 <literal>tap
</literal> devices,
<varname>MTUBytes=
</varname> setting is not currently supported in
262 [NetDev] section. Please specify it in [Link] section of
264 <citerefentry><refentrytitle>systemd.network
</refentrytitle><manvolnum>5</manvolnum></citerefentry>
267 <xi:include href=
"version-info.xml" xpointer=
"v215"/>
271 <term><varname>MACAddress=
</varname></term>
273 <para>Specifies the MAC address to use for the device, or takes the special value
274 <literal>none
</literal>. When
<literal>none
</literal>,
<command>systemd-networkd
</command>
275 does not request the MAC address for the device, and the kernel will assign a random MAC
276 address. For
<literal>tun
</literal>,
<literal>tap
</literal>, or
<literal>l2tp
</literal>
277 devices, the
<varname>MACAddress=
</varname> setting in the [NetDev] section is not
278 supported and will be ignored. Please specify it in the [Link] section of the corresponding
279 <citerefentry><refentrytitle>systemd.network
</refentrytitle><manvolnum>5</manvolnum></citerefentry>
280 file. If this option is not set,
<literal>vlan
</literal> device inherits the MAC address of
281 the master interface. For other kind of netdevs, if this option is not set, then the MAC
282 address is generated based on the interface name and the
283 <citerefentry><refentrytitle>machine-id
</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
285 <para>Note, even if
<literal>none
</literal> is specified,
<command>systemd-udevd
</command>
286 will assign the persistent MAC address for the device, as
<filename>99-default.link
</filename>
287 has
<varname>MACAddressPolicy=persistent
</varname>. So, it is also necessary to create a
288 custom .link file for the device, if the MAC address assignment is not desired.
</para>
290 <xi:include href=
"version-info.xml" xpointer=
"v215"/>
297 <title>[Bridge] Section Options
</title>
299 <para>The [Bridge] section only applies for
300 netdevs of kind
<literal>bridge
</literal>, and accepts the
301 following keys:
</para>
303 <variablelist class='network-directives'
>
305 <term><varname>HelloTimeSec=
</varname></term>
307 <para>HelloTimeSec specifies the number of seconds between two hello packets
308 sent out by the root bridge and the designated bridges. Hello packets are
309 used to communicate information about the topology throughout the entire
310 bridged local area network.
</para>
312 <xi:include href=
"version-info.xml" xpointer=
"v227"/>
316 <term><varname>MaxAgeSec=
</varname></term>
318 <para>MaxAgeSec specifies the number of seconds of maximum message age.
319 If the last seen (received) hello packet is more than this number of
320 seconds old, the bridge in question will start the takeover procedure
321 in attempt to become the Root Bridge itself.
</para>
323 <xi:include href=
"version-info.xml" xpointer=
"v227"/>
327 <term><varname>ForwardDelaySec=
</varname></term>
329 <para>ForwardDelaySec specifies the number of seconds spent in each
330 of the Listening and Learning states before the Forwarding state is entered.
</para>
332 <xi:include href=
"version-info.xml" xpointer=
"v227"/>
336 <term><varname>AgeingTimeSec=
</varname></term>
338 <para>This specifies the number of seconds a MAC Address will be kept in
339 the forwarding database after having a packet received from this MAC Address.
</para>
341 <xi:include href=
"version-info.xml" xpointer=
"v232"/>
345 <term><varname>Priority=
</varname></term>
347 <para>The priority of the bridge. An integer between
0 and
65535. A lower value
348 means higher priority. The bridge having the lowest priority will be elected as root bridge.
</para>
350 <xi:include href=
"version-info.xml" xpointer=
"v232"/>
354 <term><varname>GroupForwardMask=
</varname></term>
356 <para>A
16-bit bitmask represented as an integer which allows forwarding of link
357 local frames with
802.1D reserved addresses (
01:
80:C2:
00:
00:
0X). A logical AND
358 is performed between the specified bitmask and the exponentiation of
2^X, the
359 lower nibble of the last octet of the MAC address. For example, a value of
8
360 would allow forwarding of frames addressed to
01:
80:C2:
00:
00:
03 (
802.1X PAE).
</para>
362 <xi:include href=
"version-info.xml" xpointer=
"v235"/>
366 <term><varname>DefaultPVID=
</varname></term>
368 <para>This specifies the default port VLAN ID of a newly attached bridge port.
369 Set this to an integer in the range
1…
4094 or
<literal>none
</literal> to disable the PVID.
</para>
371 <xi:include href=
"version-info.xml" xpointer=
"v232"/>
375 <term><varname>MulticastQuerier=
</varname></term>
377 <para>Takes a boolean. This setting controls the IFLA_BR_MCAST_QUERIER option in the kernel.
378 If enabled, the kernel will send general ICMP queries from a zero source address.
379 This feature should allow faster convergence on startup, but it causes some
380 multicast-aware switches to misbehave and disrupt forwarding of multicast packets.
381 When unset, the kernel's default will be used.
384 <xi:include href=
"version-info.xml" xpointer=
"v230"/>
388 <term><varname>MulticastSnooping=
</varname></term>
390 <para>Takes a boolean. This setting controls the IFLA_BR_MCAST_SNOOPING option in the kernel.
391 If enabled, IGMP snooping monitors the Internet Group Management Protocol (IGMP) traffic
392 between hosts and multicast routers. When unset, the kernel's default will be used.
395 <xi:include href=
"version-info.xml" xpointer=
"v230"/>
399 <term><varname>VLANFiltering=
</varname></term>
401 <para>Takes a boolean. This setting controls the IFLA_BR_VLAN_FILTERING option in the kernel.
402 If enabled, the bridge will be started in VLAN-filtering mode. When unset, the kernel's default will be used.
405 <xi:include href=
"version-info.xml" xpointer=
"v231"/>
409 <term><varname>VLANProtocol=
</varname></term>
411 <para>Allows setting the protocol used for VLAN filtering. Takes
412 <option>802.1q
</option> or,
413 <option>802.1ad
</option>, and defaults to unset and kernel's default is used.
416 <xi:include href=
"version-info.xml" xpointer=
"v246"/>
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.
426 <xi:include href=
"version-info.xml" xpointer=
"v232"/>
430 <term><varname>MulticastIGMPVersion=
</varname></term>
432 <para>Allows changing bridge's multicast Internet Group Management Protocol (IGMP) version.
433 Takes an integer
2 or
3. When unset, the kernel's default will be used.
436 <xi:include href=
"version-info.xml" xpointer=
"v243"/>
443 <title>[VLAN] Section Options
</title>
445 <para>The [VLAN] section only applies for
446 netdevs of kind
<literal>vlan
</literal>, and accepts the
447 following key:
</para>
449 <variablelist class='network-directives'
>
451 <term><varname>Id=
</varname></term>
453 <para>The VLAN ID to use. An integer in the range
0…
4094.
454 This setting is compulsory.
</para>
458 <term><varname>Protocol=
</varname></term>
460 <para>Allows setting the protocol used for the VLAN interface. Takes
<literal>802.1q
</literal> or,
461 <literal>802.1ad
</literal>, and defaults to unset and kernel's default is used.
</para>
463 <xi:include href=
"version-info.xml" xpointer=
"v248"/>
467 <term><varname>GVRP=
</varname></term>
469 <para>Takes a boolean. The Generic VLAN Registration Protocol (GVRP) is a protocol that
470 allows automatic learning of VLANs on a network.
471 When unset, the kernel's default will be used.
474 <xi:include href=
"version-info.xml" xpointer=
"v234"/>
478 <term><varname>MVRP=
</varname></term>
480 <para>Takes a boolean. Multiple VLAN Registration Protocol (MVRP) formerly known as GARP VLAN
481 Registration Protocol (GVRP) is a standards-based Layer
2 network protocol,
482 for automatic configuration of VLAN information on switches. It was defined
483 in the
802.1ak amendment to
802.1Q-
2005. When unset, the kernel's default will be used.
486 <xi:include href=
"version-info.xml" xpointer=
"v234"/>
490 <term><varname>LooseBinding=
</varname></term>
492 <para>Takes a boolean. The VLAN loose binding mode, in which only the operational state is passed
493 from the parent to the associated VLANs, but the VLAN device state is not changed.
494 When unset, the kernel's default will be used.
</para>
496 <xi:include href=
"version-info.xml" xpointer=
"v234"/>
500 <term><varname>ReorderHeader=
</varname></term>
502 <para>Takes a boolean. When enabled, the VLAN reorder header is used and VLAN interfaces behave
503 like physical interfaces. When unset, the kernel's default will be used.
</para>
505 <xi:include href=
"version-info.xml" xpointer=
"v234"/>
509 <term><varname>EgressQOSMaps=
</varname></term>
510 <term><varname>IngressQOSMaps=
</varname></term>
512 <para>Defines a mapping of Linux internal packet priority (
<constant>SO_PRIORITY
</constant>)
513 to VLAN header PCP field for outgoing and incoming frames, respectively. Takes a
514 whitespace-separated list of integer pairs, where each integer must be in the range
515 1…
4294967294, in the format
<literal>from
</literal>-
<literal>to
</literal>, e.g.,
516 <literal>21-
7 45-
5</literal>. Note that
<literal>from
</literal> must be greater than or equal
517 to
<literal>to
</literal>. When unset, the kernel's default will be used.
</para>
524 <title>[MACVLAN] Section Options
</title>
526 <para>The [MACVLAN] section only applies for
527 netdevs of kind
<literal>macvlan
</literal>, and accepts the
528 following key:
</para>
530 <variablelist class='network-directives'
>
532 <term><varname>Mode=
</varname></term>
534 <para>The MACVLAN mode to use. The supported options are
535 <literal>private
</literal>,
536 <literal>vepa
</literal>,
537 <literal>bridge
</literal>,
538 <literal>passthru
</literal>, and
539 <literal>source
</literal>.
544 <term><varname>SourceMACAddress=
</varname></term>
546 <para>A whitespace-separated list of remote hardware addresses allowed on the MACVLAN. This
547 option only has an effect in source mode. Use full colon-, hyphen- or dot-delimited
548 hexadecimal. This option may appear more than once, in which case the lists are merged. If
549 the empty string is assigned to this option, the list of hardware addresses defined prior
550 to this is reset. Defaults to unset.
</para>
552 <xi:include href=
"version-info.xml" xpointer=
"v246"/>
556 <term><varname>BroadcastMulticastQueueLength=
</varname></term>
558 <para>Specifies the length of the receive queue for broadcast/multicast packets. An unsigned
559 integer in the range
0…
4294967294. Defaults to unset.
</para>
561 <xi:include href=
"version-info.xml" xpointer=
"v248"/>
568 <title>[MACVTAP] Section Options
</title>
570 <para>The [MACVTAP] section applies for netdevs of kind
<literal>macvtap
</literal> and accepts the same
571 keys as [MACVLAN].
</para>
575 <title>[IPVLAN] Section Options
</title>
577 <para>The [IPVLAN] section only applies for
578 netdevs of kind
<literal>ipvlan
</literal>, and accepts the
579 following key:
</para>
581 <variablelist class='network-directives'
>
583 <term><varname>Mode=
</varname></term>
585 <para>The IPVLAN mode to use. The supported options are
586 <literal>L2
</literal>,
<literal>L3
</literal> and
<literal>L3S
</literal>.
589 <xi:include href=
"version-info.xml" xpointer=
"v219"/>
593 <term><varname>Flags=
</varname></term>
595 <para>The IPVLAN flags to use. The supported options are
596 <literal>bridge
</literal>,
<literal>private
</literal> and
<literal>vepa
</literal>.
599 <xi:include href=
"version-info.xml" xpointer=
"v237"/>
606 <title>[IPVTAP] Section Options
</title>
608 <para>The [IPVTAP] section only applies for netdevs of kind
<literal>ipvtap
</literal> and accepts the
609 same keys as [IPVLAN].
</para>
613 <title>[VXLAN] Section Options
</title>
615 <para>The [VXLAN] section only applies for
616 netdevs of kind
<literal>vxlan
</literal>, and accepts the
617 following keys:
</para>
619 <variablelist class='network-directives'
>
621 <term><varname>VNI=
</varname></term>
623 <para>The VXLAN Network Identifier (or VXLAN Segment ID). Takes a number in the range
1…
16777215.
</para>
625 <xi:include href=
"version-info.xml" xpointer=
"v243"/>
629 <term><varname>Remote=
</varname></term>
631 <para>Configures destination IP address.
</para>
633 <xi:include href=
"version-info.xml" xpointer=
"v233"/>
637 <term><varname>Local=
</varname></term>
639 <para>Configures local IP address. It must be an address on the underlying interface of the
640 VXLAN interface, or one of the special values
<literal>ipv4_link_local
</literal>,
641 <literal>ipv6_link_local
</literal>,
<literal>dhcp4
</literal>,
<literal>dhcp6
</literal>, and
642 <literal>slaac
</literal>. If one of the special values is specified, an address which matches
643 the corresponding type on the underlying interface will be used. Defaults to unset.
</para>
645 <xi:include href=
"version-info.xml" xpointer=
"v233"/>
649 <term><varname>Group=
</varname></term>
651 <para>Configures VXLAN multicast group IP address. All members of a VXLAN must use the same
652 multicast group address.
</para>
654 <xi:include href=
"version-info.xml" xpointer=
"v243"/>
658 <term><varname>TOS=
</varname></term>
660 <para>The Type Of Service byte value for a vxlan interface.
</para>
662 <xi:include href=
"version-info.xml" xpointer=
"v215"/>
666 <term><varname>TTL=
</varname></term>
668 <para>A fixed Time To Live N on Virtual eXtensible Local Area Network packets.
669 Takes
<literal>inherit
</literal> or a number in the range
0…
255.
0 is a special
670 value meaning inherit the inner protocol's TTL value.
<literal>inherit
</literal>
671 means that it will inherit the outer protocol's TTL value.
</para>
673 <xi:include href=
"version-info.xml" xpointer=
"v215"/>
677 <term><varname>MacLearning=
</varname></term>
679 <para>Takes a boolean. When true, enables dynamic MAC learning
680 to discover remote MAC addresses.
</para>
682 <xi:include href=
"version-info.xml" xpointer=
"v215"/>
686 <term><varname>FDBAgeingSec=
</varname></term>
688 <para>The lifetime of Forwarding Database entry learnt by
689 the kernel, in seconds.
</para>
691 <xi:include href=
"version-info.xml" xpointer=
"v218"/>
695 <term><varname>MaximumFDBEntries=
</varname></term>
697 <para>Configures maximum number of FDB entries.
</para>
699 <xi:include href=
"version-info.xml" xpointer=
"v228"/>
703 <term><varname>ReduceARPProxy=
</varname></term>
705 <para>Takes a boolean. When true, bridge-connected VXLAN tunnel
706 endpoint answers ARP requests from the local bridge on behalf
707 of remote Distributed Overlay Virtual Ethernet
708 <ulink url=
"https://en.wikipedia.org/wiki/Distributed_Overlay_Virtual_Ethernet">
709 (DOVE)
</ulink> clients. Defaults to false.
</para>
711 <xi:include href=
"version-info.xml" xpointer=
"v233"/>
715 <term><varname>L2MissNotification=
</varname></term>
717 <para>Takes a boolean. When true, enables netlink LLADDR miss
718 notifications.
</para>
720 <xi:include href=
"version-info.xml" xpointer=
"v218"/>
724 <term><varname>L3MissNotification=
</varname></term>
726 <para>Takes a boolean. When true, enables netlink IP address miss notifications.
</para>
728 <xi:include href=
"version-info.xml" xpointer=
"v218"/>
732 <term><varname>RouteShortCircuit=
</varname></term>
734 <para>Takes a boolean. When true, route short circuiting is turned
737 <xi:include href=
"version-info.xml" xpointer=
"v218"/>
741 <term><varname>UDPChecksum=
</varname></term>
743 <para>Takes a boolean. When true, transmitting UDP checksums when doing VXLAN/IPv4 is turned on.
</para>
745 <xi:include href=
"version-info.xml" xpointer=
"v232"/>
749 <term><varname>UDP6ZeroChecksumTx=
</varname></term>
751 <para>Takes a boolean. When true, sending zero checksums in VXLAN/IPv6 is turned on.
</para>
753 <xi:include href=
"version-info.xml" xpointer=
"v220"/>
757 <term><varname>UDP6ZeroChecksumRx=
</varname></term>
759 <para>Takes a boolean. When true, receiving zero checksums in VXLAN/IPv6 is turned on.
</para>
761 <xi:include href=
"version-info.xml" xpointer=
"v232"/>
765 <term><varname>RemoteChecksumTx=
</varname></term>
767 <para>Takes a boolean. When true, remote transmit checksum offload of VXLAN is turned on.
</para>
769 <xi:include href=
"version-info.xml" xpointer=
"v232"/>
773 <term><varname>RemoteChecksumRx=
</varname></term>
775 <para>Takes a boolean. When true, remote receive checksum offload in VXLAN is turned on.
</para>
777 <xi:include href=
"version-info.xml" xpointer=
"v232"/>
781 <term><varname>GroupPolicyExtension=
</varname></term>
783 <para>Takes a boolean. When true, it enables Group Policy VXLAN extension security label mechanism
784 across network peers based on VXLAN. For details about the Group Policy VXLAN, see the
785 <ulink url=
"https://tools.ietf.org/html/draft-smith-vxlan-group-policy">
786 VXLAN Group Policy
</ulink> document. Defaults to false.
</para>
788 <xi:include href=
"version-info.xml" xpointer=
"v224"/>
792 <term><varname>GenericProtocolExtension=
</varname></term>
794 <para>Takes a boolean. When true, Generic Protocol Extension extends the existing VXLAN protocol
795 to provide protocol typing, OAM, and versioning capabilities. For details about the VXLAN GPE
796 Header, see the
<ulink url=
"https://tools.ietf.org/html/draft-ietf-nvo3-vxlan-gpe-07">
797 Generic Protocol Extension for VXLAN
</ulink> document. If destination port is not specified and
798 Generic Protocol Extension is set then default port of
4790 is used. Defaults to false.
</para>
800 <xi:include href=
"version-info.xml" xpointer=
"v243"/>
804 <term><varname>DestinationPort=
</varname></term>
806 <para>Configures the default destination UDP port. If the destination port is not specified then
807 Linux kernel default will be used. Set to
4789 to get the IANA assigned value.
</para>
809 <xi:include href=
"version-info.xml" xpointer=
"v229"/>
813 <term><varname>PortRange=
</varname></term>
815 <para>Configures the source port range for the VXLAN. The kernel assigns the source UDP port based
816 on the flow to help the receiver to do load balancing. When this option is not set, the normal
817 range of local UDP ports is used.
</para>
819 <xi:include href=
"version-info.xml" xpointer=
"v229"/>
823 <term><varname>FlowLabel=
</varname></term>
825 <para>Specifies the flow label to use in outgoing packets.
826 The valid range is
0-
1048575.
829 <xi:include href=
"version-info.xml" xpointer=
"v234"/>
833 <term><varname>IPDoNotFragment=
</varname></term>
835 <para>Allows setting the IPv4 Do not Fragment (DF) bit in outgoing packets, or to inherit its
836 value from the IPv4 inner header. Takes a boolean value, or
<literal>inherit
</literal>. Set
837 to
<literal>inherit
</literal> if the encapsulated protocol is IPv6. When unset, the kernel's
838 default will be used.
</para>
840 <xi:include href=
"version-info.xml" xpointer=
"v243"/>
844 <term><varname>Independent=
</varname></term>
846 <para>Takes a boolean. When true, the vxlan interface is created without any underlying network
847 interface. Defaults to false, which means that a .network file that requests this VXLAN interface
848 using
<varname>VXLAN=
</varname> is required for the VXLAN to be created.
</para>
855 <title>[GENEVE] Section Options
</title>
857 <para>The [GENEVE] section only applies for
858 netdevs of kind
<literal>geneve
</literal>, and accepts the
859 following keys:
</para>
861 <variablelist class='network-directives'
>
863 <term><varname>Id=
</varname></term>
865 <para>Specifies the Virtual Network Identifier (VNI) to use, a number between
0 and
16777215. This
866 field is mandatory.
</para>
870 <term><varname>Remote=
</varname></term>
872 <para>Specifies the unicast destination IP address to use in outgoing packets.
</para>
874 <xi:include href=
"version-info.xml" xpointer=
"v234"/>
878 <term><varname>TOS=
</varname></term>
880 <para>Specifies the TOS value to use in outgoing packets. Takes a number between
1 and
255.
</para>
882 <xi:include href=
"version-info.xml" xpointer=
"v234"/>
886 <term><varname>TTL=
</varname></term>
888 <para>Accepts the same values as in the [VXLAN] section, except that when unset
889 or set to
0, the kernel's default will be used, meaning that packet TTL will be set from
890 <filename>/proc/sys/net/ipv4/ip_default_ttl
</filename>.
</para>
892 <xi:include href=
"version-info.xml" xpointer=
"v234"/>
896 <term><varname>UDPChecksum=
</varname></term>
898 <para>Takes a boolean. When true, specifies that UDP checksum is calculated for transmitted packets
901 <xi:include href=
"version-info.xml" xpointer=
"v234"/>
905 <term><varname>UDP6ZeroChecksumTx=
</varname></term>
907 <para>Takes a boolean. When true, skip UDP checksum calculation for transmitted packets over IPv6.
</para>
909 <xi:include href=
"version-info.xml" xpointer=
"v234"/>
913 <term><varname>UDP6ZeroChecksumRx=
</varname></term>
915 <para>Takes a boolean. When true, allows incoming UDP packets over IPv6 with zero checksum field.
</para>
917 <xi:include href=
"version-info.xml" xpointer=
"v234"/>
921 <term><varname>DestinationPort=
</varname></term>
923 <para>Specifies destination port. Defaults to
6081. If not set or assigned the empty string, the default
924 port of
6081 is used.
</para>
926 <xi:include href=
"version-info.xml" xpointer=
"v234"/>
930 <term><varname>FlowLabel=
</varname></term>
932 <para>Specifies the flow label to use in outgoing packets.
</para>
934 <xi:include href=
"version-info.xml" xpointer=
"v234"/>
938 <term><varname>IPDoNotFragment=
</varname></term>
940 <para>Accepts the same key as in [VXLAN] section.
</para>
942 <xi:include href=
"version-info.xml" xpointer=
"v243"/>
946 <term><varname>InheritInnerProtocol=
</varname></term>
948 <para>Takes a boolean. When true, inner Layer
3 protocol is set as Protocol Type in the GENEVE
949 header instead of Ethernet. Defaults to false.
</para>
951 <xi:include href=
"version-info.xml" xpointer=
"v254"/>
958 <title>[BareUDP] Section Options
</title>
960 <para>The [BareUDP] section only applies for
961 netdevs of kind
<literal>bareudp
</literal>, and accepts the
962 following keys:
</para>
964 <variablelist class='network-directives'
>
966 <term><varname>DestinationPort=
</varname></term>
968 <para>Specifies the destination UDP port (in range
1…
65535). This is mandatory.
</para>
970 <xi:include href=
"version-info.xml" xpointer=
"v247"/>
975 <term><varname>EtherType=
</varname></term>
977 <para>Specifies the L3 protocol. Takes one of
<literal>ipv4
</literal>,
<literal>ipv6
</literal>,
<literal>mpls-uc
</literal>
978 or
<literal>mpls-mc
</literal>. This is mandatory.
</para>
980 <xi:include href=
"version-info.xml" xpointer=
"v247"/>
987 <title>[L2TP] Section Options
</title>
989 <para>The [L2TP] section only applies for
990 netdevs of kind
<literal>l2tp
</literal>, and accepts the
991 following keys:
</para>
993 <variablelist class='network-directives'
>
995 <term><varname>TunnelId=
</varname></term>
997 <para>Specifies the tunnel identifier. Takes an number in the range
1…
4294967295. The value used
998 must match the
<literal>PeerTunnelId=
</literal> value being used at the peer. This setting is
1001 <xi:include href=
"version-info.xml" xpointer=
"v242"/>
1005 <term><varname>PeerTunnelId=
</varname></term>
1007 <para>Specifies the peer tunnel id. Takes a number in the range
1…
4294967295. The value used must
1008 match the
<literal>TunnelId=
</literal> value being used at the peer. This setting is compulsory.
1011 <xi:include href=
"version-info.xml" xpointer=
"v242"/>
1015 <term><varname>Remote=
</varname></term>
1017 <para>Specifies the IP address of the remote peer. This setting is compulsory.
</para>
1019 <xi:include href=
"version-info.xml" xpointer=
"v242"/>
1023 <term><varname>Local=
</varname></term>
1025 <para>Specifies the IP address of a local interface. Takes an IP address, or the special
1026 values
<literal>auto
</literal>,
<literal>static
</literal>, or
<literal>dynamic
</literal>.
1027 Optionally a name of a local interface can be specified after
<literal>@
</literal>, e.g.
1028 <literal>192.168.0.1@eth0
</literal> or
<literal>auto@eth0
</literal>. When an address is
1029 specified, then a local or specified interface must have the address, and the remote address
1030 must be accessible through the local address. If
<literal>auto
</literal>, then one of the
1031 addresses on a local or specified interface which is accessible to the remote address will be
1032 used. Similarly, if
<literal>static
</literal> or
<literal>dynamic
</literal> is set, then one
1033 of the static or dynamic addresses will be used. Defaults to
<literal>auto
</literal>.
</para>
1035 <xi:include href=
"version-info.xml" xpointer=
"v242"/>
1039 <term><varname>EncapsulationType=
</varname></term>
1041 <para>Specifies the encapsulation type of the tunnel. Takes one of
<literal>udp
</literal> or
1042 <literal>ip
</literal>.
</para>
1044 <xi:include href=
"version-info.xml" xpointer=
"v242"/>
1048 <term><varname>UDPSourcePort=
</varname></term>
1050 <para>Specifies the UDP source port to be used for the tunnel. When UDP encapsulation is selected
1051 it's mandatory. Ignored when IP encapsulation is selected.
</para>
1053 <xi:include href=
"version-info.xml" xpointer=
"v242"/>
1057 <term><varname>UDPDestinationPort=
</varname></term>
1059 <para>Specifies destination port. When UDP encapsulation is selected it's mandatory. Ignored when IP
1060 encapsulation is selected.
</para>
1062 <xi:include href=
"version-info.xml" xpointer=
"v245"/>
1066 <term><varname>UDPChecksum=
</varname></term>
1068 <para>Takes a boolean. When true, specifies that UDP checksum is calculated for transmitted packets
1071 <xi:include href=
"version-info.xml" xpointer=
"v242"/>
1075 <term><varname>UDP6ZeroChecksumTx=
</varname></term>
1077 <para>Takes a boolean. When true, skip UDP checksum calculation for transmitted packets over IPv6.
</para>
1079 <xi:include href=
"version-info.xml" xpointer=
"v242"/>
1083 <term><varname>UDP6ZeroChecksumRx=
</varname></term>
1085 <para>Takes a boolean. When true, allows incoming UDP packets over IPv6 with zero checksum field.
</para>
1087 <xi:include href=
"version-info.xml" xpointer=
"v242"/>
1094 <title>[L2TPSession] Section Options
</title>
1096 <para>The [L2TPSession] section only applies for
1097 netdevs of kind
<literal>l2tp
</literal>, and accepts the
1098 following keys:
</para>
1099 <variablelist class='network-directives'
>
1101 <term><varname>Name=
</varname></term>
1103 <para>Specifies the name of the session. This setting is compulsory.
</para>
1105 <xi:include href=
"version-info.xml" xpointer=
"v242"/>
1109 <term><varname>SessionId=
</varname></term>
1111 <para>Specifies the session identifier. Takes an number in the range
1…
4294967295. The value used
1112 must match the
<literal>SessionId=
</literal> value being used at the peer. This setting is
1115 <xi:include href=
"version-info.xml" xpointer=
"v242"/>
1119 <term><varname>PeerSessionId=
</varname></term>
1121 <para>Specifies the peer session identifier. Takes an number in the range
1…
4294967295.
1122 The value used must match the
<literal>PeerSessionId=
</literal> value being used at the peer.
1123 This setting is compulsory.
</para>
1125 <xi:include href=
"version-info.xml" xpointer=
"v242"/>
1129 <term><varname>Layer2SpecificHeader=
</varname></term>
1131 <para>Specifies layer2specific header type of the session. One of
<literal>none
</literal> or
<literal>default
</literal>. Defaults to
<literal>default
</literal>.
</para>
1133 <xi:include href=
"version-info.xml" xpointer=
"v242"/>
1140 <title>[MACsec] Section Options
</title>
1142 <para>The [MACsec] section only applies for network devices of kind
1143 <literal>macsec
</literal>, and accepts the following keys:
</para>
1145 <variablelist class='network-directives'
>
1147 <term><varname>Port=
</varname></term>
1149 <para>Specifies the port to be used for the MACsec transmit channel. The port is used to make
1150 secure channel identifier (SCI). Takes a value between
1 and
65535. Defaults to unset.
1153 <xi:include href=
"version-info.xml" xpointer=
"v243"/>
1157 <term><varname>Encrypt=
</varname></term>
1159 <para>Takes a boolean. When true, enable encryption. Defaults to unset.
</para>
1161 <xi:include href=
"version-info.xml" xpointer=
"v243"/>
1168 <title>[MACsecReceiveChannel] Section Options
</title>
1169 <para>The [MACsecReceiveChannel] section only applies for network devices of
1170 kind
<literal>macsec
</literal>, and accepts the following keys:
</para>
1172 <variablelist class='network-directives'
>
1174 <term><varname>Port=
</varname></term>
1176 <para>Specifies the port to be used for the MACsec receive channel. The port is used to make
1177 secure channel identifier (SCI). Takes a value between
1 and
65535. This option is
1178 compulsory, and is not set by default.
</para>
1180 <xi:include href=
"version-info.xml" xpointer=
"v243"/>
1184 <term><varname>MACAddress=
</varname></term>
1186 <para>Specifies the MAC address to be used for the MACsec receive channel. The MAC address
1187 used to make secure channel identifier (SCI). This setting is compulsory, and is not set by
1190 <xi:include href=
"version-info.xml" xpointer=
"v243"/>
1197 <title>[MACsecTransmitAssociation] Section Options
</title>
1199 <para>The [MACsecTransmitAssociation] section only applies for network devices
1200 of kind
<literal>macsec
</literal>, and accepts the following keys:
</para>
1202 <variablelist class='network-directives'
>
1204 <term><varname>PacketNumber=
</varname></term>
1206 <para>Specifies the packet number to be used for replay protection and the construction of
1207 the initialization vector (along with the secure channel identifier [SCI]). Takes a value
1208 between
1-
4,
294,
967,
295. Defaults to unset.
1211 <xi:include href=
"version-info.xml" xpointer=
"v243"/>
1215 <term><varname>KeyId=
</varname></term>
1217 <para>Specifies the identification for the key. Takes a number between
0-
255. This option
1218 is compulsory, and is not set by default.
</para>
1220 <xi:include href=
"version-info.xml" xpointer=
"v243"/>
1224 <term><varname>Key=
</varname></term>
1226 <para>Specifies the encryption key used in the transmission channel. The same key must be
1227 configured on the peer’s matching receive channel. This setting is compulsory, and is not set
1228 by default. Takes a
128-bit key encoded in a hexadecimal string, for example
1229 <literal>dffafc8d7b9a43d5b9a3dfbbf6a30c16
</literal>.
</para>
1231 <xi:include href=
"version-info.xml" xpointer=
"v243"/>
1235 <term><varname>KeyFile=
</varname></term>
1237 <para>Takes an absolute path to a file which contains a
128-bit key encoded in a hexadecimal string,
1238 which will be used in the transmission channel. When this option is specified,
1239 <varname>Key=
</varname> is ignored. Note that the file must be readable by the user
1240 <literal>systemd-network
</literal>, so it should be, e.g., owned by
1241 <literal>root:systemd-network
</literal> with a
<literal>0640</literal> file mode. If the path
1242 refers to an
<constant>AF_UNIX
</constant> stream socket in the file system a connection is made to
1243 it and the key read from it.
</para>
1245 <xi:include href=
"version-info.xml" xpointer=
"v243"/>
1249 <term><varname>Activate=
</varname></term>
1251 <para>Takes a boolean. If enabled, then the security association is activated. Defaults to
1254 <xi:include href=
"version-info.xml" xpointer=
"v243"/>
1258 <term><varname>UseForEncoding=
</varname></term>
1260 <para>Takes a boolean. If enabled, then the security association is used for encoding. Only
1261 one [MACsecTransmitAssociation] section can enable this option. When enabled,
1262 <varname>Activate=yes
</varname> is implied. Defaults to unset.
</para>
1264 <xi:include href=
"version-info.xml" xpointer=
"v243"/>
1271 <title>[MACsecReceiveAssociation] Section Options
</title>
1273 <para>The [MACsecReceiveAssociation] section only applies for
1274 network devices of kind
<literal>macsec
</literal>, and accepts the
1275 following keys:
</para>
1277 <variablelist class='network-directives'
>
1279 <term><varname>Port=
</varname></term>
1281 <para>Accepts the same key as in [MACsecReceiveChannel] section.
</para>
1283 <xi:include href=
"version-info.xml" xpointer=
"v243"/>
1287 <term><varname>MACAddress=
</varname></term>
1289 <para>Accepts the same key as in [MACsecReceiveChannel] section.
</para>
1291 <xi:include href=
"version-info.xml" xpointer=
"v243"/>
1295 <term><varname>PacketNumber=
</varname></term>
1297 <para>Accepts the same key as in [MACsecTransmitAssociation] section.
</para>
1299 <xi:include href=
"version-info.xml" xpointer=
"v243"/>
1303 <term><varname>KeyId=
</varname></term>
1305 <para>Accepts the same key as in [MACsecTransmitAssociation] section.
</para>
1307 <xi:include href=
"version-info.xml" xpointer=
"v243"/>
1311 <term><varname>Key=
</varname></term>
1313 <para>Accepts the same key as in [MACsecTransmitAssociation] section.
</para>
1315 <xi:include href=
"version-info.xml" xpointer=
"v243"/>
1319 <term><varname>KeyFile=
</varname></term>
1321 <para>Accepts the same key as in [MACsecTransmitAssociation] section.
</para>
1323 <xi:include href=
"version-info.xml" xpointer=
"v243"/>
1327 <term><varname>Activate=
</varname></term>
1329 <para>Accepts the same key as in [MACsecTransmitAssociation] section.
</para>
1331 <xi:include href=
"version-info.xml" xpointer=
"v243"/>
1338 <title>[Tunnel] Section Options
</title>
1340 <para>The [Tunnel] section only applies for
1342 <literal>ipip
</literal>,
1343 <literal>sit
</literal>,
1344 <literal>gre
</literal>,
1345 <literal>gretap
</literal>,
1346 <literal>ip6gre
</literal>,
1347 <literal>ip6gretap
</literal>,
1348 <literal>vti
</literal>,
1349 <literal>vti6
</literal>,
1350 <literal>ip6tnl
</literal>, and
1351 <literal>erspan
</literal> and accepts
1352 the following keys:
</para>
1354 <variablelist class='network-directives'
>
1356 <term><varname>External=
</varname></term>
1358 <para>Takes a boolean value. When true, then the tunnel is externally controlled, which is
1359 also known as collect metadata mode, and most settings below like
<varname>Local=
</varname>
1360 or
<varname>Remote=
</varname> are ignored. This implies
<varname>Independent=
</varname>.
1361 Defaults to false.
</para>
1363 <xi:include href=
"version-info.xml" xpointer=
"v251"/>
1367 <term><varname>Local=
</varname></term>
1369 <para>A static local address for tunneled packets. It must be an address on another interface
1370 of this host, or one of the special values
<literal>any
</literal>,
1371 <literal>ipv4_link_local
</literal>,
<literal>ipv6_link_local
</literal>,
1372 <literal>dhcp4
</literal>,
<literal>dhcp6
</literal>, and
<literal>slaac
</literal>. If one
1373 of the special values except for
<literal>any
</literal> is specified, an address which
1374 matches the corresponding type on the underlying interface will be used. Defaults to
1375 <literal>any
</literal>.
</para>
1377 <xi:include href=
"version-info.xml" xpointer=
"v215"/>
1381 <term><varname>Remote=
</varname></term>
1383 <para>The remote endpoint of the tunnel. Takes an IP address or the special value
1384 <literal>any
</literal>.
</para>
1386 <xi:include href=
"version-info.xml" xpointer=
"v215"/>
1390 <term><varname>TOS=
</varname></term>
1392 <para>The Type Of Service byte value for a tunnel interface.
1393 For details about the TOS, see the
1394 <ulink url=
"http://tools.ietf.org/html/rfc1349"> Type of
1395 Service in the Internet Protocol Suite
</ulink> document.
1398 <xi:include href=
"version-info.xml" xpointer=
"v215"/>
1402 <term><varname>TTL=
</varname></term>
1404 <para>A fixed Time To Live N on tunneled packets. N is a
1405 number in the range
1…
255.
0 is a special value meaning that
1406 packets inherit the TTL value. The default value for IPv4
1407 tunnels is
0 (inherit). The default value for IPv6 tunnels is
1410 <xi:include href=
"version-info.xml" xpointer=
"v215"/>
1414 <term><varname>DiscoverPathMTU=
</varname></term>
1416 <para>Takes a boolean. When true, enables Path MTU Discovery on
1418 When
<varname>IgnoreDontFragment=
</varname> is enabled,
1419 defaults to false. Otherwise, defaults to true.
</para>
1421 <xi:include href=
"version-info.xml" xpointer=
"v215"/>
1425 <term><varname>IgnoreDontFragment=
</varname></term>
1427 <para>Takes a boolean. When true, enables IPv4 Don't Fragment (DF) suppression on
1428 the tunnel. Defaults to false.
1429 Note that if
<varname>IgnoreDontFragment=
</varname> is set to true,
1430 <varname>DiscoverPathMTU=
</varname> cannot be set to true.
1431 Only applicable to GRE, GRETAP, and ERSPAN tunnels.
</para>
1433 <xi:include href=
"version-info.xml" xpointer=
"v254"/>
1437 <term><varname>IPv6FlowLabel=
</varname></term>
1439 <para>Configures the
20-bit flow label (see
<ulink url=
"https://tools.ietf.org/html/rfc6437">
1440 RFC
6437</ulink>) field in the IPv6 header (see
<ulink url=
"https://tools.ietf.org/html/rfc2460">
1441 RFC
2460</ulink>), which is used by a node to label packets of a flow.
1442 It is only used for IPv6 tunnels.
1443 A flow label of zero is used to indicate packets that have
1445 It can be configured to a value in the range
0…
0xFFFFF, or be
1446 set to
<literal>inherit
</literal>, in which case the original flowlabel is used.
</para>
1448 <xi:include href=
"version-info.xml" xpointer=
"v223"/>
1452 <term><varname>CopyDSCP=
</varname></term>
1454 <para>Takes a boolean. When true, the Differentiated Service Code
1455 Point (DSCP) field will be copied to the inner header from
1456 outer header during the decapsulation of an IPv6 tunnel
1457 packet. DSCP is a field in an IP packet that enables different
1458 levels of service to be assigned to network traffic.
1459 Defaults to
<literal>no
</literal>.
1462 <xi:include href=
"version-info.xml" xpointer=
"v223"/>
1466 <term><varname>EncapsulationLimit=
</varname></term>
1468 <para>The Tunnel Encapsulation Limit option specifies how many additional
1469 levels of encapsulation are permitted to be prepended to the packet.
1470 For example, a Tunnel Encapsulation Limit option containing a limit
1471 value of zero means that a packet carrying that option may not enter
1472 another tunnel before exiting the current tunnel.
1473 (see
<ulink url=
"https://tools.ietf.org/html/rfc2473#section-4.1.1"> RFC
2473</ulink>).
1474 The valid range is
0…
255 and
<literal>none
</literal>. Defaults to
4.
1477 <xi:include href=
"version-info.xml" xpointer=
"v226"/>
1481 <term><varname>Key=
</varname></term>
1483 <para>The
<varname>Key=
</varname> parameter specifies the same key to use in
1484 both directions (
<varname>InputKey=
</varname> and
<varname>OutputKey=
</varname>).
1485 The
<varname>Key=
</varname> is either a number or an IPv4 address-like dotted quad.
1486 It is used as mark-configured SAD/SPD entry as part of the lookup key (both in data
1487 and control path) in IP XFRM (framework used to implement IPsec protocol).
1488 See
<ulink url=
"https://man7.org/linux/man-pages/man8/ip-xfrm.8.html">
1489 ip-xfrm — transform configuration
</ulink> for details. It is only used for VTI/VTI6,
1490 GRE, GRETAP, and ERSPAN tunnels.
</para>
1492 <xi:include href=
"version-info.xml" xpointer=
"v231"/>
1496 <term><varname>InputKey=
</varname></term>
1498 <para>The
<varname>InputKey=
</varname> parameter specifies the key to use for input.
1499 The format is same as
<varname>Key=
</varname>. It is only used for VTI/VTI6, GRE, GRETAP,
1500 and ERSPAN tunnels.
</para>
1502 <xi:include href=
"version-info.xml" xpointer=
"v231"/>
1506 <term><varname>OutputKey=
</varname></term>
1508 <para>The
<varname>OutputKey=
</varname> parameter specifies the key to use for output.
1509 The format is same as
<varname>Key=
</varname>. It is only used for VTI/VTI6, GRE, GRETAP,
1510 and ERSPAN tunnels.
</para>
1512 <xi:include href=
"version-info.xml" xpointer=
"v231"/>
1516 <term><varname>Mode=
</varname></term>
1518 <para>An
<literal>ip6tnl
</literal> tunnel can be in one of three
1520 <literal>ip6ip6
</literal> for IPv6 over IPv6,
1521 <literal>ipip6
</literal> for IPv4 over IPv6 or
1522 <literal>any
</literal> for either.
1525 <xi:include href=
"version-info.xml" xpointer=
"v219"/>
1529 <term><varname>Independent=
</varname></term>
1531 <para>Takes a boolean. When false (the default), the tunnel is always created over some network
1532 device, and a .network file that requests this tunnel using
<varname>Tunnel=
</varname> is required
1533 for the tunnel to be created. When true, the tunnel is created independently of any network as
1534 "tunnel@NONE".
</para>
1536 <xi:include href=
"version-info.xml" xpointer=
"v235"/>
1540 <term><varname>AssignToLoopback=
</varname></term>
1542 <para>Takes a boolean. If set to
<literal>yes
</literal>, the loopback interface
<literal>lo
</literal>
1543 is used as the underlying device of the tunnel interface. Defaults to
<literal>no
</literal>.
</para>
1545 <xi:include href=
"version-info.xml" xpointer=
"v243"/>
1549 <term><varname>AllowLocalRemote=
</varname></term>
1551 <para>Takes a boolean. When true allows tunnel traffic on
<varname>ip6tnl
</varname> devices where the remote endpoint is a local host address.
1552 When unset, the kernel's default will be used.
1555 <xi:include href=
"version-info.xml" xpointer=
"v237"/>
1559 <term><varname>FooOverUDP=
</varname></term>
1561 <para>Takes a boolean. Specifies whether
<varname>FooOverUDP=
</varname> tunnel is to be configured.
1562 Defaults to false. This takes effects only for IPIP, SIT, GRE, and GRETAP tunnels.
1563 For more detail information see
1564 <ulink url=
"https://lwn.net/Articles/614348">Foo over UDP
</ulink></para>
1566 <xi:include href=
"version-info.xml" xpointer=
"v240"/>
1570 <term><varname>FOUDestinationPort=
</varname></term>
1572 <para>This setting specifies the UDP destination port for encapsulation.
1573 This field is mandatory when
<varname>FooOverUDP=yes
</varname>, and is not set by default.
</para>
1575 <xi:include href=
"version-info.xml" xpointer=
"v240"/>
1579 <term><varname>FOUSourcePort=
</varname></term>
1581 <para>This setting specifies the UDP source port for encapsulation. Defaults to
<constant>0</constant>
1582 — that is, the source port for packets is left to the network stack to decide.
</para>
1584 <xi:include href=
"version-info.xml" xpointer=
"v240"/>
1588 <term><varname>Encapsulation=
</varname></term>
1590 <para>Accepts the same key as in the [FooOverUDP] section.
</para>
1592 <xi:include href=
"version-info.xml" xpointer=
"v240"/>
1596 <term><varname>IPv6RapidDeploymentPrefix=
</varname></term>
1598 <para>Reconfigure the tunnel for
<ulink url=
"https://tools.ietf.org/html/rfc5569">IPv6 Rapid
1599 Deployment
</ulink>, also known as
6rd. The value is an ISP-specific IPv6 prefix with a non-zero length. Only
1600 applicable to SIT tunnels.
</para>
1602 <xi:include href=
"version-info.xml" xpointer=
"v240"/>
1606 <term><varname>ISATAP=
</varname></term>
1608 <para>Takes a boolean. If set, configures the tunnel as Intra-Site Automatic Tunnel Addressing Protocol (ISATAP) tunnel.
1609 Only applicable to SIT tunnels. When unset, the kernel's default will be used.
</para>
1611 <xi:include href=
"version-info.xml" xpointer=
"v240"/>
1615 <term><varname>SerializeTunneledPackets=
</varname></term>
1617 <para>Takes a boolean. If set to yes, then packets are serialized. Only applies for GRE,
1618 GRETAP, and ERSPAN tunnels. When unset, the kernel's default will be used.
1621 <xi:include href=
"version-info.xml" xpointer=
"v240"/>
1625 <term><varname>ERSPANVersion=
</varname></term>
1627 <para>Specifies the ERSPAN version number. Takes
0 for version
0 (a.k.a. type I),
1 for version
1
1628 (a.k.a. type II), or
2 for version
2 (a.k.a. type III). Defaults to
1.
</para>
1630 <xi:include href=
"version-info.xml" xpointer=
"v252"/>
1634 <term><varname>ERSPANIndex=
</varname></term>
1636 <para>Specifies the ERSPAN v1 index field for the interface. Takes an integer in the range
1637 0…
1048575, which is associated with the ERSPAN traffic's source port and direction. Only used when
1638 <varname>ERSPANVersion=
1</varname>. Defaults to
0.
</para>
1640 <xi:include href=
"version-info.xml" xpointer=
"v240"/>
1644 <term><varname>ERSPANDirection=
</varname></term>
1646 <para>Specifies the ERSPAN v2 mirrored traffic's direction. Takes
<literal>ingress
</literal> or
1647 <literal>egress
</literal>. Only used when
<varname>ERSPANVersion=
2</varname>. Defaults to
1648 <literal>ingress
</literal>.
</para>
1650 <xi:include href=
"version-info.xml" xpointer=
"v252"/>
1654 <term><varname>ERSPANHardwareId=
</varname></term>
1656 <para>Specifies an unique identifier of the ERSPAN v2 engine. Takes an integer in the range
0…
63.
1657 Only used when
<varname>ERSPANVersion=
2</varname>. Defaults to
0.
</para>
1659 <xi:include href=
"version-info.xml" xpointer=
"v252"/>
1666 <title>[FooOverUDP] Section Options
</title>
1668 <para>The [FooOverUDP] section only applies for
1669 netdevs of kind
<literal>fou
</literal> and accepts the
1670 following keys:
</para>
1672 <variablelist class='network-directives'
>
1674 <term><varname>Encapsulation=
</varname></term>
1676 <para>Specifies the encapsulation mechanism used to store networking packets of various protocols
1677 inside the UDP packets. Supports the following values:
1679 <literal>FooOverUDP
</literal> provides the simplest no-frills model of UDP encapsulation, it simply
1680 encapsulates packets directly in the UDP payload.
<literal>GenericUDPEncapsulation
</literal> is a
1681 generic and extensible encapsulation, it allows encapsulation of packets for any IP protocol and
1682 optional data as part of the encapsulation. For more detailed information see
<ulink
1683 url=
"https://lwn.net/Articles/615044">Generic UDP Encapsulation
</ulink>. Defaults to
1684 <literal>FooOverUDP
</literal>.
1687 <xi:include href=
"version-info.xml" xpointer=
"v240"/>
1691 <term><varname>Port=
</varname></term>
1693 <para>Specifies the port number where the encapsulated packets will arrive. Those packets will be
1694 removed and manually fed back into the network stack with the encapsulation removed to be sent to
1695 the real destination. This option is mandatory.
</para>
1697 <xi:include href=
"version-info.xml" xpointer=
"v240"/>
1701 <term><varname>PeerPort=
</varname></term>
1703 <para>Specifies the peer port number. Defaults to unset. Note that when peer port is set
1704 <literal>Peer=
</literal> address is mandatory.
</para>
1706 <xi:include href=
"version-info.xml" xpointer=
"v243"/>
1710 <term><varname>Protocol=
</varname></term>
1712 <para>The
<varname>Protocol=
</varname> specifies the protocol number of the packets arriving
1713 at the UDP port. When
<varname>Encapsulation=FooOverUDP
</varname>, this field is mandatory
1714 and is not set by default. Takes an IP protocol name such as
<literal>gre
</literal> or
1715 <literal>ipip
</literal>, or an integer within the range
1…
255. When
1716 <varname>Encapsulation=GenericUDPEncapsulation
</varname>, this must not be specified.
</para>
1718 <xi:include href=
"version-info.xml" xpointer=
"v240"/>
1722 <term><varname>Peer=
</varname></term>
1724 <para>Configures peer IP address. Note that when peer address is set
<literal>PeerPort=
</literal>
1725 is mandatory.
</para>
1727 <xi:include href=
"version-info.xml" xpointer=
"v243"/>
1731 <term><varname>Local=
</varname></term>
1733 <para>Configures local IP address.
</para>
1735 <xi:include href=
"version-info.xml" xpointer=
"v243"/>
1742 <title>[Peer] Section Options
</title>
1744 <para>The [Peer] section only applies for
1745 netdevs of kind
<literal>veth
</literal> and accepts the
1746 following keys:
</para>
1748 <variablelist class='network-directives'
>
1750 <term><varname>Name=
</varname></term>
1752 <para>The interface name used when creating the netdev.
1753 This setting is compulsory.
</para>
1755 <xi:include href=
"version-info.xml" xpointer=
"v215"/>
1759 <term><varname>MACAddress=
</varname></term>
1761 <para>The peer MACAddress, if not set, it is generated in
1762 the same way as the MAC address of the main
1765 <xi:include href=
"version-info.xml" xpointer=
"v215"/>
1772 <title>[VXCAN] Section Options
</title>
1774 <para>The [VXCAN] section only applies for
1775 netdevs of kind
<literal>vxcan
</literal> and accepts the
1776 following key:
</para>
1778 <variablelist class='network-directives'
>
1780 <term><varname>Peer=
</varname></term>
1782 <para>The peer interface name used when creating the netdev.
1783 This setting is compulsory.
</para>
1785 <xi:include href=
"version-info.xml" xpointer=
"v236"/>
1792 <title>[Tun] Section Options
</title>
1794 <para>The [Tun] section only applies for
1795 netdevs of kind
<literal>tun
</literal>, and accepts the following
1798 <variablelist class='network-directives'
>
1800 <term><varname>MultiQueue=
</varname></term>
1801 <listitem><para>Takes a boolean. Configures whether
1802 to use multiple file descriptors (queues) to parallelize
1803 packets sending and receiving. Defaults to
1804 <literal>no
</literal>.
</para>
1806 <xi:include href=
"version-info.xml" xpointer=
"v215"/>
1810 <term><varname>PacketInfo=
</varname></term>
1811 <listitem><para>Takes a boolean. Configures whether
1812 packets should be prepended with four extra bytes (two flag
1813 bytes and two protocol bytes). If disabled, it indicates that
1814 the packets will be pure IP packets. Defaults to
1815 <literal>no
</literal>.
</para>
1817 <xi:include href=
"version-info.xml" xpointer=
"v215"/>
1821 <term><varname>VNetHeader=
</varname></term>
1822 <listitem><para>Takes a boolean. Configures
1823 IFF_VNET_HDR flag for a tun or tap device. It allows sending
1824 and receiving larger Generic Segmentation Offload (GSO)
1825 packets. This may increase throughput significantly.
1827 <literal>no
</literal>.
</para>
1829 <xi:include href=
"version-info.xml" xpointer=
"v223"/>
1833 <term><varname>User=
</varname></term>
1834 <listitem><para>User to grant access to the
1835 <filename>/dev/net/tun
</filename> device.
</para>
1837 <xi:include href=
"version-info.xml" xpointer=
"v215"/>
1841 <term><varname>Group=
</varname></term>
1842 <listitem><para>Group to grant access to the
1843 <filename>/dev/net/tun
</filename> device.
</para>
1845 <xi:include href=
"version-info.xml" xpointer=
"v215"/>
1849 <term><varname>KeepCarrier=
</varname></term>
1851 <para>Takes a boolean. If enabled, to make the interface maintain its carrier status, the file
1852 descriptor of the interface is kept open. This may be useful to keep the interface in running
1853 state, for example while the backing process is temporarily shutdown. Defaults to
1854 <literal>no
</literal>.
</para>
1856 <xi:include href=
"version-info.xml" xpointer=
"v252"/>
1863 <title>[Tap] Section Options
</title>
1865 <para>The [Tap] section only applies for
1866 netdevs of kind
<literal>tap
</literal>, and accepts the same keys
1867 as the [Tun] section.
</para>
1871 <title>[WireGuard] Section Options
</title>
1873 <para>The [WireGuard] section accepts the following
1876 <variablelist class='network-directives'
>
1878 <term><varname>PrivateKey=
</varname></term>
1880 <para>The Base64 encoded private key for the interface. It can be
1881 generated using the
<command>wg genkey
</command> command
1882 (see
<citerefentry project=
"wireguard"><refentrytitle>wg
</refentrytitle><manvolnum>8</manvolnum></citerefentry>).
1883 This option or
<varname>PrivateKeyFile=
</varname> is mandatory to use WireGuard.
1884 Note that because this information is secret, you may want to set
1885 the permissions of the .netdev file to be owned by
<literal>root:systemd-network
</literal>
1886 with a
<literal>0640</literal> file mode.
</para>
1888 <xi:include href=
"version-info.xml" xpointer=
"v237"/>
1892 <term><varname>PrivateKeyFile=
</varname></term>
1894 <para>Takes an absolute path to a file which contains the Base64 encoded private key for the
1895 interface. When this option is specified, then
<varname>PrivateKey=
</varname> is ignored. Note
1896 that the file must be readable by the user
<literal>systemd-network
</literal>, so it should be,
1897 e.g., owned by
<literal>root:systemd-network
</literal> with a
<literal>0640</literal> file mode. If
1898 the path refers to an
<constant>AF_UNIX
</constant> stream socket in the file system a connection is
1899 made to it and the key read from it.
</para>
1901 <xi:include href=
"version-info.xml" xpointer=
"v242"/>
1905 <term><varname>ListenPort=
</varname></term>
1907 <para>Sets UDP port for listening. Takes either value between
1 and
65535
1908 or
<literal>auto
</literal>. If
<literal>auto
</literal> is specified,
1909 the port is automatically generated based on interface name.
1910 Defaults to
<literal>auto
</literal>.
</para>
1912 <xi:include href=
"version-info.xml" xpointer=
"v237"/>
1916 <term><varname>FirewallMark=
</varname></term>
1918 <para>Sets a firewall mark on outgoing WireGuard packets from this interface. Takes a number between
1 and
4294967295.
</para>
1920 <xi:include href=
"version-info.xml" xpointer=
"v243"/>
1924 <term><varname>RouteTable=
</varname></term>
1926 <para>The table identifier for the routes to the addresses specified in the
1927 <varname>AllowedIPs=
</varname>. Takes a negative boolean value, one of the predefined names
1928 <literal>default
</literal>,
<literal>main
</literal>, and
<literal>local
</literal>, names
1929 defined in
<varname>RouteTable=
</varname> in
1930 <citerefentry><refentrytitle>networkd.conf
</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
1931 or a number in the range
1…
4294967295. When
<literal>off
</literal> the routes to the
1932 addresses specified in the
<varname>AllowedIPs=
</varname> setting will not be configured.
1933 Defaults to false. This setting will be ignored when the same setting is specified in the
1934 [WireGuardPeer] section.
</para>
1936 <xi:include href=
"version-info.xml" xpointer=
"v250"/>
1940 <term><varname>RouteMetric=
</varname></term>
1942 <para>The priority of the routes to the addresses specified in the
1943 <varname>AllowedIPs=
</varname>. Takes an integer in the range
0…
4294967295. Defaults to
0
1944 for IPv4 addresses, and
1024 for IPv6 addresses. This setting will be ignored when the same
1945 setting is specified in the [WireGuardPeer] section.
</para>
1947 <xi:include href=
"version-info.xml" xpointer=
"v250"/>
1954 <title>[WireGuardPeer] Section Options
</title>
1956 <para>The [WireGuardPeer] section accepts the following
1959 <variablelist class='network-directives'
>
1961 <term><varname>PublicKey=
</varname></term>
1963 <para>Sets a Base64 encoded public key calculated by
<command>wg pubkey
</command>
1964 (see
<citerefentry project=
"wireguard"><refentrytitle>wg
</refentrytitle><manvolnum>8</manvolnum></citerefentry>)
1965 from a private key, and usually transmitted out of band to the
1966 author of the configuration file. This option is mandatory for this
1969 <xi:include href=
"version-info.xml" xpointer=
"v237"/>
1973 <term><varname>PresharedKey=
</varname></term>
1975 <para>Optional preshared key for the interface. It can be generated
1976 by the
<command>wg genpsk
</command> command. This option adds an
1977 additional layer of symmetric-key cryptography to be mixed into the
1978 already existing public-key cryptography, for post-quantum
1980 Note that because this information is secret, you may want to set
1981 the permissions of the .netdev file to be owned by
<literal>root:systemd-network
</literal>
1982 with a
<literal>0640</literal> file mode.
</para>
1984 <xi:include href=
"version-info.xml" xpointer=
"v237"/>
1988 <term><varname>PresharedKeyFile=
</varname></term>
1990 <para>Takes an absolute path to a file which contains the Base64 encoded preshared key for the
1991 peer. When this option is specified, then
<varname>PresharedKey=
</varname> is ignored. Note that
1992 the file must be readable by the user
<literal>systemd-network
</literal>, so it should be, e.g.,
1993 owned by
<literal>root:systemd-network
</literal> with a
<literal>0640</literal> file mode. If the
1994 path refers to an
<constant>AF_UNIX
</constant> stream socket in the file system a connection is
1995 made to it and the key read from it.
</para>
1997 <xi:include href=
"version-info.xml" xpointer=
"v242"/>
2001 <term><varname>AllowedIPs=
</varname></term>
2003 <para>Sets a comma-separated list of IP (v4 or v6) addresses with CIDR masks from which this peer
2004 is allowed to send incoming traffic and to which outgoing traffic for this peer is directed. This
2005 setting can be specified multiple times. If an empty string is assigned, then the all previous
2006 assignments are cleared.
</para>
2008 <para>The catch-all
0.0.0.0/
0 may be specified for matching all IPv4 addresses,
2009 and ::/
0 may be specified for matching all IPv6 addresses.
</para>
2011 <para>Note that this only affects
<emphasis>routing inside the network interface itself
</emphasis>,
2012 i.e. the packets that pass through the tunnel itself. To cause packets to be sent via the tunnel in
2013 the first place, an appropriate route needs to be added as well — either in the
2014 <literal>[Routes]
</literal> section on the
<literal>.network
</literal> matching the wireguard
2015 interface, or externally to
<filename>systemd-networkd
</filename>.
</para>
2017 <xi:include href=
"version-info.xml" xpointer=
"v237"/>
2021 <term><varname>Endpoint=
</varname></term>
2023 <para>Sets an endpoint IP address or hostname, followed by a colon, and then
2024 a port number. IPv6 address must be in the square brackets. For example,
2025 <literal>111.222.333.444:
51820</literal> for IPv4 and
<literal>[
1111:
2222::
3333]:
51820</literal>
2026 for IPv6 address. This endpoint will be updated automatically once to
2027 the most recent source IP address and port of correctly
2028 authenticated packets from the peer at configuration time.
</para>
2030 <xi:include href=
"version-info.xml" xpointer=
"v237"/>
2034 <term><varname>PersistentKeepalive=
</varname></term>
2036 <para>Sets a seconds interval, between
1 and
65535 inclusive, of how often
2037 to send an authenticated empty packet to the peer for the purpose
2038 of keeping a stateful firewall or NAT mapping valid persistently.
2039 For example, if the interface very rarely sends traffic, but it
2040 might at anytime receive traffic from a peer, and it is behind NAT,
2041 the interface might benefit from having a persistent keepalive
2042 interval of
25 seconds. If set to
0 or
"off", this option is
2043 disabled. By default or when unspecified, this option is off.
2044 Most users will not need this.
</para>
2046 <xi:include href=
"version-info.xml" xpointer=
"v237"/>
2050 <term><varname>RouteTable=
</varname></term>
2052 <para>The table identifier for the routes to the addresses specified in the
2053 <varname>AllowedIPs=
</varname>. Takes a negative boolean value, one of the predefined names
2054 <literal>default
</literal>,
<literal>main
</literal>, and
<literal>local
</literal>, names
2055 defined in
<varname>RouteTable=
</varname> in
2056 <citerefentry><refentrytitle>networkd.conf
</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
2057 or a number in the range
1…
4294967295. Defaults to unset, and the value specified in the
2058 same setting in the [WireGuard] section will be used.
</para>
2060 <xi:include href=
"version-info.xml" xpointer=
"v250"/>
2064 <term><varname>RouteMetric=
</varname></term>
2066 <para>The priority of the routes to the addresses specified in the
2067 <varname>AllowedIPs=
</varname>. Takes an integer in the range
0…
4294967295. Defaults to
2068 unset, and the value specified in the same setting in the [WireGuard] section will be used.
2071 <xi:include href=
"version-info.xml" xpointer=
"v250"/>
2078 <title>[Bond] Section Options
</title>
2080 <para>The [Bond] section accepts the following
2083 <variablelist class='network-directives'
>
2085 <term><varname>Mode=
</varname></term>
2087 <para>Specifies one of the bonding policies. The default is
2088 <literal>balance-rr
</literal> (round robin). Possible values are
2089 <literal>balance-rr
</literal>,
2090 <literal>active-backup
</literal>,
2091 <literal>balance-xor
</literal>,
2092 <literal>broadcast
</literal>,
2093 <literal>802.3ad
</literal>,
2094 <literal>balance-tlb
</literal>, and
2095 <literal>balance-alb
</literal>.
2098 <xi:include href=
"version-info.xml" xpointer=
"v216"/>
2103 <term><varname>TransmitHashPolicy=
</varname></term>
2105 <para>Selects the transmit hash policy to use for slave
2106 selection in balance-xor,
802.3ad, and tlb modes. Possible
2108 <literal>layer2
</literal>,
2109 <literal>layer3+
4</literal>,
2110 <literal>layer2+
3</literal>,
2111 <literal>encap2+
3</literal>, and
2112 <literal>encap3+
4</literal>.
2115 <xi:include href=
"version-info.xml" xpointer=
"v216"/>
2120 <term><varname>LACPTransmitRate=
</varname></term>
2122 <para>Specifies the rate with which link partner transmits
2123 Link Aggregation Control Protocol Data Unit packets in
2124 802.3ad mode. Possible values are
<literal>slow
</literal>,
2125 which requests partner to transmit LACPDUs every
30 seconds,
2126 and
<literal>fast
</literal>, which requests partner to
2127 transmit LACPDUs every second. The default value is
2128 <literal>slow
</literal>.
</para>
2130 <xi:include href=
"version-info.xml" xpointer=
"v216"/>
2135 <term><varname>MIIMonitorSec=
</varname></term>
2137 <para>Specifies the frequency that Media Independent
2138 Interface link monitoring will occur. A value of zero
2139 disables MII link monitoring. This value is rounded down to
2140 the nearest millisecond. The default value is
0.
</para>
2142 <xi:include href=
"version-info.xml" xpointer=
"v216"/>
2147 <term><varname>UpDelaySec=
</varname></term>
2149 <para>Specifies the delay before a link is enabled after a
2150 link up status has been detected. This value is rounded down
2151 to a multiple of
<varname>MIIMonitorSec=
</varname>. The default value is
2154 <xi:include href=
"version-info.xml" xpointer=
"v216"/>
2159 <term><varname>DownDelaySec=
</varname></term>
2161 <para>Specifies the delay before a link is disabled after a
2162 link down status has been detected. This value is rounded
2163 down to a multiple of
<varname>MIIMonitorSec=
</varname>. The default value is
2166 <xi:include href=
"version-info.xml" xpointer=
"v216"/>
2171 <term><varname>LearnPacketIntervalSec=
</varname></term>
2173 <para>Specifies the number of seconds between instances where the bonding
2174 driver sends learning packets to each slave peer switch.
2175 The valid range is
1…
0x7fffffff; the default value is
1. This option
2176 has an effect only for the balance-tlb and balance-alb modes.
</para>
2178 <xi:include href=
"version-info.xml" xpointer=
"v220"/>
2183 <term><varname>AdSelect=
</varname></term>
2185 <para>Specifies the
802.3ad aggregation selection logic to use. Possible values are
2186 <literal>stable
</literal>,
2187 <literal>bandwidth
</literal> and
2188 <literal>count
</literal>.
2191 <xi:include href=
"version-info.xml" xpointer=
"v220"/>
2196 <term><varname>AdActorSystemPriority=
</varname></term>
2198 <para>Specifies the
802.3ad actor system priority. Takes a number in the range
1…
65535.
</para>
2200 <xi:include href=
"version-info.xml" xpointer=
"v240"/>
2205 <term><varname>AdUserPortKey=
</varname></term>
2207 <para>Specifies the
802.3ad user defined portion of the port key. Takes a number in the range
2210 <xi:include href=
"version-info.xml" xpointer=
"v240"/>
2215 <term><varname>AdActorSystem=
</varname></term>
2217 <para>Specifies the
802.3ad system MAC address. This cannot be a null or multicast address.
2220 <xi:include href=
"version-info.xml" xpointer=
"v240"/>
2225 <term><varname>FailOverMACPolicy=
</varname></term>
2227 <para>Specifies whether the active-backup mode should set all slaves to
2228 the same MAC address at the time of enslavement or, when enabled, to perform special handling of the
2229 bond's MAC address in accordance with the selected policy. The default policy is none.
2231 <literal>none
</literal>,
2232 <literal>active
</literal> and
2233 <literal>follow
</literal>.
2236 <xi:include href=
"version-info.xml" xpointer=
"v220"/>
2241 <term><varname>ARPValidate=
</varname></term>
2243 <para>Specifies whether or not ARP probes and replies should be
2244 validated in any mode that supports ARP monitoring, or whether
2245 non-ARP traffic should be filtered (disregarded) for link
2246 monitoring purposes. Possible values are
2247 <literal>none
</literal>,
2248 <literal>active
</literal>,
2249 <literal>backup
</literal> and
2250 <literal>all
</literal>.
2253 <xi:include href=
"version-info.xml" xpointer=
"v220"/>
2258 <term><varname>ARPIntervalSec=
</varname></term>
2260 <para>Specifies the ARP link monitoring frequency. A value of
0 disables ARP monitoring. The
2261 default value is
0, and the default unit seconds.
2264 <xi:include href=
"version-info.xml" xpointer=
"v220"/>
2269 <term><varname>ARPIPTargets=
</varname></term>
2271 <para>Specifies the IP addresses to use as ARP monitoring peers when
2272 <varname>ARPIntervalSec=
</varname> is greater than
0. These are the targets of the ARP
2273 request sent to determine the health of the link to the targets.
2274 Specify these values in IPv4 dotted decimal format. At least one IP
2275 address must be given for ARP monitoring to function. The
2276 maximum number of targets that can be specified is
16. The
2277 default value is no IP addresses.
2280 <xi:include href=
"version-info.xml" xpointer=
"v220"/>
2285 <term><varname>ARPAllTargets=
</varname></term>
2287 <para>Specifies the quantity of
<varname>ARPIPTargets=
</varname> that must be reachable
2288 in order for the ARP monitor to consider a slave as being up.
2289 This option affects only active-backup mode for slaves with
2290 ARPValidate enabled. Possible values are
2291 <literal>any
</literal> and
2292 <literal>all
</literal>.
2295 <xi:include href=
"version-info.xml" xpointer=
"v220"/>
2300 <term><varname>PrimaryReselectPolicy=
</varname></term>
2302 <para>Specifies the reselection policy for the primary slave. This
2303 affects how the primary slave is chosen to become the active slave
2304 when failure of the active slave or recovery of the primary slave
2305 occurs. This option is designed to prevent flip-flopping between
2306 the primary slave and other slaves. Possible values are
2307 <literal>always
</literal>,
2308 <literal>better
</literal> and
2309 <literal>failure
</literal>.
2312 <xi:include href=
"version-info.xml" xpointer=
"v220"/>
2317 <term><varname>ResendIGMP=
</varname></term>
2319 <para>Specifies the number of IGMP membership reports to be issued after
2320 a failover event. One membership report is issued immediately after
2321 the failover, subsequent packets are sent in each
200ms interval.
2322 The valid range is
0…
255. Defaults to
1. A value of
0
2323 prevents the IGMP membership report from being issued in response
2324 to the failover event.
2327 <xi:include href=
"version-info.xml" xpointer=
"v220"/>
2332 <term><varname>PacketsPerSlave=
</varname></term>
2334 <para>Specify the number of packets to transmit through a slave before
2335 moving to the next one. When set to
0, then a slave is chosen at
2336 random. The valid range is
0…
65535. Defaults to
1. This option
2337 only has effect when in balance-rr mode.
2340 <xi:include href=
"version-info.xml" xpointer=
"v220"/>
2345 <term><varname>GratuitousARP=
</varname></term>
2347 <para>Specify the number of peer notifications (gratuitous ARPs and
2348 unsolicited IPv6 Neighbor Advertisements) to be issued after a
2349 failover event. As soon as the link is up on the new slave,
2350 a peer notification is sent on the bonding device and each
2351 VLAN sub-device. This is repeated at each link monitor interval
2352 (ARPIntervalSec or MIIMonitorSec, whichever is active) if the number is
2353 greater than
1. The valid range is
0…
255. The default value is
1.
2354 These options affect only the active-backup mode.
2357 <xi:include href=
"version-info.xml" xpointer=
"v220"/>
2362 <term><varname>AllSlavesActive=
</varname></term>
2364 <para>Takes a boolean. Specifies that duplicate frames (received on inactive ports)
2365 should be dropped when false, or delivered when true. Normally, bonding will drop
2366 duplicate frames (received on inactive ports), which is desirable for
2367 most users. But there are some times it is nice to allow duplicate
2368 frames to be delivered. The default value is false (drop duplicate frames
2369 received on inactive ports).
2372 <xi:include href=
"version-info.xml" xpointer=
"v220"/>
2377 <term><varname>DynamicTransmitLoadBalancing=
</varname></term>
2379 <para>Takes a boolean. Specifies if dynamic shuffling of flows is enabled. Applies only
2380 for balance-tlb mode. Defaults to unset.
2383 <xi:include href=
"version-info.xml" xpointer=
"v240"/>
2388 <term><varname>MinLinks=
</varname></term>
2390 <para>Specifies the minimum number of links that must be active before
2391 asserting carrier. The default value is
0.
2394 <xi:include href=
"version-info.xml" xpointer=
"v220"/>
2399 <para>For more detail information see
2400 <ulink url=
"https://docs.kernel.org/networking/bonding.html">
2401 Linux Ethernet Bonding Driver HOWTO
</ulink></para>
2405 <title>[Xfrm] Section Options
</title>
2407 <para>The [Xfrm] section accepts the following
2410 <variablelist class='network-directives'
>
2412 <term><varname>InterfaceId=
</varname></term>
2414 <para>Sets the ID/key of the xfrm interface which needs to be associated with a SA/policy.
2415 Can be decimal or hexadecimal, valid range is
1-
0xffffffff. This is mandatory.
</para>
2417 <xi:include href=
"version-info.xml" xpointer=
"v243"/>
2421 <term><varname>Independent=
</varname></term>
2423 <para>Takes a boolean. If false (the default), the xfrm interface must have an underlying device
2424 which can be used for hardware offloading.
</para>
2426 <xi:include href=
"version-info.xml" xpointer=
"v243"/>
2431 <para>For more detail information see
2432 <ulink url=
"https://lwn.net/Articles/757391">Virtual XFRM Interfaces
</ulink>.
</para>
2436 <title>[VRF] Section Options
</title>
2437 <para>The [VRF] section only applies for
2438 netdevs of kind
<literal>vrf
</literal> and accepts the
2439 following key:
</para>
2441 <variablelist class='network-directives'
>
2443 <term><varname>Table=
</varname></term>
2445 <para>The numeric routing table identifier. This setting is compulsory.
</para>
2447 <xi:include href=
"version-info.xml" xpointer=
"v243"/>
2454 <title>[BatmanAdvanced] Section Options
</title>
2456 <para>The [BatmanAdvanced] section only applies for netdevs of kind
<literal>batadv
</literal> and accepts
2457 the following keys:
</para>
2459 <variablelist class='network-directives'
>
2461 <term><varname>GatewayMode=
</varname></term>
2463 <para>Takes one of
<literal>off
</literal>,
<literal>server
</literal>, or
<literal>client
</literal>.
2464 A batman-adv node can either run in server mode (sharing its internet
2465 connection with the mesh) or in client mode (searching for the most suitable internet connection
2466 in the mesh) or having the gateway support turned off entirely (which is the default setting).
2469 <xi:include href=
"version-info.xml" xpointer=
"v248"/>
2473 <term><varname>Aggregation=
</varname></term>
2475 <para>Takes a boolean value. Enables or disables aggregation of originator messages. Defaults to
2479 <xi:include href=
"version-info.xml" xpointer=
"v248"/>
2483 <term><varname>BridgeLoopAvoidance=
</varname></term>
2485 <para>Takes a boolean value. Enables or disables avoidance of loops on bridges. Defaults to true.
2488 <xi:include href=
"version-info.xml" xpointer=
"v248"/>
2492 <term><varname>DistributedArpTable=
</varname></term>
2494 <para>Takes a boolean value. Enables or disables the distributed ARP table. Defaults to true.
</para>
2496 <xi:include href=
"version-info.xml" xpointer=
"v248"/>
2500 <term><varname>Fragmentation=
</varname></term>
2502 <para>Takes a boolean value. Enables or disables fragmentation. Defaults to true.
</para>
2504 <xi:include href=
"version-info.xml" xpointer=
"v248"/>
2508 <term><varname>HopPenalty=
</varname></term>
2510 <para>The hop penalty setting allows one to modify
2511 <citerefentry project='mankier'
><refentrytitle>batctl
</refentrytitle><manvolnum>8</manvolnum></citerefentry>
2512 preference for multihop routes vs. short routes. This integer value is applied to the
2513 TQ (Transmit Quality) of each forwarded OGM (Originator Message), thereby propagating the
2514 cost of an extra hop (the packet has to be received and retransmitted which costs airtime).
2515 A higher hop penalty will make it more unlikely that other nodes will choose this node as
2516 intermediate hop towards any given destination. The default hop penalty of '
15' is a reasonable
2517 value for most setups and probably does not need to be changed. However, mobile nodes could
2518 choose a value of
255 (maximum value) to avoid being chosen as a router by other nodes.
2519 The minimum value is
0.
2522 <xi:include href=
"version-info.xml" xpointer=
"v248"/>
2526 <term><varname>OriginatorIntervalSec=
</varname></term>
2528 <para>The value specifies the interval in seconds, unless another time unit is specified in which
2529 batman-adv floods the network with its protocol information.
2530 See
<citerefentry><refentrytitle>systemd.time
</refentrytitle><manvolnum>7</manvolnum></citerefentry>
2531 for more information.
</para>
2533 <xi:include href=
"version-info.xml" xpointer=
"v248"/>
2537 <term><varname>GatewayBandwidthDown=
</varname></term>
2539 <para>If the node is a server, this
2540 parameter is used to inform other nodes in the network about
2541 this node's internet connection download bandwidth in bits per second. Just enter any number
2542 suffixed with K, M, G or T (base
1000) and the batman-adv
2543 module will propagate the entered value in the mesh.
</para>
2545 <xi:include href=
"version-info.xml" xpointer=
"v248"/>
2549 <term><varname>GatewayBandwidthUp=
</varname></term>
2551 <para>If the node is a server, this
2552 parameter is used to inform other nodes in the network about
2553 this node's internet connection upload bandwidth in bits per second. Just enter any number
2554 suffixed with K, M, G or T (base
1000) and the batman-adv
2555 module will propagate the entered value in the mesh.
</para>
2557 <xi:include href=
"version-info.xml" xpointer=
"v248"/>
2561 <term><varname>RoutingAlgorithm=
</varname></term>
2563 <para>This can be either
<literal>batman-v
</literal> or
<literal>batman-iv
</literal> and describes which routing_algo
2564 of
<citerefentry project='mankier'
><refentrytitle>batctl
</refentrytitle><manvolnum>8</manvolnum></citerefentry> to use. The algorithm
2565 cannot be changed after interface creation. Defaults to
<literal>batman-v
</literal>.
2568 <xi:include href=
"version-info.xml" xpointer=
"v248"/>
2575 <title>[IPoIB] Section Options
</title>
2576 <para>The [IPoIB] section only applies for netdevs of kind
<literal>ipoib
</literal> and accepts the
2577 following keys:
</para>
2579 <variablelist class='network-directives'
>
2581 <term><varname>PartitionKey=
</varname></term>
2583 <para>Takes an integer in the range
1…
0xffff, except for
0x8000. Defaults to unset, and the
2584 kernel's default is used.
</para>
2586 <xi:include href=
"version-info.xml" xpointer=
"v250"/>
2590 <varlistentry id='ipoib_mode'
>
2591 <term><varname>Mode=
</varname></term>
2593 <para>Takes one of the special values
<literal>datagram
</literal> or
2594 <literal>connected
</literal>. Defaults to unset, and the kernel's default is used.
</para>
2596 <para>When
<literal>datagram
</literal>, the Infiniband unreliable datagram (UD) transport is
2597 used, and so the interface MTU is equal to the IB L2 MTU minus the IPoIB encapsulation
2598 header (
4 bytes). For example, in a typical IB fabric with a
2K MTU, the IPoIB MTU will be
2599 2048 -
4 =
2044 bytes.
</para>
2601 <para>When
<literal>connected
</literal>, the Infiniband reliable connected (RC) transport is
2602 used. Connected mode takes advantage of the connected nature of the IB transport and allows
2603 an MTU up to the maximal IP packet size of
64K, which reduces the number of IP packets needed
2604 for handling large UDP datagrams, TCP segments, etc and increases the performance for large
2607 <xi:include href=
"version-info.xml" xpointer=
"v250"/>
2611 <varlistentry id='ipoib_umcast'
>
2612 <term><varname>IgnoreUserspaceMulticastGroup=
</varname></term>
2614 <para>Takes an boolean value. When true, the kernel ignores multicast groups handled by
2615 userspace. Defaults to unset, and the kernel's default is used.
</para>
2617 <xi:include href=
"version-info.xml" xpointer=
"v250"/>
2624 <title>[WLAN] Section Options
</title>
2625 <para>The [WLAN] section only applies to WLAN interfaces, and accepts the following keys:
</para>
2627 <variablelist class='network-directives'
>
2629 <term><varname>PhysicalDevice=
</varname></term>
2631 <para>Specifies the name or index of the physical WLAN device (e.g.
<literal>0</literal> or
2632 <literal>phy0
</literal>). The list of the physical WLAN devices that exist on the host can be
2633 obtained by
<command>iw phy
</command> command. This option is mandatory.
</para>
2635 <xi:include href=
"version-info.xml" xpointer=
"v251"/>
2640 <term><varname>Type=
</varname></term>
2642 <para>Specifies the type of the interface. Takes one of the
<literal>ad-hoc
</literal>,
2643 <literal>station
</literal>,
<literal>ap
</literal>,
<literal>ap-vlan
</literal>,
2644 <literal>wds
</literal>,
<literal>monitor
</literal>,
<literal>mesh-point
</literal>,
2645 <literal>p2p-client
</literal>,
<literal>p2p-go
</literal>,
<literal>p2p-device
</literal>,
2646 <literal>ocb
</literal>, and
<literal>nan
</literal>. This option is mandatory.
</para>
2648 <xi:include href=
"version-info.xml" xpointer=
"v251"/>
2653 <term><varname>WDS=
</varname></term>
2655 <para>Enables the Wireless Distribution System (WDS) mode on the interface. The mode is also
2656 known as the
<literal>4 address mode
</literal>. Takes a boolean value. Defaults to unset, and
2657 the kernel's default will be used.
</para>
2659 <xi:include href=
"version-info.xml" xpointer=
"v251"/>
2666 <title>Examples
</title>
2668 <title>/etc/systemd/network/
25-bridge.netdev
</title>
2670 <programlisting>[NetDev]
2672 Kind=bridge
</programlisting>
2676 <title>/etc/systemd/network/
25-vlan1.netdev
</title>
2678 <programlisting>[Match]
2686 Id=
1</programlisting>
2689 <title>/etc/systemd/network/
25-ipip.netdev
</title>
2690 <programlisting>[NetDev]
2696 Local=
192.168.223.238
2697 Remote=
192.169.224.239
2698 TTL=
64</programlisting>
2701 <title>/etc/systemd/network/
1-fou-tunnel.netdev
</title>
2702 <programlisting>[NetDev]
2712 <title>/etc/systemd/network/
25-fou-ipip.netdev
</title>
2713 <programlisting>[NetDev]
2720 Remote=
10.65.208.211
2722 FOUDestinationPort=
5555
2726 <title>/etc/systemd/network/
25-tap.netdev
</title>
2727 <programlisting>[NetDev]
2733 PacketInfo=yes
</programlisting> </example>
2736 <title>/etc/systemd/network/
25-sit.netdev
</title>
2737 <programlisting>[NetDev]
2744 Remote=
10.65.223.239</programlisting>
2748 <title>/etc/systemd/network/
25-
6rd.netdev
</title>
2749 <programlisting>[NetDev]
2756 IPv6RapidDeploymentPrefix=
2602::/
24</programlisting>
2760 <title>/etc/systemd/network/
25-gre.netdev
</title>
2761 <programlisting>[NetDev]
2768 Remote=
10.65.223.239</programlisting>
2772 <title>/etc/systemd/network/
25-ip6gre.netdev
</title>
2773 <programlisting>[NetDev]
2778 Key=
123</programlisting>
2782 <title>/etc/systemd/network/
25-vti.netdev
</title>
2784 <programlisting>[NetDev]
2791 Remote=
10.65.223.239</programlisting>
2795 <title>/etc/systemd/network/
25-veth.netdev
</title>
2796 <programlisting>[NetDev]
2801 Name=veth-peer
</programlisting>
2805 <title>/etc/systemd/network/
25-bond.netdev
</title>
2806 <programlisting>[NetDev]
2812 TransmitHashPolicy=layer3+
4
2814 LACPTransmitRate=fast
2819 <title>/etc/systemd/network/
25-dummy.netdev
</title>
2820 <programlisting>[NetDev]
2823 MACAddress=
12:
34:
56:
78:
9a:bc
</programlisting>
2826 <title>/etc/systemd/network/
25-vrf.netdev
</title>
2827 <para>Create a VRF interface with table
42.
</para>
2828 <programlisting>[NetDev]
2833 Table=
42</programlisting>
2837 <title>/etc/systemd/network/
25-macvtap.netdev
</title>
2838 <para>Create a MacVTap device.
</para>
2839 <programlisting>[NetDev]
2845 <title>/etc/systemd/network/
25-wireguard.netdev
</title>
2846 <programlisting>[NetDev]
2851 PrivateKey=EEGlnEPYJV//kbvvIqxKkQwOiS+UENyPncC4bF46ong=
2855 PublicKey=RDf+LSpeEre7YEIKaxg+wbpsNV7du+ktR99uBEtIiCA=
2856 AllowedIPs=fd31:bf08:
57cb::/
48,
192.168.26.0/
24
2857 Endpoint=wireguard.example.com:
51820</programlisting>
2861 <title>/etc/systemd/network/
27-xfrm.netdev
</title>
2862 <programlisting>[NetDev]
2867 Independent=yes
</programlisting>
2872 <title>See Also
</title>
2874 <citerefentry><refentrytitle>systemd
</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
2875 <citerefentry><refentrytitle>systemd-networkd
</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
2876 <citerefentry><refentrytitle>systemd.link
</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
2877 <citerefentry><refentrytitle>systemd.network
</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
2878 <citerefentry><refentrytitle>systemd-network-generator.service
</refentrytitle><manvolnum>8</manvolnum></citerefentry>