]> git.ipfire.org Git - thirdparty/systemd.git/blame - man/systemd.network.xml
network: move config_parse_uplink() to networkd-dhcp-common.[ch]
[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
f37f2a6b 2092 <varlistentry>
c3696a91 2093 <term><varname>ForceDHCPv6PDOtherInformation=</varname></term>
f37f2a6b 2094 <listitem>
c3696a91
ZJS
2095 <para>Takes a boolean that enforces DHCPv6 stateful mode when the 'Other information' bit is set in
2096 Router Advertisement messages. By default setting only the 'O' bit in Router Advertisements
2097 makes DHCPv6 request network information in a stateless manner using a two-message Information
2098 Request and Information Reply message exchange.
2099 <ulink url="https://tools.ietf.org/html/rfc7084">RFC 7084</ulink>, requirement WPD-4, updates
2100 this behavior for a Customer Edge router so that stateful DHCPv6 Prefix Delegation is also
2101 requested when only the 'O' bit is set in Router Advertisements. This option enables such a CE
2102 behavior as it is impossible to automatically distinguish the intention of the 'O' bit otherwise.
2103 By default this option is set to false, enable it if no prefixes are delegated when the device
2104 should be acting as a CE router.</para>
f37f2a6b
SS
2105 </listitem>
2106 </varlistentry>
ed0d1b2e
SS
2107
2108 <varlistentry>
c3696a91
ZJS
2109 <term><varname>WithoutRA=</varname></term>
2110 <listitem>
2111 <para>Allows DHCPv6 client to start without router advertisements's managed or other address
2112 configuration flag. Takes one of <literal>solicit</literal> or
2113 <literal>information-request</literal>. Defaults to unset.</para>
2114 </listitem>
2115 </varlistentry>
ad943783 2116 </variablelist>
caa8ca42 2117 </refsect1>
99e015e2
YW
2118
2119 <refsect1>
2120 <title>[DHCPv6PrefixDelegation] Section Options</title>
e5ff2245
YW
2121 <para>The [DHCPv6PrefixDelegation] section configures delegated prefixes assigned by DHCPv6 server.
2122 The settings in this section are used only when <varname>DHCPv6PrefixDelegation=</varname> setting
2123 is enabled.</para>
99e015e2
YW
2124
2125 <variablelist class='network-directives'>
2126 <varlistentry>
2127 <term><varname>SubnetId=</varname></term>
2128 <listitem>
2129 <para>Configure a specific subnet ID on the interface from a (previously) received prefix
2130 delegation. You can either set "auto" (the default) or a specific subnet ID (as defined in
2131 <ulink url="https://tools.ietf.org/html/rfc4291#section-2.5.4">RFC 4291</ulink>, section
2132 2.5.4), in which case the allowed value is hexadecimal, from 0 to 0x7fffffffffffffff
e5ff2245
YW
2133 inclusive.</para>
2134 </listitem>
2135 </varlistentry>
2136
2137 <varlistentry>
2138 <term><varname>Announce=</varname></term>
2139 <listitem>
2140 <para>Takes a boolean. When enabled, and <varname>IPv6SendRA=</varname> in [Network] section
2141 is enabled, the delegated prefixes are distributed through the IPv6 Router Advertisement.
2142 Defaults to yes.</para>
99e015e2
YW
2143 </listitem>
2144 </varlistentry>
2145
2146 <varlistentry>
2147 <term><varname>Assign=</varname></term>
2148 <listitem>
2149 <para>Takes a boolean. Specifies whether to add an address from the delegated prefixes which
e5ff2245
YW
2150 are received from the WAN interface by the DHCPv6 Prefix Delegation. When true (on LAN
2151 interfce), the EUI-64 algorithm will be used by default to form an interface identifier from
2152 the delegated prefixes. See also <varname>Token=</varname> setting below. Defaults to yes.
2153 </para>
99e015e2
YW
2154 </listitem>
2155 </varlistentry>
2156
2157 <varlistentry>
2158 <term><varname>Token=</varname></term>
2159 <listitem>
e5ff2245 2160 <para>Specifies an optional address generation mode for assigning an address in each
f5960e0a
YW
2161 delegated prefix. This accepts the same syntax as <varname>Token=</varname> in the
2162 [IPv6AcceptRA] section. If <varname>Assign=</varname> is set to false, then this setting will
2163 be ignored. Defaults to unset, which means the EUI-64 algorithm will be used.</para>
99e015e2
YW
2164 </listitem>
2165 </varlistentry>
fec1b650
YW
2166
2167 <varlistentry>
2168 <term><varname>ManageTemporaryAddress=</varname></term>
2169 <listitem>
2170 <para>As in the [Address] section, but defaults to true.</para>
2171 </listitem>
2172 </varlistentry>
9fe0b7b4
YW
2173
2174 <varlistentry>
2175 <term><varname>RouteMetric=</varname></term>
2176 <listitem>
2177 <para>The metric of the route to the delegated prefix subnet. Takes an unsigned integer in
d0619f2c
YW
2178 the range 0…4294967295. When set to 0, the kernel's default value is used. Defaults to 256.
2179 </para>
9fe0b7b4
YW
2180 </listitem>
2181 </varlistentry>
99e015e2
YW
2182 </variablelist>
2183 </refsect1>
413708d1 2184
1e7a0e21 2185 <refsect1>
f921f573 2186 <title>[IPv6AcceptRA] Section Options</title>
bdac5608
ZJS
2187 <para>The [IPv6AcceptRA] section configures the IPv6 Router Advertisement (RA) client, if it is enabled
2188 with the <varname>IPv6AcceptRA=</varname> setting described above:</para>
1e7a0e21
LP
2189
2190 <variablelist class='network-directives'>
a73628e6
YW
2191 <varlistentry>
2192 <term><varname>Token=</varname></term>
2193 <listitem>
2194 <para>Specifies an optional address generation mode for the Stateless Address
140bf8da
YW
2195 Autoconfiguration (SLAAC). Supported modes are <literal>eui64</literal>,
2196 <literal>static</literal>, and <literal>prefixstable</literal>.</para>
2197
2198 <para>When the mode is set to <literal>eui64</literal>, then the EUI-64 algorithm will be
2199 used to generate an address for that prefix.</para>
a73628e6
YW
2200
2201 <para>When the mode is set to <literal>static</literal>, an IPv6 address must be
2202 specified after a colon (<literal>:</literal>), and the lower bits of the supplied
2203 address are combined with the upper bits of a prefix received in a Router Advertisement
2204 (RA) message to form a complete address. Note that if multiple prefixes are received in an
2205 RA message, or in multiple RA messages, addresses will be formed from each of them using
2206 the supplied address. This mode implements SLAAC but uses a static interface identifier
2207 instead of an identifier generated by using the EUI-64 algorithm. Because the interface
2208 identifier is static, if Duplicate Address Detection detects that the computed address is a
2209 duplicate (in use by another node on the link), then this mode will fail to provide an
2210 address for that prefix. If an IPv6 address without mode is specified, then
2211 <literal>static</literal> mode is assumed.</para>
2212
2213 <para>When the mode is set to <literal>prefixstable</literal> the
2214 <ulink url="https://tools.ietf.org/html/rfc7217">RFC 7217</ulink> algorithm for generating
2215 interface identifiers will be used. This mode can optionally take an IPv6 address separated
2216 with a colon (<literal>:</literal>). If an IPv6 address is specified, then an interface
2217 identifier is generated only when a prefix received in an RA message matches the supplied
2218 address.</para>
2219
2220 <para>If no address generation mode is specified (which is the default), or a received
2221 prefix does not match any of the addresses provided in <literal>prefixstable</literal>
2222 mode, then the EUI-64 algorithm will be used to form an interface identifier for that
2223 prefix.</para>
2224
2225 <para>Note that the <literal>prefixstable</literal> algorithm uses both the interface
2226 name and MAC address as input to the hash to compute the interface identifier, so if either
2227 of those are changed the resulting interface identifier (and address) will be changed, even
2228 if the prefix received in the RA message has not been changed.</para>
2229
2230 <para>This setting can be specified multiple times. If an empty string is assigned, then
2231 the all previous assignments are cleared.</para>
2232
2233 <para>Examples:
140bf8da
YW
2234 <programlisting>Token=eui64
2235Token=::1a:2b:3c:4d
a73628e6
YW
2236Token=static:::1a:2b:3c:4d
2237Token=prefixstable
2238Token=prefixstable:2002:da8:1::</programlisting></para>
2239 </listitem>
2240 </varlistentry>
2241
1e7a0e21
LP
2242 <varlistentry>
2243 <term><varname>UseDNS=</varname></term>
2244 <listitem>
b63dae31 2245 <para>When true (the default), the DNS servers received in the Router Advertisement will be used.</para>
1e7a0e21
LP
2246
2247 <para>This corresponds to the <option>nameserver</option> option in <citerefentry
2248 project='man-pages'><refentrytitle>resolv.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para>
2249 </listitem>
2250 </varlistentry>
2251
2252 <varlistentry>
2253 <term><varname>UseDomains=</varname></term>
2254 <listitem>
9b6ffef3 2255 <para>Takes a boolean, or the special value <literal>route</literal>. When true, the domain name
1e7a0e21
LP
2256 received via IPv6 Router Advertisement (RA) will be used as DNS search domain over this link, similar to
2257 the effect of the <option>Domains=</option> setting. If set to <literal>route</literal>, the domain name
2258 received via IPv6 RA will be used for routing DNS queries only, but not for searching, similar to the
2259 effect of the <option>Domains=</option> setting when the argument is prefixed with
2260 <literal>~</literal>. Defaults to false.</para>
2261
2262 <para>It is recommended to enable this option only on trusted networks, as setting this affects resolution
38b38500 2263 of all hostnames, in particular of single-label names. It is generally safer to use the supplied domain
1e7a0e21
LP
2264 only as routing domain, rather than as search domain, in order to not have it affect local resolution of
2265 single-label names.</para>
2266
2267 <para>When set to true, this setting corresponds to the <option>domain</option> option in <citerefentry
2268 project='man-pages'><refentrytitle>resolv.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para>
2269 </listitem>
2270 </varlistentry>
2ba31d29
JK
2271
2272 <varlistentry>
2273 <term><varname>RouteTable=<replaceable>num</replaceable></varname></term>
2274 <listitem>
d11e656a
ZJS
2275 <para>The table identifier for the routes received in the Router Advertisement
2276 (a number between 1 and 4294967295, or 0 to unset).
2ba31d29
JK
2277 The table can be retrieved using <command>ip route show table <replaceable>num</replaceable></command>.
2278 </para>
2279 </listitem>
2280 </varlistentry>
062c2eea 2281
8ebafba9
YW
2282 <varlistentry>
2283 <term><varname>RouteMetric=</varname></term>
2284 <listitem>
2285 <para>Set the routing metric for the routes received in the Router Advertisement. Takes an
2286 unsigned integer in the range 0…4294967295. Defaults to 1024.</para>
2287 </listitem>
2288 </varlistentry>
2289
7d93b92f
YW
2290 <varlistentry>
2291 <term><varname>UseMTU=</varname></term>
2292 <listitem>
2293 <para>Takes a boolean. When true, the MTU received in the Router Advertisement will be
2294 used. Defaults to true.</para>
2295 </listitem>
2296 </varlistentry>
2297
062c2eea
SS
2298 <varlistentry>
2299 <term><varname>UseAutonomousPrefix=</varname></term>
2300 <listitem>
2301 <para>When true (the default), the autonomous prefix received in the Router Advertisement will be used and take
2302 precedence over any statically configured ones.</para>
2303 </listitem>
2304 </varlistentry>
2305
2306 <varlistentry>
2307 <term><varname>UseOnLinkPrefix=</varname></term>
2308 <listitem>
885a4e6c
ZJS
2309 <para>When true (the default), the onlink prefix received in the Router Advertisement will be
2310 used and takes precedence over any statically configured ones.</para>
062c2eea
SS
2311 </listitem>
2312 </varlistentry>
2313
75d26411
YW
2314 <varlistentry>
2315 <term><varname>RouterDenyList=</varname></term>
2316 <listitem>
c995fa02
YW
2317 <para>A whitespace-separated list of IPv6 router addresses. Each address can optionally
2318 take a prefix length after <literal>/</literal>. Any information advertised by the listed
2319 router is ignored.</para>
75d26411
YW
2320 </listitem>
2321 </varlistentry>
2322
2323 <varlistentry>
2324 <term><varname>RouterAllowList=</varname></term>
2325 <listitem>
c995fa02
YW
2326 <para>A whitespace-separated list of IPv6 router addresses. Each address can optionally
2327 take a prefix length after <literal>/</literal>. Only information advertised by the listed
2328 router is accepted. Note that if <varname>RouterAllowList=</varname> is configured then
2329 <varname>RouterDenyList=</varname> is ignored.</para>
75d26411
YW
2330 </listitem>
2331 </varlistentry>
2332
e520ce64 2333 <varlistentry>
3f0af4a5 2334 <term><varname>PrefixDenyList=</varname></term>
e520ce64 2335 <listitem>
c995fa02
YW
2336 <para>A whitespace-separated list of IPv6 prefixes. Each prefix can optionally take its
2337 prefix length after <literal>/</literal>. IPv6 prefixes supplied via router advertisements
2338 in the list are ignored.</para>
16c89e64
DP
2339 </listitem>
2340 </varlistentry>
2341
de6b6ff8
SS
2342 <varlistentry>
2343 <term><varname>PrefixAllowList=</varname></term>
2344 <listitem>
c995fa02
YW
2345 <para>A whitespace-separated list of IPv6 prefixes. Each prefix can optionally take its
2346 prefix length after <literal>/</literal>. IPv6 prefixes supplied via router advertisements
2347 in the list are allowed. Note that if <varname>PrefixAllowList=</varname> is configured
2348 then <varname>PrefixDenyList=</varname> is ignored.</para>
de6b6ff8
SS
2349 </listitem>
2350 </varlistentry>
2351
16c89e64
DP
2352 <varlistentry>
2353 <term><varname>RouteDenyList=</varname></term>
2354 <listitem>
c995fa02
YW
2355 <para>A whitespace-separated list of IPv6 route prefixes. Each prefix can optionally take
2356 its prefix length after <literal>/</literal>. IPv6 route prefixes supplied via router
2357 advertisements in the list are ignored.</para>
e520ce64
SS
2358 </listitem>
2359 </varlistentry>
2360
de6b6ff8
SS
2361 <varlistentry>
2362 <term><varname>RouteAllowList=</varname></term>
2363 <listitem>
c995fa02
YW
2364 <para>A whitespace-separated list of IPv6 route prefixes. Each prefix can optionally take
2365 its prefix length after <literal>/</literal>. IPv6 route prefixes supplied via router
2366 advertisements in the list are allowed. Note that if <varname>RouteAllowList=</varname> is
de6b6ff8
SS
2367 configured then <varname>RouteDenyList=</varname> is ignored.</para>
2368 </listitem>
2369 </varlistentry>
2370
d739fdde
YW
2371 <varlistentry>
2372 <term><varname>DHCPv6Client=</varname></term>
2373 <listitem>
0e686fea
YW
2374 <para>Takes a boolean, or the special value <literal>always</literal>. When true or
2375 <literal>always</literal>, the DHCPv6 client will be started when the RA has the managed or
2376 other information flag. If set to <literal>always</literal>, the DHCPv6 client will also be
2377 started in managed mode when neither managed nor other information flag is set in the RA.
2378 Defaults to true.</para>
d739fdde
YW
2379 </listitem>
2380 </varlistentry>
1e7a0e21
LP
2381 </variablelist>
2382 </refsect1>
2383
ad943783
LP
2384 <refsect1>
2385 <title>[DHCPServer] Section Options</title>
bdac5608 2386 <para>The [DHCPServer] section contains settings for the DHCP server, if enabled via the
ad943783
LP
2387 <varname>DHCPServer=</varname> option described above:</para>
2388
2389 <variablelist class='network-directives'>
2390
0017ba31
YW
2391 <varlistentry>
2392 <term><varname>ServerAddress=</varname></term>
2393 <listitem><para>Specifies server address for the DHCP server. Takes an IPv4 address with prefix
be0d27ee
ZJS
2394 length, for example <literal>192.168.0.1/24</literal>. This setting may be useful when the link on
2395 which the DHCP server is running has multiple static addresses. When unset, one of static addresses
2396 in the link will be automatically selected. Defaults to unset.</para></listitem>
0017ba31
YW
2397 </varlistentry>
2398
9b3a67c5
TG
2399 <varlistentry>
2400 <term><varname>PoolOffset=</varname></term>
2401 <term><varname>PoolSize=</varname></term>
2402
2403 <listitem><para>Configures the pool of addresses to hand out. The pool
2404 is a contiguous sequence of IP addresses in the subnet configured for
2405 the server address, which does not include the subnet nor the broadcast
2406 address. <varname>PoolOffset=</varname> takes the offset of the pool
2407 from the start of subnet, or zero to use the default value.
2408 <varname>PoolSize=</varname> takes the number of IP addresses in the
b938cb90 2409 pool or zero to use the default value. By default, the pool starts at
9b3a67c5
TG
2410 the first address after the subnet address and takes up the rest of
2411 the subnet, excluding the broadcast address. If the pool includes
2412 the server address (the default), this is reserved and not handed
2413 out to clients.</para></listitem>
2414 </varlistentry>
2415
ad943783
LP
2416 <varlistentry>
2417 <term><varname>DefaultLeaseTimeSec=</varname></term>
2418 <term><varname>MaxLeaseTimeSec=</varname></term>
2419
2420 <listitem><para>Control the default and maximum DHCP lease
2421 time to pass to clients. These settings take time values in seconds or
2422 another common time unit, depending on the suffix. The default
2423 lease time is used for clients that did not ask for a specific
2424 lease time. If a client asks for a lease time longer than the
b938cb90 2425 maximum lease time, it is automatically shortened to the
ad943783
LP
2426 specified time. The default lease time defaults to 1h, the
2427 maximum lease time to 12h. Shorter lease times are beneficial
2428 if the configuration data in DHCP leases changes frequently
2429 and clients shall learn the new settings with shorter
2430 latencies. Longer lease times reduce the generated DHCP
2431 network traffic.</para></listitem>
2432 </varlistentry>
2433
165d7c5c
YW
2434 <varlistentry>
2435 <term><varname>UplinkInterface=</varname></term>
2b242926
YW
2436 <listitem><para>Specifies the name or the index of the uplink interface, or one of the special
2437 values <literal>:none</literal> and <literal>:auto</literal>. When emitting DNS, NTP, or SIP
2438 servers is enabled but no servers are specified, the servers configured in the uplink interface
2439 will be emitted. When <literal>:auto</literal>, the link which has a default gateway with the
2440 highest priority will be automatically selected. When <literal>:none</literal>, no uplink
2441 interface will be selected. Defaults to <literal>:auto</literal>.</para></listitem>
165d7c5c
YW
2442 </varlistentry>
2443
ad943783
LP
2444 <varlistentry>
2445 <term><varname>EmitDNS=</varname></term>
2446 <term><varname>DNS=</varname></term>
2447
2a71d57f
LP
2448 <listitem><para><varname>EmitDNS=</varname> takes a boolean. Configures whether the DHCP leases
2449 handed out to clients shall contain DNS server information. Defaults to <literal>yes</literal>. The
2450 DNS servers to pass to clients may be configured with the <varname>DNS=</varname> option, which takes
2451 a list of IPv4 addresses. If the <varname>EmitDNS=</varname> option is enabled but no servers
2452 configured, the servers are automatically propagated from an "uplink" interface that has appropriate
2453 servers set. The "uplink" interface is determined by the default route of the system with the highest
2454 priority. Note that this information is acquired at the time the lease is handed out, and does not
2455 take uplink interfaces into account that acquire DNS server information at a later point. If no
75909cc7 2456 suitable uplink interface is found the DNS server data from <filename>/etc/resolv.conf</filename> is
2a71d57f
LP
2457 used. Also, note that the leases are not refreshed if the uplink network configuration changes. To
2458 ensure clients regularly acquire the most current uplink DNS server information, it is thus advisable
2459 to shorten the DHCP lease time via <varname>MaxLeaseTimeSec=</varname> described
ad943783
LP
2460 above.</para></listitem>
2461 </varlistentry>
2462
2463 <varlistentry>
2464 <term><varname>EmitNTP=</varname></term>
2465 <term><varname>NTP=</varname></term>
299d578f
SS
2466 <term><varname>EmitSIP=</varname></term>
2467 <term><varname>SIP=</varname></term>
2a71d57f
LP
2468 <term><varname>EmitPOP3=</varname></term>
2469 <term><varname>POP3=</varname></term>
2470 <term><varname>EmitSMTP=</varname></term>
2471 <term><varname>SMTP=</varname></term>
2472 <term><varname>EmitLPR=</varname></term>
2473 <term><varname>LPR=</varname></term>
2474
2475 <listitem><para>Similar to the <varname>EmitDNS=</varname> and <varname>DNS=</varname> settings
2476 described above, these settings configure whether and what server information for the indicate
2477 protocol shall be emitted as part of the DHCP lease. The same syntax, propagation semantics and
2478 defaults apply as for <varname>EmitDNS=</varname> and <varname>DNS=</varname>.</para></listitem>
284e8fd0
SS
2479 </varlistentry>
2480
77ff6022
CG
2481 <varlistentry>
2482 <term><varname>EmitRouter=</varname></term>
2483
2484 <listitem><para>Similar to the <varname>EmitDNS=</varname>
2485 setting described above, this setting configures whether the
2486 DHCP lease should contain the router option. The same syntax,
2487 propagation semantics and defaults apply as for
2488 <varname>EmitDNS=</varname>.</para></listitem>
2489 </varlistentry>
2490
ad943783
LP
2491 <varlistentry>
2492 <term><varname>EmitTimezone=</varname></term>
2493 <term><varname>Timezone=</varname></term>
2494
9b6ffef3
YW
2495 <listitem><para>Takes a boolean. Configures whether the DHCP leases handed out
2496 to clients shall contain timezone information. Defaults to <literal>yes</literal>. The
ad943783
LP
2497 <varname>Timezone=</varname> setting takes a timezone string
2498 (such as <literal>Europe/Berlin</literal> or
2499 <literal>UTC</literal>) to pass to clients. If no explicit
b938cb90 2500 timezone is set, the system timezone of the local host is
ad943783
LP
2501 propagated, as determined by the
2502 <filename>/etc/localtime</filename> symlink.</para></listitem>
2503 </varlistentry>
2504
564ca984 2505 <varlistentry>
d8b736bd
YW
2506 <term><varname>SendOption=</varname></term>
2507 <listitem>
2508 <para>Send a raw option with value via DHCPv4 server. Takes a DHCP option number, data type
2509 and data (<literal><replaceable>option</replaceable>:<replaceable>type</replaceable>:<replaceable>value</replaceable></literal>).
1d3a473b 2510 The option number is an integer in the range 1…254. The type takes one of <literal>uint8</literal>,
e7d5fe17 2511 <literal>uint16</literal>, <literal>uint32</literal>, <literal>ipv4address</literal>, <literal>ipv6address</literal>, or
7354900d
DW
2512 <literal>string</literal>. Special characters in the data string may be escaped using
2513 <ulink url="https://en.wikipedia.org/wiki/Escape_sequences_in_C#Table_of_escape_sequences">C-style
2514 escapes</ulink>. This setting can be specified multiple times. If an empty string is specified,
2515 then all options specified earlier are cleared. Defaults to unset.</para>
2516 </listitem>
2517 </varlistentry>
2518
2519 <varlistentry>
2520 <term><varname>SendVendorOption=</varname></term>
2521 <listitem>
2522 <para>Send a vendor option with value via DHCPv4 server. Takes a DHCP option number, data type
2523 and data (<literal><replaceable>option</replaceable>:<replaceable>type</replaceable>:<replaceable>value</replaceable></literal>).
1d3a473b 2524 The option number is an integer in the range 1…254. The type takes one of <literal>uint8</literal>,
d8b736bd
YW
2525 <literal>uint16</literal>, <literal>uint32</literal>, <literal>ipv4address</literal>, or
2526 <literal>string</literal>. Special characters in the data string may be escaped using
2527 <ulink url="https://en.wikipedia.org/wiki/Escape_sequences_in_C#Table_of_escape_sequences">C-style
2528 escapes</ulink>. This setting can be specified multiple times. If an empty string is specified,
2529 then all options specified earlier are cleared. Defaults to unset.</para>
2530 </listitem>
564ca984 2531 </varlistentry>
21b6b87e
YA
2532 <varlistentry>
2533 <term><varname>BindToInterface=</varname></term>
11c38d3e
YA
2534 <listitem>
2535 <para>Takes a boolean value. When <literal>yes</literal>, DHCP server socket will be bound
2536 to its network interface and all socket communication will be restricted to this interface.
2537 Defaults to <literal>yes</literal>, except if <varname>RelayTarget=</varname> is used (see below),
2538 in which case it defaults defaults to <literal>no</literal>.</para>
2539 </listitem>
2540 </varlistentry>
2541 <varlistentry>
2542 <term><varname>RelayTarget=</varname></term>
2543 <listitem>
2544 <para>Takes an IPv4 address, which must be in the format described in
2545 <citerefentry project='man-pages'><refentrytitle>inet_pton</refentrytitle><manvolnum>3</manvolnum></citerefentry>.
2546 Turns this DHCP server into a DHCP relay agent. See <ulink url="https://tools.ietf.org/html/rfc1542">RFC 1542</ulink>.
2547 The address is the address of DHCP server or another relay agent to forward DHCP messages to and from.</para>
2548 </listitem>
2549 </varlistentry>
2550 <varlistentry>
2551 <term><varname>RelayAgentCircuitId=</varname></term>
2552 <listitem>
2553 <para>Specifies value for Agent Circuit ID suboption of Relay Agent Information option.
2554 Takes a string, which must be in the format <literal>string:<replaceable>value</replaceable></literal>,
2555 where <literal><replaceable>value</replaceable></literal> should be replaced with the value of the suboption.
2556 Defaults to unset (means no Agent Circuit ID suboption is generated).
2557 Ignored if <varname>RelayTarget=</varname> is not specified.</para>
2558 </listitem>
2559 </varlistentry>
2560 <varlistentry>
2561 <term><varname>RelayAgentRemoteId=</varname></term>
2562 <listitem>
2563 <para>Specifies value for Agent Remote ID suboption of Relay Agent Information option.
2564 Takes a string, which must be in the format <literal>string:<replaceable>value</replaceable></literal>,
2565 where <literal><replaceable>value</replaceable></literal> should be replaced with the value of the suboption.
2566 Defaults to unset (means no Agent Remote ID suboption is generated).
2567 Ignored if <varname>RelayTarget=</varname> is not specified.</para>
21b6b87e
YA
2568 </listitem>
2569 </varlistentry>
564ca984 2570
ad943783
LP
2571 </variablelist>
2572 </refsect1>
2573
c517a49b 2574 <refsect1>
2575 <title>[DHCPServerStaticLease] Section Options</title>
be0d27ee
ZJS
2576 <para>The <literal>[DHCPServerStaticLease]</literal> section configures a static DHCP lease to assign a
2577 fixed IPv4 address to a specific device based on its MAC address. This section can be specified multiple
2578 times.</para>
c517a49b 2579
2580 <variablelist class='network-directives'>
2581 <varlistentry>
2582 <term><varname>MACAddress=</varname></term>
2583
be0d27ee 2584 <listitem><para>The hardware address of a device to match. This key is mandatory.</para></listitem>
c517a49b 2585 </varlistentry>
2586
2587 <varlistentry>
2588 <term><varname>Address=</varname></term>
2589
be0d27ee
ZJS
2590 <listitem><para>The IPv4 address that should be assigned to the device that was matched with
2591 <varname>MACAddress=</varname>. This key is mandatory.</para></listitem>
c517a49b 2592 </varlistentry>
2593 </variablelist>
2594 </refsect1>
2595
798d3a52 2596 <refsect1>
e5ff2245
YW
2597 <title>[IPv6SendRA] Section Options</title>
2598 <para>The [IPv6SendRA] section contains settings for sending IPv6 Router Advertisements and whether
2599 to act as a router, if enabled via the <varname>IPv6SendRA=</varname> option described above. IPv6
2600 network prefixes or routes are defined with one or more [IPv6Prefix] or [IPv6RoutePrefix] sections.
2601 </para>
3f9e0236
PF
2602
2603 <variablelist class='network-directives'>
2604
2605 <varlistentry>
2606 <term><varname>Managed=</varname></term>
2607 <term><varname>OtherInformation=</varname></term>
2608
9b6ffef3
YW
2609 <listitem><para>Takes a boolean. Controls whether a DHCPv6 server is used to acquire IPv6
2610 addresses on the network link when <varname>Managed=</varname>
3f9e0236
PF
2611 is set to <literal>true</literal> or if only additional network
2612 information can be obtained via DHCPv6 for the network link when
9b6ffef3 2613 <varname>OtherInformation=</varname> is set to
3f9e0236
PF
2614 <literal>true</literal>. Both settings default to
2615 <literal>false</literal>, which means that a DHCPv6 server is not being
2616 used.</para></listitem>
2617 </varlistentry>
2618
2619 <varlistentry>
2620 <term><varname>RouterLifetimeSec=</varname></term>
2621
71a5db49
YW
2622 <listitem><para>Takes a timespan. Configures the IPv6 router lifetime in seconds. When set to
2623 0, the host is not acting as a router. Defaults to 30 minutes.</para>
3f9e0236
PF
2624 </listitem>
2625 </varlistentry>
2626
2627 <varlistentry>
2628 <term><varname>RouterPreference=</varname></term>
2629
2630 <listitem><para>Configures IPv6 router preference if
2631 <varname>RouterLifetimeSec=</varname> is non-zero. Valid values are
2632 <literal>high</literal>, <literal>medium</literal> and
2633 <literal>low</literal>, with <literal>normal</literal> and
2634 <literal>default</literal> added as synonyms for
2635 <literal>medium</literal> just to make configuration easier. See
2636 <ulink url="https://tools.ietf.org/html/rfc4191">RFC 4191</ulink>
2637 for details. Defaults to <literal>medium</literal>.</para></listitem>
2638 </varlistentry>
2639
63295b42
YW
2640 <varlistentry>
2641 <term><varname>UplinkInterface=</varname></term>
2642 <listitem><para>Specifies the name or the index of the uplink interface, or one of the special
2643 values <literal>:none</literal> and <literal>:auto</literal>. When emitting DNS servers or
2644 search domains is enabled but no servers are specified, the servers configured in the uplink
2645 interface will be emitted. When <literal>:auto</literal>, the link which has a default gateway
2646 with the highest priority will be automatically selected. When <literal>:none</literal>, no
2647 uplink interface will be selected. Defaults to <literal>:auto</literal>.</para></listitem>
2648 </varlistentry>
2649
3f9e0236 2650 <varlistentry>
4cb8478c 2651 <term><varname>EmitDNS=</varname></term>
3f9e0236
PF
2652 <term><varname>DNS=</varname></term>
2653
63295b42
YW
2654 <listitem><para><varname>DNS=</varname> specifies a list of recursive DNS server IPv6 addresses
2655 that are distributed via Router Advertisement messages when <varname>EmitDNS=</varname> is true.
2656 <varname>DNS=</varname> also takes special value <literal>_link_local</literal>; in that case
2657 the IPv6 link local address is distributed. If <varname>DNS=</varname> is empty, DNS servers are
2658 read from the [Network] section. If the [Network] section does not contain any DNS servers
2659 either, DNS servers from the uplink interface specified in <varname>UplinkInterface=</varname>
2660 will be used. When <varname>EmitDNS=</varname> is false, no DNS server information is sent in
2661 Router Advertisement messages. <varname>EmitDNS=</varname> defaults to true.</para></listitem>
3f9e0236
PF
2662 </varlistentry>
2663
760021c0 2664 <varlistentry>
4cb8478c 2665 <term><varname>EmitDomains=</varname></term>
760021c0
PF
2666 <term><varname>Domains=</varname></term>
2667
bdac5608 2668 <listitem><para>A list of DNS search domains distributed via Router Advertisement messages when
63295b42
YW
2669 <varname>EmitDomains=</varname> is true. If <varname>Domains=</varname> is empty, DNS search
2670 domains are read from the [Network] section. If the [Network] section does not contain any DNS
2671 search domains either, DNS search domains from the uplink interface specified in
2672 <varname>UplinkInterface=</varname> will be used. When <varname>EmitDomains=</varname> is false,
2673 no DNS search domain information is sent in Router Advertisement messages.
2674 <varname>EmitDomains=</varname> defaults to true.</para></listitem>
760021c0
PF
2675 </varlistentry>
2676
3f9e0236
PF
2677 <varlistentry>
2678 <term><varname>DNSLifetimeSec=</varname></term>
2679
9fa25e07
YW
2680 <listitem><para>Lifetime in seconds for the DNS server addresses listed in
2681 <varname>DNS=</varname> and search domains listed in <varname>Domains=</varname>. Defaults to
2682 604800 seconds (one week).</para></listitem>
3f9e0236
PF
2683 </varlistentry>
2684
2685 </variablelist>
2686 </refsect1>
2687
203d4df5 2688 <refsect1>
3f9e0236 2689 <title>[IPv6Prefix] Section Options</title>
e9dd6984
ZJS
2690 <para>One or more [IPv6Prefix] sections contain the IPv6 prefixes that are announced via Router
2691 Advertisements. See <ulink url="https://tools.ietf.org/html/rfc4861">RFC 4861</ulink> for further
2692 details.</para>
3f9e0236
PF
2693
2694 <variablelist class='network-directives'>
2695
2696 <varlistentry>
2697 <term><varname>AddressAutoconfiguration=</varname></term>
2698 <term><varname>OnLink=</varname></term>
2699
9b6ffef3 2700 <listitem><para>Takes a boolean to specify whether IPv6 addresses can be
3f9e0236
PF
2701 autoconfigured with this prefix and whether the prefix can be used for
2702 onlink determination. Both settings default to <literal>true</literal>
2703 in order to ease configuration.
2704 </para></listitem>
2705 </varlistentry>
2706
2707 <varlistentry>
2708 <term><varname>Prefix=</varname></term>
2709
bdac5608
ZJS
2710 <listitem><para>The IPv6 prefix that is to be distributed to hosts. Similarly to configuring static
2711 IPv6 addresses, the setting is configured as an IPv6 prefix and its prefix length, separated by a
2712 <literal>/</literal> character. Use multiple [IPv6Prefix] sections to configure multiple IPv6
2713 prefixes since prefix lifetimes, address autoconfiguration and onlink status may differ from one
2714 prefix to another.</para></listitem>
3f9e0236
PF
2715 </varlistentry>
2716
2717 <varlistentry>
2718 <term><varname>PreferredLifetimeSec=</varname></term>
2719 <term><varname>ValidLifetimeSec=</varname></term>
2720
2721 <listitem><para>Preferred and valid lifetimes for the prefix measured in
2722 seconds. <varname>PreferredLifetimeSec=</varname> defaults to 604800
2723 seconds (one week) and <varname>ValidLifetimeSec=</varname> defaults
2724 to 2592000 seconds (30 days).</para></listitem>
203d4df5
SS
2725 </varlistentry>
2726
bd6379ec
SS
2727 <varlistentry>
2728 <term><varname>Assign=</varname></term>
2729 <listitem><para>Takes a boolean. When true, adds an address from the prefix. Default to false.
2730 </para></listitem>
2731 </varlistentry>
0e1fb1d0 2732
e609cd06
YW
2733 <varlistentry>
2734 <term><varname>Token=</varname></term>
2735 <listitem>
2736 <para>Specifies an optional address generation mode for assigning an address in each
2737 prefix. This accepts the same syntax as <varname>Token=</varname> in the [IPv6AcceptRA]
2738 section. If <varname>Assign=</varname> is set to false, then this setting will be ignored.
2739 Defaults to unset, which means the EUI-64 algorithm will be used.</para>
2740 </listitem>
2741 </varlistentry>
2742
0e1fb1d0
YW
2743 <varlistentry>
2744 <term><varname>RouteMetric=</varname></term>
2745 <listitem>
2746 <para>The metric of the prefix route. Takes an unsigned integer in the range 0…4294967295.
2747 When unset or set to 0, the kernel's default value is used. This setting is ignored when
2748 <varname>Assign=</varname> is false.</para>
2749 </listitem>
2750 </varlistentry>
203d4df5
SS
2751 </variablelist>
2752 </refsect1>
2753
2754 <refsect1>
2755 <title>[IPv6RoutePrefix] Section Options</title>
bdac5608 2756 <para>One or more [IPv6RoutePrefix] sections contain the IPv6
203d4df5
SS
2757 prefix routes that are announced via Router Advertisements. See
2758 <ulink url="https://tools.ietf.org/html/rfc4191">RFC 4191</ulink>
2759 for further details.</para>
2760
2761 <variablelist class='network-directives'>
2762
2763 <varlistentry>
2764 <term><varname>Route=</varname></term>
2765
bdac5608
ZJS
2766 <listitem><para>The IPv6 route that is to be distributed to hosts. Similarly to configuring static
2767 IPv6 routes, the setting is configured as an IPv6 prefix routes and its prefix route length,
2768 separated by a <literal>/</literal> character. Use multiple [IPv6PrefixRoutes] sections to configure
2769 multiple IPv6 prefix routes.</para></listitem>
203d4df5
SS
2770 </varlistentry>
2771
2772 <varlistentry>
2773 <term><varname>LifetimeSec=</varname></term>
2774
2775 <listitem><para>Lifetime for the route prefix measured in
2776 seconds. <varname>LifetimeSec=</varname> defaults to 604800 seconds (one week).
2777 </para></listitem>
3f9e0236
PF
2778 </varlistentry>
2779
2780 </variablelist>
2781 </refsect1>
2782
2783 <refsect1>
798d3a52 2784 <title>[Bridge] Section Options</title>
bdac5608 2785 <para>The [Bridge] section accepts the following keys:</para>
798d3a52 2786 <variablelist class='network-directives'>
165c41a9
SS
2787 <varlistentry>
2788 <term><varname>UnicastFlood=</varname></term>
2789 <listitem>
9b6ffef3 2790 <para>Takes a boolean. Controls whether the bridge should flood
072f9e4a 2791 traffic for which an FDB entry is missing and the destination
025314d9 2792 is unknown through this port. When unset, the kernel's default will be used.
47c7dfe2 2793 </para>
165c41a9
SS
2794 </listitem>
2795 </varlistentry>
7f15b714
TJ
2796 <varlistentry>
2797 <term><varname>MulticastFlood=</varname></term>
2798 <listitem>
2799 <para>Takes a boolean. Controls whether the bridge should flood
2800 traffic for which an MDB entry is missing and the destination
2801 is unknown through this port. When unset, the kernel's default will be used.
2802 </para>
2803 </listitem>
2804 </varlistentry>
d3aa8b49
SS
2805 <varlistentry>
2806 <term><varname>MulticastToUnicast=</varname></term>
2807 <listitem>
2808 <para>Takes a boolean. Multicast to unicast works on top of the multicast snooping feature of
2809 the bridge. Which means unicast copies are only delivered to hosts which are interested in it.
2810 When unset, the kernel's default will be used.
2811 </para>
2812 </listitem>
2813 </varlistentry>
7f15b714
TJ
2814 <varlistentry>
2815 <term><varname>NeighborSuppression=</varname></term>
2816 <listitem>
2817 <para>Takes a boolean. Configures whether ARP and ND neighbor suppression is enabled for
2818 this port. When unset, the kernel's default will be used.
2819 </para>
2820 </listitem>
2821 </varlistentry>
2822 <varlistentry>
2823 <term><varname>Learning=</varname></term>
2824 <listitem>
2825 <para>Takes a boolean. Configures whether MAC address learning is enabled for
2826 this port. When unset, the kernel's default will be used.
2827 </para>
2828 </listitem>
2829 </varlistentry>
165c41a9
SS
2830 <varlistentry>
2831 <term><varname>HairPin=</varname></term>
2832 <listitem>
e9dd6984
ZJS
2833 <para>Takes a boolean. Configures whether traffic may be sent back out of the port on which it
2834 was received. When this flag is false, then the bridge will not forward traffic back out of the
2835 receiving port. When unset, the kernel's default will be used.</para>
165c41a9
SS
2836 </listitem>
2837 </varlistentry>
2838 <varlistentry>
84c34096 2839 <term><varname>UseBPDU=</varname></term>
165c41a9 2840 <listitem>
9b6ffef3 2841 <para>Takes a boolean. Configures whether STP Bridge Protocol Data Units will be
025314d9 2842 processed by the bridge port. When unset, the kernel's default will be used.</para>
165c41a9
SS
2843 </listitem>
2844 </varlistentry>
2845 <varlistentry>
2846 <term><varname>FastLeave=</varname></term>
2847 <listitem>
9b6ffef3 2848 <para>Takes a boolean. This flag allows the bridge to immediately stop multicast
a8eaaee7 2849 traffic on a port that receives an IGMP Leave message. It is only used with
025314d9 2850 IGMP snooping if enabled on the bridge. When unset, the kernel's default will be used.</para>
165c41a9
SS
2851 </listitem>
2852 </varlistentry>
2853 <varlistentry>
23da66bb 2854 <term><varname>AllowPortToBeRoot=</varname></term>
165c41a9 2855 <listitem>
9b6ffef3 2856 <para>Takes a boolean. Configures whether a given port is allowed to
47c7dfe2 2857 become a root port. Only used when STP is enabled on the bridge.
025314d9 2858 When unset, the kernel's default will be used.</para>
165c41a9
SS
2859 </listitem>
2860 </varlistentry>
1087623b
SS
2861 <varlistentry>
2862 <term><varname>ProxyARP=</varname></term>
2863 <listitem>
2864 <para>Takes a boolean. Configures whether proxy ARP to be enabled on this port.
2865 When unset, the kernel's default will be used.</para>
2866 </listitem>
2867 </varlistentry>
2868 <varlistentry>
2869 <term><varname>ProxyARPWiFi=</varname></term>
2870 <listitem>
2871 <para>Takes a boolean. Configures whether proxy ARP to be enabled on this port
2872 which meets extended requirements by IEEE 802.11 and Hotspot 2.0 specifications.
2873 When unset, the kernel's default will be used.</para>
2874 </listitem>
2875 </varlistentry>
0fadb2a4
SS
2876 <varlistentry>
2877 <term><varname>MulticastRouter=</varname></term>
2878 <listitem>
2879 <para>Configures this port for having multicast routers attached. A port with a multicast
2880 router will receive all multicast traffic. Takes one of <literal>no</literal>
2881 to disable multicast routers on this port, <literal>query</literal> to let the system detect
2882 the presence of routers, <literal>permanent</literal> to permanently enable multicast traffic
2883 forwarding on this port, or <literal>temporary</literal> to enable multicast routers temporarily
2884 on this port, not depending on incoming queries. When unset, the kernel's default will be used.</para>
2885 </listitem>
2886 </varlistentry>
798d3a52
ZJS
2887 <varlistentry>
2888 <term><varname>Cost=</varname></term>
2889 <listitem>
47c7dfe2 2890 <para>Sets the "cost" of sending packets of this interface.
a8eaaee7 2891 Each port in a bridge may have a different speed and the cost
798d3a52 2892 is used to decide which link to use. Faster interfaces
785889e5 2893 should have lower costs. It is an integer value between 1 and
b56be296
DJL
2894 65535.</para>
2895 </listitem>
2896 </varlistentry>
2897 <varlistentry>
2898 <term><varname>Priority=</varname></term>
2899 <listitem>
2900 <para>Sets the "priority" of sending packets on this interface.
2901 Each port in a bridge may have a different priority which is used
2902 to decide which link to use. Lower value means higher priority.
785889e5 2903 It is an integer value between 0 to 63. Networkd does not set any
b56be296 2904 default, meaning the kernel default value of 32 is used.</para>
798d3a52
ZJS
2905 </listitem>
2906 </varlistentry>
2907 </variablelist>
2908 </refsect1>
798d3a52
ZJS
2909 <refsect1>
2910 <title>[BridgeFDB] Section Options</title>
bdac5608
ZJS
2911 <para>The [BridgeFDB] section manages the forwarding database table of a port and accepts the following
2912 keys. Specify several [BridgeFDB] sections to configure several static MAC table entries.</para>
798d3a52
ZJS
2913
2914 <variablelist class='network-directives'>
2915 <varlistentry>
2916 <term><varname>MACAddress=</varname></term>
2917 <listitem>
bdac5608 2918 <para>As in the [Network] section. This key is mandatory.</para>
798d3a52
ZJS
2919 </listitem>
2920 </varlistentry>
c2c2793f
SS
2921 <varlistentry>
2922 <term><varname>Destination=</varname></term>
2923 <listitem>
2924 <para>Takes an IP address of the destination VXLAN tunnel endpoint.</para>
2925 </listitem>
2926 </varlistentry>
798d3a52
ZJS
2927 <varlistentry>
2928 <term><varname>VLANId=</varname></term>
2929 <listitem>
a8eaaee7 2930 <para>The VLAN ID for the new static MAC table entry. If
db9b9fb9 2931 omitted, no VLAN ID information is appended to the new static MAC
798d3a52
ZJS
2932 table entry.</para>
2933 </listitem>
2934 </varlistentry>
61b824c5
SS
2935 <varlistentry>
2936 <term><varname>VNI=</varname></term>
2937 <listitem>
2938 <para>The VXLAN Network Identifier (or VXLAN Segment ID) to use to connect to
1d3a473b 2939 the remote VXLAN tunnel endpoint. Takes a number in the range 1…16777215.
61b824c5
SS
2940 Defaults to unset.</para>
2941 </listitem>
2942 </varlistentry>
bdb397ed
SS
2943 <varlistentry>
2944 <term><varname>AssociatedWith=</varname></term>
2945 <listitem>
2946 <para>Specifies where the address is associated with. Takes one of <literal>use</literal>,
2947 <literal>self</literal>, <literal>master</literal> or <literal>router</literal>.
2948 <literal>use</literal> means the address is in use. User space can use this option to
2949 indicate to the kernel that the fdb entry is in use. <literal>self</literal> means
2950 the address is associated with the port drivers fdb. Usually hardware. <literal>master</literal>
2951 means the address is associated with master devices fdb. <literal>router</literal> means
2952 the destination address is associated with a router. Note that it's valid if the referenced
2953 device is a VXLAN type device and has route shortcircuit enabled. Defaults to <literal>self</literal>.</para>
2954 </listitem>
2955 </varlistentry>
af99cdf4
SS
2956 <varlistentry>
2957 <term><varname>OutgoingInterface=</varname></term>
2958 <listitem>
2959 <para>Specifies the name or index of the outgoing interface for the VXLAN device driver to
2960 reach the remote VXLAN tunnel endpoint. Defaults to unset.</para>
2961 </listitem>
2962 </varlistentry>
798d3a52
ZJS
2963 </variablelist>
2964 </refsect1>
a1717e9a
DM
2965 <refsect1>
2966 <title>[BridgeMDB] Section Options</title>
2967 <para>The [BridgeMDB] section manages the multicast membership entries forwarding database table of a port and accepts the following
2968 keys. Specify several [BridgeMDB] sections to configure several permanent multicast membership entries.</para>
2969
2970 <variablelist class='network-directives'>
2971 <varlistentry>
2972 <term><varname>MulticastGroupAddress=</varname></term>
2973 <listitem>
2974 <para>Specifies the IPv4 or IPv6 multicast group address to add. This setting is mandatory.</para>
2975 </listitem>
2976 </varlistentry>
2977 <varlistentry>
2978 <term><varname>VLANId=</varname></term>
2979 <listitem>
2980 <para>The VLAN ID for the new entry. Valid ranges are 0 (no VLAN) to 4094. Optional, defaults to 0.</para>
2981 </listitem>
2982 </varlistentry>
2983 </variablelist>
2984 </refsect1>
06828bb6 2985
e9a8c550
SS
2986 <refsect1>
2987 <title>[LLDP] Section Options</title>
bdac5608 2988 <para>The [LLDP] section manages the Link Layer Discovery Protocol (LLDP) and accepts the following
885a4e6c 2989 keys:</para>
e9a8c550
SS
2990 <variablelist class='network-directives'>
2991 <varlistentry>
2992 <term><varname>MUDURL=</varname></term>
2993 <listitem>
0558f303
ZJS
2994 <para>When configured, the specified Manufacturer Usage Descriptions (MUD) URL will be sent in
2995 LLDP packets. The syntax and semantics are the same as for <varname>MUDURL=</varname> in the
2996 [DHCPv4] section described above.</para>
2997
2998 <para>The MUD URLs received via LLDP packets are saved and can be read using the
e9a8c550
SS
2999 <function>sd_lldp_neighbor_get_mud_url()</function> function.</para>
3000 </listitem>
3001 </varlistentry>
3002 </variablelist>
3003 </refsect1>
3004
06828bb6
HP
3005 <refsect1>
3006 <title>[CAN] Section Options</title>
bdac5608
ZJS
3007 <para>The [CAN] section manages the Controller Area Network (CAN bus) and accepts the
3008 following keys:</para>
06828bb6
HP
3009 <variablelist class='network-directives'>
3010 <varlistentry>
3011 <term><varname>BitRate=</varname></term>
3012 <listitem>
3013 <para>The bitrate of CAN device in bits per second. The usual SI prefixes (K, M) with the base of 1000 can
1d3a473b 3014 be used here. Takes a number in the range 1…4294967295.</para>
06828bb6
HP
3015 </listitem>
3016 </varlistentry>
3017 <varlistentry>
3018 <term><varname>SamplePoint=</varname></term>
3019 <listitem>
3020 <para>Optional sample point in percent with one decimal (e.g. <literal>75%</literal>,
817561cc
YW
3021 <literal>87.5%</literal>) or permille (e.g. <literal>875‰</literal>). This will be ignored when
3022 <varname>BitRate=</varname> is unspecified.</para>
06828bb6
HP
3023 </listitem>
3024 </varlistentry>
b164b570
YW
3025 <varlistentry>
3026 <term><varname>TimeQuantaNSec=</varname></term>
3027 <term><varname>PropagationSegment=</varname></term>
3028 <term><varname>PhaseBufferSegment1=</varname></term>
3029 <term><varname>PhaseBufferSegment2=</varname></term>
3030 <term><varname>SyncJumpWidth=</varname></term>
3031 <listitem>
3032 <para>Specifies the time quanta, propagation segment, phase buffer segment 1 and 2, and the
3033 synchronization jump width, which allow to define the CAN bit-timing in a hardware
3034 independent format as proposed by the Bosch CAN 2.0 Specification.
3035 <varname>TimeQuantaNSec=</varname> takes a timespan in nanoseconds.
3036 <varname>PropagationSegment=</varname>, <varname>PhaseBufferSegment1=</varname>,
3037 <varname>PhaseBufferSegment2=</varname>, and <varname>SyncJumpWidth=</varname> take number
3038 of time quantum specified in <varname>TimeQuantaNSec=</varname> and must be an unsigned
3039 integer in the range 0…4294967295. These settings except for
3040 <varname>SyncJumpWidth=</varname> will be ignored when <varname>BitRate=</varname> is
3041 specified.</para>
06828bb6
HP
3042 </listitem>
3043 </varlistentry>
7e025e9c
RP
3044 <varlistentry>
3045 <term><varname>DataBitRate=</varname></term>
3046 <term><varname>DataSamplePoint=</varname></term>
3047 <listitem>
3048 <para>The bitrate and sample point for the data phase, if CAN-FD is used. These settings are
3049 analogous to the <varname>BitRate=</varname> and <varname>SamplePoint=</varname> keys.</para>
3050 </listitem>
3051 </varlistentry>
b164b570
YW
3052 <varlistentry>
3053 <term><varname>DataTimeQuantaNSec=</varname></term>
3054 <term><varname>DataPropagationSegment=</varname></term>
3055 <term><varname>DataPhaseBufferSegment1=</varname></term>
3056 <term><varname>DataPhaseBufferSegment2=</varname></term>
3057 <term><varname>DataSyncJumpWidth=</varname></term>
3058 <listitem>
3059 <para>Specifies the time quanta, propagation segment, phase buffer segment 1 and 2, and the
3060 synchronization jump width for the data phase, if CAN-FD is used. These settings are
3061 analogous to the <varname>TimeQuantaNSec=</varname> or related settings.</para>
3062 </listitem>
3063 </varlistentry>
7e025e9c
RP
3064 <varlistentry>
3065 <term><varname>FDMode=</varname></term>
3066 <listitem>
3067 <para>Takes a boolean. When <literal>yes</literal>, CAN-FD mode is enabled for the interface.
3068 Note, that a bitrate and optional sample point should also be set for the CAN-FD data phase using
b164b570
YW
3069 the <varname>DataBitRate=</varname> and <varname>DataSamplePoint=</varname> keys, or
3070 <varname>DataTimeQuanta=</varname> and related settings.</para>
7e025e9c
RP
3071 </listitem>
3072 </varlistentry>
3073 <varlistentry>
3074 <term><varname>FDNonISO=</varname></term>
3075 <listitem>
3076 <para>Takes a boolean. When <literal>yes</literal>, non-ISO CAN-FD mode is enabled for the
3077 interface. When unset, the kernel's default will be used.</para>
3078 </listitem>
3079 </varlistentry>
06828bb6
HP
3080 <varlistentry>
3081 <term><varname>RestartSec=</varname></term>
3082 <listitem>
3083 <para>Automatic restart delay time. If set to a non-zero value, a restart of the CAN controller will be
3084 triggered automatically in case of a bus-off condition after the specified delay time. Subsecond delays can
3085 be specified using decimals (e.g. <literal>0.1s</literal>) or a <literal>ms</literal> or
3086 <literal>us</literal> postfix. Using <literal>infinity</literal> or <literal>0</literal> will turn the
3087 automatic restart off. By default automatic restart is disabled.</para>
3088 </listitem>
3089 </varlistentry>
52aa38f1
MR
3090 <varlistentry>
3091 <term><varname>Termination=</varname></term>
3092 <listitem>
239f91f7
YW
3093 <para>Takes a boolean or a termination resistor value in ohm in the range 0–65535. When
3094 <literal>yes</literal>, the termination resistor is set to 120 ohm. When
3095 <literal>no</literal> or <literal>0</literal> is set, the termination resistor is disabled.
3096 When unset, the kernel's default will be used.</para>
52aa38f1
MR
3097 </listitem>
3098 </varlistentry>
c423be28
CG
3099 <varlistentry>
3100 <term><varname>TripleSampling=</varname></term>
3101 <listitem>
3102 <para>Takes a boolean. When <literal>yes</literal>, three samples (instead of one) are used to determine
3103 the value of a received bit by majority rule. When unset, the kernel's default will be used.</para>
3104 </listitem>
3105 </varlistentry>
77b67404
3106 <varlistentry>
3107 <term><varname>BusErrorReporting=</varname></term>
3108 <listitem>
3109 <para>Takes a boolean. When <literal>yes</literal>, reporting of CAN bus errors is activated
3110 (those include single bit, frame format, and bit stuffing errors, unable to send dominant bit,
3111 unable to send recessive bit, bus overload, active error announcement, error occurred on
3112 transmission). When unset, the kernel's default will be used. Note: in case of a CAN bus with a
3113 single CAN device, sending a CAN frame may result in a huge number of CAN bus errors.</para>
3114 </listitem>
3115 </varlistentry>
74f0fb90
YW
3116 <varlistentry>
3117 <term><varname>ListenOnly=</varname></term>
3118 <listitem>
3119 <para>Takes a boolean. When <literal>yes</literal>, listen-only mode is enabled. When the
3120 interface is in listen-only mode, the interface neither transmit CAN frames nor send ACK
3121 bit. Listen-only mode is important to debug CAN networks without interfering with the
3122 communication or acknowledge the CAN frame. When unset, the kernel's default will be used.
3123 </para>
3124 </listitem>
3125 </varlistentry>
6dd84c9e
YW
3126 <varlistentry>
3127 <term><varname>Loopback=</varname></term>
3128 <listitem>
3129 <para>Takes a boolean. When <literal>yes</literal>, loopback mode is enabled. When the
3130 loopback mode is enabled, the interface treats messages transmitted by itself as received
3131 messages. The loopback mode is important to debug CAN networks. When unset, the kernel's
3132 default will be used.</para>
3133 </listitem>
3134 </varlistentry>
3135 <varlistentry>
3136 <term><varname>OneShot=</varname></term>
3137 <listitem>
3138 <para>Takes a boolean. When <literal>yes</literal>, one-shot mode is enabled. When unset,
3139 the kernel's default will be used.</para>
3140 </listitem>
3141 </varlistentry>
3142 <varlistentry>
3143 <term><varname>PresumeAck=</varname></term>
3144 <listitem>
3145 <para>Takes a boolean. When <literal>yes</literal>, the interface will ignore missing CAN
3146 ACKs. When unset, the kernel's default will be used.</para>
3147 </listitem>
3148 </varlistentry>
3149 <varlistentry>
3150 <term><varname>ClassicDataLengthCode=</varname></term>
3151 <listitem>
3152 <para>Takes a boolean. When <literal>yes</literal>, the interface will handle the 4bit data
3153 length code (DLC). When unset, the kernel's default will be used.</para>
3154 </listitem>
3155 </varlistentry>
06828bb6
HP
3156 </variablelist>
3157 </refsect1>
3158
2ed5f6d5
YW
3159 <refsect1>
3160 <title>[QDisc] Section Options</title>
bdac5608 3161 <para>The [QDisc] section manages the traffic control queueing discipline (qdisc).</para>
2ed5f6d5
YW
3162
3163 <variablelist class='network-directives'>
3164 <varlistentry>
3165 <term><varname>Parent=</varname></term>
3166 <listitem>
3167 <para>Specifies the parent Queueing Discipline (qdisc). Takes one of <literal>clsact</literal>
3168 or <literal>ingress</literal>. This is mandatory.</para>
3169 </listitem>
3170 </varlistentry>
d8b2396d 3171
f344a492 3172 <xi:include href="tc.xml" xpointer="qdisc-handle" />
2ed5f6d5
YW
3173 </variablelist>
3174 </refsect1>
3175
0f5bd7fe 3176 <refsect1>
18de0969 3177 <title>[NetworkEmulator] Section Options</title>
bdac5608
ZJS
3178 <para>The [NetworkEmulator] section manages the queueing discipline (qdisc) of the network emulator. It
3179 can be used to configure the kernel packet scheduler and simulate packet delay and loss for UDP or TCP
3180 applications, or limit the bandwidth usage of a particular service to simulate internet connections.
3181 </para>
0f5bd7fe
SS
3182
3183 <variablelist class='network-directives'>
f344a492
YW
3184 <xi:include href="tc.xml" xpointer="qdisc-parent" />
3185 <xi:include href="tc.xml" xpointer="qdisc-handle" />
d8b2396d 3186
0f5bd7fe 3187 <varlistentry>
18de0969 3188 <term><varname>DelaySec=</varname></term>
0f5bd7fe
SS
3189 <listitem>
3190 <para>Specifies the fixed amount of delay to be added to all packets going out of the
3191 interface. Defaults to unset.</para>
3192 </listitem>
3193 </varlistentry>
3194
3195 <varlistentry>
18de0969 3196 <term><varname>DelayJitterSec=</varname></term>
0f5bd7fe
SS
3197 <listitem>
3198 <para>Specifies the chosen delay to be added to the packets outgoing to the network
3199 interface. Defaults to unset.</para>
3200 </listitem>
3201 </varlistentry>
3202
3203 <varlistentry>
18de0969 3204 <term><varname>PacketLimit=</varname></term>
0f5bd7fe
SS
3205 <listitem>
3206 <para>Specifies the maximum number of packets the qdisc may hold queued at a time.
e9dd6984 3207 An unsigned integer in the range 0–4294967294. Defaults to 1000.</para>
0f5bd7fe
SS
3208 </listitem>
3209 </varlistentry>
3210
3211 <varlistentry>
18de0969 3212 <term><varname>LossRate=</varname></term>
0f5bd7fe
SS
3213 <listitem>
3214 <para>Specifies an independent loss probability to be added to the packets outgoing from the
3215 network interface. Takes a percentage value, suffixed with "%". Defaults to unset.</para>
3216 </listitem>
3217 </varlistentry>
3218
b9c5aa3c 3219 <varlistentry>
18de0969 3220 <term><varname>DuplicateRate=</varname></term>
b9c5aa3c
SS
3221 <listitem>
3222 <para>Specifies that the chosen percent of packets is duplicated before queuing them.
3223 Takes a percentage value, suffixed with "%". Defaults to unset.</para>
3224 </listitem>
3225 </varlistentry>
18de0969
YW
3226 </variablelist>
3227 </refsect1>
b9c5aa3c 3228
18de0969 3229 <refsect1>
60ed2dcf 3230 <title>[TokenBucketFilter] Section Options</title>
e9dd6984
ZJS
3231 <para>The [TokenBucketFilter] section manages the queueing discipline (qdisc) of token bucket filter
3232 (tbf).</para>
18de0969
YW
3233
3234 <variablelist class='network-directives'>
f344a492
YW
3235 <xi:include href="tc.xml" xpointer="qdisc-parent" />
3236 <xi:include href="tc.xml" xpointer="qdisc-handle" />
d8b2396d 3237
18de0969
YW
3238 <varlistentry>
3239 <term><varname>LatencySec=</varname></term>
ba5841b5
SS
3240 <listitem>
3241 <para>Specifies the latency parameter, which specifies the maximum amount of time a
60ed2dcf 3242 packet can sit in the Token Bucket Filter (TBF). Defaults to unset.</para>
ba5841b5
SS
3243 </listitem>
3244 </varlistentry>
3245
dcfc23ae 3246 <varlistentry>
c03ef420 3247 <term><varname>LimitBytes=</varname></term>
dcfc23ae
YW
3248 <listitem>
3249 <para>Takes the number of bytes that can be queued waiting for tokens to become available.
3250 When the size is suffixed with K, M, or G, it is parsed as Kilobytes, Megabytes, or Gigabytes,
c03ef420 3251 respectively, to the base of 1024. Defaults to unset.</para>
dcfc23ae
YW
3252 </listitem>
3253 </varlistentry>
3254
ba5841b5 3255 <varlistentry>
c03ef420 3256 <term><varname>BurstBytes=</varname></term>
ba5841b5
SS
3257 <listitem>
3258 <para>Specifies the size of the bucket. This is the maximum amount of bytes that tokens
3259 can be available for instantaneous transfer. When the size is suffixed with K, M, or G, it is
c03ef420 3260 parsed as Kilobytes, Megabytes, or Gigabytes, respectively, to the base of 1024. Defaults to
ba5841b5
SS
3261 unset.</para>
3262 </listitem>
3263 </varlistentry>
3264
3265 <varlistentry>
18de0969 3266 <term><varname>Rate=</varname></term>
ba5841b5
SS
3267 <listitem>
3268 <para>Specifies the device specific bandwidth. When suffixed with K, M, or G, the specified
6b8fe4c3 3269 bandwidth is parsed as Kilobits, Megabits, or Gigabits, respectively, to the base of 1000.
ba5841b5
SS
3270 Defaults to unset.</para>
3271 </listitem>
3272 </varlistentry>
3273
dcfc23ae 3274 <varlistentry>
18de0969 3275 <term><varname>MPUBytes=</varname></term>
dcfc23ae
YW
3276 <listitem>
3277 <para>The Minimum Packet Unit (MPU) determines the minimal token usage (specified in bytes)
3278 for a packet. When suffixed with K, M, or G, the specified size is parsed as Kilobytes,
c03ef420 3279 Megabytes, or Gigabytes, respectively, to the base of 1024. Defaults to zero.</para>
dcfc23ae
YW
3280 </listitem>
3281 </varlistentry>
3282
3283 <varlistentry>
18de0969 3284 <term><varname>PeakRate=</varname></term>
dcfc23ae
YW
3285 <listitem>
3286 <para>Takes the maximum depletion rate of the bucket. When suffixed with K, M, or G, the
6b8fe4c3 3287 specified size is parsed as Kilobits, Megabits, or Gigabits, respectively, to the base of
dcfc23ae
YW
3288 1000. Defaults to unset.</para>
3289 </listitem>
3290 </varlistentry>
3291
3292 <varlistentry>
18de0969 3293 <term><varname>MTUBytes=</varname></term>
dcfc23ae
YW
3294 <listitem>
3295 <para>Specifies the size of the peakrate bucket. When suffixed with K, M, or G, the specified
c03ef420 3296 size is parsed as Kilobytes, Megabytes, or Gigabytes, respectively, to the base of 1024.
dcfc23ae
YW
3297 Defaults to unset.</para>
3298 </listitem>
3299 </varlistentry>
18de0969
YW
3300 </variablelist>
3301 </refsect1>
3302
bde4ae88
SS
3303 <refsect1>
3304 <title>[PIE] Section Options</title>
bdac5608
ZJS
3305 <para>The [PIE] section manages the queueing discipline (qdisc) of Proportional Integral
3306 controller-Enhanced (PIE).</para>
bde4ae88
SS
3307
3308 <variablelist class='network-directives'>
f344a492
YW
3309 <xi:include href="tc.xml" xpointer="qdisc-parent" />
3310 <xi:include href="tc.xml" xpointer="qdisc-handle" />
bde4ae88
SS
3311
3312 <varlistentry>
3313 <term><varname>PacketLimit=</varname></term>
3314 <listitem>
1d3a473b
ZJS
3315 <para>Specifies the hard limit on the queue size in number of packets. When this limit is reached,
3316 incoming packets are dropped. An unsigned integer in the range 1…4294967294. Defaults to unset and
3317 kernel's default is used.</para>
8f6b6d70
SS
3318 </listitem>
3319 </varlistentry>
3320 </variablelist>
3321 </refsect1>
3322
3323 <refsect1>
3324 <title>[FlowQueuePIE] Section Options</title>
3325 <para>The <literal>[FlowQueuePIE]</literal> section manages the queueing discipline
3326 (qdisc) of Flow Queue Proportional Integral controller-Enhanced (fq_pie).</para>
3327
3328 <variablelist class='network-directives'>
3329 <xi:include href="tc.xml" xpointer="qdisc-parent" />
3330 <xi:include href="tc.xml" xpointer="qdisc-handle" />
3331
3332 <varlistentry>
3333 <term><varname>PacketLimit=</varname></term>
3334 <listitem>
75909cc7
ZJS
3335 <para>Specifies the hard limit on the queue size in number of packets. When this limit is reached,
3336 incoming packets are dropped. An unsigned integer ranges 1 to 4294967294. Defaults to unset and
3337 kernel's default is used.</para>
bde4ae88
SS
3338 </listitem>
3339 </varlistentry>
3340 </variablelist>
3341 </refsect1>
3342
982998b0
SS
3343 <refsect1>
3344 <title>[StochasticFairBlue] Section Options</title>
bdac5608
ZJS
3345 <para>The [StochasticFairBlue] section manages the queueing discipline (qdisc) of stochastic fair blue
3346 (sfb).</para>
982998b0
SS
3347
3348 <variablelist class='network-directives'>
f344a492
YW
3349 <xi:include href="tc.xml" xpointer="qdisc-parent" />
3350 <xi:include href="tc.xml" xpointer="qdisc-handle" />
982998b0
SS
3351
3352 <varlistentry>
3353 <term><varname>PacketLimit=</varname></term>
3354 <listitem>
e9dd6984
ZJS
3355 <para>Specifies the hard limit on the queue size in number of packets. When this limit is reached,
3356 incoming packets are dropped. An unsigned integer in the range 0–4294967294. Defaults to unset and
3357 kernel's default is used.</para>
982998b0
SS
3358 </listitem>
3359 </varlistentry>
3360 </variablelist>
3361 </refsect1>
3362
18de0969
YW
3363 <refsect1>
3364 <title>[StochasticFairnessQueueing] Section Options</title>
bdac5608
ZJS
3365 <para>The [StochasticFairnessQueueing] section manages the queueing discipline (qdisc) of stochastic
3366 fairness queueing (sfq).</para>
18de0969
YW
3367
3368 <variablelist class='network-directives'>
f344a492
YW
3369 <xi:include href="tc.xml" xpointer="qdisc-parent" />
3370 <xi:include href="tc.xml" xpointer="qdisc-handle" />
d8b2396d 3371
9942b710 3372 <varlistentry>
18de0969 3373 <term><varname>PerturbPeriodSec=</varname></term>
9942b710
SS
3374 <listitem>
3375 <para>Specifies the interval in seconds for queue algorithm perturbation. Defaults to unset.</para>
3376 </listitem>
3377 </varlistentry>
18de0969
YW
3378 </variablelist>
3379 </refsect1>
3380
c853f594
SS
3381 <refsect1>
3382 <title>[BFIFO] Section Options</title>
bdac5608
ZJS
3383 <para>The [BFIFO] section manages the queueing discipline (qdisc) of Byte limited Packet First In First
3384 Out (bfifo).</para>
c853f594
SS
3385
3386 <variablelist class='network-directives'>
f344a492
YW
3387 <xi:include href="tc.xml" xpointer="qdisc-parent" />
3388 <xi:include href="tc.xml" xpointer="qdisc-handle" />
c853f594
SS
3389
3390 <varlistentry>
c03ef420 3391 <term><varname>LimitBytes=</varname></term>
c853f594 3392 <listitem>
885a4e6c
ZJS
3393 <para>Specifies the hard limit in bytes on the FIFO buffer size. The size limit prevents overflow
3394 in case the kernel is unable to dequeue packets as quickly as it receives them. When this limit is
3395 reached, incoming packets are dropped. When suffixed with K, M, or G, the specified size is parsed
3396 as Kilobytes, Megabytes, or Gigabytes, respectively, to the base of 1024. Defaults to unset and
3397 kernel default is used.</para>
c853f594
SS
3398 </listitem>
3399 </varlistentry>
3400 </variablelist>
3401 </refsect1>
3402
a7476065
SS
3403 <refsect1>
3404 <title>[PFIFO] Section Options</title>
bdac5608
ZJS
3405 <para>The [PFIFO] section manages the queueing discipline (qdisc) of Packet First In First Out
3406 (pfifo).</para>
a7476065
SS
3407
3408 <variablelist class='network-directives'>
f344a492
YW
3409 <xi:include href="tc.xml" xpointer="qdisc-parent" />
3410 <xi:include href="tc.xml" xpointer="qdisc-handle" />
a7476065
SS
3411
3412 <varlistentry>
3413 <term><varname>PacketLimit=</varname></term>
3414 <listitem>
75909cc7
ZJS
3415 <para>Specifies the hard limit on the number of packets in the FIFO queue. The size limit prevents
3416 overflow in case the kernel is unable to dequeue packets as quickly as it receives them. When this
3417 limit is reached, incoming packets are dropped. An unsigned integer in the range
3418 0–4294967294. Defaults to unset and kernel's default is used.</para>
a7476065
SS
3419 </listitem>
3420 </varlistentry>
ad8352f4
SS
3421 </variablelist>
3422 </refsect1>
3423
053a2ddb
SS
3424 <refsect1>
3425 <title>[PFIFOHeadDrop] Section Options</title>
bdac5608
ZJS
3426 <para>The [PFIFOHeadDrop] section manages the queueing discipline (qdisc) of Packet First In First Out
3427 Head Drop (pfifo_head_drop).</para>
053a2ddb
SS
3428
3429 <variablelist class='network-directives'>
f344a492
YW
3430 <xi:include href="tc.xml" xpointer="qdisc-parent" />
3431 <xi:include href="tc.xml" xpointer="qdisc-handle" />
053a2ddb
SS
3432
3433 <varlistentry>
3434 <term><varname>PacketLimit=</varname></term>
3435 <listitem>
bdac5608 3436 <para>As in [PFIFO] section.</para></listitem>
053a2ddb
SS
3437 </varlistentry>
3438 </variablelist>
3439 </refsect1>
3440
1a95964b
SS
3441 <refsect1>
3442 <title>[PFIFOFast] Section Options</title>
bdac5608
ZJS
3443 <para>The [PFIFOFast] section manages the queueing discipline (qdisc) of Packet First In First Out Fast
3444 (pfifo_fast).</para>
1a95964b
SS
3445
3446 <variablelist class='network-directives'>
f344a492
YW
3447 <xi:include href="tc.xml" xpointer="qdisc-parent" />
3448 <xi:include href="tc.xml" xpointer="qdisc-handle" />
1a95964b
SS
3449 </variablelist>
3450 </refsect1>
3451
ad8352f4
SS
3452 <refsect1>
3453 <title>[CAKE] Section Options</title>
bdac5608
ZJS
3454 <para>The [CAKE] section manages the queueing discipline (qdisc) of Common Applications Kept Enhanced
3455 (CAKE).</para>
ad8352f4
SS
3456
3457 <variablelist class='network-directives'>
f344a492
YW
3458 <xi:include href="tc.xml" xpointer="qdisc-parent" />
3459 <xi:include href="tc.xml" xpointer="qdisc-handle" />
a7476065 3460
ad8352f4 3461 <varlistentry>
c03ef420 3462 <term><varname>OverheadBytes=</varname></term>
ad8352f4 3463 <listitem>
e9dd6984
ZJS
3464 <para>Specifies that bytes to be addeded to the size of each packet. Bytes may be negative. Takes
3465 an integer in the range from -64 to 256. Defaults to unset and kernel's default is used.</para>
ad8352f4 3466 </listitem>
f344a492 3467 </varlistentry>
ad8352f4
SS
3468
3469 <varlistentry>
3470 <term><varname>Bandwidth=</varname></term>
3471 <listitem>
3472 <para>Specifies the shaper bandwidth. When suffixed with K, M, or G, the specified size is
3473 parsed as Kilobits, Megabits, or Gigabits, respectively, to the base of 1000. Defaults to
3474 unset and kernel's default is used.</para>
3475 </listitem>
3476 </varlistentry>
a7476065
SS
3477 </variablelist>
3478 </refsect1>
3479
18de0969
YW
3480 <refsect1>
3481 <title>[ControlledDelay] Section Options</title>
bdac5608 3482 <para>The [ControlledDelay] section manages the queueing discipline (qdisc) of
18de0969 3483 controlled delay (CoDel).</para>
9942b710 3484
18de0969 3485 <variablelist class='network-directives'>
f344a492
YW
3486 <xi:include href="tc.xml" xpointer="qdisc-parent" />
3487 <xi:include href="tc.xml" xpointer="qdisc-handle" />
d8b2396d 3488
18de0969
YW
3489 <varlistentry>
3490 <term><varname>PacketLimit=</varname></term>
a9a5d632 3491 <listitem>
e9dd6984
ZJS
3492 <para>Specifies the hard limit on the queue size in number of packets. When this limit is reached,
3493 incoming packets are dropped. An unsigned integer in the range 0–4294967294. Defaults to unset and
3494 kernel's default is used.</para>
a9a5d632
SS
3495 </listitem>
3496 </varlistentry>
3497
b078e528 3498 <varlistentry>
18de0969 3499 <term><varname>TargetSec=</varname></term>
b078e528
YW
3500 <listitem>
3501 <para>Takes a timespan. Specifies the acceptable minimum standing/persistent queue delay.
3502 Defaults to unset and kernel's default is used.</para>
3503 </listitem>
3504 </varlistentry>
3505
3506 <varlistentry>
18de0969 3507 <term><varname>IntervalSec=</varname></term>
b078e528
YW
3508 <listitem>
3509 <para>Takes a timespan. This is used to ensure that the measured minimum delay does not
3510 become too stale. Defaults to unset and kernel's default is used.</para>
3511 </listitem>
3512 </varlistentry>
3513
3514 <varlistentry>
18de0969 3515 <term><varname>ECN=</varname></term>
b078e528
YW
3516 <listitem>
3517 <para>Takes a boolean. This can be used to mark packets instead of dropping them. Defaults to
3518 unset and kernel's default is used.</para>
3519 </listitem>
3520 </varlistentry>
3521
3522 <varlistentry>
18de0969 3523 <term><varname>CEThresholdSec=</varname></term>
b078e528
YW
3524 <listitem>
3525 <para>Takes a timespan. This sets a threshold above which all packets are marked with ECN
3526 Congestion Experienced (CE). Defaults to unset and kernel's default is used.</para>
3527 </listitem>
3528 </varlistentry>
18de0969
YW
3529 </variablelist>
3530 </refsect1>
b078e528 3531
f5fc0441
SS
3532 <refsect1>
3533 <title>[DeficitRoundRobinScheduler] Section Options</title>
bdac5608
ZJS
3534 <para>The [DeficitRoundRobinScheduler] section manages the queueing discipline (qdisc) of Deficit Round
3535 Robin Scheduler (DRR).</para>
f5fc0441
SS
3536
3537 <variablelist class='network-directives'>
f344a492
YW
3538 <xi:include href="tc.xml" xpointer="qdisc-parent" />
3539 <xi:include href="tc.xml" xpointer="qdisc-handle" />
f5fc0441
SS
3540 </variablelist>
3541 </refsect1>
3542
ad365c5d
YW
3543 <refsect1>
3544 <title>[DeficitRoundRobinSchedulerClass] Section Options</title>
bdac5608
ZJS
3545 <para>The [DeficitRoundRobinSchedulerClass] section manages the traffic control class of Deficit Round
3546 Robin Scheduler (DRR).</para>
ad365c5d
YW
3547
3548 <variablelist class='network-directives'>
f344a492
YW
3549 <xi:include href="tc.xml" xpointer="tclass-parent" />
3550 <xi:include href="tc.xml" xpointer="tclass-classid" />
ad365c5d
YW
3551
3552 <varlistentry>
c03ef420 3553 <term><varname>QuantumBytes=</varname></term>
ad365c5d 3554 <listitem>
c03ef420
YW
3555 <para>Specifies the amount of bytes a flow is allowed to dequeue before the scheduler moves
3556 to the next class. When suffixed with K, M, or G, the specified size is parsed as Kilobytes,
3557 Megabytes, or Gigabytes, respectively, to the base of 1024. Defaults to the MTU of the
3558 interface.</para>
ad365c5d
YW
3559 </listitem>
3560 </varlistentry>
3561
3562 </variablelist>
3563 </refsect1>
3564
d474aa51
YW
3565 <refsect1>
3566 <title>[EnhancedTransmissionSelection] Section Options</title>
bdac5608
ZJS
3567 <para>The [EnhancedTransmissionSelection] section manages the queueing discipline (qdisc) of Enhanced
3568 Transmission Selection (ETS).</para>
d474aa51
YW
3569
3570 <variablelist class='network-directives'>
3571 <xi:include href="tc.xml" xpointer="qdisc-parent" />
3572 <xi:include href="tc.xml" xpointer="qdisc-handle" />
3573
3574 <varlistentry>
3575 <term><varname>Bands=</varname></term>
3576 <listitem>
e9dd6984
ZJS
3577 <para>Specifies the number of bands. An unsigned integer in the range 1–16. This value has to be at
3578 least large enough to cover the strict bands specified through the <varname>StrictBands=</varname>
3579 and bandwidth-sharing bands specified in <varname>QuantumBytes=</varname>.</para>
d474aa51
YW
3580 </listitem>
3581 </varlistentry>
3582
3583 <varlistentry>
3584 <term><varname>StrictBands=</varname></term>
3585 <listitem>
e9dd6984
ZJS
3586 <para>Specifies the number of bands that should be created in strict mode. An unsigned integer in
3587 the range 1–16.</para>
d474aa51
YW
3588 </listitem>
3589 </varlistentry>
3590
3591 <varlistentry>
3592 <term><varname>QuantumBytes=</varname></term>
3593 <listitem>
3594 <para>Specifies the white-space separated list of quantum used in band-sharing bands. When
3595 suffixed with K, M, or G, the specified size is parsed as Kilobytes, Megabytes, or Gigabytes,
3596 respectively, to the base of 1024. This setting can be specified multiple times. If an empty
3597 string is assigned, then the all previous assignments are cleared.</para>
3598 </listitem>
3599 </varlistentry>
3600
3601 <varlistentry>
3602 <term><varname>PriorityMap=</varname></term>
3603 <listitem>
885a4e6c
ZJS
3604 <para>The priority map maps the priority of a packet to a band. The argument is a whitespace
3605 separated list of numbers. The first number indicates which band the packets with priority 0 should
3606 be put to, the second is for priority 1, and so on. There can be up to 16 numbers in the list. If
3607 there are fewer, the default band that traffic with one of the unmentioned priorities goes to is
1d3a473b 3608 the last one. Each band number must be in the range 0…255. This setting can be specified multiple
885a4e6c 3609 times. If an empty string is assigned, then the all previous assignments are cleared.</para>
d474aa51
YW
3610 </listitem>
3611 </varlistentry>
3612 </variablelist>
3613 </refsect1>
3614
609e8340
SS
3615 <refsect1>
3616 <title>[GenericRandomEarlyDetection] Section Options</title>
bdac5608
ZJS
3617 <para>The [GenericRandomEarlyDetection] section manages the queueing discipline (qdisc) of Generic Random
3618 Early Detection (GRED).</para>
609e8340
SS
3619
3620 <variablelist class='network-directives'>
f344a492
YW
3621 <xi:include href="tc.xml" xpointer="qdisc-parent" />
3622 <xi:include href="tc.xml" xpointer="qdisc-handle" />
609e8340
SS
3623
3624 <varlistentry>
3625 <term><varname>VirtualQueues=</varname></term>
3626 <listitem>
387f6955 3627 <para>Specifies the number of virtual queues. Takes an integer in the range 1…16. Defaults to unset
1d3a473b 3628 and kernel's default is used.</para>
609e8340
SS
3629 </listitem>
3630 </varlistentry>
3631
3632 <varlistentry>
3633 <term><varname>DefaultVirtualQueue=</varname></term>
3634 <listitem>
3635 <para>Specifies the number of default virtual queue. This must be less than <varname>VirtualQueue=</varname>.
3636 Defaults to unset and kernel's default is used.</para>
3637 </listitem>
3638 </varlistentry>
3639
3640 <varlistentry>
3641 <term><varname>GenericRIO=</varname></term>
3642 <listitem>
3643 <para>Takes a boolean. It turns on the RIO-like buffering scheme. Defaults to
3644 unset and kernel's default is used.</para>
3645 </listitem>
3646 </varlistentry>
3647 </variablelist>
3648 </refsect1>
3649
18de0969
YW
3650 <refsect1>
3651 <title>[FairQueueingControlledDelay] Section Options</title>
bdac5608
ZJS
3652 <para>The [FairQueueingControlledDelay] section manages the queueing discipline (qdisc) of fair queuing
3653 controlled delay (FQ-CoDel).</para>
18de0969
YW
3654
3655 <variablelist class='network-directives'>
f344a492
YW
3656 <xi:include href="tc.xml" xpointer="qdisc-parent" />
3657 <xi:include href="tc.xml" xpointer="qdisc-handle" />
d8b2396d 3658
18de0969
YW
3659 <varlistentry>
3660 <term><varname>PacketLimit=</varname></term>
4e5ef149
SS
3661 <listitem>
3662 <para>Specifies the hard limit on the real queue size. When this limit is reached, incoming packets are
3663 dropped. Defaults to unset and kernel's default is used.</para>
3664 </listitem>
3665 </varlistentry>
3666
ac810b75 3667 <varlistentry>
c03ef420 3668 <term><varname>MemoryLimitBytes=</varname></term>
ac810b75
YW
3669 <listitem>
3670 <para>Specifies the limit on the total number of bytes that can be queued in this FQ-CoDel instance.
3671 When suffixed with K, M, or G, the specified size is parsed as Kilobytes, Megabytes, or Gigabytes,
3672 respectively, to the base of 1024. Defaults to unset and kernel's default is used.</para>
3673 </listitem>
3674 </varlistentry>
3675
3676 <varlistentry>
18de0969 3677 <term><varname>Flows=</varname></term>
ac810b75
YW
3678 <listitem>
3679 <para>Specifies the number of flows into which the incoming packets are classified.
3680 Defaults to unset and kernel's default is used.</para>
3681 </listitem>
3682 </varlistentry>
3683
3684 <varlistentry>
18de0969 3685 <term><varname>TargetSec=</varname></term>
ac810b75
YW
3686 <listitem>
3687 <para>Takes a timespan. Specifies the acceptable minimum standing/persistent queue delay.
3688 Defaults to unset and kernel's default is used.</para>
3689 </listitem>
3690 </varlistentry>
3691
3692 <varlistentry>
18de0969 3693 <term><varname>IntervalSec=</varname></term>
ac810b75
YW
3694 <listitem>
3695 <para>Takes a timespan. This is used to ensure that the measured minimum delay does not
3696 become too stale. Defaults to unset and kernel's default is used.</para>
3697 </listitem>
3698 </varlistentry>
3699
3700 <varlistentry>
c03ef420 3701 <term><varname>QuantumBytes=</varname></term>
ac810b75 3702 <listitem>
e9dd6984 3703 <para>Specifies the number of bytes used as the "deficit" in the fair queuing algorithm timespan.
ac810b75
YW
3704 When suffixed with K, M, or G, the specified size is parsed as Kilobytes, Megabytes, or Gigabytes,
3705 respectively, to the base of 1024. Defaults to unset and kernel's default is used.</para>
3706 </listitem>
3707 </varlistentry>
3708
3709 <varlistentry>
18de0969 3710 <term><varname>ECN=</varname></term>
ac810b75
YW
3711 <listitem>
3712 <para>Takes a boolean. This can be used to mark packets instead of dropping them. Defaults to
3713 unset and kernel's default is used.</para>
3714 </listitem>
3715 </varlistentry>
3716
3717 <varlistentry>
18de0969 3718 <term><varname>CEThresholdSec=</varname></term>
ac810b75
YW
3719 <listitem>
3720 <para>Takes a timespan. This sets a threshold above which all packets are marked with ECN
3721 Congestion Experienced (CE). Defaults to unset and kernel's default is used.</para>
3722 </listitem>
3723 </varlistentry>
18de0969
YW
3724 </variablelist>
3725 </refsect1>
3726
3727 <refsect1>
ca58d00c 3728 <title>[FairQueueing] Section Options</title>
bdac5608
ZJS
3729 <para>The [FairQueueing] section manages the queueing discipline (qdisc) of fair queue traffic policing
3730 (FQ).</para>
18de0969
YW
3731
3732 <variablelist class='network-directives'>
f344a492
YW
3733 <xi:include href="tc.xml" xpointer="qdisc-parent" />
3734 <xi:include href="tc.xml" xpointer="qdisc-handle" />
d8b2396d 3735
7234b915 3736 <varlistentry>
18de0969 3737 <term><varname>PacketLimit=</varname></term>
7234b915
SS
3738 <listitem>
3739 <para>Specifies the hard limit on the real queue size. When this limit is reached, incoming packets are
3740 dropped. Defaults to unset and kernel's default is used.</para>
3741 </listitem>
3742 </varlistentry>
3743
e83562e5 3744 <varlistentry>
18de0969 3745 <term><varname>FlowLimit=</varname></term>
e83562e5
YW
3746 <listitem>
3747 <para>Specifies the hard limit on the maximum number of packets queued per flow. Defaults to
3748 unset and kernel's default is used.</para>
3749 </listitem>
3750 </varlistentry>
3751
3752 <varlistentry>
c03ef420 3753 <term><varname>QuantumBytes=</varname></term>
e83562e5
YW
3754 <listitem>
3755 <para>Specifies the credit per dequeue RR round, i.e. the amount of bytes a flow is allowed
3756 to dequeue at once. When suffixed with K, M, or G, the specified size is parsed as Kilobytes,
3757 Megabytes, or Gigabytes, respectively, to the base of 1024. Defaults to unset and kernel's
3758 default is used.</para>
3759 </listitem>
3760 </varlistentry>
3761
3762 <varlistentry>
c03ef420 3763 <term><varname>InitialQuantumBytes=</varname></term>
e83562e5
YW
3764 <listitem>
3765 <para>Specifies the initial sending rate credit, i.e. the amount of bytes a new flow is
3766 allowed to dequeue initially. When suffixed with K, M, or G, the specified size is parsed as
3767 Kilobytes, Megabytes, or Gigabytes, respectively, to the base of 1024. Defaults to unset and
3768 kernel's default is used.</para>
3769 </listitem>
3770 </varlistentry>
3771
3772 <varlistentry>
18de0969 3773 <term><varname>MaximumRate=</varname></term>
e83562e5
YW
3774 <listitem>
3775 <para>Specifies the maximum sending rate of a flow. When suffixed with K, M, or G, the
6b8fe4c3 3776 specified size is parsed as Kilobits, Megabits, or Gigabits, respectively, to the base of
e83562e5
YW
3777 1000. Defaults to unset and kernel's default is used.</para>
3778 </listitem>
3779 </varlistentry>
3780
3781 <varlistentry>
18de0969 3782 <term><varname>Buckets=</varname></term>
e83562e5
YW
3783 <listitem>
3784 <para>Specifies the size of the hash table used for flow lookups. Defaults to unset and
3785 kernel's default is used.</para>
3786 </listitem>
3787 </varlistentry>
3788
3789 <varlistentry>
18de0969 3790 <term><varname>OrphanMask=</varname></term>
e83562e5
YW
3791 <listitem>
3792 <para>Takes an unsigned integer. For packets not owned by a socket, fq is able to mask a part
3793 of hash and reduce number of buckets associated with the traffic. Defaults to unset and
3794 kernel's default is used.</para>
3795 </listitem>
3796 </varlistentry>
3797
3798 <varlistentry>
18de0969 3799 <term><varname>Pacing=</varname></term>
e83562e5
YW
3800 <listitem>
3801 <para>Takes a boolean, and enables or disables flow pacing. Defaults to unset and kernel's
3802 default is used.</para>
3803 </listitem>
3804 </varlistentry>
3805
3806 <varlistentry>
18de0969 3807 <term><varname>CEThresholdSec=</varname></term>
e83562e5
YW
3808 <listitem>
3809 <para>Takes a timespan. This sets a threshold above which all packets are marked with ECN
3810 Congestion Experienced (CE). Defaults to unset and kernel's default is used.</para>
3811 </listitem>
3812 </varlistentry>
0f5bd7fe
SS
3813 </variablelist>
3814 </refsect1>
3815
9b749c11
YW
3816 <refsect1>
3817 <title>[TrivialLinkEqualizer] Section Options</title>
bdac5608
ZJS
3818 <para>The [TrivialLinkEqualizer] section manages the queueing discipline (qdisc) of trivial link
3819 equalizer (teql).</para>
9b749c11
YW
3820
3821 <variablelist class='network-directives'>
f344a492
YW
3822 <xi:include href="tc.xml" xpointer="qdisc-parent" />
3823 <xi:include href="tc.xml" xpointer="qdisc-handle" />
d8b2396d 3824
9b749c11
YW
3825 <varlistentry>
3826 <term><varname>Id=</varname></term>
3827 <listitem>
3828 <para>Specifies the interface ID <literal>N</literal> of teql. Defaults to <literal>0</literal>.
3829 Note that when teql is used, currently, the module <constant>sch_teql</constant> with
3830 <constant>max_equalizers=N+1</constant> option must be loaded before
3831 <command>systemd-networkd</command> is started.</para>
3832 </listitem>
3833 </varlistentry>
3834 </variablelist>
3835 </refsect1>
3836
b934ac3d
YW
3837 <refsect1>
3838 <title>[HierarchyTokenBucket] Section Options</title>
bdac5608
ZJS
3839 <para>The [HierarchyTokenBucket] section manages the queueing discipline (qdisc) of hierarchy token
3840 bucket (htb).</para>
b934ac3d
YW
3841
3842 <variablelist class='network-directives'>
f344a492
YW
3843 <xi:include href="tc.xml" xpointer="qdisc-parent" />
3844 <xi:include href="tc.xml" xpointer="qdisc-handle" />
b934ac3d
YW
3845
3846 <varlistentry>
3847 <term><varname>DefaultClass=</varname></term>
3848 <listitem>
3849 <para>Takes the minor id in hexadecimal of the default class. Unclassified traffic gets sent
3850 to the class. Defaults to unset.</para>
3851 </listitem>
3852 </varlistentry>
d9eacc1c
YW
3853
3854 <varlistentry>
3855 <term><varname>RateToQuantum=</varname></term>
3856 <listitem>
3857 <para>Takes an unsigned integer. The DRR quantums are calculated by dividing the value
3858 configured in <varname>Rate=</varname> by <varname>RateToQuantum=</varname>.</para>
3859 </listitem>
3860 </varlistentry>
b934ac3d
YW
3861 </variablelist>
3862 </refsect1>
3863
19f86a63
YW
3864 <refsect1>
3865 <title>[HierarchyTokenBucketClass] Section Options</title>
bdac5608
ZJS
3866 <para>The [HierarchyTokenBucketClass] section manages the traffic control class of hierarchy token bucket
3867 (htb).</para>
19f86a63
YW
3868
3869 <variablelist class='network-directives'>
f344a492
YW
3870 <xi:include href="tc.xml" xpointer="tclass-parent" />
3871 <xi:include href="tc.xml" xpointer="tclass-classid" />
19f86a63
YW
3872
3873 <varlistentry>
3874 <term><varname>Priority=</varname></term>
3875 <listitem>
3876 <para>Specifies the priority of the class. In the round-robin process, classes with the lowest
d9eacc1c
YW
3877 priority field are tried for packets first.</para>
3878 </listitem>
3879 </varlistentry>
3880
3881 <varlistentry>
3882 <term><varname>QuantumBytes=</varname></term>
3883 <listitem>
3884 <para>Specifies how many bytes to serve from leaf at once. When suffixed with K, M, or G, the
3885 specified size is parsed as Kilobytes, Megabytes, or Gigabytes, respectively, to the base of
3886 1024.</para>
3887 </listitem>
3888 </varlistentry>
3889
3890 <varlistentry>
3891 <term><varname>MTUBytes=</varname></term>
3892 <listitem>
3893 <para>Specifies the maximum packet size we create. When suffixed with K, M, or G, the specified
3894 size is parsed as Kilobytes, Megabytes, or Gigabytes, respectively, to the base of 1024.</para>
3895 </listitem>
3896 </varlistentry>
3897
3898 <varlistentry>
3899 <term><varname>OverheadBytes=</varname></term>
3900 <listitem>
3901 <para>Takes an unsigned integer which specifies per-packet size overhead used in rate
3902 computations. When suffixed with K, M, or G, the specified size is parsed as Kilobytes,
3903 Megabytes, or Gigabytes, respectively, to the base of 1024.</para>
19f86a63
YW
3904 </listitem>
3905 </varlistentry>
3906
3907 <varlistentry>
3908 <term><varname>Rate=</varname></term>
3909 <listitem>
3910 <para>Specifies the maximum rate this class and all its children are guaranteed. When suffixed
3911 with K, M, or G, the specified size is parsed as Kilobits, Megabits, or Gigabits, respectively,
3912 to the base of 1000. This setting is mandatory.</para>
3913 </listitem>
3914 </varlistentry>
3915
3916 <varlistentry>
3917 <term><varname>CeilRate=</varname></term>
3918 <listitem>
3919 <para>Specifies the maximum rate at which a class can send, if its parent has bandwidth to spare.
3920 When suffixed with K, M, or G, the specified size is parsed as Kilobits, Megabits, or Gigabits,
3921 respectively, to the base of 1000. When unset, the value specified with <varname>Rate=</varname>
3922 is used.</para>
3923 </listitem>
3924 </varlistentry>
d9eacc1c
YW
3925
3926 <varlistentry>
3927 <term><varname>BufferBytes=</varname></term>
3928 <listitem>
3929 <para>Specifies the maximum bytes burst which can be accumulated during idle period. When suffixed
3930 with K, M, or G, the specified size is parsed as Kilobytes, Megabytes, or Gigabytes, respectively,
3931 to the base of 1024.</para>
3932 </listitem>
3933 </varlistentry>
3934
3935 <varlistentry>
3936 <term><varname>CeilBufferBytes=</varname></term>
3937 <listitem>
3938 <para>Specifies the maximum bytes burst for ceil which can be accumulated during idle period.
3939 When suffixed with K, M, or G, the specified size is parsed as Kilobytes, Megabytes, or Gigabytes,
3940 respectively, to the base of 1024.</para>
3941 </listitem>
3942 </varlistentry>
7f224020
SS
3943 </variablelist>
3944 </refsect1>
3945
3946 <refsect1>
3947 <title>[HeavyHitterFilter] Section Options</title>
bdac5608
ZJS
3948 <para>The [HeavyHitterFilter] section manages the queueing discipline (qdisc) of Heavy Hitter Filter
3949 (hhf).</para>
7f224020
SS
3950
3951 <variablelist class='network-directives'>
f344a492
YW
3952 <xi:include href="tc.xml" xpointer="qdisc-parent" />
3953 <xi:include href="tc.xml" xpointer="qdisc-handle" />
19f86a63 3954
7f224020
SS
3955 <varlistentry>
3956 <term><varname>PacketLimit=</varname></term>
3957 <listitem>
e9dd6984
ZJS
3958 <para>Specifies the hard limit on the queue size in number of packets. When this limit is reached,
3959 incoming packets are dropped. An unsigned integer in the range 0–4294967294. Defaults to unset and
3960 kernel's default is used.</para>
7f224020
SS
3961 </listitem>
3962 </varlistentry>
19f86a63
YW
3963 </variablelist>
3964 </refsect1>
3965
b12aaee5
SS
3966 <refsect1>
3967 <title>[QuickFairQueueing] Section Options</title>
bdac5608
ZJS
3968 <para>The [QuickFairQueueing] section manages the queueing discipline (qdisc) of Quick Fair Queueing
3969 (QFQ).</para>
b12aaee5
SS
3970
3971 <variablelist class='network-directives'>
3972 <xi:include href="tc.xml" xpointer="qdisc-parent" />
3973 <xi:include href="tc.xml" xpointer="qdisc-handle" />
3974 </variablelist>
3975 </refsect1>
3976
4d7ddaf9
YW
3977 <refsect1>
3978 <title>[QuickFairQueueingClass] Section Options</title>
bdac5608
ZJS
3979 <para>The [QuickFairQueueingClass] section manages the traffic control class of Quick Fair Queueing
3980 (qfq).</para>
4d7ddaf9
YW
3981
3982 <variablelist class='network-directives'>
3983 <xi:include href="tc.xml" xpointer="tclass-parent" />
3984 <xi:include href="tc.xml" xpointer="tclass-classid" />
3985
3986 <varlistentry>
3987 <term><varname>Weight=</varname></term>
3988 <listitem>
1d3a473b 3989 <para>Specifies the weight of the class. Takes an integer in the range 1…1023. Defaults to
4d7ddaf9
YW
3990 unset in which case the kernel default is used.</para>
3991 </listitem>
3992 </varlistentry>
3993
3994 <varlistentry>
c03ef420 3995 <term><varname>MaxPacketBytes=</varname></term>
4d7ddaf9 3996 <listitem>
75909cc7
ZJS
3997 <para>Specifies the maximum packet size in bytes for the class. When suffixed with K, M, or G, the
3998 specified size is parsed as Kilobytes, Megabytes, or Gigabytes, respectively, to the base of
3999 1024. When unset, the kernel default is used.</para>
4d7ddaf9
YW
4000 </listitem>
4001 </varlistentry>
4002 </variablelist>
4003 </refsect1>
4004
13b498f9
TJ
4005 <refsect1>
4006 <title>[BridgeVLAN] Section Options</title>
bdac5608
ZJS
4007 <para>The [BridgeVLAN] section manages the VLAN ID configuration of a bridge port and accepts the
4008 following keys. Specify several [BridgeVLAN] sections to configure several VLAN entries. The
4009 <varname>VLANFiltering=</varname> option has to be enabled, see the [Bridge] section in
13b498f9
TJ
4010 <citerefentry><refentrytitle>systemd.netdev</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para>
4011
4012 <variablelist class='network-directives'>
4013 <varlistentry>
4014 <term><varname>VLAN=</varname></term>
4015 <listitem>
4016 <para>The VLAN ID allowed on the port. This can be either a single ID or a range M-N. VLAN IDs are valid
4017 from 1 to 4094.</para>
4018 </listitem>
4019 </varlistentry>
4020 <varlistentry>
4021 <term><varname>EgressUntagged=</varname></term>
4022 <listitem>
4023 <para>The VLAN ID specified here will be used to untag frames on egress. Configuring
4024 <varname>EgressUntagged=</varname> implicates the use of <varname>VLAN=</varname> above and will enable the
4025 VLAN ID for ingress as well. This can be either a single ID or a range M-N.</para>
4026 </listitem>
4027 </varlistentry>
4028 <varlistentry>
4029 <term><varname>PVID=</varname></term>
4030 <listitem>
4031 <para>The Port VLAN ID specified here is assigned to all untagged frames at ingress.
4032 <varname>PVID=</varname> can be used only once. Configuring <varname>PVID=</varname> implicates the use of
4033 <varname>VLAN=</varname> above and will enable the VLAN ID for ingress as well.</para>
4034 </listitem>
4035 </varlistentry>
4036 </variablelist>
4037 </refsect1>
798d3a52
ZJS
4038
4039 <refsect1>
9e35b3de 4040 <title>Examples</title>
798d3a52 4041 <example>
9e35b3de 4042 <title>Static network configuration</title>
798d3a52 4043
9e35b3de
ZJS
4044 <programlisting># /etc/systemd/network/50-static.network
4045[Match]
eac684ef
TG
4046Name=enp2s0
4047
4048[Network]
4049Address=192.168.0.15/24
4050Gateway=192.168.0.1</programlisting>
9e35b3de
ZJS
4051
4052 <para>This brings interface <literal>enp2s0</literal> up with a static address. The
4053 specified gateway will be used for a default route.</para>
798d3a52 4054 </example>
eac684ef 4055
798d3a52 4056 <example>
9e35b3de 4057 <title>DHCP on ethernet links</title>
eac684ef 4058
9e35b3de
ZJS
4059 <programlisting># /etc/systemd/network/80-dhcp.network
4060[Match]
eac684ef
TG
4061Name=en*
4062
4063[Network]
9c8ca3f7 4064DHCP=yes</programlisting>
9e35b3de
ZJS
4065
4066 <para>This will enable DHCPv4 and DHCPv6 on all interfaces with names starting with
4067 <literal>en</literal> (i.e. ethernet interfaces).</para>
798d3a52 4068 </example>
eac684ef 4069
4c94a4c2 4070 <example>
4071 <title>IPv6 Prefix Delegation</title>
4072
4073 <programlisting># /etc/systemd/network/55-ipv6-pd-upstream.network
4074[Match]
4075Name=enp1s0
4076
4077[Network]
4078DHCP=ipv6</programlisting>
4079
4080 <programlisting># /etc/systemd/network/56-ipv6-pd-downstream.network
4081[Match]
4082Name=enp2s0
4083
4084[Network]
e5ff2245
YW
4085IPv6SendRA=yes
4086DHCPv6PrefixDelegation=yes</programlisting>
4c94a4c2 4087
e5ff2245
YW
4088 <para>This will enable DHCPv6-PD on the interface enp1s0 as an upstream interface where the
4089 DHCPv6 client is running and enp2s0 as a downstream interface where the prefix is delegated to.
4090 The delegated prefixes are distributed by IPv6 Router Advertisement on the downstream network.
4091 </para>
4c94a4c2 4092 </example>
4093
798d3a52 4094 <example>
9e35b3de 4095 <title>A bridge with two enslaved links</title>
f47c5c47 4096
9e35b3de
ZJS
4097 <programlisting># /etc/systemd/network/25-bridge-static.network
4098[Match]
f47c5c47 4099Name=bridge0
4100
4101[Network]
4102Address=192.168.0.15/24
4103Gateway=192.168.0.1
4104DNS=192.168.0.1</programlisting>
f47c5c47 4105
9e35b3de
ZJS
4106 <programlisting># /etc/systemd/network/25-bridge-slave-interface-1.network
4107[Match]
f47c5c47 4108Name=enp2s0
4109
4110[Network]
4111Bridge=bridge0</programlisting>
9e35b3de
ZJS
4112
4113 <programlisting># /etc/systemd/network/25-bridge-slave-interface-2.network
4114[Match]
4115Name=wlp3s0
4116
4117[Network]
4118Bridge=bridge0</programlisting>
4119
4120 <para>This creates a bridge and attaches devices <literal>enp2s0</literal> and
4121 <literal>wlp3s0</literal> to it. The bridge will have the specified static address
4122 and network assigned, and a default route via the specified gateway will be
4123 added. The specified DNS server will be added to the global list of DNS resolvers.
4124 </para>
13b498f9 4125 </example>
9e35b3de 4126
13b498f9 4127 <example>
9e35b3de 4128 <title></title>
13b498f9 4129
9e35b3de
ZJS
4130 <programlisting>
4131# /etc/systemd/network/20-bridge-slave-interface-vlan.network
4132[Match]
13b498f9
TJ
4133Name=enp2s0
4134
4135[Network]
4136Bridge=bridge0
4137
4138[BridgeVLAN]
4139VLAN=1-32
4140PVID=42
4141EgressUntagged=42
4142
4143[BridgeVLAN]
4144VLAN=100-200
4145
4146[BridgeVLAN]
4147EgressUntagged=300-400</programlisting>
0a8a0fad 4148
9e35b3de
ZJS
4149 <para>This overrides the configuration specified in the previous example for the
4150 interface <literal>enp2s0</literal>, and enables VLAN on that bridge port. VLAN IDs
4151 1-32, 42, 100-400 will be allowed. Packets tagged with VLAN IDs 42, 300-400 will be
4152 untagged when they leave on this interface. Untagged packets which arrive on this
4153 interface will be assigned VLAN ID 42.</para>
798d3a52 4154 </example>
0a8a0fad 4155
798d3a52 4156 <example>
9e35b3de 4157 <title>Various tunnels</title>
0a8a0fad 4158
9e35b3de
ZJS
4159 <programlisting>/etc/systemd/network/25-tunnels.network
4160[Match]
4161Name=ens1
0a8a0fad
TG
4162
4163[Network]
9e35b3de
ZJS
4164Tunnel=ipip-tun
4165Tunnel=sit-tun
4166Tunnel=gre-tun
4167Tunnel=vti-tun
4168 </programlisting>
4169
4170 <programlisting>/etc/systemd/network/25-tunnel-ipip.netdev
4171[NetDev]
4172Name=ipip-tun
4173Kind=ipip
4174 </programlisting>
4175
4176 <programlisting>/etc/systemd/network/25-tunnel-sit.netdev
4177[NetDev]
4178Name=sit-tun
4179Kind=sit
4180 </programlisting>
4181
4182 <programlisting>/etc/systemd/network/25-tunnel-gre.netdev
4183[NetDev]
4184Name=gre-tun
4185Kind=gre
4186 </programlisting>
4187
4188 <programlisting>/etc/systemd/network/25-tunnel-vti.netdev
4189[NetDev]
4190Name=vti-tun
4191Kind=vti
4192 </programlisting>
4193
4194 <para>This will bring interface <literal>ens1</literal> up and create an IPIP tunnel,
4195 a SIT tunnel, a GRE tunnel, and a VTI tunnel using it.</para>
798d3a52 4196 </example>
0a8a0fad 4197
798d3a52 4198 <example>
9e35b3de 4199 <title>A bond device</title>
0a8a0fad 4200
9e35b3de
ZJS
4201 <programlisting># /etc/systemd/network/30-bond1.network
4202[Match]
4203Name=bond1
0a8a0fad
TG
4204
4205[Network]
9e35b3de
ZJS
4206DHCP=ipv6
4207</programlisting>
0a8a0fad 4208
9e35b3de
ZJS
4209 <programlisting># /etc/systemd/network/30-bond1.netdev
4210[NetDev]
4211Name=bond1
4212Kind=bond
4213</programlisting>
0a8a0fad 4214
301a21a8 4215 <programlisting># /etc/systemd/network/30-bond1-dev1.network
9e35b3de
ZJS
4216[Match]
4217MACAddress=52:54:00:e9:64:41
0a8a0fad
TG
4218
4219[Network]
9e35b3de
ZJS
4220Bond=bond1
4221</programlisting>
d94facdc 4222
301a21a8 4223 <programlisting># /etc/systemd/network/30-bond1-dev2.network
9e35b3de
ZJS
4224[Match]
4225MACAddress=52:54:00:e9:64:42
d94facdc
MH
4226
4227[Network]
9e35b3de 4228Bond=bond1
6cb955c6 4229</programlisting>
9e35b3de
ZJS
4230
4231 <para>This will create a bond device <literal>bond1</literal> and enslave the two
4232 devices with MAC addresses 52:54:00:e9:64:41 and 52:54:00:e9:64:42 to it. IPv6 DHCP
4233 will be used to acquire an address.</para>
6cb955c6
AR
4234 </example>
4235
4236 <example>
9e35b3de
ZJS
4237 <title>Virtual Routing and Forwarding (VRF)</title>
4238 <para>Add the <literal>bond1</literal> interface to the VRF master interface
4239 <literal>vrf1</literal>. This will redirect routes generated on this interface to be
11d38b90
AR
4240 within the routing table defined during VRF creation. For kernels before 4.8 traffic
4241 won't be redirected towards the VRFs routing table unless specific ip-rules are added.
4242 </para>
9e35b3de
ZJS
4243 <programlisting># /etc/systemd/network/25-vrf.network
4244[Match]
6cb955c6
AR
4245Name=bond1
4246
4247[Network]
9e35b3de 4248VRF=vrf1
d94facdc
MH
4249</programlisting>
4250 </example>
4251
42125eda
SS
4252 <example>
4253 <title>MacVTap</title>
4254 <para>This brings up a network interface <literal>macvtap-test</literal>
4255 and attaches it to <literal>enp0s25</literal>.</para>
83ddf5d3 4256 <programlisting># /usr/lib/systemd/network/25-macvtap.network
42125eda
SS
4257[Match]
4258Name=enp0s25
4259
4260[Network]
4261MACVTAP=macvtap-test
4262</programlisting>
4263 </example>
98d20a17 4264
4265 <example>
4266 <title>A Xfrm interface with physical underlying device.</title>
4267
4268 <programlisting># /etc/systemd/network/27-xfrm.netdev
4269[NetDev]
4270Name=xfrm0
4271
4272[Xfrm]
4273InterfaceId=7</programlisting>
4274
4275 <programlisting># /etc/systemd/network/27-eth0.network
4276[Match]
4277Name=eth0
4278
4279[Network]
4280Xfrm=xfrm0</programlisting>
4281
4282 <para>This creates a <literal>xfrm0</literal> interface and binds it to the <literal>eth0</literal> device.
4283 This allows hardware based ipsec offloading to the <literal>eth0</literal> nic.
4284 If offloading is not needed, xfrm interfaces can be assigned to the <literal>lo</literal> device.
4285 </para>
4286 </example>
798d3a52
ZJS
4287 </refsect1>
4288
4289 <refsect1>
4290 <title>See Also</title>
4291 <para>
4292 <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
f41b446a 4293 <citerefentry><refentrytitle>systemd-networkd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
798d3a52 4294 <citerefentry><refentrytitle>systemd.link</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
aaa297d4
LP
4295 <citerefentry><refentrytitle>systemd.netdev</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
4296 <citerefentry><refentrytitle>systemd-resolved.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>
798d3a52
ZJS
4297 </para>
4298 </refsect1>
eac684ef
TG
4299
4300</refentry>