]> git.ipfire.org Git - thirdparty/systemd.git/blame - man/systemd.netdev.xml
projects / thirdparty / systemd.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
networkd: introduce gretap
[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"
3 "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
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
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. Virtual
7c1cff4f
TG		 63 network devices are created as soon as networkd is started. If a netdev
64 with the specified name already exists, networkd will use that as-is
65 rather than create its own. Note that the settings of the pre-existing
66 netdev will not be changed by networkd.</para>
eac684ef
TG		 67
68 <para>The <filename>.netdev</filename> files are read from the files located in the
69 system network directory <filename>/usr/lib/systemd/network</filename>,
70 the volatile runtime network directory
71 <filename>/run/systemd/network</filename> and the local administration
72 network directory <filename>/etc/systemd/network</filename>.
73 All configuration files are collectively sorted and processed in lexical order,
74 regardless of the directories in which they live. However, files with
75 identical filenames replace each other. Files in
76 <filename>/etc</filename> have the highest priority, files in
77 <filename>/run</filename> take precedence over files with the same
78 name in <filename>/usr/lib</filename>. This can be used to override a
79 system-supplied configuration file with a local file if needed; a symlink in
80 <filename>/etc</filename> with the same name as a configuration file in
81 <filename>/usr/lib</filename>, pointing to <filename>/dev/null</filename>,
82 disables the configuration file entirely.</para>
83
102bd40e
LP		 84 </refsect1>
85
86 <refsect1>
87 <title>[Match] Section Options</title>
88
eac684ef
TG		 89 <para>A virtual network device is only created if the
90 <literal>[Match]</literal> section matches the current
91 environment, or if the section is empty. The following keys are accepted:</para>
92
93 <variablelist class='network-directives'>
94 <varlistentry>
95 <term><varname>Host=</varname></term>
96 <listitem>
97 <para>Matches against the hostname or machine ID of the
98 host. See <literal>ConditionHost=</literal> in
99 <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>
100 for details.
101 </para>
102 </listitem>
103 </varlistentry>
104 <varlistentry>
105 <term><varname>Virtualization=</varname></term>
106 <listitem>
107 <para>Checks whether the system is executed in a virtualized
108 environment and optionally test whether it is a specific
109 implementation. See <literal>ConditionVirtualization=</literal> in
110 <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>
111 for details.
112 </para>
113 </listitem>
114 </varlistentry>
115 <varlistentry>
116 <term><varname>KernelCommandLine=</varname></term>
117 <listitem>
118 <para>Checks whether a specific kernel command line option is
119 set (or if prefixed with the exclamation mark unset). See
120 <literal>ConditionKernelCommandLine=</literal> in
121 <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>
122 for details.
123 </para>
124 </listitem>
125 </varlistentry>
126 <varlistentry>
127 <term><varname>Architecture=</varname></term>
128 <listitem>
129 <para>Checks whether the system is running on a specific
130 architecture. See <literal>ConditionArchitecture=</literal> in
131 <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>
132 for details.
133 </para>
134 </listitem>
135 </varlistentry>
136 </variablelist>
137
102bd40e
LP		 138 </refsect1>
139
140 <refsect1>
141 <title>[NetDev] Section Options</title>
142
eac684ef
TG		 143 <para>The <literal>[NetDev]</literal> section accepts the following
144 keys:</para>
145
146 <variablelist class='network-directives'>
b35a2909
TG		 147 <varlistentry>
148 <term><varname>Description=</varname></term>
149 <listitem>
150 <para>A free-form description of the netdev.
151 </para>
152 </listitem>
153 </varlistentry>
eac684ef
TG		 154 <varlistentry>
155 <term><varname>Name=</varname></term>
156 <listitem>
157 <para>The interface name used when creating the
158 netdev. This option is compulsory.</para>
159 </listitem>
160 </varlistentry>
161 <varlistentry>
162 <term><varname>Kind=</varname></term>
163 <listitem>
164 <para>The netdev kind. Currently, <literal>bridge</literal>,
b35a2909 165 <literal>bond</literal>, <literal>vlan</literal>,
c4a5ddc9
TG		 166 <literal>macvlan</literal>,
167 <literal>ipvlan</literal>, <literal>vxlan</literal>,
b35a2909 168 <literal>ipip</literal>, <literal>gre</literal>,
1af2536a
SS		 169 <literal>gretap</literal>, <literal>sit</literal>,
170 <literal>vti</literal>, <literal>veth</literal>,
171 <literal>tun</literal>, <literal>tap</literal> and
172 <literal>dummy</literal>
9e358851 173 are supported. This option is compulsory.</para>
eac684ef
TG		 174 </listitem>
175 </varlistentry>
b35a2909
TG		 176 <varlistentry>
177 <term><varname>MTUBytes=</varname></term>
178 <listitem>
179 <para>The maximum transmission unit in bytes to
180 set for the device. The usual suffixes K, M, G,
181 are supported and are understood to the base of
e0fbf1fc
TG		 182 1024. This key is not currently suported for
183 <literal>tun</literal> or <literal>tap</literal> devices.
184 </para>
b35a2909
TG		 185 </listitem>
186 </varlistentry>
187 <varlistentry>
188 <term><varname>MACAddress=</varname></term>
189 <listitem>
190 <para>The MAC address to use for the device.
191 If none is given, one is generated based on
192 the interface name and the
193 <citerefentry><refentrytitle>machine-id</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
e0fbf1fc 194 This key is not currently suported for <literal>tun</literal> or <literal>tap</literal> devices.
b35a2909
TG		 195 </para>
196 </listitem>
197 </varlistentry>
eac684ef 198 </variablelist>
102bd40e
LP		 199 </refsect1>
200
201 <refsect1>
202 <title>[VLAN] Section Options</title>
203
eac684ef
TG		 204 <para>The <literal>[VLAN]</literal> section only applies for netdevs of kind <literal>vlan</literal>,
205 and accepts the following key:</para>
206
207 <variablelist class='network-directives'>
208 <varlistentry>
209 <term><varname>Id=</varname></term>
210 <listitem>
211 <para>The VLAN ID to use. An integer in the range 0–4094.
212 This option is compulsory.</para>
213 </listitem>
214 </varlistentry>
fe6b2d55
TG		 215 </variablelist>
216
102bd40e
LP		 217 </refsect1>
218
219 <refsect1>
220 <title>[MACVLAN] Section Options</title>
221
fe6b2d55
TG		 222 <para>The <literal>[MACVLAN]</literal> section only applies for netdevs of kind
223 <literal>macvlan</literal>, and accepts the following key:</para>
224
225 <variablelist class='network-directives'>
226 <varlistentry>
227 <term><varname>Mode=</varname></term>
228 <listitem>
229 <para>The MACVLAN mode to use. The supported options are
230 <literal>private</literal>, <literal>vepa</literal>,
231 <literal>bridge</literal> and <literal>passthru</literal>.
232 </para>
233 </listitem>
234 </varlistentry>
eac684ef
TG		 235 </variablelist>
236
237 </refsect1>
c4a5ddc9
TG		 238
239 <refsect1>
240 <title>[IPVLAN] Section Options</title>
241
242 <para>The <literal>[IPVLAN]</literal> section only applies for netdevs of kind
243 <literal>ipvlan</literal>, and accepts the following key:</para>
244
245 <variablelist class='network-directives'>
246 <varlistentry>
247 <term><varname>Mode=</varname></term>
248 <listitem>
249 <para>The IPVLAN mode to use. The supported options are
250 <literal>L2</literal> and <literal>L3</literal>.
251 </para>
252 </listitem>
253 </varlistentry>
254 </variablelist>
255
256 </refsect1>
257
b35a2909
TG		 258 <refsect1>
259 <title>[VXLAN] Section Options</title>
260 <para>The <literal>[VXLAN]</literal> section only applies for netdevs of kind
261 <literal>vxlan</literal>, and accepts the following key:</para>
eac684ef 262
b35a2909
TG		 263 <variablelist class='network-directives'>
264 <varlistentry>
265 <term><varname>Id=</varname></term>
266 <listitem>
267 <para>The VXLAN ID to use.</para>
268 </listitem>
269 </varlistentry>
270 <varlistentry>
271 <term><varname>Group=</varname></term>
272 <listitem>
273 <para>An assigned multicast group IP address.</para>
274 </listitem>
275 </varlistentry>
276 <varlistentry>
277 <term><varname>TOS=</varname></term>
278 <listitem>
279 <para>The Type Of Service byte value for a vxlan interface.</para>
280 </listitem>
281 </varlistentry>
282 <varlistentry>
283 <term><varname>TTL=</varname></term>
284 <listitem>
285 <para>A fixed Time To Live N on Virtual eXtensible Local Area Network packets.
286 N is a number in the range 1-255. 0 is a special value meaning that packets
287 inherit the TTL value.</para>
288 </listitem>
289 </varlistentry>
290 <varlistentry>
291 <term><varname>MacLearning=</varname></term>
292 <listitem>
293 <para>A boolean. When true, enables dynamic MAC learning
294 to discover remote MAC addresses.</para>
295 </listitem>
296 </varlistentry>
85a8eeee
SS		 297 <varlistentry>
298 <term><varname>FDBAgeingSec=</varname></term>
299 <listitem>
300 <para>The lifetime of Forwarding Database entry learnt by the kernel in seconds.</para>
301 </listitem>
302 </varlistentry>
303 <varlistentry>
304 <term><varname>ARPProxy=</varname></term>
305 <listitem>
306 <para>A boolean. When true, enables ARP proxy.</para>
307 </listitem>
308 </varlistentry>
309 <varlistentry>
310 <term><varname>L2MissNotification=</varname></term>
311 <listitem>
312 <para>A boolean. When true, enables netlink LLADDR miss notifications.</para>
313 </listitem>
314 </varlistentry>
315 <varlistentry>
316 <term><varname>L3MissNotification=</varname></term>
317 <listitem>
318 <para>A boolean. When true, enables netlink IP ADDR miss notifications.</para>
319 </listitem>
320 </varlistentry>
321 <varlistentry>
322 <term><varname>RouteShortCircuit=</varname></term>
323 <listitem>
324 <para>A boolean. When true route short circuit is turned on.</para>
325 </listitem>
326 </varlistentry>
b35a2909
TG		 327 </variablelist>
328 </refsect1>
329 <refsect1>
330 <title>[Tunnel] Section Options</title>
331
332 <para>The <literal>[Tunnel]</literal> section only applies for netdevs of kind
1af2536a
SS		 333 <literal>ipip</literal>, <literal>sit</literal>, <literal>gre</literal>, <literal>gretap</literal>,
334 and <literal>vti</literal> and accepts the following keys:</para>
b35a2909
TG		 335
336 <variablelist class='network-directives'>
337 <varlistentry>
338 <term><varname>Local=</varname></term>
339 <listitem>
340 <para>A static local address for tunneled packets.
341 It must be an address on another interface of this host.</para>
342 </listitem>
343 </varlistentry>
344 <varlistentry>
345 <term><varname>Remote=</varname></term>
346 <listitem>
347 <para>The remote endpoint of the tunnel.</para>
348 </listitem>
349 </varlistentry>
350 <varlistentry>
351 <term><varname>TOS=</varname></term>
352 <listitem>
353 <para>The Type Of Service byte value for a tunnel interface.
354 For details about the TOS see the
355 <ulink url="http://tools.ietf.org/html/rfc1349">
356 Type of Service in the Internet Protocol Suite
357 </ulink> document.
358 </para>
359 </listitem>
360 </varlistentry>
361 <varlistentry>
362 <term><varname>TTL=</varname></term>
363 <listitem>
364 <para>A fixed Time To Live N on tunneled packets.
365 N is a number in the range 1-255. 0 is a special value meaning that packets
366 inherit the TTL value. The default value for IPv4 tunnels is: inherit.
367 The default value for IPv6 tunnels is: 64.</para>
368 </listitem>
369 </varlistentry>
370 <varlistentry>
371 <term><varname>DiscoverPathMTU=</varname></term>
372 <listitem>
373 <para>A boolean. When true, enables Path MTU Discovery on the tunnel.</para>
374 </listitem>
375 </varlistentry>
376 </variablelist>
377 </refsect1>
378 <refsect1>
379 <title>[Peer] Section Options</title>
380
381 <para>The <literal>[Peer]</literal> section only applies for netdevs of kind <literal>veth</literal>
382 and accepts the following key:</para>
383
384 <variablelist class='network-directives'>
385 <varlistentry>
386 <term><varname>Name=</varname></term>
387 <listitem>
388 <para>The interface name used when creating the netdev.
389 This option is compulsory.</para>
390 </listitem>
391 </varlistentry>
392 <varlistentry>
393 <term><varname>MACAddress=</varname></term>
394 <listitem>
395 <para>The peer MACAddress, if not set it is generated in the same
396 way as the MAC address of the main interface.</para>
397 </listitem>
398 </varlistentry>
399 </variablelist>
400 </refsect1>
30ae9dfd 401 <refsect1>
72d33d99 402 <title>[Tun] Section Options</title>
30ae9dfd 403
72d33d99 404 <para>The <literal>[Tun]</literal> section only applies for netdevs of kind
30ae9dfd
SS		 405 <literal>tun</literal>, and accepts the following keys:</para>
406
407 <variablelist class='network-directives'>
408 <varlistentry>
409 <term><varname>OneQueue=</varname></term>
410 <listitem><para>Takes a boolean argument. Configures whether
72d33d99
TG		 411 all packets are queued at the device (enabled), or a fixed number
412 of packets are queued at the device and the rest at the
413 <literal>qdisc</literal>. Defaults to <literal>no</literal>.</para>
30ae9dfd
SS		 414 </listitem>
415 </varlistentry>
416 <varlistentry>
417 <term><varname>MultiQueue=</varname></term>
72d33d99
TG		 418 <listitem><para>Takes a boolean argument. Configures whether to
419 use multiple file descriptors (queues) to parallelize packets
420 sending and receiving. Defaults to <literal>no</literal>.</para>
30ae9dfd
SS		 421 </listitem>
422 </varlistentry>
423 <varlistentry>
424 <term><varname>PacketInfo=</varname></term>
72d33d99
TG		 425 <listitem><para>Takes a boolean argument. Configures whether packets
426 should be prepened with four extra bytes (two flag bytes and two
427 protocol bytes). If disabled it indicates that the packets will be
ffd488e2 428 pure IP packets. Defaults to <literal>no</literal>.</para>
30ae9dfd
SS		 429 </listitem>
430 </varlistentry>
431 <varlistentry>
432 <term><varname>User=</varname></term>
72d33d99
TG		 433 <listitem><para>User to grant access to the <filename>/dev/net/tun</filename>
434 device.</para>
30ae9dfd
SS		 435 </listitem>
436 </varlistentry>
437 <varlistentry>
438 <term><varname>Group=</varname></term>
72d33d99
TG		 439 <listitem><para>Group to grant access to the <filename>/dev/net/tun</filename>
440 device.</para>
30ae9dfd
SS		 441 </listitem>
442 </varlistentry>
443
444 </variablelist>
445
446 </refsect1>
447
448 <refsect1>
72d33d99 449 <title>[Tap] Section Options</title>
30ae9dfd 450
72d33d99
TG		 451 <para>The <literal>[Tap]</literal> section only applies for netdevs of kind
452 <literal>tap</literal>, and accepts the same keys as the
453 <literal>[Tun]</literal> section.</para>
30ae9dfd
SS		 454 </refsect1>
455
fe8ac65b
SS		 456 <refsect1>
457 <title>[Bond] Section Options</title>
458
459 <para>The <literal>[Bond]</literal> section accepts the following
460 key:</para>
461
462 <variablelist class='network-directives'>
463 <varlistentry>
464 <term><varname>Mode=</varname></term>
465 <listitem>
fb1021a2
SS		 466 <para>Specifies one of the bonding policies. The default is
467 <literal>balance-rr</literal> (round robin). Possible values are
468 <literal>balance-rr</literal>,
469 <literal>active-backup</literal>,
470 <literal>balance-xor</literal>,
471 <literal>broadcast</literal>,
472 <literal>802.3ad</literal>,
473 <literal>balance-tlb</literal>, and
474 <literal>balance-alb</literal>.
fe8ac65b
SS		 475 </para>
476 </listitem>
477 </varlistentry>
227cdf2c
SS		 478
479 <varlistentry>
480 <term><varname>TransmitHashPolicy=</varname></term>
481 <listitem>
482 <para>Selects the transmit hash policy to use for slave selection in
fb1021a2
SS		 483 balance-xor, 802.3ad, and tlb modes. Possible values are
484 <literal>layer2</literal>,
485 <literal>layer3+4</literal>,
486 <literal>layer2+3</literal>,
487 <literal>encap2+3</literal>,
488 <literal>802.3ad</literal>, and
489 <literal>encap3+4</literal>.
227cdf2c
SS		 490 </para>
491 </listitem>
492 </varlistentry>
493
fb1021a2
SS		 494 <varlistentry>
495 <term><varname>LACPTransmitRate=</varname></term>
496 <listitem>
497 <para>Specifies the rate with which link partner
498 transmits Link Aggregation Control Protocol Data Unit packets
499 in 802.3ad mode. Possible values are
500 <literal>slow</literal>, which requests partner to transmit LACPDUs every 30 seconds, and
501 <literal>fast</literal>, which requests partner to transmit LACPDUs every second.
502 The default value is <literal>slow</literal>.</para>
503 </listitem>
504 </varlistentry>
d9c52fa0
SS		 505
506 <varlistentry>
507 <term><varname>MIIMonitorSec=</varname></term>
508 <listitem>
509 <para>Specifies the frequency that Media Independent Interface link
510 monitoring will occur. A value of zero disables MII link monitoring.
511 This values is rounded down to the nearest millisecond. The default
512 value is 0.</para>
513 </listitem>
514 </varlistentry>
515
516 <varlistentry>
517 <term><varname>UpDelaySec=</varname></term>
518 <listitem>
519 <para>Specifies the delay before a link is enabled after a link up
520 status has been detected. This value is rounded down to a multiple of
521 MIIMonitorSec. The default value is 0.</para>
522 </listitem>
523 </varlistentry>
524
525 <varlistentry>
526 <term><varname>DownDelaySec=</varname></term>
527 <listitem>
528 <para>Specifies the delay before a link is disabled after a link down
529 status has been detected. This value is rounded down to a multiple of
530 MIIMonitorSec. The default value is 0.</para>
531 </listitem>
532 </varlistentry>
533
fe8ac65b
SS		 534 </variablelist>
535 </refsect1>
536
eac684ef
TG		 537 <refsect1>
538 <title>Example</title>
539 <example>
540 <title>/etc/systemd/network/bridge.netdev</title>
541
542 <programlisting>[NetDev]
543Name=bridge0
544Kind=bridge</programlisting>
545 </example>
546
547 <example>
548 <title>/etc/systemd/network/vlan1.netdev</title>
549
550 <programlisting>[Match]
551Virtualization=no
552
553[NetDev]
554Name=vlan1
555Kind=vlan
556
557[VLAN]
558Id=1</programlisting>
559 </example>
b35a2909
TG		 560 <example>
561 <title>/etc/systemd/network/ipip.netdev</title>
562 <programlisting>[NetDev]
563Name=ipip-tun
564Kind=ipip
565MTUBytes=1480
566
567[Tunnel]
568Local=192.168.223.238
569Remote=192.169.224.239
570TTL=64</programlisting>
571 </example>
30ae9dfd
SS		 572 <example>
573 <title>/etc/systemd/network/tap.netdev</title>
574 <programlisting>[NetDev]
575Name=tap-test
576Kind=tap
577
578[Tap]
579MultiQueue=true
580PacketInfo=true</programlisting> </example>
eac684ef 581
b35a2909
TG		 582 <example>
583 <title>/etc/systemd/network/sit.netdev</title>
584 <programlisting>[NetDev]
585Name=sit-tun
586Kind=sit
587MTUBytes=1480
588
589[Tunnel]
590Local=10.65.223.238
591Remote=10.65.223.239</programlisting>
592 </example>
eac684ef 593
b35a2909
TG		 594 <example>
595 <title>/etc/systemd/network/gre.netdev</title>
596 <programlisting>[NetDev]
597Name=gre-tun
598Kind=gre
599MTUBytes=1480
600
601[Tunnel]
602Local=10.65.223.238
603Remote=10.65.223.239</programlisting>
604 </example>
605
606 <example>
607 <title>/etc/systemd/network/vti.netdev</title>
608
609 <programlisting>[NetDev]
610Name=vti-tun
611Kind=vti
612MTUBytes=1480
613
614[Tunnel]
615Local=10.65.223.238
616Remote=10.65.223.239</programlisting>
617 </example>
618
619 <example>
620 <title>/etc/systemd/network/veth.netdev</title>
621 <programlisting>[NetDev]
622Name=veth-test
623Kind=veth
624
625[Peer]
626Name=veth-peer</programlisting>
627 </example>
628
9e358851
TG		 629 <example>
630 <title>/etc/systemd/network/dummy.netdev</title>
631 <programlisting>[NetDev]
632Name=dummy-test
633Kind=dummy
634MACAddress=12:34:56:78:9a:bc</programlisting>
635 </example>
636
b35a2909 637 </refsect1>
eac684ef
TG		 638 <refsect1>
639 <title>See Also</title>
640 <para>
641 <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
f47c5c47 642 <citerefentry><refentrytitle>systemd-networkd</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
bd763d35 643 <citerefentry><refentrytitle>systemd.link</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
f47c5c47 644 <citerefentry><refentrytitle>systemd.network</refentrytitle><manvolnum>5</manvolnum></citerefentry>
eac684ef
TG		 645 </para>
646 </refsect1>
647
648</refentry>
Unnamed repository; edit this file 'description' to name the repository.