1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
|
<?xml version='1.0'?> <!--*-nxml-*-->
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
<!--
This file is part of systemd.
Copyright 2013 Tom Gundersen
systemd is free software; you can redistribute it and/or modify it
under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation; either version 2.1 of the License, or
(at your option) any later version.
systemd is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public License
along with systemd; If not, see <http://www.gnu.org/licenses/>.
-->
<refentry id="systemd-networkd.service" conditional='ENABLE_NETWORKD'>
<refentryinfo>
<title>systemd-networkd.service</title>
<productname>systemd</productname>
<authorgroup>
<author>
<contrib>Developer</contrib>
<firstname>Tom</firstname>
<surname>Gundersen</surname>
<email>teg@jklm.no</email>
</author>
</authorgroup>
</refentryinfo>
<refmeta>
<refentrytitle>systemd-networkd.service</refentrytitle>
<manvolnum>8</manvolnum>
</refmeta>
<refnamediv>
<refname>systemd-networkd.service</refname>
<refname>systemd-networkd</refname>
<refpurpose>Network manager</refpurpose>
</refnamediv>
<refsynopsisdiv>
<para><filename>systemd-networkd.service</filename></para>
<para><filename>/usr/lib/systemd/systemd-networkd</filename></para>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
<para><command>systemd-networkd</command> is a system
service that manages networks. It detects and configures
network devices as they appear, as well as creating virtual
network devices.</para>
<para>Network configurations applied before networkd is started
are not removed, and configuration applied by networkd are not
removed when networkd exits. This ensures restarting networkd
does not cut the network connection, and, in particular, that
it is safe to transition between the initrd and the real root,
and back.</para>
</refsect1>
<refsect1><title>Configuration Files</title>
<para>The configuration files are read from the files located in the
system network directory <filename>/usr/lib/systemd/network</filename>,
the volatile runtime network directory
<filename>/run/systemd/network</filename> and the local administration
network directory <filename>/etc/systemd/network</filename>.
All configuration files are collectively sorted and processed in lexical order,
regardless of the directories in which they live. However, files with
identical filenames replace each other. Files in
<filename>/etc</filename> have the highest priority, files in
<filename>/run</filename> take precedence over files with the same
name in <filename>/usr/lib</filename>. This can be used to override a
system-supplied configuration file with a local file if needed; a symlink in
<filename>/etc</filename> with the same name as a configuration file in
<filename>/usr/lib</filename>, pointing to <filename>/dev/null</filename>,
disables the configuration file entirely.</para>
<refsect2><title>Virtual Network Devices</title>
<para>Netdev files must have the extension <filename>.netdev</filename>;
other extensions are ignored. Virtual network devices are created as soon
as networkd is started.</para>
<para>The <literal>[Netdev]</literal> section accepts the following
keys:</para>
<variablelist class='network-directives'>
<varlistentry>
<term><varname>Name</varname></term>
<listitem>
<para>The interface name used when creating the
bridge. This option is compulsory.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>Kind</varname></term>
<listitem>
<para>The netdev kind. Currently, 'bridge', 'bond' and 'vlan'
are supported. This option is compulsory.</para>
</listitem>
</varlistentry>
</variablelist>
<para>The <literal>[VLAN]</literal> section only applies for netdevs of kind 'vlan',
and accepts the following keys:</para>
<variablelist class='network-directives'>
<varlistentry>
<term><varname>Id</varname></term>
<listitem>
<para>The VLAN ID to use. This option is compulsory.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect2>
<refsect2><title>Networks</title>
<para>Network files must have the extension <filename>.network</filename>;
other extensions are ignored. Networks are applied to links whenever the links
appear.</para>
<para>The network file contains a <literal>[Match]</literal> section,
which determines if a given network file may be applied to a given device;
and a <literal>[Network]</literal> section specifying how the device should
be configured. The first (in lexical order) of the network files that
matches a given device is applied.</para>
<para>A network file is said to match a device if each of the entries in the
<literal>[Match]</literal> section matches, or if the section is empty.
The following keys are accepted:</para>
<variablelist class='network-directives'>
<varlistentry>
<term><varname>MACAddress</varname></term>
<listitem>
<para>The hardware address.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>Path</varname></term>
<listitem>
<para>The persistent path, as exposed by the udev
property <literal>ID_PATH</literal>.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>Driver</varname></term>
<listitem>
<para>The driver currently bound to the device, as
exposed by the udev property <literal>DRIVER</literal>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>Type</varname></term>
<listitem>
<para>The device type, as exposed by the udev property
<literal>DEVTYPE</literal>.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>Name</varname></term>
<listitem>
<para>The device name, as exposed by the udev property
<literal>INTERFACE</literal>.</para>
</listitem>
</varlistentry>
</variablelist>
<para>The <literal>[Network]</literal> section accepts the following keys:</para>
<variablelist class='network-directives'>
<varlistentry>
<term><varname>Description</varname></term>
<listitem>
<para>A description of the device. This is only used for
presentation purposes.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>DHCP</varname></term>
<listitem>
<para>A boolean. When true enables basic DHCPv4 support.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>Address</varname></term>
<listitem>
<para>A static IPv4 or IPv6 address and its prefix length,
separated by a '/' character. The format of the address must
be as described in
<citerefentry><refentrytitle>inet_pton</refentrytitle><manvolnum>3</manvolnum></citerefentry>
. This is a short-hand for an [Address] section only containing an Address key (see below).</para>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>Gateway</varname></term>
<listitem>
<para>The gateway address, which must be in the format described in
<citerefentry><refentrytitle>inet_pton</refentrytitle><manvolnum>3</manvolnum></citerefentry>
. This is a short-hand for a [Route] section only containing a Gateway key.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>DNS</varname></term>
<listitem>
<para>A DNS server address, which must be in the format described in
<citerefentry><refentrytitle>inet_pton</refentrytitle><manvolnum>3</manvolnum></citerefentry>
.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>Bridge</varname></term>
<listitem>
<para>The name of the bridge to add the configured link to.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>Bond</varname></term>
<listitem>
<para>The name of the bond to add the configured link to.</para>
</listitem>
</varlistentry>
</variablelist>
<para>The <literal>[Address]</literal> section accepts the following keys:</para>
<variablelist class='network-directives'>
<varlistentry>
<term><varname>Address</varname></term>
<listitem>
<para>As in the <literal>[Network]</literal> section. This key is mandatory.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>Label</varname></term>
<listitem>
<para>An address label.</para>
</listitem>
</varlistentry>
</variablelist>
<para>The <literal>[Route]</literal> section accepts the following keys:</para>
<variablelist class='network-directives'>
<varlistentry>
<term><varname>Gateway</varname></term>
<listitem>
<para>As in the <literal>[Network]</literal> section. This key is mandatory.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>Destination</varname></term>
<listitem>
<para>The destination prefix of the route. Possibly followed by a slash and the
prefixlength, if ommitted a full-length host route is assumed.</para>
</listitem>
</varlistentry>
</variablelist>
<para>The <literal>[DHCPv4]</literal> section accepts the following keys:</para>
<variablelist class='network-directives'>
<varlistentry>
<term><varname>UseDNS</varname></term>
<listitem>
<para>When true (the default) the DNS servers received from the DHCP server will
be used, and take precedence over any statically configured ones.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>UseMTU</varname></term>
<listitem>
<para>When true the interface maximum transmission unit from the DHCP server will
be used on the current link. Defaults to false.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>UseHostname</varname></term>
<listitem>
<para>When true (the default) the hostname received from the DHCP server
will be used as the transient hostname.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>CriticalConnection</varname></term>
<listitem>
<para>When true the connection will never be torn down even if the DHCP lease
expires. This is contrary to the DHCP specification, but may be the best choice
if, say, the root filesystem relies on this connection. Defaults to false.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect2>
</refsect1>
<refsect1>
<title>See Also</title>
<para>
<citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>udev</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
</para>
</refsect1>
</refentry>
|
