]> git.ipfire.org Git - thirdparty/systemd.git/blame - man/systemd-networkd.service.xml
Merge pull request #8822 from fbuihuu/rfc-tmpfiles-safe-upstream
[thirdparty/systemd.git] / man / systemd-networkd.service.xml
CommitLineData
46b0925d
TG
1<?xml version='1.0'?> <!--*-nxml-*-->
2<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
12b42c76 3 "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
46b0925d
TG
4
5<!--
572eb058 6 SPDX-License-Identifier: LGPL-2.1+
46b0925d
TG
7-->
8
2b70d172 9<refentry id="systemd-networkd.service" conditional='ENABLE_NETWORKD'>
46b0925d 10
798d3a52
ZJS
11 <refentryinfo>
12 <title>systemd-networkd.service</title>
13 <productname>systemd</productname>
798d3a52
ZJS
14 </refentryinfo>
15
16 <refmeta>
17 <refentrytitle>systemd-networkd.service</refentrytitle>
18 <manvolnum>8</manvolnum>
19 </refmeta>
20
21 <refnamediv>
22 <refname>systemd-networkd.service</refname>
23 <refname>systemd-networkd</refname>
24 <refpurpose>Network manager</refpurpose>
25 </refnamediv>
26
27 <refsynopsisdiv>
28 <para><filename>systemd-networkd.service</filename></para>
12b42c76 29 <para><filename>/usr/lib/systemd/systemd-networkd</filename></para>
798d3a52
ZJS
30 </refsynopsisdiv>
31
32 <refsect1>
33 <title>Description</title>
34
35 <para><command>systemd-networkd</command> is a system service that
36 manages networks. It detects and configures network devices as
37 they appear, as well as creating virtual network devices.</para>
38
39 <para>To configure low-level link settings independently of
40 networks, see
41 <citerefentry><refentrytitle>systemd.link</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para>
42
1c126944
ZJS
43 <para><command>systemd-networkd</command> will create network devices based
44 on the configuration in
45 <citerefentry><refentrytitle>systemd.netdev</refentrytitle><manvolnum>5</manvolnum></citerefentry>
46 files, respecting the [Match] sections in those files.</para>
47
48 <para><command>systemd-networkd</command> will manage network addresses and
49 routes for any link for which it finds a <filename>.network</filename> file
50 with an appropriate [Match] section, see
51 <citerefentry><refentrytitle>systemd.network</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
52 For those links, it will flush existing network addresses and routes when
53 bringing up the device. Any links not matched by one of the
54 <filename>.network</filename> files will be ignored. It is also possible to
55 explicitly tell <filename>systemd-networkd</filename> to ignore a link by
56 using <varname>Unmanaged=yes</varname> option, see
57 <citerefentry><refentrytitle>systemd.network</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
58 </para>
59
60 <para>When <filename>systemd-networkd</filename> exits, it generally leaves
61 existing network devices and configuration intact. This makes it possible to
62 transition from the initrams and to restart the service without breaking
63 connectivity. This also means that when configuration is updated and
64 <filename>systemd-networkd</filename> is restarted, netdev interfaces for
65 which configuration was removed will not be dropped, and may need to be
66 cleaned up manually.</para>
798d3a52
ZJS
67 </refsect1>
68
69 <refsect1><title>Configuration Files</title>
70 <para>The configuration files are read from the files located in the
12b42c76 71 system network directory <filename>/usr/lib/systemd/network</filename>,
798d3a52
ZJS
72 the volatile runtime network directory
73 <filename>/run/systemd/network</filename> and the local administration
12b42c76 74 network directory <filename>/etc/systemd/network</filename>.</para>
798d3a52
ZJS
75
76 <para>Networks are configured in <filename>.network</filename>
77 files, see
78 <citerefentry><refentrytitle>systemd.network</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
79 and virtual network devices are configured in
80 <filename>.netdev</filename> files, see
81 <citerefentry><refentrytitle>systemd.netdev</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
82 </para>
83 </refsect1>
84
85 <refsect1>
86 <title>See Also</title>
87 <para>
88 <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
89 <citerefentry><refentrytitle>systemd.link</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
90 <citerefentry><refentrytitle>systemd.network</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
91 <citerefentry><refentrytitle>systemd.netdev</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
92 <citerefentry><refentrytitle>systemd-networkd-wait-online.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>
93 </para>
94 </refsect1>
46b0925d
TG
95
96</refentry>