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