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