systemd-networkd.service.xml revision 1a436809498faf6486815baa0338fb6b8e5def07
2827b0d03f7b6bafa504d22a5d7ca39cbda048b3Pavel Březina<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
2827b0d03f7b6bafa504d22a5d7ca39cbda048b3Pavel Březina "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
2827b0d03f7b6bafa504d22a5d7ca39cbda048b3Pavel Březina This file is part of systemd.
2827b0d03f7b6bafa504d22a5d7ca39cbda048b3Pavel Březina Copyright 2013 Tom Gundersen
2827b0d03f7b6bafa504d22a5d7ca39cbda048b3Pavel Březina systemd is free software; you can redistribute it and/or modify it
2827b0d03f7b6bafa504d22a5d7ca39cbda048b3Pavel Březina under the terms of the GNU Lesser General Public License as published by
2827b0d03f7b6bafa504d22a5d7ca39cbda048b3Pavel Březina the Free Software Foundation; either version 2.1 of the License, or
2827b0d03f7b6bafa504d22a5d7ca39cbda048b3Pavel Březina (at your option) any later version.
2827b0d03f7b6bafa504d22a5d7ca39cbda048b3Pavel Březina systemd is distributed in the hope that it will be useful, but
2827b0d03f7b6bafa504d22a5d7ca39cbda048b3Pavel Březina WITHOUT ANY WARRANTY; without even the implied warranty of
2827b0d03f7b6bafa504d22a5d7ca39cbda048b3Pavel Březina MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
2827b0d03f7b6bafa504d22a5d7ca39cbda048b3Pavel Březina Lesser General Public License for more details.
2827b0d03f7b6bafa504d22a5d7ca39cbda048b3Pavel Březina You should have received a copy of the GNU Lesser General Public License
2827b0d03f7b6bafa504d22a5d7ca39cbda048b3Pavel Březina along with systemd; If not, see <http://www.gnu.org/licenses/>.
2827b0d03f7b6bafa504d22a5d7ca39cbda048b3Pavel Březina<refentry id="systemd-networkd.service" conditional='ENABLE_NETWORKD'>
2827b0d03f7b6bafa504d22a5d7ca39cbda048b3Pavel Březina <refentryinfo>
dea636af4d1902a081ee891f1b19ee2f8729d759Pavel Březina <authorgroup>
3b09b74bf65867d882af87ec60e2a517b15264a6Jakub Hrozek </authorgroup>
3b09b74bf65867d882af87ec60e2a517b15264a6Jakub Hrozek </refentryinfo>
5ff1c3c5a12930692cb6284d14f7fda3a974af8ePavel Březina <refentrytitle>systemd-networkd.service</refentrytitle>
3b09b74bf65867d882af87ec60e2a517b15264a6Jakub Hrozek <refnamediv>
3b09b74bf65867d882af87ec60e2a517b15264a6Jakub Hrozek </refnamediv>
3b09b74bf65867d882af87ec60e2a517b15264a6Jakub Hrozek <refsynopsisdiv>
3b09b74bf65867d882af87ec60e2a517b15264a6Jakub Hrozek <para><filename>systemd-networkd.service</filename></para>
3d55c65fbe50074f6a63dcb8ae866c038a9e6b2bStephen Gallagher <para><filename>/usr/lib/systemd/systemd-networkd</filename></para>
e5b34f0166ae61468e53f369578e691ddb09cdd0Pavel Březina </refsynopsisdiv>
3b09b74bf65867d882af87ec60e2a517b15264a6Jakub Hrozek <para><command>systemd-networkd</command> is a system
3b09b74bf65867d882af87ec60e2a517b15264a6Jakub Hrozek service that manages networks. It detects and configures
3b09b74bf65867d882af87ec60e2a517b15264a6Jakub Hrozek network devices as they appear, as well as creating virtual
8bbf89c5ab798c112773fe23515c3a9df56dde71Nick Guay network devices.</para>
3b09b74bf65867d882af87ec60e2a517b15264a6Jakub Hrozek <para>Network configurations applied before networkd is started
3b09b74bf65867d882af87ec60e2a517b15264a6Jakub Hrozek are not removed, and configuration applied by networkd are not
a0c764a36f2f432e6063de84be6f6af7e96ec159Sumit Bose removed when networkd exits. This ensures restarting networkd
3b09b74bf65867d882af87ec60e2a517b15264a6Jakub Hrozek does not cut the network connection, and, in particular, that
3b09b74bf65867d882af87ec60e2a517b15264a6Jakub Hrozek it is safe to transition between the initrd and the real root,
3b09b74bf65867d882af87ec60e2a517b15264a6Jakub Hrozek and back.</para>
3b09b74bf65867d882af87ec60e2a517b15264a6Jakub Hrozek <para>The configuration files are read from the files located in the
3b09b74bf65867d882af87ec60e2a517b15264a6Jakub Hrozek system network directory <filename>/usr/lib/systemd/network</filename>,
3b09b74bf65867d882af87ec60e2a517b15264a6Jakub Hrozek the volatile runtime network directory
3b09b74bf65867d882af87ec60e2a517b15264a6Jakub Hrozek <filename>/run/systemd/network</filename> and the local administration
3b09b74bf65867d882af87ec60e2a517b15264a6Jakub Hrozek network directory <filename>/etc/systemd/network</filename>.
3b09b74bf65867d882af87ec60e2a517b15264a6Jakub Hrozek All configuration files are collectively sorted and processed in lexical order,
e5b34f0166ae61468e53f369578e691ddb09cdd0Pavel Březina regardless of the directories in which they live. However, files with
e5b34f0166ae61468e53f369578e691ddb09cdd0Pavel Březina identical filenames replace each other. Files in
e5b34f0166ae61468e53f369578e691ddb09cdd0Pavel Březina <filename>/etc</filename> have the highest priority, files in
e5b34f0166ae61468e53f369578e691ddb09cdd0Pavel Březina <filename>/run</filename> take precedence over files with the same
e5b34f0166ae61468e53f369578e691ddb09cdd0Pavel Březina name in <filename>/usr/lib</filename>. This can be used to override a
e5b34f0166ae61468e53f369578e691ddb09cdd0Pavel Březina system-supplied configuration file with a local file if needed; a symlink in
5ff1c3c5a12930692cb6284d14f7fda3a974af8ePavel Březina <filename>/etc</filename> with the same name as a configuration file in
e5b34f0166ae61468e53f369578e691ddb09cdd0Pavel Březina <filename>/usr/lib</filename>, pointing to <filename>/dev/null</filename>,
e5b34f0166ae61468e53f369578e691ddb09cdd0Pavel Březina disables the configuration file entirely.</para>
e5b34f0166ae61468e53f369578e691ddb09cdd0Pavel Březina <refsect2><title>Virtual Network Devices</title>
e5b34f0166ae61468e53f369578e691ddb09cdd0Pavel Březina <para>Virtual Network Device files must have the extension
3b09b74bf65867d882af87ec60e2a517b15264a6Jakub Hrozek <filename>.netdev</filename>; other extensions are ignored. Virtual
3b09b74bf65867d882af87ec60e2a517b15264a6Jakub Hrozek network devices are created as soon as networkd is started.</para>
3b09b74bf65867d882af87ec60e2a517b15264a6Jakub Hrozek <para>The <literal>[NetDev]</literal> section accepts the following
3b09b74bf65867d882af87ec60e2a517b15264a6Jakub Hrozek keys:</para>
3b09b74bf65867d882af87ec60e2a517b15264a6Jakub Hrozek <varlistentry>
3b09b74bf65867d882af87ec60e2a517b15264a6Jakub Hrozek <para>The interface name used when creating the
a3c8390d19593b1e5277d95bfb4ab206d4785150Nikolai Kondrashov bridge. This option is compulsory.</para>
3b09b74bf65867d882af87ec60e2a517b15264a6Jakub Hrozek </varlistentry>
3b09b74bf65867d882af87ec60e2a517b15264a6Jakub Hrozek <varlistentry>
3b09b74bf65867d882af87ec60e2a517b15264a6Jakub Hrozek <para>The netdev kind. Currently, 'bridge', 'bond' and 'vlan'
3b09b74bf65867d882af87ec60e2a517b15264a6Jakub Hrozek are supported. This option is compulsory.</para>
3b09b74bf65867d882af87ec60e2a517b15264a6Jakub Hrozek </varlistentry>
3b09b74bf65867d882af87ec60e2a517b15264a6Jakub Hrozek </variablelist>
3b09b74bf65867d882af87ec60e2a517b15264a6Jakub Hrozek <para>The <literal>[VLAN]</literal> section only applies for netdevs of kind 'vlan',
3b09b74bf65867d882af87ec60e2a517b15264a6Jakub Hrozek and accepts the following keys:</para>
3b09b74bf65867d882af87ec60e2a517b15264a6Jakub Hrozek <varlistentry>
3b09b74bf65867d882af87ec60e2a517b15264a6Jakub Hrozek <para>The VLAN ID to use. This option is compulsory.</para>
3b09b74bf65867d882af87ec60e2a517b15264a6Jakub Hrozek </varlistentry>
e5b34f0166ae61468e53f369578e691ddb09cdd0Pavel Březina </variablelist>
3b09b74bf65867d882af87ec60e2a517b15264a6Jakub Hrozek <para>Network files must have the extension <filename>.network</filename>;
3b09b74bf65867d882af87ec60e2a517b15264a6Jakub Hrozek other extensions are ignored. Networks are applied to links whenever the links
c47e9d522f0d87259e5074ea643daaa3dfcb8d92Pavel Březina appear.</para>
e5b34f0166ae61468e53f369578e691ddb09cdd0Pavel Březina <para>The network file contains a <literal>[Match]</literal> section,
c47e9d522f0d87259e5074ea643daaa3dfcb8d92Pavel Březina which determines if a given network file may be applied to a given device;
e5b34f0166ae61468e53f369578e691ddb09cdd0Pavel Březina and a <literal>[Network]</literal> section specifying how the device should
e5b34f0166ae61468e53f369578e691ddb09cdd0Pavel Březina be configured. The first (in lexical order) of the network files that
c47e9d522f0d87259e5074ea643daaa3dfcb8d92Pavel Březina matches a given device is applied.</para>
c47e9d522f0d87259e5074ea643daaa3dfcb8d92Pavel Březina <para>A network file is said to match a device if each of the entries in the
3b09b74bf65867d882af87ec60e2a517b15264a6Jakub Hrozek <literal>[Match]</literal> section matches, or if the section is empty.
dea636af4d1902a081ee891f1b19ee2f8729d759Pavel Březina The following keys are accepted:</para>
3b09b74bf65867d882af87ec60e2a517b15264a6Jakub Hrozek <varlistentry>
a3c8390d19593b1e5277d95bfb4ab206d4785150Nikolai Kondrashov </varlistentry>
3b09b74bf65867d882af87ec60e2a517b15264a6Jakub Hrozek <varlistentry>
3b09b74bf65867d882af87ec60e2a517b15264a6Jakub Hrozek <para>The persistent path, as exposed by the udev
a3c8390d19593b1e5277d95bfb4ab206d4785150Nikolai Kondrashov </varlistentry>
e5b34f0166ae61468e53f369578e691ddb09cdd0Pavel Březina <varlistentry>
dea636af4d1902a081ee891f1b19ee2f8729d759Pavel Březina <para>The driver currently bound to the device, as
dea636af4d1902a081ee891f1b19ee2f8729d759Pavel Březina exposed by the udev property <literal>DRIVER</literal>.
dea636af4d1902a081ee891f1b19ee2f8729d759Pavel Březina </varlistentry>
e5b34f0166ae61468e53f369578e691ddb09cdd0Pavel Březina <varlistentry>
e5b34f0166ae61468e53f369578e691ddb09cdd0Pavel Březina <para>The device type, as exposed by the udev property
e5b34f0166ae61468e53f369578e691ddb09cdd0Pavel Březina </varlistentry>
e5b34f0166ae61468e53f369578e691ddb09cdd0Pavel Březina <varlistentry>
e5b34f0166ae61468e53f369578e691ddb09cdd0Pavel Březina <para>The device name, as exposed by the udev property
e5b34f0166ae61468e53f369578e691ddb09cdd0Pavel Březina </varlistentry>
dfef1d050c35398c6061256a947b4cc9c1f4b8e6Pavel Březina </variablelist>
dfef1d050c35398c6061256a947b4cc9c1f4b8e6Pavel Březina <para>The <literal>[Network]</literal> section accepts the following keys:</para>
dfef1d050c35398c6061256a947b4cc9c1f4b8e6Pavel Březina <varlistentry>
e5b34f0166ae61468e53f369578e691ddb09cdd0Pavel Březina <para>A description of the device. This is only used for
e5b34f0166ae61468e53f369578e691ddb09cdd0Pavel Březina presentation purposes.</para>
a3c8390d19593b1e5277d95bfb4ab206d4785150Nikolai Kondrashov </varlistentry>
e5b34f0166ae61468e53f369578e691ddb09cdd0Pavel Březina <varlistentry>
dfef1d050c35398c6061256a947b4cc9c1f4b8e6Pavel Březina <para>A boolean. When true enables basic DHCPv4 support.</para>
e5b34f0166ae61468e53f369578e691ddb09cdd0Pavel Březina </varlistentry>
e5b34f0166ae61468e53f369578e691ddb09cdd0Pavel Březina <varlistentry>
e5b34f0166ae61468e53f369578e691ddb09cdd0Pavel Březina <para>A static IPv4 or IPv6 address and its prefix length,
dfef1d050c35398c6061256a947b4cc9c1f4b8e6Pavel Březina separated by a '/' character. The format of the address must
dfef1d050c35398c6061256a947b4cc9c1f4b8e6Pavel Březina be as described in
dfef1d050c35398c6061256a947b4cc9c1f4b8e6Pavel Březina <citerefentry><refentrytitle>inet_pton</refentrytitle><manvolnum>3</manvolnum></citerefentry>
dfef1d050c35398c6061256a947b4cc9c1f4b8e6Pavel Březina . This is a short-hand for an [Address] section only containing an Address key (see below).</para>
3b09b74bf65867d882af87ec60e2a517b15264a6Jakub Hrozek </varlistentry>
3b09b74bf65867d882af87ec60e2a517b15264a6Jakub Hrozek <varlistentry>
e5b34f0166ae61468e53f369578e691ddb09cdd0Pavel Březina <para>The gateway address, which must be in the format described in
a3c8390d19593b1e5277d95bfb4ab206d4785150Nikolai Kondrashov <citerefentry><refentrytitle>inet_pton</refentrytitle><manvolnum>3</manvolnum></citerefentry>
e5b34f0166ae61468e53f369578e691ddb09cdd0Pavel Březina . This is a short-hand for a [Route] section only containing a Gateway key.</para>
3b09b74bf65867d882af87ec60e2a517b15264a6Jakub Hrozek </varlistentry>
3b09b74bf65867d882af87ec60e2a517b15264a6Jakub Hrozek <varlistentry>
3b09b74bf65867d882af87ec60e2a517b15264a6Jakub Hrozek <para>A DNS server address, which must be in the format described in
3b09b74bf65867d882af87ec60e2a517b15264a6Jakub Hrozek <citerefentry><refentrytitle>inet_pton</refentrytitle><manvolnum>3</manvolnum></citerefentry>
3b09b74bf65867d882af87ec60e2a517b15264a6Jakub Hrozek </varlistentry>
3b09b74bf65867d882af87ec60e2a517b15264a6Jakub Hrozek <varlistentry>