1 <?xml version='
1.0'
?> <!--*-nxml-*-->
2 <!DOCTYPE refentry PUBLIC
"-//OASIS//DTD DocBook XML V4.2//EN"
3 "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
6 This file is part of systemd.
8 Copyright 2013 Tom Gundersen
10 systemd is free software; you can redistribute it and/or modify it
11 under the terms of the GNU Lesser General Public License as published by
12 the Free Software Foundation; either version 2.1 of the License, or
13 (at your option) any later version.
15 systemd is distributed in the hope that it will be useful, but
16 WITHOUT ANY WARRANTY; without even the implied warranty of
17 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18 Lesser General Public License for more details.
20 You should have received a copy of the GNU Lesser General Public License
21 along with systemd; If not, see <http://www.gnu.org/licenses/>.
24 <refentry id=
"systemd.netdev" conditional='ENABLE_NETWORKD'
>
27 <title>systemd.network
</title>
28 <productname>systemd
</productname>
32 <contrib>Developer
</contrib>
33 <firstname>Tom
</firstname>
34 <surname>Gundersen
</surname>
35 <email>teg@jklm.no
</email>
41 <refentrytitle>systemd.netdev
</refentrytitle>
42 <manvolnum>5</manvolnum>
46 <refname>systemd.netdev
</refname>
47 <refpurpose>Virtual Network Device configuration
</refpurpose>
51 <para><filename><replaceable>netdev
</replaceable>.netdev
</filename></para>
55 <title>Description
</title>
57 <para>Network setup is performed by
58 <citerefentry><refentrytitle>systemd-networkd
</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
61 <para>The main Virtual Network Device file must have the extension
<filename>.netdev
</filename>;
62 other extensions are ignored. Virtual network devices are created as soon as networkd is
63 started. If a netdev with the specified name already exists, networkd will use that as-is rather
64 than create its own. Note that the settings of the pre-existing netdev will not be changed by
67 <para>The
<filename>.netdev
</filename> files are read from the files located in the system
68 network directory
<filename>/usr/lib/systemd/network
</filename>, the volatile runtime network
69 directory
<filename>/run/systemd/network
</filename> and the local administration network
70 directory
<filename>/etc/systemd/network
</filename>. All configuration files are collectively
71 sorted and processed in lexical order, regardless of the directories in which they live.
72 However, files with identical filenames replace each other. Files in
<filename>/etc
</filename>
73 have the highest priority, files in
<filename>/run
</filename> take precedence over files with
74 the same name in
<filename>/usr/lib
</filename>. This can be used to override a system-supplied
75 configuration file with a local file if needed. As a special case, an empty file (file size
0)
76 or symlink with the same name pointing to
<filename>/dev/null
</filename> disables the
77 configuration file entirely (it is
"masked").
</para>
79 <para>Along with the netdev file
<filename>foo.netdev
</filename>, a
"drop-in" directory
80 <filename>foo.netdev.d/
</filename> may exist. All files with the suffix
<literal>.conf
</literal>
81 from this directory will be parsed after the file itself is parsed. This is useful to alter or
82 add configuration settings, without having to modify the main configuration file. Each drop-in
83 file must have appropriate section headers.
</para>
85 <para>In addition to
<filename>/etc/systemd/network
</filename>, drop-in
<literal>.d
</literal>
86 directories can be placed in
<filename>/usr/lib/systemd/network
</filename> or
87 <filename>/run/systemd/network
</filename> directories. Drop-in files in
88 <filename>/etc
</filename> take precedence over those in
<filename>/run
</filename> which in turn
89 take precedence over those in
<filename>/usr/lib
</filename>. Drop-in files under any of these
90 directories take precedence over the main netdev file wherever located. (Of course, since
91 <filename>/run
</filename> is temporary and
<filename>/usr/lib
</filename> is for vendors, it is
92 unlikely drop-ins should be used in either of those places.)
</para>
96 <title>Supported netdev kinds
</title>
98 <para>The following kinds of virtual network devices may be
99 configured in
<filename>.netdev
</filename> files:
</para>
102 <title>Supported kinds of virtual network devices
</title>
105 <colspec colname='kind'
/>
106 <colspec colname='explanation'
/>
109 <entry>Description
</entry>
112 <row><entry><varname>bond
</varname></entry>
113 <entry>A bond device is an aggregation of all its slave devices. See
<ulink url=
"https://www.kernel.org/doc/Documentation/networking/bonding.txt">Linux Ethernet Bonding Driver HOWTO
</ulink> for details.Local configuration
</entry></row>
115 <row><entry><varname>bridge
</varname></entry>
116 <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>
118 <row><entry><varname>dummy
</varname></entry>
119 <entry>A dummy device drops all packets sent to it.
</entry></row>
121 <row><entry><varname>gre
</varname></entry>
122 <entry>A Level
3 GRE tunnel over IPv4. See
<ulink url=
"https://tools.ietf.org/html/rfc2784">RFC
2784</ulink> for details.
</entry></row>
124 <row><entry><varname>gretap
</varname></entry>
125 <entry>A Level
2 GRE tunnel over IPv4.
</entry></row>
127 <row><entry><varname>ip6gre
</varname></entry>
128 <entry>A Level
3 GRE tunnel over IPv6.
</entry></row>
130 <row><entry><varname>ip6tnl
</varname></entry>
131 <entry>An IPv4 or IPv6 tunnel over IPv6
</entry></row>
133 <row><entry><varname>ip6gretap
</varname></entry>
134 <entry>A Level
2 GRE tunnel over IPv6.
</entry></row>
136 <row><entry><varname>ipip
</varname></entry>
137 <entry>An IPv4 over IPv4 tunnel.
</entry></row>
139 <row><entry><varname>ipvlan
</varname></entry>
140 <entry>An ipvlan device is a stacked device which receives packets from its underlying device based on IP address filtering.
</entry></row>
142 <row><entry><varname>macvlan
</varname></entry>
143 <entry>A macvlan device is a stacked device which receives packets from its underlying device based on MAC address filtering.
</entry></row>
145 <row><entry><varname>macvtap
</varname></entry>
146 <entry>A macvtap device is a stacked device which receives packets from its underlying device based on MAC address filtering.
</entry></row>
148 <row><entry><varname>sit
</varname></entry>
149 <entry>An IPv6 over IPv4 tunnel.
</entry></row>
151 <row><entry><varname>tap
</varname></entry>
152 <entry>A persistent Level
2 tunnel between a network device and a device node.
</entry></row>
154 <row><entry><varname>tun
</varname></entry>
155 <entry>A persistent Level
3 tunnel between a network device and a device node.
</entry></row>
157 <row><entry><varname>veth
</varname></entry>
158 <entry>An Ethernet tunnel between a pair of network devices.
</entry></row>
160 <row><entry><varname>vlan
</varname></entry>
161 <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>
163 <row><entry><varname>vti
</varname></entry>
164 <entry>An IPv4 over IPSec tunnel.
</entry></row>
166 <row><entry><varname>vti6
</varname></entry>
167 <entry>An IPv6 over IPSec tunnel.
</entry></row>
169 <row><entry><varname>vxlan
</varname></entry>
170 <entry>A virtual extensible LAN (vxlan), for connecting Cloud computing deployments.
</entry></row>
172 <row><entry><varname>geneve
</varname></entry>
173 <entry>A GEneric NEtwork Virtualization Encapsulation (GENEVE) netdev driver.
</entry></row>
175 <row><entry><varname>vrf
</varname></entry>
176 <entry>A Virtual Routing and Forwarding (
<ulink url=
"https://www.kernel.org/doc/Documentation/networking/vrf.txt">VRF
</ulink>) interface to create separate routing and forwarding domains.
</entry></row>
178 <row><entry><varname>vcan
</varname></entry>
179 <entry>The virtual CAN driver (vcan). Similar to the network loopback devices, vcan offers a virtual local CAN interface.
</entry></row>
188 <title>[Match] Section Options
</title>
190 <para>A virtual network device is only created if the
191 <literal>[Match]
</literal> section matches the current
192 environment, or if the section is empty. The following keys are
195 <variablelist class='network-directives'
>
197 <term><varname>Host=
</varname></term>
199 <para>Matches against the hostname or machine ID of the
200 host. See
<literal>ConditionHost=
</literal> in
201 <citerefentry><refentrytitle>systemd.unit
</refentrytitle><manvolnum>5</manvolnum></citerefentry>
207 <term><varname>Virtualization=
</varname></term>
209 <para>Checks whether the system is executed in a virtualized
210 environment and optionally test whether it is a specific
212 <literal>ConditionVirtualization=
</literal> in
213 <citerefentry><refentrytitle>systemd.unit
</refentrytitle><manvolnum>5</manvolnum></citerefentry>
219 <term><varname>KernelCommandLine=
</varname></term>
221 <para>Checks whether a specific kernel command line option
222 is set (or if prefixed with the exclamation mark unset). See
223 <literal>ConditionKernelCommandLine=
</literal> in
224 <citerefentry><refentrytitle>systemd.unit
</refentrytitle><manvolnum>5</manvolnum></citerefentry>
230 <term><varname>Architecture=
</varname></term>
232 <para>Checks whether the system is running on a specific
233 architecture. See
<literal>ConditionArchitecture=
</literal> in
234 <citerefentry><refentrytitle>systemd.unit
</refentrytitle><manvolnum>5</manvolnum></citerefentry>
244 <title>[NetDev] Section Options
</title>
246 <para>The
<literal>[NetDev]
</literal> section accepts the
247 following keys:
</para>
249 <variablelist class='network-directives'
>
251 <term><varname>Description=
</varname></term>
253 <para>A free-form description of the netdev.
</para>
257 <term><varname>Name=
</varname></term>
259 <para>The interface name used when creating the netdev.
260 This option is compulsory.
</para>
264 <term><varname>Kind=
</varname></term>
266 <para>The netdev kind. This option is compulsory. See the
267 <literal>Supported netdev kinds
</literal> section for the
272 <term><varname>MTUBytes=
</varname></term>
274 <para>The maximum transmission unit in bytes to set for
275 the device. The usual suffixes K, M, G, are supported and
276 are understood to the base of
1024. This key is not
277 currently supported for
<literal>tun
</literal> or
278 <literal>tap
</literal> devices.
283 <term><varname>MACAddress=
</varname></term>
285 <para>The MAC address to use for the device. If none is
286 given, one is generated based on the interface name and
288 <citerefentry><refentrytitle>machine-id
</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
289 This key is not currently supported for
290 <literal>tun
</literal> or
<literal>tap
</literal> devices.
298 <title>[Bridge] Section Options
</title>
300 <para>The
<literal>[Bridge]
</literal> section only applies for
301 netdevs of kind
<literal>bridge
</literal>, and accepts the
302 following keys:
</para>
304 <variablelist class='network-directives'
>
306 <term><varname>HelloTimeSec=
</varname></term>
308 <para>HelloTimeSec specifies the number of seconds between two hello packets
309 sent out by the root bridge and the designated bridges. Hello packets are
310 used to communicate information about the topology throughout the entire
311 bridged local area network.
</para>
315 <term><varname>MaxAgeSec=
</varname></term>
317 <para>MaxAgeSec specifies the number of seconds of maximum message age.
318 If the last seen (received) hello packet is more than this number of
319 seconds old, the bridge in question will start the takeover procedure
320 in attempt to become the Root Bridge itself.
</para>
324 <term><varname>ForwardDelaySec=
</varname></term>
326 <para>ForwardDelaySec specifies the number of seconds spent in each
327 of the Listening and Learning states before the Forwarding state is entered.
</para>
331 <term><varname>AgeingTimeSec=
</varname></term>
333 <para>This specifies the number of seconds a MAC Address will be kept in
334 the forwarding database after having a packet received from this MAC Address.
</para>
338 <term><varname>Priority=
</varname></term>
340 <para>The priority of the bridge. An integer between
0 and
65535. A lower value
341 means higher priority. The bridge having the lowest priority will be elected as root bridge.
</para>
345 <term><varname>DefaultPVID=
</varname></term>
347 <para>This specifies the default port VLAN ID of a newly attached bridge port.
</para>
351 <term><varname>MulticastQuerier=
</varname></term>
353 <para>A boolean. This setting controls the IFLA_BR_MCAST_QUERIER option in the kernel.
354 If enabled, the kernel will send general ICMP queries from a zero source address.
355 This feature should allow faster convergence on startup, but it causes some
356 multicast-aware switches to misbehave and disrupt forwarding of multicast packets.
357 When unset, the kernel's default setting applies.
362 <term><varname>MulticastSnooping=
</varname></term>
364 <para>A boolean. This setting controls the IFLA_BR_MCAST_SNOOPING option in the kernel.
365 If enabled, IGMP snooping monitors the Internet Group Management Protocol (IGMP) traffic
366 between hosts and multicast routers. When unset, the kernel's default setting applies.
371 <term><varname>VLANFiltering=
</varname></term>
373 <para>A boolean. This setting controls the IFLA_BR_VLAN_FILTERING option in the kernel.
374 If enabled, the bridge will be started in VLAN-filtering mode. When unset, the kernel's
375 default setting applies.
380 <term><varname>STP=
</varname></term>
382 <para>A boolean. This enables the bridge's Spanning Tree Protocol (STP). When unset,
383 the kernel's default setting applies.
391 <title>[VLAN] Section Options
</title>
393 <para>The
<literal>[VLAN]
</literal> section only applies for
394 netdevs of kind
<literal>vlan
</literal>, and accepts the
395 following key:
</para>
397 <variablelist class='network-directives'
>
399 <term><varname>Id=
</varname></term>
401 <para>The VLAN ID to use. An integer in the range
0–
4094.
402 This option is compulsory.
</para>
406 <term><varname>GVRP=
</varname></term>
408 <para>The Generic VLAN Registration Protocol (GVRP) is a protocol that
409 allows automatic learning of VLANs on a network. A boolean. When unset,
410 the kernel's default setting applies.
</para>
414 <term><varname>MVRP=
</varname></term>
416 <para>Multiple VLAN Registration Protocol (MVRP) formerly known as GARP VLAN
417 Registration Protocol (GVRP) is a standards-based Layer
2 network protocol,
418 for automatic configuration of VLAN information on switches. It was defined
419 in the
802.1ak amendment to
802.1Q-
2005. A boolean. When unset, the kernel's
420 default setting applies.
</para>
424 <term><varname>LooseBinding=
</varname></term>
426 <para>The VLAN loose binding mode, in which only the operational state is passed
427 from the parent to the associated VLANs, but the VLAN device state is not changed.
428 A boolean. When unset, the kernel's default setting applies.
</para>
432 <term><varname>ReorderHeader=
</varname></term>
434 <para>The VLAN reorder header is set VLAN interfaces behave like physical interfaces.
435 A boolean. When unset, the kernel's default setting applies.
</para>
442 <title>[MACVLAN] Section Options
</title>
444 <para>The
<literal>[MACVLAN]
</literal> section only applies for
445 netdevs of kind
<literal>macvlan
</literal>, and accepts the
446 following key:
</para>
448 <variablelist class='network-directives'
>
450 <term><varname>Mode=
</varname></term>
452 <para>The MACVLAN mode to use. The supported options are
453 <literal>private
</literal>,
454 <literal>vepa
</literal>,
455 <literal>bridge
</literal>, and
456 <literal>passthru
</literal>.
465 <title>[MACVTAP] Section Options
</title>
467 <para>The
<literal>[MACVTAP]
</literal> section applies for
468 netdevs of kind
<literal>macvtap
</literal> and accepts the
469 same key as
<literal>[MACVLAN]
</literal>.
</para>
474 <title>[IPVLAN] Section Options
</title>
476 <para>The
<literal>[IPVLAN]
</literal> section only applies for
477 netdevs of kind
<literal>ipvlan
</literal>, and accepts the
478 following key:
</para>
480 <variablelist class='network-directives'
>
482 <term><varname>Mode=
</varname></term>
484 <para>The IPVLAN mode to use. The supported options are
485 <literal>L2
</literal> and
<literal>L3
</literal>.
494 <title>[VXLAN] Section Options
</title>
495 <para>The
<literal>[VXLAN]
</literal> section only applies for
496 netdevs of kind
<literal>vxlan
</literal>, and accepts the
497 following keys:
</para>
499 <variablelist class='network-directives'
>
501 <term><varname>Id=
</varname></term>
503 <para>The VXLAN ID to use.
</para>
507 <term><varname>Remote=
</varname></term>
509 <para>Configures destination multicast group IP address.
</para>
513 <term><varname>Local=
</varname></term>
515 <para>Configures local IP address.
</para>
519 <term><varname>TOS=
</varname></term>
521 <para>The Type Of Service byte value for a vxlan interface.
</para>
525 <term><varname>TTL=
</varname></term>
527 <para>A fixed Time To Live N on Virtual eXtensible Local
528 Area Network packets. N is a number in the range
1–
255.
0
529 is a special value meaning that packets inherit the TTL
534 <term><varname>MacLearning=
</varname></term>
536 <para>A boolean. When true, enables dynamic MAC learning
537 to discover remote MAC addresses.
</para>
541 <term><varname>FDBAgeingSec=
</varname></term>
543 <para>The lifetime of Forwarding Database entry learnt by
544 the kernel, in seconds.
</para>
548 <term><varname>MaximumFDBEntries=
</varname></term>
550 <para>Configures maximum number of FDB entries.
</para>
554 <term><varname>ReduceARPProxy=
</varname></term>
556 <para>A boolean. When true, bridge-connected VXLAN tunnel
557 endpoint answers ARP requests from the local bridge on behalf
558 of remote Distributed Overlay Virtual Ethernet
559 <ulink url=
"https://en.wikipedia.org/wiki/Distributed_Overlay_Virtual_Ethernet">
560 (DVOE)
</ulink> clients. Defaults to false.
</para>
564 <term><varname>L2MissNotification=
</varname></term>
566 <para>A boolean. When true, enables netlink LLADDR miss
567 notifications.
</para>
571 <term><varname>L3MissNotification=
</varname></term>
573 <para>A boolean. When true, enables netlink IP address miss
574 notifications.
</para>
578 <term><varname>RouteShortCircuit=
</varname></term>
580 <para>A boolean. When true, route short circuiting is turned
585 <term><varname>UDPChecksum=
</varname></term>
587 <para>A boolean. When true, transmitting UDP checksums when doing VXLAN/IPv4 is turned on.
</para>
591 <term><varname>UDP6ZeroChecksumTx=
</varname></term>
593 <para>A boolean. When true, sending zero checksums in VXLAN/IPv6 is turned on.
</para>
597 <term><varname>UDP6ZeroChecksumRx=
</varname></term>
599 <para>A boolean. When true, receiving zero checksums in VXLAN/IPv6 is turned on.
</para>
603 <term><varname>RemoteChecksumTx=
</varname></term>
605 <para>A boolean. When true, remote transmit checksum offload of VXLAN is turned on.
</para>
609 <term><varname>RemoteChecksumRx=
</varname></term>
611 <para>A boolean. When true, remote receive checksum offload in VXLAN is turned on.
</para>
615 <term><varname>GroupPolicyExtension=
</varname></term>
617 <para>A boolean. When true, it enables Group Policy VXLAN extension security label mechanism
618 across network peers based on VXLAN. For details about the Group Policy VXLAN, see the
619 <ulink url=
"https://tools.ietf.org/html/draft-smith-vxlan-group-policy">
620 VXLAN Group Policy
</ulink> document. Defaults to false.
</para>
624 <term><varname>DestinationPort=
</varname></term>
626 <para>Configures the default destination UDP port on a per-device basis.
627 If destination port is not specified then Linux kernel default will be used.
628 Set destination port
4789 to get the IANA assigned value. If not set or if the
629 destination port is assigned the empty string the default port of
4789 is used.
</para>
633 <term><varname>PortRange=
</varname></term>
635 <para>Configures VXLAN port range. VXLAN bases source
636 UDP port based on flow to help the receiver to be able
637 to load balance based on outer header flow. It
638 restricts the port range to the normal UDP local
639 ports, and allows overriding via configuration.
</para>
643 <term><varname>FlowLabel=
</varname></term>
645 <para>Specifies the flow label to use in outgoing packets.
646 The valid range is
0-
1048575.
653 <title>[GENEVE] Section Options
</title>
654 <para>The
<literal>[GENEVE]
</literal> section only applies for
655 netdevs of kind
<literal>geneve
</literal>, and accepts the
656 following keys:
</para>
658 <variablelist class='network-directives'
>
660 <term><varname>Id=
</varname></term>
662 <para>Specifies the Virtual Network Identifer (VNI) to use. Ranges [
0-
16777215].
</para>
666 <term><varname>Remote=
</varname></term>
668 <para>Specifies the unicast destination IP address to use in outgoing packets.
</para>
672 <term><varname>TOS=
</varname></term>
674 <para>Specifies the TOS value to use in outgoing packets. Ranges [
1-
255].
</para>
678 <term><varname>TTL=
</varname></term>
680 <para>Specifies the TTL value to use in outgoing packets. Ranges [
1-
255].
</para>
684 <term><varname>UDPChecksum=
</varname></term>
686 <para>A boolean. When true, specifies if UDP checksum is calculated for transmitted packets over IPv4.
</para>
690 <term><varname>UDP6ZeroChecksumTx=
</varname></term>
692 <para>A boolean. When true, skip UDP checksum calculation for transmitted packets over IPv6.
</para>
696 <term><varname>UDP6ZeroChecksumRx=
</varname></term>
698 <para>A boolean. When true, allows incoming UDP packets over IPv6 with zero checksum field.
</para>
702 <term><varname>DestinationPort=
</varname></term>
704 <para>Specifies destination port. Defaults to
6081. If not set or assigned the empty string, the default
705 port of
6081 is used.
</para>
709 <term><varname>FlowLabel=
</varname></term>
711 <para>Specifies the flow label to use in outgoing packets.
</para>
717 <title>[Tunnel] Section Options
</title>
719 <para>The
<literal>[Tunnel]
</literal> section only applies for
721 <literal>ipip
</literal>,
722 <literal>sit
</literal>,
723 <literal>gre
</literal>,
724 <literal>gretap
</literal>,
725 <literal>ip6gre
</literal>,
726 <literal>ip6gretap
</literal>,
727 <literal>vti
</literal>,
728 <literal>vti6
</literal>, and
729 <literal>ip6tnl
</literal> and accepts
730 the following keys:
</para>
732 <variablelist class='network-directives'
>
734 <term><varname>Local=
</varname></term>
736 <para>A static local address for tunneled packets. It must
737 be an address on another interface of this host.
</para>
741 <term><varname>Remote=
</varname></term>
743 <para>The remote endpoint of the tunnel.
</para>
747 <term><varname>TOS=
</varname></term>
749 <para>The Type Of Service byte value for a tunnel interface.
750 For details about the TOS, see the
751 <ulink url=
"http://tools.ietf.org/html/rfc1349"> Type of
752 Service in the Internet Protocol Suite
</ulink> document.
757 <term><varname>TTL=
</varname></term>
759 <para>A fixed Time To Live N on tunneled packets. N is a
760 number in the range
1–
255.
0 is a special value meaning that
761 packets inherit the TTL value. The default value for IPv4
762 tunnels is: inherit. The default value for IPv6 tunnels is
767 <term><varname>DiscoverPathMTU=
</varname></term>
769 <para>A boolean. When true, enables Path MTU Discovery on
774 <term><varname>IPv6FlowLabel=
</varname></term>
776 <para>Configures the
20-bit flow label (see
<ulink url=
"https://tools.ietf.org/html/rfc6437">
777 RFC
6437</ulink>) field in the IPv6 header (see
<ulink url=
"https://tools.ietf.org/html/rfc2460">
778 RFC
2460</ulink>), which is used by a node to label packets of a flow.
779 It is only used for IPv6 tunnels.
780 A flow label of zero is used to indicate packets that have
782 It can be configured to a value in the range
0–
0xFFFFF, or be
783 set to
<literal>inherit
</literal>, in which case the original flowlabel is used.
</para>
787 <term><varname>CopyDSCP=
</varname></term>
789 <para>A boolean. When true, the Differentiated Service Code
790 Point (DSCP) field will be copied to the inner header from
791 outer header during the decapsulation of an IPv6 tunnel
792 packet. DSCP is a field in an IP packet that enables different
793 levels of service to be assigned to network traffic.
794 Defaults to
<literal>no
</literal>.
799 <term><varname>EncapsulationLimit=
</varname></term>
801 <para>The Tunnel Encapsulation Limit option specifies how many additional
802 levels of encapsulation are permitted to be prepended to the packet.
803 For example, a Tunnel Encapsulation Limit option containing a limit
804 value of zero means that a packet carrying that option may not enter
805 another tunnel before exiting the current tunnel.
806 (see
<ulink url=
"https://tools.ietf.org/html/rfc2473#section-4.1.1"> RFC
2473</ulink>).
807 The valid range is
0–
255 and
<literal>none
</literal>. Defaults to
4.
812 <term><varname>Key=
</varname></term>
814 <para>The
<varname>Key=
</varname> parameter specifies the same key to use in
815 both directions (
<varname>InputKey=
</varname> and
<varname>OutputKey=
</varname>).
816 The
<varname>Key=
</varname> is either a number or an IPv4 address-like dotted quad.
817 It is used as mark-configured SAD/SPD entry as part of the lookup key (both in data
818 and control path) in ip xfrm (framework used to implement IPsec protocol).
819 See
<ulink url=
"http://man7.org/linux/man-pages/man8/ip-xfrm.8.html">
820 ip-xfrm — transform configuration
</ulink> for details. It is only used for VTI/VTI6
825 <term><varname>InputKey=
</varname></term>
827 <para>The
<varname>InputKey=
</varname> parameter specifies the key to use for input.
828 The format is same as
<varname>Key=
</varname>. It is only used for VTI/VTI6 tunnels.
</para>
832 <term><varname>OutputKey=
</varname></term>
834 <para>The
<varname>OutputKey=
</varname> parameter specifies the key to use for output.
835 The format is same as
<varname>Key=
</varname>. It is only used for VTI/VTI6 tunnels.
</para>
839 <term><varname>Mode=
</varname></term>
841 <para>An
<literal>ip6tnl
</literal> tunnel can be in one of three
843 <literal>ip6ip6
</literal> for IPv6 over IPv6,
844 <literal>ipip6
</literal> for IPv4 over IPv6 or
845 <literal>any
</literal> for either.
852 <title>[Peer] Section Options
</title>
854 <para>The
<literal>[Peer]
</literal> section only applies for
855 netdevs of kind
<literal>veth
</literal> and accepts the
856 following keys:
</para>
858 <variablelist class='network-directives'
>
860 <term><varname>Name=
</varname></term>
862 <para>The interface name used when creating the netdev.
863 This option is compulsory.
</para>
867 <term><varname>MACAddress=
</varname></term>
869 <para>The peer MACAddress, if not set, it is generated in
870 the same way as the MAC address of the main
877 <title>[Tun] Section Options
</title>
879 <para>The
<literal>[Tun]
</literal> section only applies for
880 netdevs of kind
<literal>tun
</literal>, and accepts the following
883 <variablelist class='network-directives'
>
885 <term><varname>OneQueue=
</varname></term>
886 <listitem><para>Takes a boolean argument. Configures whether
887 all packets are queued at the device (enabled), or a fixed
888 number of packets are queued at the device and the rest at the
889 <literal>qdisc
</literal>. Defaults to
890 <literal>no
</literal>.
</para>
894 <term><varname>MultiQueue=
</varname></term>
895 <listitem><para>Takes a boolean argument. Configures whether
896 to use multiple file descriptors (queues) to parallelize
897 packets sending and receiving. Defaults to
898 <literal>no
</literal>.
</para>
902 <term><varname>PacketInfo=
</varname></term>
903 <listitem><para>Takes a boolean argument. Configures whether
904 packets should be prepended with four extra bytes (two flag
905 bytes and two protocol bytes). If disabled, it indicates that
906 the packets will be pure IP packets. Defaults to
907 <literal>no
</literal>.
</para>
911 <term><varname>VNetHeader=
</varname></term>
912 <listitem><para>Takes a boolean argument. Configures
913 IFF_VNET_HDR flag for a tap device. It allows sending
914 and receiving larger Generic Segmentation Offload (GSO)
915 packets. This may increase throughput significantly.
917 <literal>no
</literal>.
</para>
921 <term><varname>User=
</varname></term>
922 <listitem><para>User to grant access to the
923 <filename>/dev/net/tun
</filename> device.
</para>
927 <term><varname>Group=
</varname></term>
928 <listitem><para>Group to grant access to the
929 <filename>/dev/net/tun
</filename> device.
</para>
938 <title>[Tap] Section Options
</title>
940 <para>The
<literal>[Tap]
</literal> section only applies for
941 netdevs of kind
<literal>tap
</literal>, and accepts the same keys
942 as the
<literal>[Tun]
</literal> section.
</para>
946 <title>[Bond] Section Options
</title>
948 <para>The
<literal>[Bond]
</literal> section accepts the following
951 <variablelist class='network-directives'
>
953 <term><varname>Mode=
</varname></term>
955 <para>Specifies one of the bonding policies. The default is
956 <literal>balance-rr
</literal> (round robin). Possible values are
957 <literal>balance-rr
</literal>,
958 <literal>active-backup
</literal>,
959 <literal>balance-xor
</literal>,
960 <literal>broadcast
</literal>,
961 <literal>802.3ad
</literal>,
962 <literal>balance-tlb
</literal>, and
963 <literal>balance-alb
</literal>.
969 <term><varname>TransmitHashPolicy=
</varname></term>
971 <para>Selects the transmit hash policy to use for slave
972 selection in balance-xor,
802.3ad, and tlb modes. Possible
974 <literal>layer2
</literal>,
975 <literal>layer3+
4</literal>,
976 <literal>layer2+
3</literal>,
977 <literal>encap2+
3</literal>, and
978 <literal>encap3+
4</literal>.
984 <term><varname>LACPTransmitRate=
</varname></term>
986 <para>Specifies the rate with which link partner transmits
987 Link Aggregation Control Protocol Data Unit packets in
988 802.3ad mode. Possible values are
<literal>slow
</literal>,
989 which requests partner to transmit LACPDUs every
30 seconds,
990 and
<literal>fast
</literal>, which requests partner to
991 transmit LACPDUs every second. The default value is
992 <literal>slow
</literal>.
</para>
997 <term><varname>MIIMonitorSec=
</varname></term>
999 <para>Specifies the frequency that Media Independent
1000 Interface link monitoring will occur. A value of zero
1001 disables MII link monitoring. This value is rounded down to
1002 the nearest millisecond. The default value is
0.
</para>
1007 <term><varname>UpDelaySec=
</varname></term>
1009 <para>Specifies the delay before a link is enabled after a
1010 link up status has been detected. This value is rounded down
1011 to a multiple of MIIMonitorSec. The default value is
1017 <term><varname>DownDelaySec=
</varname></term>
1019 <para>Specifies the delay before a link is disabled after a
1020 link down status has been detected. This value is rounded
1021 down to a multiple of MIIMonitorSec. The default value is
1027 <term><varname>LearnPacketIntervalSec=
</varname></term>
1029 <para>Specifies the number of seconds between instances where the bonding
1030 driver sends learning packets to each slave peer switch.
1031 The valid range is
1–
0x7fffffff; the default value is
1. This option
1032 has an effect only for the balance-tlb and balance-alb modes.
</para>
1037 <term><varname>AdSelect=
</varname></term>
1039 <para>Specifies the
802.3ad aggregation selection logic to use. Possible values are
1040 <literal>stable
</literal>,
1041 <literal>bandwidth
</literal> and
1042 <literal>count
</literal>.
1048 <term><varname>FailOverMACPolicy=
</varname></term>
1050 <para>Specifies whether the active-backup mode should set all slaves to
1051 the same MAC address at the time of enslavement or, when enabled, to perform special handling of the
1052 bond's MAC address in accordance with the selected policy. The default policy is none.
1054 <literal>none
</literal>,
1055 <literal>active
</literal> and
1056 <literal>follow
</literal>.
1062 <term><varname>ARPValidate=
</varname></term>
1064 <para>Specifies whether or not ARP probes and replies should be
1065 validated in any mode that supports ARP monitoring, or whether
1066 non-ARP traffic should be filtered (disregarded) for link
1067 monitoring purposes. Possible values are
1068 <literal>none
</literal>,
1069 <literal>active
</literal>,
1070 <literal>backup
</literal> and
1071 <literal>all
</literal>.
1077 <term><varname>ARPIntervalSec=
</varname></term>
1079 <para>Specifies the ARP link monitoring frequency in milliseconds.
1080 A value of
0 disables ARP monitoring. The default value is
0.
1086 <term><varname>ARPIPTargets=
</varname></term>
1088 <para>Specifies the IP addresses to use as ARP monitoring peers when
1089 ARPIntervalSec is greater than
0. These are the targets of the ARP request
1090 sent to determine the health of the link to the targets.
1091 Specify these values in IPv4 dotted decimal format. At least one IP
1092 address must be given for ARP monitoring to function. The
1093 maximum number of targets that can be specified is
16. The
1094 default value is no IP addresses.
1100 <term><varname>ARPAllTargets=
</varname></term>
1102 <para>Specifies the quantity of ARPIPTargets that must be reachable
1103 in order for the ARP monitor to consider a slave as being up.
1104 This option affects only active-backup mode for slaves with
1105 ARPValidate enabled. Possible values are
1106 <literal>any
</literal> and
1107 <literal>all
</literal>.
1113 <term><varname>PrimaryReselectPolicy=
</varname></term>
1115 <para>Specifies the reselection policy for the primary slave. This
1116 affects how the primary slave is chosen to become the active slave
1117 when failure of the active slave or recovery of the primary slave
1118 occurs. This option is designed to prevent flip-flopping between
1119 the primary slave and other slaves. Possible values are
1120 <literal>always
</literal>,
1121 <literal>better
</literal> and
1122 <literal>failure
</literal>.
1128 <term><varname>ResendIGMP=
</varname></term>
1130 <para>Specifies the number of IGMP membership reports to be issued after
1131 a failover event. One membership report is issued immediately after
1132 the failover, subsequent packets are sent in each
200ms interval.
1133 The valid range is
0–
255. Defaults to
1. A value of
0
1134 prevents the IGMP membership report from being issued in response
1135 to the failover event.
1141 <term><varname>PacketsPerSlave=
</varname></term>
1143 <para>Specify the number of packets to transmit through a slave before
1144 moving to the next one. When set to
0, then a slave is chosen at
1145 random. The valid range is
0–
65535. Defaults to
1. This option
1146 only has effect when in balance-rr mode.
1152 <term><varname>GratuitousARP=
</varname></term>
1154 <para>Specify the number of peer notifications (gratuitous ARPs and
1155 unsolicited IPv6 Neighbor Advertisements) to be issued after a
1156 failover event. As soon as the link is up on the new slave,
1157 a peer notification is sent on the bonding device and each
1158 VLAN sub-device. This is repeated at each link monitor interval
1159 (ARPIntervalSec or MIIMonitorSec, whichever is active) if the number is
1160 greater than
1. The valid range is
0–
255. The default value is
1.
1161 These options affect only the active-backup mode.
1167 <term><varname>AllSlavesActive=
</varname></term>
1169 <para>A boolean. Specifies that duplicate frames (received on inactive ports)
1170 should be dropped when false, or delivered when true. Normally, bonding will drop
1171 duplicate frames (received on inactive ports), which is desirable for
1172 most users. But there are some times it is nice to allow duplicate
1173 frames to be delivered. The default value is false (drop duplicate frames
1174 received on inactive ports).
1180 <term><varname>MinLinks=
</varname></term>
1182 <para>Specifies the minimum number of links that must be active before
1183 asserting carrier. The default value is
0.
1189 <term><varname>ActiveSlave=
</varname></term>
1191 <para>A boolean. Specifies the new active slave. The
<literal>ActiveSlave=
</literal>
1192 option is only valid for following modes:
1193 <literal>active-backup
</literal>,
1194 <literal>balance-alb
</literal> and
1195 <literal>balance-tlb
</literal>. Defaults to false.
1201 <term><varname>PrimarySlave=
</varname></term>
1203 <para>A boolean. Specifies which slave is the primary device. The specified
1204 device will always be the active slave while it is available. Only when the
1205 primary is off-line will alternate devices be used. This is useful when
1206 one slave is preferred over another, e.g. when one slave has higher throughput
1207 than another. The
<literal>PrimarySlave=
</literal> option is only valid for
1209 <literal>active-backup
</literal>,
1210 <literal>balance-alb
</literal> and
1211 <literal>balance-tlb
</literal>. Defaults to false.
1217 <para>For more detail information see
1218 <ulink url=
"https://www.kernel.org/doc/Documentation/networking/bonding.txt">
1219 Linux Ethernet Bonding Driver HOWTO
</ulink></para>
1224 <title>Example
</title>
1226 <title>/etc/systemd/network/
25-bridge.netdev
</title>
1228 <programlisting>[NetDev]
1230 Kind=bridge
</programlisting>
1234 <title>/etc/systemd/network/
25-vlan1.netdev
</title>
1236 <programlisting>[Match]
1244 Id=
1</programlisting>
1247 <title>/etc/systemd/network/
25-ipip.netdev
</title>
1248 <programlisting>[NetDev]
1254 Local=
192.168.223.238
1255 Remote=
192.169.224.239
1256 TTL=
64</programlisting>
1259 <title>/etc/systemd/network/
25-tap.netdev
</title>
1260 <programlisting>[NetDev]
1266 PacketInfo=true
</programlisting> </example>
1269 <title>/etc/systemd/network/
25-sit.netdev
</title>
1270 <programlisting>[NetDev]
1277 Remote=
10.65.223.239</programlisting>
1281 <title>/etc/systemd/network/
25-gre.netdev
</title>
1282 <programlisting>[NetDev]
1289 Remote=
10.65.223.239</programlisting>
1293 <title>/etc/systemd/network/
25-vti.netdev
</title>
1295 <programlisting>[NetDev]
1302 Remote=
10.65.223.239</programlisting>
1306 <title>/etc/systemd/network/
25-veth.netdev
</title>
1307 <programlisting>[NetDev]
1312 Name=veth-peer
</programlisting>
1316 <title>/etc/systemd/network/
25-bond.netdev
</title>
1317 <programlisting>[NetDev]
1323 TransmitHashPolicy=layer3+
4
1325 LACPTransmitRate=fast
1330 <title>/etc/systemd/network/
25-dummy.netdev
</title>
1331 <programlisting>[NetDev]
1334 MACAddress=
12:
34:
56:
78:
9a:bc
</programlisting>
1337 <title>/etc/systemd/network/
25-vrf.netdev
</title>
1338 <para>Create a VRF interface with table
42.
</para>
1339 <programlisting>[NetDev]
1344 TableId=
42</programlisting>
1348 <title>/etc/systemd/network/
25-macvtap.netdev
</title>
1349 <para>Create a MacVTap device.
</para>
1350 <programlisting>[NetDev]
1357 <title>See Also
</title>
1359 <citerefentry><refentrytitle>systemd
</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
1360 <citerefentry><refentrytitle>systemd-networkd
</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
1361 <citerefentry><refentrytitle>systemd.link
</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
1362 <citerefentry><refentrytitle>systemd.network
</refentrytitle><manvolnum>5</manvolnum></citerefentry>