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