]>
Commit | Line | Data |
---|---|---|
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 | ||
bac150e9 ZJS |
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 | |
798d3a52 ZJS |
65 | networkd.</para> |
66 | ||
bac150e9 ZJS |
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> | |
78 | ||
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> | |
84 | ||
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> | |
798d3a52 ZJS |
93 | </refsect1> |
94 | ||
95 | <refsect1> | |
96 | <title>Supported netdev kinds</title> | |
97 | ||
98 | <para>The following kinds of virtual network devices may be | |
99 | configured in <filename>.netdev</filename> files:</para> | |
100 | ||
101 | <table> | |
102 | <title>Supported kinds of virtual network devices</title> | |
103 | ||
104 | <tgroup cols='2'> | |
105 | <colspec colname='kind' /> | |
106 | <colspec colname='explanation' /> | |
107 | <thead><row> | |
108 | <entry>Kind</entry> | |
109 | <entry>Description</entry> | |
110 | </row></thead> | |
111 | <tbody> | |
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> | |
114 | ||
115 | <row><entry><varname>bridge</varname></entry> | |
a8eaaee7 | 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> |
798d3a52 ZJS |
117 | |
118 | <row><entry><varname>dummy</varname></entry> | |
119 | <entry>A dummy device drops all packets sent to it.</entry></row> | |
120 | ||
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> | |
123 | ||
124 | <row><entry><varname>gretap</varname></entry> | |
125 | <entry>A Level 2 GRE tunnel over IPv4.</entry></row> | |
126 | ||
127 | <row><entry><varname>ip6gre</varname></entry> | |
128 | <entry>A Level 3 GRE tunnel over IPv6.</entry></row> | |
129 | ||
130 | <row><entry><varname>ip6tnl</varname></entry> | |
131 | <entry>An IPv4 or IPv6 tunnel over IPv6</entry></row> | |
132 | ||
133 | <row><entry><varname>ip6gretap</varname></entry> | |
037a3ded | 134 | <entry>A Level 2 GRE tunnel over IPv6.</entry></row> |
798d3a52 ZJS |
135 | |
136 | <row><entry><varname>ipip</varname></entry> | |
137 | <entry>An IPv4 over IPv4 tunnel.</entry></row> | |
138 | ||
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> | |
141 | ||
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> | |
144 | ||
0371f2df SS |
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> | |
147 | ||
798d3a52 ZJS |
148 | <row><entry><varname>sit</varname></entry> |
149 | <entry>An IPv6 over IPv4 tunnel.</entry></row> | |
150 | ||
151 | <row><entry><varname>tap</varname></entry> | |
152 | <entry>A persistent Level 2 tunnel between a network device and a device node.</entry></row> | |
153 | ||
154 | <row><entry><varname>tun</varname></entry> | |
155 | <entry>A persistent Level 3 tunnel between a network device and a device node.</entry></row> | |
156 | ||
157 | <row><entry><varname>veth</varname></entry> | |
a8eaaee7 | 158 | <entry>An Ethernet tunnel between a pair of network devices.</entry></row> |
798d3a52 ZJS |
159 | |
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> | |
162 | ||
163 | <row><entry><varname>vti</varname></entry> | |
164 | <entry>An IPv4 over IPSec tunnel.</entry></row> | |
165 | ||
5cc0748e SS |
166 | <row><entry><varname>vti6</varname></entry> |
167 | <entry>An IPv6 over IPSec tunnel.</entry></row> | |
168 | ||
798d3a52 ZJS |
169 | <row><entry><varname>vxlan</varname></entry> |
170 | <entry>A virtual extensible LAN (vxlan), for connecting Cloud computing deployments.</entry></row> | |
20897a0d AR |
171 | |
172 | <row><entry><varname>vrf</varname></entry> | |
92c918b0 SS |
173 | <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> |
174 | ||
175 | <row><entry><varname>vcan</varname></entry> | |
ba9fa3bc | 176 | <entry>The virtual CAN driver (vcan). Similar to the network loopback devices, vcan offers a virtual local CAN interface.</entry></row> |
20897a0d | 177 | |
798d3a52 ZJS |
178 | </tbody> |
179 | </tgroup> | |
180 | </table> | |
181 | ||
182 | </refsect1> | |
183 | ||
184 | <refsect1> | |
185 | <title>[Match] Section Options</title> | |
186 | ||
187 | <para>A virtual network device is only created if the | |
188 | <literal>[Match]</literal> section matches the current | |
189 | environment, or if the section is empty. The following keys are | |
190 | accepted:</para> | |
191 | ||
192 | <variablelist class='network-directives'> | |
193 | <varlistentry> | |
194 | <term><varname>Host=</varname></term> | |
195 | <listitem> | |
196 | <para>Matches against the hostname or machine ID of the | |
197 | host. See <literal>ConditionHost=</literal> in | |
198 | <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry> | |
199 | for details. | |
200 | </para> | |
201 | </listitem> | |
202 | </varlistentry> | |
203 | <varlistentry> | |
204 | <term><varname>Virtualization=</varname></term> | |
205 | <listitem> | |
206 | <para>Checks whether the system is executed in a virtualized | |
207 | environment and optionally test whether it is a specific | |
208 | implementation. See | |
209 | <literal>ConditionVirtualization=</literal> in | |
210 | <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry> | |
211 | for details. | |
212 | </para> | |
213 | </listitem> | |
214 | </varlistentry> | |
215 | <varlistentry> | |
216 | <term><varname>KernelCommandLine=</varname></term> | |
217 | <listitem> | |
218 | <para>Checks whether a specific kernel command line option | |
219 | is set (or if prefixed with the exclamation mark unset). See | |
220 | <literal>ConditionKernelCommandLine=</literal> in | |
221 | <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry> | |
222 | for details. | |
223 | </para> | |
224 | </listitem> | |
225 | </varlistentry> | |
226 | <varlistentry> | |
227 | <term><varname>Architecture=</varname></term> | |
228 | <listitem> | |
229 | <para>Checks whether the system is running on a specific | |
230 | architecture. See <literal>ConditionArchitecture=</literal> in | |
231 | <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry> | |
232 | for details. | |
233 | </para> | |
234 | </listitem> | |
235 | </varlistentry> | |
236 | </variablelist> | |
237 | ||
238 | </refsect1> | |
239 | ||
240 | <refsect1> | |
241 | <title>[NetDev] Section Options</title> | |
242 | ||
243 | <para>The <literal>[NetDev]</literal> section accepts the | |
244 | following keys:</para> | |
245 | ||
246 | <variablelist class='network-directives'> | |
247 | <varlistentry> | |
248 | <term><varname>Description=</varname></term> | |
249 | <listitem> | |
250 | <para>A free-form description of the netdev.</para> | |
251 | </listitem> | |
252 | </varlistentry> | |
253 | <varlistentry> | |
254 | <term><varname>Name=</varname></term> | |
255 | <listitem> | |
256 | <para>The interface name used when creating the netdev. | |
257 | This option is compulsory.</para> | |
258 | </listitem> | |
259 | </varlistentry> | |
260 | <varlistentry> | |
261 | <term><varname>Kind=</varname></term> | |
262 | <listitem> | |
263 | <para>The netdev kind. This option is compulsory. See the | |
264 | <literal>Supported netdev kinds</literal> section for the | |
265 | valid keys.</para> | |
266 | </listitem> | |
267 | </varlistentry> | |
268 | <varlistentry> | |
269 | <term><varname>MTUBytes=</varname></term> | |
270 | <listitem> | |
271 | <para>The maximum transmission unit in bytes to set for | |
272 | the device. The usual suffixes K, M, G, are supported and | |
273 | are understood to the base of 1024. This key is not | |
ff9b60f3 | 274 | currently supported for <literal>tun</literal> or |
798d3a52 ZJS |
275 | <literal>tap</literal> devices. |
276 | </para> | |
277 | </listitem> | |
278 | </varlistentry> | |
279 | <varlistentry> | |
280 | <term><varname>MACAddress=</varname></term> | |
281 | <listitem> | |
282 | <para>The MAC address to use for the device. If none is | |
283 | given, one is generated based on the interface name and | |
284 | the | |
285 | <citerefentry><refentrytitle>machine-id</refentrytitle><manvolnum>5</manvolnum></citerefentry>. | |
ff9b60f3 | 286 | This key is not currently supported for |
798d3a52 ZJS |
287 | <literal>tun</literal> or <literal>tap</literal> devices. |
288 | </para> | |
289 | </listitem> | |
290 | </varlistentry> | |
291 | </variablelist> | |
292 | </refsect1> | |
293 | ||
3428fe07 SS |
294 | <refsect1> |
295 | <title>[Bridge] Section Options</title> | |
296 | ||
297 | <para>The <literal>[Bridge]</literal> section only applies for | |
298 | netdevs of kind <literal>bridge</literal>, and accepts the | |
a8eaaee7 | 299 | following keys:</para> |
3428fe07 SS |
300 | |
301 | <variablelist class='network-directives'> | |
302 | <varlistentry> | |
303 | <term><varname>HelloTimeSec=</varname></term> | |
304 | <listitem> | |
a8eaaee7 | 305 | <para>HelloTimeSec specifies the number of seconds between two hello packets |
3428fe07 SS |
306 | sent out by the root bridge and the designated bridges. Hello packets are |
307 | used to communicate information about the topology throughout the entire | |
308 | bridged local area network.</para> | |
309 | </listitem> | |
310 | </varlistentry> | |
311 | <varlistentry> | |
312 | <term><varname>MaxAgeSec=</varname></term> | |
313 | <listitem> | |
314 | <para>MaxAgeSec specifies the number of seconds of maximum message age. | |
315 | If the last seen (received) hello packet is more than this number of | |
316 | seconds old, the bridge in question will start the takeover procedure | |
317 | in attempt to become the Root Bridge itself.</para> | |
318 | </listitem> | |
319 | </varlistentry> | |
320 | <varlistentry> | |
321 | <term><varname>ForwardDelaySec=</varname></term> | |
322 | <listitem> | |
323 | <para>ForwardDelaySec specifies the number of seconds spent in each | |
324 | of the Listening and Learning states before the Forwarding state is entered.</para> | |
325 | </listitem> | |
326 | </varlistentry> | |
c7440e74 TJ |
327 | <varlistentry> |
328 | <term><varname>AgeingTimeSec=</varname></term> | |
329 | <listitem> | |
330 | <para>This specifies the number of seconds a MAC Address will be kept in | |
d23a0044 | 331 | the forwarding database after having a packet received from this MAC Address.</para> |
c7440e74 TJ |
332 | </listitem> |
333 | </varlistentry> | |
334 | <varlistentry> | |
335 | <term><varname>Priority=</varname></term> | |
336 | <listitem> | |
337 | <para>The priority of the bridge. An integer between 0 and 65535. A lower value | |
338 | means higher priority. The bridge having the lowest priority will be elected as root bridge.</para> | |
339 | </listitem> | |
340 | </varlistentry> | |
341 | <varlistentry> | |
342 | <term><varname>DefaultPVID=</varname></term> | |
343 | <listitem> | |
344 | <para>This specifies the default port VLAN ID of a newly attached bridge port.</para> | |
345 | </listitem> | |
346 | </varlistentry> | |
3fef7a3f SS |
347 | <varlistentry> |
348 | <term><varname>MulticastQuerier=</varname></term> | |
349 | <listitem> | |
350 | <para>A boolean. This setting controls the IFLA_BR_MCAST_QUERIER option in the kernel. | |
351 | If enabled, the kernel will send general ICMP queries from a zero source address. | |
352 | This feature should allow faster convergence on startup, but it causes some | |
353 | multicast-aware switches to misbehave and disrupt forwarding of multicast packets. | |
354 | When unset, the kernel's default setting applies. | |
355 | </para> | |
356 | </listitem> | |
357 | </varlistentry> | |
6df6d898 SS |
358 | <varlistentry> |
359 | <term><varname>MulticastSnooping=</varname></term> | |
360 | <listitem> | |
361 | <para>A boolean. This setting controls the IFLA_BR_MCAST_SNOOPING option in the kernel. | |
362 | If enabled, IGMP snooping monitors the Internet Group Management Protocol (IGMP) traffic | |
363 | between hosts and multicast routers. When unset, the kernel's default setting applies. | |
364 | </para> | |
365 | </listitem> | |
366 | </varlistentry> | |
c6f8d17d TJ |
367 | <varlistentry> |
368 | <term><varname>VLANFiltering=</varname></term> | |
369 | <listitem> | |
370 | <para>A boolean. This setting controls the IFLA_BR_VLAN_FILTERING option in the kernel. | |
371 | If enabled, the bridge will be started in VLAN-filtering mode. When unset, the kernel's | |
372 | default setting applies. | |
373 | </para> | |
374 | </listitem> | |
375 | </varlistentry> | |
b760a9af SS |
376 | <varlistentry> |
377 | <term><varname>STP=</varname></term> | |
378 | <listitem> | |
379 | <para>A boolean. This enables the bridge's Spanning Tree Protocol (STP). When unset, | |
380 | the kernel's default setting applies. | |
381 | </para> | |
382 | </listitem> | |
383 | </varlistentry> | |
3428fe07 | 384 | </variablelist> |
3428fe07 SS |
385 | </refsect1> |
386 | ||
798d3a52 ZJS |
387 | <refsect1> |
388 | <title>[VLAN] Section Options</title> | |
389 | ||
390 | <para>The <literal>[VLAN]</literal> section only applies for | |
391 | netdevs of kind <literal>vlan</literal>, and accepts the | |
392 | following key:</para> | |
393 | ||
394 | <variablelist class='network-directives'> | |
395 | <varlistentry> | |
396 | <term><varname>Id=</varname></term> | |
397 | <listitem> | |
398 | <para>The VLAN ID to use. An integer in the range 0–4094. | |
399 | This option is compulsory.</para> | |
400 | </listitem> | |
401 | </varlistentry> | |
402 | </variablelist> | |
403 | ||
404 | </refsect1> | |
405 | ||
406 | <refsect1> | |
407 | <title>[MACVLAN] Section Options</title> | |
408 | ||
409 | <para>The <literal>[MACVLAN]</literal> section only applies for | |
410 | netdevs of kind <literal>macvlan</literal>, and accepts the | |
411 | following key:</para> | |
412 | ||
413 | <variablelist class='network-directives'> | |
414 | <varlistentry> | |
415 | <term><varname>Mode=</varname></term> | |
416 | <listitem> | |
417 | <para>The MACVLAN mode to use. The supported options are | |
418 | <literal>private</literal>, | |
419 | <literal>vepa</literal>, | |
420 | <literal>bridge</literal>, and | |
421 | <literal>passthru</literal>. | |
422 | </para> | |
423 | </listitem> | |
424 | </varlistentry> | |
425 | </variablelist> | |
426 | ||
427 | </refsect1> | |
428 | ||
0371f2df SS |
429 | <refsect1> |
430 | <title>[MACVTAP] Section Options</title> | |
431 | ||
432 | <para>The <literal>[MACVTAP]</literal> section applies for | |
433 | netdevs of kind <literal>macvtap</literal> and accepts the | |
96d49011 | 434 | same key as <literal>[MACVLAN]</literal>.</para> |
0371f2df SS |
435 | |
436 | </refsect1> | |
437 | ||
798d3a52 ZJS |
438 | <refsect1> |
439 | <title>[IPVLAN] Section Options</title> | |
440 | ||
441 | <para>The <literal>[IPVLAN]</literal> section only applies for | |
442 | netdevs of kind <literal>ipvlan</literal>, and accepts the | |
443 | following key:</para> | |
444 | ||
445 | <variablelist class='network-directives'> | |
446 | <varlistentry> | |
447 | <term><varname>Mode=</varname></term> | |
448 | <listitem> | |
449 | <para>The IPVLAN mode to use. The supported options are | |
450 | <literal>L2</literal> and <literal>L3</literal>. | |
451 | </para> | |
452 | </listitem> | |
453 | </varlistentry> | |
454 | </variablelist> | |
455 | ||
456 | </refsect1> | |
457 | ||
458 | <refsect1> | |
459 | <title>[VXLAN] Section Options</title> | |
460 | <para>The <literal>[VXLAN]</literal> section only applies for | |
461 | netdevs of kind <literal>vxlan</literal>, and accepts the | |
462 | following keys:</para> | |
463 | ||
464 | <variablelist class='network-directives'> | |
465 | <varlistentry> | |
466 | <term><varname>Id=</varname></term> | |
467 | <listitem> | |
468 | <para>The VXLAN ID to use.</para> | |
469 | </listitem> | |
470 | </varlistentry> | |
471 | <varlistentry> | |
472 | <term><varname>Group=</varname></term> | |
473 | <listitem> | |
474 | <para>An assigned multicast group IP address.</para> | |
475 | </listitem> | |
476 | </varlistentry> | |
477 | <varlistentry> | |
478 | <term><varname>TOS=</varname></term> | |
479 | <listitem> | |
480 | <para>The Type Of Service byte value for a vxlan interface.</para> | |
481 | </listitem> | |
482 | </varlistentry> | |
483 | <varlistentry> | |
484 | <term><varname>TTL=</varname></term> | |
485 | <listitem> | |
486 | <para>A fixed Time To Live N on Virtual eXtensible Local | |
b938cb90 | 487 | Area Network packets. N is a number in the range 1–255. 0 |
798d3a52 ZJS |
488 | is a special value meaning that packets inherit the TTL |
489 | value.</para> | |
490 | </listitem> | |
491 | </varlistentry> | |
492 | <varlistentry> | |
493 | <term><varname>MacLearning=</varname></term> | |
494 | <listitem> | |
495 | <para>A boolean. When true, enables dynamic MAC learning | |
496 | to discover remote MAC addresses.</para> | |
497 | </listitem> | |
498 | </varlistentry> | |
499 | <varlistentry> | |
500 | <term><varname>FDBAgeingSec=</varname></term> | |
501 | <listitem> | |
502 | <para>The lifetime of Forwarding Database entry learnt by | |
b938cb90 | 503 | the kernel, in seconds.</para> |
798d3a52 ZJS |
504 | </listitem> |
505 | </varlistentry> | |
506 | <varlistentry> | |
3d276dd2 SS |
507 | <term><varname>MaximumFDBEntries=</varname></term> |
508 | <listitem> | |
509 | <para>Configures maximum number of FDB entries.</para> | |
510 | </listitem> | |
511 | </varlistentry> | |
798d3a52 ZJS |
512 | <varlistentry> |
513 | <term><varname>ARPProxy=</varname></term> | |
514 | <listitem> | |
7e3f4e7f SS |
515 | <para>A boolean. When true bridge-connected VXLAN tunnel endpoint |
516 | answers ARP requests from the local bridge on behalf of | |
517 | remote Distributed Overlay Virtual Ethernet (DOVE) clients.</para> | |
798d3a52 ZJS |
518 | </listitem> |
519 | </varlistentry> | |
520 | <varlistentry> | |
521 | <term><varname>L2MissNotification=</varname></term> | |
522 | <listitem> | |
523 | <para>A boolean. When true, enables netlink LLADDR miss | |
524 | notifications.</para> | |
525 | </listitem> | |
526 | </varlistentry> | |
527 | <varlistentry> | |
528 | <term><varname>L3MissNotification=</varname></term> | |
529 | <listitem> | |
a8eaaee7 | 530 | <para>A boolean. When true, enables netlink IP address miss |
798d3a52 ZJS |
531 | notifications.</para> |
532 | </listitem> | |
533 | </varlistentry> | |
534 | <varlistentry> | |
535 | <term><varname>RouteShortCircuit=</varname></term> | |
536 | <listitem> | |
a8eaaee7 | 537 | <para>A boolean. When true, route short circuiting is turned |
798d3a52 ZJS |
538 | on.</para> |
539 | </listitem> | |
540 | </varlistentry> | |
cffacc74 | 541 | <varlistentry> |
53c06862 | 542 | <term><varname>UDPChecksum=</varname></term> |
cffacc74 | 543 | <listitem> |
b938cb90 | 544 | <para>A boolean. When true, transmitting UDP checksums when doing VXLAN/IPv4 is turned on.</para> |
cffacc74 SS |
545 | </listitem> |
546 | </varlistentry> | |
547 | <varlistentry> | |
548 | <term><varname>UDP6ZeroChecksumTx=</varname></term> | |
549 | <listitem> | |
b938cb90 | 550 | <para>A boolean. When true, sending zero checksums in VXLAN/IPv6 is turned on.</para> |
cffacc74 SS |
551 | </listitem> |
552 | </varlistentry> | |
553 | <varlistentry> | |
53c06862 | 554 | <term><varname>UDP6ZeroChecksumRx=</varname></term> |
cffacc74 | 555 | <listitem> |
b938cb90 | 556 | <para>A boolean. When true, receiving zero checksums in VXLAN/IPv6 is turned on.</para> |
16441027 SS |
557 | </listitem> |
558 | </varlistentry> | |
559 | <varlistentry> | |
53c06862 | 560 | <term><varname>RemoteChecksumTx=</varname></term> |
16441027 SS |
561 | <listitem> |
562 | <para>A boolean. When true, remote transmit checksum offload of VXLAN is turned on.</para> | |
563 | </listitem> | |
564 | </varlistentry> | |
565 | <varlistentry> | |
53c06862 | 566 | <term><varname>RemoteChecksumRx=</varname></term> |
16441027 SS |
567 | <listitem> |
568 | <para>A boolean. When true, remote receive checksum offload in VXLAN is turned on.</para> | |
cffacc74 SS |
569 | </listitem> |
570 | </varlistentry> | |
8b414e52 SS |
571 | <varlistentry> |
572 | <term><varname>GroupPolicyExtension=</varname></term> | |
573 | <listitem> | |
b938cb90 JE |
574 | <para>A boolean. When true, it enables Group Policy VXLAN extension security label mechanism |
575 | across network peers based on VXLAN. For details about the Group Policy VXLAN, see the | |
8b414e52 SS |
576 | <ulink url="https://tools.ietf.org/html/draft-smith-vxlan-group-policy"> |
577 | VXLAN Group Policy </ulink> document. Defaults to false.</para> | |
578 | </listitem> | |
579 | </varlistentry> | |
ea0288d1 SS |
580 | <varlistentry> |
581 | <term><varname>DestinationPort=</varname></term> | |
582 | <listitem> | |
583 | <para>Configures the default destination UDP port on a per-device basis. | |
584 | If destination port is not specified then Linux kernel default will be used. | |
585 | Set destination port 4789 to get the IANA assigned value, | |
586 | and destination port 0 to get default values.</para> | |
587 | </listitem> | |
588 | </varlistentry> | |
589 | <varlistentry> | |
590 | <term><varname>PortRange=</varname></term> | |
591 | <listitem> | |
592 | <para>Configures VXLAN port range. VXLAN bases source | |
593 | UDP port based on flow to help the receiver to be able | |
594 | to load balance based on outer header flow. It | |
595 | restricts the port range to the normal UDP local | |
596 | ports, and allows overriding via configuration.</para> | |
597 | </listitem> | |
598 | </varlistentry> | |
798d3a52 ZJS |
599 | </variablelist> |
600 | </refsect1> | |
601 | <refsect1> | |
602 | <title>[Tunnel] Section Options</title> | |
603 | ||
604 | <para>The <literal>[Tunnel]</literal> section only applies for | |
605 | netdevs of kind | |
606 | <literal>ipip</literal>, | |
607 | <literal>sit</literal>, | |
608 | <literal>gre</literal>, | |
609 | <literal>gretap</literal>, | |
610 | <literal>ip6gre</literal>, | |
611 | <literal>ip6gretap</literal>, | |
5cc0748e SS |
612 | <literal>vti</literal>, |
613 | <literal>vti6</literal>, and | |
798d3a52 ZJS |
614 | <literal>ip6tnl</literal> and accepts |
615 | the following keys:</para> | |
616 | ||
617 | <variablelist class='network-directives'> | |
618 | <varlistentry> | |
619 | <term><varname>Local=</varname></term> | |
620 | <listitem> | |
621 | <para>A static local address for tunneled packets. It must | |
622 | be an address on another interface of this host.</para> | |
623 | </listitem> | |
624 | </varlistentry> | |
625 | <varlistentry> | |
626 | <term><varname>Remote=</varname></term> | |
627 | <listitem> | |
628 | <para>The remote endpoint of the tunnel.</para> | |
629 | </listitem> | |
630 | </varlistentry> | |
631 | <varlistentry> | |
632 | <term><varname>TOS=</varname></term> | |
633 | <listitem> | |
634 | <para>The Type Of Service byte value for a tunnel interface. | |
b938cb90 | 635 | For details about the TOS, see the |
798d3a52 ZJS |
636 | <ulink url="http://tools.ietf.org/html/rfc1349"> Type of |
637 | Service in the Internet Protocol Suite </ulink> document. | |
638 | </para> | |
639 | </listitem> | |
640 | </varlistentry> | |
641 | <varlistentry> | |
642 | <term><varname>TTL=</varname></term> | |
643 | <listitem> | |
644 | <para>A fixed Time To Live N on tunneled packets. N is a | |
b938cb90 | 645 | number in the range 1–255. 0 is a special value meaning that |
798d3a52 | 646 | packets inherit the TTL value. The default value for IPv4 |
b938cb90 | 647 | tunnels is: inherit. The default value for IPv6 tunnels is |
798d3a52 ZJS |
648 | 64.</para> |
649 | </listitem> | |
650 | </varlistentry> | |
651 | <varlistentry> | |
652 | <term><varname>DiscoverPathMTU=</varname></term> | |
653 | <listitem> | |
654 | <para>A boolean. When true, enables Path MTU Discovery on | |
655 | the tunnel.</para> | |
656 | </listitem> | |
657 | </varlistentry> | |
276de526 SS |
658 | <varlistentry> |
659 | <term><varname>IPv6FlowLabel=</varname></term> | |
660 | <listitem> | |
a8eaaee7 | 661 | <para>Configures the 20-bit flow label (see <ulink url="https://tools.ietf.org/html/rfc6437"> |
276de526 | 662 | RFC 6437</ulink>) field in the IPv6 header (see <ulink url="https://tools.ietf.org/html/rfc2460"> |
a8eaaee7 JE |
663 | RFC 2460</ulink>), which is used by a node to label packets of a flow. |
664 | It is only used for IPv6 tunnels. | |
665 | A flow label of zero is used to indicate packets that have | |
666 | not been labeled. | |
667 | It can be configured to a value in the range 0–0xFFFFF, or be | |
668 | set to <literal>inherit</literal>, in which case the original flowlabel is used.</para> | |
276de526 SS |
669 | </listitem> |
670 | </varlistentry> | |
9b0ca30a | 671 | <varlistentry> |
a9b70f9d | 672 | <term><varname>CopyDSCP=</varname></term> |
9b0ca30a | 673 | <listitem> |
3cf4bcab ZJS |
674 | <para>A boolean. When true, the Differentiated Service Code |
675 | Point (DSCP) field will be copied to the inner header from | |
a9b70f9d | 676 | outer header during the decapsulation of an IPv6 tunnel |
3cf4bcab ZJS |
677 | packet. DSCP is a field in an IP packet that enables different |
678 | levels of service to be assigned to network traffic. | |
679 | Defaults to <literal>no</literal>. | |
9b0ca30a SS |
680 | </para> |
681 | </listitem> | |
682 | </varlistentry> | |
dae398a8 SS |
683 | <varlistentry> |
684 | <term><varname>EncapsulationLimit=</varname></term> | |
685 | <listitem> | |
686 | <para>The Tunnel Encapsulation Limit option specifies how many additional | |
687 | levels of encapsulation are permitted to be prepended to the packet. | |
688 | For example, a Tunnel Encapsulation Limit option containing a limit | |
689 | value of zero means that a packet carrying that option may not enter | |
690 | another tunnel before exiting the current tunnel. | |
691 | (see <ulink url="https://tools.ietf.org/html/rfc2473#section-4.1.1"> RFC 2473</ulink>). | |
b938cb90 | 692 | The valid range is 0–255 and <literal>none</literal>. Defaults to 4. |
dae398a8 SS |
693 | </para> |
694 | </listitem> | |
695 | </varlistentry> | |
1d710029 SS |
696 | <varlistentry> |
697 | <term><varname>Key=</varname></term> | |
698 | <listitem> | |
699 | <para>The <varname>Key=</varname> parameter specifies the same key to use in | |
700 | both directions (<varname>InputKey=</varname> and <varname>OutputKey=</varname>). | |
701 | The <varname>Key=</varname> is either a number or an IPv4 address-like dotted quad. | |
702 | It is used as mark-configured SAD/SPD entry as part of the lookup key (both in data | |
703 | and control path) in ip xfrm (framework used to implement IPsec protocol). | |
704 | See <ulink url="http://man7.org/linux/man-pages/man8/ip-xfrm.8.html"> | |
e306f2df | 705 | ip-xfrm — transform configuration</ulink> for details. It is only used for VTI/VTI6 |
1d710029 SS |
706 | tunnels.</para> |
707 | </listitem> | |
708 | </varlistentry> | |
709 | <varlistentry> | |
710 | <term><varname>InputKey=</varname></term> | |
711 | <listitem> | |
712 | <para>The <varname>InputKey=</varname> parameter specifies the key to use for input. | |
713 | The format is same as <varname>Key=</varname>. It is only used for VTI/VTI6 tunnels.</para> | |
714 | </listitem> | |
715 | </varlistentry> | |
716 | <varlistentry> | |
717 | <term><varname>OutputKey=</varname></term> | |
718 | <listitem> | |
719 | <para>The <varname>OutputKey=</varname> parameter specifies the key to use for output. | |
720 | The format is same as <varname>Key=</varname>. It is only used for VTI/VTI6 tunnels.</para> | |
721 | </listitem> | |
722 | </varlistentry> | |
798d3a52 ZJS |
723 | <varlistentry> |
724 | <term><varname>Mode=</varname></term> | |
725 | <listitem> | |
a8eaaee7 | 726 | <para>An <literal>ip6tnl</literal> tunnel can be in one of three |
798d3a52 ZJS |
727 | modes |
728 | <literal>ip6ip6</literal> for IPv6 over IPv6, | |
729 | <literal>ipip6</literal> for IPv4 over IPv6 or | |
730 | <literal>any</literal> for either. | |
731 | </para> | |
732 | </listitem> | |
733 | </varlistentry> | |
734 | </variablelist> | |
735 | </refsect1> | |
736 | <refsect1> | |
737 | <title>[Peer] Section Options</title> | |
738 | ||
739 | <para>The <literal>[Peer]</literal> section only applies for | |
740 | netdevs of kind <literal>veth</literal> and accepts the | |
a8eaaee7 | 741 | following keys:</para> |
798d3a52 ZJS |
742 | |
743 | <variablelist class='network-directives'> | |
744 | <varlistentry> | |
745 | <term><varname>Name=</varname></term> | |
746 | <listitem> | |
747 | <para>The interface name used when creating the netdev. | |
748 | This option is compulsory.</para> | |
749 | </listitem> | |
750 | </varlistentry> | |
751 | <varlistentry> | |
752 | <term><varname>MACAddress=</varname></term> | |
753 | <listitem> | |
b938cb90 | 754 | <para>The peer MACAddress, if not set, it is generated in |
798d3a52 ZJS |
755 | the same way as the MAC address of the main |
756 | interface.</para> | |
757 | </listitem> | |
758 | </varlistentry> | |
759 | </variablelist> | |
760 | </refsect1> | |
761 | <refsect1> | |
762 | <title>[Tun] Section Options</title> | |
763 | ||
764 | <para>The <literal>[Tun]</literal> section only applies for | |
765 | netdevs of kind <literal>tun</literal>, and accepts the following | |
766 | keys:</para> | |
767 | ||
768 | <variablelist class='network-directives'> | |
769 | <varlistentry> | |
770 | <term><varname>OneQueue=</varname></term> | |
771 | <listitem><para>Takes a boolean argument. Configures whether | |
772 | all packets are queued at the device (enabled), or a fixed | |
773 | number of packets are queued at the device and the rest at the | |
774 | <literal>qdisc</literal>. Defaults to | |
775 | <literal>no</literal>.</para> | |
776 | </listitem> | |
777 | </varlistentry> | |
778 | <varlistentry> | |
779 | <term><varname>MultiQueue=</varname></term> | |
780 | <listitem><para>Takes a boolean argument. Configures whether | |
781 | to use multiple file descriptors (queues) to parallelize | |
782 | packets sending and receiving. Defaults to | |
783 | <literal>no</literal>.</para> | |
784 | </listitem> | |
785 | </varlistentry> | |
786 | <varlistentry> | |
787 | <term><varname>PacketInfo=</varname></term> | |
788 | <listitem><para>Takes a boolean argument. Configures whether | |
ff9b60f3 | 789 | packets should be prepended with four extra bytes (two flag |
b938cb90 | 790 | bytes and two protocol bytes). If disabled, it indicates that |
798d3a52 ZJS |
791 | the packets will be pure IP packets. Defaults to |
792 | <literal>no</literal>.</para> | |
793 | </listitem> | |
794 | </varlistentry> | |
43f78da4 | 795 | <varlistentry> |
2aba142e | 796 | <term><varname>VNetHeader=</varname></term> |
43f78da4 SS |
797 | <listitem><para>Takes a boolean argument. Configures |
798 | IFF_VNET_HDR flag for a tap device. It allows sending | |
799 | and receiving larger Generic Segmentation Offload (GSO) | |
800 | packets. This may increase throughput significantly. | |
801 | Defaults to | |
802 | <literal>no</literal>.</para> | |
803 | </listitem> | |
804 | </varlistentry> | |
798d3a52 ZJS |
805 | <varlistentry> |
806 | <term><varname>User=</varname></term> | |
807 | <listitem><para>User to grant access to the | |
808 | <filename>/dev/net/tun</filename> device.</para> | |
809 | </listitem> | |
810 | </varlistentry> | |
811 | <varlistentry> | |
812 | <term><varname>Group=</varname></term> | |
813 | <listitem><para>Group to grant access to the | |
814 | <filename>/dev/net/tun</filename> device.</para> | |
815 | </listitem> | |
816 | </varlistentry> | |
817 | ||
818 | </variablelist> | |
819 | ||
820 | </refsect1> | |
821 | ||
822 | <refsect1> | |
823 | <title>[Tap] Section Options</title> | |
824 | ||
825 | <para>The <literal>[Tap]</literal> section only applies for | |
826 | netdevs of kind <literal>tap</literal>, and accepts the same keys | |
827 | as the <literal>[Tun]</literal> section.</para> | |
828 | </refsect1> | |
829 | ||
830 | <refsect1> | |
831 | <title>[Bond] Section Options</title> | |
832 | ||
833 | <para>The <literal>[Bond]</literal> section accepts the following | |
834 | key:</para> | |
835 | ||
836 | <variablelist class='network-directives'> | |
837 | <varlistentry> | |
838 | <term><varname>Mode=</varname></term> | |
839 | <listitem> | |
840 | <para>Specifies one of the bonding policies. The default is | |
841 | <literal>balance-rr</literal> (round robin). Possible values are | |
842 | <literal>balance-rr</literal>, | |
843 | <literal>active-backup</literal>, | |
844 | <literal>balance-xor</literal>, | |
845 | <literal>broadcast</literal>, | |
846 | <literal>802.3ad</literal>, | |
847 | <literal>balance-tlb</literal>, and | |
848 | <literal>balance-alb</literal>. | |
849 | </para> | |
850 | </listitem> | |
851 | </varlistentry> | |
852 | ||
853 | <varlistentry> | |
854 | <term><varname>TransmitHashPolicy=</varname></term> | |
855 | <listitem> | |
856 | <para>Selects the transmit hash policy to use for slave | |
857 | selection in balance-xor, 802.3ad, and tlb modes. Possible | |
858 | values are | |
859 | <literal>layer2</literal>, | |
860 | <literal>layer3+4</literal>, | |
861 | <literal>layer2+3</literal>, | |
4d89618a | 862 | <literal>encap2+3</literal>, and |
798d3a52 ZJS |
863 | <literal>encap3+4</literal>. |
864 | </para> | |
865 | </listitem> | |
866 | </varlistentry> | |
867 | ||
868 | <varlistentry> | |
869 | <term><varname>LACPTransmitRate=</varname></term> | |
870 | <listitem> | |
871 | <para>Specifies the rate with which link partner transmits | |
872 | Link Aggregation Control Protocol Data Unit packets in | |
873 | 802.3ad mode. Possible values are <literal>slow</literal>, | |
874 | which requests partner to transmit LACPDUs every 30 seconds, | |
875 | and <literal>fast</literal>, which requests partner to | |
876 | transmit LACPDUs every second. The default value is | |
877 | <literal>slow</literal>.</para> | |
878 | </listitem> | |
879 | </varlistentry> | |
880 | ||
881 | <varlistentry> | |
882 | <term><varname>MIIMonitorSec=</varname></term> | |
883 | <listitem> | |
884 | <para>Specifies the frequency that Media Independent | |
885 | Interface link monitoring will occur. A value of zero | |
dd2b607b | 886 | disables MII link monitoring. This value is rounded down to |
798d3a52 ZJS |
887 | the nearest millisecond. The default value is 0.</para> |
888 | </listitem> | |
889 | </varlistentry> | |
890 | ||
891 | <varlistentry> | |
892 | <term><varname>UpDelaySec=</varname></term> | |
893 | <listitem> | |
894 | <para>Specifies the delay before a link is enabled after a | |
895 | link up status has been detected. This value is rounded down | |
896 | to a multiple of MIIMonitorSec. The default value is | |
897 | 0.</para> | |
898 | </listitem> | |
899 | </varlistentry> | |
900 | ||
901 | <varlistentry> | |
902 | <term><varname>DownDelaySec=</varname></term> | |
903 | <listitem> | |
904 | <para>Specifies the delay before a link is disabled after a | |
905 | link down status has been detected. This value is rounded | |
906 | down to a multiple of MIIMonitorSec. The default value is | |
907 | 0.</para> | |
908 | </listitem> | |
909 | </varlistentry> | |
910 | ||
81bd37a8 | 911 | <varlistentry> |
38422da7 | 912 | <term><varname>LearnPacketIntervalSec=</varname></term> |
81bd37a8 SS |
913 | <listitem> |
914 | <para>Specifies the number of seconds between instances where the bonding | |
a8eaaee7 JE |
915 | driver sends learning packets to each slave peer switch. |
916 | The valid range is 1–0x7fffffff; the default value is 1. This option | |
917 | has an effect only for the balance-tlb and balance-alb modes.</para> | |
81bd37a8 SS |
918 | </listitem> |
919 | </varlistentry> | |
920 | ||
921 | <varlistentry> | |
922 | <term><varname>AdSelect=</varname></term> | |
923 | <listitem> | |
924 | <para>Specifies the 802.3ad aggregation selection logic to use. Possible values are | |
925 | <literal>stable</literal>, | |
a8eaaee7 JE |
926 | <literal>bandwidth</literal> and |
927 | <literal>count</literal>. | |
81bd37a8 SS |
928 | </para> |
929 | </listitem> | |
930 | </varlistentry> | |
931 | ||
932 | <varlistentry> | |
38422da7 | 933 | <term><varname>FailOverMACPolicy=</varname></term> |
81bd37a8 | 934 | <listitem> |
a8eaaee7 JE |
935 | <para>Specifies whether the active-backup mode should set all slaves to |
936 | the same MAC address at the time of enslavement or, when enabled, to perform special handling of the | |
81bd37a8 SS |
937 | bond's MAC address in accordance with the selected policy. The default policy is none. |
938 | Possible values are | |
939 | <literal>none</literal>, | |
a8eaaee7 JE |
940 | <literal>active</literal> and |
941 | <literal>follow</literal>. | |
81bd37a8 SS |
942 | </para> |
943 | </listitem> | |
944 | </varlistentry> | |
945 | ||
946 | <varlistentry> | |
38422da7 | 947 | <term><varname>ARPValidate=</varname></term> |
81bd37a8 SS |
948 | <listitem> |
949 | <para>Specifies whether or not ARP probes and replies should be | |
38422da7 | 950 | validated in any mode that supports ARP monitoring, or whether |
81bd37a8 SS |
951 | non-ARP traffic should be filtered (disregarded) for link |
952 | monitoring purposes. Possible values are | |
953 | <literal>none</literal>, | |
954 | <literal>active</literal>, | |
a8eaaee7 JE |
955 | <literal>backup</literal> and |
956 | <literal>all</literal>. | |
81bd37a8 SS |
957 | </para> |
958 | </listitem> | |
959 | </varlistentry> | |
960 | ||
961 | <varlistentry> | |
38422da7 | 962 | <term><varname>ARPIntervalSec=</varname></term> |
81bd37a8 SS |
963 | <listitem> |
964 | <para>Specifies the ARP link monitoring frequency in milliseconds. | |
965 | A value of 0 disables ARP monitoring. The default value is 0. | |
966 | </para> | |
967 | </listitem> | |
968 | </varlistentry> | |
969 | ||
970 | <varlistentry> | |
38422da7 | 971 | <term><varname>ARPIPTargets=</varname></term> |
81bd37a8 SS |
972 | <listitem> |
973 | <para>Specifies the IP addresses to use as ARP monitoring peers when | |
38422da7 | 974 | ARPIntervalSec is greater than 0. These are the targets of the ARP request |
81bd37a8 | 975 | sent to determine the health of the link to the targets. |
a8eaaee7 | 976 | Specify these values in IPv4 dotted decimal format. At least one IP |
81bd37a8 SS |
977 | address must be given for ARP monitoring to function. The |
978 | maximum number of targets that can be specified is 16. The | |
979 | default value is no IP addresses. | |
980 | </para> | |
981 | </listitem> | |
982 | </varlistentry> | |
983 | ||
984 | <varlistentry> | |
38422da7 | 985 | <term><varname>ARPAllTargets=</varname></term> |
81bd37a8 | 986 | <listitem> |
38422da7 | 987 | <para>Specifies the quantity of ARPIPTargets that must be reachable |
81bd37a8 SS |
988 | in order for the ARP monitor to consider a slave as being up. |
989 | This option affects only active-backup mode for slaves with | |
38422da7 | 990 | ARPValidate enabled. Possible values are |
a8eaaee7 JE |
991 | <literal>any</literal> and |
992 | <literal>all</literal>. | |
81bd37a8 SS |
993 | </para> |
994 | </listitem> | |
995 | </varlistentry> | |
996 | ||
997 | <varlistentry> | |
38422da7 | 998 | <term><varname>PrimaryReselectPolicy=</varname></term> |
81bd37a8 SS |
999 | <listitem> |
1000 | <para>Specifies the reselection policy for the primary slave. This | |
1001 | affects how the primary slave is chosen to become the active slave | |
1002 | when failure of the active slave or recovery of the primary slave | |
1003 | occurs. This option is designed to prevent flip-flopping between | |
1004 | the primary slave and other slaves. Possible values are | |
1005 | <literal>always</literal>, | |
a8eaaee7 JE |
1006 | <literal>better</literal> and |
1007 | <literal>failure</literal>. | |
81bd37a8 SS |
1008 | </para> |
1009 | </listitem> | |
1010 | </varlistentry> | |
1011 | ||
1012 | <varlistentry> | |
1013 | <term><varname>ResendIGMP=</varname></term> | |
1014 | <listitem> | |
1015 | <para>Specifies the number of IGMP membership reports to be issued after | |
1016 | a failover event. One membership report is issued immediately after | |
1017 | the failover, subsequent packets are sent in each 200ms interval. | |
b938cb90 | 1018 | The valid range is 0–255. Defaults to 1. A value of 0 |
81bd37a8 SS |
1019 | prevents the IGMP membership report from being issued in response |
1020 | to the failover event. | |
1021 | </para> | |
1022 | </listitem> | |
1023 | </varlistentry> | |
1024 | ||
1025 | <varlistentry> | |
1026 | <term><varname>PacketsPerSlave=</varname></term> | |
1027 | <listitem> | |
b938cb90 JE |
1028 | <para>Specify the number of packets to transmit through a slave before |
1029 | moving to the next one. When set to 0, then a slave is chosen at | |
1030 | random. The valid range is 0–65535. Defaults to 1. This option | |
a8eaaee7 | 1031 | only has effect when in balance-rr mode. |
81bd37a8 SS |
1032 | </para> |
1033 | </listitem> | |
1034 | </varlistentry> | |
1035 | ||
1036 | <varlistentry> | |
38422da7 | 1037 | <term><varname>GratuitousARP=</varname></term> |
81bd37a8 SS |
1038 | <listitem> |
1039 | <para>Specify the number of peer notifications (gratuitous ARPs and | |
1040 | unsolicited IPv6 Neighbor Advertisements) to be issued after a | |
b938cb90 | 1041 | failover event. As soon as the link is up on the new slave, |
81bd37a8 SS |
1042 | a peer notification is sent on the bonding device and each |
1043 | VLAN sub-device. This is repeated at each link monitor interval | |
38422da7 | 1044 | (ARPIntervalSec or MIIMonitorSec, whichever is active) if the number is |
a8eaaee7 | 1045 | greater than 1. The valid range is 0–255. The default value is 1. |
38422da7 | 1046 | These options affect only the active-backup mode. |
81bd37a8 SS |
1047 | </para> |
1048 | </listitem> | |
1049 | </varlistentry> | |
1050 | ||
1051 | <varlistentry> | |
1052 | <term><varname>AllSlavesActive=</varname></term> | |
1053 | <listitem> | |
a8eaaee7 JE |
1054 | <para>A boolean. Specifies that duplicate frames (received on inactive ports) |
1055 | should be dropped when false, or delivered when true. Normally, bonding will drop | |
81bd37a8 SS |
1056 | duplicate frames (received on inactive ports), which is desirable for |
1057 | most users. But there are some times it is nice to allow duplicate | |
1058 | frames to be delivered. The default value is false (drop duplicate frames | |
1059 | received on inactive ports). | |
1060 | </para> | |
1061 | </listitem> | |
1062 | </varlistentry> | |
1063 | ||
1064 | <varlistentry> | |
1065 | <term><varname>MinLinks=</varname></term> | |
1066 | <listitem> | |
1067 | <para>Specifies the minimum number of links that must be active before | |
1068 | asserting carrier. The default value is 0. | |
1069 | </para> | |
1070 | </listitem> | |
1071 | </varlistentry> | |
1072 | ||
798d3a52 | 1073 | </variablelist> |
81bd37a8 SS |
1074 | |
1075 | <para>For more detail information see | |
1076 | <ulink url="https://www.kernel.org/doc/Documentation/networking/bonding.txt"> | |
1077 | Linux Ethernet Bonding Driver HOWTO</ulink></para> | |
1078 | ||
798d3a52 ZJS |
1079 | </refsect1> |
1080 | ||
1081 | <refsect1> | |
1082 | <title>Example</title> | |
1083 | <example> | |
6c1695be | 1084 | <title>/etc/systemd/network/25-bridge.netdev</title> |
798d3a52 ZJS |
1085 | |
1086 | <programlisting>[NetDev] | |
eac684ef TG |
1087 | Name=bridge0 |
1088 | Kind=bridge</programlisting> | |
798d3a52 | 1089 | </example> |
eac684ef | 1090 | |
798d3a52 | 1091 | <example> |
6c1695be | 1092 | <title>/etc/systemd/network/25-vlan1.netdev</title> |
eac684ef | 1093 | |
798d3a52 | 1094 | <programlisting>[Match] |
eac684ef TG |
1095 | Virtualization=no |
1096 | ||
1097 | [NetDev] | |
1098 | Name=vlan1 | |
1099 | Kind=vlan | |
1100 | ||
1101 | [VLAN] | |
1102 | Id=1</programlisting> | |
798d3a52 ZJS |
1103 | </example> |
1104 | <example> | |
6c1695be | 1105 | <title>/etc/systemd/network/25-ipip.netdev</title> |
798d3a52 | 1106 | <programlisting>[NetDev] |
b35a2909 TG |
1107 | Name=ipip-tun |
1108 | Kind=ipip | |
1109 | MTUBytes=1480 | |
1110 | ||
1111 | [Tunnel] | |
1112 | Local=192.168.223.238 | |
1113 | Remote=192.169.224.239 | |
1114 | TTL=64</programlisting> | |
798d3a52 ZJS |
1115 | </example> |
1116 | <example> | |
6c1695be | 1117 | <title>/etc/systemd/network/25-tap.netdev</title> |
798d3a52 | 1118 | <programlisting>[NetDev] |
30ae9dfd SS |
1119 | Name=tap-test |
1120 | Kind=tap | |
1121 | ||
1122 | [Tap] | |
1123 | MultiQueue=true | |
1124 | PacketInfo=true</programlisting> </example> | |
eac684ef | 1125 | |
798d3a52 | 1126 | <example> |
6c1695be | 1127 | <title>/etc/systemd/network/25-sit.netdev</title> |
798d3a52 | 1128 | <programlisting>[NetDev] |
b35a2909 TG |
1129 | Name=sit-tun |
1130 | Kind=sit | |
1131 | MTUBytes=1480 | |
1132 | ||
1133 | [Tunnel] | |
1134 | Local=10.65.223.238 | |
1135 | Remote=10.65.223.239</programlisting> | |
798d3a52 | 1136 | </example> |
eac684ef | 1137 | |
798d3a52 | 1138 | <example> |
6c1695be | 1139 | <title>/etc/systemd/network/25-gre.netdev</title> |
798d3a52 | 1140 | <programlisting>[NetDev] |
b35a2909 TG |
1141 | Name=gre-tun |
1142 | Kind=gre | |
1143 | MTUBytes=1480 | |
1144 | ||
1145 | [Tunnel] | |
1146 | Local=10.65.223.238 | |
1147 | Remote=10.65.223.239</programlisting> | |
798d3a52 | 1148 | </example> |
b35a2909 | 1149 | |
798d3a52 | 1150 | <example> |
6c1695be | 1151 | <title>/etc/systemd/network/25-vti.netdev</title> |
b35a2909 | 1152 | |
798d3a52 | 1153 | <programlisting>[NetDev] |
b35a2909 TG |
1154 | Name=vti-tun |
1155 | Kind=vti | |
1156 | MTUBytes=1480 | |
1157 | ||
1158 | [Tunnel] | |
1159 | Local=10.65.223.238 | |
1160 | Remote=10.65.223.239</programlisting> | |
798d3a52 | 1161 | </example> |
b35a2909 | 1162 | |
798d3a52 | 1163 | <example> |
6c1695be | 1164 | <title>/etc/systemd/network/25-veth.netdev</title> |
798d3a52 | 1165 | <programlisting>[NetDev] |
b35a2909 TG |
1166 | Name=veth-test |
1167 | Kind=veth | |
1168 | ||
1169 | [Peer] | |
1170 | Name=veth-peer</programlisting> | |
798d3a52 | 1171 | </example> |
b35a2909 | 1172 | |
d94facdc | 1173 | <example> |
6c1695be | 1174 | <title>/etc/systemd/network/25-bond.netdev</title> |
d94facdc MH |
1175 | <programlisting>[NetDev] |
1176 | Name=bond1 | |
1177 | Kind=bond | |
1178 | ||
1179 | [Bond] | |
1180 | Mode=802.3ad | |
1181 | TransmitHashPolicy=layer3+4 | |
1182 | MIIMonitorSec=1s | |
1183 | LACPTransmitRate=fast | |
1184 | </programlisting> | |
1185 | </example> | |
1186 | ||
798d3a52 | 1187 | <example> |
6c1695be | 1188 | <title>/etc/systemd/network/25-dummy.netdev</title> |
798d3a52 | 1189 | <programlisting>[NetDev] |
9e358851 TG |
1190 | Name=dummy-test |
1191 | Kind=dummy | |
1192 | MACAddress=12:34:56:78:9a:bc</programlisting> | |
798d3a52 | 1193 | </example> |
20897a0d AR |
1194 | <example> |
1195 | <title>/etc/systemd/network/25-vrf.netdev</title> | |
037a3ded | 1196 | <para>Create a VRF interface with table 42.</para> |
20897a0d AR |
1197 | <programlisting>[NetDev] |
1198 | Name=vrf-test | |
1199 | Kind=vrf | |
798d3a52 | 1200 | |
20897a0d AR |
1201 | [VRF] |
1202 | TableId=42</programlisting> | |
1203 | </example> | |
798d3a52 ZJS |
1204 | </refsect1> |
1205 | <refsect1> | |
1206 | <title>See Also</title> | |
1207 | <para> | |
1208 | <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, | |
1209 | <citerefentry><refentrytitle>systemd-networkd</refentrytitle><manvolnum>8</manvolnum></citerefentry>, | |
1210 | <citerefentry><refentrytitle>systemd.link</refentrytitle><manvolnum>5</manvolnum></citerefentry>, | |
1211 | <citerefentry><refentrytitle>systemd.network</refentrytitle><manvolnum>5</manvolnum></citerefentry> | |
1212 | </para> | |
1213 | </refsect1> | |
eac684ef TG |
1214 | |
1215 | </refentry> |