man/systemd-networkd.service.xml

   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-networkd.service" conditional='ENABLE_NETWORKD'>
  25
  26   <refentryinfo>
  27     <title>systemd-networkd.service</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-networkd.service</refentrytitle>
  42     <manvolnum>8</manvolnum>
  43   </refmeta>
  44
  45   <refnamediv>
  46     <refname>systemd-networkd.service</refname>
  47     <refname>systemd-networkd</refname>
  48     <refpurpose>Network manager</refpurpose>
  49   </refnamediv>
  50
  51   <refsynopsisdiv>
  52     <para><filename>systemd-networkd.service</filename></para>
  53     <para><filename>/usr/lib/systemd/systemd-networkd</filename></para>
  54   </refsynopsisdiv>
  55
  56   <refsect1>
  57     <title>Description</title>
  58
  59     <para><command>systemd-networkd</command> is a system service that
  60     manages networks. It detects and configures network devices as
  61     they appear, as well as creating virtual network devices.</para>
  62
  63     <para>To configure low-level link settings independently of
  64     networks, see
  65     <citerefentry><refentrytitle>systemd.link</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para>
  66
  67     <para><command>systemd-networkd</command> will create network devices based
  68     on the configuration in
  69     <citerefentry><refentrytitle>systemd.netdev</refentrytitle><manvolnum>5</manvolnum></citerefentry>
  70     files, respecting the [Match] sections in those files.</para>
  71
  72     <para><command>systemd-networkd</command> will manage network addresses and
  73     routes for any link for which it finds a <filename>.network</filename> file
  74     with an appropriate [Match] section, see
  75     <citerefentry><refentrytitle>systemd.network</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
  76     For those links, it will flush existing network addresses and routes when
  77     bringing up the device. Any links not matched by one of the
  78     <filename>.network</filename> files will be ignored. It is also possible to
  79     explicitly tell <filename>systemd-networkd</filename> to ignore a link by
  80     using <varname>Unmanaged=yes</varname> option, see
  81     <citerefentry><refentrytitle>systemd.network</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
  82     </para>
  83
  84     <para>When <filename>systemd-networkd</filename> exits, it generally leaves
  85     existing network devices and configuration intact. This makes it possible to
  86     transition from the initrams and to restart the service without breaking
  87     connectivity. This also means that when configuration is updated and
  88     <filename>systemd-networkd</filename> is restarted, netdev interfaces for
  89     which configuration was removed will not be dropped, and may need to be
  90     cleaned up manually.</para>
  91   </refsect1>
  92
  93   <refsect1><title>Configuration Files</title>
  94     <para>The configuration files are read from the files located in the
  95     system network directory <filename>/usr/lib/systemd/network</filename>,
  96     the volatile runtime network directory
  97     <filename>/run/systemd/network</filename> and the local administration
  98     network directory <filename>/etc/systemd/network</filename>.</para>
  99
 100     <para>Networks are configured in <filename>.network</filename>
 101     files, see
 102     <citerefentry><refentrytitle>systemd.network</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
 103     and virtual network devices are configured in
 104     <filename>.netdev</filename> files, see
 105     <citerefentry><refentrytitle>systemd.netdev</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
 106     </para>
 107   </refsect1>
 108
 109   <refsect1>
 110     <title>See Also</title>
 111     <para>
 112       <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
 113       <citerefentry><refentrytitle>systemd.link</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
 114       <citerefentry><refentrytitle>systemd.network</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
 115       <citerefentry><refentrytitle>systemd.netdev</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
 116       <citerefentry><refentrytitle>systemd-networkd-wait-online.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>
 117     </para>
 118   </refsect1>
 119
 120 </refentry>