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