]>
Commit | Line | Data |
---|---|---|
514094f9 | 1 | <?xml version='1.0'?> |
3a54a157 | 2 | <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" |
413708d1 VK |
3 | "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> |
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> | |
32 | <member><filename>/etc/systemd/networkd.conf.d/*.conf</filename></member> | |
33 | <member><filename>/usr/lib/systemd/networkd.conf.d/*.conf</filename></member> | |
34 | </simplelist></para> | |
413708d1 VK |
35 | </refsynopsisdiv> |
36 | ||
37 | <refsect1> | |
38 | <title>Description</title> | |
39 | ||
40 | <para>These configuration files control global network parameters. | |
e2e08e77 | 41 | Currently the DHCP Unique Identifier (DUID).</para> |
413708d1 VK |
42 | |
43 | </refsect1> | |
44 | ||
45 | <xi:include href="standard-conf.xml" xpointer="main-conf" /> | |
46 | ||
c9fdaed0 YW |
47 | <refsect1> |
48 | <title>[Network] Section Options</title> | |
49 | ||
bdac5608 | 50 | <para>The following options are available in the [Network] section:</para> |
c9fdaed0 YW |
51 | |
52 | <variablelist class='network-directives'> | |
53 | <varlistentry> | |
54 | <term><varname>SpeedMeter=</varname></term> | |
55 | <listitem><para>Takes a boolean. If set to yes, then <command>systemd-networkd</command> | |
56 | measures the traffic of each interface, and | |
d91b9bbc | 57 | <command>networkctl status <replaceable>INTERFACE</replaceable></command> shows the measured speed. |
ec07c3c8 AK |
58 | Defaults to no.</para> |
59 | ||
60 | <xi:include href="version-info.xml" xpointer="v244"/></listitem> | |
c9fdaed0 YW |
61 | </varlistentry> |
62 | ||
63 | <varlistentry> | |
64 | <term><varname>SpeedMeterIntervalSec=</varname></term> | |
65 | <listitem><para>Specifies the time interval to calculate the traffic speed of each interface. | |
ec07c3c8 AK |
66 | If <varname>SpeedMeter=no</varname>, the value is ignored. Defaults to 10sec.</para> |
67 | ||
68 | <xi:include href="version-info.xml" xpointer="v244"/></listitem> | |
c9fdaed0 | 69 | </varlistentry> |
5d3b8017 | 70 | |
d94dfe70 YW |
71 | <varlistentry> |
72 | <term><varname>ManageForeignRoutingPolicyRules=</varname></term> | |
73 | <listitem><para>A boolean. When true, <command>systemd-networkd</command> will remove rules | |
74 | that are not configured in .network files (except for rules with protocol | |
75 | <literal>kernel</literal>). When false, it will not remove any foreign rules, keeping them even | |
76 | if they are not configured in a .network file. Defaults to yes. | |
ec07c3c8 AK |
77 | </para> |
78 | ||
79 | <xi:include href="version-info.xml" xpointer="v249"/></listitem> | |
d94dfe70 YW |
80 | </varlistentry> |
81 | ||
5d3b8017 SS |
82 | <varlistentry> |
83 | <term><varname>ManageForeignRoutes=</varname></term> | |
3fe23a96 YW |
84 | <listitem><para>A boolean. When true, <command>systemd-networkd</command> will remove routes |
85 | that are not configured in .network files (except for routes with protocol | |
86 | <literal>kernel</literal>, <literal>dhcp</literal> when <varname>KeepConfiguration=</varname> | |
87 | is true or <literal>dhcp</literal>, and <literal>static</literal> when | |
88 | <varname>KeepConfiguration=</varname> is true or <literal>static</literal>). When false, it will | |
89 | not remove any foreign routes, keeping them even if they are not configured in a .network file. | |
ec07c3c8 AK |
90 | Defaults to yes.</para> |
91 | ||
92 | <xi:include href="version-info.xml" xpointer="v246"/></listitem> | |
5d3b8017 SS |
93 | </varlistentry> |
94 | ||
bbc05bec YW |
95 | <varlistentry> |
96 | <term><varname>ManageForeignNextHops=</varname></term> | |
97 | <listitem><para>A boolean. When true, <command>systemd-networkd</command> will remove nexthops | |
98 | that are not configured in .network files (except for routes with protocol | |
99 | <literal>kernel</literal>). When false, it will | |
100 | not remove any foreign nexthops, keeping them even if they are not configured in a .network file. | |
101 | Defaults to yes.</para> | |
102 | ||
103 | <xi:include href="version-info.xml" xpointer="v256"/></listitem> | |
104 | </varlistentry> | |
105 | ||
c038ce46 SS |
106 | <varlistentry> |
107 | <term><varname>RouteTable=</varname></term> | |
310eff72 YW |
108 | <listitem><para>Defines the route table name. Takes a whitespace-separated list of the pairs of |
109 | route table name and number. The route table name and number in each pair are separated with a | |
110 | colon, i.e., <literal><replaceable>name</replaceable>:<replaceable>number</replaceable></literal>. | |
111 | The route table name must not be <literal>default</literal>, <literal>main</literal>, or | |
112 | <literal>local</literal>, as these route table names are predefined with route table number 253, | |
e8e91a81 YW |
113 | 254, and 255, respectively. The route table number must be an integer in the range 1…4294967295, |
114 | except for predefined numbers 253, 254, and 255. This setting can be specified multiple times. | |
115 | If an empty string is specified, then the list specified earlier are cleared. Defaults to unset. | |
ec07c3c8 AK |
116 | </para> |
117 | ||
118 | <xi:include href="version-info.xml" xpointer="v248"/></listitem> | |
c038ce46 SS |
119 | </varlistentry> |
120 | ||
932ef6ec YW |
121 | <varlistentry> |
122 | <term><varname>IPv6PrivacyExtensions=</varname></term> | |
123 | <listitem> | |
124 | <para>Specifies the default value for per-network <varname>IPv6PrivacyExtensions=</varname>. | |
125 | Takes a boolean or the special values <literal>prefer-public</literal> and | |
126 | <literal>kernel</literal>. See for details in | |
127 | <citerefentry><refentrytitle>systemd.network</refentrytitle><manvolnum>5</manvolnum></citerefentry>. | |
128 | Defaults to <literal>no</literal>.</para> | |
ec07c3c8 AK |
129 | |
130 | <xi:include href="version-info.xml" xpointer="v254"/> | |
932ef6ec YW |
131 | </listitem> |
132 | </varlistentry> | |
c9fdaed0 YW |
133 | </variablelist> |
134 | </refsect1> | |
135 | ||
413708d1 | 136 | <refsect1> |
4e26a5ba YW |
137 | <title>[DHCPv4] Section Options</title> |
138 | ||
139 | <para>This section configures the DHCP Unique Identifier (DUID) value used by DHCP protocol. DHCPv4 | |
140 | client protocol sends IAID and DUID to the DHCP server when acquiring a dynamic IPv4 address if | |
141 | <option>ClientIdentifier=duid</option>. IAID and DUID allows a DHCP server to uniquely identify the | |
142 | machine and the interface requesting a DHCP IP address. To configure IAID and ClientIdentifier, see | |
e2e08e77 ZJS |
143 | <citerefentry><refentrytitle>systemd.network</refentrytitle><manvolnum>5</manvolnum></citerefentry>. |
144 | </para> | |
413708d1 | 145 | |
e2e08e77 | 146 | <para>The following options are understood:</para> |
413708d1 VK |
147 | |
148 | <variablelist class='network-directives'> | |
e2e08e77 ZJS |
149 | <varlistentry> |
150 | <term><varname>DUIDType=</varname></term> | |
151 | <listitem><para>Specifies how the DUID should be generated. See | |
152 | <ulink url="https://tools.ietf.org/html/rfc3315#section-9">RFC 3315</ulink> | |
153 | for a description of all the options.</para> | |
154 | ||
80500bb5 | 155 | <para>This takes an integer in the range 0…65535, or one of the following string values: |
e2e08e77 ZJS |
156 | <variablelist> |
157 | <varlistentry> | |
319b94bc | 158 | <term><option>vendor</option></term> |
e2e08e77 ZJS |
159 | <listitem><para>If <literal>DUIDType=vendor</literal>, then the DUID value will be generated using |
160 | <literal>43793</literal> as the vendor identifier (systemd) and hashed contents of | |
161 | <citerefentry><refentrytitle>machine-id</refentrytitle><manvolnum>5</manvolnum></citerefentry>. | |
162 | This is the default if <varname>DUIDType=</varname> is not specified. | |
aefdc112 AK |
163 | </para> |
164 | ||
165 | <xi:include href="version-info.xml" xpointer="v230"/></listitem> | |
e2e08e77 ZJS |
166 | </varlistentry> |
167 | ||
168 | <varlistentry> | |
319b94bc YW |
169 | <term><option>uuid</option></term> |
170 | <listitem><para>If <literal>DUIDType=uuid</literal>, and <varname>DUIDRawData=</varname> is not set, | |
171 | then the product UUID is used as a DUID value. If a system does not have valid product UUID, then | |
172 | an application-specific | |
173 | <citerefentry><refentrytitle>machine-id</refentrytitle><manvolnum>5</manvolnum></citerefentry> | |
174 | is used as a DUID value. About the application-specific machine ID, see | |
175 | <citerefentry><refentrytitle>sd_id128_get_machine_app_specific</refentrytitle><manvolnum>3</manvolnum></citerefentry>. | |
aefdc112 AK |
176 | </para> |
177 | ||
178 | <xi:include href="version-info.xml" xpointer="v230"/></listitem> | |
319b94bc YW |
179 | </varlistentry> |
180 | ||
181 | <varlistentry> | |
8fa266c2 | 182 | <term><option>link-layer-time[:<replaceable>TIME</replaceable>]</option></term> |
319b94bc | 183 | <term><option>link-layer</option></term> |
8fa266c2 YW |
184 | <listitem><para>If <literal>link-layer-time</literal> or <literal>link-layer</literal> is specified, |
185 | then the MAC address of the interface is used as a DUID value. The value <literal>link-layer-time</literal> | |
186 | can take additional time value after a colon, e.g. <literal>link-layer-time:2018-01-23 12:34:56 UTC</literal>. | |
187 | The default time value is <literal>2000-01-01 00:00:00 UTC</literal>. | |
aefdc112 AK |
188 | </para> |
189 | ||
190 | <xi:include href="version-info.xml" xpointer="v240"/></listitem> | |
e2e08e77 ZJS |
191 | </varlistentry> |
192 | </variablelist> | |
193 | </para> | |
194 | ||
195 | <para>In all cases, <varname>DUIDRawData=</varname> can be used to override the | |
aefdc112 AK |
196 | actual DUID value that is used.</para> |
197 | ||
198 | <xi:include href="version-info.xml" xpointer="v230"/></listitem> | |
e2e08e77 | 199 | </varlistentry> |
413708d1 | 200 | |
413708d1 | 201 | <varlistentry> |
e2e08e77 ZJS |
202 | <term><varname>DUIDRawData=</varname></term> |
203 | <listitem><para>Specifies the DHCP DUID value as a single newline-terminated, hexadecimal string, with each | |
204 | byte separated by <literal>:</literal>. The DUID that is sent is composed of the DUID type specified by | |
205 | <varname>DUIDType=</varname> and the value configured here.</para> | |
206 | ||
319b94bc YW |
207 | <para>The DUID value specified here overrides the DUID that |
208 | <citerefentry><refentrytitle>systemd-networkd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry> | |
209 | generates from the machine ID. To configure DUID per-network, see | |
2ac5fe95 | 210 | <citerefentry><refentrytitle>systemd.network</refentrytitle><manvolnum>5</manvolnum></citerefentry>. |
e2e08e77 ZJS |
211 | The configured DHCP DUID should conform to the specification in |
212 | <ulink url="http://tools.ietf.org/html/rfc3315#section-9">RFC 3315</ulink>, | |
213 | <ulink url="http://tools.ietf.org/html/rfc6355">RFC 6355</ulink>. To configure IAID, see | |
214 | <citerefentry><refentrytitle>systemd.network</refentrytitle><manvolnum>5</manvolnum> | |
215 | </citerefentry>.</para> | |
216 | ||
217 | <example> | |
218 | <title>A <option>DUIDType=vendor</option> with a custom value</title> | |
219 | ||
220 | <programlisting>DUIDType=vendor | |
221 | DUIDRawData=00:00:ab:11:f9:2a:c2:77:29:f9:5c:00</programlisting> | |
222 | ||
223 | <para>This specifies a 14 byte DUID, with the type DUID-EN (<literal>00:02</literal>), enterprise number | |
224 | 43793 (<literal>00:00:ab:11</literal>), and identifier value <literal>f9:2a:c2:77:29:f9:5c:00</literal>. | |
225 | </para> | |
226 | </example> | |
aefdc112 AK |
227 | |
228 | <xi:include href="version-info.xml" xpointer="v230"/> | |
e2e08e77 | 229 | </listitem> |
413708d1 VK |
230 | </varlistentry> |
231 | </variablelist> | |
232 | </refsect1> | |
233 | ||
4e26a5ba YW |
234 | <refsect1> |
235 | <title>[DHCPv6] Section Options</title> | |
236 | ||
237 | <para>This section configures the DHCP Unique Identifier (DUID) value used by DHCPv6 protocol. | |
238 | DHCPv6 client protocol sends the DHCP Unique Identifier and the interface Identity Association | |
239 | Identifier (IAID) to a DHCPv6 server when acquiring a dynamic IPv6 address. IAID and DUID allows a | |
240 | DHCPv6 server to uniquely identify the machine and the interface requesting a DHCP IP address. To | |
241 | configure IAID, see | |
242 | <citerefentry><refentrytitle>systemd.network</refentrytitle><manvolnum>5</manvolnum></citerefentry>. | |
243 | </para> | |
244 | ||
245 | <para>The following options are understood:</para> | |
246 | ||
247 | <variablelist class='network-directives'> | |
248 | <varlistentry> | |
249 | <term><varname>DUIDType=</varname></term> | |
250 | <term><varname>DUIDRawData=</varname></term> | |
ec07c3c8 AK |
251 | <listitem><para>As in the [DHCPv4] section.</para> |
252 | ||
253 | <xi:include href="version-info.xml" xpointer="v249"/></listitem> | |
4e26a5ba YW |
254 | </varlistentry> |
255 | </variablelist> | |
256 | </refsect1> | |
257 | ||
413708d1 VK |
258 | <refsect1> |
259 | <title>See Also</title> | |
260 | <para> | |
261 | <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, | |
262 | <citerefentry><refentrytitle>systemd.network</refentrytitle><manvolnum>5</manvolnum></citerefentry>, | |
319b94bc YW |
263 | <citerefentry><refentrytitle>systemd-networkd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>, |
264 | <citerefentry><refentrytitle>machine-id</refentrytitle><manvolnum>5</manvolnum></citerefentry>, | |
265 | <citerefentry><refentrytitle>sd_id128_get_machine_app_specific</refentrytitle><manvolnum>3</manvolnum></citerefentry> | |
413708d1 VK |
266 | </para> |
267 | </refsect1> | |
268 | ||
269 | </refentry> |