]>
Commit | Line | Data |
---|---|---|
ad943783 | 1 | <?xml version='1.0'?> <!--*- Mode: nxml; nxml-child-indent: 2; indent-tabs-mode: nil -*--> |
eac684ef | 2 | <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" |
12b42c76 | 3 | "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> |
eac684ef TG |
4 | |
5 | <!-- | |
6 | This file is part of systemd. | |
7 | ||
8 | Copyright 2013 Tom Gundersen | |
9 | ||
10 | systemd is free software; you can redistribute it and/or modify it | |
11 | under the terms of the GNU Lesser General Public License as published by | |
12 | the Free Software Foundation; either version 2.1 of the License, or | |
13 | (at your option) any later version. | |
14 | ||
15 | systemd is distributed in the hope that it will be useful, but | |
16 | WITHOUT ANY WARRANTY; without even the implied warranty of | |
17 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
18 | Lesser General Public License for more details. | |
19 | ||
20 | You should have received a copy of the GNU Lesser General Public License | |
21 | along with systemd; If not, see <http://www.gnu.org/licenses/>. | |
22 | --> | |
23 | ||
24 | <refentry id="systemd.network" conditional='ENABLE_NETWORKD'> | |
25 | ||
798d3a52 ZJS |
26 | <refentryinfo> |
27 | <title>systemd.network</title> | |
28 | <productname>systemd</productname> | |
29 | ||
30 | <authorgroup> | |
31 | <author> | |
32 | <contrib>Developer</contrib> | |
33 | <firstname>Tom</firstname> | |
34 | <surname>Gundersen</surname> | |
35 | <email>teg@jklm.no</email> | |
36 | </author> | |
37 | </authorgroup> | |
38 | </refentryinfo> | |
39 | ||
40 | <refmeta> | |
41 | <refentrytitle>systemd.network</refentrytitle> | |
42 | <manvolnum>5</manvolnum> | |
43 | </refmeta> | |
44 | ||
45 | <refnamediv> | |
46 | <refname>systemd.network</refname> | |
47 | <refpurpose>Network configuration</refpurpose> | |
48 | </refnamediv> | |
49 | ||
50 | <refsynopsisdiv> | |
51 | <para><filename><replaceable>network</replaceable>.network</filename></para> | |
52 | </refsynopsisdiv> | |
53 | ||
54 | <refsect1> | |
55 | <title>Description</title> | |
56 | ||
57 | <para>Network setup is performed by | |
58 | <citerefentry><refentrytitle>systemd-networkd</refentrytitle><manvolnum>8</manvolnum></citerefentry>. | |
59 | </para> | |
60 | ||
61 | <para>Network files must have the extension | |
62 | <filename>.network</filename>; other extensions are ignored. | |
63 | Networks are applied to links whenever the links appear.</para> | |
64 | ||
65 | <para>The <filename>.network</filename> files are read from the | |
66 | files located in the system network directory | |
12b42c76 | 67 | <filename>/usr/lib/systemd/network</filename>, the volatile |
798d3a52 ZJS |
68 | runtime network directory |
69 | <filename>/run/systemd/network</filename> and the local | |
70 | administration network directory | |
12b42c76 | 71 | <filename>/etc/systemd/network</filename>. All configuration files |
798d3a52 ZJS |
72 | are collectively sorted and processed in lexical order, regardless |
73 | of the directories in which they live. However, files with | |
74 | identical filenames replace each other. Files in | |
75 | <filename>/etc</filename> have the highest priority, files in | |
76 | <filename>/run</filename> take precedence over files with the same | |
12b42c76 | 77 | name in <filename>/usr/lib</filename>. This can be used to |
798d3a52 | 78 | override a system-supplied configuration file with a local file if |
57e27ec0 | 79 | needed. As a special case, an empty file (file size 0) or symlink |
b938cb90 | 80 | with the same name pointing to <filename>/dev/null</filename> |
a8eaaee7 | 81 | disables the configuration file entirely (it is "masked").</para> |
82ecb4c3 LP |
82 | |
83 | <para>Note that an interface without any static IPv6 addresses configured, and neither DHCPv6 nor IPv6LL enabled, | |
84 | shall be considered to have no IPv6 support. IPv6 will be automatically disabled for that interface by writing "1" | |
85 | to <filename>/proc/sys/net/ipv6/conf/<replaceable>ifname</replaceable>/disable_ipv6</filename>. | |
86 | </para> | |
798d3a52 ZJS |
87 | </refsect1> |
88 | ||
89 | <refsect1> | |
90 | <title>[Match] Section Options</title> | |
91 | ||
92 | <para>The network file contains a <literal>[Match]</literal> | |
93 | section, which determines if a given network file may be applied | |
94 | to a given device; and a <literal>[Network]</literal> section | |
95 | specifying how the device should be configured. The first (in | |
96 | lexical order) of the network files that matches a given device | |
a22e1850 LP |
97 | is applied, all later files are ignored, even if they match as |
98 | well.</para> | |
798d3a52 ZJS |
99 | |
100 | <para>A network file is said to match a device if each of the | |
101 | entries in the <literal>[Match]</literal> section matches, or if | |
102 | the section is empty. The following keys are accepted:</para> | |
103 | ||
104 | <variablelist class='network-directives'> | |
105 | <varlistentry> | |
106 | <term><varname>MACAddress=</varname></term> | |
107 | <listitem> | |
108 | <para>The hardware address.</para> | |
109 | </listitem> | |
110 | </varlistentry> | |
111 | <varlistentry> | |
112 | <term><varname>Path=</varname></term> | |
113 | <listitem> | |
5256e00e TG |
114 | <para>A whitespace-separated list of shell-style globs |
115 | matching the persistent path, as exposed by the udev | |
116 | property <literal>ID_PATH</literal>.</para> | |
798d3a52 ZJS |
117 | </listitem> |
118 | </varlistentry> | |
119 | <varlistentry> | |
120 | <term><varname>Driver=</varname></term> | |
121 | <listitem> | |
5256e00e TG |
122 | <para>A whitespace-separated list of shell-style globs |
123 | matching the driver currently bound to the device, as | |
798d3a52 ZJS |
124 | exposed by the udev property <literal>DRIVER</literal> |
125 | of its parent device, or if that is not set the driver | |
126 | as exposed by <literal>ethtool -i</literal> of the | |
127 | device itself.</para> | |
128 | </listitem> | |
129 | </varlistentry> | |
130 | <varlistentry> | |
131 | <term><varname>Type=</varname></term> | |
132 | <listitem> | |
5256e00e TG |
133 | <para>A whitespace-separated list of shell-style globs |
134 | matching the device type, as exposed by the udev property | |
798d3a52 ZJS |
135 | <literal>DEVTYPE</literal>.</para> |
136 | </listitem> | |
137 | </varlistentry> | |
138 | <varlistentry> | |
139 | <term><varname>Name=</varname></term> | |
140 | <listitem> | |
5256e00e TG |
141 | <para>A whitespace-separated list of shell-style globs |
142 | matching the device name, as exposed by the udev property | |
143 | <literal>INTERFACE</literal>.</para> | |
798d3a52 ZJS |
144 | </listitem> |
145 | </varlistentry> | |
146 | <varlistentry> | |
147 | <term><varname>Host=</varname></term> | |
148 | <listitem> | |
149 | <para>Matches against the hostname or machine ID of the | |
150 | host. See <literal>ConditionHost=</literal> in | |
151 | <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry> | |
152 | for details. | |
153 | </para> | |
154 | </listitem> | |
155 | </varlistentry> | |
156 | <varlistentry> | |
157 | <term><varname>Virtualization=</varname></term> | |
158 | <listitem> | |
159 | <para>Checks whether the system is executed in a virtualized | |
160 | environment and optionally test whether it is a specific | |
161 | implementation. See <literal>ConditionVirtualization=</literal> in | |
162 | <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry> | |
163 | for details. | |
164 | </para> | |
165 | </listitem> | |
166 | </varlistentry> | |
167 | <varlistentry> | |
168 | <term><varname>KernelCommandLine=</varname></term> | |
169 | <listitem> | |
170 | <para>Checks whether a specific kernel command line option is | |
171 | set (or if prefixed with the exclamation mark unset). See | |
172 | <literal>ConditionKernelCommandLine=</literal> in | |
173 | <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry> | |
174 | for details. | |
175 | </para> | |
176 | </listitem> | |
177 | </varlistentry> | |
178 | <varlistentry> | |
179 | <term><varname>Architecture=</varname></term> | |
180 | <listitem> | |
181 | <para>Checks whether the system is running on a specific | |
182 | architecture. See <literal>ConditionArchitecture=</literal> in | |
183 | <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry> | |
184 | for details. | |
185 | </para> | |
186 | </listitem> | |
187 | </varlistentry> | |
188 | </variablelist> | |
189 | ||
190 | </refsect1> | |
191 | ||
192 | <refsect1> | |
193 | <title>[Link] Section Options</title> | |
194 | ||
195 | <para> The <literal>[Link]</literal> section accepts the following keys:</para> | |
196 | ||
197 | <variablelist class='network-directives'> | |
198 | <varlistentry> | |
199 | <term><varname>MACAddress=</varname></term> | |
200 | <listitem> | |
201 | <para>The hardware address.</para> | |
202 | </listitem> | |
203 | </varlistentry> | |
204 | <varlistentry> | |
205 | <term><varname>MTUBytes=</varname></term> | |
206 | <listitem> | |
207 | <para>The maximum transmission unit in bytes to set for the | |
208 | device. The usual suffixes K, M, G, are supported and are | |
209 | understood to the base of 1024.</para> | |
439689c6 SS |
210 | <para>Note that if IPv6 is enabled on the interface, and the MTU is chosen |
211 | below 1280 (the minimum MTU for IPv6) it will automatically be increased to this value.</para> | |
798d3a52 ZJS |
212 | </listitem> |
213 | </varlistentry> | |
214 | </variablelist> | |
215 | </refsect1> | |
216 | ||
217 | <refsect1> | |
218 | <title>[Network] Section Options</title> | |
219 | ||
220 | <para>The <literal>[Network]</literal> section accepts the following keys:</para> | |
221 | ||
222 | <variablelist class='network-directives'> | |
223 | <varlistentry> | |
224 | <term><varname>Description=</varname></term> | |
225 | <listitem> | |
226 | <para>A description of the device. This is only used for | |
227 | presentation purposes.</para> | |
228 | </listitem> | |
229 | </varlistentry> | |
230 | <varlistentry> | |
231 | <term><varname>DHCP=</varname></term> | |
232 | <listitem> | |
ad943783 | 233 | <para>Enables DHCPv4 and/or DHCPv6 client support. Accepts |
798d3a52 ZJS |
234 | <literal>yes</literal>, <literal>no</literal>, |
235 | <literal>ipv4</literal>, or <literal>ipv6</literal>.</para> | |
e88d8021 | 236 | |
f5a8c43f | 237 | <para>Note that DHCPv6 will by default be triggered by Router |
7f3fdb7f | 238 | Advertisement, if that is enabled, regardless of this parameter. |
f5a8c43f TG |
239 | By enabling DHCPv6 support explicitly, the DHCPv6 client will |
240 | be started regardless of the presence of routers on the link, | |
241 | or what flags the routers pass. See | |
242 | <literal>IPv6AcceptRouterAdvertisements=</literal>.</para> | |
243 | ||
244 | <para>Furthermore, note that by default the domain name | |
e88d8021 ZJS |
245 | specified through DHCP is not used for name resolution. |
246 | See option <option>UseDomains=</option> below.</para> | |
798d3a52 ZJS |
247 | </listitem> |
248 | </varlistentry> | |
249 | <varlistentry> | |
250 | <term><varname>DHCPServer=</varname></term> | |
251 | <listitem> | |
ad943783 LP |
252 | <para>A boolean. Enables DHCPv4 server support. Defaults |
253 | to <literal>no</literal>. Further settings for the DHCP | |
254 | server may be set in the <literal>[DHCPServer]</literal> | |
255 | section described below.</para> | |
798d3a52 ZJS |
256 | </listitem> |
257 | </varlistentry> | |
258 | <varlistentry> | |
56fd6bf7 | 259 | <term><varname>LinkLocalAddressing=</varname></term> |
798d3a52 | 260 | <listitem> |
d0d6a4cd TG |
261 | <para>Enables link-local address autoconfiguration. Accepts |
262 | <literal>yes</literal>, <literal>no</literal>, | |
263 | <literal>ipv4</literal>, or <literal>ipv6</literal>. Defaults to | |
264 | <literal>ipv6</literal>.</para> | |
798d3a52 ZJS |
265 | </listitem> |
266 | </varlistentry> | |
267 | <varlistentry> | |
268 | <term><varname>IPv4LLRoute=</varname></term> | |
269 | <listitem> | |
270 | <para>A boolean. When true, sets up the route needed for | |
271 | non-IPv4LL hosts to communicate with IPv4LL-only hosts. Defaults | |
272 | to false. | |
273 | </para> | |
274 | </listitem> | |
275 | </varlistentry> | |
276 | <varlistentry> | |
113bfde1 TG |
277 | <term><varname>IPv6Token=</varname></term> |
278 | <listitem> | |
279 | <para>An IPv6 address with the top 64 bits unset. When set, indicates the | |
eb142d8e TG |
280 | 64-bit interface part of SLAAC IPv6 addresses for this link. Note that |
281 | the token is only ever used for SLAAC, and not for DHCPv6 addresses, even | |
3708bd46 | 282 | in the case DHCP is requested by router advertisement. By default, the |
eb142d8e | 283 | token is autogenerated.</para> |
113bfde1 TG |
284 | </listitem> |
285 | </varlistentry> | |
286 | <varlistentry> | |
798d3a52 ZJS |
287 | <term><varname>LLMNR=</varname></term> |
288 | <listitem> | |
aaa297d4 LP |
289 | <para>A boolean or <literal>resolve</literal>. When true, |
290 | enables <ulink | |
291 | url="https://tools.ietf.org/html/rfc4795">Link-Local | |
292 | Multicast Name Resolution</ulink> on the link. When set to | |
293 | <literal>resolve</literal>, only resolution is enabled, | |
294 | but not host registration and announcement. Defaults to | |
295 | true. This setting is read by | |
296 | <citerefentry><refentrytitle>systemd-resolved.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para> | |
297 | </listitem> | |
298 | </varlistentry> | |
299 | <varlistentry> | |
300 | <term><varname>MulticastDNS=</varname></term> | |
301 | <listitem> | |
302 | <para>A boolean or <literal>resolve</literal>. When true, | |
303 | enables <ulink | |
304 | url="https://tools.ietf.org/html/rfc6762">Multicast | |
305 | DNS</ulink> support on the link. When set to | |
306 | <literal>resolve</literal>, only resolution is enabled, | |
307 | but not host or service registration and | |
308 | announcement. Defaults to false. This setting is read by | |
309 | <citerefentry><refentrytitle>systemd-resolved.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para> | |
798d3a52 ZJS |
310 | </listitem> |
311 | </varlistentry> | |
ad6c0475 LP |
312 | <varlistentry> |
313 | <term><varname>DNSSEC=</varname></term> | |
314 | <listitem> | |
315 | <para>A boolean or | |
316 | <literal>allow-downgrade</literal>. When true, enables | |
317 | <ulink | |
318 | url="https://tools.ietf.org/html/rfc4033">DNSSEC</ulink> | |
319 | DNS validation support on the link. When set to | |
320 | <literal>allow-downgrade</literal>, compatibility with | |
321 | non-DNSSEC capable networks is increased, by automatically | |
322 | turning off DNSEC in this case. This option defines a | |
323 | per-interface setting for | |
324 | <citerefentry><refentrytitle>resolved.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>'s | |
325 | global <varname>DNSSEC=</varname> option. Defaults to | |
326 | false. This setting is read by | |
327 | <citerefentry><refentrytitle>systemd-resolved.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para> | |
328 | </listitem> | |
329 | </varlistentry> | |
8a516214 LP |
330 | <varlistentry> |
331 | <term><varname>DNSSECNegativeTrustAnchors=</varname></term> | |
332 | <listitem><para>A space-separated list of DNSSEC negative | |
333 | trust anchor domains. If specified and DNSSEC is enabled, | |
334 | look-ups done via the interface's DNS server will be subject | |
335 | to the list of negative trust anchors, and not require | |
336 | authentication for the specified domains, or anything below | |
337 | it. Use this to disable DNSSEC authentication for specific | |
338 | private domains, that cannot be proven valid using the | |
339 | Internet DNS hierarchy. Defaults to the empty list. This | |
340 | setting is read by | |
341 | <citerefentry><refentrytitle>systemd-resolved.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para> | |
342 | </listitem> | |
343 | </varlistentry> | |
798d3a52 ZJS |
344 | <varlistentry> |
345 | <term><varname>LLDP=</varname></term> | |
346 | <listitem> | |
da6c766d LP |
347 | <para>Controls support for Ethernet LLDP packet reception. LLDP is a link-layer protocol commonly |
348 | implemented on professional routers and bridges which announces which physical port a system is connected | |
349 | to, as well as other related data. Accepts a boolean or the special value | |
34437b4f LP |
350 | <literal>routers-only</literal>. When true, incoming LLDP packets are accepted and a database of all LLDP |
351 | neighbors maintained. If <literal>routers-only</literal> is set only LLDP data of various types of routers | |
352 | is collected and LLDP data about other types of devices ignored (such as stations, telephones and | |
7cececb2 | 353 | others). If false, LLDP reception is disabled. Defaults to <literal>routers-only</literal>. Use |
34437b4f | 354 | <citerefentry><refentrytitle>networkctl</refentrytitle><manvolnum>1</manvolnum></citerefentry> to query the |
da6c766d LP |
355 | collected neighbor data. LLDP is only available on Ethernet links. See <varname>EmitLLDP=</varname> below |
356 | for enabling LLDP packet emission from the local system. | |
798d3a52 ZJS |
357 | </para> |
358 | </listitem> | |
359 | </varlistentry> | |
da6c766d LP |
360 | <varlistentry> |
361 | <term><varname>EmitLLDP=</varname></term> | |
362 | <listitem> | |
363 | <para>Controls support for Ethernet LLDP packet emission. Accepts a boolean parameter and defaults to | |
364 | false. If enabled a short LLDP packet with information about the local system is sent out in regular | |
365 | intervals on the link. The LLDP packet will contain information about the local host name, the local | |
366 | machine ID (as stored in | |
367 | <citerefentry><refentrytitle>machine-id</refentrytitle><manvolnum>5</manvolnum></citerefentry>) and the | |
368 | local interface name, as well as the pretty hostname of the system (as set in | |
369 | <citerefentry><refentrytitle>machine-info</refentrytitle><manvolnum>5</manvolnum></citerefentry>). LLDP | |
370 | emission is only available on Ethernet links. Note that this setting passed data suitable for | |
371 | identification of host to the network and should thus not be used on untrusted networks, where such | |
372 | identification data should not be made available. Use this option to enable other systems to identify on | |
373 | which interface they are connected to this system. See <varname>LLDP=</varname> above for an option to | |
374 | enable LLDP reception.</para> | |
375 | </listitem> | |
376 | </varlistentry> | |
0d4ad91d AR |
377 | <varlistentry> |
378 | <term><varname>BindCarrier=</varname></term> | |
379 | <listitem> | |
2ae7505f TG |
380 | <para>A link name or a list of link names. When set, controls the behavior of the current |
381 | link. When all links in the list are in an operational down state, the current link is brought | |
382 | down. When at least one link has carrier, the current interface is brought up. | |
0d4ad91d AR |
383 | </para> |
384 | </listitem> | |
385 | </varlistentry> | |
798d3a52 ZJS |
386 | <varlistentry> |
387 | <term><varname>Address=</varname></term> | |
388 | <listitem> | |
389 | <para>A static IPv4 or IPv6 address and its prefix length, | |
390 | separated by a <literal>/</literal> character. Specify | |
391 | this key more than once to configure several addresses. | |
392 | The format of the address must be as described in | |
3ba3a79d | 393 | <citerefentry project='man-pages'><refentrytitle>inet_pton</refentrytitle><manvolnum>3</manvolnum></citerefentry>. |
798d3a52 ZJS |
394 | This is a short-hand for an [Address] section only |
395 | containing an Address key (see below). This option may be | |
396 | specified more than once. | |
397 | </para> | |
398 | ||
399 | <para>If the specified address is 0.0.0.0 (for IPv4) or | |
400 | [::] (for IPv6), a new address range of the requested size | |
401 | is automatically allocated from a system-wide pool of | |
402 | unused ranges. The allocated range is checked against all | |
403 | current network interfaces and all known network | |
404 | configuration files to avoid address range conflicts. The | |
405 | default system-wide pool consists of 192.168.0.0/16, | |
406 | 172.16.0.0/12 and 10.0.0.0/8 for IPv4, and fc00::/7 for | |
407 | IPv6. This functionality is useful to manage a large | |
408 | number of dynamically created network interfaces with the | |
409 | same network configuration and automatic address range | |
410 | assignment.</para> | |
411 | ||
412 | </listitem> | |
413 | </varlistentry> | |
414 | <varlistentry> | |
415 | <term><varname>Gateway=</varname></term> | |
416 | <listitem> | |
417 | <para>The gateway address, which must be in the format | |
418 | described in | |
3ba3a79d | 419 | <citerefentry project='man-pages'><refentrytitle>inet_pton</refentrytitle><manvolnum>3</manvolnum></citerefentry>. |
798d3a52 ZJS |
420 | This is a short-hand for a [Route] section only containing |
421 | a Gateway key. This option may be specified more than | |
422 | once.</para> | |
423 | </listitem> | |
424 | </varlistentry> | |
425 | <varlistentry> | |
426 | <term><varname>DNS=</varname></term> | |
427 | <listitem> | |
428 | <para>A DNS server address, which must be in the format | |
429 | described in | |
3ba3a79d | 430 | <citerefentry project='man-pages'><refentrytitle>inet_pton</refentrytitle><manvolnum>3</manvolnum></citerefentry>. |
f41b446a | 431 | This option may be specified more than once. This setting is read by |
3df9bec5 | 432 | <citerefentry><refentrytitle>systemd-resolved.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para> |
798d3a52 ZJS |
433 | </listitem> |
434 | </varlistentry> | |
435 | <varlistentry> | |
436 | <term><varname>Domains=</varname></term> | |
437 | <listitem> | |
3df9bec5 LP |
438 | <para>The domains used for DNS host name resolution on this link. Takes a list of DNS domain names which |
439 | are used as search suffixes for extending single-label host names (host names containing no dots) to become | |
440 | fully qualified domain names (FQDNs). If a single-label host name is resolved on this interface, each of | |
441 | the specified search domains are appended to it in turn, converting it into a fully qualified domain name, | |
442 | until one of them may be successfully resolved.</para> | |
443 | ||
444 | <para>The specified domains are also used for routing of DNS queries: look-ups for host names ending in the | |
445 | domains specified here are preferably routed to the DNS servers configured for this interface. If a domain | |
446 | name is prefixed with <literal>~</literal>, the domain name becomes a pure "routing" domain, is used for | |
447 | DNS query routing purposes only and is not used in the described domain search logic. By specifying a | |
07ff561c | 448 | routing domain of <literal>~.</literal> (the tilde indicating definition of a routing domain, the dot |
3df9bec5 LP |
449 | referring to the DNS root domain which is the implied suffix of all valid DNS names) it is possible to |
450 | route all DNS traffic preferably to the DNS server specified for this interface. The route domain logic is | |
451 | particularly useful on multi-homed hosts with DNS servers serving particular private DNS zones on each | |
452 | interface.</para> | |
453 | ||
454 | <para>This setting is read by | |
455 | <citerefentry><refentrytitle>systemd-resolved.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para> | |
798d3a52 ZJS |
456 | </listitem> |
457 | </varlistentry> | |
458 | <varlistentry> | |
459 | <term><varname>NTP=</varname></term> | |
460 | <listitem> | |
f41b446a | 461 | <para>An NTP server address. This option may be specified more than once. This setting is read by |
3df9bec5 | 462 | <citerefentry><refentrytitle>systemd-timesyncd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para> |
798d3a52 ZJS |
463 | </listitem> |
464 | </varlistentry> | |
465 | <varlistentry> | |
466 | <term><varname>IPForward=</varname></term> | |
765afd5c LP |
467 | <listitem><para>Configures IP packet forwarding for the |
468 | system. If enabled, incoming packets on any network | |
469 | interface will be forwarded to any other interfaces | |
470 | according to the routing table. Takes either a boolean | |
471 | argument, or the values <literal>ipv4</literal> or | |
472 | <literal>ipv6</literal>, which only enable IP packet | |
473 | forwarding for the specified address family. This controls | |
474 | the <filename>net.ipv4.ip_forward</filename> and | |
475 | <filename>net.ipv6.conf.all.forwarding</filename> sysctl | |
476 | options of the network interface (see <ulink | |
4046d836 LP |
477 | url="https://www.kernel.org/doc/Documentation/networking/ip-sysctl.txt">ip-sysctl.txt</ulink> |
478 | for details about sysctl options). Defaults to | |
479 | <literal>no</literal>.</para> | |
480 | ||
765afd5c LP |
481 | <para>Note: this setting controls a global kernel option, |
482 | and does so one way only: if a network that has this setting | |
483 | enabled is set up the global setting is turned on. However, | |
484 | it is never turned off again, even after all networks with | |
485 | this setting enabled are shut down again.</para> | |
486 | ||
487 | <para>To allow IP packet forwarding only between specific | |
488 | network interfaces use a firewall.</para> | |
4046d836 | 489 | </listitem> |
798d3a52 ZJS |
490 | </varlistentry> |
491 | <varlistentry> | |
492 | <term><varname>IPMasquerade=</varname></term> | |
493 | <listitem><para>Configures IP masquerading for the network | |
b938cb90 | 494 | interface. If enabled, packets forwarded from the network |
798d3a52 ZJS |
495 | interface will be appear as coming from the local host. |
496 | Takes a boolean argument. Implies | |
5c82dd13 | 497 | <varname>IPForward=ipv4</varname>. Defaults to |
4046d836 | 498 | <literal>no</literal>.</para></listitem> |
798d3a52 | 499 | </varlistentry> |
a46e37cb SS |
500 | <varlistentry> |
501 | <term><varname>IPv6PrivacyExtensions=</varname></term> | |
1f0d9695 LP |
502 | <listitem><para>Configures use of stateless temporary |
503 | addresses that change over time (see <ulink | |
504 | url="https://tools.ietf.org/html/rfc4941">RFC 4941</ulink>, | |
505 | Privacy Extensions for Stateless Address Autoconfiguration | |
506 | in IPv6). Takes a boolean or the special values | |
507 | <literal>prefer-public</literal> and | |
b938cb90 | 508 | <literal>kernel</literal>. When true, enables the privacy |
1f0d9695 | 509 | extensions and prefers temporary addresses over public |
b938cb90 | 510 | addresses. When <literal>prefer-public</literal>, enables the |
1f0d9695 LP |
511 | privacy extensions, but prefers public addresses over |
512 | temporary addresses. When false, the privacy extensions | |
b938cb90 | 513 | remain disabled. When <literal>kernel</literal>, the kernel's |
1f0d9695 | 514 | default setting will be left in place. Defaults to |
a46e37cb SS |
515 | <literal>no</literal>.</para></listitem> |
516 | </varlistentry> | |
941d0aa8 SS |
517 | <varlistentry> |
518 | <term><varname>IPv6AcceptRouterAdvertisements=</varname></term> | |
a8eaaee7 | 519 | <listitem><para>Force the setting of the <filename>accept_ra</filename> |
ebf98081 ZJS |
520 | (router advertisements) setting for the interface. |
521 | When unset, the kernel default is used, and router | |
522 | advertisements are accepted only when local forwarding | |
523 | is disabled for that interface. | |
f5a8c43f TG |
524 | When router advertisements are accepted, they will |
525 | trigger the start of the DHCPv6 client if the relevant | |
526 | flags are passed, or if no routers are found on the link. | |
ebf98081 ZJS |
527 | Takes a boolean. If true, router advertisements are |
528 | accepted, when false, router advertisements are ignored, | |
529 | independently of the local forwarding state.</para> | |
530 | ||
531 | <para>See | |
532 | <ulink url="https://www.kernel.org/doc/Documentation/networking/ip-sysctl.txt">ip-sysctl.txt</ulink> | |
533 | in the kernel documentation, but note that systemd's | |
534 | setting of <constant>1</constant> corresponds to | |
535 | kernel's setting of <constant>2</constant>.</para> | |
536 | </listitem> | |
941d0aa8 | 537 | </varlistentry> |
44de7fb1 SS |
538 | <varlistentry> |
539 | <term><varname>IPv6DuplicateAddressDetection=</varname></term> | |
a8eaaee7 JE |
540 | <listitem><para>Configures the amount of IPv6 Duplicate |
541 | Address Detection (DAD) probes to send. Defaults to unset. | |
44de7fb1 SS |
542 | </para></listitem> |
543 | </varlistentry> | |
a86cba89 SS |
544 | <varlistentry> |
545 | <term><varname>IPv6HopLimit=</varname></term> | |
546 | <listitem><para>Configures IPv6 Hop Limit. For each router that | |
547 | forwards the packet, the hop limit is decremented by 1. When the | |
548 | hop limit field reaches zero, the packet is discarded. | |
549 | Defaults to unset. | |
550 | </para></listitem> | |
551 | </varlistentry> | |
23d8b221 SS |
552 | <varlistentry> |
553 | <term><varname>ProxyARP=</varname></term> | |
554 | <listitem><para>A boolean. Configures proxy ARP. Proxy ARP is the technique in which one host, | |
555 | usually a router, answers ARP requests intended for another machine. By "faking" its identity, | |
556 | the router accepts responsibility for routing packets to the "real" destination. (see <ulink | |
557 | url="https://tools.ietf.org/html/rfc1027">RFC 1027</ulink>. | |
558 | Defaults to unset. | |
559 | </para></listitem> | |
560 | </varlistentry> | |
798d3a52 ZJS |
561 | <varlistentry> |
562 | <term><varname>Bridge=</varname></term> | |
563 | <listitem> | |
564 | <para>The name of the bridge to add the link to.</para> | |
565 | </listitem> | |
566 | </varlistentry> | |
567 | <varlistentry> | |
568 | <term><varname>Bond=</varname></term> | |
569 | <listitem> | |
570 | <para>The name of the bond to add the link to.</para> | |
571 | </listitem> | |
572 | </varlistentry> | |
573 | <varlistentry> | |
574 | <term><varname>VLAN=</varname></term> | |
575 | <listitem> | |
576 | <para>The name of a VLAN to create on the link. This | |
577 | option may be specified more than once.</para> | |
578 | </listitem> | |
579 | </varlistentry> | |
580 | <varlistentry> | |
581 | <term><varname>MACVLAN=</varname></term> | |
582 | <listitem> | |
583 | <para>The name of a MACVLAN to create on the link. This | |
584 | option may be specified more than once.</para> | |
585 | </listitem> | |
586 | </varlistentry> | |
587 | <varlistentry> | |
588 | <term><varname>VXLAN=</varname></term> | |
589 | <listitem> | |
590 | <para>The name of a VXLAN to create on the link. This | |
591 | option may be specified more than once.</para> | |
592 | </listitem> | |
593 | </varlistentry> | |
594 | <varlistentry> | |
595 | <term><varname>Tunnel=</varname></term> | |
596 | <listitem> | |
597 | <para>The name of a Tunnel to create on the link. This | |
598 | option may be specified more than once.</para> | |
599 | </listitem> | |
600 | </varlistentry> | |
601 | </variablelist> | |
602 | ||
603 | </refsect1> | |
604 | ||
605 | <refsect1> | |
606 | <title>[Address] Section Options</title> | |
607 | ||
608 | <para>An <literal>[Address]</literal> section accepts the | |
609 | following keys. Specify several <literal>[Address]</literal> | |
610 | sections to configure several addresses.</para> | |
611 | ||
612 | <variablelist class='network-directives'> | |
613 | <varlistentry> | |
614 | <term><varname>Address=</varname></term> | |
615 | <listitem> | |
616 | <para>As in the <literal>[Network]</literal> section. This | |
617 | key is mandatory.</para> | |
618 | </listitem> | |
619 | </varlistentry> | |
620 | <varlistentry> | |
621 | <term><varname>Peer=</varname></term> | |
622 | <listitem> | |
623 | <para>The peer address in a point-to-point connection. | |
624 | Accepts the same format as the <literal>Address</literal> | |
625 | key.</para> | |
626 | </listitem> | |
627 | </varlistentry> | |
628 | <varlistentry> | |
629 | <term><varname>Broadcast=</varname></term> | |
630 | <listitem> | |
631 | <para>The broadcast address, which must be in the format | |
632 | described in | |
3ba3a79d | 633 | <citerefentry project='man-pages'><refentrytitle>inet_pton</refentrytitle><manvolnum>3</manvolnum></citerefentry>. |
798d3a52 ZJS |
634 | This key only applies to IPv4 addresses. If it is not |
635 | given, it is derived from the <literal>Address</literal> | |
636 | key.</para> | |
637 | </listitem> | |
638 | </varlistentry> | |
639 | <varlistentry> | |
640 | <term><varname>Label=</varname></term> | |
641 | <listitem> | |
642 | <para>An address label.</para> | |
643 | </listitem> | |
644 | </varlistentry> | |
b5834a0b SS |
645 | <varlistentry> |
646 | <term><varname>PreferredLifetime=</varname></term> | |
647 | <listitem> | |
648 | <para>Allows the default "preferred lifetime" of the address to be overridden. | |
649 | Only three settings are accepted: <literal>forever</literal> or <literal>infinity</literal> | |
650 | which is the default and means that the address never expires, and <literal>0</literal> which means | |
651 | that the address is considered immediately "expired" and will not be used, | |
652 | unless explicitly requested. A setting of PreferredLifetime=0 is useful for | |
653 | addresses which are added to be used only by a specific application, | |
654 | which is then configured to use them explicitly.</para> | |
655 | </listitem> | |
656 | </varlistentry> | |
798d3a52 ZJS |
657 | </variablelist> |
658 | </refsect1> | |
659 | ||
660 | <refsect1> | |
661 | <title>[Route] Section Options</title> | |
662 | <para>The <literal>[Route]</literal> section accepts the | |
663 | following keys. Specify several <literal>[Route]</literal> | |
664 | sections to configure several routes.</para> | |
665 | ||
666 | <variablelist class='network-directives'> | |
667 | <varlistentry> | |
668 | <term><varname>Gateway=</varname></term> | |
669 | <listitem> | |
670 | <para>As in the <literal>[Network]</literal> section.</para> | |
671 | </listitem> | |
672 | </varlistentry> | |
673 | <varlistentry> | |
674 | <term><varname>Destination=</varname></term> | |
675 | <listitem> | |
676 | <para>The destination prefix of the route. Possibly | |
b938cb90 | 677 | followed by a slash and the prefix length. If omitted, a |
798d3a52 ZJS |
678 | full-length host route is assumed.</para> |
679 | </listitem> | |
680 | </varlistentry> | |
681 | <varlistentry> | |
682 | <term><varname>Source=</varname></term> | |
683 | <listitem> | |
684 | <para>The source prefix of the route. Possibly followed by | |
b938cb90 | 685 | a slash and the prefix length. If omitted, a full-length |
798d3a52 ZJS |
686 | host route is assumed.</para> |
687 | </listitem> | |
688 | </varlistentry> | |
689 | <varlistentry> | |
690 | <term><varname>Metric=</varname></term> | |
691 | <listitem> | |
b938cb90 | 692 | <para>The metric of the route (an unsigned integer).</para> |
798d3a52 ZJS |
693 | </listitem> |
694 | </varlistentry> | |
769b56a3 TG |
695 | <varlistentry> |
696 | <term><varname>Scope=</varname></term> | |
697 | <listitem> | |
a8eaaee7 | 698 | <para>The scope of the route, which can be <literal>global</literal>, |
769b56a3 TG |
699 | <literal>link</literal> or <literal>host</literal>. Defaults to |
700 | <literal>global</literal>.</para> | |
701 | </listitem> | |
0d07e595 JK |
702 | </varlistentry> |
703 | <varlistentry> | |
704 | <term><varname>PreferredSource=</varname></term> | |
705 | <listitem> | |
706 | <para>The preferred source address of the route. The address | |
707 | must be in the format described in | |
708 | <citerefentry project='man-pages'><refentrytitle>inet_pton</refentrytitle><manvolnum>3</manvolnum></citerefentry>.</para> | |
709 | </listitem> | |
769b56a3 | 710 | </varlistentry> |
c953b24c SS |
711 | <varlistentry> |
712 | <term><varname>Table=<replaceable>num</replaceable></varname></term> | |
713 | <listitem> | |
714 | <para>The table identifier for the route (a number between 1 and 4294967295, or 0 to unset). | |
715 | The table can be retrieved using <command>ip route show table <replaceable>num</replaceable></command>. | |
716 | </para> | |
717 | </listitem> | |
718 | </varlistentry> | |
798d3a52 ZJS |
719 | </variablelist> |
720 | </refsect1> | |
721 | ||
722 | <refsect1> | |
723 | <title>[DHCP] Section Options</title> | |
ad943783 LP |
724 | <para>The <literal>[DHCP]</literal> section configures the |
725 | DHCPv4 and DHCP6 client, if it is enabled with the | |
726 | <varname>DHCP=</varname> setting described above:</para> | |
798d3a52 ZJS |
727 | |
728 | <variablelist class='network-directives'> | |
729 | <varlistentry> | |
730 | <term><varname>UseDNS=</varname></term> | |
731 | <listitem> | |
732 | <para>When true (the default), the DNS servers received | |
733 | from the DHCP server will be used and take precedence over | |
734 | any statically configured ones.</para> | |
e88d8021 ZJS |
735 | |
736 | <para>This corresponds to the <option>nameserver</option> | |
ad943783 LP |
737 | option in <citerefentry |
738 | project='man-pages'><refentrytitle>resolv.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para> | |
798d3a52 ZJS |
739 | </listitem> |
740 | </varlistentry> | |
301f4073 MM |
741 | <varlistentry> |
742 | <term><varname>UseNTP=</varname></term> | |
743 | <listitem> | |
744 | <para>When true (the default), the NTP servers received | |
745 | from the DHCP server will be used by systemd-timesyncd | |
746 | and take precedence over any statically configured ones.</para> | |
747 | </listitem> | |
748 | </varlistentry> | |
798d3a52 ZJS |
749 | <varlistentry> |
750 | <term><varname>UseMTU=</varname></term> | |
751 | <listitem> | |
752 | <para>When true, the interface maximum transmission unit | |
753 | from the DHCP server will be used on the current link. | |
754 | Defaults to false.</para> | |
755 | </listitem> | |
756 | </varlistentry> | |
757 | <varlistentry> | |
758 | <term><varname>SendHostname=</varname></term> | |
759 | <listitem> | |
d59be2cf ZJS |
760 | <para>When true (the default), the machine's hostname will |
761 | be sent to the DHCP server.</para> | |
798d3a52 ZJS |
762 | </listitem> |
763 | </varlistentry> | |
764 | <varlistentry> | |
765 | <term><varname>UseHostname=</varname></term> | |
766 | <listitem> | |
767 | <para>When true (the default), the hostname received from | |
ad943783 | 768 | the DHCP server will be set as the transient hostname of the system |
d59be2cf | 769 | </para> |
798d3a52 ZJS |
770 | </listitem> |
771 | </varlistentry> | |
1adc5d0b SS |
772 | <varlistentry> |
773 | <term><varname>Hostname=</varname></term> | |
774 | <listitem> | |
d59be2cf ZJS |
775 | <para>Use this value for the hostname which is sent to the |
776 | DHCP server, instead of machine's hostname.</para> | |
1adc5d0b SS |
777 | </listitem> |
778 | </varlistentry> | |
798d3a52 ZJS |
779 | <varlistentry> |
780 | <term><varname>UseDomains=</varname></term> | |
781 | <listitem> | |
07ff561c | 782 | <para>Takes a boolean argument, or the special value <literal>route</literal>. When true, the domain name |
b2a81c0b LP |
783 | received from the DHCP server will be used as DNS search domain over this link, similar to the effect of |
784 | the <option>Domains=</option> setting. If set to <literal>route</literal>, the domain name received from | |
785 | the DHCP server will be used for routing DNS queries only, but not for searching, similar to the effect of | |
786 | the <option>Domains=</option> setting when the argument is prefixed with <literal>~</literal>. Defaults to | |
787 | false.</para> | |
788 | ||
789 | <para>It is recommended to enable this option only on trusted networks, as setting this affects resolution | |
790 | of all host names, in particular to single-label names. It is generally safer to use the supplied domain | |
791 | only as routing domain, rather than as search domain, in order to not have it affect local resolution of | |
792 | single-label names.</para> | |
793 | ||
794 | <para>When set to true, this setting corresponds to the <option>domain</option> option in <citerefentry | |
795 | project='man-pages'><refentrytitle>resolv.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para> | |
798d3a52 ZJS |
796 | </listitem> |
797 | </varlistentry> | |
798 | <varlistentry> | |
799 | <term><varname>UseRoutes=</varname></term> | |
800 | <listitem> | |
801 | <para>When true (the default), the static routes will be | |
802 | requested from the DHCP server and added to the routing | |
a8eaaee7 | 803 | table with a metric of 1024.</para> |
798d3a52 ZJS |
804 | </listitem> |
805 | </varlistentry> | |
ad943783 LP |
806 | |
807 | <varlistentry> | |
808 | <term><varname>UseTimezone=</varname></term> | |
809 | ||
810 | <listitem><para>When true, the timezone received from the | |
7f3fdb7f | 811 | DHCP server will be set as timezone of the local |
ad943783 LP |
812 | system. Defaults to <literal>no</literal>.</para></listitem> |
813 | </varlistentry> | |
814 | ||
798d3a52 ZJS |
815 | <varlistentry> |
816 | <term><varname>CriticalConnection=</varname></term> | |
817 | <listitem> | |
818 | <para>When true, the connection will never be torn down | |
819 | even if the DHCP lease expires. This is contrary to the | |
820 | DHCP specification, but may be the best choice if, say, | |
821 | the root filesystem relies on this connection. Defaults to | |
822 | false.</para> | |
823 | </listitem> | |
824 | </varlistentry> | |
e2e08e77 | 825 | |
3e43b2cd JJ |
826 | <varlistentry> |
827 | <term><varname>ClientIdentifier=</varname></term> | |
828 | <listitem> | |
076ea6f6 LP |
829 | <para>The DHCPv4 client identifier to use. Either <literal>mac</literal> to use the MAC address of the link |
830 | or <literal>duid</literal> (the default, see below) to use a RFC4361-compliant Client ID.</para> | |
3e43b2cd JJ |
831 | </listitem> |
832 | </varlistentry> | |
e2e08e77 | 833 | |
798d3a52 ZJS |
834 | <varlistentry> |
835 | <term><varname>VendorClassIdentifier=</varname></term> | |
836 | <listitem> | |
837 | <para>The vendor class identifier used to identify vendor | |
838 | type and configuration.</para> | |
839 | </listitem> | |
840 | </varlistentry> | |
076ea6f6 | 841 | |
e2e08e77 ZJS |
842 | <varlistentry> |
843 | <term><varname>DUIDType=</varname></term> | |
844 | <listitem> | |
845 | <para>Override the global <varname>DUIDType</varname> setting for this network. See | |
846 | <citerefentry><refentrytitle>networkd.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry> | |
847 | for a description of possible values.</para> | |
848 | </listitem> | |
849 | </varlistentry> | |
076ea6f6 | 850 | |
e2e08e77 ZJS |
851 | <varlistentry> |
852 | <term><varname>DUIDRawData=</varname></term> | |
853 | <listitem> | |
854 | <para>Override the global <varname>DUIDRawData</varname> setting for this network. See | |
855 | <citerefentry><refentrytitle>networkd.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry> | |
856 | for a description of possible values.</para> | |
076ea6f6 LP |
857 | </listitem> |
858 | </varlistentry> | |
e2e08e77 | 859 | |
d05def16 LP |
860 | <varlistentry> |
861 | <term><varname>IAID=</varname></term> | |
862 | <listitem> | |
863 | <para>The DHCP Identity Association Identifier (IAID) for the interface, a 32-bit unsigned integer.</para> | |
864 | </listitem> | |
865 | </varlistentry> | |
866 | ||
798d3a52 ZJS |
867 | <varlistentry> |
868 | <term><varname>RequestBroadcast=</varname></term> | |
869 | <listitem> | |
870 | <para>Request the server to use broadcast messages before | |
871 | the IP address has been configured. This is necessary for | |
872 | devices that cannot receive RAW packets, or that cannot | |
873 | receive packets at all before an IP address has been | |
874 | configured. On the other hand, this must not be enabled on | |
875 | networks where broadcasts are filtered out.</para> | |
876 | </listitem> | |
877 | </varlistentry> | |
e2e08e77 | 878 | |
798d3a52 ZJS |
879 | <varlistentry> |
880 | <term><varname>RouteMetric=</varname></term> | |
881 | <listitem> | |
882 | <para>Set the routing metric for routes specified by the | |
883 | DHCP server.</para> | |
884 | </listitem> | |
885 | </varlistentry> | |
ad943783 | 886 | </variablelist> |
076ea6f6 | 887 | </refsect1> |
413708d1 | 888 | |
ad943783 LP |
889 | <refsect1> |
890 | <title>[DHCPServer] Section Options</title> | |
891 | <para>The <literal>[DHCPServer]</literal> section contains | |
892 | settings for the DHCP server, if enabled via the | |
893 | <varname>DHCPServer=</varname> option described above:</para> | |
894 | ||
895 | <variablelist class='network-directives'> | |
896 | ||
9b3a67c5 TG |
897 | <varlistentry> |
898 | <term><varname>PoolOffset=</varname></term> | |
899 | <term><varname>PoolSize=</varname></term> | |
900 | ||
901 | <listitem><para>Configures the pool of addresses to hand out. The pool | |
902 | is a contiguous sequence of IP addresses in the subnet configured for | |
903 | the server address, which does not include the subnet nor the broadcast | |
904 | address. <varname>PoolOffset=</varname> takes the offset of the pool | |
905 | from the start of subnet, or zero to use the default value. | |
906 | <varname>PoolSize=</varname> takes the number of IP addresses in the | |
b938cb90 | 907 | pool or zero to use the default value. By default, the pool starts at |
9b3a67c5 TG |
908 | the first address after the subnet address and takes up the rest of |
909 | the subnet, excluding the broadcast address. If the pool includes | |
910 | the server address (the default), this is reserved and not handed | |
911 | out to clients.</para></listitem> | |
912 | </varlistentry> | |
913 | ||
ad943783 LP |
914 | <varlistentry> |
915 | <term><varname>DefaultLeaseTimeSec=</varname></term> | |
916 | <term><varname>MaxLeaseTimeSec=</varname></term> | |
917 | ||
918 | <listitem><para>Control the default and maximum DHCP lease | |
919 | time to pass to clients. These settings take time values in seconds or | |
920 | another common time unit, depending on the suffix. The default | |
921 | lease time is used for clients that did not ask for a specific | |
922 | lease time. If a client asks for a lease time longer than the | |
b938cb90 | 923 | maximum lease time, it is automatically shortened to the |
ad943783 LP |
924 | specified time. The default lease time defaults to 1h, the |
925 | maximum lease time to 12h. Shorter lease times are beneficial | |
926 | if the configuration data in DHCP leases changes frequently | |
927 | and clients shall learn the new settings with shorter | |
928 | latencies. Longer lease times reduce the generated DHCP | |
929 | network traffic.</para></listitem> | |
930 | </varlistentry> | |
931 | ||
932 | <varlistentry> | |
933 | <term><varname>EmitDNS=</varname></term> | |
934 | <term><varname>DNS=</varname></term> | |
935 | ||
936 | <listitem><para>Configures whether the DHCP leases handed out | |
937 | to clients shall contain DNS server information. The | |
938 | <varname>EmitDNS=</varname> setting takes a boolean argument | |
939 | and defaults to <literal>yes</literal>. The DNS servers to | |
940 | pass to clients may be configured with the | |
941 | <varname>DNS=</varname> option, which takes a list of IPv4 | |
942 | addresses. If the <varname>EmitDNS=</varname> option is | |
b938cb90 | 943 | enabled but no servers configured, the servers are |
ad943783 LP |
944 | automatically propagated from an "uplink" interface that has |
945 | appropriate servers set. The "uplink" interface is determined | |
946 | by the default route of the system with the highest | |
947 | priority. Note that this information is acquired at the time | |
948 | the lease is handed out, and does not take uplink interfaces | |
949 | into account that acquire DNS or NTP server information at a | |
950 | later point. DNS server propagation does not take | |
951 | <filename>/etc/resolv.conf</filename> into account. Also, note | |
a8eaaee7 | 952 | that the leases are not refreshed if the uplink network |
ad943783 | 953 | configuration changes. To ensure clients regularly acquire the |
b938cb90 | 954 | most current uplink DNS server information, it is thus |
ad943783 LP |
955 | advisable to shorten the DHCP lease time via |
956 | <varname>MaxLeaseTimeSec=</varname> described | |
957 | above.</para></listitem> | |
958 | </varlistentry> | |
959 | ||
960 | <varlistentry> | |
961 | <term><varname>EmitNTP=</varname></term> | |
962 | <term><varname>NTP=</varname></term> | |
963 | ||
964 | <listitem><para>Similar to the <varname>EmitDNS=</varname> and | |
b938cb90 | 965 | <varname>DNS=</varname> settings described above, these |
ad943783 LP |
966 | settings configure whether and what NTP server information |
967 | shall be emitted as part of the DHCP lease. The same syntax, | |
968 | propagation semantics and defaults apply as for | |
969 | <varname>EmitDNS=</varname> and | |
970 | <varname>DNS=</varname>.</para></listitem> | |
971 | </varlistentry> | |
972 | ||
973 | <varlistentry> | |
974 | <term><varname>EmitTimezone=</varname></term> | |
975 | <term><varname>Timezone=</varname></term> | |
976 | ||
977 | <listitem><para>Configures whether the DHCP leases handed out | |
978 | to clients shall contain timezone information. The | |
979 | <varname>EmitTimezone=</varname> setting takes a boolean | |
980 | argument and defaults to <literal>yes</literal>. The | |
981 | <varname>Timezone=</varname> setting takes a timezone string | |
982 | (such as <literal>Europe/Berlin</literal> or | |
983 | <literal>UTC</literal>) to pass to clients. If no explicit | |
b938cb90 | 984 | timezone is set, the system timezone of the local host is |
ad943783 LP |
985 | propagated, as determined by the |
986 | <filename>/etc/localtime</filename> symlink.</para></listitem> | |
987 | </varlistentry> | |
988 | ||
989 | </variablelist> | |
990 | </refsect1> | |
991 | ||
798d3a52 ZJS |
992 | <refsect1> |
993 | <title>[Bridge] Section Options</title> | |
994 | <para>The <literal>[Bridge]</literal> section accepts the | |
995 | following keys.</para> | |
996 | <variablelist class='network-directives'> | |
165c41a9 SS |
997 | <varlistentry> |
998 | <term><varname>UnicastFlood=</varname></term> | |
999 | <listitem> | |
072f9e4a ZJS |
1000 | <para>A boolean. Controls whether the bridge should flood |
1001 | traffic for which an FDB entry is missing and the destination | |
1002 | is unknown through this port. Defaults to on. | |
47c7dfe2 | 1003 | </para> |
165c41a9 SS |
1004 | </listitem> |
1005 | </varlistentry> | |
1006 | <varlistentry> | |
1007 | <term><varname>HairPin=</varname></term> | |
1008 | <listitem> | |
47c7dfe2 ZJS |
1009 | <para>A boolean. Configures whether traffic may be sent back |
1010 | out of the port on which it was received. By default, this | |
1011 | flag is false, and the bridge will not forward traffic back | |
1012 | out of the receiving port.</para> | |
165c41a9 SS |
1013 | </listitem> |
1014 | </varlistentry> | |
1015 | <varlistentry> | |
84c34096 | 1016 | <term><varname>UseBPDU=</varname></term> |
165c41a9 | 1017 | <listitem> |
47c7dfe2 | 1018 | <para>A boolean. Configures whether STP Bridge Protocol Data Units will be |
84c34096 | 1019 | processed by the bridge port. Defaults to yes.</para> |
165c41a9 SS |
1020 | </listitem> |
1021 | </varlistentry> | |
1022 | <varlistentry> | |
1023 | <term><varname>FastLeave=</varname></term> | |
1024 | <listitem> | |
47c7dfe2 | 1025 | <para>A boolean. This flag allows the bridge to immediately stop multicast |
a8eaaee7 | 1026 | traffic on a port that receives an IGMP Leave message. It is only used with |
47c7dfe2 | 1027 | IGMP snooping if enabled on the bridge. Defaults to off.</para> |
165c41a9 SS |
1028 | </listitem> |
1029 | </varlistentry> | |
1030 | <varlistentry> | |
23da66bb | 1031 | <term><varname>AllowPortToBeRoot=</varname></term> |
165c41a9 | 1032 | <listitem> |
47c7dfe2 ZJS |
1033 | <para>A boolean. Configures whether a given port is allowed to |
1034 | become a root port. Only used when STP is enabled on the bridge. | |
23da66bb | 1035 | Defaults to on.</para> |
165c41a9 SS |
1036 | </listitem> |
1037 | </varlistentry> | |
798d3a52 ZJS |
1038 | <varlistentry> |
1039 | <term><varname>Cost=</varname></term> | |
1040 | <listitem> | |
47c7dfe2 | 1041 | <para>Sets the "cost" of sending packets of this interface. |
a8eaaee7 | 1042 | Each port in a bridge may have a different speed and the cost |
798d3a52 | 1043 | is used to decide which link to use. Faster interfaces |
47c7dfe2 | 1044 | should have lower costs.</para> |
798d3a52 ZJS |
1045 | </listitem> |
1046 | </varlistentry> | |
1047 | </variablelist> | |
1048 | </refsect1> | |
798d3a52 ZJS |
1049 | <refsect1> |
1050 | <title>[BridgeFDB] Section Options</title> | |
1051 | <para>The <literal>[BridgeFDB]</literal> section manages the | |
1052 | forwarding database table of a port and accepts the following | |
1053 | keys. Specify several <literal>[BridgeFDB]</literal> sections to | |
1054 | configure several static MAC table entries.</para> | |
1055 | ||
1056 | <variablelist class='network-directives'> | |
1057 | <varlistentry> | |
1058 | <term><varname>MACAddress=</varname></term> | |
1059 | <listitem> | |
1060 | <para>As in the <literal>[Network]</literal> section. This | |
1061 | key is mandatory.</para> | |
1062 | </listitem> | |
1063 | </varlistentry> | |
1064 | <varlistentry> | |
1065 | <term><varname>VLANId=</varname></term> | |
1066 | <listitem> | |
a8eaaee7 JE |
1067 | <para>The VLAN ID for the new static MAC table entry. If |
1068 | omitted, no VLAN ID info is appended to the new static MAC | |
798d3a52 ZJS |
1069 | table entry.</para> |
1070 | </listitem> | |
1071 | </varlistentry> | |
1072 | </variablelist> | |
1073 | </refsect1> | |
1074 | ||
1075 | <refsect1> | |
1076 | <title>Example</title> | |
1077 | <example> | |
12b42c76 | 1078 | <title>/etc/systemd/network/50-static.network</title> |
798d3a52 ZJS |
1079 | |
1080 | <programlisting>[Match] | |
eac684ef TG |
1081 | Name=enp2s0 |
1082 | ||
1083 | [Network] | |
1084 | Address=192.168.0.15/24 | |
1085 | Gateway=192.168.0.1</programlisting> | |
798d3a52 | 1086 | </example> |
eac684ef | 1087 | |
798d3a52 | 1088 | <example> |
12b42c76 | 1089 | <title>/etc/systemd/network/80-dhcp.network</title> |
eac684ef | 1090 | |
798d3a52 | 1091 | <programlisting>[Match] |
eac684ef TG |
1092 | Name=en* |
1093 | ||
1094 | [Network] | |
9c8ca3f7 | 1095 | DHCP=yes</programlisting> |
798d3a52 | 1096 | </example> |
eac684ef | 1097 | |
798d3a52 | 1098 | <example> |
6c1695be | 1099 | <title>/etc/systemd/network/25-bridge-static.network</title> |
f47c5c47 | 1100 | |
798d3a52 | 1101 | <programlisting>[Match] |
f47c5c47 | 1102 | Name=bridge0 |
1103 | ||
1104 | [Network] | |
1105 | Address=192.168.0.15/24 | |
1106 | Gateway=192.168.0.1 | |
1107 | DNS=192.168.0.1</programlisting> | |
798d3a52 | 1108 | </example> |
f47c5c47 | 1109 | |
798d3a52 | 1110 | <example> |
6c1695be | 1111 | <title>/etc/systemd/network/25-bridge-slave-interface.network</title> |
f47c5c47 | 1112 | |
798d3a52 | 1113 | <programlisting>[Match] |
f47c5c47 | 1114 | Name=enp2s0 |
1115 | ||
1116 | [Network] | |
1117 | Bridge=bridge0</programlisting> | |
798d3a52 ZJS |
1118 | </example> |
1119 | <example> | |
6c1695be | 1120 | <title>/etc/systemd/network/25-ipip.network</title> |
0a8a0fad | 1121 | |
798d3a52 | 1122 | <programlisting>[Match] |
0a8a0fad TG |
1123 | Name=em1 |
1124 | ||
1125 | [Network] | |
1126 | Tunnel=ipip-tun</programlisting> | |
798d3a52 | 1127 | </example> |
0a8a0fad | 1128 | |
798d3a52 | 1129 | <example> |
6c1695be | 1130 | <title>/etc/systemd/network/25-sit.network</title> |
0a8a0fad | 1131 | |
798d3a52 | 1132 | <programlisting>[Match] |
0a8a0fad TG |
1133 | Name=em1 |
1134 | ||
1135 | [Network] | |
1136 | Tunnel=sit-tun</programlisting> | |
798d3a52 | 1137 | </example> |
0a8a0fad | 1138 | |
798d3a52 | 1139 | <example> |
6c1695be | 1140 | <title>/etc/systemd/network/25-gre.network</title> |
0a8a0fad | 1141 | |
798d3a52 | 1142 | <programlisting>[Match] |
0a8a0fad TG |
1143 | Name=em1 |
1144 | ||
1145 | [Network] | |
1146 | Tunnel=gre-tun</programlisting> | |
798d3a52 | 1147 | </example> |
0a8a0fad | 1148 | |
798d3a52 | 1149 | <example> |
6c1695be | 1150 | <title>/etc/systemd/network/25-vti.network</title> |
0a8a0fad | 1151 | |
798d3a52 | 1152 | <programlisting>[Match] |
0a8a0fad TG |
1153 | Name=em1 |
1154 | ||
1155 | [Network] | |
1156 | Tunnel=vti-tun</programlisting> | |
798d3a52 | 1157 | </example> |
d94facdc MH |
1158 | |
1159 | <example> | |
6c1695be | 1160 | <title>/etc/systemd/network/25-bond.network</title> |
d94facdc MH |
1161 | |
1162 | <programlisting>[Match] | |
1163 | Name=bond1 | |
1164 | ||
1165 | [Network] | |
1166 | DHCP=yes | |
1167 | </programlisting> | |
1168 | </example> | |
1169 | ||
798d3a52 ZJS |
1170 | </refsect1> |
1171 | ||
1172 | <refsect1> | |
1173 | <title>See Also</title> | |
1174 | <para> | |
1175 | <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, | |
f41b446a | 1176 | <citerefentry><refentrytitle>systemd-networkd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>, |
798d3a52 | 1177 | <citerefentry><refentrytitle>systemd.link</refentrytitle><manvolnum>5</manvolnum></citerefentry>, |
aaa297d4 LP |
1178 | <citerefentry><refentrytitle>systemd.netdev</refentrytitle><manvolnum>5</manvolnum></citerefentry>, |
1179 | <citerefentry><refentrytitle>systemd-resolved.service</refentrytitle><manvolnum>8</manvolnum></citerefentry> | |
798d3a52 ZJS |
1180 | </para> |
1181 | </refsect1> | |
eac684ef TG |
1182 | |
1183 | </refentry> |