]>
Commit | Line | Data |
---|---|---|
514094f9 | 1 | <?xml version='1.0'?> |
3a54a157 | 2 | <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" |
eea10b26 | 3 | "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> |
413708d1 VK |
4 | |
5 | <!-- | |
db9ecf05 | 6 | SPDX-License-Identifier: LGPL-2.1-or-later |
572eb058 | 7 | |
96b2fb93 | 8 | Copyright © 2014 Vinay Kulkarni |
413708d1 VK |
9 | --> |
10 | ||
11 | <refentry id="networkd.conf" conditional='ENABLE_NETWORKD' | |
12 | xmlns:xi="http://www.w3.org/2001/XInclude"> | |
13 | <refentryinfo> | |
14 | <title>networkd.conf</title> | |
15 | <productname>systemd</productname> | |
413708d1 VK |
16 | </refentryinfo> |
17 | ||
18 | <refmeta> | |
19 | <refentrytitle>networkd.conf</refentrytitle> | |
20 | <manvolnum>5</manvolnum> | |
21 | </refmeta> | |
22 | ||
23 | <refnamediv> | |
24 | <refname>networkd.conf</refname> | |
25 | <refname>networkd.conf.d</refname> | |
26 | <refpurpose>Global Network configuration files</refpurpose> | |
27 | </refnamediv> | |
28 | ||
29 | <refsynopsisdiv> | |
73e97bb0 ZJS |
30 | <para><simplelist> |
31 | <member><filename>/etc/systemd/networkd.conf</filename></member> | |
b83a59f8 ZJS |
32 | <member><filename>/run/systemd/networkd.conf</filename></member> |
33 | <member><filename>/usr/lib/systemd/networkd.conf</filename></member> | |
73e97bb0 | 34 | <member><filename>/etc/systemd/networkd.conf.d/*.conf</filename></member> |
38b4eb22 | 35 | <member><filename>/run/systemd/networkd.conf.d/*.conf</filename></member> |
73e97bb0 ZJS |
36 | <member><filename>/usr/lib/systemd/networkd.conf.d/*.conf</filename></member> |
37 | </simplelist></para> | |
413708d1 VK |
38 | </refsynopsisdiv> |
39 | ||
40 | <refsect1> | |
41 | <title>Description</title> | |
42 | ||
8835a6ff | 43 | <para>These configuration files control global network parameters.</para> |
413708d1 VK |
44 | </refsect1> |
45 | ||
46 | <xi:include href="standard-conf.xml" xpointer="main-conf" /> | |
47 | ||
c9fdaed0 YW |
48 | <refsect1> |
49 | <title>[Network] Section Options</title> | |
50 | ||
bdac5608 | 51 | <para>The following options are available in the [Network] section:</para> |
c9fdaed0 YW |
52 | |
53 | <variablelist class='network-directives'> | |
54 | <varlistentry> | |
55 | <term><varname>SpeedMeter=</varname></term> | |
56 | <listitem><para>Takes a boolean. If set to yes, then <command>systemd-networkd</command> | |
57 | measures the traffic of each interface, and | |
d91b9bbc | 58 | <command>networkctl status <replaceable>INTERFACE</replaceable></command> shows the measured speed. |
ec07c3c8 AK |
59 | Defaults to no.</para> |
60 | ||
61 | <xi:include href="version-info.xml" xpointer="v244"/></listitem> | |
c9fdaed0 YW |
62 | </varlistentry> |
63 | ||
64 | <varlistentry> | |
65 | <term><varname>SpeedMeterIntervalSec=</varname></term> | |
66 | <listitem><para>Specifies the time interval to calculate the traffic speed of each interface. | |
ec07c3c8 AK |
67 | If <varname>SpeedMeter=no</varname>, the value is ignored. Defaults to 10sec.</para> |
68 | ||
69 | <xi:include href="version-info.xml" xpointer="v244"/></listitem> | |
c9fdaed0 | 70 | </varlistentry> |
5d3b8017 | 71 | |
d94dfe70 YW |
72 | <varlistentry> |
73 | <term><varname>ManageForeignRoutingPolicyRules=</varname></term> | |
74 | <listitem><para>A boolean. When true, <command>systemd-networkd</command> will remove rules | |
75 | that are not configured in .network files (except for rules with protocol | |
76 | <literal>kernel</literal>). When false, it will not remove any foreign rules, keeping them even | |
77 | if they are not configured in a .network file. Defaults to yes. | |
ec07c3c8 AK |
78 | </para> |
79 | ||
80 | <xi:include href="version-info.xml" xpointer="v249"/></listitem> | |
d94dfe70 YW |
81 | </varlistentry> |
82 | ||
5d3b8017 SS |
83 | <varlistentry> |
84 | <term><varname>ManageForeignRoutes=</varname></term> | |
3fe23a96 YW |
85 | <listitem><para>A boolean. When true, <command>systemd-networkd</command> will remove routes |
86 | that are not configured in .network files (except for routes with protocol | |
87 | <literal>kernel</literal>, <literal>dhcp</literal> when <varname>KeepConfiguration=</varname> | |
88 | is true or <literal>dhcp</literal>, and <literal>static</literal> when | |
89 | <varname>KeepConfiguration=</varname> is true or <literal>static</literal>). When false, it will | |
90 | not remove any foreign routes, keeping them even if they are not configured in a .network file. | |
ec07c3c8 AK |
91 | Defaults to yes.</para> |
92 | ||
93 | <xi:include href="version-info.xml" xpointer="v246"/></listitem> | |
5d3b8017 SS |
94 | </varlistentry> |
95 | ||
bbc05bec YW |
96 | <varlistentry> |
97 | <term><varname>ManageForeignNextHops=</varname></term> | |
98 | <listitem><para>A boolean. When true, <command>systemd-networkd</command> will remove nexthops | |
99 | that are not configured in .network files (except for routes with protocol | |
100 | <literal>kernel</literal>). When false, it will | |
101 | not remove any foreign nexthops, keeping them even if they are not configured in a .network file. | |
102 | Defaults to yes.</para> | |
103 | ||
104 | <xi:include href="version-info.xml" xpointer="v256"/></listitem> | |
105 | </varlistentry> | |
106 | ||
c038ce46 SS |
107 | <varlistentry> |
108 | <term><varname>RouteTable=</varname></term> | |
310eff72 YW |
109 | <listitem><para>Defines the route table name. Takes a whitespace-separated list of the pairs of |
110 | route table name and number. The route table name and number in each pair are separated with a | |
111 | colon, i.e., <literal><replaceable>name</replaceable>:<replaceable>number</replaceable></literal>. | |
112 | The route table name must not be <literal>default</literal>, <literal>main</literal>, or | |
113 | <literal>local</literal>, as these route table names are predefined with route table number 253, | |
e8e91a81 YW |
114 | 254, and 255, respectively. The route table number must be an integer in the range 1…4294967295, |
115 | except for predefined numbers 253, 254, and 255. This setting can be specified multiple times. | |
116 | If an empty string is specified, then the list specified earlier are cleared. Defaults to unset. | |
ec07c3c8 AK |
117 | </para> |
118 | ||
119 | <xi:include href="version-info.xml" xpointer="v248"/></listitem> | |
c038ce46 SS |
120 | </varlistentry> |
121 | ||
3976c430 YW |
122 | <varlistentry> |
123 | <term><varname>IPv4Forwarding=</varname></term> | |
124 | <listitem> | |
125 | <para>Configures IPv4 packet forwarding for the system. Takes a boolean value. This controls the | |
126 | <filename>net.ipv4.conf.default.forwarding</filename> and | |
127 | <filename>net.ipv4.conf.all.forwarding</filename>sysctl options. See | |
128 | <ulink url="https://docs.kernel.org/networking/ip-sysctl.html">IP Sysctl</ulink> | |
129 | for more details about the sysctl options. Defaults to unset and the sysctl options will not be | |
130 | changed.</para> | |
131 | ||
132 | <xi:include href="version-info.xml" xpointer="v256"/> | |
133 | </listitem> | |
134 | </varlistentry> | |
135 | ||
136 | <varlistentry> | |
137 | <term><varname>IPv6Forwarding=</varname></term> | |
138 | <listitem> | |
139 | <para>Configures IPv6 packet forwarding for the system. Takes a boolean value. This controls the | |
140 | <filename>net.ipv6.conf.default.forwarding</filename> and | |
141 | <filename>net.ipv6.conf.all.forwarding</filename> sysctl options. See | |
142 | <ulink url="https://docs.kernel.org/networking/ip-sysctl.html">IP Sysctl</ulink> | |
143 | for more details about the sysctl options. Defaults to unset and the sysctl options will not be | |
144 | changed.</para> | |
145 | ||
146 | <xi:include href="version-info.xml" xpointer="v256"/> | |
147 | </listitem> | |
148 | </varlistentry> | |
149 | ||
932ef6ec YW |
150 | <varlistentry> |
151 | <term><varname>IPv6PrivacyExtensions=</varname></term> | |
152 | <listitem> | |
153 | <para>Specifies the default value for per-network <varname>IPv6PrivacyExtensions=</varname>. | |
154 | Takes a boolean or the special values <literal>prefer-public</literal> and | |
155 | <literal>kernel</literal>. See for details in | |
156 | <citerefentry><refentrytitle>systemd.network</refentrytitle><manvolnum>5</manvolnum></citerefentry>. | |
157 | Defaults to <literal>no</literal>.</para> | |
ec07c3c8 AK |
158 | |
159 | <xi:include href="version-info.xml" xpointer="v254"/> | |
932ef6ec YW |
160 | </listitem> |
161 | </varlistentry> | |
418f2dc7 YW |
162 | |
163 | <varlistentry> | |
164 | <term><varname>UseDomains=</varname></term> | |
165 | <listitem> | |
166 | <para>Specifies the network- and protocol-independent default value for the same settins in | |
167 | [IPv6AcceptRA], [DHCPv4], and [DHCPv6] sections below. Takes a boolean, or the special value | |
168 | <option>route</option>. See the same setting in | |
169 | <citerefentry><refentrytitle>systemd.network</refentrytitle><manvolnum>5</manvolnum></citerefentry>. | |
170 | Defaults to <literal>no</literal>.</para> | |
171 | ||
172 | <xi:include href="version-info.xml" xpointer="v256"/> | |
173 | </listitem> | |
174 | </varlistentry> | |
175 | </variablelist> | |
176 | </refsect1> | |
177 | ||
178 | <refsect1> | |
179 | <title>[IPv6AcceptRA] Section Options</title> | |
180 | ||
181 | <para>This section configures the default setting of the Neighbor Discovery. The following options are | |
182 | available in the [IPv6AcceptRA] section:</para> | |
183 | ||
184 | <variablelist class='network-directives'> | |
185 | <varlistentry> | |
186 | <term><varname>UseDomains=</varname></term> | |
187 | <listitem> | |
188 | <para>Specifies the network-independent default value for the same setting in the [IPv6AcceptRA] | |
189 | section in | |
190 | <citerefentry><refentrytitle>systemd.network</refentrytitle><manvolnum>5</manvolnum></citerefentry>. | |
191 | Takes a boolean, or the special value <option>route</option>. When unspecified, the value specified | |
192 | in the [Network] section in | |
193 | <citerefentry><refentrytitle>networkd.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>, | |
194 | which defaults to <literal>no</literal>, will be used.</para> | |
195 | ||
196 | <xi:include href="version-info.xml" xpointer="v256"/> | |
197 | </listitem> | |
198 | </varlistentry> | |
c9fdaed0 YW |
199 | </variablelist> |
200 | </refsect1> | |
201 | ||
413708d1 | 202 | <refsect1> |
4e26a5ba YW |
203 | <title>[DHCPv4] Section Options</title> |
204 | ||
205 | <para>This section configures the DHCP Unique Identifier (DUID) value used by DHCP protocol. DHCPv4 | |
206 | client protocol sends IAID and DUID to the DHCP server when acquiring a dynamic IPv4 address if | |
207 | <option>ClientIdentifier=duid</option>. IAID and DUID allows a DHCP server to uniquely identify the | |
208 | machine and the interface requesting a DHCP IP address. To configure IAID and ClientIdentifier, see | |
e2e08e77 ZJS |
209 | <citerefentry><refentrytitle>systemd.network</refentrytitle><manvolnum>5</manvolnum></citerefentry>. |
210 | </para> | |
413708d1 | 211 | |
e2e08e77 | 212 | <para>The following options are understood:</para> |
413708d1 VK |
213 | |
214 | <variablelist class='network-directives'> | |
e2e08e77 ZJS |
215 | <varlistentry> |
216 | <term><varname>DUIDType=</varname></term> | |
217 | <listitem><para>Specifies how the DUID should be generated. See | |
218 | <ulink url="https://tools.ietf.org/html/rfc3315#section-9">RFC 3315</ulink> | |
219 | for a description of all the options.</para> | |
220 | ||
80500bb5 | 221 | <para>This takes an integer in the range 0…65535, or one of the following string values: |
e2e08e77 ZJS |
222 | <variablelist> |
223 | <varlistentry> | |
319b94bc | 224 | <term><option>vendor</option></term> |
e2e08e77 ZJS |
225 | <listitem><para>If <literal>DUIDType=vendor</literal>, then the DUID value will be generated using |
226 | <literal>43793</literal> as the vendor identifier (systemd) and hashed contents of | |
227 | <citerefentry><refentrytitle>machine-id</refentrytitle><manvolnum>5</manvolnum></citerefentry>. | |
228 | This is the default if <varname>DUIDType=</varname> is not specified. | |
aefdc112 AK |
229 | </para> |
230 | ||
231 | <xi:include href="version-info.xml" xpointer="v230"/></listitem> | |
e2e08e77 ZJS |
232 | </varlistentry> |
233 | ||
234 | <varlistentry> | |
319b94bc YW |
235 | <term><option>uuid</option></term> |
236 | <listitem><para>If <literal>DUIDType=uuid</literal>, and <varname>DUIDRawData=</varname> is not set, | |
237 | then the product UUID is used as a DUID value. If a system does not have valid product UUID, then | |
238 | an application-specific | |
239 | <citerefentry><refentrytitle>machine-id</refentrytitle><manvolnum>5</manvolnum></citerefentry> | |
240 | is used as a DUID value. About the application-specific machine ID, see | |
241 | <citerefentry><refentrytitle>sd_id128_get_machine_app_specific</refentrytitle><manvolnum>3</manvolnum></citerefentry>. | |
aefdc112 AK |
242 | </para> |
243 | ||
244 | <xi:include href="version-info.xml" xpointer="v230"/></listitem> | |
319b94bc YW |
245 | </varlistentry> |
246 | ||
247 | <varlistentry> | |
8fa266c2 | 248 | <term><option>link-layer-time[:<replaceable>TIME</replaceable>]</option></term> |
319b94bc | 249 | <term><option>link-layer</option></term> |
8fa266c2 YW |
250 | <listitem><para>If <literal>link-layer-time</literal> or <literal>link-layer</literal> is specified, |
251 | then the MAC address of the interface is used as a DUID value. The value <literal>link-layer-time</literal> | |
252 | can take additional time value after a colon, e.g. <literal>link-layer-time:2018-01-23 12:34:56 UTC</literal>. | |
253 | The default time value is <literal>2000-01-01 00:00:00 UTC</literal>. | |
aefdc112 AK |
254 | </para> |
255 | ||
256 | <xi:include href="version-info.xml" xpointer="v240"/></listitem> | |
e2e08e77 ZJS |
257 | </varlistentry> |
258 | </variablelist> | |
259 | </para> | |
260 | ||
261 | <para>In all cases, <varname>DUIDRawData=</varname> can be used to override the | |
aefdc112 AK |
262 | actual DUID value that is used.</para> |
263 | ||
264 | <xi:include href="version-info.xml" xpointer="v230"/></listitem> | |
e2e08e77 | 265 | </varlistentry> |
413708d1 | 266 | |
413708d1 | 267 | <varlistentry> |
e2e08e77 ZJS |
268 | <term><varname>DUIDRawData=</varname></term> |
269 | <listitem><para>Specifies the DHCP DUID value as a single newline-terminated, hexadecimal string, with each | |
270 | byte separated by <literal>:</literal>. The DUID that is sent is composed of the DUID type specified by | |
271 | <varname>DUIDType=</varname> and the value configured here.</para> | |
272 | ||
319b94bc YW |
273 | <para>The DUID value specified here overrides the DUID that |
274 | <citerefentry><refentrytitle>systemd-networkd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry> | |
275 | generates from the machine ID. To configure DUID per-network, see | |
2ac5fe95 | 276 | <citerefentry><refentrytitle>systemd.network</refentrytitle><manvolnum>5</manvolnum></citerefentry>. |
e2e08e77 ZJS |
277 | The configured DHCP DUID should conform to the specification in |
278 | <ulink url="http://tools.ietf.org/html/rfc3315#section-9">RFC 3315</ulink>, | |
279 | <ulink url="http://tools.ietf.org/html/rfc6355">RFC 6355</ulink>. To configure IAID, see | |
280 | <citerefentry><refentrytitle>systemd.network</refentrytitle><manvolnum>5</manvolnum> | |
281 | </citerefentry>.</para> | |
282 | ||
283 | <example> | |
284 | <title>A <option>DUIDType=vendor</option> with a custom value</title> | |
285 | ||
286 | <programlisting>DUIDType=vendor | |
287 | DUIDRawData=00:00:ab:11:f9:2a:c2:77:29:f9:5c:00</programlisting> | |
288 | ||
289 | <para>This specifies a 14 byte DUID, with the type DUID-EN (<literal>00:02</literal>), enterprise number | |
290 | 43793 (<literal>00:00:ab:11</literal>), and identifier value <literal>f9:2a:c2:77:29:f9:5c:00</literal>. | |
291 | </para> | |
292 | </example> | |
aefdc112 AK |
293 | |
294 | <xi:include href="version-info.xml" xpointer="v230"/> | |
e2e08e77 | 295 | </listitem> |
413708d1 | 296 | </varlistentry> |
fb573007 HL |
297 | |
298 | <varlistentry> | |
299 | <term><varname>UseDomains=</varname></term> | |
418f2dc7 YW |
300 | <listitem> |
301 | <para>Same as the one in the [IPv6AcceptRA] section, but applied for DHCPv4 protocol.</para> | |
302 | ||
fb573007 HL |
303 | <xi:include href="version-info.xml" xpointer="v256"/> |
304 | </listitem> | |
305 | </varlistentry> | |
413708d1 VK |
306 | </variablelist> |
307 | </refsect1> | |
308 | ||
4e26a5ba YW |
309 | <refsect1> |
310 | <title>[DHCPv6] Section Options</title> | |
311 | ||
312 | <para>This section configures the DHCP Unique Identifier (DUID) value used by DHCPv6 protocol. | |
313 | DHCPv6 client protocol sends the DHCP Unique Identifier and the interface Identity Association | |
314 | Identifier (IAID) to a DHCPv6 server when acquiring a dynamic IPv6 address. IAID and DUID allows a | |
315 | DHCPv6 server to uniquely identify the machine and the interface requesting a DHCP IP address. To | |
316 | configure IAID, see | |
317 | <citerefentry><refentrytitle>systemd.network</refentrytitle><manvolnum>5</manvolnum></citerefentry>. | |
318 | </para> | |
319 | ||
320 | <para>The following options are understood:</para> | |
321 | ||
322 | <variablelist class='network-directives'> | |
323 | <varlistentry> | |
324 | <term><varname>DUIDType=</varname></term> | |
325 | <term><varname>DUIDRawData=</varname></term> | |
ec07c3c8 AK |
326 | <listitem><para>As in the [DHCPv4] section.</para> |
327 | ||
328 | <xi:include href="version-info.xml" xpointer="v249"/></listitem> | |
4e26a5ba | 329 | </varlistentry> |
fb573007 HL |
330 | |
331 | <varlistentry> | |
332 | <term><varname>UseDomains=</varname></term> | |
333 | <listitem><para>As in the [DHCPv4] section.</para> | |
334 | ||
335 | <xi:include href="version-info.xml" xpointer="v256"/></listitem> | |
336 | </varlistentry> | |
4e26a5ba YW |
337 | </variablelist> |
338 | </refsect1> | |
339 | ||
a3ed665a YW |
340 | <refsect1> |
341 | <title>[DHCPServer] Section Options</title> | |
342 | ||
343 | <para>This section configures the default setting of the DHCP server. The following options are available | |
344 | in the [DHCPServer] section:</para> | |
345 | ||
346 | <variablelist class='network-directives'> | |
347 | <varlistentry> | |
418f2dc7 | 348 | <term><varname>UseDomains=</varname></term> |
a3ed665a | 349 | <listitem> |
418f2dc7 | 350 | <para>Same as the one in the [IPv6AcceptRA] section, but applied for DHCPv4 protocol.</para> |
a3ed665a YW |
351 | |
352 | <xi:include href="version-info.xml" xpointer="v256"/> | |
353 | </listitem> | |
354 | </varlistentry> | |
355 | </variablelist> | |
356 | </refsect1> | |
357 | ||
413708d1 VK |
358 | <refsect1> |
359 | <title>See Also</title> | |
13a69c12 DT |
360 | <para><simplelist type="inline"> |
361 | <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> | |
362 | <member><citerefentry><refentrytitle>systemd.network</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> | |
363 | <member><citerefentry><refentrytitle>systemd-networkd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> | |
364 | <member><citerefentry><refentrytitle>machine-id</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> | |
365 | <member><citerefentry><refentrytitle>sd_id128_get_machine_app_specific</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> | |
366 | </simplelist></para> | |
413708d1 VK |
367 | </refsect1> |
368 | ||
369 | </refentry> |