]> git.ipfire.org Git - thirdparty/systemd.git/blame - man/systemd.network.xml
docs: add .link/.network/.netdev files to interface stability chart
[thirdparty/systemd.git] / man / systemd.network.xml
CommitLineData
514094f9 1<?xml version='1.0'?>
3a54a157 2<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
12b42c76 3 "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
0307f791 4<!-- SPDX-License-Identifier: LGPL-2.1+ -->
eac684ef 5
d9b20454
ZJS
6<refentry id="systemd.network" conditional='ENABLE_NETWORKD'
7 xmlns:xi="http://www.w3.org/2001/XInclude">
eac684ef 8
798d3a52
ZJS
9 <refentryinfo>
10 <title>systemd.network</title>
11 <productname>systemd</productname>
798d3a52
ZJS
12 </refentryinfo>
13
14 <refmeta>
15 <refentrytitle>systemd.network</refentrytitle>
16 <manvolnum>5</manvolnum>
17 </refmeta>
18
19 <refnamediv>
20 <refname>systemd.network</refname>
21 <refpurpose>Network configuration</refpurpose>
22 </refnamediv>
23
24 <refsynopsisdiv>
25 <para><filename><replaceable>network</replaceable>.network</filename></para>
26 </refsynopsisdiv>
27
28 <refsect1>
29 <title>Description</title>
30
31 <para>Network setup is performed by
32 <citerefentry><refentrytitle>systemd-networkd</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
33 </para>
34
bac150e9
ZJS
35 <para>The main network file must have the extension <filename>.network</filename>; other
36 extensions are ignored. Networks are applied to links whenever the links appear.</para>
37
dc0d4078
ZJS
38 <para>The <filename>.network</filename> files are read from the files located in the system network
39 directories <filename>/usr/lib/systemd/network</filename> and
40 <filename>/usr/local/lib/systemd/network</filename>, the volatile runtime network directory
41 <filename>/run/systemd/network</filename> and the local administration network directory
42 <filename>/etc/systemd/network</filename>. All configuration files are collectively sorted and processed
43 in lexical order, regardless of the directories in which they live. However, files with identical
44 filenames replace each other. Files in <filename>/etc</filename> have the highest priority, files in
45 <filename>/run</filename> take precedence over files with the same name under
46 <filename>/usr</filename>. This can be used to override a system-supplied configuration file with a local
47 file if needed. As a special case, an empty file (file size 0) or symlink with the same name pointing to
48 <filename>/dev/null</filename> disables the configuration file entirely (it is "masked").</para>
bac150e9
ZJS
49
50 <para>Along with the network file <filename>foo.network</filename>, a "drop-in" directory
51 <filename>foo.network.d/</filename> may exist. All files with the suffix
52 <literal>.conf</literal> from this directory will be parsed after the file itself is
53 parsed. This is useful to alter or add configuration settings, without having to modify the main
54 configuration file. Each drop-in file must have appropriate section headers.</para>
55
56 <para>In addition to <filename>/etc/systemd/network</filename>, drop-in <literal>.d</literal>
57 directories can be placed in <filename>/usr/lib/systemd/network</filename> or
58 <filename>/run/systemd/network</filename> directories. Drop-in files in
59 <filename>/etc</filename> take precedence over those in <filename>/run</filename> which in turn
60 take precedence over those in <filename>/usr/lib</filename>. Drop-in files under any of these
b1e91af8 61 directories take precedence over the main network file wherever located.</para>
bac150e9
ZJS
62
63 <para>Note that an interface without any static IPv6 addresses configured, and neither DHCPv6
64 nor IPv6LL enabled, shall be considered to have no IPv6 support. IPv6 will be automatically
65 disabled for that interface by writing "1" to
66 <filename>/proc/sys/net/ipv6/conf/<replaceable>ifname</replaceable>/disable_ipv6</filename>.
82ecb4c3 67 </para>
798d3a52
ZJS
68 </refsect1>
69
70 <refsect1>
71 <title>[Match] Section Options</title>
72
73 <para>The network file contains a <literal>[Match]</literal>
74 section, which determines if a given network file may be applied
75 to a given device; and a <literal>[Network]</literal> section
76 specifying how the device should be configured. The first (in
77 lexical order) of the network files that matches a given device
a22e1850
LP
78 is applied, all later files are ignored, even if they match as
79 well.</para>
798d3a52 80
84ea567e
YW
81 <para>A network file is said to match a network interface if all matches specified by the
82 <literal>[Match]</literal> section are satisfied. When a network file does not contain valid
83 settings in <literal>[Match]</literal> section, then the file will match all interfaces and
84 <command>systemd-networkd</command> warns about that. Hint: to avoid the warning and to make it
85 clear that all interfaces shall be matched, add the following:
86 <programlisting>Name=*</programlisting>
87 The following keys are accepted:</para>
798d3a52
ZJS
88
89 <variablelist class='network-directives'>
d9b20454
ZJS
90 <xi:include href="systemd.link.xml" xpointer="mac-address" />
91 <xi:include href="systemd.link.xml" xpointer="permanent-mac-address" />
92 <xi:include href="systemd.link.xml" xpointer="path" />
93 <xi:include href="systemd.link.xml" xpointer="driver" />
94 <xi:include href="systemd.link.xml" xpointer="type" />
95 <xi:include href="systemd.link.xml" xpointer="property" />
9310bf4b 96
798d3a52
ZJS
97 <varlistentry>
98 <term><varname>Name=</varname></term>
99 <listitem>
572b21d9
YW
100 <para>A whitespace-separated list of shell-style globs matching the device name, as exposed
101 by the udev property <literal>INTERFACE</literal>, or device's alternative names. If the
102 list is prefixed with a "!", the test is inverted.</para>
798d3a52
ZJS
103 </listitem>
104 </varlistentry>
44005bfb 105
78404d22 106 <varlistentry>
1bcefad9 107 <term><varname>WLANInterfaceType=</varname></term>
78404d22
YW
108 <listitem>
109 <para>A whitespace-separated list of wireless network type. Supported values are
110 <literal>ad-hoc</literal>, <literal>station</literal>, <literal>ap</literal>,
111 <literal>ap-vlan</literal>, <literal>wds</literal>, <literal>monitor</literal>,
112 <literal>mesh-point</literal>, <literal>p2p-client</literal>, <literal>p2p-go</literal>,
113 <literal>p2p-device</literal>, <literal>ocb</literal>, and <literal>nan</literal>. If the
114 list is prefixed with a "!", the test is inverted.
115 </para>
116 </listitem>
117 </varlistentry>
d9b20454 118
8d968fdd
YW
119 <varlistentry>
120 <term><varname>SSID=</varname></term>
121 <listitem>
122 <para>A whitespace-separated list of shell-style globs matching the SSID of the currently
123 connected wireless LAN. If the list is prefixed with a "!", the test is inverted.
124 </para>
125 </listitem>
126 </varlistentry>
d9b20454 127
277ba8d1
YW
128 <varlistentry>
129 <term><varname>BSSID=</varname></term>
130 <listitem>
131 <para>A whitespace-separated list of hardware address of the currently connected wireless
132 LAN. Use full colon-, hyphen- or dot-delimited hexadecimal. See the example in
133 <varname>MACAddress=</varname>. This option may appear more than one, in which case the
134 lists are merged. If the empty string is assigned to this option, the list of BSSID defined
135 prior to this is reset.</para>
136 </listitem>
137 </varlistentry>
d9b20454
ZJS
138
139 <xi:include href="systemd.link.xml" xpointer="host" />
140 <xi:include href="systemd.link.xml" xpointer="virtualization" />
141 <xi:include href="systemd.link.xml" xpointer="kernel-command-line" />
142 <xi:include href="systemd.link.xml" xpointer="kernel-version" />
143 <xi:include href="systemd.link.xml" xpointer="architecture" />
798d3a52
ZJS
144 </variablelist>
145
146 </refsect1>
147
148 <refsect1>
149 <title>[Link] Section Options</title>
150
151 <para> The <literal>[Link]</literal> section accepts the following keys:</para>
152
153 <variablelist class='network-directives'>
154 <varlistentry>
155 <term><varname>MACAddress=</varname></term>
156 <listitem>
de25aae1 157 <para>The hardware address to set for the device.</para>
798d3a52
ZJS
158 </listitem>
159 </varlistentry>
160 <varlistentry>
161 <term><varname>MTUBytes=</varname></term>
162 <listitem>
163 <para>The maximum transmission unit in bytes to set for the
164 device. The usual suffixes K, M, G, are supported and are
165 understood to the base of 1024.</para>
439689c6
SS
166 <para>Note that if IPv6 is enabled on the interface, and the MTU is chosen
167 below 1280 (the minimum MTU for IPv6) it will automatically be increased to this value.</para>
798d3a52
ZJS
168 </listitem>
169 </varlistentry>
99d2baa2
SS
170 <varlistentry>
171 <term><varname>ARP=</varname></term>
172 <listitem>
9b6ffef3
YW
173 <para>Takes a boolean. If set to true, the ARP (low-level Address Resolution Protocol)
174 for this interface is enabled. When unset, the kernel's default will be used.</para>
99d2baa2
SS
175 <para> For example, disabling ARP is useful when creating multiple MACVLAN or VLAN virtual
176 interfaces atop a single lower-level physical interface, which will then only serve as a
177 link/"bridge" device aggregating traffic to the same physical link and not participate in
178 the network otherwise.</para>
179 </listitem>
180 </varlistentry>
e6ebebbe
SS
181 <varlistentry>
182 <term><varname>Multicast=</varname></term>
183 <listitem>
9b6ffef3 184 <para>Takes a boolean. If set to true, the multicast flag on the device is enabled.</para>
866e6b7a
SS
185 </listitem>
186 </varlistentry>
187 <varlistentry>
188 <term><varname>AllMulticast=</varname></term>
189 <listitem>
9b6ffef3 190 <para>Takes a boolean. If set to true, the driver retrieves all multicast packets from the network.
866e6b7a 191 This happens when multicast routing is enabled.</para>
e6ebebbe
SS
192 </listitem>
193 </varlistentry>
a09dc546
DM
194 <varlistentry>
195 <term><varname>Unmanaged=</varname></term>
196 <listitem>
9b6ffef3 197 <para>Takes a boolean. When <literal>yes</literal>, no attempts are
a09dc546
DM
198 made to bring up or configure matching links, equivalent to
199 when there are no matching network files. Defaults to
200 <literal>no</literal>.</para>
201 <para>This is useful for preventing later matching network
202 files from interfering with certain interfaces that are fully
203 controlled by other applications.</para>
204 </listitem>
205 </varlistentry>
c1a38904
MTL
206 <varlistentry>
207 <term><varname>RequiredForOnline=</varname></term>
208 <listitem>
75cd4a5d
DDM
209 <para>Takes a boolean or a minimum operational state and an optional maximum operational state.
210 Please see <citerefentry><refentrytitle>networkctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>
8d6082e4
YW
211 for possible operational states. When <literal>yes</literal>, the network is deemed required when
212 determining whether the system is online when running
213 <command>systemd-networkd-wait-online</command>. When <literal>no</literal>, the network is ignored
75cd4a5d
DDM
214 when checking for online state. When a minimum operational state and an optional maximum operational
215 state are set, <literal>yes</literal> is implied, and this controls the minimum and maximum
216 operational state required for the network interface to be considered online.
8d6082e4
YW
217 Defaults to <literal>yes</literal>.</para>
218
c1a38904
MTL
219 <para>The network will be brought up normally in all cases, but in
220 the event that there is no address being assigned by DHCP or the
221 cable is not plugged in, the link will simply remain offline and be
8d6082e4 222 skipped automatically by <command>systemd-networkd-wait-online</command>
ca92fe36 223 if <literal>RequiredForOnline=no</literal>.</para>
c1a38904
MTL
224 </listitem>
225 </varlistentry>
798d3a52
ZJS
226 </variablelist>
227 </refsect1>
228
229 <refsect1>
230 <title>[Network] Section Options</title>
231
232 <para>The <literal>[Network]</literal> section accepts the following keys:</para>
233
234 <variablelist class='network-directives'>
235 <varlistentry>
236 <term><varname>Description=</varname></term>
237 <listitem>
238 <para>A description of the device. This is only used for
239 presentation purposes.</para>
240 </listitem>
241 </varlistentry>
242 <varlistentry>
243 <term><varname>DHCP=</varname></term>
244 <listitem>
ad943783 245 <para>Enables DHCPv4 and/or DHCPv6 client support. Accepts
798d3a52 246 <literal>yes</literal>, <literal>no</literal>,
c702bd3b
LY
247 <literal>ipv4</literal>, or <literal>ipv6</literal>. Defaults
248 to <literal>no</literal>.</para>
e88d8021 249
f5a8c43f 250 <para>Note that DHCPv6 will by default be triggered by Router
7f3fdb7f 251 Advertisement, if that is enabled, regardless of this parameter.
f5a8c43f
TG
252 By enabling DHCPv6 support explicitly, the DHCPv6 client will
253 be started regardless of the presence of routers on the link,
254 or what flags the routers pass. See
f921f573 255 <literal>IPv6AcceptRA=</literal>.</para>
f5a8c43f
TG
256
257 <para>Furthermore, note that by default the domain name
e88d8021
ZJS
258 specified through DHCP is not used for name resolution.
259 See option <option>UseDomains=</option> below.</para>
2ef322fc 260
4f7331a8
YW
261 <para>See the <literal>[DHCPv4]</literal> or <literal>[DHCPv6]</literal> section below for
262 further configuration options for the DHCP client support.</para>
798d3a52
ZJS
263 </listitem>
264 </varlistentry>
265 <varlistentry>
266 <term><varname>DHCPServer=</varname></term>
267 <listitem>
68b7f7ac 268 <para>Takes a boolean. If set to <literal>yes</literal>, DHCPv4 server will be started. Defaults
ad943783
LP
269 to <literal>no</literal>. Further settings for the DHCP
270 server may be set in the <literal>[DHCPServer]</literal>
271 section described below.</para>
798d3a52
ZJS
272 </listitem>
273 </varlistentry>
274 <varlistentry>
56fd6bf7 275 <term><varname>LinkLocalAddressing=</varname></term>
798d3a52 276 <listitem>
85fc09c9 277 <para>Enables link-local address autoconfiguration. Accepts <literal>yes</literal>,
8bc17bb3
SS
278 <literal>no</literal>, <literal>ipv4</literal>, <literal>ipv6</literal>,
279 <literal>fallback</literal>, or <literal>ipv4-fallback</literal>. If
280 <literal>fallback</literal> or <literal>ipv4-fallback</literal> is specified, then an IPv4
281 link-local address is configured only when DHCPv4 fails. If <literal>fallback</literal>,
282 an IPv6 link-local address is always configured, and if <literal>ipv4-fallback</literal>,
283 the address is not configured. Note that, the fallback mechanism works only when DHCPv4
284 client is enabled, that is, it requires <literal>DHCP=yes</literal> or
285 <literal>DHCP=ipv4</literal>. If <varname>Bridge=</varname> is set, defaults to
286 <literal>no</literal>, and if not, defaults to <literal>ipv6</literal>.
287 </para>
798d3a52
ZJS
288 </listitem>
289 </varlistentry>
290 <varlistentry>
291 <term><varname>IPv4LLRoute=</varname></term>
292 <listitem>
9b6ffef3 293 <para>Takes a boolean. If set to true, sets up the route needed for
798d3a52
ZJS
294 non-IPv4LL hosts to communicate with IPv4LL-only hosts. Defaults
295 to false.
296 </para>
297 </listitem>
298 </varlistentry>
5d5003ab
YW
299 <varlistentry>
300 <term><varname>DefaultRouteOnDevice=</varname></term>
301 <listitem>
302 <para>Takes a boolean. If set to true, sets up the default route bound to the interface.
303 Defaults to false. This is useful when creating routes on point-to-point interfaces.
304 This is equivalent to e.g. the following.
305 <programlisting>ip route add default dev veth99</programlisting></para>
306 </listitem>
307 </varlistentry>
798d3a52 308 <varlistentry>
113bfde1
TG
309 <term><varname>IPv6Token=</varname></term>
310 <listitem>
8dcce054
KF
311 <para>Specifies an optional address generation mode and a required IPv6 address. If
312 the mode is present, the two parts must be separated with a colon
313 <literal><replaceable>mode</replaceable>:<replaceable>address</replaceable></literal>. The
314 address generation mode may be either <constant>prefixstable</constant> or
315 <constant>static</constant>. If not specified, <constant>static</constant> is assumed.
316 </para>
317 <para>When the mode is set to <constant>static</constant>, or unspecified, the lower bits of
318 the supplied address are combined with the upper bits of a prefix received in a Router Advertisement
319 message to form a complete address. Note that if multiple prefixes are received in an RA message, or in
320 multiple RA messages, addresses will be formed from each of them using the supplied address. This
321 mode implements SLAAC but uses a static interface identifier instead of an identifier generated
322 using the EUI-64 algorithm. Because the interface identifier is static, if Duplicate Address Detection
323 detects that the computed address is a duplicate (in use by another node on the link), then this
324 mode will fail to provide an address for that prefix.
8dcce054
KF
325 </para>
326 <para>When the mode is set to <literal>prefixstable</literal> the RFC 7217 algorithm for generating
327 interface identifiers will be used, but only when a prefix received in an RA message matches the supplied address.
328 See <ulink url="https://tools.ietf.org/html/rfc7217">RFC 7217</ulink>. Prefix matching will be attempted
329 against each <constant>prefixstable</constant> IPv6Token variable provided in the configuration; if a received
330 prefix does not match any of the provided addresses, then the EUI-64 algorithm will be used to form
331 an interface identifier for that prefix. This mode is also SLAAC, but with a potentially stable interface
332 identifier which does not directly map to the interface's hardware address.
333
334 Note that the <constant>prefixstable</constant> algorithm includes both the interface's name and
335 MAC address in the hash used to compute the interface identifier, so if either of those are changed the resulting
336 interface identifier (and address) will change, even if the prefix received in the RA message has not changed.
337
338 Note that if multiple <constant>prefixstable</constant> IPv6Token variables are supplied with addresses that
339 match a prefix received in an RA message, only the first one will be used to generate addresses.
5f506a55 340 </para>
113bfde1
TG
341 </listitem>
342 </varlistentry>
343 <varlistentry>
798d3a52
ZJS
344 <term><varname>LLMNR=</varname></term>
345 <listitem>
9b6ffef3 346 <para>Takes a boolean or <literal>resolve</literal>. When true,
aaa297d4
LP
347 enables <ulink
348 url="https://tools.ietf.org/html/rfc4795">Link-Local
349 Multicast Name Resolution</ulink> on the link. When set to
350 <literal>resolve</literal>, only resolution is enabled,
351 but not host registration and announcement. Defaults to
352 true. This setting is read by
353 <citerefentry><refentrytitle>systemd-resolved.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
354 </listitem>
355 </varlistentry>
356 <varlistentry>
357 <term><varname>MulticastDNS=</varname></term>
358 <listitem>
9b6ffef3 359 <para>Takes a boolean or <literal>resolve</literal>. When true,
aaa297d4
LP
360 enables <ulink
361 url="https://tools.ietf.org/html/rfc6762">Multicast
362 DNS</ulink> support on the link. When set to
363 <literal>resolve</literal>, only resolution is enabled,
364 but not host or service registration and
365 announcement. Defaults to false. This setting is read by
366 <citerefentry><refentrytitle>systemd-resolved.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
798d3a52
ZJS
367 </listitem>
368 </varlistentry>
30e59c84 369 <varlistentry>
c9299be2 370 <term><varname>DNSOverTLS=</varname></term>
30e59c84 371 <listitem>
4310bfc2
IT
372 <para>Takes a boolean or <literal>opportunistic</literal>.
373 When true, enables
30e59c84
IT
374 <ulink
375 url="https://tools.ietf.org/html/rfc7858">DNS-over-TLS</ulink>
4310bfc2
IT
376 support on the link.
377 When set to <literal>opportunistic</literal>, compatibility with
378 non-DNS-over-TLS servers is increased, by automatically
379 turning off DNS-over-TLS servers in this case.
380 This option defines a per-interface setting for
30e59c84 381 <citerefentry><refentrytitle>resolved.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>'s
c9299be2 382 global <varname>DNSOverTLS=</varname> option. Defaults to
30e59c84
IT
383 false. This setting is read by
384 <citerefentry><refentrytitle>systemd-resolved.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
385 </listitem>
386 </varlistentry>
ad6c0475
LP
387 <varlistentry>
388 <term><varname>DNSSEC=</varname></term>
389 <listitem>
9b6ffef3 390 <para>Takes a boolean. or
ad6c0475
LP
391 <literal>allow-downgrade</literal>. When true, enables
392 <ulink
393 url="https://tools.ietf.org/html/rfc4033">DNSSEC</ulink>
394 DNS validation support on the link. When set to
395 <literal>allow-downgrade</literal>, compatibility with
396 non-DNSSEC capable networks is increased, by automatically
785889e5 397 turning off DNSSEC in this case. This option defines a
ad6c0475
LP
398 per-interface setting for
399 <citerefentry><refentrytitle>resolved.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>'s
400 global <varname>DNSSEC=</varname> option. Defaults to
401 false. This setting is read by
402 <citerefentry><refentrytitle>systemd-resolved.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
403 </listitem>
404 </varlistentry>
8a516214
LP
405 <varlistentry>
406 <term><varname>DNSSECNegativeTrustAnchors=</varname></term>
407 <listitem><para>A space-separated list of DNSSEC negative
408 trust anchor domains. If specified and DNSSEC is enabled,
409 look-ups done via the interface's DNS server will be subject
410 to the list of negative trust anchors, and not require
411 authentication for the specified domains, or anything below
412 it. Use this to disable DNSSEC authentication for specific
413 private domains, that cannot be proven valid using the
414 Internet DNS hierarchy. Defaults to the empty list. This
415 setting is read by
416 <citerefentry><refentrytitle>systemd-resolved.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
417 </listitem>
418 </varlistentry>
798d3a52
ZJS
419 <varlistentry>
420 <term><varname>LLDP=</varname></term>
421 <listitem>
da6c766d
LP
422 <para>Controls support for Ethernet LLDP packet reception. LLDP is a link-layer protocol commonly
423 implemented on professional routers and bridges which announces which physical port a system is connected
424 to, as well as other related data. Accepts a boolean or the special value
34437b4f
LP
425 <literal>routers-only</literal>. When true, incoming LLDP packets are accepted and a database of all LLDP
426 neighbors maintained. If <literal>routers-only</literal> is set only LLDP data of various types of routers
427 is collected and LLDP data about other types of devices ignored (such as stations, telephones and
7cececb2 428 others). If false, LLDP reception is disabled. Defaults to <literal>routers-only</literal>. Use
34437b4f 429 <citerefentry><refentrytitle>networkctl</refentrytitle><manvolnum>1</manvolnum></citerefentry> to query the
da6c766d
LP
430 collected neighbor data. LLDP is only available on Ethernet links. See <varname>EmitLLDP=</varname> below
431 for enabling LLDP packet emission from the local system.
798d3a52
ZJS
432 </para>
433 </listitem>
434 </varlistentry>
da6c766d
LP
435 <varlistentry>
436 <term><varname>EmitLLDP=</varname></term>
437 <listitem>
7272b25e
LP
438 <para>Controls support for Ethernet LLDP packet emission. Accepts a boolean parameter or the special values
439 <literal>nearest-bridge</literal>, <literal>non-tpmr-bridge</literal> and
440 <literal>customer-bridge</literal>. Defaults to false, which turns off LLDP packet emission. If not false,
441 a short LLDP packet with information about the local system is sent out in regular intervals on the
442 link. The LLDP packet will contain information about the local host name, the local machine ID (as stored
443 in <citerefentry><refentrytitle>machine-id</refentrytitle><manvolnum>5</manvolnum></citerefentry>) and the
da6c766d
LP
444 local interface name, as well as the pretty hostname of the system (as set in
445 <citerefentry><refentrytitle>machine-info</refentrytitle><manvolnum>5</manvolnum></citerefentry>). LLDP
7272b25e
LP
446 emission is only available on Ethernet links. Note that this setting passes data suitable for
447 identification of host to the network and should thus not be enabled on untrusted networks, where such
448 identification data should not be made available. Use this option to permit other systems to identify on
449 which interfaces they are connected to this system. The three special values control propagation of the
450 LLDP packets. The <literal>nearest-bridge</literal> setting permits propagation only to the nearest
451 connected bridge, <literal>non-tpmr-bridge</literal> permits propagation across Two-Port MAC Relays, but
452 not any other bridges, and <literal>customer-bridge</literal> permits propagation until a customer bridge
453 is reached. For details about these concepts, see <ulink
6a1bae83 454 url="https://standards.ieee.org/findstds/standard/802.1AB-2016.html">IEEE 802.1AB-2016</ulink>. Note that
7272b25e
LP
455 configuring this setting to true is equivalent to <literal>nearest-bridge</literal>, the recommended and
456 most restricted level of propagation. See <varname>LLDP=</varname> above for an option to enable LLDP
457 reception.</para>
da6c766d
LP
458 </listitem>
459 </varlistentry>
0d4ad91d
AR
460 <varlistentry>
461 <term><varname>BindCarrier=</varname></term>
462 <listitem>
2ae7505f
TG
463 <para>A link name or a list of link names. When set, controls the behavior of the current
464 link. When all links in the list are in an operational down state, the current link is brought
465 down. When at least one link has carrier, the current interface is brought up.
0d4ad91d
AR
466 </para>
467 </listitem>
468 </varlistentry>
798d3a52
ZJS
469 <varlistentry>
470 <term><varname>Address=</varname></term>
471 <listitem>
472 <para>A static IPv4 or IPv6 address and its prefix length,
473 separated by a <literal>/</literal> character. Specify
474 this key more than once to configure several addresses.
475 The format of the address must be as described in
3ba3a79d 476 <citerefentry project='man-pages'><refentrytitle>inet_pton</refentrytitle><manvolnum>3</manvolnum></citerefentry>.
798d3a52
ZJS
477 This is a short-hand for an [Address] section only
478 containing an Address key (see below). This option may be
479 specified more than once.
480 </para>
481
e6ef3a13
YW
482 <para>If the specified address is <literal>0.0.0.0</literal> (for IPv4) or <literal>::</literal>
483 (for IPv6), a new address range of the requested size is automatically allocated from a
484 system-wide pool of unused ranges. Note that the prefix length must be equal or larger than 8 for
485 IPv4, and 64 for IPv6. The allocated range is checked against all current network interfaces and
486 all known network configuration files to avoid address range conflicts. The default system-wide
487 pool consists of 192.168.0.0/16, 172.16.0.0/12 and 10.0.0.0/8 for IPv4, and fd00::/8 for IPv6.
488 This functionality is useful to manage a large number of dynamically created network interfaces
489 with the same network configuration and automatic address range assignment.</para>
798d3a52
ZJS
490
491 </listitem>
492 </varlistentry>
493 <varlistentry>
494 <term><varname>Gateway=</varname></term>
495 <listitem>
496 <para>The gateway address, which must be in the format
497 described in
3ba3a79d 498 <citerefentry project='man-pages'><refentrytitle>inet_pton</refentrytitle><manvolnum>3</manvolnum></citerefentry>.
798d3a52
ZJS
499 This is a short-hand for a [Route] section only containing
500 a Gateway key. This option may be specified more than
501 once.</para>
502 </listitem>
503 </varlistentry>
504 <varlistentry>
505 <term><varname>DNS=</varname></term>
506 <listitem>
507 <para>A DNS server address, which must be in the format
508 described in
3ba3a79d 509 <citerefentry project='man-pages'><refentrytitle>inet_pton</refentrytitle><manvolnum>3</manvolnum></citerefentry>.
f41b446a 510 This option may be specified more than once. This setting is read by
3df9bec5 511 <citerefentry><refentrytitle>systemd-resolved.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
798d3a52
ZJS
512 </listitem>
513 </varlistentry>
514 <varlistentry>
515 <term><varname>Domains=</varname></term>
516 <listitem>
cd517eb7
ZJS
517 <para>A whitespace-separated list of domains which should be resolved using the DNS servers on
518 this link. Each item in the list should be a domain name, optionally prefixed with a tilde
519 (<literal>~</literal>). The domains with the prefix are called "routing-only domains". The
520 domains without the prefix are called "search domains" and are first used as search suffixes for
521 extending single-label host names (host names containing no dots) to become fully qualified
522 domain names (FQDNs). If a single-label host name is resolved on this interface, each of the
523 specified search domains are appended to it in turn, converting it into a fully qualified domain
524 name, until one of them may be successfully resolved.</para>
2df22529
ZJS
525
526 <para>Both "search" and "routing-only" domains are used for routing of DNS queries: look-ups for host names
527 ending in those domains (hence also single label names, if any "search domains" are listed), are routed to
528 the DNS servers configured for this interface. The domain routing logic is particularly useful on
529 multi-homed hosts with DNS servers serving particular private DNS zones on each interface.</para>
530
531 <para>The "routing-only" domain <literal>~.</literal> (the tilde indicating definition of a routing domain,
532 the dot referring to the DNS root domain which is the implied suffix of all valid DNS names) has special
533 effect. It causes all DNS traffic which does not match another configured domain routing entry to be routed
534 to DNS servers specified for this interface. This setting is useful to prefer a certain set of DNS servers
535 if a link on which they are connected is available.</para>
3df9bec5
LP
536
537 <para>This setting is read by
2df22529
ZJS
538 <citerefentry><refentrytitle>systemd-resolved.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
539 "Search domains" correspond to the <varname>domain</varname> and <varname>search</varname> entries in
98e9d710 540 <citerefentry project='man-pages'><refentrytitle>resolv.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
2df22529
ZJS
541 Domain name routing has no equivalent in the traditional glibc API, which has no concept of domain
542 name servers limited to a specific link.</para>
798d3a52
ZJS
543 </listitem>
544 </varlistentry>
7ece6f58
LP
545 <varlistentry>
546 <term><varname>DNSDefaultRoute=</varname></term>
547 <listitem>
548 <para>Takes a boolean argument. If true, this link's configured DNS servers are used for resolving domain
549 names that do not match any link's configured <varname>Domains=</varname> setting. If false, this link's
550 configured DNS servers are never used for such domains, and are exclusively used for resolving names that
551 match at least one of the domains configured on this link. If not specified defaults to an automatic mode:
552 queries not matching any link's configured domains will be routed to this link if it has no routing-only
553 domains configured.</para>
554 </listitem>
555 </varlistentry>
798d3a52
ZJS
556 <varlistentry>
557 <term><varname>NTP=</varname></term>
558 <listitem>
f41b446a 559 <para>An NTP server address. This option may be specified more than once. This setting is read by
3df9bec5 560 <citerefentry><refentrytitle>systemd-timesyncd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
798d3a52
ZJS
561 </listitem>
562 </varlistentry>
563 <varlistentry>
564 <term><varname>IPForward=</varname></term>
765afd5c
LP
565 <listitem><para>Configures IP packet forwarding for the
566 system. If enabled, incoming packets on any network
567 interface will be forwarded to any other interfaces
9b6ffef3
YW
568 according to the routing table. Takes a boolean,
569 or the values <literal>ipv4</literal> or
765afd5c
LP
570 <literal>ipv6</literal>, which only enable IP packet
571 forwarding for the specified address family. This controls
572 the <filename>net.ipv4.ip_forward</filename> and
573 <filename>net.ipv6.conf.all.forwarding</filename> sysctl
574 options of the network interface (see <ulink
4046d836
LP
575 url="https://www.kernel.org/doc/Documentation/networking/ip-sysctl.txt">ip-sysctl.txt</ulink>
576 for details about sysctl options). Defaults to
577 <literal>no</literal>.</para>
578
765afd5c
LP
579 <para>Note: this setting controls a global kernel option,
580 and does so one way only: if a network that has this setting
581 enabled is set up the global setting is turned on. However,
582 it is never turned off again, even after all networks with
583 this setting enabled are shut down again.</para>
584
585 <para>To allow IP packet forwarding only between specific
586 network interfaces use a firewall.</para>
4046d836 587 </listitem>
798d3a52
ZJS
588 </varlistentry>
589 <varlistentry>
590 <term><varname>IPMasquerade=</varname></term>
591 <listitem><para>Configures IP masquerading for the network
b938cb90 592 interface. If enabled, packets forwarded from the network
798d3a52
ZJS
593 interface will be appear as coming from the local host.
594 Takes a boolean argument. Implies
5c82dd13 595 <varname>IPForward=ipv4</varname>. Defaults to
4046d836 596 <literal>no</literal>.</para></listitem>
798d3a52 597 </varlistentry>
a46e37cb
SS
598 <varlistentry>
599 <term><varname>IPv6PrivacyExtensions=</varname></term>
1f0d9695
LP
600 <listitem><para>Configures use of stateless temporary
601 addresses that change over time (see <ulink
602 url="https://tools.ietf.org/html/rfc4941">RFC 4941</ulink>,
603 Privacy Extensions for Stateless Address Autoconfiguration
604 in IPv6). Takes a boolean or the special values
605 <literal>prefer-public</literal> and
b938cb90 606 <literal>kernel</literal>. When true, enables the privacy
1f0d9695 607 extensions and prefers temporary addresses over public
b938cb90 608 addresses. When <literal>prefer-public</literal>, enables the
1f0d9695
LP
609 privacy extensions, but prefers public addresses over
610 temporary addresses. When false, the privacy extensions
b938cb90 611 remain disabled. When <literal>kernel</literal>, the kernel's
1f0d9695 612 default setting will be left in place. Defaults to
a46e37cb
SS
613 <literal>no</literal>.</para></listitem>
614 </varlistentry>
941d0aa8 615 <varlistentry>
f921f573 616 <term><varname>IPv6AcceptRA=</varname></term>
c7fe06fb
ZJS
617 <listitem><para>Takes a boolean. Controls IPv6 Router Advertisement (RA) reception support for the
618 interface. If true, RAs are accepted; if false, RAs are ignored. When RAs are accepted, they may
619 trigger the start of the DHCPv6 client if the relevant flags are set in the RA data, or if no
620 routers are found on the link. The default is to disable RA reception for bridge devices or when IP
621 forwarding is enabled, and to enable it otherwise. Cannot be enabled on bond devices and when link
622 local adressing is disabled.</para>
1e7a0e21
LP
623
624 <para>Further settings for the IPv6 RA support may be configured in the
f921f573 625 <literal>[IPv6AcceptRA]</literal> section, see below.</para>
1e7a0e21
LP
626
627 <para>Also see <ulink
628 url="https://www.kernel.org/doc/Documentation/networking/ip-sysctl.txt">ip-sysctl.txt</ulink> in the kernel
629 documentation regarding <literal>accept_ra</literal>, but note that systemd's setting of
630 <constant>1</constant> (i.e. true) corresponds to kernel's setting of <constant>2</constant>.</para>
c4a05aa1 631
b3454e1e
YW
632 <para>Note that kernel's implementation of the IPv6 RA protocol is always disabled,
633 regardless of this setting. If this option is enabled, a userspace implementation of the IPv6
634 RA protocol is used, and the kernel's own implementation remains disabled, since
635 <command>systemd-networkd</command> needs to know all details supplied in the advertisements,
636 and these are not available from the kernel if the kernel's own implementation is used.</para>
ebf98081 637 </listitem>
941d0aa8 638 </varlistentry>
44de7fb1
SS
639 <varlistentry>
640 <term><varname>IPv6DuplicateAddressDetection=</varname></term>
a8eaaee7 641 <listitem><para>Configures the amount of IPv6 Duplicate
025314d9 642 Address Detection (DAD) probes to send. When unset, the kernel's default will be used.
44de7fb1
SS
643 </para></listitem>
644 </varlistentry>
a86cba89
SS
645 <varlistentry>
646 <term><varname>IPv6HopLimit=</varname></term>
647 <listitem><para>Configures IPv6 Hop Limit. For each router that
648 forwards the packet, the hop limit is decremented by 1. When the
649 hop limit field reaches zero, the packet is discarded.
025314d9 650 When unset, the kernel's default will be used.
a86cba89
SS
651 </para></listitem>
652 </varlistentry>
23d8b221 653 <varlistentry>
8f9a206b 654 <term><varname>IPv4ProxyARP=</varname></term>
9b6ffef3 655 <listitem><para>Takes a boolean. Configures proxy ARP for IPv4. Proxy ARP is the technique in which one host,
23d8b221
SS
656 usually a router, answers ARP requests intended for another machine. By "faking" its identity,
657 the router accepts responsibility for routing packets to the "real" destination. (see <ulink
658 url="https://tools.ietf.org/html/rfc1027">RFC 1027</ulink>.
025314d9 659 When unset, the kernel's default will be used.
23d8b221
SS
660 </para></listitem>
661 </varlistentry>
a0e5c15d 662 <varlistentry>
465dfe59 663 <term><varname>IPv6ProxyNDP=</varname></term>
9b6ffef3 664 <listitem><para>Takes a boolean. Configures proxy NDP for IPv6. Proxy NDP (Neighbor Discovery
465dfe59
HV
665 Protocol) is a technique for IPv6 to allow routing of addresses to a different
666 destination when peers expect them to be present on a certain physical link.
a0e5c15d
FK
667 In this case a router answers Neighbour Advertisement messages intended for
668 another machine by offering its own MAC address as destination.
465dfe59 669 Unlike proxy ARP for IPv4, it is not enabled globally, but will only send Neighbour
a0e5c15d 670 Advertisement messages for addresses in the IPv6 neighbor proxy table,
465dfe59
HV
671 which can also be shown by <command>ip -6 neighbour show proxy</command>.
672 systemd-networkd will control the per-interface `proxy_ndp` switch for each configured
673 interface depending on this option.
025314d9 674 When unset, the kernel's default will be used.
465dfe59
HV
675 </para></listitem>
676 </varlistentry>
677 <varlistentry>
678 <term><varname>IPv6ProxyNDPAddress=</varname></term>
679 <listitem><para>An IPv6 address, for which Neighbour Advertisement messages will be
680 proxied. This option may be specified more than once. systemd-networkd will add the
681 <option>IPv6ProxyNDPAddress=</option> entries to the kernel's IPv6 neighbor proxy table.
964c4eda 682 This option implies <option>IPv6ProxyNDP=yes</option> but has no effect if
025314d9 683 <option>IPv6ProxyNDP</option> has been set to false. When unset, the kernel's default will be used.
a0e5c15d
FK
684 </para></listitem>
685 </varlistentry>
3f9e0236
PF
686 <varlistentry>
687 <term><varname>IPv6PrefixDelegation=</varname></term>
688 <listitem><para>Whether to enable or disable Router Advertisement sending on a link.
982be97c
PF
689 Allowed values are <literal>static</literal> which distributes prefixes as defined in
690 the <literal>[IPv6PrefixDelegation]</literal> and any <literal>[IPv6Prefix]</literal>
691 sections, <literal>dhcpv6</literal> which requests prefixes using a DHCPv6 client
692 configured for another link and any values configured in the
693 <literal>[IPv6PrefixDelegation]</literal> section while ignoring all static prefix
694 configuration sections, <literal>yes</literal> which uses both static configuration
695 and DHCPv6, and <literal>false</literal> which turns off IPv6 prefix delegation
696 altogether. Defaults to <literal>false</literal>. See the
697 <literal>[IPv6PrefixDelegation]</literal> and the <literal>[IPv6Prefix]</literal>
698 sections for more configuration options.
3f9e0236
PF
699 </para></listitem>
700 </varlistentry>
11102cba
SS
701 <varlistentry>
702 <term><varname>IPv6MTUBytes=</varname></term>
703 <listitem><para>Configures IPv6 maximum transmission unit (MTU).
025314d9 704 An integer greater than or equal to 1280 bytes. When unset, the kernel's default will be used.
11102cba
SS
705 </para></listitem>
706 </varlistentry>
798d3a52
ZJS
707 <varlistentry>
708 <term><varname>Bridge=</varname></term>
709 <listitem>
9e35b3de
ZJS
710 <para>The name of the bridge to add the link to. See
711 <citerefentry><refentrytitle>systemd.netdev</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
712 </para>
798d3a52
ZJS
713 </listitem>
714 </varlistentry>
715 <varlistentry>
716 <term><varname>Bond=</varname></term>
717 <listitem>
9e35b3de
ZJS
718 <para>The name of the bond to add the link to. See
719 <citerefentry><refentrytitle>systemd.netdev</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
720 </para>
798d3a52
ZJS
721 </listitem>
722 </varlistentry>
6cb955c6
AR
723 <varlistentry>
724 <term><varname>VRF=</varname></term>
725 <listitem>
9e35b3de
ZJS
726 <para>The name of the VRF to add the link to. See
727 <citerefentry><refentrytitle>systemd.netdev</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
728 </para>
6cb955c6
AR
729 </listitem>
730 </varlistentry>
798d3a52
ZJS
731 <varlistentry>
732 <term><varname>VLAN=</varname></term>
733 <listitem>
9e35b3de
ZJS
734 <para>The name of a VLAN to create on the link. See
735 <citerefentry><refentrytitle>systemd.netdev</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
736 This option may be specified more than once.</para>
798d3a52
ZJS
737 </listitem>
738 </varlistentry>
2479c4fe 739 <varlistentry>
740 <term><varname>IPVLAN=</varname></term>
741 <listitem>
742 <para>The name of a IPVLAN to create on the link. See
743 <citerefentry><refentrytitle>systemd.netdev</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
744 This option may be specified more than once.</para>
745 </listitem>
746 </varlistentry>
798d3a52
ZJS
747 <varlistentry>
748 <term><varname>MACVLAN=</varname></term>
749 <listitem>
9e35b3de
ZJS
750 <para>The name of a MACVLAN to create on the link. See
751 <citerefentry><refentrytitle>systemd.netdev</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
752 This option may be specified more than once.</para>
798d3a52
ZJS
753 </listitem>
754 </varlistentry>
755 <varlistentry>
756 <term><varname>VXLAN=</varname></term>
757 <listitem>
9e35b3de
ZJS
758 <para>The name of a VXLAN to create on the link. See
759 <citerefentry><refentrytitle>systemd.netdev</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
760 This option may be specified more than once.</para>
798d3a52
ZJS
761 </listitem>
762 </varlistentry>
763 <varlistentry>
764 <term><varname>Tunnel=</varname></term>
765 <listitem>
9e35b3de
ZJS
766 <para>The name of a Tunnel to create on the link. See
767 <citerefentry><refentrytitle>systemd.netdev</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
768 This option may be specified more than once.</para>
798d3a52
ZJS
769 </listitem>
770 </varlistentry>
81962db7
SS
771 <varlistentry>
772 <term><varname>MACsec=</varname></term>
773 <listitem>
774 <para>The name of a MACsec device to create on the link. See
775 <citerefentry><refentrytitle>systemd.netdev</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
776 This option may be specified more than once.</para>
777 </listitem>
778 </varlistentry>
dd5f3175
SS
779 <varlistentry>
780 <term><varname>ActiveSlave=</varname></term>
781 <listitem>
9b6ffef3 782 <para>Takes a boolean. Specifies the new active slave. The <literal>ActiveSlave=</literal>
dd5f3175
SS
783 option is only valid for following modes:
784 <literal>active-backup</literal>,
785 <literal>balance-alb</literal> and
786 <literal>balance-tlb</literal>. Defaults to false.
787 </para>
788 </listitem>
789 </varlistentry>
790 <varlistentry>
791 <term><varname>PrimarySlave=</varname></term>
792 <listitem>
9b6ffef3 793 <para>Takes a boolean. Specifies which slave is the primary device. The specified
dd5f3175
SS
794 device will always be the active slave while it is available. Only when the
795 primary is off-line will alternate devices be used. This is useful when
796 one slave is preferred over another, e.g. when one slave has higher throughput
797 than another. The <literal>PrimarySlave=</literal> option is only valid for
798 following modes:
799 <literal>active-backup</literal>,
800 <literal>balance-alb</literal> and
801 <literal>balance-tlb</literal>. Defaults to false.
802 </para>
803 </listitem>
804 </varlistentry>
dad2d78e
SS
805 <varlistentry>
806 <term><varname>ConfigureWithoutCarrier=</varname></term>
807 <listitem>
9b6ffef3 808 <para>Takes a boolean. Allows networkd to configure a specific link even if it has no carrier.
dad2d78e
SS
809 Defaults to false.
810 </para>
811 </listitem>
812 </varlistentry>
93b4dab5
SS
813 <varlistentry>
814 <term><varname>IgnoreCarrierLoss=</varname></term>
815 <listitem>
816 <para>A boolean. Allows networkd to retain both the static and dynamic configuration of the
817 interface even if its carrier is lost. Defaults to false.
818 </para>
819 </listitem>
820 </varlistentry>
98d20a17 821 <varlistentry>
822 <term><varname>Xfrm=</varname></term>
823 <listitem>
824 <para>The name of the xfrm to create on the link. See
825 <citerefentry><refentrytitle>systemd.netdev</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
826 This option may be specified more than once.</para>
827 </listitem>
828 </varlistentry>
c98d78d3
YW
829 <varlistentry>
830 <term><varname>KeepConfiguration=</varname></term>
831 <listitem>
832 <para>Takes a boolean or one of <literal>static</literal>, <literal>dhcp-on-stop</literal>,
833 <literal>dhcp</literal>. When <literal>static</literal>, <command>systemd-networkd</command>
834 will not drop static addresses and routes on starting up process. When set to
835 <literal>dhcp-on-stop</literal>, <command>systemd-networkd</command> will not drop addresses
836 and routes on stopping the daemon. When <literal>dhcp</literal>,
837 the addresses and routes provided by a DHCP server will never be dropped even if the DHCP
838 lease expires. This is contrary to the DHCP specification, but may be the best choice if,
839 e.g., the root filesystem relies on this connection. The setting <literal>dhcp</literal>
840 implies <literal>dhcp-on-stop</literal>, and <literal>yes</literal> implies
80060352
ZJS
841 <literal>dhcp</literal> and <literal>static</literal>. Defaults to <literal>no</literal>.
842 </para>
c98d78d3
YW
843 </listitem>
844 </varlistentry>
93b4dab5 845
798d3a52
ZJS
846 </variablelist>
847
848 </refsect1>
849
850 <refsect1>
851 <title>[Address] Section Options</title>
852
853 <para>An <literal>[Address]</literal> section accepts the
854 following keys. Specify several <literal>[Address]</literal>
855 sections to configure several addresses.</para>
856
857 <variablelist class='network-directives'>
858 <varlistentry>
859 <term><varname>Address=</varname></term>
860 <listitem>
4e68898e
YW
861 <para>As in the <literal>[Network]</literal> section. This key is mandatory. Each
862 <literal>[Address]</literal> section can contain one <varname>Address=</varname> setting.</para>
798d3a52
ZJS
863 </listitem>
864 </varlistentry>
865 <varlistentry>
866 <term><varname>Peer=</varname></term>
867 <listitem>
868 <para>The peer address in a point-to-point connection.
4e68898e 869 Accepts the same format as the <varname>Address=</varname>
798d3a52
ZJS
870 key.</para>
871 </listitem>
872 </varlistentry>
873 <varlistentry>
874 <term><varname>Broadcast=</varname></term>
875 <listitem>
876 <para>The broadcast address, which must be in the format
877 described in
3ba3a79d 878 <citerefentry project='man-pages'><refentrytitle>inet_pton</refentrytitle><manvolnum>3</manvolnum></citerefentry>.
798d3a52 879 This key only applies to IPv4 addresses. If it is not
4e68898e 880 given, it is derived from the <varname>Address=</varname>
798d3a52
ZJS
881 key.</para>
882 </listitem>
883 </varlistentry>
884 <varlistentry>
885 <term><varname>Label=</varname></term>
886 <listitem>
887 <para>An address label.</para>
888 </listitem>
889 </varlistentry>
b5834a0b
SS
890 <varlistentry>
891 <term><varname>PreferredLifetime=</varname></term>
892 <listitem>
893 <para>Allows the default "preferred lifetime" of the address to be overridden.
894 Only three settings are accepted: <literal>forever</literal> or <literal>infinity</literal>
895 which is the default and means that the address never expires, and <literal>0</literal> which means
896 that the address is considered immediately "expired" and will not be used,
897 unless explicitly requested. A setting of PreferredLifetime=0 is useful for
898 addresses which are added to be used only by a specific application,
899 which is then configured to use them explicitly.</para>
900 </listitem>
901 </varlistentry>
2959fb07
SS
902 <varlistentry>
903 <term><varname>Scope=</varname></term>
904 <listitem>
905 <para>The scope of the address, which can be <literal>global</literal>,
906 <literal>link</literal> or <literal>host</literal> or an unsigned integer ranges 0 to 255.
907 Defaults to <literal>global</literal>.</para>
908 </listitem>
909 </varlistentry>
e63be084
SS
910 <varlistentry>
911 <term><varname>HomeAddress=</varname></term>
912 <listitem>
9b6ffef3 913 <para>Takes a boolean. Designates this address the "home address" as defined in
e63be084
SS
914 <ulink url="https://tools.ietf.org/html/rfc6275">RFC 6275</ulink>.
915 Supported only on IPv6. Defaults to false.</para>
916 </listitem>
917 </varlistentry>
918 <varlistentry>
919 <term><varname>DuplicateAddressDetection=</varname></term>
920 <listitem>
051e77ca
SS
921 <para>Takes one of <literal>ipv4</literal>, <literal>ipv6</literal>,
922 <literal>both</literal>, <literal>none</literal>. When <literal>ipv4</literal>,
923 performs IPv4 Duplicate Address Detection. See
924 <ulink url="https://tools.ietf.org/html/rfc5227">RFC 5224</ulink>.
925 When <literal>ipv6</literal>, performs IPv6 Duplicate Address Detection. See
926 <ulink url="https://tools.ietf.org/html/rfc4862">RFC 4862</ulink>.
927 Defaults to <literal>ipv6</literal>.</para>
e63be084
SS
928 </listitem>
929 </varlistentry>
930 <varlistentry>
931 <term><varname>ManageTemporaryAddress=</varname></term>
932 <listitem>
9b6ffef3 933 <para>Takes a boolean. If true the kernel manage temporary addresses created
e63be084
SS
934 from this one as template on behalf of Privacy Extensions
935 <ulink url="https://tools.ietf.org/html/rfc3041">RFC 3041</ulink>. For this to become
936 active, the use_tempaddr sysctl setting has to be set to a value greater than zero.
11fcfc53 937 The given address needs to have a prefix length of 64. This flag allows using privacy
e63be084
SS
938 extensions in a manually configured network, just like if stateless auto-configuration
939 was active. Defaults to false. </para>
940 </listitem>
941 </varlistentry>
942 <varlistentry>
de697db0 943 <term><varname>AddPrefixRoute=</varname></term>
e63be084 944 <listitem>
de697db0
YW
945 <para>Takes a boolean. When true, the prefix route for the address is automatically added.
946 Defaults to true.</para>
e63be084
SS
947 </listitem>
948 </varlistentry>
949 <varlistentry>
950 <term><varname>AutoJoin=</varname></term>
951 <listitem>
9b6ffef3 952 <para>Takes a boolean. Joining multicast group on ethernet level via
e63be084
SS
953 <command>ip maddr</command> command would not work if we have an Ethernet switch that does
954 IGMP snooping since the switch would not replicate multicast packets on ports that did not
955 have IGMP reports for the multicast addresses. Linux vxlan interfaces created via
956 <command>ip link add vxlan</command> or networkd's netdev kind vxlan have the group option
957 that enables then to do the required join. By extending ip address command with option
958 <literal>autojoin</literal> we can get similar functionality for openvswitch (OVS) vxlan
959 interfaces as well as other tunneling mechanisms that need to receive multicast traffic.
960 Defaults to <literal>no</literal>.</para>
961 </listitem>
962 </varlistentry>
798d3a52
ZJS
963 </variablelist>
964 </refsect1>
965
e4a71bf3
WKI
966 <refsect1>
967 <title>[Neighbor] Section Options</title>
968 <para>A <literal>[Neighbor]</literal> section accepts the
969 following keys. The neighbor section adds a permanent, static
970 entry to the neighbor table (IPv6) or ARP table (IPv4) for
971 the given hardware address on the links matched for the network.
972 Specify several <literal>[Neighbor]</literal> sections to configure
973 several static neighbors.</para>
974
975 <variablelist class='network-directives'>
976 <varlistentry>
977 <term><varname>Address=</varname></term>
978 <listitem>
979 <para>The IP address of the neighbor.</para>
980 </listitem>
981 </varlistentry>
982 <varlistentry>
b956364d 983 <term><varname>LinkLayerAddress=</varname></term>
e4a71bf3 984 <listitem>
b956364d 985 <para>The link layer address (MAC address or IP address) of the neighbor.</para>
e4a71bf3
WKI
986 </listitem>
987 </varlistentry>
988 </variablelist>
989 </refsect1>
990
95b74ef6
SS
991 <refsect1>
992 <title>[IPv6AddressLabel] Section Options</title>
993
994 <para>An <literal>[IPv6AddressLabel]</literal> section accepts the
995 following keys. Specify several <literal>[IPv6AddressLabel]</literal>
785889e5 996 sections to configure several address labels. IPv6 address labels are
95b74ef6
SS
997 used for address selection. See <ulink url="https://tools.ietf.org/html/rfc3484">RFC 3484</ulink>.
998 Precedence is managed by userspace, and only the label itself is stored in the kernel</para>
999
1000 <variablelist class='network-directives'>
1001 <varlistentry>
1002 <term><varname>Label=</varname></term>
1003 <listitem>
1004 <para> The label for the prefix (an unsigned integer) ranges 0 to 4294967294.
1005 0xffffffff is reserved. This key is mandatory.</para>
1006 </listitem>
1007 </varlistentry>
1008 <varlistentry>
1009 <term><varname>Prefix=</varname></term>
1010 <listitem>
1011 <para>IPv6 prefix is an address with a prefix length, separated by a slash <literal>/</literal> character.
1012 This key is mandatory. </para>
1013 </listitem>
1014 </varlistentry>
1015 </variablelist>
1016 </refsect1>
1017
bce67bbe
SS
1018 <refsect1>
1019 <title>[RoutingPolicyRule] Section Options</title>
1020
1021 <para>An <literal>[RoutingPolicyRule]</literal> section accepts the
1022 following keys. Specify several <literal>[RoutingPolicyRule]</literal>
1023 sections to configure several rules.</para>
1024
1025 <variablelist class='network-directives'>
1026 <varlistentry>
1027 <term><varname>TypeOfService=</varname></term>
1028 <listitem>
1029 <para>Specifies the type of service to match a number between 0 to 255.</para>
1030 </listitem>
1031 </varlistentry>
1032 <varlistentry>
1033 <term><varname>From=</varname></term>
1034 <listitem>
1035 <para>Specifies the source address prefix to match. Possibly followed by a slash and the prefix length.</para>
1036 </listitem>
1037 </varlistentry>
1038 <varlistentry>
1039 <term><varname>To=</varname></term>
1040 <listitem>
1041 <para>Specifies the destination address prefix to match. Possibly followed by a slash and the prefix length.</para>
1042 </listitem>
1043 </varlistentry>
1044 <varlistentry>
1045 <term><varname>FirewallMark=</varname></term>
1046 <listitem>
1047 <para>Specifies the iptables firewall mark value to match (a number between 1 and 4294967295).</para>
1048 </listitem>
1049 </varlistentry>
1050 <varlistentry>
1051 <term><varname>Table=</varname></term>
1052 <listitem>
41b90a1e
YW
1053 <para>Specifies the routing table identifier to lookup if the rule selector matches. Takes
1054 one of <literal>default</literal>, <literal>main</literal>, and <literal>local</literal>,
1055 or a number between 1 and 4294967295. Defaults to <literal>main</literal>.</para>
bce67bbe
SS
1056 </listitem>
1057 </varlistentry>
1058 <varlistentry>
1059 <term><varname>Priority=</varname></term>
1060 <listitem>
1061 <para>Specifies the priority of this rule. <varname>Priority=</varname> is an unsigned
1062 integer. Higher number means lower priority, and rules get processed in order of increasing number.</para>
1063 </listitem>
1064 </varlistentry>
762e2659
SS
1065 <varlistentry>
1066 <term><varname>IncomingInterface=</varname></term>
1067 <listitem>
1068 <para>Specifies incoming device to match. If the interface is loopback, the rule only matches packets originating from this host.</para>
1069 </listitem>
1070 </varlistentry>
1071 <varlistentry>
1072 <term><varname>OutgoingInterface=</varname></term>
1073 <listitem>
1074 <para>Specifies the outgoing device to match. The outgoing interface is only available for packets originating from local sockets that are bound to a device.</para>
1075 </listitem>
1076 </varlistentry>
926062f0
SS
1077 <varlistentry>
1078 <term><varname>SourcePort=</varname></term>
1079 <listitem>
1080 <para>Specifies the source IP port or IP port range match in forwarding information base (FIB) rules.
1081 A port range is specified by the lower and upper port separated by a dash. Defaults to unset.</para>
1082 </listitem>
1083 </varlistentry>
1084 <varlistentry>
1085 <term><varname>DestinationPort=</varname></term>
1086 <listitem>
1087 <para>Specifies the destination IP port or IP port range match in forwarding information base (FIB) rules.
1088 A port range is specified by the lower and upper port separated by a dash. Defaults to unset.</para>
1089 </listitem>
1090 </varlistentry>
1091 <varlistentry>
97f9df9e 1092 <term><varname>IPProtocol=</varname></term>
926062f0 1093 <listitem>
3a269dcf
YW
1094 <para>Specifies the IP protocol to match in forwarding information base (FIB) rules. Takes IP protocol name such as <literal>tcp</literal>,
1095 <literal>udp</literal> or <literal>sctp</literal>, or IP protocol number such as <literal>6</literal> for <literal>tcp</literal> or
1096 <literal>17</literal> for <literal>udp</literal>.
926062f0
SS
1097 Defaults to unset.</para>
1098 </listitem>
1099 </varlistentry>
8b220643
SS
1100 <varlistentry>
1101 <term><varname>InvertRule=</varname></term>
1102 <listitem>
53e1ba28 1103 <para>A boolean. Specifies whether the rule is to be inverted. Defaults to false.</para>
8b220643
SS
1104 </listitem>
1105 </varlistentry>
f6c6ff97
YW
1106 <varlistentry>
1107 <term><varname>Family=</varname></term>
1108 <listitem>
1109 <para>Takes a special value <literal>ipv4</literal>, <literal>ipv6</literal>, or
1110 <literal>both</literal>. By default, the address family is determined by the address
1111 specified in <varname>To=</varname> or <varname>From=</varname>. If neither
1112 <varname>To=</varname> nor <varname>From=</varname> are specified, then defaults to
1113 <literal>ipv4</literal>.</para>
1114 </listitem>
1115 </varlistentry>
ea471a46
YW
1116 <varlistentry>
1117 <term><varname>User=</varname></term>
1118 <listitem>
1119 <para>Takes a username, a user ID, or a range of user IDs separated by a dash. Defaults to
1120 unset.</para>
1121 </listitem>
1122 </varlistentry>
53e1ba28
NF
1123 <varlistentry>
1124 <term><varname>SuppressPrefixLength=</varname></term>
1125 <listitem>
1126 <para>Takes a number <replaceable>N</replaceable> in the range 0-128 and rejects routing
1127 decisions that have a prefix length of <replaceable>N</replaceable> or less. Defaults to
1128 unset.</para>
1129 </listitem>
1130 </varlistentry>
bce67bbe 1131 </variablelist>
c16c7808
SS
1132 </refsect1>
1133
1134 <refsect1>
1135 <title>[NextHop] Section Options</title>
1136 <para>The <literal>[NextHop]</literal> section accepts the
1137 following keys. Specify several <literal>[NextHop]</literal>
1138 sections to configure several nexthop. Nexthop is used to manipulate entries in the kernel's nexthop
1139 tables.</para>
1140
1141 <variablelist class='network-directives'>
1142 <varlistentry>
1143 <term><varname>Gateway=</varname></term>
1144 <listitem>
1145 <para>As in the <literal>[Network]</literal> section. This is mandatory.</para>
1146 </listitem>
1147 </varlistentry>
1148 <varlistentry>
1149 <term><varname>Id=</varname></term>
1150 <listitem>
1151 <para>The id of the nexthop (an unsigned integer). If unspecified or '0' then automatically chosen by kernel.</para>
1152 </listitem>
1153 </varlistentry>
1154 </variablelist>
bce67bbe
SS
1155 </refsect1>
1156
798d3a52
ZJS
1157 <refsect1>
1158 <title>[Route] Section Options</title>
1159 <para>The <literal>[Route]</literal> section accepts the
1160 following keys. Specify several <literal>[Route]</literal>
1161 sections to configure several routes.</para>
1162
1163 <variablelist class='network-directives'>
1164 <varlistentry>
1165 <term><varname>Gateway=</varname></term>
1166 <listitem>
427928ca
ZJS
1167 <para>Takes the gateway address or special value <literal>_dhcp</literal>. If
1168 <literal>_dhcp</literal>, then the gateway address provided by DHCP (or in the IPv6 case,
1985c54f 1169 provided by IPv6 RA) is used.</para>
798d3a52
ZJS
1170 </listitem>
1171 </varlistentry>
28959f7d 1172 <varlistentry>
9cb8c559 1173 <term><varname>GatewayOnLink=</varname></term>
28959f7d 1174 <listitem>
9b6ffef3 1175 <para>Takes a boolean. If set to true, the kernel does not have
28959f7d
SS
1176 to check if the gateway is reachable directly by the current machine (i.e., the kernel does
1177 not need to check if the gateway is attached to the local network), so that we can insert the
9b6ffef3 1178 route in the kernel table without it being complained about. Defaults to <literal>no</literal>.
28959f7d
SS
1179 </para>
1180 </listitem>
1181 </varlistentry>
798d3a52
ZJS
1182 <varlistentry>
1183 <term><varname>Destination=</varname></term>
1184 <listitem>
1185 <para>The destination prefix of the route. Possibly
b938cb90 1186 followed by a slash and the prefix length. If omitted, a
798d3a52
ZJS
1187 full-length host route is assumed.</para>
1188 </listitem>
1189 </varlistentry>
1190 <varlistentry>
1191 <term><varname>Source=</varname></term>
1192 <listitem>
1193 <para>The source prefix of the route. Possibly followed by
b938cb90 1194 a slash and the prefix length. If omitted, a full-length
798d3a52
ZJS
1195 host route is assumed.</para>
1196 </listitem>
1197 </varlistentry>
1198 <varlistentry>
1199 <term><varname>Metric=</varname></term>
1200 <listitem>
b938cb90 1201 <para>The metric of the route (an unsigned integer).</para>
798d3a52
ZJS
1202 </listitem>
1203 </varlistentry>
b5bf6f64
SS
1204 <varlistentry>
1205 <term><varname>IPv6Preference=</varname></term>
1206 <listitem>
1207 <para>Specifies the route preference as defined in <ulink
1208 url="https://tools.ietf.org/html/rfc4191">RFC4191</ulink> for Router Discovery messages.
1209 Which can be one of <literal>low</literal> the route has a lowest priority,
1210 <literal>medium</literal> the route has a default priority or
1211 <literal>high</literal> the route has a highest priority.</para>
1212 </listitem>
1213 </varlistentry>
769b56a3
TG
1214 <varlistentry>
1215 <term><varname>Scope=</varname></term>
1216 <listitem>
f5c38922
YW
1217 <para>The scope of the route, which can be <literal>global</literal>, <literal>site</literal>,
1218 <literal>link</literal>, <literal>host</literal>, or <literal>nowhere</literal>. For IPv4 route,
1219 defaults to <literal>host</literal> if <varname>Type=</varname> is <literal>local</literal>
1220 or <literal>nat</literal>, and <literal>link</literal> if <varname>Type=</varname> is
1221 <literal>broadcast</literal>, <literal>multicast</literal>, or <literal>anycast</literal>.
1222 In other cases, defaults to <literal>global</literal>.</para>
769b56a3 1223 </listitem>
0d07e595
JK
1224 </varlistentry>
1225 <varlistentry>
1226 <term><varname>PreferredSource=</varname></term>
1227 <listitem>
1228 <para>The preferred source address of the route. The address
1229 must be in the format described in
1230 <citerefentry project='man-pages'><refentrytitle>inet_pton</refentrytitle><manvolnum>3</manvolnum></citerefentry>.</para>
1231 </listitem>
769b56a3 1232 </varlistentry>
c953b24c 1233 <varlistentry>
f5c38922 1234 <term><varname>Table=</varname></term>
c953b24c 1235 <listitem>
f5c38922
YW
1236 <para>The table identifier for the route. Takes <literal>default</literal>,
1237 <literal>main</literal>, <literal>local</literal> or a number between 1 and 4294967295.
1238 The table can be retrieved using <command>ip route show table <replaceable>num</replaceable></command>.
1239 If unset and <varname>Type=</varname> is <literal>local</literal>, <literal>broadcast</literal>,
1240 <literal>anycast</literal>, or <literal>nat</literal>, then <literal>local</literal> is used.
1241 In other cases, defaults to <literal>main</literal>.
c953b24c
SS
1242 </para>
1243 </listitem>
1244 </varlistentry>
c83ecc04
SS
1245 <varlistentry>
1246 <term><varname>Protocol=</varname></term>
1247 <listitem>
88925d2f 1248 <para>The protocol identifier for the route. Takes a number between 0 and 255 or the special values
ca420b62
YW
1249 <literal>kernel</literal>, <literal>boot</literal>, <literal>static</literal>,
1250 <literal>ra</literal> and <literal>dhcp</literal>. Defaults to <literal>static</literal>.
c83ecc04
SS
1251 </para>
1252 </listitem>
1253 </varlistentry>
983226f3
SS
1254 <varlistentry>
1255 <term><varname>Type=</varname></term>
1256 <listitem>
94d6e299
YW
1257 <para>Specifies the type for the route. Takes one of <literal>unicast</literal>,
1258 <literal>local</literal>, <literal>broadcast</literal>, <literal>anycast</literal>,
1259 <literal>multicast</literal>, <literal>blackhole</literal>, <literal>unreachable</literal>,
1260 <literal>prohibit</literal>, <literal>throw</literal>, <literal>nat</literal>, and
1261 <literal>xresolve</literal>. If <literal>unicast</literal>, a regular route is defined, i.e. a
66d7235e
LP
1262 route indicating the path to take to a destination network address. If <literal>blackhole</literal>, packets
1263 to the defined route are discarded silently. If <literal>unreachable</literal>, packets to the defined route
1264 are discarded and the ICMP message "Host Unreachable" is generated. If <literal>prohibit</literal>, packets
1265 to the defined route are discarded and the ICMP message "Communication Administratively Prohibited" is
1266 generated. If <literal>throw</literal>, route lookup in the current routing table will fail and the route
1267 selection process will return to Routing Policy Database (RPDB). Defaults to <literal>unicast</literal>.
983226f3
SS
1268 </para>
1269 </listitem>
1270 </varlistentry>
323d9329
SS
1271 <varlistentry>
1272 <term><varname>InitialCongestionWindow=</varname></term>
1273 <listitem>
6b21ad33
SS
1274 <para>The TCP initial congestion window is used during the start of a TCP connection. During the start of a TCP
1275 session, when a client requests a resource, the server's initial congestion window determines how many data bytes
1276 will be sent during the initial burst of data. Takes a size in bytes between 1 and 4294967295 (2^32 - 1). The usual
025314d9 1277 suffixes K, M, G are supported and are understood to the base of 1024. When unset, the kernel's default will be used.
323d9329
SS
1278 </para>
1279 </listitem>
1280 </varlistentry>
1281 <varlistentry>
1282 <term><varname>InitialAdvertisedReceiveWindow=</varname></term>
1283 <listitem>
5238e957 1284 <para>The TCP initial advertised receive window is the amount of receive data (in bytes) that can initially be buffered at one time
6b21ad33
SS
1285 on a connection. The sending host can send only that amount of data before waiting for an acknowledgment and window update
1286 from the receiving host. Takes a size in bytes between 1 and 4294967295 (2^32 - 1). The usual suffixes K, M, G are supported
025314d9 1287 and are understood to the base of 1024. When unset, the kernel's default will be used.
323d9329
SS
1288 </para>
1289 </listitem>
1290 </varlistentry>
09f5dfad
SS
1291 <varlistentry>
1292 <term><varname>QuickAck=</varname></term>
1293 <listitem>
9b6ffef3 1294 <para>Takes a boolean. When true enables TCP quick ack mode for the route. When unset, the kernel's default will be used.
09f5dfad
SS
1295 </para>
1296 </listitem>
1297 </varlistentry>
633c7258
SS
1298 <varlistentry>
1299 <term><varname>FastOpenNoCookie=</varname></term>
1300 <listitem>
1301 <para>Takes a boolean. When true enables TCP fastopen without a cookie on a per-route basis.
1302 When unset, the kernel's default will be used.
1303 </para>
1304 </listitem>
09f5dfad 1305 </varlistentry>
9b88f20a
SS
1306 <varlistentry>
1307 <term><varname>TTLPropagate=</varname></term>
1308 <listitem>
1309 <para>Takes a boolean. When true enables TTL propagation at Label Switched Path (LSP) egress.
1310 When unset, the kernel's default will be used.
1311 </para>
1312 </listitem>
1313 </varlistentry>
cea79e66
SS
1314 <varlistentry>
1315 <term><varname>MTUBytes=</varname></term>
1316 <listitem>
1317 <para>The maximum transmission unit in bytes to set for the
1318 route. The usual suffixes K, M, G, are supported and are
1319 understood to the base of 1024.</para>
1320 <para>Note that if IPv6 is enabled on the interface, and the MTU is chosen
1321 below 1280 (the minimum MTU for IPv6) it will automatically be increased to this value.</para>
1322 </listitem>
afe42aef
SC
1323 </varlistentry>
1324 <varlistentry>
1325 <term><varname>IPServiceType=</varname></term>
1326 <listitem>
e681a2ee
YW
1327 <para>Takes string; <literal>CS6</literal> or <literal>CS4</literal>. Used to set IP
1328 service type to CS6 (network control) or CS4 (Realtime). Defaults to CS6.</para>
afe42aef
SC
1329 </listitem>
1330 </varlistentry>
6ff5cc6b
YW
1331 <varlistentry>
1332 <term><varname>MultiPathRoute=<replaceable>address</replaceable>[@<replaceable>name</replaceable>] [<replaceable>weight</replaceable>]</varname></term>
1333 <listitem>
1334 <para>Configures multipath route. Multipath routing is the technique of using multiple
1335 alternative paths through a network. Takes gateway address. Optionally, takes a network
1336 interface name or index separated with <literal>@</literal>, and a weight in 1..256 for
1337 this multipath route separated with whitespace. This setting can be specified multiple
1338 times. If an empty string is assigned, then the all previous assignments are cleared.</para>
1339 </listitem>
1340 </varlistentry>
798d3a52
ZJS
1341 </variablelist>
1342 </refsect1>
1343
1344 <refsect1>
4f7331a8
YW
1345 <title>[DHCPv4] Section Options</title>
1346 <para>The <literal>[DHCPv4]</literal> section configures the
caa8ca42 1347 DHCPv4 client, if it is enabled with the
ad943783 1348 <varname>DHCP=</varname> setting described above:</para>
798d3a52
ZJS
1349
1350 <variablelist class='network-directives'>
1351 <varlistentry>
1352 <term><varname>UseDNS=</varname></term>
1353 <listitem>
1354 <para>When true (the default), the DNS servers received
1355 from the DHCP server will be used and take precedence over
1356 any statically configured ones.</para>
e88d8021
ZJS
1357
1358 <para>This corresponds to the <option>nameserver</option>
ad943783
LP
1359 option in <citerefentry
1360 project='man-pages'><refentrytitle>resolv.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para>
798d3a52
ZJS
1361 </listitem>
1362 </varlistentry>
a24e12f0
YW
1363 <varlistentry>
1364 <term><varname>RoutesToDNS=</varname></term>
1365 <listitem>
1366 <para>When true, the routes to the DNS servers received from the DHCP server will be
1367 configured. When <varname>UseDNS=</varname> is disabled, this setting is ignored.
f7e7bb65 1368 Defaults to false.</para>
a24e12f0
YW
1369 </listitem>
1370 </varlistentry>
301f4073
MM
1371 <varlistentry>
1372 <term><varname>UseNTP=</varname></term>
1373 <listitem>
1374 <para>When true (the default), the NTP servers received
1375 from the DHCP server will be used by systemd-timesyncd
1376 and take precedence over any statically configured ones.</para>
1377 </listitem>
1378 </varlistentry>
299d578f
SS
1379 <varlistentry>
1380 <term><varname>UseSIP=</varname></term>
1381 <listitem>
1382 <para>When true (the default), the SIP servers received
1383 from the DHCP server will be saved at the state files and can be
1384 read via <function>sd_network_link_get_sip_servers()</function> function.</para>
1385 </listitem>
1386 </varlistentry>
798d3a52
ZJS
1387 <varlistentry>
1388 <term><varname>UseMTU=</varname></term>
1389 <listitem>
1390 <para>When true, the interface maximum transmission unit
1391 from the DHCP server will be used on the current link.
7169cdc8 1392 If <varname>MTUBytes=</varname> is set, then this setting is ignored.
95ab9eff 1393 Defaults to false.</para>
798d3a52
ZJS
1394 </listitem>
1395 </varlistentry>
7585baa0 1396 <varlistentry>
1397 <term><varname>Anonymize=</varname></term>
1398 <listitem>
9b6ffef3 1399 <para>Takes a boolean. When true, the options sent to the DHCP server will
7585baa0 1400 follow the <ulink url="https://tools.ietf.org/html/rfc7844">RFC 7844</ulink>
1401 (Anonymity Profiles for DHCP Clients) to minimize disclosure of identifying information.
1402 Defaults to false.</para>
1403
1404 <para>This option should only be set to true when
1405 <varname>MACAddressPolicy=</varname> is set to <literal>random</literal>
1406 (see <citerefentry
1407 project='man-pages'><refentrytitle>systemd.link</refentrytitle><manvolnum>5</manvolnum></citerefentry>).</para>
1408
1409 <para>Note that this configuration will overwrite others.
1410 In concrete, the following variables will be ignored:
1411 <varname>SendHostname=</varname>, <varname>ClientIdentifier=</varname>,
da2076a1
TK
1412 <varname>UseRoutes=</varname>, <varname>UseMTU=</varname>,
1413 <varname>VendorClassIdentifier=</varname>, <varname>UseTimezone=</varname>.</para>
fba10579
LP
1414
1415 <para>With this option enabled DHCP requests will mimic those generated by Microsoft Windows, in
1416 order to reduce the ability to fingerprint and recognize installations. This means DHCP request
1417 sizes will grow and lease data will be more comprehensive than normally, though most of the
1418 requested data is not actually used.</para>
7585baa0 1419 </listitem>
1420 </varlistentry>
798d3a52
ZJS
1421 <varlistentry>
1422 <term><varname>SendHostname=</varname></term>
1423 <listitem>
31ee3973
YW
1424 <para>When true (the default), the machine's hostname will be sent to the DHCP server.
1425 Note that the machine's hostname must consist only of 7-bit ASCII lower-case characters and
1426 no spaces or dots, and be formatted as a valid DNS domain name. Otherwise, the hostname is not
cad8d671 1427 sent even if this is set to true.</para>
798d3a52
ZJS
1428 </listitem>
1429 </varlistentry>
1430 <varlistentry>
1431 <term><varname>UseHostname=</varname></term>
1432 <listitem>
1433 <para>When true (the default), the hostname received from
31ee3973 1434 the DHCP server will be set as the transient hostname of the system.
d59be2cf 1435 </para>
798d3a52
ZJS
1436 </listitem>
1437 </varlistentry>
1adc5d0b 1438 <varlistentry>
31ee3973
YW
1439 <term><varname>Hostname=</varname></term>
1440 <listitem>
1441 <para>Use this value for the hostname which is sent to the DHCP server, instead of machine's hostname.
1442 Note that the specified hostname must consist only of 7-bit ASCII lower-case characters and
1443 no spaces or dots, and be formatted as a valid DNS domain name.</para>
1444 </listitem>
1445 </varlistentry>
798d3a52
ZJS
1446 <varlistentry>
1447 <term><varname>UseDomains=</varname></term>
1448 <listitem>
9b6ffef3 1449 <para>Takes a boolean, or the special value <literal>route</literal>. When true, the domain name
b2a81c0b
LP
1450 received from the DHCP server will be used as DNS search domain over this link, similar to the effect of
1451 the <option>Domains=</option> setting. If set to <literal>route</literal>, the domain name received from
1452 the DHCP server will be used for routing DNS queries only, but not for searching, similar to the effect of
1453 the <option>Domains=</option> setting when the argument is prefixed with <literal>~</literal>. Defaults to
1454 false.</para>
1455
1456 <para>It is recommended to enable this option only on trusted networks, as setting this affects resolution
1e7a0e21 1457 of all host names, in particular of single-label names. It is generally safer to use the supplied domain
b2a81c0b
LP
1458 only as routing domain, rather than as search domain, in order to not have it affect local resolution of
1459 single-label names.</para>
1460
1461 <para>When set to true, this setting corresponds to the <option>domain</option> option in <citerefentry
1462 project='man-pages'><refentrytitle>resolv.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para>
798d3a52
ZJS
1463 </listitem>
1464 </varlistentry>
1465 <varlistentry>
1466 <term><varname>UseRoutes=</varname></term>
1467 <listitem>
d6eac9bd
DW
1468 <para>When true (the default), the static routes will be requested from the DHCP server and added to the
1469 routing table with a metric of 1024, and a scope of "global", "link" or "host", depending on the route's
1470 destination and gateway. If the destination is on the local host, e.g., 127.x.x.x, or the same as the
1471 link's own address, the scope will be set to "host". Otherwise if the gateway is null (a direct route), a
1472 "link" scope will be used. For anything else, scope defaults to "global".</para>
798d3a52
ZJS
1473 </listitem>
1474 </varlistentry>
ad943783
LP
1475
1476 <varlistentry>
1477 <term><varname>UseTimezone=</varname></term>
1478
1479 <listitem><para>When true, the timezone received from the
7f3fdb7f 1480 DHCP server will be set as timezone of the local
ad943783
LP
1481 system. Defaults to <literal>no</literal>.</para></listitem>
1482 </varlistentry>
1483
3e43b2cd
JJ
1484 <varlistentry>
1485 <term><varname>ClientIdentifier=</varname></term>
1486 <listitem>
dace710c
YW
1487 <para>The DHCPv4 client identifier to use. Takes one of <literal>mac</literal>, <literal>duid</literal> or <literal>duid-only</literal>.
1488 If set to <literal>mac</literal>, the MAC address of the link is used.
1489 If set to <literal>duid</literal>, an RFC4361-compliant Client ID, which is the combination of IAID and DUID (see below), is used.
1490 If set to <literal>duid-only</literal>, only DUID is used, this may not be RFC compliant, but some setups may require to use this.
1491 Defaults to <literal>duid</literal>.</para>
3e43b2cd
JJ
1492 </listitem>
1493 </varlistentry>
e2e08e77 1494
798d3a52
ZJS
1495 <varlistentry>
1496 <term><varname>VendorClassIdentifier=</varname></term>
1497 <listitem>
1498 <para>The vendor class identifier used to identify vendor
1499 type and configuration.</para>
1500 </listitem>
1501 </varlistentry>
076ea6f6 1502
af1c0de0
SS
1503 <varlistentry>
1504 <term><varname>UserClass=</varname></term>
1505 <listitem>
1506 <para>A DHCPv4 client can use UserClass option to identify the type or category of user or applications
1507 it represents. The information contained in this option is a string that represents the user class of which
1508 the client is a member. Each class sets an identifying string of information to be used by the DHCP
1509 service to classify clients. Takes a whitespace-separated list of strings.</para>
1510 </listitem>
1511 </varlistentry>
1512
715cedfb
SS
1513 <varlistentry>
1514 <term><varname>MaxAttempts=</varname></term>
1515 <listitem>
1516 <para>Specifies how many times the DHCPv4 client configuration should be attempted. Takes a
1517 number or <literal>infinity</literal>. Defaults to <literal>infinity</literal>.
1518 Note that the time between retries is increased exponentially, so the network will not be
1519 overloaded even if this number is high.</para>
1520 </listitem>
1521 </varlistentry>
1522
e2e08e77
ZJS
1523 <varlistentry>
1524 <term><varname>DUIDType=</varname></term>
1525 <listitem>
1526 <para>Override the global <varname>DUIDType</varname> setting for this network. See
1527 <citerefentry><refentrytitle>networkd.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>
1528 for a description of possible values.</para>
1529 </listitem>
1530 </varlistentry>
076ea6f6 1531
e2e08e77
ZJS
1532 <varlistentry>
1533 <term><varname>DUIDRawData=</varname></term>
1534 <listitem>
1535 <para>Override the global <varname>DUIDRawData</varname> setting for this network. See
1536 <citerefentry><refentrytitle>networkd.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>
1537 for a description of possible values.</para>
076ea6f6
LP
1538 </listitem>
1539 </varlistentry>
e2e08e77 1540
d05def16
LP
1541 <varlistentry>
1542 <term><varname>IAID=</varname></term>
1543 <listitem>
1544 <para>The DHCP Identity Association Identifier (IAID) for the interface, a 32-bit unsigned integer.</para>
1545 </listitem>
1546 </varlistentry>
1547
798d3a52
ZJS
1548 <varlistentry>
1549 <term><varname>RequestBroadcast=</varname></term>
1550 <listitem>
1551 <para>Request the server to use broadcast messages before
1552 the IP address has been configured. This is necessary for
1553 devices that cannot receive RAW packets, or that cannot
1554 receive packets at all before an IP address has been
1555 configured. On the other hand, this must not be enabled on
1556 networks where broadcasts are filtered out.</para>
1557 </listitem>
1558 </varlistentry>
e2e08e77 1559
798d3a52
ZJS
1560 <varlistentry>
1561 <term><varname>RouteMetric=</varname></term>
1562 <listitem>
1563 <para>Set the routing metric for routes specified by the
1564 DHCP server.</para>
1565 </listitem>
1566 </varlistentry>
f594276b
JK
1567
1568 <varlistentry>
1569 <term><varname>RouteTable=<replaceable>num</replaceable></varname></term>
1570 <listitem>
d11e656a 1571 <para>The table identifier for DHCP routes (a number between 1 and 4294967295, or 0 to unset).
f594276b
JK
1572 The table can be retrieved using <command>ip route show table <replaceable>num</replaceable></command>.
1573 </para>
917b2260
AR
1574 <para>When used in combination with <varname>VRF=</varname> the
1575 VRF's routing table is used unless this parameter is specified.
1576 </para>
f594276b
JK
1577 </listitem>
1578 </varlistentry>
9faed222 1579
c695dcf9
SS
1580 <varlistentry>
1581 <term><varname>RouteMTUBytes=</varname></term>
1582 <listitem>
1583 <para>Specifies the MTU for the DHCP routes. Please see the [Route] section for further details.</para>
1584 </listitem>
1585 </varlistentry>
1586
9faed222
SS
1587 <varlistentry>
1588 <term><varname>ListenPort=</varname></term>
1589 <listitem>
1590 <para>Allow setting custom port for the DHCP client to listen on.</para>
1591 </listitem>
1592 </varlistentry>
fb5c8216 1593
1501b429
SS
1594 <varlistentry>
1595 <term><varname>SendRelease=</varname></term>
1596 <listitem>
1597 <para>When true, the DHCPv4 client sends a DHCP release packet when it stops.
5f3b5f19 1598 Defaults to true.</para>
1501b429
SS
1599 </listitem>
1600 </varlistentry>
1601
0f3ff4ea
SS
1602 <varlistentry>
1603 <term><varname>SendDecline=</varname></term>
1604 <listitem>
1605 <para>A boolen. When <literal>true</literal>, DHCPv4 clients receives IP address from DHCP server.
1606 After new IP is received, DHCPv4 performs IPv4 Duplicate Address Detection. If duplicate use of IP is detected
1607 the DHCPv4 client rejects the IP by sending a DHCPDECLINE packet DHCP clients try to obtain an IP address again.
1608 See <ulink url="https://tools.ietf.org/html/rfc5227">RFC 5224</ulink>.
1609 Defaults to <literal>unset</literal>.</para>
1610 </listitem>
1611 </varlistentry>
1612
caa8ca42 1613 <varlistentry>
5bc945be
SS
1614 <term><varname>BlackList=</varname></term>
1615 <listitem>
1616 <para>A whitespace-separated list of IPv4 addresses. DHCP offers from servers in the list are rejected.</para>
1617 </listitem>
1618 </varlistentry>
1619
1620 <varlistentry>
1621 <term><varname>RequestOptions=</varname></term>
caa8ca42 1622 <listitem>
5bc945be 1623 <para>A whitespace-separated list of integers in the range 1–254.</para>
caa8ca42
SS
1624 </listitem>
1625 </varlistentry>
1626
cb29c156 1627 <varlistentry>
864edb39 1628 <term><varname>SendOption=</varname></term>
cb29c156 1629 <listitem>
586ec936 1630 <para>Send an arbitrary option in the DHCPv4 request. Takes a DHCP option number, data type
d8b736bd
YW
1631 and data separated with a colon
1632 (<literal><replaceable>option</replaceable>:<replaceable>type</replaceable>:<replaceable>value</replaceable></literal>).
11fcfc53 1633 The option number must be an integer in the range 1..254. The type takes one of <literal>uint8</literal>,
d8b736bd
YW
1634 <literal>uint16</literal>, <literal>uint32</literal>, <literal>ipv4address</literal>, or
1635 <literal>string</literal>. Special characters in the data string may be escaped using
a2cc708a 1636 <ulink url="https://en.wikipedia.org/wiki/Escape_sequences_in_C#Table_of_escape_sequences">C-style
d8b736bd 1637 escapes</ulink>. This setting can be specified multiple times. If an empty string is specified,
a2cc708a 1638 then all options specified earlier are cleared. Defaults to unset.</para>
cb29c156
SS
1639 </listitem>
1640 </varlistentry>
caa8ca42
SS
1641 </variablelist>
1642 </refsect1>
1643
1644 <refsect1>
1645 <title>[DHCPv6] Section Options</title>
1646 <para>The <literal>[DHCPv6]</literal> section configures the DHCPv6 client, if it is enabled with the
4f7331a8 1647 <varname>DHCP=</varname> setting described above, or invoked by the IPv6 Router Advertisement:</para>
caa8ca42
SS
1648
1649 <variablelist class='network-directives'>
1650 <varlistentry>
1651 <term><varname>UseDNS=</varname></term>
1652 <term><varname>UseNTP=</varname></term>
1653 <listitem>
9fdae8d5 1654 <para>As in the <literal>[DHCPv4]</literal> section.</para>
caa8ca42
SS
1655 </listitem>
1656 </varlistentry>
1657
fb5c8216
SS
1658 <varlistentry>
1659 <term><varname>RapidCommit=</varname></term>
1660 <listitem>
9b6ffef3 1661 <para>Takes a boolean. The DHCPv6 client can obtain configuration parameters from a DHCPv6 server through
fb5c8216
SS
1662 a rapid two-message exchange (solicit and reply). When the rapid commit option is enabled by both
1663 the DHCPv6 client and the DHCPv6 server, the two-message exchange is used, rather than the default
1664 four-method exchange (solicit, advertise, request, and reply). The two-message exchange provides
1665 faster client configuration and is beneficial in environments in which networks are under a heavy load.
1666 See <ulink url="https://tools.ietf.org/html/rfc3315#section-17.2.1">RFC 3315</ulink> for details.
1667 Defaults to true.</para>
1668 </listitem>
1669 </varlistentry>
1670
125f20b4
PF
1671 <varlistentry>
1672 <term><varname>ForceDHCPv6PDOtherInformation=</varname></term>
1673 <listitem>
9b6ffef3 1674 <para>Takes a boolean that enforces DHCPv6 stateful mode when the 'Other information' bit is set in
125f20b4
PF
1675 Router Advertisement messages. By default setting only the 'O' bit in Router Advertisements
1676 makes DHCPv6 request network information in a stateless manner using a two-message Information
1677 Request and Information Reply message exchange.
1678 <ulink url="https://tools.ietf.org/html/rfc7084">RFC 7084</ulink>, requirement WPD-4, updates
1679 this behavior for a Customer Edge router so that stateful DHCPv6 Prefix Delegation is also
1680 requested when only the 'O' bit is set in Router Advertisements. This option enables such a CE
1681 behavior as it is impossible to automatically distinguish the intention of the 'O' bit otherwise.
1682 By default this option is set to 'false', enable it if no prefixes are delegated when the device
1683 should be acting as a CE router.</para>
1684 </listitem>
1685 </varlistentry>
1686
2805536b
SS
1687 <varlistentry>
1688 <term><varname>PrefixDelegationHint=</varname></term>
1689 <listitem>
48daf510 1690 <para>Takes an IPv6 address with prefix length as <varname>Address=</varname> in
2805536b
SS
1691 the "[Network]" section. Specifies the DHCPv6 client for the requesting router to include
1692 a prefix-hint in the DHCPv6 solicitation. Prefix ranges 1-128. Defaults to unset.</para>
1693 </listitem>
1694 </varlistentry>
ad943783 1695 </variablelist>
caa8ca42 1696 </refsect1>
413708d1 1697
1e7a0e21 1698 <refsect1>
f921f573
LP
1699 <title>[IPv6AcceptRA] Section Options</title>
1700 <para>The <literal>[IPv6AcceptRA]</literal> section configures the IPv6 Router Advertisement
1701 (RA) client, if it is enabled with the <varname>IPv6AcceptRA=</varname> setting described
1e7a0e21
LP
1702 above:</para>
1703
1704 <variablelist class='network-directives'>
1705 <varlistentry>
1706 <term><varname>UseDNS=</varname></term>
1707 <listitem>
1708 <para>When true (the default), the DNS servers received in the Router Advertisement will be used and take
1709 precedence over any statically configured ones.</para>
1710
1711 <para>This corresponds to the <option>nameserver</option> option in <citerefentry
1712 project='man-pages'><refentrytitle>resolv.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para>
1713 </listitem>
1714 </varlistentry>
1715
1716 <varlistentry>
1717 <term><varname>UseDomains=</varname></term>
1718 <listitem>
9b6ffef3 1719 <para>Takes a boolean, or the special value <literal>route</literal>. When true, the domain name
1e7a0e21
LP
1720 received via IPv6 Router Advertisement (RA) will be used as DNS search domain over this link, similar to
1721 the effect of the <option>Domains=</option> setting. If set to <literal>route</literal>, the domain name
1722 received via IPv6 RA will be used for routing DNS queries only, but not for searching, similar to the
1723 effect of the <option>Domains=</option> setting when the argument is prefixed with
1724 <literal>~</literal>. Defaults to false.</para>
1725
1726 <para>It is recommended to enable this option only on trusted networks, as setting this affects resolution
1727 of all host names, in particular of single-label names. It is generally safer to use the supplied domain
1728 only as routing domain, rather than as search domain, in order to not have it affect local resolution of
1729 single-label names.</para>
1730
1731 <para>When set to true, this setting corresponds to the <option>domain</option> option in <citerefentry
1732 project='man-pages'><refentrytitle>resolv.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para>
1733 </listitem>
1734 </varlistentry>
2ba31d29
JK
1735
1736 <varlistentry>
1737 <term><varname>RouteTable=<replaceable>num</replaceable></varname></term>
1738 <listitem>
d11e656a
ZJS
1739 <para>The table identifier for the routes received in the Router Advertisement
1740 (a number between 1 and 4294967295, or 0 to unset).
2ba31d29
JK
1741 The table can be retrieved using <command>ip route show table <replaceable>num</replaceable></command>.
1742 </para>
1743 </listitem>
1744 </varlistentry>
062c2eea
SS
1745
1746 <varlistentry>
1747 <term><varname>UseAutonomousPrefix=</varname></term>
1748 <listitem>
1749 <para>When true (the default), the autonomous prefix received in the Router Advertisement will be used and take
1750 precedence over any statically configured ones.</para>
1751 </listitem>
1752 </varlistentry>
1753
1754 <varlistentry>
1755 <term><varname>UseOnLinkPrefix=</varname></term>
1756 <listitem>
1757 <para>When true (the default), the onlink prefix received in the Router Advertisement will be used and take
1758 precedence over any statically configured ones.</para>
1759 </listitem>
1760 </varlistentry>
1761
e520ce64
SS
1762 <varlistentry>
1763 <term><varname>BlackList=</varname></term>
1764 <listitem>
1765 <para>A whitespace-separated list of IPv6 prefixes. IPv6 prefixes supplied via router advertisements in the list are ignored.</para>
1766 </listitem>
1767 </varlistentry>
1768
1e7a0e21
LP
1769 </variablelist>
1770 </refsect1>
1771
ad943783
LP
1772 <refsect1>
1773 <title>[DHCPServer] Section Options</title>
1774 <para>The <literal>[DHCPServer]</literal> section contains
1775 settings for the DHCP server, if enabled via the
1776 <varname>DHCPServer=</varname> option described above:</para>
1777
1778 <variablelist class='network-directives'>
1779
9b3a67c5
TG
1780 <varlistentry>
1781 <term><varname>PoolOffset=</varname></term>
1782 <term><varname>PoolSize=</varname></term>
1783
1784 <listitem><para>Configures the pool of addresses to hand out. The pool
1785 is a contiguous sequence of IP addresses in the subnet configured for
1786 the server address, which does not include the subnet nor the broadcast
1787 address. <varname>PoolOffset=</varname> takes the offset of the pool
1788 from the start of subnet, or zero to use the default value.
1789 <varname>PoolSize=</varname> takes the number of IP addresses in the
b938cb90 1790 pool or zero to use the default value. By default, the pool starts at
9b3a67c5
TG
1791 the first address after the subnet address and takes up the rest of
1792 the subnet, excluding the broadcast address. If the pool includes
1793 the server address (the default), this is reserved and not handed
1794 out to clients.</para></listitem>
1795 </varlistentry>
1796
ad943783
LP
1797 <varlistentry>
1798 <term><varname>DefaultLeaseTimeSec=</varname></term>
1799 <term><varname>MaxLeaseTimeSec=</varname></term>
1800
1801 <listitem><para>Control the default and maximum DHCP lease
1802 time to pass to clients. These settings take time values in seconds or
1803 another common time unit, depending on the suffix. The default
1804 lease time is used for clients that did not ask for a specific
1805 lease time. If a client asks for a lease time longer than the
b938cb90 1806 maximum lease time, it is automatically shortened to the
ad943783
LP
1807 specified time. The default lease time defaults to 1h, the
1808 maximum lease time to 12h. Shorter lease times are beneficial
1809 if the configuration data in DHCP leases changes frequently
1810 and clients shall learn the new settings with shorter
1811 latencies. Longer lease times reduce the generated DHCP
1812 network traffic.</para></listitem>
1813 </varlistentry>
1814
1815 <varlistentry>
1816 <term><varname>EmitDNS=</varname></term>
1817 <term><varname>DNS=</varname></term>
1818
9b6ffef3
YW
1819 <listitem><para>Takes a boolean. Configures whether the DHCP leases handed out
1820 to clients shall contain DNS server information. Defaults to <literal>yes</literal>.
1821 The DNS servers to pass to clients may be configured with the
ad943783
LP
1822 <varname>DNS=</varname> option, which takes a list of IPv4
1823 addresses. If the <varname>EmitDNS=</varname> option is
b938cb90 1824 enabled but no servers configured, the servers are
ad943783
LP
1825 automatically propagated from an "uplink" interface that has
1826 appropriate servers set. The "uplink" interface is determined
1827 by the default route of the system with the highest
1828 priority. Note that this information is acquired at the time
1829 the lease is handed out, and does not take uplink interfaces
1830 into account that acquire DNS or NTP server information at a
1831 later point. DNS server propagation does not take
1832 <filename>/etc/resolv.conf</filename> into account. Also, note
a8eaaee7 1833 that the leases are not refreshed if the uplink network
ad943783 1834 configuration changes. To ensure clients regularly acquire the
b938cb90 1835 most current uplink DNS server information, it is thus
ad943783
LP
1836 advisable to shorten the DHCP lease time via
1837 <varname>MaxLeaseTimeSec=</varname> described
1838 above.</para></listitem>
1839 </varlistentry>
1840
1841 <varlistentry>
1842 <term><varname>EmitNTP=</varname></term>
1843 <term><varname>NTP=</varname></term>
1844
1845 <listitem><para>Similar to the <varname>EmitDNS=</varname> and
b938cb90 1846 <varname>DNS=</varname> settings described above, these
ad943783
LP
1847 settings configure whether and what NTP server information
1848 shall be emitted as part of the DHCP lease. The same syntax,
1849 propagation semantics and defaults apply as for
1850 <varname>EmitDNS=</varname> and
1851 <varname>DNS=</varname>.</para></listitem>
1852 </varlistentry>
1853
299d578f
SS
1854 <varlistentry>
1855 <term><varname>EmitSIP=</varname></term>
1856 <term><varname>SIP=</varname></term>
1857
1858 <listitem><para>Similar to the <varname>EmitDNS=</varname> and
1859 <varname>DNS=</varname> settings described above, these
1860 settings configure whether and what SIP server information
1861 shall be emitted as part of the DHCP lease. The same syntax,
1862 propagation semantics and defaults apply as for
1863 <varname>EmitDNS=</varname> and
1864 <varname>DNS=</varname>.</para></listitem>
1865 </varlistentry>
1866
77ff6022
CG
1867 <varlistentry>
1868 <term><varname>EmitRouter=</varname></term>
1869
1870 <listitem><para>Similar to the <varname>EmitDNS=</varname>
1871 setting described above, this setting configures whether the
1872 DHCP lease should contain the router option. The same syntax,
1873 propagation semantics and defaults apply as for
1874 <varname>EmitDNS=</varname>.</para></listitem>
1875 </varlistentry>
1876
ad943783
LP
1877 <varlistentry>
1878 <term><varname>EmitTimezone=</varname></term>
1879 <term><varname>Timezone=</varname></term>
1880
9b6ffef3
YW
1881 <listitem><para>Takes a boolean. Configures whether the DHCP leases handed out
1882 to clients shall contain timezone information. Defaults to <literal>yes</literal>. The
ad943783
LP
1883 <varname>Timezone=</varname> setting takes a timezone string
1884 (such as <literal>Europe/Berlin</literal> or
1885 <literal>UTC</literal>) to pass to clients. If no explicit
b938cb90 1886 timezone is set, the system timezone of the local host is
ad943783
LP
1887 propagated, as determined by the
1888 <filename>/etc/localtime</filename> symlink.</para></listitem>
1889 </varlistentry>
1890
564ca984 1891 <varlistentry>
d8b736bd
YW
1892 <term><varname>SendOption=</varname></term>
1893 <listitem>
1894 <para>Send a raw option with value via DHCPv4 server. Takes a DHCP option number, data type
1895 and data (<literal><replaceable>option</replaceable>:<replaceable>type</replaceable>:<replaceable>value</replaceable></literal>).
1896 The option number is an integer in the range 1..254. The type takes one of <literal>uint8</literal>,
1897 <literal>uint16</literal>, <literal>uint32</literal>, <literal>ipv4address</literal>, or
1898 <literal>string</literal>. Special characters in the data string may be escaped using
1899 <ulink url="https://en.wikipedia.org/wiki/Escape_sequences_in_C#Table_of_escape_sequences">C-style
1900 escapes</ulink>. This setting can be specified multiple times. If an empty string is specified,
1901 then all options specified earlier are cleared. Defaults to unset.</para>
1902 </listitem>
564ca984
SS
1903 </varlistentry>
1904
ad943783
LP
1905 </variablelist>
1906 </refsect1>
1907
798d3a52 1908 <refsect1>
3f9e0236
PF
1909 <title>[IPv6PrefixDelegation] Section Options</title>
1910 <para>The <literal>[IPv6PrefixDelegation]</literal> section contains
1911 settings for sending IPv6 Router Advertisements and whether to act as
1912 a router, if enabled via the <varname>IPv6PrefixDelegation=</varname>
1913 option described above. IPv6 network prefixes are defined with one or
1914 more <literal>[IPv6Prefix]</literal> sections.</para>
1915
1916 <variablelist class='network-directives'>
1917
1918 <varlistentry>
1919 <term><varname>Managed=</varname></term>
1920 <term><varname>OtherInformation=</varname></term>
1921
9b6ffef3
YW
1922 <listitem><para>Takes a boolean. Controls whether a DHCPv6 server is used to acquire IPv6
1923 addresses on the network link when <varname>Managed=</varname>
3f9e0236
PF
1924 is set to <literal>true</literal> or if only additional network
1925 information can be obtained via DHCPv6 for the network link when
9b6ffef3 1926 <varname>OtherInformation=</varname> is set to
3f9e0236
PF
1927 <literal>true</literal>. Both settings default to
1928 <literal>false</literal>, which means that a DHCPv6 server is not being
1929 used.</para></listitem>
1930 </varlistentry>
1931
1932 <varlistentry>
1933 <term><varname>RouterLifetimeSec=</varname></term>
1934
9b6ffef3 1935 <listitem><para>Takes a timespan. Configures the IPv6 router lifetime in seconds. If set,
3f9e0236 1936 this host also announces itself in Router Advertisements as an IPv6
025314d9 1937 router for the network link. When unset, the host is not acting as a router.</para>
3f9e0236
PF
1938 </listitem>
1939 </varlistentry>
1940
1941 <varlistentry>
1942 <term><varname>RouterPreference=</varname></term>
1943
1944 <listitem><para>Configures IPv6 router preference if
1945 <varname>RouterLifetimeSec=</varname> is non-zero. Valid values are
1946 <literal>high</literal>, <literal>medium</literal> and
1947 <literal>low</literal>, with <literal>normal</literal> and
1948 <literal>default</literal> added as synonyms for
1949 <literal>medium</literal> just to make configuration easier. See
1950 <ulink url="https://tools.ietf.org/html/rfc4191">RFC 4191</ulink>
1951 for details. Defaults to <literal>medium</literal>.</para></listitem>
1952 </varlistentry>
1953
1954 <varlistentry>
4cb8478c 1955 <term><varname>EmitDNS=</varname></term>
3f9e0236
PF
1956 <term><varname>DNS=</varname></term>
1957
fd3ef936
YW
1958 <listitem><para><varname>DNS=</varname> specifies a list of recursive DNS server IPv6 addresses
1959 that are distributed via Router Advertisement messages when <varname>EmitDNS=</varname> is
1960 true. <varname>DNS=</varname> also takes special value <literal>_link_local</literal>; in that
1961 case the IPv6 link local address is distributed. If <varname>DNS=</varname> is empty, DNS
1962 servers are read from the <literal>[Network]</literal> section. If the
1963 <literal>[Network]</literal> section does not contain any DNS servers either, DNS servers from
1964 the uplink with the highest priority default route are used. When <varname>EmitDNS=</varname>
1965 is false, no DNS server information is sent in Router Advertisement messages.
4cb8478c 1966 <varname>EmitDNS=</varname> defaults to true.
3f9e0236
PF
1967 </para></listitem>
1968 </varlistentry>
1969
760021c0 1970 <varlistentry>
4cb8478c 1971 <term><varname>EmitDomains=</varname></term>
760021c0
PF
1972 <term><varname>Domains=</varname></term>
1973
4cb8478c
PF
1974 <listitem><para>A list of DNS search domains distributed via Router
1975 Advertisement messages when <varname>EmitDomains=</varname> is true. If
1976 <varname>Domains=</varname> is empty, DNS search domains are read from the
1977 <literal>[Network]</literal> section. If the <literal>[Network]</literal>
1978 section does not contain any DNS search domains either, DNS search
1979 domains from the uplink with the highest priority default route are
1980 used. When <varname>EmitDomains=</varname> is false, no DNS search domain
1981 information is sent in Router Advertisement messages.
1982 <varname>EmitDomains=</varname> defaults to true.
1983 </para></listitem>
760021c0
PF
1984 </varlistentry>
1985
3f9e0236
PF
1986 <varlistentry>
1987 <term><varname>DNSLifetimeSec=</varname></term>
1988
1989 <listitem><para>Lifetime in seconds for the DNS server addresses listed
760021c0
PF
1990 in <varname>DNS=</varname> and search domains listed in
1991 <varname>Domains=</varname>.</para></listitem>
3f9e0236
PF
1992 </varlistentry>
1993
1994 </variablelist>
1995 </refsect1>
1996
203d4df5 1997 <refsect1>
3f9e0236
PF
1998 <title>[IPv6Prefix] Section Options</title>
1999 <para>One or more <literal>[IPv6Prefix]</literal> sections contain the IPv6
2000 prefixes that are announced via Router Advertisements. See
2001 <ulink url="https://tools.ietf.org/html/rfc4861">RFC 4861</ulink>
2002 for further details.</para>
2003
2004 <variablelist class='network-directives'>
2005
2006 <varlistentry>
2007 <term><varname>AddressAutoconfiguration=</varname></term>
2008 <term><varname>OnLink=</varname></term>
2009
9b6ffef3 2010 <listitem><para>Takes a boolean to specify whether IPv6 addresses can be
3f9e0236
PF
2011 autoconfigured with this prefix and whether the prefix can be used for
2012 onlink determination. Both settings default to <literal>true</literal>
2013 in order to ease configuration.
2014 </para></listitem>
2015 </varlistentry>
2016
2017 <varlistentry>
2018 <term><varname>Prefix=</varname></term>
2019
2020 <listitem><para>The IPv6 prefix that is to be distributed to hosts.
2021 Similarly to configuring static IPv6 addresses, the setting is
2022 configured as an IPv6 prefix and its prefix length, separated by a
2023 <literal>/</literal> character. Use multiple
2024 <literal>[IPv6Prefix]</literal> sections to configure multiple IPv6
2025 prefixes since prefix lifetimes, address autoconfiguration and onlink
2026 status may differ from one prefix to another.</para></listitem>
2027 </varlistentry>
2028
2029 <varlistentry>
2030 <term><varname>PreferredLifetimeSec=</varname></term>
2031 <term><varname>ValidLifetimeSec=</varname></term>
2032
2033 <listitem><para>Preferred and valid lifetimes for the prefix measured in
2034 seconds. <varname>PreferredLifetimeSec=</varname> defaults to 604800
2035 seconds (one week) and <varname>ValidLifetimeSec=</varname> defaults
2036 to 2592000 seconds (30 days).</para></listitem>
203d4df5
SS
2037 </varlistentry>
2038
2039 </variablelist>
2040 </refsect1>
2041
2042 <refsect1>
2043 <title>[IPv6RoutePrefix] Section Options</title>
2044 <para>One or more <literal>[IPv6RoutePrefix]</literal> sections contain the IPv6
2045 prefix routes that are announced via Router Advertisements. See
2046 <ulink url="https://tools.ietf.org/html/rfc4191">RFC 4191</ulink>
2047 for further details.</para>
2048
2049 <variablelist class='network-directives'>
2050
2051 <varlistentry>
2052 <term><varname>Route=</varname></term>
2053
2054 <listitem><para>The IPv6 route that is to be distributed to hosts.
2055 Similarly to configuring static IPv6 routes, the setting is
2056 configured as an IPv6 prefix routes and its prefix route length,
2057 separated by a<literal>/</literal> character. Use multiple
2058 <literal>[IPv6PrefixRoutes]</literal> sections to configure multiple IPv6
2059 prefix routes.</para></listitem>
2060 </varlistentry>
2061
2062 <varlistentry>
2063 <term><varname>LifetimeSec=</varname></term>
2064
2065 <listitem><para>Lifetime for the route prefix measured in
2066 seconds. <varname>LifetimeSec=</varname> defaults to 604800 seconds (one week).
2067 </para></listitem>
3f9e0236
PF
2068 </varlistentry>
2069
2070 </variablelist>
2071 </refsect1>
2072
2073 <refsect1>
798d3a52
ZJS
2074 <title>[Bridge] Section Options</title>
2075 <para>The <literal>[Bridge]</literal> section accepts the
2076 following keys.</para>
2077 <variablelist class='network-directives'>
165c41a9
SS
2078 <varlistentry>
2079 <term><varname>UnicastFlood=</varname></term>
2080 <listitem>
9b6ffef3 2081 <para>Takes a boolean. Controls whether the bridge should flood
072f9e4a 2082 traffic for which an FDB entry is missing and the destination
025314d9 2083 is unknown through this port. When unset, the kernel's default will be used.
47c7dfe2 2084 </para>
165c41a9
SS
2085 </listitem>
2086 </varlistentry>
7f15b714
TJ
2087 <varlistentry>
2088 <term><varname>MulticastFlood=</varname></term>
2089 <listitem>
2090 <para>Takes a boolean. Controls whether the bridge should flood
2091 traffic for which an MDB entry is missing and the destination
2092 is unknown through this port. When unset, the kernel's default will be used.
2093 </para>
2094 </listitem>
2095 </varlistentry>
d3aa8b49
SS
2096 <varlistentry>
2097 <term><varname>MulticastToUnicast=</varname></term>
2098 <listitem>
2099 <para>Takes a boolean. Multicast to unicast works on top of the multicast snooping feature of
2100 the bridge. Which means unicast copies are only delivered to hosts which are interested in it.
2101 When unset, the kernel's default will be used.
2102 </para>
2103 </listitem>
2104 </varlistentry>
7f15b714
TJ
2105 <varlistentry>
2106 <term><varname>NeighborSuppression=</varname></term>
2107 <listitem>
2108 <para>Takes a boolean. Configures whether ARP and ND neighbor suppression is enabled for
2109 this port. When unset, the kernel's default will be used.
2110 </para>
2111 </listitem>
2112 </varlistentry>
2113 <varlistentry>
2114 <term><varname>Learning=</varname></term>
2115 <listitem>
2116 <para>Takes a boolean. Configures whether MAC address learning is enabled for
2117 this port. When unset, the kernel's default will be used.
2118 </para>
2119 </listitem>
2120 </varlistentry>
165c41a9
SS
2121 <varlistentry>
2122 <term><varname>HairPin=</varname></term>
2123 <listitem>
9b6ffef3 2124 <para>Takes a boolean. Configures whether traffic may be sent back
025314d9
YW
2125 out of the port on which it was received. When this flag is false, and the bridge
2126 will not forward traffic back out of the receiving port.
2127 When unset, the kernel's default will be used.</para>
165c41a9
SS
2128 </listitem>
2129 </varlistentry>
2130 <varlistentry>
84c34096 2131 <term><varname>UseBPDU=</varname></term>
165c41a9 2132 <listitem>
9b6ffef3 2133 <para>Takes a boolean. Configures whether STP Bridge Protocol Data Units will be
025314d9 2134 processed by the bridge port. When unset, the kernel's default will be used.</para>
165c41a9
SS
2135 </listitem>
2136 </varlistentry>
2137 <varlistentry>
2138 <term><varname>FastLeave=</varname></term>
2139 <listitem>
9b6ffef3 2140 <para>Takes a boolean. This flag allows the bridge to immediately stop multicast
a8eaaee7 2141 traffic on a port that receives an IGMP Leave message. It is only used with
025314d9 2142 IGMP snooping if enabled on the bridge. When unset, the kernel's default will be used.</para>
165c41a9
SS
2143 </listitem>
2144 </varlistentry>
2145 <varlistentry>
23da66bb 2146 <term><varname>AllowPortToBeRoot=</varname></term>
165c41a9 2147 <listitem>
9b6ffef3 2148 <para>Takes a boolean. Configures whether a given port is allowed to
47c7dfe2 2149 become a root port. Only used when STP is enabled on the bridge.
025314d9 2150 When unset, the kernel's default will be used.</para>
165c41a9
SS
2151 </listitem>
2152 </varlistentry>
1087623b
SS
2153 <varlistentry>
2154 <term><varname>ProxyARP=</varname></term>
2155 <listitem>
2156 <para>Takes a boolean. Configures whether proxy ARP to be enabled on this port.
2157 When unset, the kernel's default will be used.</para>
2158 </listitem>
2159 </varlistentry>
2160 <varlistentry>
2161 <term><varname>ProxyARPWiFi=</varname></term>
2162 <listitem>
2163 <para>Takes a boolean. Configures whether proxy ARP to be enabled on this port
2164 which meets extended requirements by IEEE 802.11 and Hotspot 2.0 specifications.
2165 When unset, the kernel's default will be used.</para>
2166 </listitem>
2167 </varlistentry>
0fadb2a4
SS
2168 <varlistentry>
2169 <term><varname>MulticastRouter=</varname></term>
2170 <listitem>
2171 <para>Configures this port for having multicast routers attached. A port with a multicast
2172 router will receive all multicast traffic. Takes one of <literal>no</literal>
2173 to disable multicast routers on this port, <literal>query</literal> to let the system detect
2174 the presence of routers, <literal>permanent</literal> to permanently enable multicast traffic
2175 forwarding on this port, or <literal>temporary</literal> to enable multicast routers temporarily
2176 on this port, not depending on incoming queries. When unset, the kernel's default will be used.</para>
2177 </listitem>
2178 </varlistentry>
798d3a52
ZJS
2179 <varlistentry>
2180 <term><varname>Cost=</varname></term>
2181 <listitem>
47c7dfe2 2182 <para>Sets the "cost" of sending packets of this interface.
a8eaaee7 2183 Each port in a bridge may have a different speed and the cost
798d3a52 2184 is used to decide which link to use. Faster interfaces
785889e5 2185 should have lower costs. It is an integer value between 1 and
b56be296
DJL
2186 65535.</para>
2187 </listitem>
2188 </varlistentry>
2189 <varlistentry>
2190 <term><varname>Priority=</varname></term>
2191 <listitem>
2192 <para>Sets the "priority" of sending packets on this interface.
2193 Each port in a bridge may have a different priority which is used
2194 to decide which link to use. Lower value means higher priority.
785889e5 2195 It is an integer value between 0 to 63. Networkd does not set any
b56be296 2196 default, meaning the kernel default value of 32 is used.</para>
798d3a52
ZJS
2197 </listitem>
2198 </varlistentry>
2199 </variablelist>
2200 </refsect1>
798d3a52
ZJS
2201 <refsect1>
2202 <title>[BridgeFDB] Section Options</title>
2203 <para>The <literal>[BridgeFDB]</literal> section manages the
2204 forwarding database table of a port and accepts the following
2205 keys. Specify several <literal>[BridgeFDB]</literal> sections to
2206 configure several static MAC table entries.</para>
2207
2208 <variablelist class='network-directives'>
2209 <varlistentry>
2210 <term><varname>MACAddress=</varname></term>
2211 <listitem>
2212 <para>As in the <literal>[Network]</literal> section. This
2213 key is mandatory.</para>
2214 </listitem>
2215 </varlistentry>
c2c2793f
SS
2216 <varlistentry>
2217 <term><varname>Destination=</varname></term>
2218 <listitem>
2219 <para>Takes an IP address of the destination VXLAN tunnel endpoint.</para>
2220 </listitem>
2221 </varlistentry>
798d3a52
ZJS
2222 <varlistentry>
2223 <term><varname>VLANId=</varname></term>
2224 <listitem>
a8eaaee7 2225 <para>The VLAN ID for the new static MAC table entry. If
db9b9fb9 2226 omitted, no VLAN ID information is appended to the new static MAC
798d3a52
ZJS
2227 table entry.</para>
2228 </listitem>
2229 </varlistentry>
61b824c5
SS
2230 <varlistentry>
2231 <term><varname>VNI=</varname></term>
2232 <listitem>
2233 <para>The VXLAN Network Identifier (or VXLAN Segment ID) to use to connect to
2234 the remote VXLAN tunnel endpoint. Takes a number in the range 1-16777215.
2235 Defaults to unset.</para>
2236 </listitem>
2237 </varlistentry>
bdb397ed
SS
2238 <varlistentry>
2239 <term><varname>AssociatedWith=</varname></term>
2240 <listitem>
2241 <para>Specifies where the address is associated with. Takes one of <literal>use</literal>,
2242 <literal>self</literal>, <literal>master</literal> or <literal>router</literal>.
2243 <literal>use</literal> means the address is in use. User space can use this option to
2244 indicate to the kernel that the fdb entry is in use. <literal>self</literal> means
2245 the address is associated with the port drivers fdb. Usually hardware. <literal>master</literal>
2246 means the address is associated with master devices fdb. <literal>router</literal> means
2247 the destination address is associated with a router. Note that it's valid if the referenced
2248 device is a VXLAN type device and has route shortcircuit enabled. Defaults to <literal>self</literal>.</para>
2249 </listitem>
2250 </varlistentry>
798d3a52
ZJS
2251 </variablelist>
2252 </refsect1>
06828bb6
HP
2253
2254 <refsect1>
2255 <title>[CAN] Section Options</title>
2256 <para>The <literal>[CAN]</literal> section manages the Controller Area Network (CAN bus) and accepts the
2257 following keys.</para>
2258 <variablelist class='network-directives'>
2259 <varlistentry>
2260 <term><varname>BitRate=</varname></term>
2261 <listitem>
2262 <para>The bitrate of CAN device in bits per second. The usual SI prefixes (K, M) with the base of 1000 can
2263 be used here.</para>
2264 </listitem>
2265 </varlistentry>
2266 <varlistentry>
2267 <term><varname>SamplePoint=</varname></term>
2268 <listitem>
2269 <para>Optional sample point in percent with one decimal (e.g. <literal>75%</literal>,
2270 <literal>87.5%</literal>) or permille (e.g. <literal>875‰</literal>).</para>
2271 </listitem>
2272 </varlistentry>
2273 <varlistentry>
2274 <term><varname>RestartSec=</varname></term>
2275 <listitem>
2276 <para>Automatic restart delay time. If set to a non-zero value, a restart of the CAN controller will be
2277 triggered automatically in case of a bus-off condition after the specified delay time. Subsecond delays can
2278 be specified using decimals (e.g. <literal>0.1s</literal>) or a <literal>ms</literal> or
2279 <literal>us</literal> postfix. Using <literal>infinity</literal> or <literal>0</literal> will turn the
2280 automatic restart off. By default automatic restart is disabled.</para>
2281 </listitem>
2282 </varlistentry>
c423be28
CG
2283 <varlistentry>
2284 <term><varname>TripleSampling=</varname></term>
2285 <listitem>
2286 <para>Takes a boolean. When <literal>yes</literal>, three samples (instead of one) are used to determine
2287 the value of a received bit by majority rule. When unset, the kernel's default will be used.</para>
2288 </listitem>
2289 </varlistentry>
06828bb6
HP
2290 </variablelist>
2291 </refsect1>
2292
2ed5f6d5
YW
2293 <refsect1>
2294 <title>[QDisc] Section Options</title>
2295 <para>The <literal>[QDisc]</literal> section manages the traffic control queueing discipline (qdisc).</para>
2296
2297 <variablelist class='network-directives'>
2298 <varlistentry>
2299 <term><varname>Parent=</varname></term>
2300 <listitem>
2301 <para>Specifies the parent Queueing Discipline (qdisc). Takes one of <literal>clsact</literal>
2302 or <literal>ingress</literal>. This is mandatory.</para>
2303 </listitem>
2304 </varlistentry>
d8b2396d
SS
2305
2306 <varlistentry>
2307 <term><varname>Handle=</varname></term>
2308 <listitem>
2309 <para>Specifies the major number of unique identifier of the qdisc, known as the handle.
2310 Takes a number in hexadecimal ranges 1 to ffff. Defaults to unset.</para>
2311 </listitem>
2312 </varlistentry>
2ed5f6d5
YW
2313 </variablelist>
2314 </refsect1>
2315
0f5bd7fe 2316 <refsect1>
18de0969
YW
2317 <title>[NetworkEmulator] Section Options</title>
2318 <para>The <literal>[NetworkEmulator]</literal> section manages the queueing discipline (qdisc) of
2319 the network emulator. It can be used to configure the kernel packet scheduler and simulate packet
2320 delay and loss for UDP or TCP applications, or limit the bandwidth usage of a particular service to
2321 simulate internet connections.</para>
0f5bd7fe
SS
2322
2323 <variablelist class='network-directives'>
2324 <varlistentry>
2325 <term><varname>Parent=</varname></term>
2326 <listitem>
d8081020
SS
2327 <para>Specifies the parent Queueing Discipline (qdisc). Takes one of <literal>root</literal>,
2328 <literal>clsact</literal> or <literal>ingress</literal>. Defaults to <literal>root</literal>.</para>
0f5bd7fe
SS
2329 </listitem>
2330 </varlistentry>
2331
d8b2396d
SS
2332 <varlistentry>
2333 <term><varname>Handle=</varname></term>
2334 <listitem>
2335 <para>Specifies the major number of unique identifier of the qdisc, known as the handle.
2336 Takes a number in hexadecimal ranges 1 to ffff. Defaults to unset.</para>
2337 </listitem>
2338 </varlistentry>
2339
0f5bd7fe 2340 <varlistentry>
18de0969 2341 <term><varname>DelaySec=</varname></term>
0f5bd7fe
SS
2342 <listitem>
2343 <para>Specifies the fixed amount of delay to be added to all packets going out of the
2344 interface. Defaults to unset.</para>
2345 </listitem>
2346 </varlistentry>
2347
2348 <varlistentry>
18de0969 2349 <term><varname>DelayJitterSec=</varname></term>
0f5bd7fe
SS
2350 <listitem>
2351 <para>Specifies the chosen delay to be added to the packets outgoing to the network
2352 interface. Defaults to unset.</para>
2353 </listitem>
2354 </varlistentry>
2355
2356 <varlistentry>
18de0969 2357 <term><varname>PacketLimit=</varname></term>
0f5bd7fe
SS
2358 <listitem>
2359 <para>Specifies the maximum number of packets the qdisc may hold queued at a time.
2360 An unsigned integer ranges 0 to 4294967294. Defaults to 1000.</para>
2361 </listitem>
2362 </varlistentry>
2363
2364 <varlistentry>
18de0969 2365 <term><varname>LossRate=</varname></term>
0f5bd7fe
SS
2366 <listitem>
2367 <para>Specifies an independent loss probability to be added to the packets outgoing from the
2368 network interface. Takes a percentage value, suffixed with "%". Defaults to unset.</para>
2369 </listitem>
2370 </varlistentry>
2371
b9c5aa3c 2372 <varlistentry>
18de0969 2373 <term><varname>DuplicateRate=</varname></term>
b9c5aa3c
SS
2374 <listitem>
2375 <para>Specifies that the chosen percent of packets is duplicated before queuing them.
2376 Takes a percentage value, suffixed with "%". Defaults to unset.</para>
2377 </listitem>
2378 </varlistentry>
18de0969
YW
2379 </variablelist>
2380 </refsect1>
b9c5aa3c 2381
18de0969 2382 <refsect1>
60ed2dcf
ZJS
2383 <title>[TokenBucketFilter] Section Options</title>
2384 <para>The <literal>[TokenBucketFilter]</literal> section manages the queueing discipline (qdisc) of
2385 token bucket filter (tbf).</para>
18de0969
YW
2386
2387 <variablelist class='network-directives'>
ba5841b5 2388 <varlistentry>
18de0969
YW
2389 <term><varname>Parent=</varname></term>
2390 <listitem>
2391 <para>Specifies the parent Queueing Discipline (qdisc). Takes one of <literal>root</literal>,
2392 <literal>clsact</literal> or <literal>ingress</literal>. Defaults to <literal>root</literal>.</para>
2393 </listitem>
2394 </varlistentry>
2395
d8b2396d
SS
2396 <varlistentry>
2397 <term><varname>Handle=</varname></term>
2398 <listitem>
2399 <para>Specifies the major number of unique identifier of the qdisc, known as the handle.
2400 Takes a number in hexadecimal ranges 1 to ffff. Defaults to unset.</para>
2401 </listitem>
2402 </varlistentry>
2403
18de0969
YW
2404 <varlistentry>
2405 <term><varname>LatencySec=</varname></term>
ba5841b5
SS
2406 <listitem>
2407 <para>Specifies the latency parameter, which specifies the maximum amount of time a
60ed2dcf 2408 packet can sit in the Token Bucket Filter (TBF). Defaults to unset.</para>
ba5841b5
SS
2409 </listitem>
2410 </varlistentry>
2411
dcfc23ae 2412 <varlistentry>
18de0969 2413 <term><varname>LimitSize=</varname></term>
dcfc23ae
YW
2414 <listitem>
2415 <para>Takes the number of bytes that can be queued waiting for tokens to become available.
2416 When the size is suffixed with K, M, or G, it is parsed as Kilobytes, Megabytes, or Gigabytes,
2417 respectively, to the base of 1000. Defaults to unset.</para>
2418 </listitem>
2419 </varlistentry>
2420
ba5841b5 2421 <varlistentry>
18de0969 2422 <term><varname>Burst=</varname></term>
ba5841b5
SS
2423 <listitem>
2424 <para>Specifies the size of the bucket. This is the maximum amount of bytes that tokens
2425 can be available for instantaneous transfer. When the size is suffixed with K, M, or G, it is
2426 parsed as Kilobytes, Megabytes, or Gigabytes, respectively, to the base of 1000. Defaults to
2427 unset.</para>
2428 </listitem>
2429 </varlistentry>
2430
2431 <varlistentry>
18de0969 2432 <term><varname>Rate=</varname></term>
ba5841b5
SS
2433 <listitem>
2434 <para>Specifies the device specific bandwidth. When suffixed with K, M, or G, the specified
6b8fe4c3 2435 bandwidth is parsed as Kilobits, Megabits, or Gigabits, respectively, to the base of 1000.
ba5841b5
SS
2436 Defaults to unset.</para>
2437 </listitem>
2438 </varlistentry>
2439
dcfc23ae 2440 <varlistentry>
18de0969 2441 <term><varname>MPUBytes=</varname></term>
dcfc23ae
YW
2442 <listitem>
2443 <para>The Minimum Packet Unit (MPU) determines the minimal token usage (specified in bytes)
2444 for a packet. When suffixed with K, M, or G, the specified size is parsed as Kilobytes,
2445 Megabytes, or Gigabytes, respectively, to the base of 1000. Defaults to zero.</para>
2446 </listitem>
2447 </varlistentry>
2448
2449 <varlistentry>
18de0969 2450 <term><varname>PeakRate=</varname></term>
dcfc23ae
YW
2451 <listitem>
2452 <para>Takes the maximum depletion rate of the bucket. When suffixed with K, M, or G, the
6b8fe4c3 2453 specified size is parsed as Kilobits, Megabits, or Gigabits, respectively, to the base of
dcfc23ae
YW
2454 1000. Defaults to unset.</para>
2455 </listitem>
2456 </varlistentry>
2457
2458 <varlistentry>
18de0969 2459 <term><varname>MTUBytes=</varname></term>
dcfc23ae
YW
2460 <listitem>
2461 <para>Specifies the size of the peakrate bucket. When suffixed with K, M, or G, the specified
2462 size is parsed as Kilobytes, Megabytes, or Gigabytes, respectively, to the base of 1000.
2463 Defaults to unset.</para>
2464 </listitem>
2465 </varlistentry>
18de0969
YW
2466 </variablelist>
2467 </refsect1>
2468
2469 <refsect1>
2470 <title>[StochasticFairnessQueueing] Section Options</title>
2471 <para>The <literal>[StochasticFairnessQueueing]</literal> section manages the queueing discipline
2472 (qdisc) of stochastic fairness queueing (sfq).</para>
2473
2474 <variablelist class='network-directives'>
2475 <varlistentry>
2476 <term><varname>Parent=</varname></term>
2477 <listitem>
2478 <para>Specifies the parent Queueing Discipline (qdisc). Takes one of <literal>root</literal>,
2479 <literal>clsact</literal> or <literal>ingress</literal>. Defaults to <literal>root</literal>.</para>
2480 </listitem>
2481 </varlistentry>
dcfc23ae 2482
d8b2396d
SS
2483 <varlistentry>
2484 <term><varname>Handle=</varname></term>
2485 <listitem>
2486 <para>Specifies the major number of unique identifier of the qdisc, known as the handle.
2487 Takes a number in hexadecimal ranges 1 to ffff. Defaults to unset.</para>
2488 </listitem>
2489 </varlistentry>
2490
9942b710 2491 <varlistentry>
18de0969 2492 <term><varname>PerturbPeriodSec=</varname></term>
9942b710
SS
2493 <listitem>
2494 <para>Specifies the interval in seconds for queue algorithm perturbation. Defaults to unset.</para>
2495 </listitem>
2496 </varlistentry>
18de0969
YW
2497 </variablelist>
2498 </refsect1>
2499
2500 <refsect1>
2501 <title>[ControlledDelay] Section Options</title>
2502 <para>The <literal>[ControlledDelay]</literal> section manages the queueing discipline (qdisc) of
2503 controlled delay (CoDel).</para>
9942b710 2504
18de0969 2505 <variablelist class='network-directives'>
a9a5d632 2506 <varlistentry>
18de0969
YW
2507 <term><varname>Parent=</varname></term>
2508 <listitem>
2509 <para>Specifies the parent Queueing Discipline (qdisc). Takes one of <literal>root</literal>,
2510 <literal>clsact</literal> or <literal>ingress</literal>. Defaults to <literal>root</literal>.</para>
2511 </listitem>
2512 </varlistentry>
2513
d8b2396d
SS
2514 <varlistentry>
2515 <term><varname>Handle=</varname></term>
2516 <listitem>
2517 <para>Specifies the major number of unique identifier of the qdisc, known as the handle.
2518 Takes a number in hexadecimal ranges 1 to ffff. Defaults to unset.</para>
2519 </listitem>
2520 </varlistentry>
2521
18de0969
YW
2522 <varlistentry>
2523 <term><varname>PacketLimit=</varname></term>
a9a5d632 2524 <listitem>
2cd65106 2525 <para>Specifies the hard limit on the queue size in number of packets. When this limit is reached, incoming packets are
a9a5d632
SS
2526 dropped. An unsigned integer ranges 0 to 4294967294. Defaults to unset and kernel's default is used.</para>
2527 </listitem>
2528 </varlistentry>
2529
b078e528 2530 <varlistentry>
18de0969 2531 <term><varname>TargetSec=</varname></term>
b078e528
YW
2532 <listitem>
2533 <para>Takes a timespan. Specifies the acceptable minimum standing/persistent queue delay.
2534 Defaults to unset and kernel's default is used.</para>
2535 </listitem>
2536 </varlistentry>
2537
2538 <varlistentry>
18de0969 2539 <term><varname>IntervalSec=</varname></term>
b078e528
YW
2540 <listitem>
2541 <para>Takes a timespan. This is used to ensure that the measured minimum delay does not
2542 become too stale. Defaults to unset and kernel's default is used.</para>
2543 </listitem>
2544 </varlistentry>
2545
2546 <varlistentry>
18de0969 2547 <term><varname>ECN=</varname></term>
b078e528
YW
2548 <listitem>
2549 <para>Takes a boolean. This can be used to mark packets instead of dropping them. Defaults to
2550 unset and kernel's default is used.</para>
2551 </listitem>
2552 </varlistentry>
2553
2554 <varlistentry>
18de0969 2555 <term><varname>CEThresholdSec=</varname></term>
b078e528
YW
2556 <listitem>
2557 <para>Takes a timespan. This sets a threshold above which all packets are marked with ECN
2558 Congestion Experienced (CE). Defaults to unset and kernel's default is used.</para>
2559 </listitem>
2560 </varlistentry>
18de0969
YW
2561 </variablelist>
2562 </refsect1>
b078e528 2563
18de0969
YW
2564 <refsect1>
2565 <title>[FairQueueingControlledDelay] Section Options</title>
2566 <para>The <literal>[FairQueueingControlledDelay]</literal> section manages the queueing discipline
2567 (qdisc) of fair queuing controlled delay (FQ-CoDel).</para>
2568
2569 <variablelist class='network-directives'>
4e5ef149 2570 <varlistentry>
18de0969
YW
2571 <term><varname>Parent=</varname></term>
2572 <listitem>
2573 <para>Specifies the parent Queueing Discipline (qdisc). Takes one of <literal>root</literal>,
2574 <literal>clsact</literal> or <literal>ingress</literal>. Defaults to <literal>root</literal>.</para>
2575 </listitem>
2576 </varlistentry>
2577
d8b2396d
SS
2578 <varlistentry>
2579 <term><varname>Handle=</varname></term>
2580 <listitem>
2581 <para>Specifies the major number of unique identifier of the qdisc, known as the handle.
2582 Takes a number in hexadecimal ranges 1 to ffff. Defaults to unset.</para>
2583 </listitem>
2584 </varlistentry>
2585
18de0969
YW
2586 <varlistentry>
2587 <term><varname>PacketLimit=</varname></term>
4e5ef149
SS
2588 <listitem>
2589 <para>Specifies the hard limit on the real queue size. When this limit is reached, incoming packets are
2590 dropped. Defaults to unset and kernel's default is used.</para>
2591 </listitem>
2592 </varlistentry>
2593
ac810b75 2594 <varlistentry>
18de0969 2595 <term><varname>MemoryLimit=</varname></term>
ac810b75
YW
2596 <listitem>
2597 <para>Specifies the limit on the total number of bytes that can be queued in this FQ-CoDel instance.
2598 When suffixed with K, M, or G, the specified size is parsed as Kilobytes, Megabytes, or Gigabytes,
2599 respectively, to the base of 1024. Defaults to unset and kernel's default is used.</para>
2600 </listitem>
2601 </varlistentry>
2602
2603 <varlistentry>
18de0969 2604 <term><varname>Flows=</varname></term>
ac810b75
YW
2605 <listitem>
2606 <para>Specifies the number of flows into which the incoming packets are classified.
2607 Defaults to unset and kernel's default is used.</para>
2608 </listitem>
2609 </varlistentry>
2610
2611 <varlistentry>
18de0969 2612 <term><varname>TargetSec=</varname></term>
ac810b75
YW
2613 <listitem>
2614 <para>Takes a timespan. Specifies the acceptable minimum standing/persistent queue delay.
2615 Defaults to unset and kernel's default is used.</para>
2616 </listitem>
2617 </varlistentry>
2618
2619 <varlistentry>
18de0969 2620 <term><varname>IntervalSec=</varname></term>
ac810b75
YW
2621 <listitem>
2622 <para>Takes a timespan. This is used to ensure that the measured minimum delay does not
2623 become too stale. Defaults to unset and kernel's default is used.</para>
2624 </listitem>
2625 </varlistentry>
2626
2627 <varlistentry>
18de0969 2628 <term><varname>Quantum=</varname></term>
ac810b75
YW
2629 <listitem>
2630 <para>Specifies the number of bytes used as 'deficit' in the fair queuing algorithmtimespan.
2631 When suffixed with K, M, or G, the specified size is parsed as Kilobytes, Megabytes, or Gigabytes,
2632 respectively, to the base of 1024. Defaults to unset and kernel's default is used.</para>
2633 </listitem>
2634 </varlistentry>
2635
2636 <varlistentry>
18de0969 2637 <term><varname>ECN=</varname></term>
ac810b75
YW
2638 <listitem>
2639 <para>Takes a boolean. This can be used to mark packets instead of dropping them. Defaults to
2640 unset and kernel's default is used.</para>
2641 </listitem>
2642 </varlistentry>
2643
2644 <varlistentry>
18de0969 2645 <term><varname>CEThresholdSec=</varname></term>
ac810b75
YW
2646 <listitem>
2647 <para>Takes a timespan. This sets a threshold above which all packets are marked with ECN
2648 Congestion Experienced (CE). Defaults to unset and kernel's default is used.</para>
2649 </listitem>
2650 </varlistentry>
18de0969
YW
2651 </variablelist>
2652 </refsect1>
2653
2654 <refsect1>
ca58d00c
ZJS
2655 <title>[FairQueueing] Section Options</title>
2656 <para>The <literal>[FairQueueing]</literal> section manages the queueing discipline
18de0969
YW
2657 (qdisc) of fair queue traffic policing (FQ).</para>
2658
2659 <variablelist class='network-directives'>
2660 <varlistentry>
2661 <term><varname>Parent=</varname></term>
2662 <listitem>
2663 <para>Specifies the parent Queueing Discipline (qdisc). Takes one of <literal>root</literal>,
2664 <literal>clsact</literal> or <literal>ingress</literal>. Defaults to <literal>root</literal>.</para>
2665 </listitem>
2666 </varlistentry>
ac810b75 2667
d8b2396d
SS
2668 <varlistentry>
2669 <term><varname>Handle=</varname></term>
2670 <listitem>
2671 <para>Specifies the major number of unique identifier of the qdisc, known as the handle.
2672 Takes a number in hexadecimal ranges 1 to ffff. Defaults to unset.</para>
2673 </listitem>
2674 </varlistentry>
2675
7234b915 2676 <varlistentry>
18de0969 2677 <term><varname>PacketLimit=</varname></term>
7234b915
SS
2678 <listitem>
2679 <para>Specifies the hard limit on the real queue size. When this limit is reached, incoming packets are
2680 dropped. Defaults to unset and kernel's default is used.</para>
2681 </listitem>
2682 </varlistentry>
2683
e83562e5 2684 <varlistentry>
18de0969 2685 <term><varname>FlowLimit=</varname></term>
e83562e5
YW
2686 <listitem>
2687 <para>Specifies the hard limit on the maximum number of packets queued per flow. Defaults to
2688 unset and kernel's default is used.</para>
2689 </listitem>
2690 </varlistentry>
2691
2692 <varlistentry>
18de0969 2693 <term><varname>Quantum=</varname></term>
e83562e5
YW
2694 <listitem>
2695 <para>Specifies the credit per dequeue RR round, i.e. the amount of bytes a flow is allowed
2696 to dequeue at once. When suffixed with K, M, or G, the specified size is parsed as Kilobytes,
2697 Megabytes, or Gigabytes, respectively, to the base of 1024. Defaults to unset and kernel's
2698 default is used.</para>
2699 </listitem>
2700 </varlistentry>
2701
2702 <varlistentry>
18de0969 2703 <term><varname>InitialQuantum=</varname></term>
e83562e5
YW
2704 <listitem>
2705 <para>Specifies the initial sending rate credit, i.e. the amount of bytes a new flow is
2706 allowed to dequeue initially. When suffixed with K, M, or G, the specified size is parsed as
2707 Kilobytes, Megabytes, or Gigabytes, respectively, to the base of 1024. Defaults to unset and
2708 kernel's default is used.</para>
2709 </listitem>
2710 </varlistentry>
2711
2712 <varlistentry>
18de0969 2713 <term><varname>MaximumRate=</varname></term>
e83562e5
YW
2714 <listitem>
2715 <para>Specifies the maximum sending rate of a flow. When suffixed with K, M, or G, the
6b8fe4c3 2716 specified size is parsed as Kilobits, Megabits, or Gigabits, respectively, to the base of
e83562e5
YW
2717 1000. Defaults to unset and kernel's default is used.</para>
2718 </listitem>
2719 </varlistentry>
2720
2721 <varlistentry>
18de0969 2722 <term><varname>Buckets=</varname></term>
e83562e5
YW
2723 <listitem>
2724 <para>Specifies the size of the hash table used for flow lookups. Defaults to unset and
2725 kernel's default is used.</para>
2726 </listitem>
2727 </varlistentry>
2728
2729 <varlistentry>
18de0969 2730 <term><varname>OrphanMask=</varname></term>
e83562e5
YW
2731 <listitem>
2732 <para>Takes an unsigned integer. For packets not owned by a socket, fq is able to mask a part
2733 of hash and reduce number of buckets associated with the traffic. Defaults to unset and
2734 kernel's default is used.</para>
2735 </listitem>
2736 </varlistentry>
2737
2738 <varlistentry>
18de0969 2739 <term><varname>Pacing=</varname></term>
e83562e5
YW
2740 <listitem>
2741 <para>Takes a boolean, and enables or disables flow pacing. Defaults to unset and kernel's
2742 default is used.</para>
2743 </listitem>
2744 </varlistentry>
2745
2746 <varlistentry>
18de0969 2747 <term><varname>CEThresholdSec=</varname></term>
e83562e5
YW
2748 <listitem>
2749 <para>Takes a timespan. This sets a threshold above which all packets are marked with ECN
2750 Congestion Experienced (CE). Defaults to unset and kernel's default is used.</para>
2751 </listitem>
2752 </varlistentry>
0f5bd7fe
SS
2753 </variablelist>
2754 </refsect1>
2755
9b749c11
YW
2756 <refsect1>
2757 <title>[TrivialLinkEqualizer] Section Options</title>
2758 <para>The <literal>[TrivialLinkEqualizer]</literal> section manages the queueing discipline (qdisc) of
2759 trivial link equalizer (teql).</para>
2760
2761 <variablelist class='network-directives'>
2762 <varlistentry>
2763 <term><varname>Parent=</varname></term>
2764 <listitem>
2765 <para>Specifies the parent Queueing Discipline (qdisc). Takes one of <literal>root</literal>,
2766 <literal>clsact</literal> or <literal>ingress</literal>. Defaults to <literal>root</literal>.</para>
2767 </listitem>
2768 </varlistentry>
d8b2396d
SS
2769
2770 <varlistentry>
2771 <term><varname>Handle=</varname></term>
2772 <listitem>
2773 <para>Specifies the major number of unique identifier of the qdisc, known as the handle.
2774 Takes a number in hexadecimal ranges 1 to ffff. Defaults to unset.</para>
2775 </listitem>
2776 </varlistentry>
2777
9b749c11
YW
2778 <varlistentry>
2779 <term><varname>Id=</varname></term>
2780 <listitem>
2781 <para>Specifies the interface ID <literal>N</literal> of teql. Defaults to <literal>0</literal>.
2782 Note that when teql is used, currently, the module <constant>sch_teql</constant> with
2783 <constant>max_equalizers=N+1</constant> option must be loaded before
2784 <command>systemd-networkd</command> is started.</para>
2785 </listitem>
2786 </varlistentry>
2787 </variablelist>
2788 </refsect1>
2789
13b498f9
TJ
2790 <refsect1>
2791 <title>[BridgeVLAN] Section Options</title>
2792 <para>The <literal>[BridgeVLAN]</literal> section manages the VLAN ID configuration of a bridge port and accepts
2793 the following keys. Specify several <literal>[BridgeVLAN]</literal> sections to configure several VLAN entries.
2794 The <varname>VLANFiltering=</varname> option has to be enabled, see <literal>[Bridge]</literal> section in
2795 <citerefentry><refentrytitle>systemd.netdev</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para>
2796
2797 <variablelist class='network-directives'>
2798 <varlistentry>
2799 <term><varname>VLAN=</varname></term>
2800 <listitem>
2801 <para>The VLAN ID allowed on the port. This can be either a single ID or a range M-N. VLAN IDs are valid
2802 from 1 to 4094.</para>
2803 </listitem>
2804 </varlistentry>
2805 <varlistentry>
2806 <term><varname>EgressUntagged=</varname></term>
2807 <listitem>
2808 <para>The VLAN ID specified here will be used to untag frames on egress. Configuring
2809 <varname>EgressUntagged=</varname> implicates the use of <varname>VLAN=</varname> above and will enable the
2810 VLAN ID for ingress as well. This can be either a single ID or a range M-N.</para>
2811 </listitem>
2812 </varlistentry>
2813 <varlistentry>
2814 <term><varname>PVID=</varname></term>
2815 <listitem>
2816 <para>The Port VLAN ID specified here is assigned to all untagged frames at ingress.
2817 <varname>PVID=</varname> can be used only once. Configuring <varname>PVID=</varname> implicates the use of
2818 <varname>VLAN=</varname> above and will enable the VLAN ID for ingress as well.</para>
2819 </listitem>
2820 </varlistentry>
2821 </variablelist>
2822 </refsect1>
798d3a52
ZJS
2823
2824 <refsect1>
9e35b3de 2825 <title>Examples</title>
798d3a52 2826 <example>
9e35b3de 2827 <title>Static network configuration</title>
798d3a52 2828
9e35b3de
ZJS
2829 <programlisting># /etc/systemd/network/50-static.network
2830[Match]
eac684ef
TG
2831Name=enp2s0
2832
2833[Network]
2834Address=192.168.0.15/24
2835Gateway=192.168.0.1</programlisting>
9e35b3de
ZJS
2836
2837 <para>This brings interface <literal>enp2s0</literal> up with a static address. The
2838 specified gateway will be used for a default route.</para>
798d3a52 2839 </example>
eac684ef 2840
798d3a52 2841 <example>
9e35b3de 2842 <title>DHCP on ethernet links</title>
eac684ef 2843
9e35b3de
ZJS
2844 <programlisting># /etc/systemd/network/80-dhcp.network
2845[Match]
eac684ef
TG
2846Name=en*
2847
2848[Network]
9c8ca3f7 2849DHCP=yes</programlisting>
9e35b3de
ZJS
2850
2851 <para>This will enable DHCPv4 and DHCPv6 on all interfaces with names starting with
2852 <literal>en</literal> (i.e. ethernet interfaces).</para>
798d3a52 2853 </example>
eac684ef 2854
4c94a4c2 2855 <example>
2856 <title>IPv6 Prefix Delegation</title>
2857
2858 <programlisting># /etc/systemd/network/55-ipv6-pd-upstream.network
2859[Match]
2860Name=enp1s0
2861
2862[Network]
2863DHCP=ipv6</programlisting>
2864
2865 <programlisting># /etc/systemd/network/56-ipv6-pd-downstream.network
2866[Match]
2867Name=enp2s0
2868
2869[Network]
2870IPv6PrefixDelegation=dhcpv6</programlisting>
2871
2872 <para>This will enable IPv6 PD on the interface enp1s0 as an upstream interface where the
2873 DHCPv6 client is running and enp2s0 as a downstream interface where the prefix is delegated to.</para>
2874 </example>
2875
798d3a52 2876 <example>
9e35b3de 2877 <title>A bridge with two enslaved links</title>
f47c5c47 2878
9e35b3de
ZJS
2879 <programlisting># /etc/systemd/network/25-bridge-static.network
2880[Match]
f47c5c47 2881Name=bridge0
2882
2883[Network]
2884Address=192.168.0.15/24
2885Gateway=192.168.0.1
2886DNS=192.168.0.1</programlisting>
f47c5c47 2887
9e35b3de
ZJS
2888 <programlisting># /etc/systemd/network/25-bridge-slave-interface-1.network
2889[Match]
f47c5c47 2890Name=enp2s0
2891
2892[Network]
2893Bridge=bridge0</programlisting>
9e35b3de
ZJS
2894
2895 <programlisting># /etc/systemd/network/25-bridge-slave-interface-2.network
2896[Match]
2897Name=wlp3s0
2898
2899[Network]
2900Bridge=bridge0</programlisting>
2901
2902 <para>This creates a bridge and attaches devices <literal>enp2s0</literal> and
2903 <literal>wlp3s0</literal> to it. The bridge will have the specified static address
2904 and network assigned, and a default route via the specified gateway will be
2905 added. The specified DNS server will be added to the global list of DNS resolvers.
2906 </para>
13b498f9 2907 </example>
9e35b3de 2908
13b498f9 2909 <example>
9e35b3de 2910 <title></title>
13b498f9 2911
9e35b3de
ZJS
2912 <programlisting>
2913# /etc/systemd/network/20-bridge-slave-interface-vlan.network
2914[Match]
13b498f9
TJ
2915Name=enp2s0
2916
2917[Network]
2918Bridge=bridge0
2919
2920[BridgeVLAN]
2921VLAN=1-32
2922PVID=42
2923EgressUntagged=42
2924
2925[BridgeVLAN]
2926VLAN=100-200
2927
2928[BridgeVLAN]
2929EgressUntagged=300-400</programlisting>
0a8a0fad 2930
9e35b3de
ZJS
2931 <para>This overrides the configuration specified in the previous example for the
2932 interface <literal>enp2s0</literal>, and enables VLAN on that bridge port. VLAN IDs
2933 1-32, 42, 100-400 will be allowed. Packets tagged with VLAN IDs 42, 300-400 will be
2934 untagged when they leave on this interface. Untagged packets which arrive on this
2935 interface will be assigned VLAN ID 42.</para>
798d3a52 2936 </example>
0a8a0fad 2937
798d3a52 2938 <example>
9e35b3de 2939 <title>Various tunnels</title>
0a8a0fad 2940
9e35b3de
ZJS
2941 <programlisting>/etc/systemd/network/25-tunnels.network
2942[Match]
2943Name=ens1
0a8a0fad
TG
2944
2945[Network]
9e35b3de
ZJS
2946Tunnel=ipip-tun
2947Tunnel=sit-tun
2948Tunnel=gre-tun
2949Tunnel=vti-tun
2950 </programlisting>
2951
2952 <programlisting>/etc/systemd/network/25-tunnel-ipip.netdev
2953[NetDev]
2954Name=ipip-tun
2955Kind=ipip
2956 </programlisting>
2957
2958 <programlisting>/etc/systemd/network/25-tunnel-sit.netdev
2959[NetDev]
2960Name=sit-tun
2961Kind=sit
2962 </programlisting>
2963
2964 <programlisting>/etc/systemd/network/25-tunnel-gre.netdev
2965[NetDev]
2966Name=gre-tun
2967Kind=gre
2968 </programlisting>
2969
2970 <programlisting>/etc/systemd/network/25-tunnel-vti.netdev
2971[NetDev]
2972Name=vti-tun
2973Kind=vti
2974 </programlisting>
2975
2976 <para>This will bring interface <literal>ens1</literal> up and create an IPIP tunnel,
2977 a SIT tunnel, a GRE tunnel, and a VTI tunnel using it.</para>
798d3a52 2978 </example>
0a8a0fad 2979
798d3a52 2980 <example>
9e35b3de 2981 <title>A bond device</title>
0a8a0fad 2982
9e35b3de
ZJS
2983 <programlisting># /etc/systemd/network/30-bond1.network
2984[Match]
2985Name=bond1
0a8a0fad
TG
2986
2987[Network]
9e35b3de
ZJS
2988DHCP=ipv6
2989</programlisting>
0a8a0fad 2990
9e35b3de
ZJS
2991 <programlisting># /etc/systemd/network/30-bond1.netdev
2992[NetDev]
2993Name=bond1
2994Kind=bond
2995</programlisting>
0a8a0fad 2996
301a21a8 2997 <programlisting># /etc/systemd/network/30-bond1-dev1.network
9e35b3de
ZJS
2998[Match]
2999MACAddress=52:54:00:e9:64:41
0a8a0fad
TG
3000
3001[Network]
9e35b3de
ZJS
3002Bond=bond1
3003</programlisting>
d94facdc 3004
301a21a8 3005 <programlisting># /etc/systemd/network/30-bond1-dev2.network
9e35b3de
ZJS
3006[Match]
3007MACAddress=52:54:00:e9:64:42
d94facdc
MH
3008
3009[Network]
9e35b3de 3010Bond=bond1
6cb955c6 3011</programlisting>
9e35b3de
ZJS
3012
3013 <para>This will create a bond device <literal>bond1</literal> and enslave the two
3014 devices with MAC addresses 52:54:00:e9:64:41 and 52:54:00:e9:64:42 to it. IPv6 DHCP
3015 will be used to acquire an address.</para>
6cb955c6
AR
3016 </example>
3017
3018 <example>
9e35b3de
ZJS
3019 <title>Virtual Routing and Forwarding (VRF)</title>
3020 <para>Add the <literal>bond1</literal> interface to the VRF master interface
3021 <literal>vrf1</literal>. This will redirect routes generated on this interface to be
11d38b90
AR
3022 within the routing table defined during VRF creation. For kernels before 4.8 traffic
3023 won't be redirected towards the VRFs routing table unless specific ip-rules are added.
3024 </para>
9e35b3de
ZJS
3025 <programlisting># /etc/systemd/network/25-vrf.network
3026[Match]
6cb955c6
AR
3027Name=bond1
3028
3029[Network]
9e35b3de 3030VRF=vrf1
d94facdc
MH
3031</programlisting>
3032 </example>
3033
42125eda
SS
3034 <example>
3035 <title>MacVTap</title>
3036 <para>This brings up a network interface <literal>macvtap-test</literal>
3037 and attaches it to <literal>enp0s25</literal>.</para>
83ddf5d3 3038 <programlisting># /usr/lib/systemd/network/25-macvtap.network
42125eda
SS
3039[Match]
3040Name=enp0s25
3041
3042[Network]
3043MACVTAP=macvtap-test
3044</programlisting>
3045 </example>
98d20a17 3046
3047 <example>
3048 <title>A Xfrm interface with physical underlying device.</title>
3049
3050 <programlisting># /etc/systemd/network/27-xfrm.netdev
3051[NetDev]
3052Name=xfrm0
3053
3054[Xfrm]
3055InterfaceId=7</programlisting>
3056
3057 <programlisting># /etc/systemd/network/27-eth0.network
3058[Match]
3059Name=eth0
3060
3061[Network]
3062Xfrm=xfrm0</programlisting>
3063
3064 <para>This creates a <literal>xfrm0</literal> interface and binds it to the <literal>eth0</literal> device.
3065 This allows hardware based ipsec offloading to the <literal>eth0</literal> nic.
3066 If offloading is not needed, xfrm interfaces can be assigned to the <literal>lo</literal> device.
3067 </para>
3068 </example>
798d3a52
ZJS
3069 </refsect1>
3070
3071 <refsect1>
3072 <title>See Also</title>
3073 <para>
3074 <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
f41b446a 3075 <citerefentry><refentrytitle>systemd-networkd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
798d3a52 3076 <citerefentry><refentrytitle>systemd.link</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
aaa297d4
LP
3077 <citerefentry><refentrytitle>systemd.netdev</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
3078 <citerefentry><refentrytitle>systemd-resolved.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>
798d3a52
ZJS
3079 </para>
3080 </refsect1>
eac684ef
TG
3081
3082</refentry>