]>
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 | ||
bac150e9 ZJS |
61 | <para>The main network file must have the extension <filename>.network</filename>; other |
62 | extensions are ignored. Networks are applied to links whenever the links appear.</para> | |
63 | ||
64 | <para>The <filename>.network</filename> files are read from the files located in the system | |
65 | network directory <filename>/usr/lib/systemd/network</filename>, the volatile runtime network | |
66 | directory <filename>/run/systemd/network</filename> and the local administration network | |
67 | directory <filename>/etc/systemd/network</filename>. All configuration files are collectively | |
68 | sorted and processed in lexical order, regardless of the directories in which they live. | |
69 | However, files with identical filenames replace each other. Files in <filename>/etc</filename> | |
70 | have the highest priority, files in <filename>/run</filename> take precedence over files with | |
71 | the same name in <filename>/usr/lib</filename>. This can be used to override a system-supplied | |
72 | configuration file with a local file if needed. As a special case, an empty file (file size 0) | |
73 | or symlink with the same name pointing to <filename>/dev/null</filename> disables the | |
74 | configuration file entirely (it is "masked").</para> | |
75 | ||
76 | <para>Along with the network file <filename>foo.network</filename>, a "drop-in" directory | |
77 | <filename>foo.network.d/</filename> may exist. All files with the suffix | |
78 | <literal>.conf</literal> from this directory will be parsed after the file itself is | |
79 | parsed. This is useful to alter or add configuration settings, without having to modify the main | |
80 | configuration file. Each drop-in file must have appropriate section headers.</para> | |
81 | ||
82 | <para>In addition to <filename>/etc/systemd/network</filename>, drop-in <literal>.d</literal> | |
83 | directories can be placed in <filename>/usr/lib/systemd/network</filename> or | |
84 | <filename>/run/systemd/network</filename> directories. Drop-in files in | |
85 | <filename>/etc</filename> take precedence over those in <filename>/run</filename> which in turn | |
86 | take precedence over those in <filename>/usr/lib</filename>. Drop-in files under any of these | |
87 | directories take precedence over the main netdev file wherever located. (Of course, since | |
88 | <filename>/run</filename> is temporary and <filename>/usr/lib</filename> is for vendors, it is | |
89 | unlikely drop-ins should be used in either of those places.)</para> | |
90 | ||
91 | <para>Note that an interface without any static IPv6 addresses configured, and neither DHCPv6 | |
92 | nor IPv6LL enabled, shall be considered to have no IPv6 support. IPv6 will be automatically | |
93 | disabled for that interface by writing "1" to | |
94 | <filename>/proc/sys/net/ipv6/conf/<replaceable>ifname</replaceable>/disable_ipv6</filename>. | |
82ecb4c3 | 95 | </para> |
798d3a52 ZJS |
96 | </refsect1> |
97 | ||
98 | <refsect1> | |
99 | <title>[Match] Section Options</title> | |
100 | ||
101 | <para>The network file contains a <literal>[Match]</literal> | |
102 | section, which determines if a given network file may be applied | |
103 | to a given device; and a <literal>[Network]</literal> section | |
104 | specifying how the device should be configured. The first (in | |
105 | lexical order) of the network files that matches a given device | |
a22e1850 LP |
106 | is applied, all later files are ignored, even if they match as |
107 | well.</para> | |
798d3a52 ZJS |
108 | |
109 | <para>A network file is said to match a device if each of the | |
110 | entries in the <literal>[Match]</literal> section matches, or if | |
111 | the section is empty. The following keys are accepted:</para> | |
112 | ||
113 | <variablelist class='network-directives'> | |
114 | <varlistentry> | |
115 | <term><varname>MACAddress=</varname></term> | |
116 | <listitem> | |
de25aae1 DKG |
117 | <para>The hardware address of the interface (use full colon-delimited hexadecimal, e.g., |
118 | 01:23:45:67:89:ab).</para> | |
798d3a52 ZJS |
119 | </listitem> |
120 | </varlistentry> | |
121 | <varlistentry> | |
122 | <term><varname>Path=</varname></term> | |
123 | <listitem> | |
5256e00e TG |
124 | <para>A whitespace-separated list of shell-style globs |
125 | matching the persistent path, as exposed by the udev | |
618b196e DM |
126 | property <literal>ID_PATH</literal>. If the list is |
127 | prefixed with a "!", the test is inverted; i.e. it is | |
128 | true when <literal>ID_PATH</literal> does not match any | |
129 | item in the list.</para> | |
798d3a52 ZJS |
130 | </listitem> |
131 | </varlistentry> | |
132 | <varlistentry> | |
133 | <term><varname>Driver=</varname></term> | |
134 | <listitem> | |
5256e00e TG |
135 | <para>A whitespace-separated list of shell-style globs |
136 | matching the driver currently bound to the device, as | |
798d3a52 ZJS |
137 | exposed by the udev property <literal>DRIVER</literal> |
138 | of its parent device, or if that is not set the driver | |
139 | as exposed by <literal>ethtool -i</literal> of the | |
618b196e DM |
140 | device itself. If the list is prefixed with a "!", the |
141 | test is inverted.</para> | |
798d3a52 ZJS |
142 | </listitem> |
143 | </varlistentry> | |
144 | <varlistentry> | |
145 | <term><varname>Type=</varname></term> | |
146 | <listitem> | |
5256e00e TG |
147 | <para>A whitespace-separated list of shell-style globs |
148 | matching the device type, as exposed by the udev property | |
618b196e DM |
149 | <literal>DEVTYPE</literal>. If the list is prefixed with |
150 | a "!", the test is inverted.</para> | |
798d3a52 ZJS |
151 | </listitem> |
152 | </varlistentry> | |
153 | <varlistentry> | |
154 | <term><varname>Name=</varname></term> | |
155 | <listitem> | |
5256e00e TG |
156 | <para>A whitespace-separated list of shell-style globs |
157 | matching the device name, as exposed by the udev property | |
618b196e DM |
158 | <literal>INTERFACE</literal>. If the list is prefixed |
159 | with a "!", the test is inverted.</para> | |
798d3a52 ZJS |
160 | </listitem> |
161 | </varlistentry> | |
162 | <varlistentry> | |
163 | <term><varname>Host=</varname></term> | |
164 | <listitem> | |
165 | <para>Matches against the hostname or machine ID of the | |
166 | host. See <literal>ConditionHost=</literal> in | |
167 | <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry> | |
168 | for details. | |
169 | </para> | |
170 | </listitem> | |
171 | </varlistentry> | |
172 | <varlistentry> | |
173 | <term><varname>Virtualization=</varname></term> | |
174 | <listitem> | |
175 | <para>Checks whether the system is executed in a virtualized | |
176 | environment and optionally test whether it is a specific | |
177 | implementation. See <literal>ConditionVirtualization=</literal> in | |
178 | <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry> | |
179 | for details. | |
180 | </para> | |
181 | </listitem> | |
182 | </varlistentry> | |
183 | <varlistentry> | |
184 | <term><varname>KernelCommandLine=</varname></term> | |
185 | <listitem> | |
186 | <para>Checks whether a specific kernel command line option is | |
187 | set (or if prefixed with the exclamation mark unset). See | |
188 | <literal>ConditionKernelCommandLine=</literal> in | |
189 | <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry> | |
190 | for details. | |
191 | </para> | |
192 | </listitem> | |
193 | </varlistentry> | |
194 | <varlistentry> | |
195 | <term><varname>Architecture=</varname></term> | |
196 | <listitem> | |
197 | <para>Checks whether the system is running on a specific | |
198 | architecture. See <literal>ConditionArchitecture=</literal> in | |
199 | <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry> | |
200 | for details. | |
201 | </para> | |
202 | </listitem> | |
203 | </varlistentry> | |
204 | </variablelist> | |
205 | ||
206 | </refsect1> | |
207 | ||
208 | <refsect1> | |
209 | <title>[Link] Section Options</title> | |
210 | ||
211 | <para> The <literal>[Link]</literal> section accepts the following keys:</para> | |
212 | ||
213 | <variablelist class='network-directives'> | |
214 | <varlistentry> | |
215 | <term><varname>MACAddress=</varname></term> | |
216 | <listitem> | |
de25aae1 | 217 | <para>The hardware address to set for the device.</para> |
798d3a52 ZJS |
218 | </listitem> |
219 | </varlistentry> | |
220 | <varlistentry> | |
221 | <term><varname>MTUBytes=</varname></term> | |
222 | <listitem> | |
223 | <para>The maximum transmission unit in bytes to set for the | |
224 | device. The usual suffixes K, M, G, are supported and are | |
225 | understood to the base of 1024.</para> | |
439689c6 SS |
226 | <para>Note that if IPv6 is enabled on the interface, and the MTU is chosen |
227 | below 1280 (the minimum MTU for IPv6) it will automatically be increased to this value.</para> | |
798d3a52 ZJS |
228 | </listitem> |
229 | </varlistentry> | |
99d2baa2 SS |
230 | <varlistentry> |
231 | <term><varname>ARP=</varname></term> | |
232 | <listitem> | |
233 | <para> A boolean. Enables or disables the ARP (low-level Address Resolution Protocol) | |
234 | for this interface. Defaults to unset, which means that the kernel default will be used.</para> | |
235 | <para> For example, disabling ARP is useful when creating multiple MACVLAN or VLAN virtual | |
236 | interfaces atop a single lower-level physical interface, which will then only serve as a | |
237 | link/"bridge" device aggregating traffic to the same physical link and not participate in | |
238 | the network otherwise.</para> | |
239 | </listitem> | |
240 | </varlistentry> | |
a09dc546 DM |
241 | <varlistentry> |
242 | <term><varname>Unmanaged=</varname></term> | |
243 | <listitem> | |
244 | <para>A boolean. When <literal>yes</literal>, no attempts are | |
245 | made to bring up or configure matching links, equivalent to | |
246 | when there are no matching network files. Defaults to | |
247 | <literal>no</literal>.</para> | |
248 | <para>This is useful for preventing later matching network | |
249 | files from interfering with certain interfaces that are fully | |
250 | controlled by other applications.</para> | |
251 | </listitem> | |
252 | </varlistentry> | |
798d3a52 ZJS |
253 | </variablelist> |
254 | </refsect1> | |
255 | ||
256 | <refsect1> | |
257 | <title>[Network] Section Options</title> | |
258 | ||
259 | <para>The <literal>[Network]</literal> section accepts the following keys:</para> | |
260 | ||
261 | <variablelist class='network-directives'> | |
262 | <varlistentry> | |
263 | <term><varname>Description=</varname></term> | |
264 | <listitem> | |
265 | <para>A description of the device. This is only used for | |
266 | presentation purposes.</para> | |
267 | </listitem> | |
268 | </varlistentry> | |
269 | <varlistentry> | |
270 | <term><varname>DHCP=</varname></term> | |
271 | <listitem> | |
ad943783 | 272 | <para>Enables DHCPv4 and/or DHCPv6 client support. Accepts |
798d3a52 | 273 | <literal>yes</literal>, <literal>no</literal>, |
c702bd3b LY |
274 | <literal>ipv4</literal>, or <literal>ipv6</literal>. Defaults |
275 | to <literal>no</literal>.</para> | |
e88d8021 | 276 | |
f5a8c43f | 277 | <para>Note that DHCPv6 will by default be triggered by Router |
7f3fdb7f | 278 | Advertisement, if that is enabled, regardless of this parameter. |
f5a8c43f TG |
279 | By enabling DHCPv6 support explicitly, the DHCPv6 client will |
280 | be started regardless of the presence of routers on the link, | |
281 | or what flags the routers pass. See | |
f921f573 | 282 | <literal>IPv6AcceptRA=</literal>.</para> |
f5a8c43f TG |
283 | |
284 | <para>Furthermore, note that by default the domain name | |
e88d8021 ZJS |
285 | specified through DHCP is not used for name resolution. |
286 | See option <option>UseDomains=</option> below.</para> | |
2ef322fc LP |
287 | |
288 | <para>See the <literal>[DHCP]</literal> section below for further configuration options for the DHCP client | |
289 | support.</para> | |
798d3a52 ZJS |
290 | </listitem> |
291 | </varlistentry> | |
292 | <varlistentry> | |
293 | <term><varname>DHCPServer=</varname></term> | |
294 | <listitem> | |
ad943783 LP |
295 | <para>A boolean. Enables DHCPv4 server support. Defaults |
296 | to <literal>no</literal>. Further settings for the DHCP | |
297 | server may be set in the <literal>[DHCPServer]</literal> | |
298 | section described below.</para> | |
798d3a52 ZJS |
299 | </listitem> |
300 | </varlistentry> | |
301 | <varlistentry> | |
56fd6bf7 | 302 | <term><varname>LinkLocalAddressing=</varname></term> |
798d3a52 | 303 | <listitem> |
d0d6a4cd TG |
304 | <para>Enables link-local address autoconfiguration. Accepts |
305 | <literal>yes</literal>, <literal>no</literal>, | |
306 | <literal>ipv4</literal>, or <literal>ipv6</literal>. Defaults to | |
307 | <literal>ipv6</literal>.</para> | |
798d3a52 ZJS |
308 | </listitem> |
309 | </varlistentry> | |
310 | <varlistentry> | |
311 | <term><varname>IPv4LLRoute=</varname></term> | |
312 | <listitem> | |
313 | <para>A boolean. When true, sets up the route needed for | |
314 | non-IPv4LL hosts to communicate with IPv4LL-only hosts. Defaults | |
315 | to false. | |
316 | </para> | |
317 | </listitem> | |
318 | </varlistentry> | |
319 | <varlistentry> | |
113bfde1 TG |
320 | <term><varname>IPv6Token=</varname></term> |
321 | <listitem> | |
322 | <para>An IPv6 address with the top 64 bits unset. When set, indicates the | |
eb142d8e TG |
323 | 64-bit interface part of SLAAC IPv6 addresses for this link. Note that |
324 | the token is only ever used for SLAAC, and not for DHCPv6 addresses, even | |
3708bd46 | 325 | in the case DHCP is requested by router advertisement. By default, the |
eb142d8e | 326 | token is autogenerated.</para> |
113bfde1 TG |
327 | </listitem> |
328 | </varlistentry> | |
329 | <varlistentry> | |
798d3a52 ZJS |
330 | <term><varname>LLMNR=</varname></term> |
331 | <listitem> | |
aaa297d4 LP |
332 | <para>A boolean or <literal>resolve</literal>. When true, |
333 | enables <ulink | |
334 | url="https://tools.ietf.org/html/rfc4795">Link-Local | |
335 | Multicast Name Resolution</ulink> on the link. When set to | |
336 | <literal>resolve</literal>, only resolution is enabled, | |
337 | but not host registration and announcement. Defaults to | |
338 | true. This setting is read by | |
339 | <citerefentry><refentrytitle>systemd-resolved.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para> | |
340 | </listitem> | |
341 | </varlistentry> | |
342 | <varlistentry> | |
343 | <term><varname>MulticastDNS=</varname></term> | |
344 | <listitem> | |
345 | <para>A boolean or <literal>resolve</literal>. When true, | |
346 | enables <ulink | |
347 | url="https://tools.ietf.org/html/rfc6762">Multicast | |
348 | DNS</ulink> support on the link. When set to | |
349 | <literal>resolve</literal>, only resolution is enabled, | |
350 | but not host or service registration and | |
351 | announcement. Defaults to false. This setting is read by | |
352 | <citerefentry><refentrytitle>systemd-resolved.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para> | |
798d3a52 ZJS |
353 | </listitem> |
354 | </varlistentry> | |
ad6c0475 LP |
355 | <varlistentry> |
356 | <term><varname>DNSSEC=</varname></term> | |
357 | <listitem> | |
358 | <para>A boolean or | |
359 | <literal>allow-downgrade</literal>. When true, enables | |
360 | <ulink | |
361 | url="https://tools.ietf.org/html/rfc4033">DNSSEC</ulink> | |
362 | DNS validation support on the link. When set to | |
363 | <literal>allow-downgrade</literal>, compatibility with | |
364 | non-DNSSEC capable networks is increased, by automatically | |
785889e5 | 365 | turning off DNSSEC in this case. This option defines a |
ad6c0475 LP |
366 | per-interface setting for |
367 | <citerefentry><refentrytitle>resolved.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>'s | |
368 | global <varname>DNSSEC=</varname> option. Defaults to | |
369 | false. This setting is read by | |
370 | <citerefentry><refentrytitle>systemd-resolved.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para> | |
371 | </listitem> | |
372 | </varlistentry> | |
8a516214 LP |
373 | <varlistentry> |
374 | <term><varname>DNSSECNegativeTrustAnchors=</varname></term> | |
375 | <listitem><para>A space-separated list of DNSSEC negative | |
376 | trust anchor domains. If specified and DNSSEC is enabled, | |
377 | look-ups done via the interface's DNS server will be subject | |
378 | to the list of negative trust anchors, and not require | |
379 | authentication for the specified domains, or anything below | |
380 | it. Use this to disable DNSSEC authentication for specific | |
381 | private domains, that cannot be proven valid using the | |
382 | Internet DNS hierarchy. Defaults to the empty list. This | |
383 | setting is read by | |
384 | <citerefentry><refentrytitle>systemd-resolved.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para> | |
385 | </listitem> | |
386 | </varlistentry> | |
798d3a52 ZJS |
387 | <varlistentry> |
388 | <term><varname>LLDP=</varname></term> | |
389 | <listitem> | |
da6c766d LP |
390 | <para>Controls support for Ethernet LLDP packet reception. LLDP is a link-layer protocol commonly |
391 | implemented on professional routers and bridges which announces which physical port a system is connected | |
392 | to, as well as other related data. Accepts a boolean or the special value | |
34437b4f LP |
393 | <literal>routers-only</literal>. When true, incoming LLDP packets are accepted and a database of all LLDP |
394 | neighbors maintained. If <literal>routers-only</literal> is set only LLDP data of various types of routers | |
395 | is collected and LLDP data about other types of devices ignored (such as stations, telephones and | |
7cececb2 | 396 | others). If false, LLDP reception is disabled. Defaults to <literal>routers-only</literal>. Use |
34437b4f | 397 | <citerefentry><refentrytitle>networkctl</refentrytitle><manvolnum>1</manvolnum></citerefentry> to query the |
da6c766d LP |
398 | collected neighbor data. LLDP is only available on Ethernet links. See <varname>EmitLLDP=</varname> below |
399 | for enabling LLDP packet emission from the local system. | |
798d3a52 ZJS |
400 | </para> |
401 | </listitem> | |
402 | </varlistentry> | |
da6c766d LP |
403 | <varlistentry> |
404 | <term><varname>EmitLLDP=</varname></term> | |
405 | <listitem> | |
7272b25e LP |
406 | <para>Controls support for Ethernet LLDP packet emission. Accepts a boolean parameter or the special values |
407 | <literal>nearest-bridge</literal>, <literal>non-tpmr-bridge</literal> and | |
408 | <literal>customer-bridge</literal>. Defaults to false, which turns off LLDP packet emission. If not false, | |
409 | a short LLDP packet with information about the local system is sent out in regular intervals on the | |
410 | link. The LLDP packet will contain information about the local host name, the local machine ID (as stored | |
411 | in <citerefentry><refentrytitle>machine-id</refentrytitle><manvolnum>5</manvolnum></citerefentry>) and the | |
da6c766d LP |
412 | local interface name, as well as the pretty hostname of the system (as set in |
413 | <citerefentry><refentrytitle>machine-info</refentrytitle><manvolnum>5</manvolnum></citerefentry>). LLDP | |
7272b25e LP |
414 | emission is only available on Ethernet links. Note that this setting passes data suitable for |
415 | identification of host to the network and should thus not be enabled on untrusted networks, where such | |
416 | identification data should not be made available. Use this option to permit other systems to identify on | |
417 | which interfaces they are connected to this system. The three special values control propagation of the | |
418 | LLDP packets. The <literal>nearest-bridge</literal> setting permits propagation only to the nearest | |
419 | connected bridge, <literal>non-tpmr-bridge</literal> permits propagation across Two-Port MAC Relays, but | |
420 | not any other bridges, and <literal>customer-bridge</literal> permits propagation until a customer bridge | |
421 | is reached. For details about these concepts, see <ulink | |
422 | url="http://standards.ieee.org/getieee802/download/802.1AB-2009.pdf">IEEE 802.1AB-2009</ulink>. Note that | |
423 | configuring this setting to true is equivalent to <literal>nearest-bridge</literal>, the recommended and | |
424 | most restricted level of propagation. See <varname>LLDP=</varname> above for an option to enable LLDP | |
425 | reception.</para> | |
da6c766d LP |
426 | </listitem> |
427 | </varlistentry> | |
0d4ad91d AR |
428 | <varlistentry> |
429 | <term><varname>BindCarrier=</varname></term> | |
430 | <listitem> | |
2ae7505f TG |
431 | <para>A link name or a list of link names. When set, controls the behavior of the current |
432 | link. When all links in the list are in an operational down state, the current link is brought | |
433 | down. When at least one link has carrier, the current interface is brought up. | |
0d4ad91d AR |
434 | </para> |
435 | </listitem> | |
436 | </varlistentry> | |
798d3a52 ZJS |
437 | <varlistentry> |
438 | <term><varname>Address=</varname></term> | |
439 | <listitem> | |
440 | <para>A static IPv4 or IPv6 address and its prefix length, | |
441 | separated by a <literal>/</literal> character. Specify | |
442 | this key more than once to configure several addresses. | |
443 | The format of the address must be as described in | |
3ba3a79d | 444 | <citerefentry project='man-pages'><refentrytitle>inet_pton</refentrytitle><manvolnum>3</manvolnum></citerefentry>. |
798d3a52 ZJS |
445 | This is a short-hand for an [Address] section only |
446 | containing an Address key (see below). This option may be | |
447 | specified more than once. | |
448 | </para> | |
449 | ||
450 | <para>If the specified address is 0.0.0.0 (for IPv4) or | |
451 | [::] (for IPv6), a new address range of the requested size | |
452 | is automatically allocated from a system-wide pool of | |
453 | unused ranges. The allocated range is checked against all | |
454 | current network interfaces and all known network | |
455 | configuration files to avoid address range conflicts. The | |
456 | default system-wide pool consists of 192.168.0.0/16, | |
457 | 172.16.0.0/12 and 10.0.0.0/8 for IPv4, and fc00::/7 for | |
458 | IPv6. This functionality is useful to manage a large | |
459 | number of dynamically created network interfaces with the | |
460 | same network configuration and automatic address range | |
461 | assignment.</para> | |
462 | ||
463 | </listitem> | |
464 | </varlistentry> | |
465 | <varlistentry> | |
466 | <term><varname>Gateway=</varname></term> | |
467 | <listitem> | |
468 | <para>The gateway address, which must be in the format | |
469 | described in | |
3ba3a79d | 470 | <citerefentry project='man-pages'><refentrytitle>inet_pton</refentrytitle><manvolnum>3</manvolnum></citerefentry>. |
798d3a52 ZJS |
471 | This is a short-hand for a [Route] section only containing |
472 | a Gateway key. This option may be specified more than | |
473 | once.</para> | |
474 | </listitem> | |
475 | </varlistentry> | |
476 | <varlistentry> | |
477 | <term><varname>DNS=</varname></term> | |
478 | <listitem> | |
479 | <para>A DNS server address, which must be in the format | |
480 | described in | |
3ba3a79d | 481 | <citerefentry project='man-pages'><refentrytitle>inet_pton</refentrytitle><manvolnum>3</manvolnum></citerefentry>. |
f41b446a | 482 | This option may be specified more than once. This setting is read by |
3df9bec5 | 483 | <citerefentry><refentrytitle>systemd-resolved.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para> |
798d3a52 ZJS |
484 | </listitem> |
485 | </varlistentry> | |
486 | <varlistentry> | |
487 | <term><varname>Domains=</varname></term> | |
488 | <listitem> | |
2df22529 ZJS |
489 | <para>A list of domains which should be resolved using the DNS servers on this link. Each item in the list |
490 | should be a domain name, optionally prefixed with a tilde (<literal>~</literal>). The domains with the | |
491 | prefix are called "routing-only domains". The domains without the prefix are called "search domains" and | |
492 | are first used as search suffixes for extending single-label host names (host names containing no dots) to | |
493 | become fully qualified domain names (FQDNs). If a single-label host name is resolved on this interface, | |
494 | each of the specified search domains are appended to it in turn, converting it into a fully qualified | |
495 | domain name, until one of them may be successfully resolved.</para> | |
496 | ||
497 | <para>Both "search" and "routing-only" domains are used for routing of DNS queries: look-ups for host names | |
498 | ending in those domains (hence also single label names, if any "search domains" are listed), are routed to | |
499 | the DNS servers configured for this interface. The domain routing logic is particularly useful on | |
500 | multi-homed hosts with DNS servers serving particular private DNS zones on each interface.</para> | |
501 | ||
502 | <para>The "routing-only" domain <literal>~.</literal> (the tilde indicating definition of a routing domain, | |
503 | the dot referring to the DNS root domain which is the implied suffix of all valid DNS names) has special | |
504 | effect. It causes all DNS traffic which does not match another configured domain routing entry to be routed | |
505 | to DNS servers specified for this interface. This setting is useful to prefer a certain set of DNS servers | |
506 | if a link on which they are connected is available.</para> | |
3df9bec5 LP |
507 | |
508 | <para>This setting is read by | |
2df22529 ZJS |
509 | <citerefentry><refentrytitle>systemd-resolved.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>. |
510 | "Search domains" correspond to the <varname>domain</varname> and <varname>search</varname> entries in | |
98e9d710 | 511 | <citerefentry project='man-pages'><refentrytitle>resolv.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>. |
2df22529 ZJS |
512 | Domain name routing has no equivalent in the traditional glibc API, which has no concept of domain |
513 | name servers limited to a specific link.</para> | |
798d3a52 ZJS |
514 | </listitem> |
515 | </varlistentry> | |
516 | <varlistentry> | |
517 | <term><varname>NTP=</varname></term> | |
518 | <listitem> | |
f41b446a | 519 | <para>An NTP server address. This option may be specified more than once. This setting is read by |
3df9bec5 | 520 | <citerefentry><refentrytitle>systemd-timesyncd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para> |
798d3a52 ZJS |
521 | </listitem> |
522 | </varlistentry> | |
523 | <varlistentry> | |
524 | <term><varname>IPForward=</varname></term> | |
765afd5c LP |
525 | <listitem><para>Configures IP packet forwarding for the |
526 | system. If enabled, incoming packets on any network | |
527 | interface will be forwarded to any other interfaces | |
528 | according to the routing table. Takes either a boolean | |
529 | argument, or the values <literal>ipv4</literal> or | |
530 | <literal>ipv6</literal>, which only enable IP packet | |
531 | forwarding for the specified address family. This controls | |
532 | the <filename>net.ipv4.ip_forward</filename> and | |
533 | <filename>net.ipv6.conf.all.forwarding</filename> sysctl | |
534 | options of the network interface (see <ulink | |
4046d836 LP |
535 | url="https://www.kernel.org/doc/Documentation/networking/ip-sysctl.txt">ip-sysctl.txt</ulink> |
536 | for details about sysctl options). Defaults to | |
537 | <literal>no</literal>.</para> | |
538 | ||
765afd5c LP |
539 | <para>Note: this setting controls a global kernel option, |
540 | and does so one way only: if a network that has this setting | |
541 | enabled is set up the global setting is turned on. However, | |
542 | it is never turned off again, even after all networks with | |
543 | this setting enabled are shut down again.</para> | |
544 | ||
545 | <para>To allow IP packet forwarding only between specific | |
546 | network interfaces use a firewall.</para> | |
4046d836 | 547 | </listitem> |
798d3a52 ZJS |
548 | </varlistentry> |
549 | <varlistentry> | |
550 | <term><varname>IPMasquerade=</varname></term> | |
551 | <listitem><para>Configures IP masquerading for the network | |
b938cb90 | 552 | interface. If enabled, packets forwarded from the network |
798d3a52 ZJS |
553 | interface will be appear as coming from the local host. |
554 | Takes a boolean argument. Implies | |
5c82dd13 | 555 | <varname>IPForward=ipv4</varname>. Defaults to |
4046d836 | 556 | <literal>no</literal>.</para></listitem> |
798d3a52 | 557 | </varlistentry> |
a46e37cb SS |
558 | <varlistentry> |
559 | <term><varname>IPv6PrivacyExtensions=</varname></term> | |
1f0d9695 LP |
560 | <listitem><para>Configures use of stateless temporary |
561 | addresses that change over time (see <ulink | |
562 | url="https://tools.ietf.org/html/rfc4941">RFC 4941</ulink>, | |
563 | Privacy Extensions for Stateless Address Autoconfiguration | |
564 | in IPv6). Takes a boolean or the special values | |
565 | <literal>prefer-public</literal> and | |
b938cb90 | 566 | <literal>kernel</literal>. When true, enables the privacy |
1f0d9695 | 567 | extensions and prefers temporary addresses over public |
b938cb90 | 568 | addresses. When <literal>prefer-public</literal>, enables the |
1f0d9695 LP |
569 | privacy extensions, but prefers public addresses over |
570 | temporary addresses. When false, the privacy extensions | |
b938cb90 | 571 | remain disabled. When <literal>kernel</literal>, the kernel's |
1f0d9695 | 572 | default setting will be left in place. Defaults to |
a46e37cb SS |
573 | <literal>no</literal>.</para></listitem> |
574 | </varlistentry> | |
941d0aa8 | 575 | <varlistentry> |
f921f573 | 576 | <term><varname>IPv6AcceptRA=</varname></term> |
1e7a0e21 LP |
577 | <listitem><para>Enable or disable IPv6 Router Advertisement (RA) reception support for the interface. Takes |
578 | a boolean parameter. If true, RAs are accepted; if false, RAs are ignored, independently of the local | |
579 | forwarding state. When not set, the kernel default is used, and RAs are accepted only when local forwarding | |
580 | is disabled for that interface. When RAs are accepted, they may trigger the start of the DHCPv6 client if | |
581 | the relevant flags are set in the RA data, or if no routers are found on the link.</para> | |
582 | ||
583 | <para>Further settings for the IPv6 RA support may be configured in the | |
f921f573 | 584 | <literal>[IPv6AcceptRA]</literal> section, see below.</para> |
1e7a0e21 LP |
585 | |
586 | <para>Also see <ulink | |
587 | url="https://www.kernel.org/doc/Documentation/networking/ip-sysctl.txt">ip-sysctl.txt</ulink> in the kernel | |
588 | documentation regarding <literal>accept_ra</literal>, but note that systemd's setting of | |
589 | <constant>1</constant> (i.e. true) corresponds to kernel's setting of <constant>2</constant>.</para> | |
ebf98081 | 590 | </listitem> |
941d0aa8 | 591 | </varlistentry> |
44de7fb1 SS |
592 | <varlistentry> |
593 | <term><varname>IPv6DuplicateAddressDetection=</varname></term> | |
a8eaaee7 JE |
594 | <listitem><para>Configures the amount of IPv6 Duplicate |
595 | Address Detection (DAD) probes to send. Defaults to unset. | |
44de7fb1 SS |
596 | </para></listitem> |
597 | </varlistentry> | |
a86cba89 SS |
598 | <varlistentry> |
599 | <term><varname>IPv6HopLimit=</varname></term> | |
600 | <listitem><para>Configures IPv6 Hop Limit. For each router that | |
601 | forwards the packet, the hop limit is decremented by 1. When the | |
602 | hop limit field reaches zero, the packet is discarded. | |
603 | Defaults to unset. | |
604 | </para></listitem> | |
605 | </varlistentry> | |
23d8b221 | 606 | <varlistentry> |
8f9a206b SS |
607 | <term><varname>IPv4ProxyARP=</varname></term> |
608 | <listitem><para>A boolean. Configures proxy ARP for IPv4. Proxy ARP is the technique in which one host, | |
23d8b221 SS |
609 | usually a router, answers ARP requests intended for another machine. By "faking" its identity, |
610 | the router accepts responsibility for routing packets to the "real" destination. (see <ulink | |
611 | url="https://tools.ietf.org/html/rfc1027">RFC 1027</ulink>. | |
612 | Defaults to unset. | |
613 | </para></listitem> | |
614 | </varlistentry> | |
a0e5c15d | 615 | <varlistentry> |
465dfe59 HV |
616 | <term><varname>IPv6ProxyNDP=</varname></term> |
617 | <listitem><para>A boolean. Configures proxy NDP for IPv6. Proxy NDP (Neighbor Discovery | |
618 | Protocol) is a technique for IPv6 to allow routing of addresses to a different | |
619 | destination when peers expect them to be present on a certain physical link. | |
a0e5c15d FK |
620 | In this case a router answers Neighbour Advertisement messages intended for |
621 | another machine by offering its own MAC address as destination. | |
465dfe59 | 622 | Unlike proxy ARP for IPv4, it is not enabled globally, but will only send Neighbour |
a0e5c15d | 623 | Advertisement messages for addresses in the IPv6 neighbor proxy table, |
465dfe59 HV |
624 | which can also be shown by <command>ip -6 neighbour show proxy</command>. |
625 | systemd-networkd will control the per-interface `proxy_ndp` switch for each configured | |
626 | interface depending on this option. | |
627 | Defautls to unset. | |
628 | </para></listitem> | |
629 | </varlistentry> | |
630 | <varlistentry> | |
631 | <term><varname>IPv6ProxyNDPAddress=</varname></term> | |
632 | <listitem><para>An IPv6 address, for which Neighbour Advertisement messages will be | |
633 | proxied. This option may be specified more than once. systemd-networkd will add the | |
634 | <option>IPv6ProxyNDPAddress=</option> entries to the kernel's IPv6 neighbor proxy table. | |
635 | This option implies <option>IPv6ProxyNDP=true</option> but has no effect if | |
636 | <option>IPv6ProxyNDP</option> has been set to false. Defaults to unset. | |
a0e5c15d FK |
637 | </para></listitem> |
638 | </varlistentry> | |
798d3a52 ZJS |
639 | <varlistentry> |
640 | <term><varname>Bridge=</varname></term> | |
641 | <listitem> | |
9e35b3de ZJS |
642 | <para>The name of the bridge to add the link to. See |
643 | <citerefentry><refentrytitle>systemd.netdev</refentrytitle><manvolnum>5</manvolnum></citerefentry>. | |
644 | </para> | |
798d3a52 ZJS |
645 | </listitem> |
646 | </varlistentry> | |
647 | <varlistentry> | |
648 | <term><varname>Bond=</varname></term> | |
649 | <listitem> | |
9e35b3de ZJS |
650 | <para>The name of the bond to add the link to. See |
651 | <citerefentry><refentrytitle>systemd.netdev</refentrytitle><manvolnum>5</manvolnum></citerefentry>. | |
652 | </para> | |
798d3a52 ZJS |
653 | </listitem> |
654 | </varlistentry> | |
6cb955c6 AR |
655 | <varlistentry> |
656 | <term><varname>VRF=</varname></term> | |
657 | <listitem> | |
9e35b3de ZJS |
658 | <para>The name of the VRF to add the link to. See |
659 | <citerefentry><refentrytitle>systemd.netdev</refentrytitle><manvolnum>5</manvolnum></citerefentry>. | |
660 | </para> | |
6cb955c6 AR |
661 | </listitem> |
662 | </varlistentry> | |
798d3a52 ZJS |
663 | <varlistentry> |
664 | <term><varname>VLAN=</varname></term> | |
665 | <listitem> | |
9e35b3de ZJS |
666 | <para>The name of a VLAN to create on the link. See |
667 | <citerefentry><refentrytitle>systemd.netdev</refentrytitle><manvolnum>5</manvolnum></citerefentry>. | |
668 | This option may be specified more than once.</para> | |
798d3a52 ZJS |
669 | </listitem> |
670 | </varlistentry> | |
671 | <varlistentry> | |
672 | <term><varname>MACVLAN=</varname></term> | |
673 | <listitem> | |
9e35b3de ZJS |
674 | <para>The name of a MACVLAN to create on the link. See |
675 | <citerefentry><refentrytitle>systemd.netdev</refentrytitle><manvolnum>5</manvolnum></citerefentry>. | |
676 | This option may be specified more than once.</para> | |
798d3a52 ZJS |
677 | </listitem> |
678 | </varlistentry> | |
679 | <varlistentry> | |
680 | <term><varname>VXLAN=</varname></term> | |
681 | <listitem> | |
9e35b3de ZJS |
682 | <para>The name of a VXLAN to create on the link. See |
683 | <citerefentry><refentrytitle>systemd.netdev</refentrytitle><manvolnum>5</manvolnum></citerefentry>. | |
684 | This option may be specified more than once.</para> | |
798d3a52 ZJS |
685 | </listitem> |
686 | </varlistentry> | |
687 | <varlistentry> | |
688 | <term><varname>Tunnel=</varname></term> | |
689 | <listitem> | |
9e35b3de ZJS |
690 | <para>The name of a Tunnel to create on the link. See |
691 | <citerefentry><refentrytitle>systemd.netdev</refentrytitle><manvolnum>5</manvolnum></citerefentry>. | |
692 | This option may be specified more than once.</para> | |
798d3a52 ZJS |
693 | </listitem> |
694 | </varlistentry> | |
dd5f3175 SS |
695 | <varlistentry> |
696 | <term><varname>ActiveSlave=</varname></term> | |
697 | <listitem> | |
698 | <para>A boolean. Specifies the new active slave. The <literal>ActiveSlave=</literal> | |
699 | option is only valid for following modes: | |
700 | <literal>active-backup</literal>, | |
701 | <literal>balance-alb</literal> and | |
702 | <literal>balance-tlb</literal>. Defaults to false. | |
703 | </para> | |
704 | </listitem> | |
705 | </varlistentry> | |
706 | <varlistentry> | |
707 | <term><varname>PrimarySlave=</varname></term> | |
708 | <listitem> | |
709 | <para>A boolean. Specifies which slave is the primary device. The specified | |
710 | device will always be the active slave while it is available. Only when the | |
711 | primary is off-line will alternate devices be used. This is useful when | |
712 | one slave is preferred over another, e.g. when one slave has higher throughput | |
713 | than another. The <literal>PrimarySlave=</literal> option is only valid for | |
714 | following modes: | |
715 | <literal>active-backup</literal>, | |
716 | <literal>balance-alb</literal> and | |
717 | <literal>balance-tlb</literal>. Defaults to false. | |
718 | </para> | |
719 | </listitem> | |
720 | </varlistentry> | |
798d3a52 ZJS |
721 | </variablelist> |
722 | ||
723 | </refsect1> | |
724 | ||
725 | <refsect1> | |
726 | <title>[Address] Section Options</title> | |
727 | ||
728 | <para>An <literal>[Address]</literal> section accepts the | |
729 | following keys. Specify several <literal>[Address]</literal> | |
730 | sections to configure several addresses.</para> | |
731 | ||
732 | <variablelist class='network-directives'> | |
733 | <varlistentry> | |
734 | <term><varname>Address=</varname></term> | |
735 | <listitem> | |
736 | <para>As in the <literal>[Network]</literal> section. This | |
737 | key is mandatory.</para> | |
738 | </listitem> | |
739 | </varlistentry> | |
740 | <varlistentry> | |
741 | <term><varname>Peer=</varname></term> | |
742 | <listitem> | |
743 | <para>The peer address in a point-to-point connection. | |
744 | Accepts the same format as the <literal>Address</literal> | |
745 | key.</para> | |
746 | </listitem> | |
747 | </varlistentry> | |
748 | <varlistentry> | |
749 | <term><varname>Broadcast=</varname></term> | |
750 | <listitem> | |
751 | <para>The broadcast address, which must be in the format | |
752 | described in | |
3ba3a79d | 753 | <citerefentry project='man-pages'><refentrytitle>inet_pton</refentrytitle><manvolnum>3</manvolnum></citerefentry>. |
798d3a52 ZJS |
754 | This key only applies to IPv4 addresses. If it is not |
755 | given, it is derived from the <literal>Address</literal> | |
756 | key.</para> | |
757 | </listitem> | |
758 | </varlistentry> | |
759 | <varlistentry> | |
760 | <term><varname>Label=</varname></term> | |
761 | <listitem> | |
762 | <para>An address label.</para> | |
763 | </listitem> | |
764 | </varlistentry> | |
b5834a0b SS |
765 | <varlistentry> |
766 | <term><varname>PreferredLifetime=</varname></term> | |
767 | <listitem> | |
768 | <para>Allows the default "preferred lifetime" of the address to be overridden. | |
769 | Only three settings are accepted: <literal>forever</literal> or <literal>infinity</literal> | |
770 | which is the default and means that the address never expires, and <literal>0</literal> which means | |
771 | that the address is considered immediately "expired" and will not be used, | |
772 | unless explicitly requested. A setting of PreferredLifetime=0 is useful for | |
773 | addresses which are added to be used only by a specific application, | |
774 | which is then configured to use them explicitly.</para> | |
775 | </listitem> | |
776 | </varlistentry> | |
2959fb07 SS |
777 | <varlistentry> |
778 | <term><varname>Scope=</varname></term> | |
779 | <listitem> | |
780 | <para>The scope of the address, which can be <literal>global</literal>, | |
781 | <literal>link</literal> or <literal>host</literal> or an unsigned integer ranges 0 to 255. | |
782 | Defaults to <literal>global</literal>.</para> | |
783 | </listitem> | |
784 | </varlistentry> | |
e63be084 SS |
785 | <varlistentry> |
786 | <term><varname>HomeAddress=</varname></term> | |
787 | <listitem> | |
788 | <para>Takes a boolean argument. Designates this address the "home address" as defined in | |
789 | <ulink url="https://tools.ietf.org/html/rfc6275">RFC 6275</ulink>. | |
790 | Supported only on IPv6. Defaults to false.</para> | |
791 | </listitem> | |
792 | </varlistentry> | |
793 | <varlistentry> | |
794 | <term><varname>DuplicateAddressDetection=</varname></term> | |
795 | <listitem> | |
796 | <para>Takes a boolean argument. Do not perform Duplicate Address Detection | |
797 | <ulink url="https://tools.ietf.org/html/rfc4862">RFC 4862</ulink> when adding this address. | |
798 | Supported only on IPv6. Defaults to false.</para> | |
799 | </listitem> | |
800 | </varlistentry> | |
801 | <varlistentry> | |
802 | <term><varname>ManageTemporaryAddress=</varname></term> | |
803 | <listitem> | |
804 | <para>Takes a boolean argument. If true the kernel manage temporary addresses created | |
805 | from this one as template on behalf of Privacy Extensions | |
806 | <ulink url="https://tools.ietf.org/html/rfc3041">RFC 3041</ulink>. For this to become | |
807 | active, the use_tempaddr sysctl setting has to be set to a value greater than zero. | |
808 | The given address needs to have a prefix length of 64. This flag allows to use privacy | |
809 | extensions in a manually configured network, just like if stateless auto-configuration | |
810 | was active. Defaults to false. </para> | |
811 | </listitem> | |
812 | </varlistentry> | |
813 | <varlistentry> | |
814 | <term><varname>PrefixRoute=</varname></term> | |
815 | <listitem> | |
816 | <para>Takes a boolean argument. When adding or modifying an IPv6 address, the userspace | |
817 | application needs a way to suppress adding a prefix route. This is for example relevant | |
818 | together with IFA_F_MANAGERTEMPADDR, where userspace creates autoconf generated addresses, | |
819 | but depending on on-link, no route for the prefix should be added. Defaults to false.</para> | |
820 | </listitem> | |
821 | </varlistentry> | |
822 | <varlistentry> | |
823 | <term><varname>AutoJoin=</varname></term> | |
824 | <listitem> | |
825 | <para>Takes a boolean argument. Joining multicast group on ethernet level via | |
826 | <command>ip maddr</command> command would not work if we have an Ethernet switch that does | |
827 | IGMP snooping since the switch would not replicate multicast packets on ports that did not | |
828 | have IGMP reports for the multicast addresses. Linux vxlan interfaces created via | |
829 | <command>ip link add vxlan</command> or networkd's netdev kind vxlan have the group option | |
830 | that enables then to do the required join. By extending ip address command with option | |
831 | <literal>autojoin</literal> we can get similar functionality for openvswitch (OVS) vxlan | |
832 | interfaces as well as other tunneling mechanisms that need to receive multicast traffic. | |
833 | Defaults to <literal>no</literal>.</para> | |
834 | </listitem> | |
835 | </varlistentry> | |
798d3a52 ZJS |
836 | </variablelist> |
837 | </refsect1> | |
838 | ||
95b74ef6 SS |
839 | <refsect1> |
840 | <title>[IPv6AddressLabel] Section Options</title> | |
841 | ||
842 | <para>An <literal>[IPv6AddressLabel]</literal> section accepts the | |
843 | following keys. Specify several <literal>[IPv6AddressLabel]</literal> | |
785889e5 | 844 | sections to configure several address labels. IPv6 address labels are |
95b74ef6 SS |
845 | used for address selection. See <ulink url="https://tools.ietf.org/html/rfc3484">RFC 3484</ulink>. |
846 | Precedence is managed by userspace, and only the label itself is stored in the kernel</para> | |
847 | ||
848 | <variablelist class='network-directives'> | |
849 | <varlistentry> | |
850 | <term><varname>Label=</varname></term> | |
851 | <listitem> | |
852 | <para> The label for the prefix (an unsigned integer) ranges 0 to 4294967294. | |
853 | 0xffffffff is reserved. This key is mandatory.</para> | |
854 | </listitem> | |
855 | </varlistentry> | |
856 | <varlistentry> | |
857 | <term><varname>Prefix=</varname></term> | |
858 | <listitem> | |
859 | <para>IPv6 prefix is an address with a prefix length, separated by a slash <literal>/</literal> character. | |
860 | This key is mandatory. </para> | |
861 | </listitem> | |
862 | </varlistentry> | |
863 | </variablelist> | |
864 | </refsect1> | |
865 | ||
798d3a52 ZJS |
866 | <refsect1> |
867 | <title>[Route] Section Options</title> | |
868 | <para>The <literal>[Route]</literal> section accepts the | |
869 | following keys. Specify several <literal>[Route]</literal> | |
870 | sections to configure several routes.</para> | |
871 | ||
872 | <variablelist class='network-directives'> | |
873 | <varlistentry> | |
874 | <term><varname>Gateway=</varname></term> | |
875 | <listitem> | |
876 | <para>As in the <literal>[Network]</literal> section.</para> | |
877 | </listitem> | |
878 | </varlistentry> | |
28959f7d SS |
879 | <varlistentry> |
880 | <term><varname>GatewayOnlink=</varname></term> | |
881 | <listitem> | |
320ac7a6 | 882 | <para>The <literal>GatewayOnlink</literal> option tells the kernel that it does not have |
28959f7d SS |
883 | to check if the gateway is reachable directly by the current machine (i.e., the kernel does |
884 | not need to check if the gateway is attached to the local network), so that we can insert the | |
885 | route in the kernel table without it being complained about. A boolean, defaults to <literal>no</literal>. | |
886 | </para> | |
887 | </listitem> | |
888 | </varlistentry> | |
798d3a52 ZJS |
889 | <varlistentry> |
890 | <term><varname>Destination=</varname></term> | |
891 | <listitem> | |
892 | <para>The destination prefix of the route. Possibly | |
b938cb90 | 893 | followed by a slash and the prefix length. If omitted, a |
798d3a52 ZJS |
894 | full-length host route is assumed.</para> |
895 | </listitem> | |
896 | </varlistentry> | |
897 | <varlistentry> | |
898 | <term><varname>Source=</varname></term> | |
899 | <listitem> | |
900 | <para>The source prefix of the route. Possibly followed by | |
b938cb90 | 901 | a slash and the prefix length. If omitted, a full-length |
798d3a52 ZJS |
902 | host route is assumed.</para> |
903 | </listitem> | |
904 | </varlistentry> | |
905 | <varlistentry> | |
906 | <term><varname>Metric=</varname></term> | |
907 | <listitem> | |
b938cb90 | 908 | <para>The metric of the route (an unsigned integer).</para> |
798d3a52 ZJS |
909 | </listitem> |
910 | </varlistentry> | |
b5bf6f64 SS |
911 | <varlistentry> |
912 | <term><varname>IPv6Preference=</varname></term> | |
913 | <listitem> | |
914 | <para>Specifies the route preference as defined in <ulink | |
915 | url="https://tools.ietf.org/html/rfc4191">RFC4191</ulink> for Router Discovery messages. | |
916 | Which can be one of <literal>low</literal> the route has a lowest priority, | |
917 | <literal>medium</literal> the route has a default priority or | |
918 | <literal>high</literal> the route has a highest priority.</para> | |
919 | </listitem> | |
920 | </varlistentry> | |
769b56a3 TG |
921 | <varlistentry> |
922 | <term><varname>Scope=</varname></term> | |
923 | <listitem> | |
a8eaaee7 | 924 | <para>The scope of the route, which can be <literal>global</literal>, |
769b56a3 TG |
925 | <literal>link</literal> or <literal>host</literal>. Defaults to |
926 | <literal>global</literal>.</para> | |
927 | </listitem> | |
0d07e595 JK |
928 | </varlistentry> |
929 | <varlistentry> | |
930 | <term><varname>PreferredSource=</varname></term> | |
931 | <listitem> | |
932 | <para>The preferred source address of the route. The address | |
933 | must be in the format described in | |
934 | <citerefentry project='man-pages'><refentrytitle>inet_pton</refentrytitle><manvolnum>3</manvolnum></citerefentry>.</para> | |
935 | </listitem> | |
769b56a3 | 936 | </varlistentry> |
c953b24c SS |
937 | <varlistentry> |
938 | <term><varname>Table=<replaceable>num</replaceable></varname></term> | |
939 | <listitem> | |
940 | <para>The table identifier for the route (a number between 1 and 4294967295, or 0 to unset). | |
941 | The table can be retrieved using <command>ip route show table <replaceable>num</replaceable></command>. | |
942 | </para> | |
943 | </listitem> | |
944 | </varlistentry> | |
c83ecc04 SS |
945 | <varlistentry> |
946 | <term><varname>Protocol=</varname></term> | |
947 | <listitem> | |
948 | <para>The Protocol identifier for the route. Takes a number between 0 and 255 or the special values | |
949 | <literal>kernel</literal>, <literal>boot</literal> and <literal>static</literal>. Defaults to | |
950 | <literal>static</literal>. | |
951 | </para> | |
952 | </listitem> | |
953 | </varlistentry> | |
798d3a52 ZJS |
954 | </variablelist> |
955 | </refsect1> | |
956 | ||
957 | <refsect1> | |
958 | <title>[DHCP] Section Options</title> | |
ad943783 LP |
959 | <para>The <literal>[DHCP]</literal> section configures the |
960 | DHCPv4 and DHCP6 client, if it is enabled with the | |
961 | <varname>DHCP=</varname> setting described above:</para> | |
798d3a52 ZJS |
962 | |
963 | <variablelist class='network-directives'> | |
964 | <varlistentry> | |
965 | <term><varname>UseDNS=</varname></term> | |
966 | <listitem> | |
967 | <para>When true (the default), the DNS servers received | |
968 | from the DHCP server will be used and take precedence over | |
969 | any statically configured ones.</para> | |
e88d8021 ZJS |
970 | |
971 | <para>This corresponds to the <option>nameserver</option> | |
ad943783 LP |
972 | option in <citerefentry |
973 | project='man-pages'><refentrytitle>resolv.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para> | |
798d3a52 ZJS |
974 | </listitem> |
975 | </varlistentry> | |
301f4073 MM |
976 | <varlistentry> |
977 | <term><varname>UseNTP=</varname></term> | |
978 | <listitem> | |
979 | <para>When true (the default), the NTP servers received | |
980 | from the DHCP server will be used by systemd-timesyncd | |
981 | and take precedence over any statically configured ones.</para> | |
982 | </listitem> | |
983 | </varlistentry> | |
798d3a52 ZJS |
984 | <varlistentry> |
985 | <term><varname>UseMTU=</varname></term> | |
986 | <listitem> | |
987 | <para>When true, the interface maximum transmission unit | |
988 | from the DHCP server will be used on the current link. | |
989 | Defaults to false.</para> | |
990 | </listitem> | |
991 | </varlistentry> | |
992 | <varlistentry> | |
993 | <term><varname>SendHostname=</varname></term> | |
994 | <listitem> | |
d59be2cf ZJS |
995 | <para>When true (the default), the machine's hostname will |
996 | be sent to the DHCP server.</para> | |
798d3a52 ZJS |
997 | </listitem> |
998 | </varlistentry> | |
999 | <varlistentry> | |
1000 | <term><varname>UseHostname=</varname></term> | |
1001 | <listitem> | |
1002 | <para>When true (the default), the hostname received from | |
ad943783 | 1003 | the DHCP server will be set as the transient hostname of the system |
d59be2cf | 1004 | </para> |
798d3a52 ZJS |
1005 | </listitem> |
1006 | </varlistentry> | |
1adc5d0b SS |
1007 | <varlistentry> |
1008 | <term><varname>Hostname=</varname></term> | |
1009 | <listitem> | |
d59be2cf ZJS |
1010 | <para>Use this value for the hostname which is sent to the |
1011 | DHCP server, instead of machine's hostname.</para> | |
1adc5d0b SS |
1012 | </listitem> |
1013 | </varlistentry> | |
798d3a52 ZJS |
1014 | <varlistentry> |
1015 | <term><varname>UseDomains=</varname></term> | |
1016 | <listitem> | |
07ff561c | 1017 | <para>Takes a boolean argument, or the special value <literal>route</literal>. When true, the domain name |
b2a81c0b LP |
1018 | received from the DHCP server will be used as DNS search domain over this link, similar to the effect of |
1019 | the <option>Domains=</option> setting. If set to <literal>route</literal>, the domain name received from | |
1020 | the DHCP server will be used for routing DNS queries only, but not for searching, similar to the effect of | |
1021 | the <option>Domains=</option> setting when the argument is prefixed with <literal>~</literal>. Defaults to | |
1022 | false.</para> | |
1023 | ||
1024 | <para>It is recommended to enable this option only on trusted networks, as setting this affects resolution | |
1e7a0e21 | 1025 | of all host names, in particular of single-label names. It is generally safer to use the supplied domain |
b2a81c0b LP |
1026 | only as routing domain, rather than as search domain, in order to not have it affect local resolution of |
1027 | single-label names.</para> | |
1028 | ||
1029 | <para>When set to true, this setting corresponds to the <option>domain</option> option in <citerefentry | |
1030 | project='man-pages'><refentrytitle>resolv.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para> | |
798d3a52 ZJS |
1031 | </listitem> |
1032 | </varlistentry> | |
1033 | <varlistentry> | |
1034 | <term><varname>UseRoutes=</varname></term> | |
1035 | <listitem> | |
d6eac9bd DW |
1036 | <para>When true (the default), the static routes will be requested from the DHCP server and added to the |
1037 | routing table with a metric of 1024, and a scope of "global", "link" or "host", depending on the route's | |
1038 | destination and gateway. If the destination is on the local host, e.g., 127.x.x.x, or the same as the | |
1039 | link's own address, the scope will be set to "host". Otherwise if the gateway is null (a direct route), a | |
1040 | "link" scope will be used. For anything else, scope defaults to "global".</para> | |
798d3a52 ZJS |
1041 | </listitem> |
1042 | </varlistentry> | |
ad943783 LP |
1043 | |
1044 | <varlistentry> | |
1045 | <term><varname>UseTimezone=</varname></term> | |
1046 | ||
1047 | <listitem><para>When true, the timezone received from the | |
7f3fdb7f | 1048 | DHCP server will be set as timezone of the local |
ad943783 LP |
1049 | system. Defaults to <literal>no</literal>.</para></listitem> |
1050 | </varlistentry> | |
1051 | ||
798d3a52 ZJS |
1052 | <varlistentry> |
1053 | <term><varname>CriticalConnection=</varname></term> | |
1054 | <listitem> | |
1055 | <para>When true, the connection will never be torn down | |
1056 | even if the DHCP lease expires. This is contrary to the | |
1057 | DHCP specification, but may be the best choice if, say, | |
1058 | the root filesystem relies on this connection. Defaults to | |
1059 | false.</para> | |
1060 | </listitem> | |
1061 | </varlistentry> | |
e2e08e77 | 1062 | |
3e43b2cd JJ |
1063 | <varlistentry> |
1064 | <term><varname>ClientIdentifier=</varname></term> | |
1065 | <listitem> | |
076ea6f6 | 1066 | <para>The DHCPv4 client identifier to use. Either <literal>mac</literal> to use the MAC address of the link |
037a3ded | 1067 | or <literal>duid</literal> (the default, see below) to use an RFC4361-compliant Client ID.</para> |
3e43b2cd JJ |
1068 | </listitem> |
1069 | </varlistentry> | |
e2e08e77 | 1070 | |
798d3a52 ZJS |
1071 | <varlistentry> |
1072 | <term><varname>VendorClassIdentifier=</varname></term> | |
1073 | <listitem> | |
1074 | <para>The vendor class identifier used to identify vendor | |
1075 | type and configuration.</para> | |
1076 | </listitem> | |
1077 | </varlistentry> | |
076ea6f6 | 1078 | |
e2e08e77 ZJS |
1079 | <varlistentry> |
1080 | <term><varname>DUIDType=</varname></term> | |
1081 | <listitem> | |
1082 | <para>Override the global <varname>DUIDType</varname> setting for this network. See | |
1083 | <citerefentry><refentrytitle>networkd.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry> | |
1084 | for a description of possible values.</para> | |
1085 | </listitem> | |
1086 | </varlistentry> | |
076ea6f6 | 1087 | |
e2e08e77 ZJS |
1088 | <varlistentry> |
1089 | <term><varname>DUIDRawData=</varname></term> | |
1090 | <listitem> | |
1091 | <para>Override the global <varname>DUIDRawData</varname> setting for this network. See | |
1092 | <citerefentry><refentrytitle>networkd.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry> | |
1093 | for a description of possible values.</para> | |
076ea6f6 LP |
1094 | </listitem> |
1095 | </varlistentry> | |
e2e08e77 | 1096 | |
d05def16 LP |
1097 | <varlistentry> |
1098 | <term><varname>IAID=</varname></term> | |
1099 | <listitem> | |
1100 | <para>The DHCP Identity Association Identifier (IAID) for the interface, a 32-bit unsigned integer.</para> | |
1101 | </listitem> | |
1102 | </varlistentry> | |
1103 | ||
798d3a52 ZJS |
1104 | <varlistentry> |
1105 | <term><varname>RequestBroadcast=</varname></term> | |
1106 | <listitem> | |
1107 | <para>Request the server to use broadcast messages before | |
1108 | the IP address has been configured. This is necessary for | |
1109 | devices that cannot receive RAW packets, or that cannot | |
1110 | receive packets at all before an IP address has been | |
1111 | configured. On the other hand, this must not be enabled on | |
1112 | networks where broadcasts are filtered out.</para> | |
1113 | </listitem> | |
1114 | </varlistentry> | |
e2e08e77 | 1115 | |
798d3a52 ZJS |
1116 | <varlistentry> |
1117 | <term><varname>RouteMetric=</varname></term> | |
1118 | <listitem> | |
1119 | <para>Set the routing metric for routes specified by the | |
1120 | DHCP server.</para> | |
1121 | </listitem> | |
1122 | </varlistentry> | |
f594276b JK |
1123 | |
1124 | <varlistentry> | |
1125 | <term><varname>RouteTable=<replaceable>num</replaceable></varname></term> | |
1126 | <listitem> | |
d11e656a | 1127 | <para>The table identifier for DHCP routes (a number between 1 and 4294967295, or 0 to unset). |
f594276b JK |
1128 | The table can be retrieved using <command>ip route show table <replaceable>num</replaceable></command>. |
1129 | </para> | |
1130 | </listitem> | |
1131 | </varlistentry> | |
9faed222 SS |
1132 | |
1133 | <varlistentry> | |
1134 | <term><varname>ListenPort=</varname></term> | |
1135 | <listitem> | |
1136 | <para>Allow setting custom port for the DHCP client to listen on.</para> | |
1137 | </listitem> | |
1138 | </varlistentry> | |
ad943783 | 1139 | </variablelist> |
076ea6f6 | 1140 | </refsect1> |
413708d1 | 1141 | |
1e7a0e21 | 1142 | <refsect1> |
f921f573 LP |
1143 | <title>[IPv6AcceptRA] Section Options</title> |
1144 | <para>The <literal>[IPv6AcceptRA]</literal> section configures the IPv6 Router Advertisement | |
1145 | (RA) client, if it is enabled with the <varname>IPv6AcceptRA=</varname> setting described | |
1e7a0e21 LP |
1146 | above:</para> |
1147 | ||
1148 | <variablelist class='network-directives'> | |
1149 | <varlistentry> | |
1150 | <term><varname>UseDNS=</varname></term> | |
1151 | <listitem> | |
1152 | <para>When true (the default), the DNS servers received in the Router Advertisement will be used and take | |
1153 | precedence over any statically configured ones.</para> | |
1154 | ||
1155 | <para>This corresponds to the <option>nameserver</option> option in <citerefentry | |
1156 | project='man-pages'><refentrytitle>resolv.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para> | |
1157 | </listitem> | |
1158 | </varlistentry> | |
1159 | ||
1160 | <varlistentry> | |
1161 | <term><varname>UseDomains=</varname></term> | |
1162 | <listitem> | |
1163 | <para>Takes a boolean argument, or the special value <literal>route</literal>. When true, the domain name | |
1164 | received via IPv6 Router Advertisement (RA) will be used as DNS search domain over this link, similar to | |
1165 | the effect of the <option>Domains=</option> setting. If set to <literal>route</literal>, the domain name | |
1166 | received via IPv6 RA will be used for routing DNS queries only, but not for searching, similar to the | |
1167 | effect of the <option>Domains=</option> setting when the argument is prefixed with | |
1168 | <literal>~</literal>. Defaults to false.</para> | |
1169 | ||
1170 | <para>It is recommended to enable this option only on trusted networks, as setting this affects resolution | |
1171 | of all host names, in particular of single-label names. It is generally safer to use the supplied domain | |
1172 | only as routing domain, rather than as search domain, in order to not have it affect local resolution of | |
1173 | single-label names.</para> | |
1174 | ||
1175 | <para>When set to true, this setting corresponds to the <option>domain</option> option in <citerefentry | |
1176 | project='man-pages'><refentrytitle>resolv.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para> | |
1177 | </listitem> | |
1178 | </varlistentry> | |
2ba31d29 JK |
1179 | |
1180 | <varlistentry> | |
1181 | <term><varname>RouteTable=<replaceable>num</replaceable></varname></term> | |
1182 | <listitem> | |
d11e656a ZJS |
1183 | <para>The table identifier for the routes received in the Router Advertisement |
1184 | (a number between 1 and 4294967295, or 0 to unset). | |
2ba31d29 JK |
1185 | The table can be retrieved using <command>ip route show table <replaceable>num</replaceable></command>. |
1186 | </para> | |
1187 | </listitem> | |
1188 | </varlistentry> | |
1e7a0e21 LP |
1189 | </variablelist> |
1190 | </refsect1> | |
1191 | ||
1192 | ||
ad943783 LP |
1193 | <refsect1> |
1194 | <title>[DHCPServer] Section Options</title> | |
1195 | <para>The <literal>[DHCPServer]</literal> section contains | |
1196 | settings for the DHCP server, if enabled via the | |
1197 | <varname>DHCPServer=</varname> option described above:</para> | |
1198 | ||
1199 | <variablelist class='network-directives'> | |
1200 | ||
9b3a67c5 TG |
1201 | <varlistentry> |
1202 | <term><varname>PoolOffset=</varname></term> | |
1203 | <term><varname>PoolSize=</varname></term> | |
1204 | ||
1205 | <listitem><para>Configures the pool of addresses to hand out. The pool | |
1206 | is a contiguous sequence of IP addresses in the subnet configured for | |
1207 | the server address, which does not include the subnet nor the broadcast | |
1208 | address. <varname>PoolOffset=</varname> takes the offset of the pool | |
1209 | from the start of subnet, or zero to use the default value. | |
1210 | <varname>PoolSize=</varname> takes the number of IP addresses in the | |
b938cb90 | 1211 | pool or zero to use the default value. By default, the pool starts at |
9b3a67c5 TG |
1212 | the first address after the subnet address and takes up the rest of |
1213 | the subnet, excluding the broadcast address. If the pool includes | |
1214 | the server address (the default), this is reserved and not handed | |
1215 | out to clients.</para></listitem> | |
1216 | </varlistentry> | |
1217 | ||
ad943783 LP |
1218 | <varlistentry> |
1219 | <term><varname>DefaultLeaseTimeSec=</varname></term> | |
1220 | <term><varname>MaxLeaseTimeSec=</varname></term> | |
1221 | ||
1222 | <listitem><para>Control the default and maximum DHCP lease | |
1223 | time to pass to clients. These settings take time values in seconds or | |
1224 | another common time unit, depending on the suffix. The default | |
1225 | lease time is used for clients that did not ask for a specific | |
1226 | lease time. If a client asks for a lease time longer than the | |
b938cb90 | 1227 | maximum lease time, it is automatically shortened to the |
ad943783 LP |
1228 | specified time. The default lease time defaults to 1h, the |
1229 | maximum lease time to 12h. Shorter lease times are beneficial | |
1230 | if the configuration data in DHCP leases changes frequently | |
1231 | and clients shall learn the new settings with shorter | |
1232 | latencies. Longer lease times reduce the generated DHCP | |
1233 | network traffic.</para></listitem> | |
1234 | </varlistentry> | |
1235 | ||
1236 | <varlistentry> | |
1237 | <term><varname>EmitDNS=</varname></term> | |
1238 | <term><varname>DNS=</varname></term> | |
1239 | ||
1240 | <listitem><para>Configures whether the DHCP leases handed out | |
1241 | to clients shall contain DNS server information. The | |
1242 | <varname>EmitDNS=</varname> setting takes a boolean argument | |
1243 | and defaults to <literal>yes</literal>. The DNS servers to | |
1244 | pass to clients may be configured with the | |
1245 | <varname>DNS=</varname> option, which takes a list of IPv4 | |
1246 | addresses. If the <varname>EmitDNS=</varname> option is | |
b938cb90 | 1247 | enabled but no servers configured, the servers are |
ad943783 LP |
1248 | automatically propagated from an "uplink" interface that has |
1249 | appropriate servers set. The "uplink" interface is determined | |
1250 | by the default route of the system with the highest | |
1251 | priority. Note that this information is acquired at the time | |
1252 | the lease is handed out, and does not take uplink interfaces | |
1253 | into account that acquire DNS or NTP server information at a | |
1254 | later point. DNS server propagation does not take | |
1255 | <filename>/etc/resolv.conf</filename> into account. Also, note | |
a8eaaee7 | 1256 | that the leases are not refreshed if the uplink network |
ad943783 | 1257 | configuration changes. To ensure clients regularly acquire the |
b938cb90 | 1258 | most current uplink DNS server information, it is thus |
ad943783 LP |
1259 | advisable to shorten the DHCP lease time via |
1260 | <varname>MaxLeaseTimeSec=</varname> described | |
1261 | above.</para></listitem> | |
1262 | </varlistentry> | |
1263 | ||
1264 | <varlistentry> | |
1265 | <term><varname>EmitNTP=</varname></term> | |
1266 | <term><varname>NTP=</varname></term> | |
1267 | ||
1268 | <listitem><para>Similar to the <varname>EmitDNS=</varname> and | |
b938cb90 | 1269 | <varname>DNS=</varname> settings described above, these |
ad943783 LP |
1270 | settings configure whether and what NTP server information |
1271 | shall be emitted as part of the DHCP lease. The same syntax, | |
1272 | propagation semantics and defaults apply as for | |
1273 | <varname>EmitDNS=</varname> and | |
1274 | <varname>DNS=</varname>.</para></listitem> | |
1275 | </varlistentry> | |
1276 | ||
77ff6022 CG |
1277 | <varlistentry> |
1278 | <term><varname>EmitRouter=</varname></term> | |
1279 | ||
1280 | <listitem><para>Similar to the <varname>EmitDNS=</varname> | |
1281 | setting described above, this setting configures whether the | |
1282 | DHCP lease should contain the router option. The same syntax, | |
1283 | propagation semantics and defaults apply as for | |
1284 | <varname>EmitDNS=</varname>.</para></listitem> | |
1285 | </varlistentry> | |
1286 | ||
ad943783 LP |
1287 | <varlistentry> |
1288 | <term><varname>EmitTimezone=</varname></term> | |
1289 | <term><varname>Timezone=</varname></term> | |
1290 | ||
1291 | <listitem><para>Configures whether the DHCP leases handed out | |
1292 | to clients shall contain timezone information. The | |
1293 | <varname>EmitTimezone=</varname> setting takes a boolean | |
1294 | argument and defaults to <literal>yes</literal>. The | |
1295 | <varname>Timezone=</varname> setting takes a timezone string | |
1296 | (such as <literal>Europe/Berlin</literal> or | |
1297 | <literal>UTC</literal>) to pass to clients. If no explicit | |
b938cb90 | 1298 | timezone is set, the system timezone of the local host is |
ad943783 LP |
1299 | propagated, as determined by the |
1300 | <filename>/etc/localtime</filename> symlink.</para></listitem> | |
1301 | </varlistentry> | |
1302 | ||
1303 | </variablelist> | |
1304 | </refsect1> | |
1305 | ||
798d3a52 ZJS |
1306 | <refsect1> |
1307 | <title>[Bridge] Section Options</title> | |
1308 | <para>The <literal>[Bridge]</literal> section accepts the | |
1309 | following keys.</para> | |
1310 | <variablelist class='network-directives'> | |
165c41a9 SS |
1311 | <varlistentry> |
1312 | <term><varname>UnicastFlood=</varname></term> | |
1313 | <listitem> | |
072f9e4a ZJS |
1314 | <para>A boolean. Controls whether the bridge should flood |
1315 | traffic for which an FDB entry is missing and the destination | |
1316 | is unknown through this port. Defaults to on. | |
47c7dfe2 | 1317 | </para> |
165c41a9 SS |
1318 | </listitem> |
1319 | </varlistentry> | |
1320 | <varlistentry> | |
1321 | <term><varname>HairPin=</varname></term> | |
1322 | <listitem> | |
47c7dfe2 ZJS |
1323 | <para>A boolean. Configures whether traffic may be sent back |
1324 | out of the port on which it was received. By default, this | |
1325 | flag is false, and the bridge will not forward traffic back | |
1326 | out of the receiving port.</para> | |
165c41a9 SS |
1327 | </listitem> |
1328 | </varlistentry> | |
1329 | <varlistentry> | |
84c34096 | 1330 | <term><varname>UseBPDU=</varname></term> |
165c41a9 | 1331 | <listitem> |
47c7dfe2 | 1332 | <para>A boolean. Configures whether STP Bridge Protocol Data Units will be |
84c34096 | 1333 | processed by the bridge port. Defaults to yes.</para> |
165c41a9 SS |
1334 | </listitem> |
1335 | </varlistentry> | |
1336 | <varlistentry> | |
1337 | <term><varname>FastLeave=</varname></term> | |
1338 | <listitem> | |
47c7dfe2 | 1339 | <para>A boolean. This flag allows the bridge to immediately stop multicast |
a8eaaee7 | 1340 | traffic on a port that receives an IGMP Leave message. It is only used with |
47c7dfe2 | 1341 | IGMP snooping if enabled on the bridge. Defaults to off.</para> |
165c41a9 SS |
1342 | </listitem> |
1343 | </varlistentry> | |
1344 | <varlistentry> | |
23da66bb | 1345 | <term><varname>AllowPortToBeRoot=</varname></term> |
165c41a9 | 1346 | <listitem> |
47c7dfe2 ZJS |
1347 | <para>A boolean. Configures whether a given port is allowed to |
1348 | become a root port. Only used when STP is enabled on the bridge. | |
23da66bb | 1349 | Defaults to on.</para> |
165c41a9 SS |
1350 | </listitem> |
1351 | </varlistentry> | |
798d3a52 ZJS |
1352 | <varlistentry> |
1353 | <term><varname>Cost=</varname></term> | |
1354 | <listitem> | |
47c7dfe2 | 1355 | <para>Sets the "cost" of sending packets of this interface. |
a8eaaee7 | 1356 | Each port in a bridge may have a different speed and the cost |
798d3a52 | 1357 | is used to decide which link to use. Faster interfaces |
785889e5 | 1358 | should have lower costs. It is an integer value between 1 and |
b56be296 DJL |
1359 | 65535.</para> |
1360 | </listitem> | |
1361 | </varlistentry> | |
1362 | <varlistentry> | |
1363 | <term><varname>Priority=</varname></term> | |
1364 | <listitem> | |
1365 | <para>Sets the "priority" of sending packets on this interface. | |
1366 | Each port in a bridge may have a different priority which is used | |
1367 | to decide which link to use. Lower value means higher priority. | |
785889e5 | 1368 | It is an integer value between 0 to 63. Networkd does not set any |
b56be296 | 1369 | default, meaning the kernel default value of 32 is used.</para> |
798d3a52 ZJS |
1370 | </listitem> |
1371 | </varlistentry> | |
1372 | </variablelist> | |
1373 | </refsect1> | |
798d3a52 ZJS |
1374 | <refsect1> |
1375 | <title>[BridgeFDB] Section Options</title> | |
1376 | <para>The <literal>[BridgeFDB]</literal> section manages the | |
1377 | forwarding database table of a port and accepts the following | |
1378 | keys. Specify several <literal>[BridgeFDB]</literal> sections to | |
1379 | configure several static MAC table entries.</para> | |
1380 | ||
1381 | <variablelist class='network-directives'> | |
1382 | <varlistentry> | |
1383 | <term><varname>MACAddress=</varname></term> | |
1384 | <listitem> | |
1385 | <para>As in the <literal>[Network]</literal> section. This | |
1386 | key is mandatory.</para> | |
1387 | </listitem> | |
1388 | </varlistentry> | |
1389 | <varlistentry> | |
1390 | <term><varname>VLANId=</varname></term> | |
1391 | <listitem> | |
a8eaaee7 JE |
1392 | <para>The VLAN ID for the new static MAC table entry. If |
1393 | omitted, no VLAN ID info is appended to the new static MAC | |
798d3a52 ZJS |
1394 | table entry.</para> |
1395 | </listitem> | |
1396 | </varlistentry> | |
1397 | </variablelist> | |
1398 | </refsect1> | |
13b498f9 TJ |
1399 | <refsect1> |
1400 | <title>[BridgeVLAN] Section Options</title> | |
1401 | <para>The <literal>[BridgeVLAN]</literal> section manages the VLAN ID configuration of a bridge port and accepts | |
1402 | the following keys. Specify several <literal>[BridgeVLAN]</literal> sections to configure several VLAN entries. | |
1403 | The <varname>VLANFiltering=</varname> option has to be enabled, see <literal>[Bridge]</literal> section in | |
1404 | <citerefentry><refentrytitle>systemd.netdev</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para> | |
1405 | ||
1406 | <variablelist class='network-directives'> | |
1407 | <varlistentry> | |
1408 | <term><varname>VLAN=</varname></term> | |
1409 | <listitem> | |
1410 | <para>The VLAN ID allowed on the port. This can be either a single ID or a range M-N. VLAN IDs are valid | |
1411 | from 1 to 4094.</para> | |
1412 | </listitem> | |
1413 | </varlistentry> | |
1414 | <varlistentry> | |
1415 | <term><varname>EgressUntagged=</varname></term> | |
1416 | <listitem> | |
1417 | <para>The VLAN ID specified here will be used to untag frames on egress. Configuring | |
1418 | <varname>EgressUntagged=</varname> implicates the use of <varname>VLAN=</varname> above and will enable the | |
1419 | VLAN ID for ingress as well. This can be either a single ID or a range M-N.</para> | |
1420 | </listitem> | |
1421 | </varlistentry> | |
1422 | <varlistentry> | |
1423 | <term><varname>PVID=</varname></term> | |
1424 | <listitem> | |
1425 | <para>The Port VLAN ID specified here is assigned to all untagged frames at ingress. | |
1426 | <varname>PVID=</varname> can be used only once. Configuring <varname>PVID=</varname> implicates the use of | |
1427 | <varname>VLAN=</varname> above and will enable the VLAN ID for ingress as well.</para> | |
1428 | </listitem> | |
1429 | </varlistentry> | |
1430 | </variablelist> | |
1431 | </refsect1> | |
798d3a52 ZJS |
1432 | |
1433 | <refsect1> | |
9e35b3de | 1434 | <title>Examples</title> |
798d3a52 | 1435 | <example> |
9e35b3de | 1436 | <title>Static network configuration</title> |
798d3a52 | 1437 | |
9e35b3de ZJS |
1438 | <programlisting># /etc/systemd/network/50-static.network |
1439 | [Match] | |
eac684ef TG |
1440 | Name=enp2s0 |
1441 | ||
1442 | [Network] | |
1443 | Address=192.168.0.15/24 | |
1444 | Gateway=192.168.0.1</programlisting> | |
9e35b3de ZJS |
1445 | |
1446 | <para>This brings interface <literal>enp2s0</literal> up with a static address. The | |
1447 | specified gateway will be used for a default route.</para> | |
798d3a52 | 1448 | </example> |
eac684ef | 1449 | |
798d3a52 | 1450 | <example> |
9e35b3de | 1451 | <title>DHCP on ethernet links</title> |
eac684ef | 1452 | |
9e35b3de ZJS |
1453 | <programlisting># /etc/systemd/network/80-dhcp.network |
1454 | [Match] | |
eac684ef TG |
1455 | Name=en* |
1456 | ||
1457 | [Network] | |
9c8ca3f7 | 1458 | DHCP=yes</programlisting> |
9e35b3de ZJS |
1459 | |
1460 | <para>This will enable DHCPv4 and DHCPv6 on all interfaces with names starting with | |
1461 | <literal>en</literal> (i.e. ethernet interfaces).</para> | |
798d3a52 | 1462 | </example> |
eac684ef | 1463 | |
798d3a52 | 1464 | <example> |
9e35b3de | 1465 | <title>A bridge with two enslaved links</title> |
f47c5c47 | 1466 | |
9e35b3de ZJS |
1467 | <programlisting># /etc/systemd/network/25-bridge-static.network |
1468 | [Match] | |
f47c5c47 | 1469 | Name=bridge0 |
1470 | ||
1471 | [Network] | |
1472 | Address=192.168.0.15/24 | |
1473 | Gateway=192.168.0.1 | |
1474 | DNS=192.168.0.1</programlisting> | |
f47c5c47 | 1475 | |
9e35b3de ZJS |
1476 | <programlisting># /etc/systemd/network/25-bridge-slave-interface-1.network |
1477 | [Match] | |
f47c5c47 | 1478 | Name=enp2s0 |
1479 | ||
1480 | [Network] | |
1481 | Bridge=bridge0</programlisting> | |
9e35b3de ZJS |
1482 | |
1483 | <programlisting># /etc/systemd/network/25-bridge-slave-interface-2.network | |
1484 | [Match] | |
1485 | Name=wlp3s0 | |
1486 | ||
1487 | [Network] | |
1488 | Bridge=bridge0</programlisting> | |
1489 | ||
1490 | <para>This creates a bridge and attaches devices <literal>enp2s0</literal> and | |
1491 | <literal>wlp3s0</literal> to it. The bridge will have the specified static address | |
1492 | and network assigned, and a default route via the specified gateway will be | |
1493 | added. The specified DNS server will be added to the global list of DNS resolvers. | |
1494 | </para> | |
13b498f9 | 1495 | </example> |
9e35b3de | 1496 | |
13b498f9 | 1497 | <example> |
9e35b3de | 1498 | <title></title> |
13b498f9 | 1499 | |
9e35b3de ZJS |
1500 | <programlisting> |
1501 | # /etc/systemd/network/20-bridge-slave-interface-vlan.network | |
1502 | [Match] | |
13b498f9 TJ |
1503 | Name=enp2s0 |
1504 | ||
1505 | [Network] | |
1506 | Bridge=bridge0 | |
1507 | ||
1508 | [BridgeVLAN] | |
1509 | VLAN=1-32 | |
1510 | PVID=42 | |
1511 | EgressUntagged=42 | |
1512 | ||
1513 | [BridgeVLAN] | |
1514 | VLAN=100-200 | |
1515 | ||
1516 | [BridgeVLAN] | |
1517 | EgressUntagged=300-400</programlisting> | |
0a8a0fad | 1518 | |
9e35b3de ZJS |
1519 | <para>This overrides the configuration specified in the previous example for the |
1520 | interface <literal>enp2s0</literal>, and enables VLAN on that bridge port. VLAN IDs | |
1521 | 1-32, 42, 100-400 will be allowed. Packets tagged with VLAN IDs 42, 300-400 will be | |
1522 | untagged when they leave on this interface. Untagged packets which arrive on this | |
1523 | interface will be assigned VLAN ID 42.</para> | |
798d3a52 | 1524 | </example> |
0a8a0fad | 1525 | |
798d3a52 | 1526 | <example> |
9e35b3de | 1527 | <title>Various tunnels</title> |
0a8a0fad | 1528 | |
9e35b3de ZJS |
1529 | <programlisting>/etc/systemd/network/25-tunnels.network |
1530 | [Match] | |
1531 | Name=ens1 | |
0a8a0fad TG |
1532 | |
1533 | [Network] | |
9e35b3de ZJS |
1534 | Tunnel=ipip-tun |
1535 | Tunnel=sit-tun | |
1536 | Tunnel=gre-tun | |
1537 | Tunnel=vti-tun | |
1538 | </programlisting> | |
1539 | ||
1540 | <programlisting>/etc/systemd/network/25-tunnel-ipip.netdev | |
1541 | [NetDev] | |
1542 | Name=ipip-tun | |
1543 | Kind=ipip | |
1544 | </programlisting> | |
1545 | ||
1546 | <programlisting>/etc/systemd/network/25-tunnel-sit.netdev | |
1547 | [NetDev] | |
1548 | Name=sit-tun | |
1549 | Kind=sit | |
1550 | </programlisting> | |
1551 | ||
1552 | <programlisting>/etc/systemd/network/25-tunnel-gre.netdev | |
1553 | [NetDev] | |
1554 | Name=gre-tun | |
1555 | Kind=gre | |
1556 | </programlisting> | |
1557 | ||
1558 | <programlisting>/etc/systemd/network/25-tunnel-vti.netdev | |
1559 | [NetDev] | |
1560 | Name=vti-tun | |
1561 | Kind=vti | |
1562 | </programlisting> | |
1563 | ||
1564 | <para>This will bring interface <literal>ens1</literal> up and create an IPIP tunnel, | |
1565 | a SIT tunnel, a GRE tunnel, and a VTI tunnel using it.</para> | |
798d3a52 | 1566 | </example> |
0a8a0fad | 1567 | |
798d3a52 | 1568 | <example> |
9e35b3de | 1569 | <title>A bond device</title> |
0a8a0fad | 1570 | |
9e35b3de ZJS |
1571 | <programlisting># /etc/systemd/network/30-bond1.network |
1572 | [Match] | |
1573 | Name=bond1 | |
0a8a0fad TG |
1574 | |
1575 | [Network] | |
9e35b3de ZJS |
1576 | DHCP=ipv6 |
1577 | </programlisting> | |
0a8a0fad | 1578 | |
9e35b3de ZJS |
1579 | <programlisting># /etc/systemd/network/30-bond1.netdev |
1580 | [NetDev] | |
1581 | Name=bond1 | |
1582 | Kind=bond | |
1583 | </programlisting> | |
0a8a0fad | 1584 | |
301a21a8 | 1585 | <programlisting># /etc/systemd/network/30-bond1-dev1.network |
9e35b3de ZJS |
1586 | [Match] |
1587 | MACAddress=52:54:00:e9:64:41 | |
0a8a0fad TG |
1588 | |
1589 | [Network] | |
9e35b3de ZJS |
1590 | Bond=bond1 |
1591 | </programlisting> | |
d94facdc | 1592 | |
301a21a8 | 1593 | <programlisting># /etc/systemd/network/30-bond1-dev2.network |
9e35b3de ZJS |
1594 | [Match] |
1595 | MACAddress=52:54:00:e9:64:42 | |
d94facdc MH |
1596 | |
1597 | [Network] | |
9e35b3de | 1598 | Bond=bond1 |
6cb955c6 | 1599 | </programlisting> |
9e35b3de ZJS |
1600 | |
1601 | <para>This will create a bond device <literal>bond1</literal> and enslave the two | |
1602 | devices with MAC addresses 52:54:00:e9:64:41 and 52:54:00:e9:64:42 to it. IPv6 DHCP | |
1603 | will be used to acquire an address.</para> | |
6cb955c6 AR |
1604 | </example> |
1605 | ||
1606 | <example> | |
9e35b3de ZJS |
1607 | <title>Virtual Routing and Forwarding (VRF)</title> |
1608 | <para>Add the <literal>bond1</literal> interface to the VRF master interface | |
1609 | <literal>vrf1</literal>. This will redirect routes generated on this interface to be | |
1610 | within the routing table defined during VRF creation. Traffic won't be redirected | |
1611 | towards the VRFs routing table unless specific ip-rules are added.</para> | |
1612 | <programlisting># /etc/systemd/network/25-vrf.network | |
1613 | [Match] | |
6cb955c6 AR |
1614 | Name=bond1 |
1615 | ||
1616 | [Network] | |
9e35b3de | 1617 | VRF=vrf1 |
d94facdc MH |
1618 | </programlisting> |
1619 | </example> | |
1620 | ||
42125eda SS |
1621 | <example> |
1622 | <title>MacVTap</title> | |
1623 | <para>This brings up a network interface <literal>macvtap-test</literal> | |
1624 | and attaches it to <literal>enp0s25</literal>.</para> | |
83ddf5d3 | 1625 | <programlisting># /usr/lib/systemd/network/25-macvtap.network |
42125eda SS |
1626 | [Match] |
1627 | Name=enp0s25 | |
1628 | ||
1629 | [Network] | |
1630 | MACVTAP=macvtap-test | |
1631 | </programlisting> | |
1632 | </example> | |
798d3a52 ZJS |
1633 | </refsect1> |
1634 | ||
1635 | <refsect1> | |
1636 | <title>See Also</title> | |
1637 | <para> | |
1638 | <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, | |
f41b446a | 1639 | <citerefentry><refentrytitle>systemd-networkd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>, |
798d3a52 | 1640 | <citerefentry><refentrytitle>systemd.link</refentrytitle><manvolnum>5</manvolnum></citerefentry>, |
aaa297d4 LP |
1641 | <citerefentry><refentrytitle>systemd.netdev</refentrytitle><manvolnum>5</manvolnum></citerefentry>, |
1642 | <citerefentry><refentrytitle>systemd-resolved.service</refentrytitle><manvolnum>8</manvolnum></citerefentry> | |
798d3a52 ZJS |
1643 | </para> |
1644 | </refsect1> | |
eac684ef TG |
1645 | |
1646 | </refentry> |