]> git.ipfire.org Git - thirdparty/systemd.git/blame - man/systemd.netdev.xml
networkd: ip6 tunnel add DSCP
[thirdparty/systemd.git] / man / systemd.netdev.xml
CommitLineData
eac684ef
TG
1<?xml version='1.0'?> <!--*-nxml-*-->
2<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
12b42c76 3 "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
eac684ef
TG
4
5<!--
6 This file is part of systemd.
7
8 Copyright 2013 Tom Gundersen
9
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.
14
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.
19
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/>.
22-->
23
24<refentry id="systemd.netdev" conditional='ENABLE_NETWORKD'>
25
798d3a52
ZJS
26 <refentryinfo>
27 <title>systemd.network</title>
28 <productname>systemd</productname>
29
30 <authorgroup>
31 <author>
32 <contrib>Developer</contrib>
33 <firstname>Tom</firstname>
34 <surname>Gundersen</surname>
35 <email>teg@jklm.no</email>
36 </author>
37 </authorgroup>
38 </refentryinfo>
39
40 <refmeta>
41 <refentrytitle>systemd.netdev</refentrytitle>
42 <manvolnum>5</manvolnum>
43 </refmeta>
44
45 <refnamediv>
46 <refname>systemd.netdev</refname>
47 <refpurpose>Virtual Network Device configuration</refpurpose>
48 </refnamediv>
49
50 <refsynopsisdiv>
51 <para><filename><replaceable>netdev</replaceable>.netdev</filename></para>
52 </refsynopsisdiv>
53
54 <refsect1>
55 <title>Description</title>
56
57 <para>Network setup is performed by
58 <citerefentry><refentrytitle>systemd-networkd</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
59 </para>
60
61 <para>Virtual Network Device files must have the extension
62 <filename>.netdev</filename>; other extensions are ignored.
63 Virtual network devices are created as soon as networkd is
64 started. If a netdev with the specified name already exists,
65 networkd will use that as-is rather than create its own. Note that
66 the settings of the pre-existing netdev will not be changed by
67 networkd.</para>
68
69 <para>The <filename>.netdev</filename> files are read from the
70 files located in the system network directory
12b42c76 71 <filename>/usr/lib/systemd/network</filename>, the volatile
798d3a52
ZJS
72 runtime network directory
73 <filename>/run/systemd/network</filename> and the local
74 administration network directory
12b42c76 75 <filename>/etc/systemd/network</filename>. All configuration files
798d3a52
ZJS
76 are collectively sorted and processed in lexical order, regardless
77 of the directories in which they live. However, files with
78 identical filenames replace each other. Files in
79 <filename>/etc</filename> have the highest priority, files in
80 <filename>/run</filename> take precedence over files with the same
12b42c76 81 name in <filename>/usr/lib</filename>. This can be used to
798d3a52
ZJS
82 override a system-supplied configuration file with a local file if
83 needed; a symlink in <filename>/etc</filename> with the same name
12b42c76 84 as a configuration file in <filename>/usr/lib</filename>, pointing
798d3a52
ZJS
85 to <filename>/dev/null</filename>, disables the configuration file
86 entirely.</para>
87
88 </refsect1>
89
90 <refsect1>
91 <title>Supported netdev kinds</title>
92
93 <para>The following kinds of virtual network devices may be
94 configured in <filename>.netdev</filename> files:</para>
95
96 <table>
97 <title>Supported kinds of virtual network devices</title>
98
99 <tgroup cols='2'>
100 <colspec colname='kind' />
101 <colspec colname='explanation' />
102 <thead><row>
103 <entry>Kind</entry>
104 <entry>Description</entry>
105 </row></thead>
106 <tbody>
107 <row><entry><varname>bond</varname></entry>
108 <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>
109
110 <row><entry><varname>bridge</varname></entry>
a6818881 111 <entry>A bridge device is a software switch, each of its slave devices and the bridge itself are ports of the switch.</entry></row>
798d3a52
ZJS
112
113 <row><entry><varname>dummy</varname></entry>
114 <entry>A dummy device drops all packets sent to it.</entry></row>
115
116 <row><entry><varname>gre</varname></entry>
117 <entry>A Level 3 GRE tunnel over IPv4. See <ulink url="https://tools.ietf.org/html/rfc2784">RFC 2784</ulink> for details.</entry></row>
118
119 <row><entry><varname>gretap</varname></entry>
120 <entry>A Level 2 GRE tunnel over IPv4.</entry></row>
121
122 <row><entry><varname>ip6gre</varname></entry>
123 <entry>A Level 3 GRE tunnel over IPv6.</entry></row>
124
125 <row><entry><varname>ip6tnl</varname></entry>
126 <entry>An IPv4 or IPv6 tunnel over IPv6</entry></row>
127
128 <row><entry><varname>ip6gretap</varname></entry>
129 <entry>An Level 2 GRE tunnel over IPv6.</entry></row>
130
131 <row><entry><varname>ipip</varname></entry>
132 <entry>An IPv4 over IPv4 tunnel.</entry></row>
133
134 <row><entry><varname>ipvlan</varname></entry>
135 <entry>An ipvlan device is a stacked device which receives packets from its underlying device based on IP address filtering.</entry></row>
136
137 <row><entry><varname>macvlan</varname></entry>
138 <entry>A macvlan device is a stacked device which receives packets from its underlying device based on MAC address filtering.</entry></row>
139
140 <row><entry><varname>sit</varname></entry>
141 <entry>An IPv6 over IPv4 tunnel.</entry></row>
142
143 <row><entry><varname>tap</varname></entry>
144 <entry>A persistent Level 2 tunnel between a network device and a device node.</entry></row>
145
146 <row><entry><varname>tun</varname></entry>
147 <entry>A persistent Level 3 tunnel between a network device and a device node.</entry></row>
148
149 <row><entry><varname>veth</varname></entry>
150 <entry>An ethernet tunnel between a pair of network devices.</entry></row>
151
152 <row><entry><varname>vlan</varname></entry>
153 <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>
154
155 <row><entry><varname>vti</varname></entry>
156 <entry>An IPv4 over IPSec tunnel.</entry></row>
157
5cc0748e
SS
158 <row><entry><varname>vti6</varname></entry>
159 <entry>An IPv6 over IPSec tunnel.</entry></row>
160
798d3a52
ZJS
161 <row><entry><varname>vxlan</varname></entry>
162 <entry>A virtual extensible LAN (vxlan), for connecting Cloud computing deployments.</entry></row>
163 </tbody>
164 </tgroup>
165 </table>
166
167 </refsect1>
168
169 <refsect1>
170 <title>[Match] Section Options</title>
171
172 <para>A virtual network device is only created if the
173 <literal>[Match]</literal> section matches the current
174 environment, or if the section is empty. The following keys are
175 accepted:</para>
176
177 <variablelist class='network-directives'>
178 <varlistentry>
179 <term><varname>Host=</varname></term>
180 <listitem>
181 <para>Matches against the hostname or machine ID of the
182 host. See <literal>ConditionHost=</literal> in
183 <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>
184 for details.
185 </para>
186 </listitem>
187 </varlistentry>
188 <varlistentry>
189 <term><varname>Virtualization=</varname></term>
190 <listitem>
191 <para>Checks whether the system is executed in a virtualized
192 environment and optionally test whether it is a specific
193 implementation. See
194 <literal>ConditionVirtualization=</literal> in
195 <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>
196 for details.
197 </para>
198 </listitem>
199 </varlistentry>
200 <varlistentry>
201 <term><varname>KernelCommandLine=</varname></term>
202 <listitem>
203 <para>Checks whether a specific kernel command line option
204 is set (or if prefixed with the exclamation mark unset). See
205 <literal>ConditionKernelCommandLine=</literal> in
206 <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>
207 for details.
208 </para>
209 </listitem>
210 </varlistentry>
211 <varlistentry>
212 <term><varname>Architecture=</varname></term>
213 <listitem>
214 <para>Checks whether the system is running on a specific
215 architecture. See <literal>ConditionArchitecture=</literal> in
216 <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>
217 for details.
218 </para>
219 </listitem>
220 </varlistentry>
221 </variablelist>
222
223 </refsect1>
224
225 <refsect1>
226 <title>[NetDev] Section Options</title>
227
228 <para>The <literal>[NetDev]</literal> section accepts the
229 following keys:</para>
230
231 <variablelist class='network-directives'>
232 <varlistentry>
233 <term><varname>Description=</varname></term>
234 <listitem>
235 <para>A free-form description of the netdev.</para>
236 </listitem>
237 </varlistentry>
238 <varlistentry>
239 <term><varname>Name=</varname></term>
240 <listitem>
241 <para>The interface name used when creating the netdev.
242 This option is compulsory.</para>
243 </listitem>
244 </varlistentry>
245 <varlistentry>
246 <term><varname>Kind=</varname></term>
247 <listitem>
248 <para>The netdev kind. This option is compulsory. See the
249 <literal>Supported netdev kinds</literal> section for the
250 valid keys.</para>
251 </listitem>
252 </varlistentry>
253 <varlistentry>
254 <term><varname>MTUBytes=</varname></term>
255 <listitem>
256 <para>The maximum transmission unit in bytes to set for
257 the device. The usual suffixes K, M, G, are supported and
258 are understood to the base of 1024. This key is not
ff9b60f3 259 currently supported for <literal>tun</literal> or
798d3a52
ZJS
260 <literal>tap</literal> devices.
261 </para>
262 </listitem>
263 </varlistentry>
264 <varlistentry>
265 <term><varname>MACAddress=</varname></term>
266 <listitem>
267 <para>The MAC address to use for the device. If none is
268 given, one is generated based on the interface name and
269 the
270 <citerefentry><refentrytitle>machine-id</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
ff9b60f3 271 This key is not currently supported for
798d3a52
ZJS
272 <literal>tun</literal> or <literal>tap</literal> devices.
273 </para>
274 </listitem>
275 </varlistentry>
276 </variablelist>
277 </refsect1>
278
279 <refsect1>
280 <title>[VLAN] Section Options</title>
281
282 <para>The <literal>[VLAN]</literal> section only applies for
283 netdevs of kind <literal>vlan</literal>, and accepts the
284 following key:</para>
285
286 <variablelist class='network-directives'>
287 <varlistentry>
288 <term><varname>Id=</varname></term>
289 <listitem>
290 <para>The VLAN ID to use. An integer in the range 0–4094.
291 This option is compulsory.</para>
292 </listitem>
293 </varlistentry>
294 </variablelist>
295
296 </refsect1>
297
298 <refsect1>
299 <title>[MACVLAN] Section Options</title>
300
301 <para>The <literal>[MACVLAN]</literal> section only applies for
302 netdevs of kind <literal>macvlan</literal>, and accepts the
303 following key:</para>
304
305 <variablelist class='network-directives'>
306 <varlistentry>
307 <term><varname>Mode=</varname></term>
308 <listitem>
309 <para>The MACVLAN mode to use. The supported options are
310 <literal>private</literal>,
311 <literal>vepa</literal>,
312 <literal>bridge</literal>, and
313 <literal>passthru</literal>.
314 </para>
315 </listitem>
316 </varlistentry>
317 </variablelist>
318
319 </refsect1>
320
321 <refsect1>
322 <title>[IPVLAN] Section Options</title>
323
324 <para>The <literal>[IPVLAN]</literal> section only applies for
325 netdevs of kind <literal>ipvlan</literal>, and accepts the
326 following key:</para>
327
328 <variablelist class='network-directives'>
329 <varlistentry>
330 <term><varname>Mode=</varname></term>
331 <listitem>
332 <para>The IPVLAN mode to use. The supported options are
333 <literal>L2</literal> and <literal>L3</literal>.
334 </para>
335 </listitem>
336 </varlistentry>
337 </variablelist>
338
339 </refsect1>
340
341 <refsect1>
342 <title>[VXLAN] Section Options</title>
343 <para>The <literal>[VXLAN]</literal> section only applies for
344 netdevs of kind <literal>vxlan</literal>, and accepts the
345 following keys:</para>
346
347 <variablelist class='network-directives'>
348 <varlistentry>
349 <term><varname>Id=</varname></term>
350 <listitem>
351 <para>The VXLAN ID to use.</para>
352 </listitem>
353 </varlistentry>
354 <varlistentry>
355 <term><varname>Group=</varname></term>
356 <listitem>
357 <para>An assigned multicast group IP address.</para>
358 </listitem>
359 </varlistentry>
360 <varlistentry>
361 <term><varname>TOS=</varname></term>
362 <listitem>
363 <para>The Type Of Service byte value for a vxlan interface.</para>
364 </listitem>
365 </varlistentry>
366 <varlistentry>
367 <term><varname>TTL=</varname></term>
368 <listitem>
369 <para>A fixed Time To Live N on Virtual eXtensible Local
370 Area Network packets. N is a number in the range 1-255. 0
371 is a special value meaning that packets inherit the TTL
372 value.</para>
373 </listitem>
374 </varlistentry>
375 <varlistentry>
376 <term><varname>MacLearning=</varname></term>
377 <listitem>
378 <para>A boolean. When true, enables dynamic MAC learning
379 to discover remote MAC addresses.</para>
380 </listitem>
381 </varlistentry>
382 <varlistentry>
383 <term><varname>FDBAgeingSec=</varname></term>
384 <listitem>
385 <para>The lifetime of Forwarding Database entry learnt by
386 the kernel in seconds.</para>
387 </listitem>
388 </varlistentry>
389 <varlistentry>
390 <term><varname>ARPProxy=</varname></term>
391 <listitem>
392 <para>A boolean. When true, enables ARP proxy.</para>
393 </listitem>
394 </varlistentry>
395 <varlistentry>
396 <term><varname>L2MissNotification=</varname></term>
397 <listitem>
398 <para>A boolean. When true, enables netlink LLADDR miss
399 notifications.</para>
400 </listitem>
401 </varlistentry>
402 <varlistentry>
403 <term><varname>L3MissNotification=</varname></term>
404 <listitem>
405 <para>A boolean. When true, enables netlink IP ADDR miss
406 notifications.</para>
407 </listitem>
408 </varlistentry>
409 <varlistentry>
410 <term><varname>RouteShortCircuit=</varname></term>
411 <listitem>
412 <para>A boolean. When true route short circuit is turned
413 on.</para>
414 </listitem>
415 </varlistentry>
cffacc74
SS
416 <varlistentry>
417 <term><varname>UDPCheckSum=</varname></term>
418 <listitem>
419 <para>A boolean. When true transmitting UDP checksums when doing VXLAN/IPv4 is turned on.</para>
420 </listitem>
421 </varlistentry>
422 <varlistentry>
423 <term><varname>UDP6ZeroChecksumTx=</varname></term>
424 <listitem>
425 <para>A boolean. When true sending zero checksums in VXLAN/IPv6 is turned on.</para>
426 </listitem>
427 </varlistentry>
428 <varlistentry>
429 <term><varname>UDP6ZeroCheckSumRx=</varname></term>
430 <listitem>
431 <para>A boolean. When true receiving zero checksums in VXLAN/IPv6 is turned on.</para>
432 </listitem>
433 </varlistentry>
798d3a52
ZJS
434 </variablelist>
435 </refsect1>
436 <refsect1>
437 <title>[Tunnel] Section Options</title>
438
439 <para>The <literal>[Tunnel]</literal> section only applies for
440 netdevs of kind
441 <literal>ipip</literal>,
442 <literal>sit</literal>,
443 <literal>gre</literal>,
444 <literal>gretap</literal>,
445 <literal>ip6gre</literal>,
446 <literal>ip6gretap</literal>,
5cc0748e
SS
447 <literal>vti</literal>,
448 <literal>vti6</literal>, and
798d3a52
ZJS
449 <literal>ip6tnl</literal> and accepts
450 the following keys:</para>
451
452 <variablelist class='network-directives'>
453 <varlistentry>
454 <term><varname>Local=</varname></term>
455 <listitem>
456 <para>A static local address for tunneled packets. It must
457 be an address on another interface of this host.</para>
458 </listitem>
459 </varlistentry>
460 <varlistentry>
461 <term><varname>Remote=</varname></term>
462 <listitem>
463 <para>The remote endpoint of the tunnel.</para>
464 </listitem>
465 </varlistentry>
466 <varlistentry>
467 <term><varname>TOS=</varname></term>
468 <listitem>
469 <para>The Type Of Service byte value for a tunnel interface.
470 For details about the TOS see the
471 <ulink url="http://tools.ietf.org/html/rfc1349"> Type of
472 Service in the Internet Protocol Suite </ulink> document.
473 </para>
474 </listitem>
475 </varlistentry>
476 <varlistentry>
477 <term><varname>TTL=</varname></term>
478 <listitem>
479 <para>A fixed Time To Live N on tunneled packets. N is a
480 number in the range 1-255. 0 is a special value meaning that
481 packets inherit the TTL value. The default value for IPv4
482 tunnels is: inherit. The default value for IPv6 tunnels is:
483 64.</para>
484 </listitem>
485 </varlistentry>
486 <varlistentry>
487 <term><varname>DiscoverPathMTU=</varname></term>
488 <listitem>
489 <para>A boolean. When true, enables Path MTU Discovery on
490 the tunnel.</para>
491 </listitem>
492 </varlistentry>
276de526
SS
493 <varlistentry>
494 <term><varname>IPv6FlowLabel=</varname></term>
495 <listitem>
496 <para>Configures The 20-bit Flow Label (see <ulink url="https://tools.ietf.org/html/rfc6437">
497 RFC 6437</ulink>) field in the IPv6 header (see <ulink url="https://tools.ietf.org/html/rfc2460">
498 RFC 2460</ulink>), is used by a node to label packets of a flow.
499 It's only used for IPv6 Tunnels.
500 A Flow Label of zero is used to indicate packets that have
501 not been labeled. Takes following values.
502 When <literal>inherit</literal> it uses the original flowlabel,
503 or can be configured to any value betwen 0 to 0xFFFFF.</para>
504 </listitem>
505 </varlistentry>
798d3a52
ZJS
506 <varlistentry>
507 <term><varname>Mode=</varname></term>
508 <listitem>
509 <para>An <literal>ip6tnl</literal> tunnels can have three
510 modes
511 <literal>ip6ip6</literal> for IPv6 over IPv6,
512 <literal>ipip6</literal> for IPv4 over IPv6 or
513 <literal>any</literal> for either.
514 </para>
515 </listitem>
516 </varlistentry>
517 </variablelist>
518 </refsect1>
519 <refsect1>
520 <title>[Peer] Section Options</title>
521
522 <para>The <literal>[Peer]</literal> section only applies for
523 netdevs of kind <literal>veth</literal> and accepts the
524 following key:</para>
525
526 <variablelist class='network-directives'>
527 <varlistentry>
528 <term><varname>Name=</varname></term>
529 <listitem>
530 <para>The interface name used when creating the netdev.
531 This option is compulsory.</para>
532 </listitem>
533 </varlistentry>
534 <varlistentry>
535 <term><varname>MACAddress=</varname></term>
536 <listitem>
537 <para>The peer MACAddress, if not set it is generated in
538 the same way as the MAC address of the main
539 interface.</para>
540 </listitem>
541 </varlistentry>
542 </variablelist>
543 </refsect1>
544 <refsect1>
545 <title>[Tun] Section Options</title>
546
547 <para>The <literal>[Tun]</literal> section only applies for
548 netdevs of kind <literal>tun</literal>, and accepts the following
549 keys:</para>
550
551 <variablelist class='network-directives'>
552 <varlistentry>
553 <term><varname>OneQueue=</varname></term>
554 <listitem><para>Takes a boolean argument. Configures whether
555 all packets are queued at the device (enabled), or a fixed
556 number of packets are queued at the device and the rest at the
557 <literal>qdisc</literal>. Defaults to
558 <literal>no</literal>.</para>
559 </listitem>
560 </varlistentry>
561 <varlistentry>
562 <term><varname>MultiQueue=</varname></term>
563 <listitem><para>Takes a boolean argument. Configures whether
564 to use multiple file descriptors (queues) to parallelize
565 packets sending and receiving. Defaults to
566 <literal>no</literal>.</para>
567 </listitem>
568 </varlistentry>
569 <varlistentry>
570 <term><varname>PacketInfo=</varname></term>
571 <listitem><para>Takes a boolean argument. Configures whether
ff9b60f3 572 packets should be prepended with four extra bytes (two flag
798d3a52
ZJS
573 bytes and two protocol bytes). If disabled it indicates that
574 the packets will be pure IP packets. Defaults to
575 <literal>no</literal>.</para>
576 </listitem>
577 </varlistentry>
43f78da4
SS
578 <varlistentry>
579 <term><varname>VnetHeader=</varname></term>
580 <listitem><para>Takes a boolean argument. Configures
581 IFF_VNET_HDR flag for a tap device. It allows sending
582 and receiving larger Generic Segmentation Offload (GSO)
583 packets. This may increase throughput significantly.
584 Defaults to
585 <literal>no</literal>.</para>
586 </listitem>
587 </varlistentry>
798d3a52
ZJS
588 <varlistentry>
589 <term><varname>User=</varname></term>
590 <listitem><para>User to grant access to the
591 <filename>/dev/net/tun</filename> device.</para>
592 </listitem>
593 </varlistentry>
594 <varlistentry>
595 <term><varname>Group=</varname></term>
596 <listitem><para>Group to grant access to the
597 <filename>/dev/net/tun</filename> device.</para>
598 </listitem>
599 </varlistentry>
600
601 </variablelist>
602
603 </refsect1>
604
605 <refsect1>
606 <title>[Tap] Section Options</title>
607
608 <para>The <literal>[Tap]</literal> section only applies for
609 netdevs of kind <literal>tap</literal>, and accepts the same keys
610 as the <literal>[Tun]</literal> section.</para>
611 </refsect1>
612
613 <refsect1>
614 <title>[Bond] Section Options</title>
615
616 <para>The <literal>[Bond]</literal> section accepts the following
617 key:</para>
618
619 <variablelist class='network-directives'>
620 <varlistentry>
621 <term><varname>Mode=</varname></term>
622 <listitem>
623 <para>Specifies one of the bonding policies. The default is
624 <literal>balance-rr</literal> (round robin). Possible values are
625 <literal>balance-rr</literal>,
626 <literal>active-backup</literal>,
627 <literal>balance-xor</literal>,
628 <literal>broadcast</literal>,
629 <literal>802.3ad</literal>,
630 <literal>balance-tlb</literal>, and
631 <literal>balance-alb</literal>.
632 </para>
633 </listitem>
634 </varlistentry>
635
636 <varlistentry>
637 <term><varname>TransmitHashPolicy=</varname></term>
638 <listitem>
639 <para>Selects the transmit hash policy to use for slave
640 selection in balance-xor, 802.3ad, and tlb modes. Possible
641 values are
642 <literal>layer2</literal>,
643 <literal>layer3+4</literal>,
644 <literal>layer2+3</literal>,
645 <literal>encap2+3</literal>,
646 <literal>802.3ad</literal>, and
647 <literal>encap3+4</literal>.
648 </para>
649 </listitem>
650 </varlistentry>
651
652 <varlistentry>
653 <term><varname>LACPTransmitRate=</varname></term>
654 <listitem>
655 <para>Specifies the rate with which link partner transmits
656 Link Aggregation Control Protocol Data Unit packets in
657 802.3ad mode. Possible values are <literal>slow</literal>,
658 which requests partner to transmit LACPDUs every 30 seconds,
659 and <literal>fast</literal>, which requests partner to
660 transmit LACPDUs every second. The default value is
661 <literal>slow</literal>.</para>
662 </listitem>
663 </varlistentry>
664
665 <varlistentry>
666 <term><varname>MIIMonitorSec=</varname></term>
667 <listitem>
668 <para>Specifies the frequency that Media Independent
669 Interface link monitoring will occur. A value of zero
670 disables MII link monitoring. This values is rounded down to
671 the nearest millisecond. The default value is 0.</para>
672 </listitem>
673 </varlistentry>
674
675 <varlistentry>
676 <term><varname>UpDelaySec=</varname></term>
677 <listitem>
678 <para>Specifies the delay before a link is enabled after a
679 link up status has been detected. This value is rounded down
680 to a multiple of MIIMonitorSec. The default value is
681 0.</para>
682 </listitem>
683 </varlistentry>
684
685 <varlistentry>
686 <term><varname>DownDelaySec=</varname></term>
687 <listitem>
688 <para>Specifies the delay before a link is disabled after a
689 link down status has been detected. This value is rounded
690 down to a multiple of MIIMonitorSec. The default value is
691 0.</para>
692 </listitem>
693 </varlistentry>
694
81bd37a8 695 <varlistentry>
38422da7 696 <term><varname>LearnPacketIntervalSec=</varname></term>
81bd37a8
SS
697 <listitem>
698 <para>Specifies the number of seconds between instances where the bonding
699 driver sends learning packets to each slaves peer switch.
700 The valid range is 1 - 0x7fffffff; the default value is 1. This Option
701 has effect only in balance-tlb and balance-alb modes.</para>
702 </listitem>
703 </varlistentry>
704
705 <varlistentry>
706 <term><varname>AdSelect=</varname></term>
707 <listitem>
708 <para>Specifies the 802.3ad aggregation selection logic to use. Possible values are
709 <literal>stable</literal>,
710 <literal>bandwidth</literal>,
711 <literal>count</literal>
712 </para>
713 </listitem>
714 </varlistentry>
715
716 <varlistentry>
38422da7 717 <term><varname>FailOverMACPolicy=</varname></term>
81bd37a8
SS
718 <listitem>
719 <para>Specifies whether active-backup mode should set all slaves to
720 the same MAC address at enslavement or, when enabled, perform special handling of the
721 bond's MAC address in accordance with the selected policy. The default policy is none.
722 Possible values are
723 <literal>none</literal>,
724 <literal>active</literal>,
725 <literal>follow</literal>
726 </para>
727 </listitem>
728 </varlistentry>
729
730 <varlistentry>
38422da7 731 <term><varname>ARPValidate=</varname></term>
81bd37a8
SS
732 <listitem>
733 <para>Specifies whether or not ARP probes and replies should be
38422da7 734 validated in any mode that supports ARP monitoring, or whether
81bd37a8
SS
735 non-ARP traffic should be filtered (disregarded) for link
736 monitoring purposes. Possible values are
737 <literal>none</literal>,
738 <literal>active</literal>,
739 <literal>backup</literal>,
740 <literal>all</literal>
741 </para>
742 </listitem>
743 </varlistentry>
744
745 <varlistentry>
38422da7 746 <term><varname>ARPIntervalSec=</varname></term>
81bd37a8
SS
747 <listitem>
748 <para>Specifies the ARP link monitoring frequency in milliseconds.
749 A value of 0 disables ARP monitoring. The default value is 0.
750 </para>
751 </listitem>
752 </varlistentry>
753
754 <varlistentry>
38422da7 755 <term><varname>ARPIPTargets=</varname></term>
81bd37a8
SS
756 <listitem>
757 <para>Specifies the IP addresses to use as ARP monitoring peers when
38422da7 758 ARPIntervalSec is greater than 0. These are the targets of the ARP request
81bd37a8
SS
759 sent to determine the health of the link to the targets.
760 Specify these values in ipv4 dotted decimal format. At least one IP
761 address must be given for ARP monitoring to function. The
762 maximum number of targets that can be specified is 16. The
763 default value is no IP addresses.
764 </para>
765 </listitem>
766 </varlistentry>
767
768 <varlistentry>
38422da7 769 <term><varname>ARPAllTargets=</varname></term>
81bd37a8 770 <listitem>
38422da7 771 <para>Specifies the quantity of ARPIPTargets that must be reachable
81bd37a8
SS
772 in order for the ARP monitor to consider a slave as being up.
773 This option affects only active-backup mode for slaves with
38422da7 774 ARPValidate enabled. Possible values are
81bd37a8
SS
775 <literal>any</literal>,
776 <literal>all</literal>
777 </para>
778 </listitem>
779 </varlistentry>
780
781 <varlistentry>
38422da7 782 <term><varname>PrimaryReselectPolicy=</varname></term>
81bd37a8
SS
783 <listitem>
784 <para>Specifies the reselection policy for the primary slave. This
785 affects how the primary slave is chosen to become the active slave
786 when failure of the active slave or recovery of the primary slave
787 occurs. This option is designed to prevent flip-flopping between
788 the primary slave and other slaves. Possible values are
789 <literal>always</literal>,
790 <literal>better</literal>,
791 <literal>failure</literal>
792 </para>
793 </listitem>
794 </varlistentry>
795
796 <varlistentry>
797 <term><varname>ResendIGMP=</varname></term>
798 <listitem>
799 <para>Specifies the number of IGMP membership reports to be issued after
800 a failover event. One membership report is issued immediately after
801 the failover, subsequent packets are sent in each 200ms interval.
802 The valid range is (0 - 255). Defaults to 1. A value of 0
803 prevents the IGMP membership report from being issued in response
804 to the failover event.
805 </para>
806 </listitem>
807 </varlistentry>
808
809 <varlistentry>
810 <term><varname>PacketsPerSlave=</varname></term>
811 <listitem>
812 <para> Specify the number of packets to transmit through a slave before
813 moving to the next one. When set to 0 then a slave is chosen at
814 random.The valid range is (0 - 65535). Defaults to 1. This option
815 has effect only in balance-rr mode.
816 </para>
817 </listitem>
818 </varlistentry>
819
820 <varlistentry>
38422da7 821 <term><varname>GratuitousARP=</varname></term>
81bd37a8
SS
822 <listitem>
823 <para>Specify the number of peer notifications (gratuitous ARPs and
824 unsolicited IPv6 Neighbor Advertisements) to be issued after a
825 failover event. As soon as the link is up on the new slave
826 a peer notification is sent on the bonding device and each
827 VLAN sub-device. This is repeated at each link monitor interval
38422da7 828 (ARPIntervalSec or MIIMonitorSec, whichever is active) if the number is
81bd37a8 829 greater than 1. The valid range is (0 - 255). Default value is 1.
38422da7 830 These options affect only the active-backup mode.
81bd37a8
SS
831 </para>
832 </listitem>
833 </varlistentry>
834
835 <varlistentry>
836 <term><varname>AllSlavesActive=</varname></term>
837 <listitem>
838 <para> A boolean. Specifies that duplicate frames (received on inactive ports)
839 should be dropped false or delivered true. Normally, bonding will drop
840 duplicate frames (received on inactive ports), which is desirable for
841 most users. But there are some times it is nice to allow duplicate
842 frames to be delivered. The default value is false (drop duplicate frames
843 received on inactive ports).
844 </para>
845 </listitem>
846 </varlistentry>
847
848 <varlistentry>
849 <term><varname>MinLinks=</varname></term>
850 <listitem>
851 <para>Specifies the minimum number of links that must be active before
852 asserting carrier. The default value is 0.
853 </para>
854 </listitem>
855 </varlistentry>
856
798d3a52 857 </variablelist>
81bd37a8
SS
858
859 <para>For more detail information see
860 <ulink url="https://www.kernel.org/doc/Documentation/networking/bonding.txt">
861 Linux Ethernet Bonding Driver HOWTO</ulink></para>
862
798d3a52
ZJS
863 </refsect1>
864
865 <refsect1>
866 <title>Example</title>
867 <example>
12b42c76 868 <title>/etc/systemd/network/bridge.netdev</title>
798d3a52
ZJS
869
870 <programlisting>[NetDev]
eac684ef
TG
871Name=bridge0
872Kind=bridge</programlisting>
798d3a52 873 </example>
eac684ef 874
798d3a52 875 <example>
12b42c76 876 <title>/etc/systemd/network/vlan1.netdev</title>
eac684ef 877
798d3a52 878 <programlisting>[Match]
eac684ef
TG
879Virtualization=no
880
881[NetDev]
882Name=vlan1
883Kind=vlan
884
885[VLAN]
886Id=1</programlisting>
798d3a52
ZJS
887 </example>
888 <example>
12b42c76 889 <title>/etc/systemd/network/ipip.netdev</title>
798d3a52 890 <programlisting>[NetDev]
b35a2909
TG
891Name=ipip-tun
892Kind=ipip
893MTUBytes=1480
894
895[Tunnel]
896Local=192.168.223.238
897Remote=192.169.224.239
898TTL=64</programlisting>
798d3a52
ZJS
899 </example>
900 <example>
12b42c76 901 <title>/etc/systemd/network/tap.netdev</title>
798d3a52 902 <programlisting>[NetDev]
30ae9dfd
SS
903Name=tap-test
904Kind=tap
905
906[Tap]
907MultiQueue=true
908PacketInfo=true</programlisting> </example>
eac684ef 909
798d3a52 910 <example>
12b42c76 911 <title>/etc/systemd/network/sit.netdev</title>
798d3a52 912 <programlisting>[NetDev]
b35a2909
TG
913Name=sit-tun
914Kind=sit
915MTUBytes=1480
916
917[Tunnel]
918Local=10.65.223.238
919Remote=10.65.223.239</programlisting>
798d3a52 920 </example>
eac684ef 921
798d3a52 922 <example>
12b42c76 923 <title>/etc/systemd/network/gre.netdev</title>
798d3a52 924 <programlisting>[NetDev]
b35a2909
TG
925Name=gre-tun
926Kind=gre
927MTUBytes=1480
928
929[Tunnel]
930Local=10.65.223.238
931Remote=10.65.223.239</programlisting>
798d3a52 932 </example>
b35a2909 933
798d3a52 934 <example>
12b42c76 935 <title>/etc/systemd/network/vti.netdev</title>
b35a2909 936
798d3a52 937 <programlisting>[NetDev]
b35a2909
TG
938Name=vti-tun
939Kind=vti
940MTUBytes=1480
941
942[Tunnel]
943Local=10.65.223.238
944Remote=10.65.223.239</programlisting>
798d3a52 945 </example>
b35a2909 946
798d3a52 947 <example>
12b42c76 948 <title>/etc/systemd/network/veth.netdev</title>
798d3a52 949 <programlisting>[NetDev]
b35a2909
TG
950Name=veth-test
951Kind=veth
952
953[Peer]
954Name=veth-peer</programlisting>
798d3a52 955 </example>
b35a2909 956
798d3a52 957 <example>
12b42c76 958 <title>/etc/systemd/network/dummy.netdev</title>
798d3a52 959 <programlisting>[NetDev]
9e358851
TG
960Name=dummy-test
961Kind=dummy
962MACAddress=12:34:56:78:9a:bc</programlisting>
798d3a52
ZJS
963 </example>
964
965 </refsect1>
966 <refsect1>
967 <title>See Also</title>
968 <para>
969 <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
970 <citerefentry><refentrytitle>systemd-networkd</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
971 <citerefentry><refentrytitle>systemd.link</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
972 <citerefentry><refentrytitle>systemd.network</refentrytitle><manvolnum>5</manvolnum></citerefentry>
973 </para>
974 </refsect1>
eac684ef
TG
975
976</refentry>