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">
6 This file is part of systemd.
8 Copyright 2013 Tom Gundersen
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.
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.
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/>.
24 <refentry id="systemd.netdev" conditional='ENABLE_NETWORKD'>
27 <title>systemd.network</title>
28 <productname>systemd</productname>
32 <contrib>Developer</contrib>
33 <firstname>Tom</firstname>
34 <surname>Gundersen</surname>
35 <email>teg@jklm.no</email>
41 <refentrytitle>systemd.netdev</refentrytitle>
42 <manvolnum>5</manvolnum>
46 <refname>systemd.netdev</refname>
47 <refpurpose>Virtual Network Device configuration</refpurpose>
51 <para><filename><replaceable>netdev</replaceable>.netdev</filename></para>
55 <title>Description</title>
57 <para>Network setup is performed by
58 <citerefentry><refentrytitle>systemd-networkd</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
61 <para>Virtual Network Device files must have the extension
62 <filename>.netdev</filename>; other extensions are ignored. Virtual
63 network devices are created as soon as networkd is started.</para>
65 <para>The <filename>.netdev</filename> files are read from the files located in the
66 system network directory <filename>/usr/lib/systemd/network</filename>,
67 the volatile runtime network directory
68 <filename>/run/systemd/network</filename> and the local administration
69 network directory <filename>/etc/systemd/network</filename>.
70 All configuration files are collectively sorted and processed in lexical order,
71 regardless of the directories in which they live. However, files with
72 identical filenames replace each other. Files in
73 <filename>/etc</filename> have the highest priority, files in
74 <filename>/run</filename> take precedence over files with the same
75 name in <filename>/usr/lib</filename>. This can be used to override a
76 system-supplied configuration file with a local file if needed; a symlink in
77 <filename>/etc</filename> with the same name as a configuration file in
78 <filename>/usr/lib</filename>, pointing to <filename>/dev/null</filename>,
79 disables the configuration file entirely.</para>
84 <title>[Match] Section Options</title>
86 <para>A virtual network device is only created if the
87 <literal>[Match]</literal> section matches the current
88 environment, or if the section is empty. The following keys are accepted:</para>
90 <variablelist class='network-directives'>
92 <term><varname>Host=</varname></term>
94 <para>Matches against the hostname or machine ID of the
95 host. See <literal>ConditionHost=</literal> in
96 <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>
102 <term><varname>Virtualization=</varname></term>
104 <para>Checks whether the system is executed in a virtualized
105 environment and optionally test whether it is a specific
106 implementation. See <literal>ConditionVirtualization=</literal> in
107 <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>
113 <term><varname>KernelCommandLine=</varname></term>
115 <para>Checks whether a specific kernel command line option is
116 set (or if prefixed with the exclamation mark unset). See
117 <literal>ConditionKernelCommandLine=</literal> in
118 <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>
124 <term><varname>Architecture=</varname></term>
126 <para>Checks whether the system is running on a specific
127 architecture. See <literal>ConditionArchitecture=</literal> in
128 <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>
138 <title>[NetDev] Section Options</title>
140 <para>The <literal>[NetDev]</literal> section accepts the following
143 <variablelist class='network-directives'>
145 <term><varname>Description=</varname></term>
147 <para>A free-form description of the netdev.
152 <term><varname>Name=</varname></term>
154 <para>The interface name used when creating the
155 netdev. This option is compulsory.</para>
159 <term><varname>Kind=</varname></term>
161 <para>The netdev kind. Currently, <literal>bridge</literal>,
162 <literal>bond</literal>, <literal>vlan</literal>,
163 <literal>macvlan</literal>, <literal>vxlan</literal>,
164 <literal>ipip</literal>, <literal>gre</literal>,
165 <literal>sit</literal>, <literal>vti</literal>,
166 <literal>veth</literal>, <literal>tun</literal>,
167 <literal>tap</literal> and <literal>dummy</literal>
168 are supported. This option is compulsory.</para>
172 <term><varname>MTUBytes=</varname></term>
174 <para>The maximum transmission unit in bytes to
175 set for the device. The usual suffixes K, M, G,
176 are supported and are understood to the base of
181 <term><varname>MACAddress=</varname></term>
183 <para>The MAC address to use for the device.
184 If none is given, one is generated based on
185 the interface name and the
186 <citerefentry><refentrytitle>machine-id</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
194 <title>[VLAN] Section Options</title>
196 <para>The <literal>[VLAN]</literal> section only applies for netdevs of kind <literal>vlan</literal>,
197 and accepts the following key:</para>
199 <variablelist class='network-directives'>
201 <term><varname>Id=</varname></term>
203 <para>The VLAN ID to use. An integer in the range 0–4094.
204 This option is compulsory.</para>
212 <title>[MACVLAN] Section Options</title>
214 <para>The <literal>[MACVLAN]</literal> section only applies for netdevs of kind
215 <literal>macvlan</literal>, and accepts the following key:</para>
217 <variablelist class='network-directives'>
219 <term><varname>Mode=</varname></term>
221 <para>The MACVLAN mode to use. The supported options are
222 <literal>private</literal>, <literal>vepa</literal>,
223 <literal>bridge</literal> and <literal>passthru</literal>.
231 <title>[VXLAN] Section Options</title>
232 <para>The <literal>[VXLAN]</literal> section only applies for netdevs of kind
233 <literal>vxlan</literal>, and accepts the following key:</para>
235 <variablelist class='network-directives'>
237 <term><varname>Id=</varname></term>
239 <para>The VXLAN ID to use.</para>
243 <term><varname>Group=</varname></term>
245 <para>An assigned multicast group IP address.</para>
249 <term><varname>TOS=</varname></term>
251 <para>The Type Of Service byte value for a vxlan interface.</para>
255 <term><varname>TTL=</varname></term>
257 <para>A fixed Time To Live N on Virtual eXtensible Local Area Network packets.
258 N is a number in the range 1-255. 0 is a special value meaning that packets
259 inherit the TTL value.</para>
263 <term><varname>MacLearning=</varname></term>
265 <para>A boolean. When true, enables dynamic MAC learning
266 to discover remote MAC addresses.</para>
272 <title>[Tunnel] Section Options</title>
274 <para>The <literal>[Tunnel]</literal> section only applies for netdevs of kind
275 <literal>ipip</literal>, <literal>sit</literal>, <literal>gre</literal> and
276 <literal>vti</literal> and accepts the following keys:</para>
278 <variablelist class='network-directives'>
280 <term><varname>Local=</varname></term>
282 <para>A static local address for tunneled packets.
283 It must be an address on another interface of this host.</para>
287 <term><varname>Remote=</varname></term>
289 <para>The remote endpoint of the tunnel.</para>
293 <term><varname>TOS=</varname></term>
295 <para>The Type Of Service byte value for a tunnel interface.
296 For details about the TOS see the
297 <ulink url="http://tools.ietf.org/html/rfc1349">
298 Type of Service in the Internet Protocol Suite
304 <term><varname>TTL=</varname></term>
306 <para>A fixed Time To Live N on tunneled packets.
307 N is a number in the range 1-255. 0 is a special value meaning that packets
308 inherit the TTL value. The default value for IPv4 tunnels is: inherit.
309 The default value for IPv6 tunnels is: 64.</para>
313 <term><varname>DiscoverPathMTU=</varname></term>
315 <para>A boolean. When true, enables Path MTU Discovery on the tunnel.</para>
321 <title>[Peer] Section Options</title>
323 <para>The <literal>[Peer]</literal> section only applies for netdevs of kind <literal>veth</literal>
324 and accepts the following key:</para>
326 <variablelist class='network-directives'>
328 <term><varname>Name=</varname></term>
330 <para>The interface name used when creating the netdev.
331 This option is compulsory.</para>
335 <term><varname>MACAddress=</varname></term>
337 <para>The peer MACAddress, if not set it is generated in the same
338 way as the MAC address of the main interface.</para>
344 <title>[Tun] Section Options</title>
346 <para>The <literal>[Tun]</literal> section only applies for netdevs of kind
347 <literal>tun</literal>, and accepts the following keys:</para>
349 <variablelist class='network-directives'>
351 <term><varname>OneQueue=</varname></term>
352 <listitem><para>Takes a boolean argument. Configures whether
353 all packets are queued at the device (enabled), or a fixed number
354 of packets are queued at the device and the rest at the
355 <literal>qdisc</literal>. Defaults to <literal>no</literal>.</para>
359 <term><varname>MultiQueue=</varname></term>
360 <listitem><para>Takes a boolean argument. Configures whether to
361 use multiple file descriptors (queues) to parallelize packets
362 sending and receiving. Defaults to <literal>no</literal>.</para>
366 <term><varname>PacketInfo=</varname></term>
367 <listitem><para>Takes a boolean argument. Configures whether packets
368 should be prepened with four extra bytes (two flag bytes and two
369 protocol bytes). If disabled it indicates that the packets will be
370 pure IP packets. Defaults to <literal>no</literal>.</para>
374 <term><varname>User=</varname></term>
375 <listitem><para>User to grant access to the <filename>/dev/net/tun</filename>
380 <term><varname>Group=</varname></term>
381 <listitem><para>Group to grant access to the <filename>/dev/net/tun</filename>
391 <title>[Tap] Section Options</title>
393 <para>The <literal>[Tap]</literal> section only applies for netdevs of kind
394 <literal>tap</literal>, and accepts the same keys as the
395 <literal>[Tun]</literal> section.</para>
399 <title>[Bond] Section Options</title>
401 <para>The <literal>[Bond]</literal> section accepts the following
404 <variablelist class='network-directives'>
406 <term><varname>Mode=</varname></term>
408 <para>Specifies one of the bonding policies. The default is balance-rr (round robin).
409 <literal>balance-rr</literal>
410 <literal>active-backup</literal>
411 <literal>balance-xor</literal>
412 <literal>broadcast</literal>
413 <literal>802.3ad</literal>
414 <literal>balance-tlb</literal>
415 <literal>balance-alb</literal>
423 <title>Example</title>
425 <title>/etc/systemd/network/bridge.netdev</title>
427 <programlisting>[NetDev]
429 Kind=bridge</programlisting>
433 <title>/etc/systemd/network/vlan1.netdev</title>
435 <programlisting>[Match]
443 Id=1</programlisting>
446 <title>/etc/systemd/network/ipip.netdev</title>
447 <programlisting>[NetDev]
453 Local=192.168.223.238
454 Remote=192.169.224.239
455 TTL=64</programlisting>
458 <title>/etc/systemd/network/tap.netdev</title>
459 <programlisting>[NetDev]
465 PacketInfo=true</programlisting> </example>
468 <title>/etc/systemd/network/sit.netdev</title>
469 <programlisting>[NetDev]
476 Remote=10.65.223.239</programlisting>
480 <title>/etc/systemd/network/gre.netdev</title>
481 <programlisting>[NetDev]
488 Remote=10.65.223.239</programlisting>
492 <title>/etc/systemd/network/vti.netdev</title>
494 <programlisting>[NetDev]
501 Remote=10.65.223.239</programlisting>
505 <title>/etc/systemd/network/veth.netdev</title>
506 <programlisting>[NetDev]
511 Name=veth-peer</programlisting>
515 <title>/etc/systemd/network/dummy.netdev</title>
516 <programlisting>[NetDev]
519 MACAddress=12:34:56:78:9a:bc</programlisting>
524 <title>See Also</title>
526 <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
527 <citerefentry><refentrytitle>systemd-networkd</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
528 <citerefentry><refentrytitle>systemd.network</refentrytitle><manvolnum>5</manvolnum></citerefentry>