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