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   Copyright © 2013 Tom Gundersen
   9 -->
  10
  11 <refentry id="systemd-networkd.service" conditional='ENABLE_NETWORKD'>
  12
  13   <refentryinfo>
  14     <title>systemd-networkd.service</title>
  15     <productname>systemd</productname>
  16
  17     <authorgroup>
  18       <author>
  19         <contrib>Developer</contrib>
  20         <firstname>Tom</firstname>
  21         <surname>Gundersen</surname>
  22         <email>teg@jklm.no</email>
  23       </author>
  24     </authorgroup>
  25   </refentryinfo>
  26
  27   <refmeta>
  28     <refentrytitle>systemd-networkd.service</refentrytitle>
  29     <manvolnum>8</manvolnum>
  30   </refmeta>
  31
  32   <refnamediv>
  33     <refname>systemd-networkd.service</refname>
  34     <refname>systemd-networkd</refname>
  35     <refpurpose>Network manager</refpurpose>
  36   </refnamediv>
  37
  38   <refsynopsisdiv>
  39     <para><filename>systemd-networkd.service</filename></para>
  40     <para><filename>/usr/lib/systemd/systemd-networkd</filename></para>
  41   </refsynopsisdiv>
  42
  43   <refsect1>
  44     <title>Description</title>
  45
  46     <para><command>systemd-networkd</command> is a system service that
  47     manages networks. It detects and configures network devices as
  48     they appear, as well as creating virtual network devices.</para>
  49
  50     <para>To configure low-level link settings independently of
  51     networks, see
  52     <citerefentry><refentrytitle>systemd.link</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para>
  53
  54     <para><command>systemd-networkd</command> will create network devices based
  55     on the configuration in
  56     <citerefentry><refentrytitle>systemd.netdev</refentrytitle><manvolnum>5</manvolnum></citerefentry>
  57     files, respecting the [Match] sections in those files.</para>
  58
  59     <para><command>systemd-networkd</command> will manage network addresses and
  60     routes for any link for which it finds a <filename>.network</filename> file
  61     with an appropriate [Match] section, see
  62     <citerefentry><refentrytitle>systemd.network</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
  63     For those links, it will flush existing network addresses and routes when
  64     bringing up the device. Any links not matched by one of the
  65     <filename>.network</filename> files will be ignored. It is also possible to
  66     explicitly tell <filename>systemd-networkd</filename> to ignore a link by
  67     using <varname>Unmanaged=yes</varname> option, see
  68     <citerefentry><refentrytitle>systemd.network</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
  69     </para>
  70
  71     <para>When <filename>systemd-networkd</filename> exits, it generally leaves
  72     existing network devices and configuration intact. This makes it possible to
  73     transition from the initrams and to restart the service without breaking
  74     connectivity. This also means that when configuration is updated and
  75     <filename>systemd-networkd</filename> is restarted, netdev interfaces for
  76     which configuration was removed will not be dropped, and may need to be
  77     cleaned up manually.</para>
  78   </refsect1>
  79
  80   <refsect1><title>Configuration Files</title>
  81     <para>The configuration files are read from the files located in the
  82     system network directory <filename>/usr/lib/systemd/network</filename>,
  83     the volatile runtime network directory
  84     <filename>/run/systemd/network</filename> and the local administration
  85     network directory <filename>/etc/systemd/network</filename>.</para>
  86
  87     <para>Networks are configured in <filename>.network</filename>
  88     files, see
  89     <citerefentry><refentrytitle>systemd.network</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
  90     and virtual network devices are configured in
  91     <filename>.netdev</filename> files, see
  92     <citerefentry><refentrytitle>systemd.netdev</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
  93     </para>
  94   </refsect1>
  95
  96   <refsect1>
  97     <title>See Also</title>
  98     <para>
  99       <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
 100       <citerefentry><refentrytitle>systemd.link</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
 101       <citerefentry><refentrytitle>systemd.network</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
 102       <citerefentry><refentrytitle>systemd.netdev</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
 103       <citerefentry><refentrytitle>systemd-networkd-wait-online.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>
 104     </para>
 105   </refsect1>
 106
 107 </refentry>