Debian Codegraph @

upstream/debian-unstable/man5/networkd.conf.5

raw
1 '\" t
2 .TH "NETWORKD\&.CONF" "5" "" "systemd 261~rc3" "networkd.conf"
3 .\" -----------------------------------------------------------------
4 .\" * Define some portability stuff
5 .\" -----------------------------------------------------------------
6 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
7 .\" http://bugs.debian.org/507673
8 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
9 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
10 .ie \n(.g .ds Aq \(aq
11 .el .ds Aq '
12 .\" -----------------------------------------------------------------
13 .\" * set default formatting
14 .\" -----------------------------------------------------------------
15 .\" disable hyphenation
16 .nh
17 .\" disable justification (adjust text to left margin only)
18 .ad l
19 .\" -----------------------------------------------------------------
20 .\" * MAIN CONTENT STARTS HERE *
21 .\" -----------------------------------------------------------------
22 .SH "NAME"
23 networkd.conf, networkd.conf.d \- Global Network configuration files
24 .SH "SYNOPSIS"
25 .PP
26 .RS 4
27 /etc/systemd/networkd\&.conf
28 .RE
29 .RS 4
30 /run/systemd/networkd\&.conf
31 .RE
32 .RS 4
33 /usr/local/lib/systemd/networkd\&.conf
34 .RE
35 .RS 4
36 /usr/lib/systemd/networkd\&.conf
37 .RE
38 .RS 4
39 /etc/systemd/networkd\&.conf\&.d/*\&.conf
40 .RE
41 .RS 4
42 /run/systemd/networkd\&.conf\&.d/*\&.conf
43 .RE
44 .RS 4
45 /usr/local/lib/systemd/networkd\&.conf\&.d/*\&.conf
46 .RE
47 .RS 4
48 /usr/lib/systemd/networkd\&.conf\&.d/*\&.conf
49 .RE
50 .SH "DESCRIPTION"
51 .PP
52 These configuration files control global network parameters\&.
53 .SH "CONFIGURATION DIRECTORIES AND PRECEDENCE"
54 .PP
55 The default configuration is set during compilation, so configuration is only needed when it is necessary to deviate from those defaults\&. The main configuration file is loaded from one of the listed directories in order of priority, only the first file found is used:
56 /etc/systemd/,
57 /run/systemd/,
58 /usr/local/lib/systemd/
59 \&\s-2\u[1]\d\s+2,
60 /usr/lib/systemd/\&. The vendor version of the file contains commented out entries showing the defaults as a guide to the administrator\&. Local overrides can also be created by creating drop\-ins, as described below\&. The main configuration file can also be edited for this purpose (or a copy in
61 /etc/
62 if it is shipped under
63 /usr/), however using drop\-ins for local configuration is recommended over modifications to the main configuration file\&.
64 .PP
65 In addition to the main configuration file, drop\-in configuration snippets are read from
66 /usr/lib/systemd/*\&.conf\&.d/,
67 /usr/local/lib/systemd/*\&.conf\&.d/, and
68 /etc/systemd/*\&.conf\&.d/\&. Those drop\-ins have higher precedence and override the main configuration file\&. Files in the
69 *\&.conf\&.d/
70 configuration subdirectories are sorted by their filename in lexicographic order, regardless of in which of the subdirectories they reside\&. When multiple files specify the same option, for options which accept just a single value, the entry in the file sorted last takes precedence, and for options which accept a list of values, entries are collected as they occur in the sorted files\&.
71 .PP
72 When packages need to customize the configuration, they can install drop\-ins under
73 /usr/\&. Files in
74 /etc/
75 are reserved for the local administrator, who may use this logic to override the configuration files installed by vendor packages\&. Drop\-ins have to be used to override package drop\-ins, since the main configuration file has lower precedence\&. It is recommended to prefix all filenames in those subdirectories with a two\-digit number and a dash, to simplify the ordering\&. This also defines a concept of drop\-in priorities to allow OS vendors to ship drop\-ins within a specific range lower than the range used by users\&. This should lower the risk of package drop\-ins overriding accidentally drop\-ins defined by users\&. It is recommended to use the range 10\-40 for drop\-ins in
76 /usr/
77 and the range 60\-90 for drop\-ins in
78 /etc/
79 and
80 /run/, to make sure that local and transient drop\-ins take priority over drop\-ins shipped by the OS vendor\&.
81 .PP
82 To disable a configuration file supplied by the vendor, the recommended way is to place a symlink to
83 /dev/null
84 in the configuration directory in
85 /etc/, with the same filename as the vendor configuration file\&.
86 .SH "[NETWORK] SECTION OPTIONS"
87 .PP
88 The following options are available in the [Network] section:
89 .PP
90 \fISpeedMeter=\fR
91 .RS 4
92 Takes a boolean\&. If set to yes, then
93 \fBsystemd\-networkd\fR
94 measures the traffic of each interface, and
95 \fBnetworkctl status \fR\fB\fIINTERFACE\fR\fR
96 shows the measured speed\&. Defaults to no\&.
97 .sp
98 Added in version 244\&.
99 .RE
100 .PP
101 \fISpeedMeterIntervalSec=\fR
102 .RS 4
103 Specifies the time interval to calculate the traffic speed of each interface\&. If
104 \fISpeedMeter=no\fR, the value is ignored\&. Defaults to 10sec\&.
105 .sp
106 Added in version 244\&.
107 .RE
108 .PP
109 \fIManageForeignRoutingPolicyRules=\fR
110 .RS 4
111 A boolean\&. When true,
112 \fBsystemd\-networkd\fR
113 will remove rules that are not configured in \&.network files (except for rules with protocol
114 "kernel")\&. When false, it will not remove any foreign rules, keeping them even if they are not configured in a \&.network file\&. Defaults to yes\&.
115 .sp
116 Added in version 249\&.
117 .RE
118 .PP
119 \fIManageForeignRoutes=\fR
120 .RS 4
121 A boolean\&. When true,
122 \fBsystemd\-networkd\fR
123 will remove routes that are not configured in \&.network files (except for routes with protocol
124 "kernel",
125 "dhcp"
126 when
127 \fIKeepConfiguration=\fR
128 is true or
129 "dhcp", and
130 "static"
131 when
132 \fIKeepConfiguration=\fR
133 is true or
134 "static")\&. When false, it will not remove any foreign routes, keeping them even if they are not configured in a \&.network file\&. Defaults to yes\&.
135 .sp
136 Added in version 246\&.
137 .RE
138 .PP
139 \fIManageForeignNextHops=\fR
140 .RS 4
141 A boolean\&. When true,
142 \fBsystemd\-networkd\fR
143 will remove nexthops that are not configured in \&.network files (except for routes with protocol
144 "kernel")\&. When false, it will not remove any foreign nexthops, keeping them even if they are not configured in a \&.network file\&. Defaults to yes\&.
145 .sp
146 Added in version 256\&.
147 .RE
148 .PP
149 \fIRouteTable=\fR
150 .RS 4
151 Defines the route table name\&. Takes a whitespace\-separated list of the pairs of route table name and number\&. The route table name and number in each pair are separated with a colon, i\&.e\&.,
152 "\fIname\fR:\fInumber\fR"\&. The route table name must not be
153 "default",
154 "main", or
155 "local", as these route table names are predefined with route table number 253, 254, and 255, respectively\&. The route table number must be an integer in the range 1\&...4294967295, except for predefined numbers 253, 254, and 255\&. This setting can be specified multiple times\&. If an empty string is specified, then the list specified earlier are cleared\&. Defaults to unset\&.
156 .sp
157 Added in version 248\&.
158 .RE
159 .PP
160 \fIIPv4Forwarding=\fR
161 .RS 4
162 Configures IPv4 packet forwarding for the system\&. Takes a boolean value\&. This controls the
163 net\&.ipv4\&.conf\&.default\&.forwarding
164 and
165 net\&.ipv4\&.conf\&.all\&.forwarding
166 sysctl options\&. See
167 \m[blue]\fBIP Sysctl\fR\m[]\&\s-2\u[2]\d\s+2
168 for more details about the sysctl options\&. Defaults to unset and the sysctl options will not be changed\&.
169 .sp
170 If an interface is configured with a \&.network file that enables
171 \fIIPMasquerade=\fR
172 for IPv4 (that is,
173 "ipv4"
174 or
175 "both"), this setting is implied unless explicitly specified\&. See
176 \fIIPMasquerade=\fR
177 in
178 \fBsystemd.network\fR(5)
179 for more details\&.
180 .sp
181 Added in version 256\&.
182 .RE
183 .PP
184 \fIIPv6Forwarding=\fR
185 .RS 4
186 Configures IPv6 packet forwarding for the system\&. Takes a boolean value\&. This controls the
187 net\&.ipv6\&.conf\&.default\&.forwarding
188 and
189 net\&.ipv6\&.conf\&.all\&.forwarding
190 sysctl options\&. See
191 \m[blue]\fBIP Sysctl\fR\m[]\&\s-2\u[2]\d\s+2
192 for more details about the sysctl options\&. Defaults to unset and the sysctl options will not be changed\&.
193 .sp
194 If an interface is configured with a \&.network file that enables
195 \fIIPMasquerade=\fR
196 for IPv6 (that is,
197 "ipv6"
198 or
199 "both"), this setting is implied unless explicitly specified\&. See
200 \fIIPMasquerade=\fR
201 in
202 \fBsystemd.network\fR(5)
203 for more details\&.
204 .sp
205 Added in version 256\&.
206 .RE
207 .PP
208 \fIIPv6PrivacyExtensions=\fR
209 .RS 4
210 Specifies the default value for per\-network
211 \fIIPv6PrivacyExtensions=\fR\&. Takes a boolean or the special values
212 "prefer\-public"
213 and
214 "kernel"\&. See for details in
215 \fBsystemd.network\fR(5)\&. Defaults to
216 "no"\&.
217 .sp
218 Added in version 254\&.
219 .RE
220 .PP
221 \fIUseDomains=\fR
222 .RS 4
223 Specifies the network\- and protocol\-independent default value for the same settings in [IPv6AcceptRA], [DHCPv4], and [DHCPv6] sections below\&. Takes a boolean, or the special value
224 \fBroute\fR\&. See the same setting in
225 \fBsystemd.network\fR(5)\&. Defaults to
226 "no"\&.
227 .sp
228 Added in version 256\&.
229 .RE
230 .SH "[IPV6ACCEPTRA] SECTION OPTIONS"
231 .PP
232 This section configures the default setting of the Neighbor Discovery\&. The following options are available in the [IPv6AcceptRA] section:
233 .PP
234 \fIUseDomains=\fR
235 .RS 4
236 Specifies the network\-independent default value for the same setting in the [IPv6AcceptRA] section in
237 \fBsystemd.network\fR(5)\&. Takes a boolean, or the special value
238 \fBroute\fR\&. When unspecified, the value specified in the [Network] section in
239 \fBnetworkd.conf\fR(5), which defaults to
240 "no", will be used\&.
241 .sp
242 Added in version 256\&.
243 .RE
244 .SH "[IPV6ADDRESSLABEL] SECTION OPTIONS"
245 .PP
246 An [IPv6AddressLabel] section accepts the following keys\&. Specify multiple [IPv6AddressLabel] sections to configure multiple address labels\&. IPv6 address labels are used for address selection\&. See
247 \m[blue]\fBRFC 3484\fR\m[]\&\s-2\u[3]\d\s+2\&. Precedence is managed by userspace, and only the label itself is stored in the kernel\&.
248 .PP
249 \fILabel=\fR
250 .RS 4
251 The label for the prefix, an unsigned integer in the range 0\&...4294967294\&. 0xffffffff is reserved\&. This setting is mandatory\&.
252 .sp
253 Added in version 257\&.
254 .RE
255 .PP
256 \fIPrefix=\fR
257 .RS 4
258 IPv6 prefix is an address with a prefix length, separated by a slash
259 "/"
260 character\&. This setting is mandatory\&.
261 .sp
262 Added in version 257\&.
263 .RE
264 .SH "[DHCPV4] SECTION OPTIONS"
265 .PP
266 This section configures the default configurations of DHCPv4 client\&. If the DHCPv4 client is enabled on an interface, then the configurations below will be used by default unless explicitly specified in the corresponding
267 \&.network
268 file\&. See also
269 \fBsystemd.network\fR(5)\&.
270 .PP
271 The following options are understood:
272 .PP
273 \fIClientIdentifier=\fR
274 .RS 4
275 Specifies the default DHCPv4 client identifier to be used\&. Takes one of
276 \fBmac\fR
277 or
278 \fBduid\fR\&. If set to
279 \fBmac\fR, the MAC address of each link will be used\&. If set to
280 \fBduid\fR, an RFC4361\-compliant Client ID, which is the combination of IAID and DUID, is used\&. IAID can be configured by
281 \fIIAID=\fR
282 in each matching
283 \&.network
284 file\&. DUID can be configured by
285 \fIDUIDType=\fR
286 and
287 \fIDUIDRawData=\fR\&. Defaults to
288 \fBduid\fR\&.
289 .sp
290 Added in version 258\&.
291 .RE
292 .PP
293 \fIDUIDType=\fR
294 .RS 4
295 Specifies how the DUID should be generated\&. See
296 \m[blue]\fBRFC 3315\fR\m[]\&\s-2\u[4]\d\s+2
297 for a description of all the options\&.
298 .sp
299 This takes an integer in the range 0\&...65535, or one of the following string values:
300 .PP
301 \fBvendor\fR
302 .RS 4
303 If
304 "DUIDType=vendor", then the DUID value will be generated using
305 "43793"
306 as the vendor identifier (systemd) and hashed contents of
307 \fBmachine-id\fR(5)\&. This is the default if
308 \fIDUIDType=\fR
309 is not specified\&.
310 .sp
311 Added in version 230\&.
312 .RE
313 .PP
314 \fBuuid\fR
315 .RS 4
316 If
317 "DUIDType=uuid", and
318 \fIDUIDRawData=\fR
319 is not set, then the product UUID is used as a DUID value\&. If a system does not have valid product UUID, then an application\-specific
320 \fBmachine-id\fR(5)
321 is used as a DUID value\&. About the application\-specific machine ID, see
322 \fBsd_id128_get_machine_app_specific\fR(3)\&.
323 .sp
324 Added in version 230\&.
325 .RE
326 .PP
327 \fBlink\-layer\-time[:\fR\fB\fITIME\fR\fR\fB]\fR, \fBlink\-layer\fR
328 .RS 4
329 If
330 "link\-layer\-time"
331 or
332 "link\-layer"
333 is specified, then the MAC address of the interface is used as a DUID value\&. The value
334 "link\-layer\-time"
335 can take additional time value after a colon, e\&.g\&.
336 "link\-layer\-time:2018\-01\-23 12:34:56 UTC"\&. The default time value is
337 "2000\-01\-01 00:00:00 UTC"\&.
338 .sp
339 Added in version 240\&.
340 .RE
341 .sp
342 In all cases,
343 \fIDUIDRawData=\fR
344 can be used to override the actual DUID value that is used\&.
345 .sp
346 Added in version 230\&.
347 .RE
348 .PP
349 \fIDUIDRawData=\fR
350 .RS 4
351 Specifies the DHCP DUID value as a single newline\-terminated, hexadecimal string, with each byte separated by
352 ":"\&. The DUID that is sent is composed of the DUID type specified by
353 \fIDUIDType=\fR
354 and the value configured here\&.
355 .sp
356 The DUID value specified here overrides the DUID that
357 \fBsystemd-networkd.service\fR(8)
358 generates from the machine ID\&. To configure DUID per\-network, see
359 \fBsystemd.network\fR(5)\&. The configured DHCP DUID should conform to the specification in
360 \m[blue]\fBRFC 3315\fR\m[]\&\s-2\u[5]\d\s+2,
361 \m[blue]\fBRFC 6355\fR\m[]\&\s-2\u[6]\d\s+2\&. To configure IAID, see
362 \fBsystemd.network\fR(5)\&.
363 .PP
364 \fBExample\ \&1.\ \&A DUIDType=vendor with a custom value\fR
365 .sp
366 .if n \{\
367 .RS 4
368 .\}
369 .nf
370 DUIDType=vendor
371 DUIDRawData=00:00:ab:11:f9:2a:c2:77:29:f9:5c:00
372 .fi
373 .if n \{\
374 .RE
375 .\}
376 .sp
377 This specifies a 14 byte DUID, with the type DUID\-EN ("00:02"), enterprise number 43793 ("00:00:ab:11"), and identifier value
378 "f9:2a:c2:77:29:f9:5c:00"\&.
379
380 Added in version 230\&.
381 .RE
382 .PP
383 \fIUseDomains=\fR
384 .RS 4
385 Same as the one in the [IPv6AcceptRA] section, but applied for DHCPv4 protocol\&.
386 .sp
387 Added in version 256\&.
388 .RE
389 .SH "[DHCPV6] SECTION OPTIONS"
390 .PP
391 This section configures the default configurations of DHCPv6 client\&. If the DHCPv6 client is enabled on an interface, then the configurations below will be used by default unless explicitly specified in the corresponding
392 \&.network
393 file\&. See also
394 \fBsystemd.network\fR(5)\&.
395 .PP
396 The following options are understood:
397 .PP
398 \fIDUIDType=\fR, \fIDUIDRawData=\fR
399 .RS 4
400 As in the [DHCPv4] section\&.
401 .sp
402 Added in version 249\&.
403 .RE
404 .PP
405 \fIUseDomains=\fR
406 .RS 4
407 As in the [DHCPv4] section\&.
408 .sp
409 Added in version 256\&.
410 .RE
411 .SH "[DHCPRELAY] SECTION OPTIONS"
412 .PP
413 The [DHCPRelay] section contains host\-wide settings for the DHCP relay agent\&.
414 .PP
415 \fIServerAddress=\fR
416 .RS 4
417 Specifies the IPv4 address of the upstream DHCP server\&. This is required for the host to act as a DHCP relay agent\&.
418 .sp
419 Added in version 261\&.
420 .RE
421 .PP
422 \fIOverrideServerIdentifier=\fR
423 .RS 4
424 Takes a boolean value\&. When enabled, the Server Identifier Override sub\-option and the Relay Agent Flags sub\-option in the Relay Agent Information option will be appended to the DHCP message forwarded to the upstream DHCP server\&. Defaults to false\&.
425 .sp
426 Added in version 261\&.
427 .RE
428 .PP
429 \fIRemoteId=\fR
430 .RS 4
431 Specifies the remote ID, which is typically used by DHCP servers to identify the DHCP relay agent\&. Takes a data type and data separated with a colon ("\fItype\fR:\fIvalue\fR")\&. The type takes one of
432 "uint8",
433 "uint16",
434 "uint32",
435 "ipv4address",
436 "ipv6address", or
437 "string"\&. Special characters in the data string may be escaped using
438 \m[blue]\fBC\-style escapes\fR\m[]\&\s-2\u[7]\d\s+2\&. If unset, a UUID generated from the local machine ID will be used\&.
439 .sp
440 Added in version 261\&.
441 .RE
442 .PP
443 \fIExtraOption=\fR
444 .RS 4
445 Specifies an extra sub\-option in the Relay Agent Information option, which is appended to DHCP messages forwarded to the upstream DHCP server\&. Takes a sub\-option code, data type, and data separated with a colon ("\fIcode\fR:\fItype\fR:\fIvalue\fR")\&. The code is an integer in 1\&...254\&. See
446 \fIRemoteId=\fR
447 in the above for the acceptable type and data\&. This setting can be specified multiple times\&. When an empty string is specified, all previous assignments are cleared\&. Defaults to unset, and no extra sub\-option will be appended\&.
448 .sp
449 Added in version 261\&.
450 .RE
451 .SH "[DHCPSERVER] SECTION OPTIONS"
452 .PP
453 This section configures the default setting of the DHCP server\&. The following options are available in the [DHCPServer] section:
454 .PP
455 \fIPersistLeases=\fR
456 .RS 4
457 Specifies the default value for per\-network
458 \fIPersistLeases=\fR\&. Takes a boolean or special value
459 "runtime"\&. See for details in
460 \fBsystemd.network\fR(5)\&. Defaults to
461 "yes"\&.
462 .sp
463 Added in version 256\&.
464 .RE
465 .SH "SEE ALSO"
466 .PP
467 \fBsystemd\fR(1), \fBsystemd.network\fR(5), \fBsystemd-networkd.service\fR(8), \fBmachine-id\fR(5), \fBsd_id128_get_machine_app_specific\fR(3)
468 .SH "NOTES"
469 .IP " 1." 4
470 ๐Ÿ’ฃ๐Ÿ’ฅ๐Ÿงจ๐Ÿ’ฅ๐Ÿ’ฅ๐Ÿ’ฃ Please note that those configuration files must be available at all times. If
471 /usr/local/
472 is a separate partition, it may not be available during early boot, and must not be used for configuration.
473 .IP " 2." 4
474 IP Sysctl
475 .RS 4
476 \%https://docs.kernel.org/networking/ip-sysctl.html
477 .RE
478 .IP " 3." 4
479 RFC 3484
480 .RS 4
481 \%https://tools.ietf.org/html/rfc3484
482 .RE
483 .IP " 4." 4
484 RFC 3315
485 .RS 4
486 \%https://tools.ietf.org/html/rfc3315#section-9
487 .RE
488 .IP " 5." 4
489 RFC 3315
490 .RS 4
491 \%http://tools.ietf.org/html/rfc3315#section-9
492 .RE
493 .IP " 6." 4
494 RFC 6355
495 .RS 4
496 \%http://tools.ietf.org/html/rfc6355
497 .RE
498 .IP " 7." 4
499 C-style escapes
500 .RS 4
501 \%https://en.wikipedia.org/wiki/Escape_sequences_in_C#Table_of_escape_sequences
502 .RE