systemd.network.xml revision aba496a58acf9d9c61314de71353550e579f85ee
5c79bd79839f1e50bd3c34a0670037f7965ca5a4Patrik Flykt<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
5c79bd79839f1e50bd3c34a0670037f7965ca5a4Patrik Flykt "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
5c79bd79839f1e50bd3c34a0670037f7965ca5a4Patrik Flykt This file is part of systemd.
5c79bd79839f1e50bd3c34a0670037f7965ca5a4Patrik Flykt Copyright 2013 Tom Gundersen
5c79bd79839f1e50bd3c34a0670037f7965ca5a4Patrik Flykt systemd is free software; you can redistribute it and/or modify it
5c79bd79839f1e50bd3c34a0670037f7965ca5a4Patrik Flykt under the terms of the GNU Lesser General Public License as published by
5c79bd79839f1e50bd3c34a0670037f7965ca5a4Patrik Flykt the Free Software Foundation; either version 2.1 of the License, or
5c79bd79839f1e50bd3c34a0670037f7965ca5a4Patrik Flykt (at your option) any later version.
5c79bd79839f1e50bd3c34a0670037f7965ca5a4Patrik Flykt systemd is distributed in the hope that it will be useful, but
5c79bd79839f1e50bd3c34a0670037f7965ca5a4Patrik Flykt WITHOUT ANY WARRANTY; without even the implied warranty of
5c79bd79839f1e50bd3c34a0670037f7965ca5a4Patrik Flykt MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
5c79bd79839f1e50bd3c34a0670037f7965ca5a4Patrik Flykt Lesser General Public License for more details.
5c79bd79839f1e50bd3c34a0670037f7965ca5a4Patrik Flykt You should have received a copy of the GNU Lesser General Public License
5c79bd79839f1e50bd3c34a0670037f7965ca5a4Patrik Flykt along with systemd; If not, see <http://www.gnu.org/licenses/>.
5c79bd79839f1e50bd3c34a0670037f7965ca5a4Patrik Flykt<refentry id="systemd.network" conditional='ENABLE_NETWORKD'>
5c79bd79839f1e50bd3c34a0670037f7965ca5a4Patrik Flykt <refentryinfo>
be3a09b7ffe62b52658e77ae4d6638d1b0dae654Patrik Flykt <authorgroup>
1c4baffc1895809bae9ac36b670af90a4cb9cd7dTom Gundersen </authorgroup>
c62c4628d9dbc27effd36143c75abe528f561867Patrik Flykt </refentryinfo>
c62c4628d9dbc27effd36143c75abe528f561867Patrik Flykt <refnamediv>
be3a09b7ffe62b52658e77ae4d6638d1b0dae654Patrik Flykt </refnamediv>
be3a09b7ffe62b52658e77ae4d6638d1b0dae654Patrik Flykt <refsynopsisdiv>
be3a09b7ffe62b52658e77ae4d6638d1b0dae654Patrik Flykt <para><filename><replaceable>network</replaceable>.network</filename></para>
be3a09b7ffe62b52658e77ae4d6638d1b0dae654Patrik Flykt </refsynopsisdiv>
c62c4628d9dbc27effd36143c75abe528f561867Patrik Flykt <para>Network setup is performed by
c62c4628d9dbc27effd36143c75abe528f561867Patrik Flykt <citerefentry><refentrytitle>systemd-networkd</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
c62c4628d9dbc27effd36143c75abe528f561867Patrik Flykt <para>Network files must have the extension <filename>.network</filename>;
c62c4628d9dbc27effd36143c75abe528f561867Patrik Flykt other extensions are ignored. Networks are applied to links whenever the links
c62c4628d9dbc27effd36143c75abe528f561867Patrik Flykt appear.</para>
36c32f6120a0c3fe19be5aeaa1926e179e8c29baTom Gundersen <para>The <filename>.network</filename> files are read from the files located in the
6d8f6b0b2ae14aee0b02c7e3d1edaeaa2c118056Tom Gundersen system network directory <filename>/usr/lib/systemd/network</filename>,
c62c4628d9dbc27effd36143c75abe528f561867Patrik Flykt the volatile runtime network directory
c62c4628d9dbc27effd36143c75abe528f561867Patrik Flykt <filename>/run/systemd/network</filename> and the local administration
c62c4628d9dbc27effd36143c75abe528f561867Patrik Flykt network directory <filename>/etc/systemd/network</filename>.
f0213e3796b4dd66e546e2de4d677db319f9171bTom Gundersen All configuration files are collectively sorted and processed in lexical order,
c62c4628d9dbc27effd36143c75abe528f561867Patrik Flykt regardless of the directories in which they live. However, files with
c62c4628d9dbc27effd36143c75abe528f561867Patrik Flykt identical filenames replace each other. Files in
c62c4628d9dbc27effd36143c75abe528f561867Patrik Flykt <filename>/etc</filename> have the highest priority, files in
c62c4628d9dbc27effd36143c75abe528f561867Patrik Flykt <filename>/run</filename> take precedence over files with the same
c62c4628d9dbc27effd36143c75abe528f561867Patrik Flykt name in <filename>/usr/lib</filename>. This can be used to override a
851c9f82736c89d423b244a292e153ec7124d309Patrik Flykt system-supplied configuration file with a local file if needed; a symlink in
851c9f82736c89d423b244a292e153ec7124d309Patrik Flykt <filename>/etc</filename> with the same name as a configuration file in
6d8f6b0b2ae14aee0b02c7e3d1edaeaa2c118056Tom Gundersen <filename>/usr/lib</filename>, pointing to <filename>/dev/null</filename>,
c62c4628d9dbc27effd36143c75abe528f561867Patrik Flykt disables the configuration file entirely.</para>
c62c4628d9dbc27effd36143c75abe528f561867Patrik Flykt <para>The network file contains a <literal>[Match]</literal> section,
c62c4628d9dbc27effd36143c75abe528f561867Patrik Flykt which determines if a given network file may be applied to a given device;
f2341e0a87cab1558c84c933956e9181d5fb6c52Lennart Poettering and a <literal>[Network]</literal> section specifying how the device should
4d7b83da7b78647f4ba3f1d6fa2dc8d7b9833d93Tom Gundersen be configured. The first (in lexical order) of the network files that
4d7b83da7b78647f4ba3f1d6fa2dc8d7b9833d93Tom Gundersen matches a given device is applied.</para>
c62c4628d9dbc27effd36143c75abe528f561867Patrik Flykt <para>A network file is said to match a device if each of the entries in the
6666907869fb3bc7fe6a6025540db5b887c7a78bTom Gundersen <literal>[Match]</literal> section matches, or if the section is empty.
c62c4628d9dbc27effd36143c75abe528f561867Patrik Flykt The following keys are accepted:</para>
c62c4628d9dbc27effd36143c75abe528f561867Patrik Flykt <varlistentry>
c62c4628d9dbc27effd36143c75abe528f561867Patrik Flykt </varlistentry>
c62c4628d9dbc27effd36143c75abe528f561867Patrik Flykt <varlistentry>
c62c4628d9dbc27effd36143c75abe528f561867Patrik Flykt <para>The persistent path, as exposed by the udev
c62c4628d9dbc27effd36143c75abe528f561867Patrik Flykt property <literal>ID_PATH</literal>. May contain shell
c62c4628d9dbc27effd36143c75abe528f561867Patrik Flykt style globs.</para>
c62c4628d9dbc27effd36143c75abe528f561867Patrik Flykt </varlistentry>
c62c4628d9dbc27effd36143c75abe528f561867Patrik Flykt <varlistentry>
c62c4628d9dbc27effd36143c75abe528f561867Patrik Flykt <para>The driver currently bound to the device, as
c62c4628d9dbc27effd36143c75abe528f561867Patrik Flykt exposed by the udev property <literal>DRIVER</literal>
6d8f6b0b2ae14aee0b02c7e3d1edaeaa2c118056Tom Gundersen of its parent device, or if that is not set the driver
c62c4628d9dbc27effd36143c75abe528f561867Patrik Flykt as exposed by <literal>ethtool -i</literal> of the
c62c4628d9dbc27effd36143c75abe528f561867Patrik Flykt device itself.</para>
c62c4628d9dbc27effd36143c75abe528f561867Patrik Flykt </varlistentry>
c62c4628d9dbc27effd36143c75abe528f561867Patrik Flykt <varlistentry>
5c79bd79839f1e50bd3c34a0670037f7965ca5a4Patrik Flykt <para>The device type, as exposed by the udev property
5c79bd79839f1e50bd3c34a0670037f7965ca5a4Patrik Flykt </varlistentry>
5c79bd79839f1e50bd3c34a0670037f7965ca5a4Patrik Flykt <varlistentry>
5c79bd79839f1e50bd3c34a0670037f7965ca5a4Patrik Flykt <para>The device name, as exposed by the udev property
5c79bd79839f1e50bd3c34a0670037f7965ca5a4Patrik Flykt <literal>INTERFACE</literal>. May contain shell style
5c79bd79839f1e50bd3c34a0670037f7965ca5a4Patrik Flykt globs.</para>
5c79bd79839f1e50bd3c34a0670037f7965ca5a4Patrik Flykt </varlistentry>
10c9ce615d98e125bc520efa94aebaef250a4061David Herrmann <varlistentry>
3098562c9236fe0bd3e7d950b6c53907304d277fTom Gundersen <para>Matches against the hostname or machine ID of the
3098562c9236fe0bd3e7d950b6c53907304d277fTom Gundersen host. See <literal>ConditionHost=</literal> in
18d29550b5fbc4b0de334b8212d05decdd131f1bPatrik Flykt <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>
18d29550b5fbc4b0de334b8212d05decdd131f1bPatrik Flykt for details.
10c9ce615d98e125bc520efa94aebaef250a4061David Herrmann </varlistentry>
c62c4628d9dbc27effd36143c75abe528f561867Patrik Flykt <varlistentry>
c62c4628d9dbc27effd36143c75abe528f561867Patrik Flykt <term><varname>Virtualization=</varname></term>
c62c4628d9dbc27effd36143c75abe528f561867Patrik Flykt <para>Checks whether the system is executed in a virtualized
c62c4628d9dbc27effd36143c75abe528f561867Patrik Flykt environment and optionally test whether it is a specific
c62c4628d9dbc27effd36143c75abe528f561867Patrik Flykt implementation. See <literal>ConditionVirtualization=</literal> in
c62c4628d9dbc27effd36143c75abe528f561867Patrik Flykt <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>
c62c4628d9dbc27effd36143c75abe528f561867Patrik Flykt </varlistentry>
c62c4628d9dbc27effd36143c75abe528f561867Patrik Flykt <varlistentry>
c62c4628d9dbc27effd36143c75abe528f561867Patrik Flykt <term><varname>KernelCommandLine=</varname></term>
18d29550b5fbc4b0de334b8212d05decdd131f1bPatrik Flykt <para>Checks whether a specific kernel command line option is
5c79bd79839f1e50bd3c34a0670037f7965ca5a4Patrik Flykt set (or if prefixed with the exclamation mark unset). See
5c79bd79839f1e50bd3c34a0670037f7965ca5a4Patrik Flykt <literal>ConditionKernelCommandLine=</literal> in
5c79bd79839f1e50bd3c34a0670037f7965ca5a4Patrik Flykt <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>
5c79bd79839f1e50bd3c34a0670037f7965ca5a4Patrik Flykt for details.
e53fc357a9bb9d0a5362ccc4246d598cb0febd5eLennart Poettering </varlistentry>
5c79bd79839f1e50bd3c34a0670037f7965ca5a4Patrik Flykt <varlistentry>
8012cd391932d58b44332df106d426a360faf0a6Tom Gundersen <para>Checks whether the system is running on a specific
5c79bd79839f1e50bd3c34a0670037f7965ca5a4Patrik Flykt architecture. See <literal>ConditionArchitecture=</literal> in
5c79bd79839f1e50bd3c34a0670037f7965ca5a4Patrik Flykt <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>
5c79bd79839f1e50bd3c34a0670037f7965ca5a4Patrik Flykt </varlistentry>
7a695d8e1fda59857c4c23bcb50cd1e0aaf4a854Tom Gundersen </variablelist>
5c79bd79839f1e50bd3c34a0670037f7965ca5a4Patrik Flykt <para>The <literal>[Network]</literal> section accepts the following keys:</para>
7a695d8e1fda59857c4c23bcb50cd1e0aaf4a854Tom Gundersen <varlistentry>
7a695d8e1fda59857c4c23bcb50cd1e0aaf4a854Tom Gundersen <para>A description of the device. This is only used for
85bd849f09aceb7f972a0697494ea22b2247a5d7Patrik Flykt presentation purposes.</para>
7a695d8e1fda59857c4c23bcb50cd1e0aaf4a854Tom Gundersen </varlistentry>
7a695d8e1fda59857c4c23bcb50cd1e0aaf4a854Tom Gundersen <varlistentry>
e66040417b52be98d41ba1230f25dea65147e8eePatrik Flykt <para>A boolean. When true, enables basic DHCPv4 support.</para>
7a695d8e1fda59857c4c23bcb50cd1e0aaf4a854Tom Gundersen </varlistentry>
7a695d8e1fda59857c4c23bcb50cd1e0aaf4a854Tom Gundersen <varlistentry>
85bd849f09aceb7f972a0697494ea22b2247a5d7Patrik Flykt <para>A boolean. When true, enables IPv4 link-local support.
7a695d8e1fda59857c4c23bcb50cd1e0aaf4a854Tom Gundersen If <literal>DHCP=</literal> is also true, acquiring DHCP address
7a695d8e1fda59857c4c23bcb50cd1e0aaf4a854Tom Gundersen will deprecate previously acquired IPv4 link-local address or
7a695d8e1fda59857c4c23bcb50cd1e0aaf4a854Tom Gundersen stop acquiring process if there hasn't been one acquired before.
85bd849f09aceb7f972a0697494ea22b2247a5d7Patrik Flykt </varlistentry>
7a695d8e1fda59857c4c23bcb50cd1e0aaf4a854Tom Gundersen <varlistentry>
85bd849f09aceb7f972a0697494ea22b2247a5d7Patrik Flykt <para>A static IPv4 or IPv6 address and its prefix length,
7a695d8e1fda59857c4c23bcb50cd1e0aaf4a854Tom Gundersen separated by a <literal>/</literal> character. Specify this
7a695d8e1fda59857c4c23bcb50cd1e0aaf4a854Tom Gundersen key more than once to configure several addresses.
18d29550b5fbc4b0de334b8212d05decdd131f1bPatrik Flykt The format of the address must be as described in
7a695d8e1fda59857c4c23bcb50cd1e0aaf4a854Tom Gundersen <citerefentry><refentrytitle>inet_pton</refentrytitle><manvolnum>3</manvolnum></citerefentry>.
7a695d8e1fda59857c4c23bcb50cd1e0aaf4a854Tom Gundersen This is a short-hand for an [Address] section only containing
7a695d8e1fda59857c4c23bcb50cd1e0aaf4a854Tom Gundersen an Address key (see below). This option may be specified
7a695d8e1fda59857c4c23bcb50cd1e0aaf4a854Tom Gundersen more than once.
7a695d8e1fda59857c4c23bcb50cd1e0aaf4a854Tom Gundersen </varlistentry>
7a695d8e1fda59857c4c23bcb50cd1e0aaf4a854Tom Gundersen <varlistentry>
7a695d8e1fda59857c4c23bcb50cd1e0aaf4a854Tom Gundersen <para>The gateway address, which must be in the format described in
5c79bd79839f1e50bd3c34a0670037f7965ca5a4Patrik Flykt <citerefentry><refentrytitle>inet_pton</refentrytitle><manvolnum>3</manvolnum></citerefentry>.
e66040417b52be98d41ba1230f25dea65147e8eePatrik Flykt This is a short-hand for a [Route] section only containing a Gateway
5c79bd79839f1e50bd3c34a0670037f7965ca5a4Patrik Flykt key. This option may be specified more than once.</para>
e66040417b52be98d41ba1230f25dea65147e8eePatrik Flykt </varlistentry>
5c79bd79839f1e50bd3c34a0670037f7965ca5a4Patrik Flykt <para>A DNS server address, which must be in the format described in
5c79bd79839f1e50bd3c34a0670037f7965ca5a4Patrik Flykt <citerefentry><refentrytitle>inet_pton</refentrytitle><manvolnum>3</manvolnum></citerefentry>.
e66040417b52be98d41ba1230f25dea65147e8eePatrik Flykt This option may be specified more than once.</para>
5c79bd79839f1e50bd3c34a0670037f7965ca5a4Patrik Flykt </varlistentry>
7a695d8e1fda59857c4c23bcb50cd1e0aaf4a854Tom Gundersen <varlistentry>
5c79bd79839f1e50bd3c34a0670037f7965ca5a4Patrik Flykt <para>The name of the bridge to add the link to.</para>
e66040417b52be98d41ba1230f25dea65147e8eePatrik Flykt </varlistentry>
e66040417b52be98d41ba1230f25dea65147e8eePatrik Flykt <varlistentry>
e66040417b52be98d41ba1230f25dea65147e8eePatrik Flykt <para>The name of the bond to add the link to.</para>
5c79bd79839f1e50bd3c34a0670037f7965ca5a4Patrik Flykt </varlistentry>
7a695d8e1fda59857c4c23bcb50cd1e0aaf4a854Tom Gundersen <varlistentry>
5c79bd79839f1e50bd3c34a0670037f7965ca5a4Patrik Flykt <para>The name of a VLAN to create on the link. This option