2014-02-25 22:30:40 +04:00
<?xml version='1.0'?> <!-- * - nxml - * -->
< !DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
<!--
This file is part of systemd.
Copyright 2013 Tom Gundersen
systemd is free software; you can redistribute it and/or modify it
under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation; either version 2.1 of the License, or
(at your option) any later version.
systemd is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public License
along with systemd; If not, see <http: / / w w w . g n u . o r g / l i c e n s e s /> .
-->
<refentry id= "systemd.netdev" conditional= 'ENABLE_NETWORKD' >
<refentryinfo >
<title > systemd.network</title>
<productname > systemd</productname>
<authorgroup >
<author >
<contrib > Developer</contrib>
<firstname > Tom</firstname>
<surname > Gundersen</surname>
<email > teg@jklm.no</email>
</author>
</authorgroup>
</refentryinfo>
<refmeta >
<refentrytitle > systemd.netdev</refentrytitle>
<manvolnum > 5</manvolnum>
</refmeta>
<refnamediv >
<refname > systemd.netdev</refname>
<refpurpose > Virtual Network Device configuration</refpurpose>
</refnamediv>
<refsynopsisdiv >
<para > <filename > <replaceable > netdev</replaceable> .netdev</filename> </para>
</refsynopsisdiv>
<refsect1 >
<title > Description</title>
<para > Network setup is performed by
<citerefentry > <refentrytitle > systemd-networkd</refentrytitle> <manvolnum > 8</manvolnum> </citerefentry> .
</para>
<para > Virtual Network Device files must have the extension
<filename > .netdev</filename> ; other extensions are ignored. Virtual
2014-07-14 14:25:42 +04:00
network devices are created as soon as networkd is started. If a netdev
with the specified name already exists, networkd will use that as-is
rather than create its own. Note that the settings of the pre-existing
netdev will not be changed by networkd.</para>
2014-02-25 22:30:40 +04:00
<para > The <filename > .netdev</filename> files are read from the files located in the
system network directory <filename > /usr/lib/systemd/network</filename> ,
the volatile runtime network directory
<filename > /run/systemd/network</filename> and the local administration
network directory <filename > /etc/systemd/network</filename> .
All configuration files are collectively sorted and processed in lexical order,
regardless of the directories in which they live. However, files with
identical filenames replace each other. Files in
<filename > /etc</filename> have the highest priority, files in
<filename > /run</filename> take precedence over files with the same
name in <filename > /usr/lib</filename> . This can be used to override a
system-supplied configuration file with a local file if needed; a symlink in
<filename > /etc</filename> with the same name as a configuration file in
<filename > /usr/lib</filename> , pointing to <filename > /dev/null</filename> ,
disables the configuration file entirely.</para>
2014-06-27 22:42:36 +04:00
</refsect1>
<refsect1 >
<title > [Match] Section Options</title>
2014-02-25 22:30:40 +04:00
<para > A virtual network device is only created if the
<literal > [Match]</literal> section matches the current
environment, or if the section is empty. The following keys are accepted:</para>
<variablelist class= 'network-directives' >
<varlistentry >
<term > <varname > Host=</varname> </term>
<listitem >
<para > Matches against the hostname or machine ID of the
host. See <literal > ConditionHost=</literal> in
<citerefentry > <refentrytitle > systemd.unit</refentrytitle> <manvolnum > 5</manvolnum> </citerefentry>
for details.
</para>
</listitem>
</varlistentry>
<varlistentry >
<term > <varname > Virtualization=</varname> </term>
<listitem >
<para > Checks whether the system is executed in a virtualized
environment and optionally test whether it is a specific
implementation. See <literal > ConditionVirtualization=</literal> in
<citerefentry > <refentrytitle > systemd.unit</refentrytitle> <manvolnum > 5</manvolnum> </citerefentry>
for details.
</para>
</listitem>
</varlistentry>
<varlistentry >
<term > <varname > KernelCommandLine=</varname> </term>
<listitem >
<para > Checks whether a specific kernel command line option is
set (or if prefixed with the exclamation mark unset). See
<literal > ConditionKernelCommandLine=</literal> in
<citerefentry > <refentrytitle > systemd.unit</refentrytitle> <manvolnum > 5</manvolnum> </citerefentry>
for details.
</para>
</listitem>
</varlistentry>
<varlistentry >
<term > <varname > Architecture=</varname> </term>
<listitem >
<para > Checks whether the system is running on a specific
architecture. See <literal > ConditionArchitecture=</literal> in
<citerefentry > <refentrytitle > systemd.unit</refentrytitle> <manvolnum > 5</manvolnum> </citerefentry>
for details.
</para>
</listitem>
</varlistentry>
</variablelist>
2014-06-27 22:42:36 +04:00
</refsect1>
<refsect1 >
<title > [NetDev] Section Options</title>
2014-02-25 22:30:40 +04:00
<para > The <literal > [NetDev]</literal> section accepts the following
keys:</para>
<variablelist class= 'network-directives' >
2014-07-01 23:38:08 +04:00
<varlistentry >
<term > <varname > Description=</varname> </term>
<listitem >
<para > A free-form description of the netdev.
</para>
</listitem>
</varlistentry>
2014-02-25 22:30:40 +04:00
<varlistentry >
<term > <varname > Name=</varname> </term>
<listitem >
<para > The interface name used when creating the
netdev. This option is compulsory.</para>
</listitem>
</varlistentry>
<varlistentry >
<term > <varname > Kind=</varname> </term>
<listitem >
<para > The netdev kind. Currently, <literal > bridge</literal> ,
2014-07-01 23:38:08 +04:00
<literal > bond</literal> , <literal > vlan</literal> ,
<literal > macvlan</literal> , <literal > vxlan</literal> ,
<literal > ipip</literal> , <literal > gre</literal> ,
<literal > sit</literal> , <literal > vti</literal> ,
2014-07-04 03:26:19 +04:00
<literal > veth</literal> , <literal > tun</literal> ,
<literal > tap</literal> and <literal > dummy</literal>
2014-07-01 21:45:37 +04:00
are supported. This option is compulsory.</para>
2014-02-25 22:30:40 +04:00
</listitem>
</varlistentry>
2014-07-01 23:38:08 +04:00
<varlistentry >
<term > <varname > MTUBytes=</varname> </term>
<listitem >
<para > The maximum transmission unit in bytes to
set for the device. The usual suffixes K, M, G,
are supported and are understood to the base of
2014-08-18 14:29:45 +04:00
1024. This key is not currently suported for
<literal > tun</literal> or <literal > tap</literal> devices.
</para>
2014-07-01 23:38:08 +04:00
</listitem>
</varlistentry>
<varlistentry >
<term > <varname > MACAddress=</varname> </term>
<listitem >
<para > The MAC address to use for the device.
If none is given, one is generated based on
the interface name and the
<citerefentry > <refentrytitle > machine-id</refentrytitle> <manvolnum > 5</manvolnum> </citerefentry> .
2014-08-18 14:29:45 +04:00
This key is not currently suported for <literal > tun</literal> or <literal > tap</literal> devices.
2014-07-01 23:38:08 +04:00
</para>
</listitem>
</varlistentry>
2014-02-25 22:30:40 +04:00
</variablelist>
2014-06-27 22:42:36 +04:00
</refsect1>
<refsect1 >
<title > [VLAN] Section Options</title>
2014-02-25 22:30:40 +04:00
<para > The <literal > [VLAN]</literal> section only applies for netdevs of kind <literal > vlan</literal> ,
and accepts the following key:</para>
<variablelist class= 'network-directives' >
<varlistentry >
<term > <varname > Id=</varname> </term>
<listitem >
<para > The VLAN ID to use. An integer in the range 0–
This option is compulsory.</para>
</listitem>
</varlistentry>
2014-02-26 00:16:17 +04:00
</variablelist>
2014-06-27 22:42:36 +04:00
</refsect1>
<refsect1 >
<title > [MACVLAN] Section Options</title>
2014-02-26 00:16:17 +04:00
<para > The <literal > [MACVLAN]</literal> section only applies for netdevs of kind
<literal > macvlan</literal> , and accepts the following key:</para>
<variablelist class= 'network-directives' >
<varlistentry >
<term > <varname > Mode=</varname> </term>
<listitem >
<para > The MACVLAN mode to use. The supported options are
<literal > private</literal> , <literal > vepa</literal> ,
<literal > bridge</literal> and <literal > passthru</literal> .
</para>
</listitem>
</varlistentry>
2014-02-25 22:30:40 +04:00
</variablelist>
</refsect1>
2014-07-01 23:38:08 +04:00
<refsect1 >
<title > [VXLAN] Section Options</title>
<para > The <literal > [VXLAN]</literal> section only applies for netdevs of kind
<literal > vxlan</literal> , and accepts the following key:</para>
2014-02-25 22:30:40 +04:00
2014-07-01 23:38:08 +04:00
<variablelist class= 'network-directives' >
<varlistentry >
<term > <varname > Id=</varname> </term>
<listitem >
<para > The VXLAN ID to use.</para>
</listitem>
</varlistentry>
<varlistentry >
<term > <varname > Group=</varname> </term>
<listitem >
<para > An assigned multicast group IP address.</para>
</listitem>
</varlistentry>
<varlistentry >
<term > <varname > TOS=</varname> </term>
<listitem >
<para > The Type Of Service byte value for a vxlan interface.</para>
</listitem>
</varlistentry>
<varlistentry >
<term > <varname > TTL=</varname> </term>
<listitem >
<para > A fixed Time To Live N on Virtual eXtensible Local Area Network packets.
N is a number in the range 1-255. 0 is a special value meaning that packets
inherit the TTL value.</para>
</listitem>
</varlistentry>
<varlistentry >
<term > <varname > MacLearning=</varname> </term>
<listitem >
<para > A boolean. When true, enables dynamic MAC learning
to discover remote MAC addresses.</para>
</listitem>
</varlistentry>
2014-11-15 05:54:59 +03:00
<varlistentry >
<term > <varname > FDBAgeingSec=</varname> </term>
<listitem >
<para > The lifetime of Forwarding Database entry learnt by the kernel in seconds.</para>
</listitem>
</varlistentry>
<varlistentry >
<term > <varname > ARPProxy=</varname> </term>
<listitem >
<para > A boolean. When true, enables ARP proxy.</para>
</listitem>
</varlistentry>
<varlistentry >
<term > <varname > L2MissNotification=</varname> </term>
<listitem >
<para > A boolean. When true, enables netlink LLADDR miss notifications.</para>
</listitem>
</varlistentry>
<varlistentry >
<term > <varname > L3MissNotification=</varname> </term>
<listitem >
<para > A boolean. When true, enables netlink IP ADDR miss notifications.</para>
</listitem>
</varlistentry>
<varlistentry >
<term > <varname > RouteShortCircuit=</varname> </term>
<listitem >
<para > A boolean. When true route short circuit is turned on.</para>
</listitem>
</varlistentry>
2014-07-01 23:38:08 +04:00
</variablelist>
</refsect1>
<refsect1 >
<title > [Tunnel] Section Options</title>
<para > The <literal > [Tunnel]</literal> section only applies for netdevs of kind
<literal > ipip</literal> , <literal > sit</literal> , <literal > gre</literal> and
<literal > vti</literal> and accepts the following keys:</para>
<variablelist class= 'network-directives' >
<varlistentry >
<term > <varname > Local=</varname> </term>
<listitem >
<para > A static local address for tunneled packets.
It must be an address on another interface of this host.</para>
</listitem>
</varlistentry>
<varlistentry >
<term > <varname > Remote=</varname> </term>
<listitem >
<para > The remote endpoint of the tunnel.</para>
</listitem>
</varlistentry>
<varlistentry >
<term > <varname > TOS=</varname> </term>
<listitem >
<para > The Type Of Service byte value for a tunnel interface.
For details about the TOS see the
<ulink url= "http://tools.ietf.org/html/rfc1349" >
Type of Service in the Internet Protocol Suite
</ulink> document.
</para>
</listitem>
</varlistentry>
<varlistentry >
<term > <varname > TTL=</varname> </term>
<listitem >
<para > A fixed Time To Live N on tunneled packets.
N is a number in the range 1-255. 0 is a special value meaning that packets
inherit the TTL value. The default value for IPv4 tunnels is: inherit.
The default value for IPv6 tunnels is: 64.</para>
</listitem>
</varlistentry>
<varlistentry >
<term > <varname > DiscoverPathMTU=</varname> </term>
<listitem >
<para > A boolean. When true, enables Path MTU Discovery on the tunnel.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 >
<title > [Peer] Section Options</title>
<para > The <literal > [Peer]</literal> section only applies for netdevs of kind <literal > veth</literal>
and accepts the following key:</para>
<variablelist class= 'network-directives' >
<varlistentry >
<term > <varname > Name=</varname> </term>
<listitem >
<para > The interface name used when creating the netdev.
This option is compulsory.</para>
</listitem>
</varlistentry>
<varlistentry >
<term > <varname > MACAddress=</varname> </term>
<listitem >
<para > The peer MACAddress, if not set it is generated in the same
way as the MAC address of the main interface.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
2014-07-03 12:04:11 +04:00
<refsect1 >
2014-07-03 13:25:07 +04:00
<title > [Tun] Section Options</title>
2014-07-03 12:04:11 +04:00
2014-07-03 13:25:07 +04:00
<para > The <literal > [Tun]</literal> section only applies for netdevs of kind
2014-07-03 12:04:11 +04:00
<literal > tun</literal> , and accepts the following keys:</para>
<variablelist class= 'network-directives' >
<varlistentry >
<term > <varname > OneQueue=</varname> </term>
<listitem > <para > Takes a boolean argument. Configures whether
2014-07-03 13:25:07 +04:00
all packets are queued at the device (enabled), or a fixed number
of packets are queued at the device and the rest at the
<literal > qdisc</literal> . Defaults to <literal > no</literal> .</para>
2014-07-03 12:04:11 +04:00
</listitem>
</varlistentry>
<varlistentry >
<term > <varname > MultiQueue=</varname> </term>
2014-07-03 13:25:07 +04:00
<listitem > <para > Takes a boolean argument. Configures whether to
use multiple file descriptors (queues) to parallelize packets
sending and receiving. Defaults to <literal > no</literal> .</para>
2014-07-03 12:04:11 +04:00
</listitem>
</varlistentry>
<varlistentry >
<term > <varname > PacketInfo=</varname> </term>
2014-07-03 13:25:07 +04:00
<listitem > <para > Takes a boolean argument. Configures whether packets
should be prepened with four extra bytes (two flag bytes and two
protocol bytes). If disabled it indicates that the packets will be
2014-07-03 14:19:14 +04:00
pure IP packets. Defaults to <literal > no</literal> .</para>
2014-07-03 12:04:11 +04:00
</listitem>
</varlistentry>
<varlistentry >
<term > <varname > User=</varname> </term>
2014-07-03 13:25:07 +04:00
<listitem > <para > User to grant access to the <filename > /dev/net/tun</filename>
device.</para>
2014-07-03 12:04:11 +04:00
</listitem>
</varlistentry>
<varlistentry >
<term > <varname > Group=</varname> </term>
2014-07-03 13:25:07 +04:00
<listitem > <para > Group to grant access to the <filename > /dev/net/tun</filename>
device.</para>
2014-07-03 12:04:11 +04:00
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 >
2014-07-03 13:25:07 +04:00
<title > [Tap] Section Options</title>
2014-07-03 12:04:11 +04:00
2014-07-03 13:25:07 +04:00
<para > The <literal > [Tap]</literal> section only applies for netdevs of kind
<literal > tap</literal> , and accepts the same keys as the
<literal > [Tun]</literal> section.</para>
2014-07-03 12:04:11 +04:00
</refsect1>
2014-07-04 21:05:02 +04:00
<refsect1 >
<title > [Bond] Section Options</title>
<para > The <literal > [Bond]</literal> section accepts the following
key:</para>
<variablelist class= 'network-directives' >
<varlistentry >
<term > <varname > Mode=</varname> </term>
<listitem >
2014-07-21 17:22:14 +04:00
<para > Specifies one of the bonding policies. The default is
<literal > balance-rr</literal> (round robin). Possible values are
<literal > balance-rr</literal> ,
<literal > active-backup</literal> ,
<literal > balance-xor</literal> ,
<literal > broadcast</literal> ,
<literal > 802.3ad</literal> ,
<literal > balance-tlb</literal> , and
<literal > balance-alb</literal> .
2014-07-04 21:05:02 +04:00
</para>
</listitem>
</varlistentry>
2014-07-21 17:07:05 +04:00
<varlistentry >
<term > <varname > TransmitHashPolicy=</varname> </term>
<listitem >
<para > Selects the transmit hash policy to use for slave selection in
2014-07-21 17:22:14 +04:00
balance-xor, 802.3ad, and tlb modes. Possible values are
<literal > layer2</literal> ,
<literal > layer3+4</literal> ,
<literal > layer2+3</literal> ,
<literal > encap2+3</literal> ,
<literal > 802.3ad</literal> , and
<literal > encap3+4</literal> .
2014-07-21 17:07:05 +04:00
</para>
</listitem>
</varlistentry>
2014-07-21 17:22:14 +04:00
<varlistentry >
<term > <varname > LACPTransmitRate=</varname> </term>
<listitem >
<para > Specifies the rate with which link partner
transmits Link Aggregation Control Protocol Data Unit packets
in 802.3ad mode. Possible values are
<literal > slow</literal> , which requests partner to transmit LACPDUs every 30 seconds, and
<literal > fast</literal> , which requests partner to transmit LACPDUs every second.
The default value is <literal > slow</literal> .</para>
</listitem>
</varlistentry>
2014-07-21 17:44:48 +04:00
<varlistentry >
<term > <varname > MIIMonitorSec=</varname> </term>
<listitem >
<para > Specifies the frequency that Media Independent Interface link
monitoring will occur. A value of zero disables MII link monitoring.
This values is rounded down to the nearest millisecond. The default
value is 0.</para>
</listitem>
</varlistentry>
<varlistentry >
<term > <varname > UpDelaySec=</varname> </term>
<listitem >
<para > Specifies the delay before a link is enabled after a link up
status has been detected. This value is rounded down to a multiple of
MIIMonitorSec. The default value is 0.</para>
</listitem>
</varlistentry>
<varlistentry >
<term > <varname > DownDelaySec=</varname> </term>
<listitem >
<para > Specifies the delay before a link is disabled after a link down
status has been detected. This value is rounded down to a multiple of
MIIMonitorSec. The default value is 0.</para>
</listitem>
</varlistentry>
2014-07-04 21:05:02 +04:00
</variablelist>
</refsect1>
2014-02-25 22:30:40 +04:00
<refsect1 >
<title > Example</title>
<example >
<title > /etc/systemd/network/bridge.netdev</title>
<programlisting > [NetDev]
Name=bridge0
Kind=bridge</programlisting>
</example>
<example >
<title > /etc/systemd/network/vlan1.netdev</title>
<programlisting > [Match]
Virtualization=no
[NetDev]
Name=vlan1
Kind=vlan
[VLAN]
Id=1</programlisting>
</example>
2014-07-01 23:38:08 +04:00
<example >
<title > /etc/systemd/network/ipip.netdev</title>
<programlisting > [NetDev]
Name=ipip-tun
Kind=ipip
MTUBytes=1480
[Tunnel]
Local=192.168.223.238
Remote=192.169.224.239
TTL=64</programlisting>
</example>
2014-07-03 12:04:11 +04:00
<example >
<title > /etc/systemd/network/tap.netdev</title>
<programlisting > [NetDev]
Name=tap-test
Kind=tap
[Tap]
MultiQueue=true
PacketInfo=true</programlisting> </example>
2014-02-25 22:30:40 +04:00
2014-07-01 23:38:08 +04:00
<example >
<title > /etc/systemd/network/sit.netdev</title>
<programlisting > [NetDev]
Name=sit-tun
Kind=sit
MTUBytes=1480
[Tunnel]
Local=10.65.223.238
Remote=10.65.223.239</programlisting>
</example>
2014-02-25 22:30:40 +04:00
2014-07-01 23:38:08 +04:00
<example >
<title > /etc/systemd/network/gre.netdev</title>
<programlisting > [NetDev]
Name=gre-tun
Kind=gre
MTUBytes=1480
[Tunnel]
Local=10.65.223.238
Remote=10.65.223.239</programlisting>
</example>
<example >
<title > /etc/systemd/network/vti.netdev</title>
<programlisting > [NetDev]
Name=vti-tun
Kind=vti
MTUBytes=1480
[Tunnel]
Local=10.65.223.238
Remote=10.65.223.239</programlisting>
</example>
<example >
<title > /etc/systemd/network/veth.netdev</title>
<programlisting > [NetDev]
Name=veth-test
Kind=veth
[Peer]
Name=veth-peer</programlisting>
</example>
2014-07-01 21:45:37 +04:00
<example >
<title > /etc/systemd/network/dummy.netdev</title>
<programlisting > [NetDev]
Name=dummy-test
Kind=dummy
MACAddress=12:34:56:78:9a:bc</programlisting>
</example>
2014-07-01 23:38:08 +04:00
</refsect1>
2014-02-25 22:30:40 +04:00
<refsect1 >
<title > See Also</title>
<para >
<citerefentry > <refentrytitle > systemd</refentrytitle> <manvolnum > 1</manvolnum> </citerefentry> ,
2014-03-18 00:08:40 +04:00
<citerefentry > <refentrytitle > systemd-networkd</refentrytitle> <manvolnum > 8</manvolnum> </citerefentry> ,
<citerefentry > <refentrytitle > systemd.network</refentrytitle> <manvolnum > 5</manvolnum> </citerefentry>
2014-02-25 22:30:40 +04:00
</para>
</refsect1>
</refentry>
