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