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   SPDX-License-Identifier: LGPL-2.1+
   7
   8   This file is part of systemd.
   9
  10   Copyright 2013 Tom Gundersen
  11
  12   systemd is free software; you can redistribute it and/or modify it
  13   under the terms of the GNU Lesser General Public License as published by
  14   the Free Software Foundation; either version 2.1 of the License, or
  15   (at your option) any later version.
  16
  17   systemd is distributed in the hope that it will be useful, but
  18   WITHOUT ANY WARRANTY; without even the implied warranty of
  19   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  20   Lesser General Public License for more details.
  21
  22   You should have received a copy of the GNU Lesser General Public License
  23   along with systemd; If not, see <http://www.gnu.org/licenses/>.
  24 -->
  25
  26 <refentry id="systemd-networkd.service" conditional='ENABLE_NETWORKD'>
  27
  28   <refentryinfo>
  29     <title>systemd-networkd.service</title>
  30     <productname>systemd</productname>
  31
  32     <authorgroup>
  33       <author>
  34         <contrib>Developer</contrib>
  35         <firstname>Tom</firstname>
  36         <surname>Gundersen</surname>
  37         <email>teg@jklm.no</email>
  38       </author>
  39     </authorgroup>
  40   </refentryinfo>
  41
  42   <refmeta>
  43     <refentrytitle>systemd-networkd.service</refentrytitle>
  44     <manvolnum>8</manvolnum>
  45   </refmeta>
  46
  47   <refnamediv>
  48     <refname>systemd-networkd.service</refname>
  49     <refname>systemd-networkd</refname>
  50     <refpurpose>Network manager</refpurpose>
  51   </refnamediv>
  52
  53   <refsynopsisdiv>
  54     <para><filename>systemd-networkd.service</filename></para>
  55     <para><filename>/usr/lib/systemd/systemd-networkd</filename></para>
  56   </refsynopsisdiv>
  57
  58   <refsect1>
  59     <title>Description</title>
  60
  61     <para><command>systemd-networkd</command> is a system service that
  62     manages networks. It detects and configures network devices as
  63     they appear, as well as creating virtual network devices.</para>
  64
  65     <para>To configure low-level link settings independently of
  66     networks, see
  67     <citerefentry><refentrytitle>systemd.link</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para>
  68
  69     <para><command>systemd-networkd</command> will create network devices based
  70     on the configuration in
  71     <citerefentry><refentrytitle>systemd.netdev</refentrytitle><manvolnum>5</manvolnum></citerefentry>
  72     files, respecting the [Match] sections in those files.</para>
  73
  74     <para><command>systemd-networkd</command> will manage network addresses and
  75     routes for any link for which it finds a <filename>.network</filename> file
  76     with an appropriate [Match] section, see
  77     <citerefentry><refentrytitle>systemd.network</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
  78     For those links, it will flush existing network addresses and routes when
  79     bringing up the device. Any links not matched by one of the
  80     <filename>.network</filename> files will be ignored. It is also possible to
  81     explicitly tell <filename>systemd-networkd</filename> to ignore a link by
  82     using <varname>Unmanaged=yes</varname> option, see
  83     <citerefentry><refentrytitle>systemd.network</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
  84     </para>
  85
  86     <para>When <filename>systemd-networkd</filename> exits, it generally leaves
  87     existing network devices and configuration intact. This makes it possible to
  88     transition from the initrams and to restart the service without breaking
  89     connectivity. This also means that when configuration is updated and
  90     <filename>systemd-networkd</filename> is restarted, netdev interfaces for
  91     which configuration was removed will not be dropped, and may need to be
  92     cleaned up manually.</para>
  93   </refsect1>
  94
  95   <refsect1><title>Configuration Files</title>
  96     <para>The configuration files are read from the files located in the
  97     system network directory <filename>/usr/lib/systemd/network</filename>,
  98     the volatile runtime network directory
  99     <filename>/run/systemd/network</filename> and the local administration
 100     network directory <filename>/etc/systemd/network</filename>.</para>
 101
 102     <para>Networks are configured in <filename>.network</filename>
 103     files, see
 104     <citerefentry><refentrytitle>systemd.network</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
 105     and virtual network devices are configured in
 106     <filename>.netdev</filename> files, see
 107     <citerefentry><refentrytitle>systemd.netdev</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
 108     </para>
 109   </refsect1>
 110
 111   <refsect1>
 112     <title>See Also</title>
 113     <para>
 114       <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
 115       <citerefentry><refentrytitle>systemd.link</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
 116       <citerefentry><refentrytitle>systemd.network</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
 117       <citerefentry><refentrytitle>systemd.netdev</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
 118       <citerefentry><refentrytitle>systemd-networkd-wait-online.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>
 119     </para>
 120   </refsect1>
 121
 122 </refentry>