]>
Commit | Line | Data |
---|---|---|
eac684ef TG |
1 | <?xml version='1.0'?> <!--*-nxml-*--> |
2 | <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" | |
798d3a52 | 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 | |
71 | <filename>/usr/lib/systemd/network</filename>, the volatile | |
72 | runtime network directory | |
73 | <filename>/run/systemd/network</filename> and the local | |
74 | administration network directory | |
75 | <filename>/etc/systemd/network</filename>. All configuration files | |
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 | |
81 | name in <filename>/usr/lib</filename>. This can be used to | |
82 | override a system-supplied configuration file with a local file if | |
83 | needed; a symlink in <filename>/etc</filename> with the same name | |
84 | as a configuration file in <filename>/usr/lib</filename>, pointing | |
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> | |
111 | <entry>A bridge devcie is a software switch, each of its slave devices and the bridge itself are ports of the switch.</entry></row> | |
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 | ||
158 | <row><entry><varname>vxlan</varname></entry> | |
159 | <entry>A virtual extensible LAN (vxlan), for connecting Cloud computing deployments.</entry></row> | |
160 | </tbody> | |
161 | </tgroup> | |
162 | </table> | |
163 | ||
164 | </refsect1> | |
165 | ||
166 | <refsect1> | |
167 | <title>[Match] Section Options</title> | |
168 | ||
169 | <para>A virtual network device is only created if the | |
170 | <literal>[Match]</literal> section matches the current | |
171 | environment, or if the section is empty. The following keys are | |
172 | accepted:</para> | |
173 | ||
174 | <variablelist class='network-directives'> | |
175 | <varlistentry> | |
176 | <term><varname>Host=</varname></term> | |
177 | <listitem> | |
178 | <para>Matches against the hostname or machine ID of the | |
179 | host. See <literal>ConditionHost=</literal> in | |
180 | <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry> | |
181 | for details. | |
182 | </para> | |
183 | </listitem> | |
184 | </varlistentry> | |
185 | <varlistentry> | |
186 | <term><varname>Virtualization=</varname></term> | |
187 | <listitem> | |
188 | <para>Checks whether the system is executed in a virtualized | |
189 | environment and optionally test whether it is a specific | |
190 | implementation. See | |
191 | <literal>ConditionVirtualization=</literal> in | |
192 | <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry> | |
193 | for details. | |
194 | </para> | |
195 | </listitem> | |
196 | </varlistentry> | |
197 | <varlistentry> | |
198 | <term><varname>KernelCommandLine=</varname></term> | |
199 | <listitem> | |
200 | <para>Checks whether a specific kernel command line option | |
201 | is set (or if prefixed with the exclamation mark unset). See | |
202 | <literal>ConditionKernelCommandLine=</literal> in | |
203 | <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry> | |
204 | for details. | |
205 | </para> | |
206 | </listitem> | |
207 | </varlistentry> | |
208 | <varlistentry> | |
209 | <term><varname>Architecture=</varname></term> | |
210 | <listitem> | |
211 | <para>Checks whether the system is running on a specific | |
212 | architecture. See <literal>ConditionArchitecture=</literal> in | |
213 | <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry> | |
214 | for details. | |
215 | </para> | |
216 | </listitem> | |
217 | </varlistentry> | |
218 | </variablelist> | |
219 | ||
220 | </refsect1> | |
221 | ||
222 | <refsect1> | |
223 | <title>[NetDev] Section Options</title> | |
224 | ||
225 | <para>The <literal>[NetDev]</literal> section accepts the | |
226 | following keys:</para> | |
227 | ||
228 | <variablelist class='network-directives'> | |
229 | <varlistentry> | |
230 | <term><varname>Description=</varname></term> | |
231 | <listitem> | |
232 | <para>A free-form description of the netdev.</para> | |
233 | </listitem> | |
234 | </varlistentry> | |
235 | <varlistentry> | |
236 | <term><varname>Name=</varname></term> | |
237 | <listitem> | |
238 | <para>The interface name used when creating the netdev. | |
239 | This option is compulsory.</para> | |
240 | </listitem> | |
241 | </varlistentry> | |
242 | <varlistentry> | |
243 | <term><varname>Kind=</varname></term> | |
244 | <listitem> | |
245 | <para>The netdev kind. This option is compulsory. See the | |
246 | <literal>Supported netdev kinds</literal> section for the | |
247 | valid keys.</para> | |
248 | </listitem> | |
249 | </varlistentry> | |
250 | <varlistentry> | |
251 | <term><varname>MTUBytes=</varname></term> | |
252 | <listitem> | |
253 | <para>The maximum transmission unit in bytes to set for | |
254 | the device. The usual suffixes K, M, G, are supported and | |
255 | are understood to the base of 1024. This key is not | |
256 | currently suported for <literal>tun</literal> or | |
257 | <literal>tap</literal> devices. | |
258 | </para> | |
259 | </listitem> | |
260 | </varlistentry> | |
261 | <varlistentry> | |
262 | <term><varname>MACAddress=</varname></term> | |
263 | <listitem> | |
264 | <para>The MAC address to use for the device. If none is | |
265 | given, one is generated based on the interface name and | |
266 | the | |
267 | <citerefentry><refentrytitle>machine-id</refentrytitle><manvolnum>5</manvolnum></citerefentry>. | |
268 | This key is not currently suported for | |
269 | <literal>tun</literal> or <literal>tap</literal> devices. | |
270 | </para> | |
271 | </listitem> | |
272 | </varlistentry> | |
273 | </variablelist> | |
274 | </refsect1> | |
275 | ||
276 | <refsect1> | |
277 | <title>[VLAN] Section Options</title> | |
278 | ||
279 | <para>The <literal>[VLAN]</literal> section only applies for | |
280 | netdevs of kind <literal>vlan</literal>, and accepts the | |
281 | following key:</para> | |
282 | ||
283 | <variablelist class='network-directives'> | |
284 | <varlistentry> | |
285 | <term><varname>Id=</varname></term> | |
286 | <listitem> | |
287 | <para>The VLAN ID to use. An integer in the range 0–4094. | |
288 | This option is compulsory.</para> | |
289 | </listitem> | |
290 | </varlistentry> | |
291 | </variablelist> | |
292 | ||
293 | </refsect1> | |
294 | ||
295 | <refsect1> | |
296 | <title>[MACVLAN] Section Options</title> | |
297 | ||
298 | <para>The <literal>[MACVLAN]</literal> section only applies for | |
299 | netdevs of kind <literal>macvlan</literal>, and accepts the | |
300 | following key:</para> | |
301 | ||
302 | <variablelist class='network-directives'> | |
303 | <varlistentry> | |
304 | <term><varname>Mode=</varname></term> | |
305 | <listitem> | |
306 | <para>The MACVLAN mode to use. The supported options are | |
307 | <literal>private</literal>, | |
308 | <literal>vepa</literal>, | |
309 | <literal>bridge</literal>, and | |
310 | <literal>passthru</literal>. | |
311 | </para> | |
312 | </listitem> | |
313 | </varlistentry> | |
314 | </variablelist> | |
315 | ||
316 | </refsect1> | |
317 | ||
318 | <refsect1> | |
319 | <title>[IPVLAN] Section Options</title> | |
320 | ||
321 | <para>The <literal>[IPVLAN]</literal> section only applies for | |
322 | netdevs of kind <literal>ipvlan</literal>, and accepts the | |
323 | following key:</para> | |
324 | ||
325 | <variablelist class='network-directives'> | |
326 | <varlistentry> | |
327 | <term><varname>Mode=</varname></term> | |
328 | <listitem> | |
329 | <para>The IPVLAN mode to use. The supported options are | |
330 | <literal>L2</literal> and <literal>L3</literal>. | |
331 | </para> | |
332 | </listitem> | |
333 | </varlistentry> | |
334 | </variablelist> | |
335 | ||
336 | </refsect1> | |
337 | ||
338 | <refsect1> | |
339 | <title>[VXLAN] Section Options</title> | |
340 | <para>The <literal>[VXLAN]</literal> section only applies for | |
341 | netdevs of kind <literal>vxlan</literal>, and accepts the | |
342 | following keys:</para> | |
343 | ||
344 | <variablelist class='network-directives'> | |
345 | <varlistentry> | |
346 | <term><varname>Id=</varname></term> | |
347 | <listitem> | |
348 | <para>The VXLAN ID to use.</para> | |
349 | </listitem> | |
350 | </varlistentry> | |
351 | <varlistentry> | |
352 | <term><varname>Group=</varname></term> | |
353 | <listitem> | |
354 | <para>An assigned multicast group IP address.</para> | |
355 | </listitem> | |
356 | </varlistentry> | |
357 | <varlistentry> | |
358 | <term><varname>TOS=</varname></term> | |
359 | <listitem> | |
360 | <para>The Type Of Service byte value for a vxlan interface.</para> | |
361 | </listitem> | |
362 | </varlistentry> | |
363 | <varlistentry> | |
364 | <term><varname>TTL=</varname></term> | |
365 | <listitem> | |
366 | <para>A fixed Time To Live N on Virtual eXtensible Local | |
367 | Area Network packets. N is a number in the range 1-255. 0 | |
368 | is a special value meaning that packets inherit the TTL | |
369 | value.</para> | |
370 | </listitem> | |
371 | </varlistentry> | |
372 | <varlistentry> | |
373 | <term><varname>MacLearning=</varname></term> | |
374 | <listitem> | |
375 | <para>A boolean. When true, enables dynamic MAC learning | |
376 | to discover remote MAC addresses.</para> | |
377 | </listitem> | |
378 | </varlistentry> | |
379 | <varlistentry> | |
380 | <term><varname>FDBAgeingSec=</varname></term> | |
381 | <listitem> | |
382 | <para>The lifetime of Forwarding Database entry learnt by | |
383 | the kernel in seconds.</para> | |
384 | </listitem> | |
385 | </varlistentry> | |
386 | <varlistentry> | |
387 | <term><varname>ARPProxy=</varname></term> | |
388 | <listitem> | |
389 | <para>A boolean. When true, enables ARP proxy.</para> | |
390 | </listitem> | |
391 | </varlistentry> | |
392 | <varlistentry> | |
393 | <term><varname>L2MissNotification=</varname></term> | |
394 | <listitem> | |
395 | <para>A boolean. When true, enables netlink LLADDR miss | |
396 | notifications.</para> | |
397 | </listitem> | |
398 | </varlistentry> | |
399 | <varlistentry> | |
400 | <term><varname>L3MissNotification=</varname></term> | |
401 | <listitem> | |
402 | <para>A boolean. When true, enables netlink IP ADDR miss | |
403 | notifications.</para> | |
404 | </listitem> | |
405 | </varlistentry> | |
406 | <varlistentry> | |
407 | <term><varname>RouteShortCircuit=</varname></term> | |
408 | <listitem> | |
409 | <para>A boolean. When true route short circuit is turned | |
410 | on.</para> | |
411 | </listitem> | |
412 | </varlistentry> | |
413 | </variablelist> | |
414 | </refsect1> | |
415 | <refsect1> | |
416 | <title>[Tunnel] Section Options</title> | |
417 | ||
418 | <para>The <literal>[Tunnel]</literal> section only applies for | |
419 | netdevs of kind | |
420 | <literal>ipip</literal>, | |
421 | <literal>sit</literal>, | |
422 | <literal>gre</literal>, | |
423 | <literal>gretap</literal>, | |
424 | <literal>ip6gre</literal>, | |
425 | <literal>ip6gretap</literal>, | |
426 | <literal>vti</literal>, and | |
427 | <literal>ip6tnl</literal> and accepts | |
428 | the following keys:</para> | |
429 | ||
430 | <variablelist class='network-directives'> | |
431 | <varlistentry> | |
432 | <term><varname>Local=</varname></term> | |
433 | <listitem> | |
434 | <para>A static local address for tunneled packets. It must | |
435 | be an address on another interface of this host.</para> | |
436 | </listitem> | |
437 | </varlistentry> | |
438 | <varlistentry> | |
439 | <term><varname>Remote=</varname></term> | |
440 | <listitem> | |
441 | <para>The remote endpoint of the tunnel.</para> | |
442 | </listitem> | |
443 | </varlistentry> | |
444 | <varlistentry> | |
445 | <term><varname>TOS=</varname></term> | |
446 | <listitem> | |
447 | <para>The Type Of Service byte value for a tunnel interface. | |
448 | For details about the TOS see the | |
449 | <ulink url="http://tools.ietf.org/html/rfc1349"> Type of | |
450 | Service in the Internet Protocol Suite </ulink> document. | |
451 | </para> | |
452 | </listitem> | |
453 | </varlistentry> | |
454 | <varlistentry> | |
455 | <term><varname>TTL=</varname></term> | |
456 | <listitem> | |
457 | <para>A fixed Time To Live N on tunneled packets. N is a | |
458 | number in the range 1-255. 0 is a special value meaning that | |
459 | packets inherit the TTL value. The default value for IPv4 | |
460 | tunnels is: inherit. The default value for IPv6 tunnels is: | |
461 | 64.</para> | |
462 | </listitem> | |
463 | </varlistentry> | |
464 | <varlistentry> | |
465 | <term><varname>DiscoverPathMTU=</varname></term> | |
466 | <listitem> | |
467 | <para>A boolean. When true, enables Path MTU Discovery on | |
468 | the tunnel.</para> | |
469 | </listitem> | |
470 | </varlistentry> | |
471 | <varlistentry> | |
472 | <term><varname>Mode=</varname></term> | |
473 | <listitem> | |
474 | <para>An <literal>ip6tnl</literal> tunnels can have three | |
475 | modes | |
476 | <literal>ip6ip6</literal> for IPv6 over IPv6, | |
477 | <literal>ipip6</literal> for IPv4 over IPv6 or | |
478 | <literal>any</literal> for either. | |
479 | </para> | |
480 | </listitem> | |
481 | </varlistentry> | |
482 | </variablelist> | |
483 | </refsect1> | |
484 | <refsect1> | |
485 | <title>[Peer] Section Options</title> | |
486 | ||
487 | <para>The <literal>[Peer]</literal> section only applies for | |
488 | netdevs of kind <literal>veth</literal> and accepts the | |
489 | following key:</para> | |
490 | ||
491 | <variablelist class='network-directives'> | |
492 | <varlistentry> | |
493 | <term><varname>Name=</varname></term> | |
494 | <listitem> | |
495 | <para>The interface name used when creating the netdev. | |
496 | This option is compulsory.</para> | |
497 | </listitem> | |
498 | </varlistentry> | |
499 | <varlistentry> | |
500 | <term><varname>MACAddress=</varname></term> | |
501 | <listitem> | |
502 | <para>The peer MACAddress, if not set it is generated in | |
503 | the same way as the MAC address of the main | |
504 | interface.</para> | |
505 | </listitem> | |
506 | </varlistentry> | |
507 | </variablelist> | |
508 | </refsect1> | |
509 | <refsect1> | |
510 | <title>[Tun] Section Options</title> | |
511 | ||
512 | <para>The <literal>[Tun]</literal> section only applies for | |
513 | netdevs of kind <literal>tun</literal>, and accepts the following | |
514 | keys:</para> | |
515 | ||
516 | <variablelist class='network-directives'> | |
517 | <varlistentry> | |
518 | <term><varname>OneQueue=</varname></term> | |
519 | <listitem><para>Takes a boolean argument. Configures whether | |
520 | all packets are queued at the device (enabled), or a fixed | |
521 | number of packets are queued at the device and the rest at the | |
522 | <literal>qdisc</literal>. Defaults to | |
523 | <literal>no</literal>.</para> | |
524 | </listitem> | |
525 | </varlistentry> | |
526 | <varlistentry> | |
527 | <term><varname>MultiQueue=</varname></term> | |
528 | <listitem><para>Takes a boolean argument. Configures whether | |
529 | to use multiple file descriptors (queues) to parallelize | |
530 | packets sending and receiving. Defaults to | |
531 | <literal>no</literal>.</para> | |
532 | </listitem> | |
533 | </varlistentry> | |
534 | <varlistentry> | |
535 | <term><varname>PacketInfo=</varname></term> | |
536 | <listitem><para>Takes a boolean argument. Configures whether | |
537 | packets should be prepened with four extra bytes (two flag | |
538 | bytes and two protocol bytes). If disabled it indicates that | |
539 | the packets will be pure IP packets. Defaults to | |
540 | <literal>no</literal>.</para> | |
541 | </listitem> | |
542 | </varlistentry> | |
543 | <varlistentry> | |
544 | <term><varname>User=</varname></term> | |
545 | <listitem><para>User to grant access to the | |
546 | <filename>/dev/net/tun</filename> device.</para> | |
547 | </listitem> | |
548 | </varlistentry> | |
549 | <varlistentry> | |
550 | <term><varname>Group=</varname></term> | |
551 | <listitem><para>Group to grant access to the | |
552 | <filename>/dev/net/tun</filename> device.</para> | |
553 | </listitem> | |
554 | </varlistentry> | |
555 | ||
556 | </variablelist> | |
557 | ||
558 | </refsect1> | |
559 | ||
560 | <refsect1> | |
561 | <title>[Tap] Section Options</title> | |
562 | ||
563 | <para>The <literal>[Tap]</literal> section only applies for | |
564 | netdevs of kind <literal>tap</literal>, and accepts the same keys | |
565 | as the <literal>[Tun]</literal> section.</para> | |
566 | </refsect1> | |
567 | ||
568 | <refsect1> | |
569 | <title>[Bond] Section Options</title> | |
570 | ||
571 | <para>The <literal>[Bond]</literal> section accepts the following | |
572 | key:</para> | |
573 | ||
574 | <variablelist class='network-directives'> | |
575 | <varlistentry> | |
576 | <term><varname>Mode=</varname></term> | |
577 | <listitem> | |
578 | <para>Specifies one of the bonding policies. The default is | |
579 | <literal>balance-rr</literal> (round robin). Possible values are | |
580 | <literal>balance-rr</literal>, | |
581 | <literal>active-backup</literal>, | |
582 | <literal>balance-xor</literal>, | |
583 | <literal>broadcast</literal>, | |
584 | <literal>802.3ad</literal>, | |
585 | <literal>balance-tlb</literal>, and | |
586 | <literal>balance-alb</literal>. | |
587 | </para> | |
588 | </listitem> | |
589 | </varlistentry> | |
590 | ||
591 | <varlistentry> | |
592 | <term><varname>TransmitHashPolicy=</varname></term> | |
593 | <listitem> | |
594 | <para>Selects the transmit hash policy to use for slave | |
595 | selection in balance-xor, 802.3ad, and tlb modes. Possible | |
596 | values are | |
597 | <literal>layer2</literal>, | |
598 | <literal>layer3+4</literal>, | |
599 | <literal>layer2+3</literal>, | |
600 | <literal>encap2+3</literal>, | |
601 | <literal>802.3ad</literal>, and | |
602 | <literal>encap3+4</literal>. | |
603 | </para> | |
604 | </listitem> | |
605 | </varlistentry> | |
606 | ||
607 | <varlistentry> | |
608 | <term><varname>LACPTransmitRate=</varname></term> | |
609 | <listitem> | |
610 | <para>Specifies the rate with which link partner transmits | |
611 | Link Aggregation Control Protocol Data Unit packets in | |
612 | 802.3ad mode. Possible values are <literal>slow</literal>, | |
613 | which requests partner to transmit LACPDUs every 30 seconds, | |
614 | and <literal>fast</literal>, which requests partner to | |
615 | transmit LACPDUs every second. The default value is | |
616 | <literal>slow</literal>.</para> | |
617 | </listitem> | |
618 | </varlistentry> | |
619 | ||
620 | <varlistentry> | |
621 | <term><varname>MIIMonitorSec=</varname></term> | |
622 | <listitem> | |
623 | <para>Specifies the frequency that Media Independent | |
624 | Interface link monitoring will occur. A value of zero | |
625 | disables MII link monitoring. This values is rounded down to | |
626 | the nearest millisecond. The default value is 0.</para> | |
627 | </listitem> | |
628 | </varlistentry> | |
629 | ||
630 | <varlistentry> | |
631 | <term><varname>UpDelaySec=</varname></term> | |
632 | <listitem> | |
633 | <para>Specifies the delay before a link is enabled after a | |
634 | link up status has been detected. This value is rounded down | |
635 | to a multiple of MIIMonitorSec. The default value is | |
636 | 0.</para> | |
637 | </listitem> | |
638 | </varlistentry> | |
639 | ||
640 | <varlistentry> | |
641 | <term><varname>DownDelaySec=</varname></term> | |
642 | <listitem> | |
643 | <para>Specifies the delay before a link is disabled after a | |
644 | link down status has been detected. This value is rounded | |
645 | down to a multiple of MIIMonitorSec. The default value is | |
646 | 0.</para> | |
647 | </listitem> | |
648 | </varlistentry> | |
649 | ||
650 | </variablelist> | |
651 | </refsect1> | |
652 | ||
653 | <refsect1> | |
654 | <title>Example</title> | |
655 | <example> | |
656 | <title>/etc/systemd/network/bridge.netdev</title> | |
657 | ||
658 | <programlisting>[NetDev] | |
eac684ef TG |
659 | Name=bridge0 |
660 | Kind=bridge</programlisting> | |
798d3a52 | 661 | </example> |
eac684ef | 662 | |
798d3a52 ZJS |
663 | <example> |
664 | <title>/etc/systemd/network/vlan1.netdev</title> | |
eac684ef | 665 | |
798d3a52 | 666 | <programlisting>[Match] |
eac684ef TG |
667 | Virtualization=no |
668 | ||
669 | [NetDev] | |
670 | Name=vlan1 | |
671 | Kind=vlan | |
672 | ||
673 | [VLAN] | |
674 | Id=1</programlisting> | |
798d3a52 ZJS |
675 | </example> |
676 | <example> | |
677 | <title>/etc/systemd/network/ipip.netdev</title> | |
678 | <programlisting>[NetDev] | |
b35a2909 TG |
679 | Name=ipip-tun |
680 | Kind=ipip | |
681 | MTUBytes=1480 | |
682 | ||
683 | [Tunnel] | |
684 | Local=192.168.223.238 | |
685 | Remote=192.169.224.239 | |
686 | TTL=64</programlisting> | |
798d3a52 ZJS |
687 | </example> |
688 | <example> | |
689 | <title>/etc/systemd/network/tap.netdev</title> | |
690 | <programlisting>[NetDev] | |
30ae9dfd SS |
691 | Name=tap-test |
692 | Kind=tap | |
693 | ||
694 | [Tap] | |
695 | MultiQueue=true | |
696 | PacketInfo=true</programlisting> </example> | |
eac684ef | 697 | |
798d3a52 ZJS |
698 | <example> |
699 | <title>/etc/systemd/network/sit.netdev</title> | |
700 | <programlisting>[NetDev] | |
b35a2909 TG |
701 | Name=sit-tun |
702 | Kind=sit | |
703 | MTUBytes=1480 | |
704 | ||
705 | [Tunnel] | |
706 | Local=10.65.223.238 | |
707 | Remote=10.65.223.239</programlisting> | |
798d3a52 | 708 | </example> |
eac684ef | 709 | |
798d3a52 ZJS |
710 | <example> |
711 | <title>/etc/systemd/network/gre.netdev</title> | |
712 | <programlisting>[NetDev] | |
b35a2909 TG |
713 | Name=gre-tun |
714 | Kind=gre | |
715 | MTUBytes=1480 | |
716 | ||
717 | [Tunnel] | |
718 | Local=10.65.223.238 | |
719 | Remote=10.65.223.239</programlisting> | |
798d3a52 | 720 | </example> |
b35a2909 | 721 | |
798d3a52 ZJS |
722 | <example> |
723 | <title>/etc/systemd/network/vti.netdev</title> | |
b35a2909 | 724 | |
798d3a52 | 725 | <programlisting>[NetDev] |
b35a2909 TG |
726 | Name=vti-tun |
727 | Kind=vti | |
728 | MTUBytes=1480 | |
729 | ||
730 | [Tunnel] | |
731 | Local=10.65.223.238 | |
732 | Remote=10.65.223.239</programlisting> | |
798d3a52 | 733 | </example> |
b35a2909 | 734 | |
798d3a52 ZJS |
735 | <example> |
736 | <title>/etc/systemd/network/veth.netdev</title> | |
737 | <programlisting>[NetDev] | |
b35a2909 TG |
738 | Name=veth-test |
739 | Kind=veth | |
740 | ||
741 | [Peer] | |
742 | Name=veth-peer</programlisting> | |
798d3a52 | 743 | </example> |
b35a2909 | 744 | |
798d3a52 ZJS |
745 | <example> |
746 | <title>/etc/systemd/network/dummy.netdev</title> | |
747 | <programlisting>[NetDev] | |
9e358851 TG |
748 | Name=dummy-test |
749 | Kind=dummy | |
750 | MACAddress=12:34:56:78:9a:bc</programlisting> | |
798d3a52 ZJS |
751 | </example> |
752 | ||
753 | </refsect1> | |
754 | <refsect1> | |
755 | <title>See Also</title> | |
756 | <para> | |
757 | <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, | |
758 | <citerefentry><refentrytitle>systemd-networkd</refentrytitle><manvolnum>8</manvolnum></citerefentry>, | |
759 | <citerefentry><refentrytitle>systemd.link</refentrytitle><manvolnum>5</manvolnum></citerefentry>, | |
760 | <citerefentry><refentrytitle>systemd.network</refentrytitle><manvolnum>5</manvolnum></citerefentry> | |
761 | </para> | |
762 | </refsect1> | |
eac684ef TG |
763 | |
764 | </refentry> |