1 <?xml version='
1.0'
?> <!--*-nxml-*-->
2 <!DOCTYPE refentry PUBLIC
"-//OASIS//DTD DocBook XML V4.5//EN"
3 "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
4 <!-- SPDX-License-Identifier: LGPL-2.1+ -->
6 <refentry id=
"systemd.netdev" conditional='ENABLE_NETWORKD'
>
9 <title>systemd.network
</title>
10 <productname>systemd
</productname>
14 <refentrytitle>systemd.netdev
</refentrytitle>
15 <manvolnum>5</manvolnum>
19 <refname>systemd.netdev
</refname>
20 <refpurpose>Virtual Network Device configuration
</refpurpose>
24 <para><filename><replaceable>netdev
</replaceable>.netdev
</filename></para>
28 <title>Description
</title>
30 <para>Network setup is performed by
31 <citerefentry><refentrytitle>systemd-networkd
</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
34 <para>The main Virtual Network Device file must have the extension
<filename>.netdev
</filename>;
35 other extensions are ignored. Virtual network devices are created as soon as networkd is
36 started. If a netdev with the specified name already exists, networkd will use that as-is rather
37 than create its own. Note that the settings of the pre-existing netdev will not be changed by
40 <para>The
<filename>.netdev
</filename> files are read from the files located in the system
41 network directory
<filename>/usr/lib/systemd/network
</filename>, the volatile runtime network
42 directory
<filename>/run/systemd/network
</filename> and the local administration network
43 directory
<filename>/etc/systemd/network
</filename>. All configuration files are collectively
44 sorted and processed in lexical order, regardless of the directories in which they live.
45 However, files with identical filenames replace each other. Files in
<filename>/etc
</filename>
46 have the highest priority, files in
<filename>/run
</filename> take precedence over files with
47 the same name in
<filename>/usr/lib
</filename>. This can be used to override a system-supplied
48 configuration file with a local file if needed. As a special case, an empty file (file size
0)
49 or symlink with the same name pointing to
<filename>/dev/null
</filename> disables the
50 configuration file entirely (it is
"masked").
</para>
52 <para>Along with the netdev file
<filename>foo.netdev
</filename>, a
"drop-in" directory
53 <filename>foo.netdev.d/
</filename> may exist. All files with the suffix
<literal>.conf
</literal>
54 from this directory will be parsed after the file itself is parsed. This is useful to alter or
55 add configuration settings, without having to modify the main configuration file. Each drop-in
56 file must have appropriate section headers.
</para>
58 <para>In addition to
<filename>/etc/systemd/network
</filename>, drop-in
<literal>.d
</literal>
59 directories can be placed in
<filename>/usr/lib/systemd/network
</filename> or
60 <filename>/run/systemd/network
</filename> directories. Drop-in files in
61 <filename>/etc
</filename> take precedence over those in
<filename>/run
</filename> which in turn
62 take precedence over those in
<filename>/usr/lib
</filename>. Drop-in files under any of these
63 directories take precedence over the main netdev file wherever located. (Of course, since
64 <filename>/run
</filename> is temporary and
<filename>/usr/lib
</filename> is for vendors, it is
65 unlikely drop-ins should be used in either of those places.)
</para>
69 <title>Supported netdev kinds
</title>
71 <para>The following kinds of virtual network devices may be
72 configured in
<filename>.netdev
</filename> files:
</para>
75 <title>Supported kinds of virtual network devices
</title>
78 <colspec colname='kind'
/>
79 <colspec colname='explanation'
/>
82 <entry>Description
</entry>
85 <row><entry><varname>bond
</varname></entry>
86 <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>
88 <row><entry><varname>bridge
</varname></entry>
89 <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>
91 <row><entry><varname>dummy
</varname></entry>
92 <entry>A dummy device drops all packets sent to it.
</entry></row>
94 <row><entry><varname>gre
</varname></entry>
95 <entry>A Level
3 GRE tunnel over IPv4. See
<ulink url=
"https://tools.ietf.org/html/rfc2784">RFC
2784</ulink> for details.
</entry></row>
97 <row><entry><varname>gretap
</varname></entry>
98 <entry>A Level
2 GRE tunnel over IPv4.
</entry></row>
100 <row><entry><varname>erspan
</varname></entry>
101 <entry>ERSPAN mirrors traffic on one or more source ports and delivers the mirrored traffic to one or more destination ports on another switch.
102 The traffic is encapsulated in generic routing encapsulation (GRE) and is therefore routable across a layer
3 network between the source switch
103 and the destination switch.
</entry></row>
105 <row><entry><varname>ip6gre
</varname></entry>
106 <entry>A Level
3 GRE tunnel over IPv6.
</entry></row>
108 <row><entry><varname>ip6tnl
</varname></entry>
109 <entry>An IPv4 or IPv6 tunnel over IPv6
</entry></row>
111 <row><entry><varname>ip6gretap
</varname></entry>
112 <entry>A Level
2 GRE tunnel over IPv6.
</entry></row>
114 <row><entry><varname>ipip
</varname></entry>
115 <entry>An IPv4 over IPv4 tunnel.
</entry></row>
117 <row><entry><varname>ipvlan
</varname></entry>
118 <entry>An ipvlan device is a stacked device which receives packets from its underlying device based on IP address filtering.
</entry></row>
120 <row><entry><varname>macvlan
</varname></entry>
121 <entry>A macvlan device is a stacked device which receives packets from its underlying device based on MAC address filtering.
</entry></row>
123 <row><entry><varname>macvtap
</varname></entry>
124 <entry>A macvtap device is a stacked device which receives packets from its underlying device based on MAC address filtering.
</entry></row>
126 <row><entry><varname>sit
</varname></entry>
127 <entry>An IPv6 over IPv4 tunnel.
</entry></row>
129 <row><entry><varname>tap
</varname></entry>
130 <entry>A persistent Level
2 tunnel between a network device and a device node.
</entry></row>
132 <row><entry><varname>tun
</varname></entry>
133 <entry>A persistent Level
3 tunnel between a network device and a device node.
</entry></row>
135 <row><entry><varname>veth
</varname></entry>
136 <entry>An Ethernet tunnel between a pair of network devices.
</entry></row>
138 <row><entry><varname>vlan
</varname></entry>
139 <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>
141 <row><entry><varname>vti
</varname></entry>
142 <entry>An IPv4 over IPSec tunnel.
</entry></row>
144 <row><entry><varname>vti6
</varname></entry>
145 <entry>An IPv6 over IPSec tunnel.
</entry></row>
147 <row><entry><varname>vxlan
</varname></entry>
148 <entry>A virtual extensible LAN (vxlan), for connecting Cloud computing deployments.
</entry></row>
150 <row><entry><varname>geneve
</varname></entry>
151 <entry>A GEneric NEtwork Virtualization Encapsulation (GENEVE) netdev driver.
</entry></row>
153 <row><entry><varname>l2tp
</varname></entry>
154 <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>
156 <row><entry><varname>vrf
</varname></entry>
157 <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>
159 <row><entry><varname>vcan
</varname></entry>
160 <entry>The virtual CAN driver (vcan). Similar to the network loopback devices, vcan offers a virtual local CAN interface.
</entry></row>
162 <row><entry><varname>vxcan
</varname></entry>
163 <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.
166 <row><entry><varname>wireguard
</varname></entry>
167 <entry>WireGuard Secure Network Tunnel.
</entry></row>
169 <row><entry><varname>netdevsim
</varname></entry>
170 <entry> A simulator. This simulated networking device is used for testing various networking APIs and at this time is particularly focused on testing hardware offloading related interfaces.
</entry></row>
172 <row><entry><varname>fou
</varname></entry>
173 <entry>Foo-over-UDP tunneling.
</entry></row>
182 <title>[Match] Section Options
</title>
184 <para>A virtual network device is only created if the
185 <literal>[Match]
</literal> section matches the current
186 environment, or if the section is empty. The following keys are
189 <variablelist class='network-directives'
>
191 <term><varname>Host=
</varname></term>
193 <para>Matches against the hostname or machine ID of the host. See
194 <literal>ConditionHost=
</literal> in
195 <citerefentry><refentrytitle>systemd.unit
</refentrytitle><manvolnum>5</manvolnum></citerefentry>
196 for details. When prefixed with an exclamation mark (
<literal>!
</literal>), the result is negated.
197 If an empty string is assigned, then previously assigned value is cleared.
202 <term><varname>Virtualization=
</varname></term>
204 <para>Checks whether the system is executed in a virtualized environment and optionally test
205 whether it is a specific implementation. See
<literal>ConditionVirtualization=
</literal> in
206 <citerefentry><refentrytitle>systemd.unit
</refentrytitle><manvolnum>5</manvolnum></citerefentry>
207 for details. When prefixed with an exclamation mark (
<literal>!
</literal>), the result is negated.
208 If an empty string is assigned, then previously assigned value is cleared.
213 <term><varname>KernelCommandLine=
</varname></term>
215 <para>Checks whether a specific kernel command line option is set. See
216 <literal>ConditionKernelCommandLine=
</literal> in
217 <citerefentry><refentrytitle>systemd.unit
</refentrytitle><manvolnum>5</manvolnum></citerefentry>
218 for details. When prefixed with an exclamation mark (
<literal>!
</literal>), the result is negated.
219 If an empty string is assigned, then previously assigned value is cleared.
224 <term><varname>KernelVersion=
</varname></term>
226 <para>Checks whether the kernel version (as reported by
<command>uname -r
</command>) matches a
227 certain expression. See
<literal>ConditionKernelVersion=
</literal> in
228 <citerefentry><refentrytitle>systemd.unit
</refentrytitle><manvolnum>5</manvolnum></citerefentry>
229 for details. When prefixed with an exclamation mark (
<literal>!
</literal>), the result is negated.
230 If an empty string is assigned, then previously assigned value is cleared.
235 <term><varname>Architecture=
</varname></term>
237 <para>Checks whether the system is running on a specific architecture. See
238 <literal>ConditionArchitecture=
</literal> in
239 <citerefentry><refentrytitle>systemd.unit
</refentrytitle><manvolnum>5</manvolnum></citerefentry>
240 for details. When prefixed with an exclamation mark (
<literal>!
</literal>), the result is negated.
241 If an empty string is assigned, then previously assigned value is cleared.
250 <title>[NetDev] Section Options
</title>
252 <para>The
<literal>[NetDev]
</literal> section accepts the
253 following keys:
</para>
255 <variablelist class='network-directives'
>
257 <term><varname>Description=
</varname></term>
259 <para>A free-form description of the netdev.
</para>
263 <term><varname>Name=
</varname></term>
265 <para>The interface name used when creating the netdev.
266 This option is compulsory.
</para>
270 <term><varname>Kind=
</varname></term>
272 <para>The netdev kind. This option is compulsory. See the
273 <literal>Supported netdev kinds
</literal> section for the
278 <term><varname>MTUBytes=
</varname></term>
280 <para>The maximum transmission unit in bytes to set for the device. The usual suffixes K, M, G,
281 are supported and are understood to the base of
1024. For
<literal>tun
</literal> or
282 <literal>tap
</literal> devices,
<varname>MTUBytes=
</varname> setting is not currently supported in
283 <literal>[NetDev]
</literal> section. Please specify it in
<literal>[Link]
</literal> section of
285 <citerefentry><refentrytitle>systemd.network
</refentrytitle><manvolnum>5</manvolnum></citerefentry>
290 <term><varname>MACAddress=
</varname></term>
292 <para>The MAC address to use for the device. For
<literal>tun
</literal> or
<literal>tap
</literal>
293 devices, setting
<varname>MACAddress=
</varname> in the
<literal>[NetDev]
</literal> section is not
294 supported. Please specify it in
<literal>[Link]
</literal> section of the corresponding
295 <citerefentry><refentrytitle>systemd.network
</refentrytitle><manvolnum>5</manvolnum></citerefentry>
296 file. If this option is not set,
<literal>vlan
</literal> devices inherit the MAC address of the
297 physical interface. For other kind of netdevs, if this option is not set, then MAC address is
298 generated based on the interface name and the
299 <citerefentry><refentrytitle>machine-id
</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
307 <title>[Bridge] Section Options
</title>
309 <para>The
<literal>[Bridge]
</literal> section only applies for
310 netdevs of kind
<literal>bridge
</literal>, and accepts the
311 following keys:
</para>
313 <variablelist class='network-directives'
>
315 <term><varname>HelloTimeSec=
</varname></term>
317 <para>HelloTimeSec specifies the number of seconds between two hello packets
318 sent out by the root bridge and the designated bridges. Hello packets are
319 used to communicate information about the topology throughout the entire
320 bridged local area network.
</para>
324 <term><varname>MaxAgeSec=
</varname></term>
326 <para>MaxAgeSec specifies the number of seconds of maximum message age.
327 If the last seen (received) hello packet is more than this number of
328 seconds old, the bridge in question will start the takeover procedure
329 in attempt to become the Root Bridge itself.
</para>
333 <term><varname>ForwardDelaySec=
</varname></term>
335 <para>ForwardDelaySec specifies the number of seconds spent in each
336 of the Listening and Learning states before the Forwarding state is entered.
</para>
340 <term><varname>AgeingTimeSec=
</varname></term>
342 <para>This specifies the number of seconds a MAC Address will be kept in
343 the forwarding database after having a packet received from this MAC Address.
</para>
347 <term><varname>Priority=
</varname></term>
349 <para>The priority of the bridge. An integer between
0 and
65535. A lower value
350 means higher priority. The bridge having the lowest priority will be elected as root bridge.
</para>
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>
364 <term><varname>DefaultPVID=
</varname></term>
366 <para>This specifies the default port VLAN ID of a newly attached bridge port.
367 Set this to an integer in the range
1–
4094 or
<literal>none
</literal> to disable the PVID.
</para>
371 <term><varname>MulticastQuerier=
</varname></term>
373 <para>Takes a boolean. This setting controls the IFLA_BR_MCAST_QUERIER option in the kernel.
374 If enabled, the kernel will send general ICMP queries from a zero source address.
375 This feature should allow faster convergence on startup, but it causes some
376 multicast-aware switches to misbehave and disrupt forwarding of multicast packets.
377 When unset, the kernel's default will be used.
382 <term><varname>MulticastSnooping=
</varname></term>
384 <para>Takes a boolean. This setting controls the IFLA_BR_MCAST_SNOOPING option in the kernel.
385 If enabled, IGMP snooping monitors the Internet Group Management Protocol (IGMP) traffic
386 between hosts and multicast routers. When unset, the kernel's default will be used.
391 <term><varname>VLANFiltering=
</varname></term>
393 <para>Takes a boolean. This setting controls the IFLA_BR_VLAN_FILTERING option in the kernel.
394 If enabled, the bridge will be started in VLAN-filtering mode. When unset, the kernel's default will be used.
399 <term><varname>STP=
</varname></term>
401 <para>Takes a boolean. This enables the bridge's Spanning Tree Protocol (STP).
402 When unset, the kernel's default will be used.
410 <title>[VLAN] Section Options
</title>
412 <para>The
<literal>[VLAN]
</literal> section only applies for
413 netdevs of kind
<literal>vlan
</literal>, and accepts the
414 following key:
</para>
416 <variablelist class='network-directives'
>
418 <term><varname>Id=
</varname></term>
420 <para>The VLAN ID to use. An integer in the range
0–
4094.
421 This option is compulsory.
</para>
425 <term><varname>GVRP=
</varname></term>
427 <para>Takes a boolean. The Generic VLAN Registration Protocol (GVRP) is a protocol that
428 allows automatic learning of VLANs on a network.
429 When unset, the kernel's default will be used.
434 <term><varname>MVRP=
</varname></term>
436 <para>Takes a boolean. Multiple VLAN Registration Protocol (MVRP) formerly known as GARP VLAN
437 Registration Protocol (GVRP) is a standards-based Layer
2 network protocol,
438 for automatic configuration of VLAN information on switches. It was defined
439 in the
802.1ak amendment to
802.1Q-
2005. When unset, the kernel's default will be used.
444 <term><varname>LooseBinding=
</varname></term>
446 <para>Takes a boolean. The VLAN loose binding mode, in which only the operational state is passed
447 from the parent to the associated VLANs, but the VLAN device state is not changed.
448 When unset, the kernel's default will be used.
</para>
452 <term><varname>ReorderHeader=
</varname></term>
454 <para>Takes a boolean. The VLAN reorder header is set VLAN interfaces behave like physical interfaces.
455 When unset, the kernel's default will be used.
</para>
462 <title>[MACVLAN] Section Options
</title>
464 <para>The
<literal>[MACVLAN]
</literal> section only applies for
465 netdevs of kind
<literal>macvlan
</literal>, and accepts the
466 following key:
</para>
468 <variablelist class='network-directives'
>
470 <term><varname>Mode=
</varname></term>
472 <para>The MACVLAN mode to use. The supported options are
473 <literal>private
</literal>,
474 <literal>vepa
</literal>,
475 <literal>bridge
</literal>, and
476 <literal>passthru
</literal>.
485 <title>[MACVTAP] Section Options
</title>
487 <para>The
<literal>[MACVTAP]
</literal> section applies for
488 netdevs of kind
<literal>macvtap
</literal> and accepts the
489 same key as
<literal>[MACVLAN]
</literal>.
</para>
494 <title>[IPVLAN] Section Options
</title>
496 <para>The
<literal>[IPVLAN]
</literal> section only applies for
497 netdevs of kind
<literal>ipvlan
</literal>, and accepts the
498 following key:
</para>
500 <variablelist class='network-directives'
>
502 <term><varname>Mode=
</varname></term>
504 <para>The IPVLAN mode to use. The supported options are
505 <literal>L2
</literal>,
<literal>L3
</literal> and
<literal>L3S
</literal>.
510 <term><varname>Flags=
</varname></term>
512 <para>The IPVLAN flags to use. The supported options are
513 <literal>bridge
</literal>,
<literal>private
</literal> and
<literal>vepa
</literal>.
522 <title>[VXLAN] Section Options
</title>
523 <para>The
<literal>[VXLAN]
</literal> section only applies for
524 netdevs of kind
<literal>vxlan
</literal>, and accepts the
525 following keys:
</para>
527 <variablelist class='network-directives'
>
529 <term><varname>Id=
</varname></term>
531 <para>The VXLAN ID to use.
</para>
535 <term><varname>Remote=
</varname></term>
537 <para>Configures destination IP address.
</para>
541 <term><varname>Local=
</varname></term>
543 <para>Configures local IP address.
</para>
547 <term><varname>TOS=
</varname></term>
549 <para>The Type Of Service byte value for a vxlan interface.
</para>
553 <term><varname>TTL=
</varname></term>
555 <para>A fixed Time To Live N on Virtual eXtensible Local
556 Area Network packets. N is a number in the range
1–
255.
0
557 is a special value meaning that packets inherit the TTL
562 <term><varname>MacLearning=
</varname></term>
564 <para>Takes a boolean. When true, enables dynamic MAC learning
565 to discover remote MAC addresses.
</para>
569 <term><varname>FDBAgeingSec=
</varname></term>
571 <para>The lifetime of Forwarding Database entry learnt by
572 the kernel, in seconds.
</para>
576 <term><varname>MaximumFDBEntries=
</varname></term>
578 <para>Configures maximum number of FDB entries.
</para>
582 <term><varname>ReduceARPProxy=
</varname></term>
584 <para>Takes a boolean. When true, bridge-connected VXLAN tunnel
585 endpoint answers ARP requests from the local bridge on behalf
586 of remote Distributed Overlay Virtual Ethernet
587 <ulink url=
"https://en.wikipedia.org/wiki/Distributed_Overlay_Virtual_Ethernet">
588 (DVOE)
</ulink> clients. Defaults to false.
</para>
592 <term><varname>L2MissNotification=
</varname></term>
594 <para>Takes a boolean. When true, enables netlink LLADDR miss
595 notifications.
</para>
599 <term><varname>L3MissNotification=
</varname></term>
601 <para>Takes a boolean. When true, enables netlink IP address miss
602 notifications.
</para>
606 <term><varname>RouteShortCircuit=
</varname></term>
608 <para>Takes a boolean. When true, route short circuiting is turned
613 <term><varname>UDPChecksum=
</varname></term>
615 <para>Takes a boolean. When true, transmitting UDP checksums when doing VXLAN/IPv4 is turned on.
</para>
619 <term><varname>UDP6ZeroChecksumTx=
</varname></term>
621 <para>Takes a boolean. When true, sending zero checksums in VXLAN/IPv6 is turned on.
</para>
625 <term><varname>UDP6ZeroChecksumRx=
</varname></term>
627 <para>Takes a boolean. When true, receiving zero checksums in VXLAN/IPv6 is turned on.
</para>
631 <term><varname>RemoteChecksumTx=
</varname></term>
633 <para>Takes a boolean. When true, remote transmit checksum offload of VXLAN is turned on.
</para>
637 <term><varname>RemoteChecksumRx=
</varname></term>
639 <para>Takes a boolean. When true, remote receive checksum offload in VXLAN is turned on.
</para>
643 <term><varname>GroupPolicyExtension=
</varname></term>
645 <para>Takes a boolean. When true, it enables Group Policy VXLAN extension security label mechanism
646 across network peers based on VXLAN. For details about the Group Policy VXLAN, see the
647 <ulink url=
"https://tools.ietf.org/html/draft-smith-vxlan-group-policy">
648 VXLAN Group Policy
</ulink> document. Defaults to false.
</para>
652 <term><varname>DestinationPort=
</varname></term>
654 <para>Configures the default destination UDP port on a per-device basis.
655 If destination port is not specified then Linux kernel default will be used.
656 Set destination port
4789 to get the IANA assigned value. If not set or if the
657 destination port is assigned the empty string the default port of
4789 is used.
</para>
661 <term><varname>PortRange=
</varname></term>
663 <para>Configures VXLAN port range. VXLAN bases source
664 UDP port based on flow to help the receiver to be able
665 to load balance based on outer header flow. It
666 restricts the port range to the normal UDP local
667 ports, and allows overriding via configuration.
</para>
671 <term><varname>FlowLabel=
</varname></term>
673 <para>Specifies the flow label to use in outgoing packets.
674 The valid range is
0-
1048575.
681 <title>[GENEVE] Section Options
</title>
682 <para>The
<literal>[GENEVE]
</literal> section only applies for
683 netdevs of kind
<literal>geneve
</literal>, and accepts the
684 following keys:
</para>
686 <variablelist class='network-directives'
>
688 <term><varname>Id=
</varname></term>
690 <para>Specifies the Virtual Network Identifier (VNI) to use. Ranges [
0-
16777215].
</para>
694 <term><varname>Remote=
</varname></term>
696 <para>Specifies the unicast destination IP address to use in outgoing packets.
</para>
700 <term><varname>TOS=
</varname></term>
702 <para>Specifies the TOS value to use in outgoing packets. Ranges [
1-
255].
</para>
706 <term><varname>TTL=
</varname></term>
708 <para>Specifies the TTL value to use in outgoing packets. Ranges [
1-
255].
</para>
712 <term><varname>UDPChecksum=
</varname></term>
714 <para>Takes a boolean. When true, specifies if UDP checksum is calculated for transmitted packets over IPv4.
</para>
718 <term><varname>UDP6ZeroChecksumTx=
</varname></term>
720 <para>Takes a boolean. When true, skip UDP checksum calculation for transmitted packets over IPv6.
</para>
724 <term><varname>UDP6ZeroChecksumRx=
</varname></term>
726 <para>Takes a boolean. When true, allows incoming UDP packets over IPv6 with zero checksum field.
</para>
730 <term><varname>DestinationPort=
</varname></term>
732 <para>Specifies destination port. Defaults to
6081. If not set or assigned the empty string, the default
733 port of
6081 is used.
</para>
737 <term><varname>FlowLabel=
</varname></term>
739 <para>Specifies the flow label to use in outgoing packets.
</para>
745 <title>[L2TP] Section Options
</title>
746 <para>The
<literal>[L2TP]
</literal> section only applies for
747 netdevs of kind
<literal>l2tp
</literal>, and accepts the
748 following keys:
</para>
750 <variablelist class='network-directives'
>
752 <term><varname>TunnelId=
</varname></term>
754 <para>Specifies the tunnel id. The value used must match the
<literal>PeerTunnelId=
</literal> value being used at the peer.
755 Ranges a number between
1 and
4294967295). This option is compulsory.
</para>
759 <term><varname>PeerTunnelId=
</varname></term>
761 <para>Specifies the peer tunnel id. The value used must match the
<literal>PeerTunnelId=
</literal> value being used at the peer.
762 Ranges a number between
1 and
4294967295). This option is compulsory.
</para>
766 <term><varname>Remote=
</varname></term>
768 <para>Specifies the IP address of the remote peer. This option is compulsory.
</para>
772 <term><varname>Local=
</varname></term>
774 <para>Specifies the IP address of the local interface. Takes an IP address, or the special values
775 <literal>auto
</literal>,
<literal>static
</literal>, or
<literal>dynamic
</literal>. When an address
776 is set, then the local interface must have the address. If
<literal>auto
</literal>, then one of the
777 addresses on the local interface is used. Similarly, if
<literal>static
</literal> or
778 <literal>dynamic
</literal> is set, then one of the static or dynamic addresses on the local
779 interface is used. Defaults to
<literal>auto
</literal>.
</para>
783 <term><varname>EncapsulationType=
</varname></term>
785 <para>Specifies the encapsulation type of the tunnel. Takes one of
<literal>udp
</literal> or
<literal>ip
</literal>.
</para>
789 <term><varname>UDPSourcePort=
</varname></term>
791 <para>Specifies the UDP source port to be used for the tunnel. When UDP encapsulation is selected it's mandotory. Ignored when ip
792 encapsulation is selected.
</para>
796 <term><varname>DestinationPort=
</varname></term>
798 <para>Specifies destination port. When UDP encapsulation is selected it's mandotory. Ignored when ip
799 encapsulation is selected.
</para>
803 <term><varname>UDPChecksum=
</varname></term>
805 <para>Takes a boolean. When true, specifies if UDP checksum is calculated for transmitted packets over IPv4.
</para>
809 <term><varname>UDP6ZeroChecksumTx=
</varname></term>
811 <para>Takes a boolean. When true, skip UDP checksum calculation for transmitted packets over IPv6.
</para>
815 <term><varname>UDP6ZeroChecksumRx=
</varname></term>
817 <para>Takes a boolean. When true, allows incoming UDP packets over IPv6 with zero checksum field.
</para>
823 <title>[L2TPSession] Section Options
</title>
824 <para>The
<literal>[L2TPSession]
</literal> section only applies for
825 netdevs of kind
<literal>l2tp
</literal>, and accepts the
826 following keys:
</para>
827 <variablelist class='network-directives'
>
829 <term><varname>Name=
</varname></term>
831 <para>Specifies the name of the sesssion. This option is compulsory.
</para>
835 <term><varname>SessionId=
</varname></term>
837 <para>Specifies the sesssion id. The value used must match the
<literal>SessionId=
</literal> value being used at the peer.
838 Ranges a number between
1 and
4294967295). This option is compulsory.
</para>
842 <term><varname>PeerSessionId=
</varname></term>
844 <para>Specifies the peer session id. The value used must match the
<literal>PeerSessionId=
</literal> value being used at the peer.
845 Ranges a number between
1 and
4294967295). This option is compulsory.
</para>
849 <term><varname>Layer2SpecificHeader=
</varname></term>
851 <para>Specifies layer2specific header type of the session. One of
<literal>none
</literal> or
<literal>default
</literal>. Defaults to
<literal>default
</literal>.
</para>
857 <title>[Tunnel] Section Options
</title>
859 <para>The
<literal>[Tunnel]
</literal> section only applies for
861 <literal>ipip
</literal>,
862 <literal>sit
</literal>,
863 <literal>gre
</literal>,
864 <literal>gretap
</literal>,
865 <literal>ip6gre
</literal>,
866 <literal>ip6gretap
</literal>,
867 <literal>vti
</literal>,
868 <literal>vti6
</literal>,
869 <literal>ip6tnl
</literal>, and
870 <literal>erspan
</literal> and accepts
871 the following keys:
</para>
873 <variablelist class='network-directives'
>
875 <term><varname>Local=
</varname></term>
877 <para>A static local address for tunneled packets. It must
878 be an address on another interface of this host.
</para>
882 <term><varname>Remote=
</varname></term>
884 <para>The remote endpoint of the tunnel.
</para>
888 <term><varname>TOS=
</varname></term>
890 <para>The Type Of Service byte value for a tunnel interface.
891 For details about the TOS, see the
892 <ulink url=
"http://tools.ietf.org/html/rfc1349"> Type of
893 Service in the Internet Protocol Suite
</ulink> document.
898 <term><varname>TTL=
</varname></term>
900 <para>A fixed Time To Live N on tunneled packets. N is a
901 number in the range
1–
255.
0 is a special value meaning that
902 packets inherit the TTL value. The default value for IPv4
903 tunnels is: inherit. The default value for IPv6 tunnels is
908 <term><varname>DiscoverPathMTU=
</varname></term>
910 <para>Takes a boolean. When true, enables Path MTU Discovery on
915 <term><varname>IPv6FlowLabel=
</varname></term>
917 <para>Configures the
20-bit flow label (see
<ulink url=
"https://tools.ietf.org/html/rfc6437">
918 RFC
6437</ulink>) field in the IPv6 header (see
<ulink url=
"https://tools.ietf.org/html/rfc2460">
919 RFC
2460</ulink>), which is used by a node to label packets of a flow.
920 It is only used for IPv6 tunnels.
921 A flow label of zero is used to indicate packets that have
923 It can be configured to a value in the range
0–
0xFFFFF, or be
924 set to
<literal>inherit
</literal>, in which case the original flowlabel is used.
</para>
928 <term><varname>CopyDSCP=
</varname></term>
930 <para>Takes a boolean. When true, the Differentiated Service Code
931 Point (DSCP) field will be copied to the inner header from
932 outer header during the decapsulation of an IPv6 tunnel
933 packet. DSCP is a field in an IP packet that enables different
934 levels of service to be assigned to network traffic.
935 Defaults to
<literal>no
</literal>.
940 <term><varname>EncapsulationLimit=
</varname></term>
942 <para>The Tunnel Encapsulation Limit option specifies how many additional
943 levels of encapsulation are permitted to be prepended to the packet.
944 For example, a Tunnel Encapsulation Limit option containing a limit
945 value of zero means that a packet carrying that option may not enter
946 another tunnel before exiting the current tunnel.
947 (see
<ulink url=
"https://tools.ietf.org/html/rfc2473#section-4.1.1"> RFC
2473</ulink>).
948 The valid range is
0–
255 and
<literal>none
</literal>. Defaults to
4.
953 <term><varname>Key=
</varname></term>
955 <para>The
<varname>Key=
</varname> parameter specifies the same key to use in
956 both directions (
<varname>InputKey=
</varname> and
<varname>OutputKey=
</varname>).
957 The
<varname>Key=
</varname> is either a number or an IPv4 address-like dotted quad.
958 It is used as mark-configured SAD/SPD entry as part of the lookup key (both in data
959 and control path) in ip xfrm (framework used to implement IPsec protocol).
960 See
<ulink url=
"http://man7.org/linux/man-pages/man8/ip-xfrm.8.html">
961 ip-xfrm — transform configuration
</ulink> for details. It is only used for VTI/VTI6
966 <term><varname>InputKey=
</varname></term>
968 <para>The
<varname>InputKey=
</varname> parameter specifies the key to use for input.
969 The format is same as
<varname>Key=
</varname>. It is only used for VTI/VTI6 tunnels.
</para>
973 <term><varname>OutputKey=
</varname></term>
975 <para>The
<varname>OutputKey=
</varname> parameter specifies the key to use for output.
976 The format is same as
<varname>Key=
</varname>. It is only used for VTI/VTI6 tunnels.
</para>
980 <term><varname>Mode=
</varname></term>
982 <para>An
<literal>ip6tnl
</literal> tunnel can be in one of three
984 <literal>ip6ip6
</literal> for IPv6 over IPv6,
985 <literal>ipip6
</literal> for IPv4 over IPv6 or
986 <literal>any
</literal> for either.
991 <term><varname>Independent=
</varname></term>
993 <para>Takes a boolean. When true tunnel does not require .network file. Created as
"tunnel@NONE".
994 Defaults to
<literal>false
</literal>.
999 <term><varname>AllowLocalRemote=
</varname></term>
1001 <para>Takes a boolean. When true allows tunnel traffic on
<varname>ip6tnl
</varname> devices where the remote endpoint is a local host address.
1002 When unset, the kernel's default will be used.
1007 <term><varname>FooOverUDP=
</varname></term>
1009 <para>Takes a boolean. Specifies whether
<varname>FooOverUDP=
</varname> tunnel is to be configured.
1010 Defaults to false. For more detail information see
1011 <ulink url=
"https://lwn.net/Articles/614348">Foo over UDP
</ulink></para>
1015 <term><varname>FOUDestinationPort=
</varname></term>
1017 <para>This setting specifies the UDP destination port for encapsulation.
1018 This field is mandatory and is not set by default.
</para>
1022 <term><varname>FOUSourcePort=
</varname></term>
1024 <para>This setting specifies the UDP source port for encapsulation. Defaults to
<constant>0</constant>
1025 — that is, the source port for packets is left to the network stack to decide.
</para>
1029 <term><varname>Encapsulation=
</varname></term>
1031 <para>Accepts the same key as
<literal>[FooOverUDP]
</literal></para>
1035 <term><varname>IPv6RapidDeploymentPrefix=
</varname></term>
1037 <para>Reconfigure the tunnel for
<ulink url=
"https://tools.ietf.org/html/rfc5569">IPv6 Rapid
1038 Deployment
</ulink>, also known as
6rd. The value is an ISP-specific IPv6 prefix with a non-zero length. Only
1039 applicable to SIT tunnels.
</para>
1043 <term><varname>ISATAP=
</varname></term>
1045 <para>Takes a boolean. If set, configures the tunnel as Intra-Site Automatic Tunnel Addressing Protocol (ISATAP) tunnel.
1046 Only applicable to SIT tunnels. When unset, the kernel's default will be used.
</para>
1050 <term><varname>SerializeTunneledPackets=
</varname></term>
1052 <para>Takes a boolean. If set to yes, then packets are serialized. Only applies for ERSPAN tunnel.
1053 When unset, the kernel's default will be used.
1058 <term><varname>ERSPANIndex=
</varname></term>
1060 <para>Specifies the ERSPAN index field for the interface, an integer in the range
1-
1048575 associated with
1061 the ERSPAN traffic's source port and direction. This field is mandatory.
1069 <title>[FooOverUDP] Section Options
</title>
1071 <para>The
<literal>[FooOverUDP]
</literal> section only applies for
1072 netdevs of kind
<literal>fou
</literal> and accepts the
1073 following keys:
</para>
1075 <variablelist class='network-directives'
>
1077 <term><varname>Protocol=
</varname></term>
1079 <para>The
<varname>Protocol=
</varname> specifies the protocol number of the
1080 packets arriving at the UDP port. This field is mandatory and is not set by default. Valid range is
1-
255.
</para>
1084 <term><varname>Encapsulation=
</varname></term>
1086 <para>Specifies the encapsulation mechanism used to store networking packets of various protocols inside the UDP packets. Supports the following values:
1088 <literal>FooOverUDP
</literal> provides the simplest no frills model of UDP encapsulation, it simply encapsulates
1089 packets directly in the UDP payload.
1090 <literal>GenericUDPEncapsulation
</literal> is a generic and extensible encapsulation, it allows encapsulation of packets for any IP
1091 protocol and optional data as part of the encapsulation.
1092 For more detailed information see
<ulink url=
"https://lwn.net/Articles/615044">Generic UDP Encapsulation
</ulink>.
1093 Defaults to
<literal>FooOverUDP
</literal>.
1098 <term><varname>Port=
</varname></term>
1100 <para>Specifies the port number, where the IP encapsulation packets will arrive. Please take note that the packets
1101 will arrive with the encapsulation will be removed. Then they will be manually fed back into the network stack, and sent ahead
1102 for delivery to the real destination. This option is mandatory.
</para>
1108 <title>[Peer] Section Options
</title>
1110 <para>The
<literal>[Peer]
</literal> section only applies for
1111 netdevs of kind
<literal>veth
</literal> and accepts the
1112 following keys:
</para>
1114 <variablelist class='network-directives'
>
1116 <term><varname>Name=
</varname></term>
1118 <para>The interface name used when creating the netdev.
1119 This option is compulsory.
</para>
1123 <term><varname>MACAddress=
</varname></term>
1125 <para>The peer MACAddress, if not set, it is generated in
1126 the same way as the MAC address of the main
1133 <title>[VXCAN] Section Options
</title>
1134 <para>The
<literal>[VXCAN]
</literal> section only applies for
1135 netdevs of kind
<literal>vxcan
</literal> and accepts the
1136 following key:
</para>
1138 <variablelist class='network-directives'
>
1140 <term><varname>Peer=
</varname></term>
1142 <para>The peer interface name used when creating the netdev.
1143 This option is compulsory.
</para>
1149 <title>[Tun] Section Options
</title>
1151 <para>The
<literal>[Tun]
</literal> section only applies for
1152 netdevs of kind
<literal>tun
</literal>, and accepts the following
1155 <variablelist class='network-directives'
>
1157 <term><varname>OneQueue=
</varname></term>
1158 <listitem><para>Takes a boolean. Configures whether
1159 all packets are queued at the device (enabled), or a fixed
1160 number of packets are queued at the device and the rest at the
1161 <literal>qdisc
</literal>. Defaults to
1162 <literal>no
</literal>.
</para>
1166 <term><varname>MultiQueue=
</varname></term>
1167 <listitem><para>Takes a boolean. Configures whether
1168 to use multiple file descriptors (queues) to parallelize
1169 packets sending and receiving. Defaults to
1170 <literal>no
</literal>.
</para>
1174 <term><varname>PacketInfo=
</varname></term>
1175 <listitem><para>Takes a boolean. Configures whether
1176 packets should be prepended with four extra bytes (two flag
1177 bytes and two protocol bytes). If disabled, it indicates that
1178 the packets will be pure IP packets. Defaults to
1179 <literal>no
</literal>.
</para>
1183 <term><varname>VNetHeader=
</varname></term>
1184 <listitem><para>Takes a boolean. Configures
1185 IFF_VNET_HDR flag for a tap device. It allows sending
1186 and receiving larger Generic Segmentation Offload (GSO)
1187 packets. This may increase throughput significantly.
1189 <literal>no
</literal>.
</para>
1193 <term><varname>User=
</varname></term>
1194 <listitem><para>User to grant access to the
1195 <filename>/dev/net/tun
</filename> device.
</para>
1199 <term><varname>Group=
</varname></term>
1200 <listitem><para>Group to grant access to the
1201 <filename>/dev/net/tun
</filename> device.
</para>
1210 <title>[Tap] Section Options
</title>
1212 <para>The
<literal>[Tap]
</literal> section only applies for
1213 netdevs of kind
<literal>tap
</literal>, and accepts the same keys
1214 as the
<literal>[Tun]
</literal> section.
</para>
1218 <title>[WireGuard] Section Options
</title>
1220 <para>The
<literal>[WireGuard]
</literal> section accepts the following
1223 <variablelist class='network-directives'
>
1225 <term><varname>PrivateKey=
</varname></term>
1227 <para>The Base64 encoded private key for the interface. It can be
1228 generated using the
<command>wg genkey
</command> command
1229 (see
<citerefentry project=
"wireguard"><refentrytitle>wg
</refentrytitle><manvolnum>8</manvolnum></citerefentry>).
1230 This option or
<varname>PrivateKeyFile=
</varname> is mandatory to use WireGuard.
1231 Note that because this information is secret, you may want to set
1232 the permissions of the .netdev file to be owned by
<literal>root:systemd-network
</literal>
1233 with a
<literal>0640</literal> file mode.
</para>
1237 <term><varname>PrivateKeyFile=
</varname></term>
1239 <para>Takes a absolute path to a file which contains the Base64 encoded private key for the interface.
1240 If both
<varname>PrivateKey=
</varname> and
<varname>PrivateKeyFile=
</varname> are specified, and if
1241 the file specified in
<varname>PrivateKeyFile=
</varname> contains valid wireguard key, then
1242 the key provided by
<varname>PrivateKey=
</varname> is ignored.
1243 Note that the file must be readable by the user
<literal>systemd-network
</literal>, so it
1244 should be, e.g., owned by
<literal>root:systemd-network
</literal> with a
1245 <literal>0640</literal> file mode.
</para>
1249 <term><varname>ListenPort=
</varname></term>
1251 <para>Sets UDP port for listening. Takes either value between
1 and
65535
1252 or
<literal>auto
</literal>. If
<literal>auto
</literal> is specified,
1253 the port is automatically generated based on interface name.
1254 Defaults to
<literal>auto
</literal>.
</para>
1258 <term><varname>FwMark=
</varname></term>
1260 <para>Sets a firewall mark on outgoing WireGuard packets from this interface.
</para>
1267 <title>[WireGuardPeer] Section Options
</title>
1269 <para>The
<literal>[WireGuardPeer]
</literal> section accepts the following
1272 <variablelist class='network-directives'
>
1274 <term><varname>PublicKey=
</varname></term>
1276 <para>Sets a Base64 encoded public key calculated by
<command>wg pubkey
</command>
1277 (see
<citerefentry project=
"wireguard"><refentrytitle>wg
</refentrytitle><manvolnum>8</manvolnum></citerefentry>)
1278 from a private key, and usually transmitted out of band to the
1279 author of the configuration file. This option is mandatory for this
1284 <term><varname>PresharedKey=
</varname></term>
1286 <para>Optional preshared key for the interface. It can be generated
1287 by the
<command>wg genpsk
</command> command. This option adds an
1288 additional layer of symmetric-key cryptography to be mixed into the
1289 already existing public-key cryptography, for post-quantum
1291 Note that because this information is secret, you may want to set
1292 the permissions of the .netdev file to be owned by
<literal>root:systemd-networkd
</literal>
1293 with a
<literal>0640</literal> file mode.
</para>
1297 <term><varname>AllowedIPs=
</varname></term>
1299 <para>Sets a comma-separated list of IP (v4 or v6) addresses with CIDR masks
1300 from which this peer is allowed to send incoming traffic and to
1301 which outgoing traffic for this peer is directed. The catch-all
1302 0.0.0.0/
0 may be specified for matching all IPv4 addresses, and
1303 ::/
0 may be specified for matching all IPv6 addresses.
</para>
1307 <term><varname>Endpoint=
</varname></term>
1309 <para>Sets an endpoint IP address or hostname, followed by a colon, and then
1310 a port number. This endpoint will be updated automatically once to
1311 the most recent source IP address and port of correctly
1312 authenticated packets from the peer at configuration time.
</para>
1316 <term><varname>PersistentKeepalive=
</varname></term>
1318 <para>Sets a seconds interval, between
1 and
65535 inclusive, of how often
1319 to send an authenticated empty packet to the peer for the purpose
1320 of keeping a stateful firewall or NAT mapping valid persistently.
1321 For example, if the interface very rarely sends traffic, but it
1322 might at anytime receive traffic from a peer, and it is behind NAT,
1323 the interface might benefit from having a persistent keepalive
1324 interval of
25 seconds. If set to
0 or
"off", this option is
1325 disabled. By default or when unspecified, this option is off.
1326 Most users will not need this.
</para>
1333 <title>[Bond] Section Options
</title>
1335 <para>The
<literal>[Bond]
</literal> section accepts the following
1338 <variablelist class='network-directives'
>
1340 <term><varname>Mode=
</varname></term>
1342 <para>Specifies one of the bonding policies. The default is
1343 <literal>balance-rr
</literal> (round robin). Possible values are
1344 <literal>balance-rr
</literal>,
1345 <literal>active-backup
</literal>,
1346 <literal>balance-xor
</literal>,
1347 <literal>broadcast
</literal>,
1348 <literal>802.3ad
</literal>,
1349 <literal>balance-tlb
</literal>, and
1350 <literal>balance-alb
</literal>.
1356 <term><varname>TransmitHashPolicy=
</varname></term>
1358 <para>Selects the transmit hash policy to use for slave
1359 selection in balance-xor,
802.3ad, and tlb modes. Possible
1361 <literal>layer2
</literal>,
1362 <literal>layer3+
4</literal>,
1363 <literal>layer2+
3</literal>,
1364 <literal>encap2+
3</literal>, and
1365 <literal>encap3+
4</literal>.
1371 <term><varname>LACPTransmitRate=
</varname></term>
1373 <para>Specifies the rate with which link partner transmits
1374 Link Aggregation Control Protocol Data Unit packets in
1375 802.3ad mode. Possible values are
<literal>slow
</literal>,
1376 which requests partner to transmit LACPDUs every
30 seconds,
1377 and
<literal>fast
</literal>, which requests partner to
1378 transmit LACPDUs every second. The default value is
1379 <literal>slow
</literal>.
</para>
1384 <term><varname>MIIMonitorSec=
</varname></term>
1386 <para>Specifies the frequency that Media Independent
1387 Interface link monitoring will occur. A value of zero
1388 disables MII link monitoring. This value is rounded down to
1389 the nearest millisecond. The default value is
0.
</para>
1394 <term><varname>UpDelaySec=
</varname></term>
1396 <para>Specifies the delay before a link is enabled after a
1397 link up status has been detected. This value is rounded down
1398 to a multiple of MIIMonitorSec. The default value is
1404 <term><varname>DownDelaySec=
</varname></term>
1406 <para>Specifies the delay before a link is disabled after a
1407 link down status has been detected. This value is rounded
1408 down to a multiple of MIIMonitorSec. The default value is
1414 <term><varname>LearnPacketIntervalSec=
</varname></term>
1416 <para>Specifies the number of seconds between instances where the bonding
1417 driver sends learning packets to each slave peer switch.
1418 The valid range is
1–
0x7fffffff; the default value is
1. This option
1419 has an effect only for the balance-tlb and balance-alb modes.
</para>
1424 <term><varname>AdSelect=
</varname></term>
1426 <para>Specifies the
802.3ad aggregation selection logic to use. Possible values are
1427 <literal>stable
</literal>,
1428 <literal>bandwidth
</literal> and
1429 <literal>count
</literal>.
1435 <term><varname>AdActorSystemPriority=
</varname></term>
1437 <para>Specifies the
802.3ad actor system priority. Ranges [
1-
65535].
</para>
1442 <term><varname>AdUserPortKey=
</varname></term>
1444 <para>Specifies the
802.3ad user defined portion of the port key. Ranges [
0-
1023].
</para>
1449 <term><varname>AdActorSystem=
</varname></term>
1451 <para>Specifies the
802.3ad system mac address. This can not be either NULL or Multicast.
</para>
1456 <term><varname>FailOverMACPolicy=
</varname></term>
1458 <para>Specifies whether the active-backup mode should set all slaves to
1459 the same MAC address at the time of enslavement or, when enabled, to perform special handling of the
1460 bond's MAC address in accordance with the selected policy. The default policy is none.
1462 <literal>none
</literal>,
1463 <literal>active
</literal> and
1464 <literal>follow
</literal>.
1470 <term><varname>ARPValidate=
</varname></term>
1472 <para>Specifies whether or not ARP probes and replies should be
1473 validated in any mode that supports ARP monitoring, or whether
1474 non-ARP traffic should be filtered (disregarded) for link
1475 monitoring purposes. Possible values are
1476 <literal>none
</literal>,
1477 <literal>active
</literal>,
1478 <literal>backup
</literal> and
1479 <literal>all
</literal>.
1485 <term><varname>ARPIntervalSec=
</varname></term>
1487 <para>Specifies the ARP link monitoring frequency in milliseconds.
1488 A value of
0 disables ARP monitoring. The default value is
0.
1494 <term><varname>ARPIPTargets=
</varname></term>
1496 <para>Specifies the IP addresses to use as ARP monitoring peers when
1497 ARPIntervalSec is greater than
0. These are the targets of the ARP request
1498 sent to determine the health of the link to the targets.
1499 Specify these values in IPv4 dotted decimal format. At least one IP
1500 address must be given for ARP monitoring to function. The
1501 maximum number of targets that can be specified is
16. The
1502 default value is no IP addresses.
1508 <term><varname>ARPAllTargets=
</varname></term>
1510 <para>Specifies the quantity of ARPIPTargets that must be reachable
1511 in order for the ARP monitor to consider a slave as being up.
1512 This option affects only active-backup mode for slaves with
1513 ARPValidate enabled. Possible values are
1514 <literal>any
</literal> and
1515 <literal>all
</literal>.
1521 <term><varname>PrimaryReselectPolicy=
</varname></term>
1523 <para>Specifies the reselection policy for the primary slave. This
1524 affects how the primary slave is chosen to become the active slave
1525 when failure of the active slave or recovery of the primary slave
1526 occurs. This option is designed to prevent flip-flopping between
1527 the primary slave and other slaves. Possible values are
1528 <literal>always
</literal>,
1529 <literal>better
</literal> and
1530 <literal>failure
</literal>.
1536 <term><varname>ResendIGMP=
</varname></term>
1538 <para>Specifies the number of IGMP membership reports to be issued after
1539 a failover event. One membership report is issued immediately after
1540 the failover, subsequent packets are sent in each
200ms interval.
1541 The valid range is
0–
255. Defaults to
1. A value of
0
1542 prevents the IGMP membership report from being issued in response
1543 to the failover event.
1549 <term><varname>PacketsPerSlave=
</varname></term>
1551 <para>Specify the number of packets to transmit through a slave before
1552 moving to the next one. When set to
0, then a slave is chosen at
1553 random. The valid range is
0–
65535. Defaults to
1. This option
1554 only has effect when in balance-rr mode.
1560 <term><varname>GratuitousARP=
</varname></term>
1562 <para>Specify the number of peer notifications (gratuitous ARPs and
1563 unsolicited IPv6 Neighbor Advertisements) to be issued after a
1564 failover event. As soon as the link is up on the new slave,
1565 a peer notification is sent on the bonding device and each
1566 VLAN sub-device. This is repeated at each link monitor interval
1567 (ARPIntervalSec or MIIMonitorSec, whichever is active) if the number is
1568 greater than
1. The valid range is
0–
255. The default value is
1.
1569 These options affect only the active-backup mode.
1575 <term><varname>AllSlavesActive=
</varname></term>
1577 <para>Takes a boolean. Specifies that duplicate frames (received on inactive ports)
1578 should be dropped when false, or delivered when true. Normally, bonding will drop
1579 duplicate frames (received on inactive ports), which is desirable for
1580 most users. But there are some times it is nice to allow duplicate
1581 frames to be delivered. The default value is false (drop duplicate frames
1582 received on inactive ports).
1588 <term><varname>DynamicTransmitLoadBalancing=
</varname></term>
1590 <para>Takes a boolean. Specifies if dynamic shuffling of flows is enabled. Applies only
1591 for balance-tlb mode. Defaults to unset.
1597 <term><varname>MinLinks=
</varname></term>
1599 <para>Specifies the minimum number of links that must be active before
1600 asserting carrier. The default value is
0.
1606 <para>For more detail information see
1607 <ulink url=
"https://www.kernel.org/doc/Documentation/networking/bonding.txt">
1608 Linux Ethernet Bonding Driver HOWTO
</ulink></para>
1613 <title>Examples
</title>
1615 <title>/etc/systemd/network/
25-bridge.netdev
</title>
1617 <programlisting>[NetDev]
1619 Kind=bridge
</programlisting>
1623 <title>/etc/systemd/network/
25-vlan1.netdev
</title>
1625 <programlisting>[Match]
1633 Id=
1</programlisting>
1636 <title>/etc/systemd/network/
25-ipip.netdev
</title>
1637 <programlisting>[NetDev]
1643 Local=
192.168.223.238
1644 Remote=
192.169.224.239
1645 TTL=
64</programlisting>
1648 <title>/etc/systemd/network/
1-fou-tunnel.netdev
</title>
1649 <programlisting>[NetDev]
1659 <title>/etc/systemd/network/
25-fou-ipip.netdev
</title>
1660 <programlisting>[NetDev]
1667 Remote=
10.65.208.211
1669 FOUDestinationPort=
5555
1673 <title>/etc/systemd/network/
25-tap.netdev
</title>
1674 <programlisting>[NetDev]
1680 PacketInfo=yes
</programlisting> </example>
1683 <title>/etc/systemd/network/
25-sit.netdev
</title>
1684 <programlisting>[NetDev]
1691 Remote=
10.65.223.239</programlisting>
1695 <title>/etc/systemd/network/
25-
6rd.netdev
</title>
1696 <programlisting>[NetDev]
1703 IPv6RapidDeploymentPrefix=
2602::/
24</programlisting>
1707 <title>/etc/systemd/network/
25-gre.netdev
</title>
1708 <programlisting>[NetDev]
1715 Remote=
10.65.223.239</programlisting>
1719 <title>/etc/systemd/network/
25-vti.netdev
</title>
1721 <programlisting>[NetDev]
1728 Remote=
10.65.223.239</programlisting>
1732 <title>/etc/systemd/network/
25-veth.netdev
</title>
1733 <programlisting>[NetDev]
1738 Name=veth-peer
</programlisting>
1742 <title>/etc/systemd/network/
25-bond.netdev
</title>
1743 <programlisting>[NetDev]
1749 TransmitHashPolicy=layer3+
4
1751 LACPTransmitRate=fast
1756 <title>/etc/systemd/network/
25-dummy.netdev
</title>
1757 <programlisting>[NetDev]
1760 MACAddress=
12:
34:
56:
78:
9a:bc
</programlisting>
1763 <title>/etc/systemd/network/
25-vrf.netdev
</title>
1764 <para>Create a VRF interface with table
42.
</para>
1765 <programlisting>[NetDev]
1770 Table=
42</programlisting>
1774 <title>/etc/systemd/network/
25-macvtap.netdev
</title>
1775 <para>Create a MacVTap device.
</para>
1776 <programlisting>[NetDev]
1782 <title>/etc/systemd/network/
25-wireguard.netdev
</title>
1783 <programlisting>[NetDev]
1788 PrivateKey=EEGlnEPYJV//kbvvIqxKkQwOiS+UENyPncC4bF46ong=
1792 PublicKey=RDf+LSpeEre7YEIKaxg+wbpsNV7du+ktR99uBEtIiCA=
1793 AllowedIPs=fd31:bf08:
57cb::/
48,
192.168.26.0/
24
1794 Endpoint=wireguard.example.com:
51820</programlisting>
1798 <title>See Also
</title>
1800 <citerefentry><refentrytitle>systemd
</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
1801 <citerefentry><refentrytitle>systemd-networkd
</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
1802 <citerefentry><refentrytitle>systemd.link
</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
1803 <citerefentry><refentrytitle>systemd.network
</refentrytitle><manvolnum>5</manvolnum></citerefentry>