2 <!DOCTYPE refentry PUBLIC
"-//OASIS//DTD DocBook XML V4.5//EN"
3 "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
4 <!-- SPDX-License-Identifier: LGPL-2.1-or-later -->
6 <refentry id=
"systemd.network" conditional='ENABLE_NETWORKD'
7 xmlns:
xi=
"http://www.w3.org/2001/XInclude">
10 <title>systemd.network
</title>
11 <productname>systemd
</productname>
15 <refentrytitle>systemd.network
</refentrytitle>
16 <manvolnum>5</manvolnum>
20 <refname>systemd.network
</refname>
21 <refpurpose>Network configuration
</refpurpose>
25 <para><filename><replaceable>network
</replaceable>.network
</filename></para>
29 <title>Description
</title>
31 <para>A plain ini-style text file that encodes network configuration for matching network interfaces,
33 <citerefentry><refentrytitle>systemd-networkd
</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
34 See
<citerefentry><refentrytitle>systemd.syntax
</refentrytitle><manvolnum>7</manvolnum></citerefentry>
35 for a general description of the syntax.
</para>
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>
40 <para>The
<filename>.network
</filename> files are read from the files located in the system network
41 directories
<filename>/usr/lib/systemd/network
</filename> and
42 <filename>/usr/local/lib/systemd/network
</filename>, the volatile runtime network directory
43 <filename>/run/systemd/network
</filename> and the local administration network directory
44 <filename>/etc/systemd/network
</filename>. All configuration files are collectively sorted and processed
45 in lexical order, regardless of the directories in which they live. However, files with identical
46 filenames replace each other. Files in
<filename>/etc/
</filename> have the highest priority, files in
47 <filename>/run/
</filename> take precedence over files with the same name under
48 <filename>/usr/
</filename>. This can be used to override a system-supplied configuration file with a local
49 file if needed. As a special case, an empty file (file size
0) or symlink with the same name pointing to
50 <filename>/dev/null
</filename> disables the configuration file entirely (it is
"masked").
</para>
52 <para>Along with the network file
<filename>foo.network
</filename>, a
"drop-in" directory
53 <filename>foo.network.d/
</filename> may exist. All files with the suffix
54 <literal>.conf
</literal> from this directory will be parsed after the file itself is
55 parsed. This is useful to alter or add configuration settings, without having to modify the main
56 configuration file. Each drop-in file must have appropriate section headers.
</para>
58 <para>In addition to
<filename>/etc/systemd/network
</filename>, drop-in
<literal>.d
</literal>
59 directories can be placed in
<filename>/usr/lib/systemd/network
</filename> or
60 <filename>/run/systemd/network
</filename> directories. Drop-in files in
61 <filename>/etc/
</filename> take precedence over those in
<filename>/run/
</filename> which in turn
62 take precedence over those in
<filename>/usr/lib/
</filename>. Drop-in files under any of these
63 directories take precedence over the main network file wherever located.
</para>
65 <para>Note that an interface without any static IPv6 addresses configured, and neither DHCPv6
66 nor IPv6LL enabled, shall be considered to have no IPv6 support. IPv6 will be automatically
67 disabled for that interface by writing
"1" to
68 <filename>/proc/sys/net/ipv6/conf/
<replaceable>ifname
</replaceable>/disable_ipv6
</filename>.
73 <title>[Match] Section Options
</title>
75 <para>The network file contains a [Match] section, which determines if a given network file may be
76 applied to a given device; and a [Network] section specifying how the device should be configured. The
77 first (in lexical order) of the network files that matches a given device is applied, all later files
78 are ignored, even if they match as well.
</para>
80 <para>A network file is said to match a network interface if all matches specified by the [Match]
81 section are satisfied. When a network file does not contain valid settings in [Match] section, then the
82 file will match all interfaces and
<command>systemd-networkd
</command> warns about that. Hint: to avoid
83 the warning and to make it clear that all interfaces shall be matched, add the following:
84 <programlisting>Name=*
</programlisting> The following keys are accepted:
</para>
86 <variablelist class='network-directives'
>
87 <xi:include href=
"systemd.link.xml" xpointer=
"mac-address" />
88 <xi:include href=
"systemd.link.xml" xpointer=
"permanent-mac-address" />
89 <xi:include href=
"systemd.link.xml" xpointer=
"path" />
90 <xi:include href=
"systemd.link.xml" xpointer=
"driver" />
91 <xi:include href=
"systemd.link.xml" xpointer=
"type" />
92 <xi:include href=
"systemd.link.xml" xpointer=
"property" />
95 <term><varname>Name=
</varname></term>
97 <para>A whitespace-separated list of shell-style globs matching the device name, as exposed
98 by the udev property
<literal>INTERFACE
</literal>, or device's alternative names. If the
99 list is prefixed with a
"!", the test is inverted.
</para>
104 <term><varname>WLANInterfaceType=
</varname></term>
106 <para>A whitespace-separated list of wireless network type. Supported values are
107 <literal>ad-hoc
</literal>,
<literal>station
</literal>,
<literal>ap
</literal>,
108 <literal>ap-vlan
</literal>,
<literal>wds
</literal>,
<literal>monitor
</literal>,
109 <literal>mesh-point
</literal>,
<literal>p2p-client
</literal>,
<literal>p2p-go
</literal>,
110 <literal>p2p-device
</literal>,
<literal>ocb
</literal>, and
<literal>nan
</literal>. If the
111 list is prefixed with a
"!", the test is inverted.
117 <term><varname>SSID=
</varname></term>
119 <para>A whitespace-separated list of shell-style globs matching the SSID of the currently
120 connected wireless LAN. If the list is prefixed with a
"!", the test is inverted.
126 <term><varname>BSSID=
</varname></term>
128 <para>A whitespace-separated list of hardware address of the currently connected wireless
129 LAN. Use full colon-, hyphen- or dot-delimited hexadecimal. See the example in
130 <varname>MACAddress=
</varname>. This option may appear more than once, in which case the
131 lists are merged. If the empty string is assigned to this option, the list is reset.
</para>
135 <xi:include href=
"systemd.link.xml" xpointer=
"host" />
136 <xi:include href=
"systemd.link.xml" xpointer=
"virtualization" />
137 <xi:include href=
"systemd.link.xml" xpointer=
"kernel-command-line" />
138 <xi:include href=
"systemd.link.xml" xpointer=
"kernel-version" />
139 <xi:include href=
"systemd.link.xml" xpointer=
"architecture" />
145 <title>[Link] Section Options
</title>
147 <para> The [Link] section accepts the following keys:
</para>
149 <variablelist class='network-directives'
>
151 <term><varname>MACAddress=
</varname></term>
153 <para>The hardware address to set for the device.
</para>
157 <term><varname>MTUBytes=
</varname></term>
159 <para>The maximum transmission unit in bytes to set for the
160 device. The usual suffixes K, M, G, are supported and are
161 understood to the base of
1024.
</para>
162 <para>Note that if IPv6 is enabled on the interface, and the MTU is chosen
163 below
1280 (the minimum MTU for IPv6) it will automatically be increased to this value.
</para>
167 <term><varname>ARP=
</varname></term>
169 <para>Takes a boolean. If set to true, the ARP (low-level Address Resolution Protocol)
170 for this interface is enabled. When unset, the kernel's default will be used.
</para>
171 <para> For example, disabling ARP is useful when creating multiple MACVLAN or VLAN virtual
172 interfaces atop a single lower-level physical interface, which will then only serve as a
173 link/
"bridge" device aggregating traffic to the same physical link and not participate in
174 the network otherwise. Defaults to unset.
</para>
178 <term><varname>Multicast=
</varname></term>
180 <para>Takes a boolean. If set to true, the multicast flag on the device is enabled. Defaults to unset.
</para>
184 <term><varname>AllMulticast=
</varname></term>
186 <para>Takes a boolean. If set to true, the driver retrieves all multicast packets from the network.
187 This happens when multicast routing is enabled. Defaults to unset.
</para>
191 <term><varname>Promiscuous=
</varname></term>
193 <para>Takes a boolean. If set to true, promiscuous mode of the interface is enabled.
194 Defaults to unset.
</para>
198 <term><varname>Unmanaged=
</varname></term>
200 <para>Takes a boolean. When
<literal>yes
</literal>, no attempts are
201 made to bring up or configure matching links, equivalent to
202 when there are no matching network files. Defaults to
203 <literal>no
</literal>.
</para>
204 <para>This is useful for preventing later matching network
205 files from interfering with certain interfaces that are fully
206 controlled by other applications.
</para>
210 <term><varname>Group=
</varname></term>
212 <para>Link groups are similar to port ranges found in managed switches.
213 When network interfaces are added to a numbered group, operations on
214 all the interfaces from that group can be performed at once. An unsigned
215 integer in the range
0—
4294967294. Defaults to unset.
</para>
219 <term><varname>TransmitQueues=
</varname></term>
221 <para>Specifies the devices's number of transmit queues. An integer in the range
1..
.4096.
222 When unset, the kernel's default will be used.
</para>
226 <term><varname>ReceiveQueues=
</varname></term>
228 <para>Specifies the devices's number of receive queues. An integer in the range
1..
.4096.
229 When unset, the kernel's default will be used.
</para>
233 <term><varname>RequiredForOnline=
</varname></term>
235 <para>Takes a boolean or a minimum operational state and an optional maximum operational state.
236 Please see
<citerefentry><refentrytitle>networkctl
</refentrytitle><manvolnum>1</manvolnum></citerefentry>
237 for possible operational states. When
<literal>yes
</literal>, the network is deemed required when
238 determining whether the system is online when running
239 <command>systemd-networkd-wait-online
</command>. When
<literal>no
</literal>, the network is ignored
240 when checking for online state. When a minimum operational state and an optional maximum operational
241 state are set,
<literal>yes
</literal> is implied, and this controls the minimum and maximum
242 operational state required for the network interface to be considered online.
243 Defaults to
<literal>yes
</literal>.
</para>
245 <para>The network will be brought up normally in all cases, but in
246 the event that there is no address being assigned by DHCP or the
247 cable is not plugged in, the link will simply remain offline and be
248 skipped automatically by
<command>systemd-networkd-wait-online
</command>
249 if
<literal>RequiredForOnline=no
</literal>.
</para>
253 <term><varname>ActivationPolicy=
</varname></term>
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>
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>
275 <para>The administrative state is not the same as the carrier state, so using
276 <literal>always-up
</literal> does not mean the link will never lose carrier. The link
277 carrier depends on both the administrative state as well as the network device's physical
278 connection. However, to avoid reconfiguration failures, when using
<literal>always-up
</literal>,
279 <varname>IgnoreCarrierLoss=
</varname> is forced to true.
</para>
286 <title>[SR-IOV] Section Options
</title>
287 <para>The [SR-IOV] section accepts the following keys. Specify several [SR-IOV] sections to configure
288 several SR-IOVs. SR-IOV provides the ability to partition a single physical PCI resource into virtual
289 PCI functions which can then be injected into a VM. In the case of network VFs, SR-IOV improves
290 north-south network performance (that is, traffic with endpoints outside the host machine) by allowing
291 traffic to bypass the host machine’s network stack.
</para>
293 <variablelist class='network-directives'
>
295 <term><varname>VirtualFunction=
</varname></term>
297 <para>Specifies a Virtual Function (VF), lightweight PCIe function designed solely to move data
298 in and out. Takes an unsigned integer in the range
0.
.2147483646. This option is compulsory.
</para>
303 <term><varname>VLANId=
</varname></term>
305 <para>Specifies VLAN ID of the virtual function. Takes an unsigned integer in the range
1.
.4095.
</para>
310 <term><varname>QualityOfService=
</varname></term>
312 <para>Specifies quality of service of the virtual function. Takes an unsigned integer in the range
1.
.4294967294.
</para>
317 <term><varname>VLANProtocol=
</varname></term>
319 <para>Specifies VLAN protocol of the virtual function. Takes
<literal>802.1Q
</literal> or
320 <literal>802.1ad
</literal>.
</para>
325 <term><varname>MACSpoofCheck=
</varname></term>
327 <para>Takes a boolean. Controls the MAC spoof checking. When unset, the kernel's default will be used.
</para>
332 <term><varname>QueryReceiveSideScaling=
</varname></term>
334 <para>Takes a boolean. Toggle the ability of querying the receive side scaling (RSS)
335 configuration of the virtual function (VF). The VF RSS information like RSS hash key may be
336 considered sensitive on some devices where this information is shared between VF and the
337 physical function (PF). When unset, the kernel's default will be used.
</para>
342 <term><varname>Trust=
</varname></term>
344 <para>Takes a boolean. Allows to set trust mode of the virtual function (VF). When set, VF
345 users can set a specific feature which may impact security and/or performance. When unset,
346 the kernel's default will be used.
</para>
351 <term><varname>LinkState=
</varname></term>
353 <para>Allows to set the link state of the virtual function (VF). Takes a boolean or a
354 special value
<literal>auto
</literal>. Setting to
<literal>auto
</literal> means a
355 reflection of the physical function (PF) link state,
<literal>yes
</literal> lets the VF to
356 communicate with other VFs on this host even if the PF link state is down,
357 <literal>no
</literal> causes the hardware to drop any packets sent by the VF. When unset,
358 the kernel's default will be used.
</para>
363 <term><varname>MACAddress=
</varname></term>
365 <para>Specifies the MAC address for the virtual function.
</para>
372 <title>[Network] Section Options
</title>
374 <para>The [Network] section accepts the following keys:
</para>
376 <variablelist class='network-directives'
>
378 <term><varname>Description=
</varname></term>
380 <para>A description of the device. This is only used for
381 presentation purposes.
</para>
385 <term><varname>DHCP=
</varname></term>
387 <para>Enables DHCPv4 and/or DHCPv6 client support. Accepts
388 <literal>yes
</literal>,
<literal>no
</literal>,
389 <literal>ipv4
</literal>, or
<literal>ipv6
</literal>. Defaults
390 to
<literal>no
</literal>.
</para>
392 <para>Note that DHCPv6 will by default be triggered by Router
393 Advertisement, if that is enabled, regardless of this parameter.
394 By enabling DHCPv6 support explicitly, the DHCPv6 client will
395 be started regardless of the presence of routers on the link,
396 or what flags the routers pass. See
397 <literal>IPv6AcceptRA=
</literal>.
</para>
399 <para>Furthermore, note that by default the domain name
400 specified through DHCP is not used for name resolution.
401 See option
<option>UseDomains=
</option> below.
</para>
403 <para>See the [DHCPv4] or [DHCPv6] sections below for further configuration options for the DHCP
404 client support.
</para>
408 <term><varname>DHCPServer=
</varname></term>
410 <para>Takes a boolean. If set to
<literal>yes
</literal>, DHCPv4 server will be started. Defaults
411 to
<literal>no
</literal>. Further settings for the DHCP server may be set in the [DHCPServer]
412 section described below.
</para>
416 <term><varname>LinkLocalAddressing=
</varname></term>
418 <para>Enables link-local address autoconfiguration. Accepts
<option>yes
</option>,
419 <option>no
</option>,
<option>ipv4
</option>, and
<option>ipv6
</option>. An IPv6 link-local address
420 is configured when
<option>yes
</option> or
<option>ipv6
</option>. An IPv4 link-local address is
421 configured when
<option>yes
</option> or
<option>ipv4
</option> and when DHCPv4 autoconfiguration
422 has been unsuccessful for some time. (IPv4 link-local address autoconfiguration will usually
423 happen in parallel with repeated attempts to acquire a DHCPv4 lease).
</para>
425 <para>Defaults to
<option>no
</option> when
<varname>Bridge=yes
</varname> is set, and
426 <option>ipv6
</option> otherwise.
</para>
430 <term><varname>IPv6LinkLocalAddressGenerationMode=
</varname></term>
432 <para>Specifies how IPv6 link local address is generated. Takes one of
<literal>eui64
</literal>,
433 <literal>none
</literal>,
<literal>stable-privacy
</literal> and
<literal>random
</literal>.
434 When unset, the kernel's default will be used. Note that if
<varname>LinkLocalAdressing=
</varname>
435 not configured as
<literal>ipv6
</literal> then
<varname>IPv6LinkLocalAddressGenerationMode=
</varname>
440 <term><varname>IPv4LLRoute=
</varname></term>
442 <para>Takes a boolean. If set to true, sets up the route needed for
443 non-IPv4LL hosts to communicate with IPv4LL-only hosts. Defaults
449 <term><varname>DefaultRouteOnDevice=
</varname></term>
451 <para>Takes a boolean. If set to true, sets up the default route bound to the interface.
452 Defaults to false. This is useful when creating routes on point-to-point interfaces.
453 This is equivalent to e.g. the following.
454 <programlisting>ip route add default dev veth99
</programlisting></para>
458 <term><varname>IPv6Token=
</varname></term>
460 <para>Specifies an optional address generation mode for the Stateless Address
461 Autoconfiguration (SLAAC). Supported modes are
<literal>prefixstable
</literal> and
462 <literal>static
</literal>.
</para>
464 <para>When the mode is set to
<literal>static
</literal>, an IPv6 address must be
465 specified after a colon (
<literal>:
</literal>), and the lower bits of the supplied
466 address are combined with the upper bits of a prefix received in a Router Advertisement
467 (RA) message to form a complete address. Note that if multiple prefixes are received in an
468 RA message, or in multiple RA messages, addresses will be formed from each of them using
469 the supplied address. This mode implements SLAAC but uses a static interface identifier
470 instead of an identifier generated by using the EUI-
64 algorithm. Because the interface
471 identifier is static, if Duplicate Address Detection detects that the computed address is a
472 duplicate (in use by another node on the link), then this mode will fail to provide an
473 address for that prefix. If an IPv6 address without mode is specified, then
474 <literal>static
</literal> mode is assumed.
</para>
476 <para>When the mode is set to
<literal>prefixstable
</literal> the
477 <ulink url=
"https://tools.ietf.org/html/rfc7217">RFC
7217</ulink> algorithm for generating
478 interface identifiers will be used. This mode can optionally take an IPv6 address separated
479 with a colon (
<literal>:
</literal>). If an IPv6 address is specified, then an interface
480 identifier is generated only when a prefix received in an RA message matches the supplied
483 <para>If no address generation mode is specified (which is the default), or a received
484 prefix does not match any of the addresses provided in
<literal>prefixstable
</literal>
485 mode, then the EUI-
64 algorithm will be used to form an interface identifier for that
486 prefix. This mode is also SLAAC, but with a potentially stable interface identifier which
487 does not directly map to the interface's hardware address.
</para>
489 <para>Note that the
<literal>prefixstable
</literal> algorithm uses both the interface
490 name and MAC address as input to the hash to compute the interface identifier, so if either
491 of those are changed the resulting interface identifier (and address) will change, even if
492 the prefix received in the RA message has not changed.
</para>
494 <para>This setting can be specified multiple times. If an empty string is assigned, then
495 the all previous assignments are cleared.
</para>
498 <programlisting>IPv6Token=::
1a:
2b:
3c:
4d
499 IPv6Token=static:::
1a:
2b:
3c:
4d
500 IPv6Token=prefixstable
501 IPv6Token=prefixstable:
2002:da8:
1::
</programlisting></para>
505 <term><varname>LLMNR=
</varname></term>
507 <para>Takes a boolean or
<literal>resolve
</literal>. When true,
509 url=
"https://tools.ietf.org/html/rfc4795">Link-Local
510 Multicast Name Resolution
</ulink> on the link. When set to
511 <literal>resolve
</literal>, only resolution is enabled,
512 but not host registration and announcement. Defaults to
513 true. This setting is read by
514 <citerefentry><refentrytitle>systemd-resolved.service
</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
</para>
518 <term><varname>MulticastDNS=
</varname></term>
520 <para>Takes a boolean or
<literal>resolve
</literal>. When true,
522 url=
"https://tools.ietf.org/html/rfc6762">Multicast
523 DNS
</ulink> support on the link. When set to
524 <literal>resolve
</literal>, only resolution is enabled,
525 but not host or service registration and
526 announcement. Defaults to false. This setting is read by
527 <citerefentry><refentrytitle>systemd-resolved.service
</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
</para>
531 <term><varname>DNSOverTLS=
</varname></term>
533 <para>Takes a boolean or
<literal>opportunistic
</literal>.
536 url=
"https://tools.ietf.org/html/rfc7858">DNS-over-TLS
</ulink>
538 When set to
<literal>opportunistic
</literal>, compatibility with
539 non-DNS-over-TLS servers is increased, by automatically
540 turning off DNS-over-TLS servers in this case.
541 This option defines a per-interface setting for
542 <citerefentry><refentrytitle>resolved.conf
</refentrytitle><manvolnum>5</manvolnum></citerefentry>'s
543 global
<varname>DNSOverTLS=
</varname> option. Defaults to
544 false. This setting is read by
545 <citerefentry><refentrytitle>systemd-resolved.service
</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
</para>
549 <term><varname>DNSSEC=
</varname></term>
551 <para>Takes a boolean or
<literal>allow-downgrade
</literal>. When true, enables
552 <ulink url=
"https://tools.ietf.org/html/rfc4033">DNSSEC
</ulink>
553 DNS validation support on the link. When set to
554 <literal>allow-downgrade
</literal>, compatibility with
555 non-DNSSEC capable networks is increased, by automatically
556 turning off DNSSEC in this case. This option defines a
557 per-interface setting for
558 <citerefentry><refentrytitle>resolved.conf
</refentrytitle><manvolnum>5</manvolnum></citerefentry>'s
559 global
<varname>DNSSEC=
</varname> option. Defaults to
560 false. This setting is read by
561 <citerefentry><refentrytitle>systemd-resolved.service
</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
</para>
565 <term><varname>DNSSECNegativeTrustAnchors=
</varname></term>
566 <listitem><para>A space-separated list of DNSSEC negative
567 trust anchor domains. If specified and DNSSEC is enabled,
568 look-ups done via the interface's DNS server will be subject
569 to the list of negative trust anchors, and not require
570 authentication for the specified domains, or anything below
571 it. Use this to disable DNSSEC authentication for specific
572 private domains, that cannot be proven valid using the
573 Internet DNS hierarchy. Defaults to the empty list. This
575 <citerefentry><refentrytitle>systemd-resolved.service
</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
</para>
579 <term><varname>LLDP=
</varname></term>
581 <para>Controls support for Ethernet LLDP packet reception. LLDP is a link-layer protocol commonly
582 implemented on professional routers and bridges which announces which physical port a system is connected
583 to, as well as other related data. Accepts a boolean or the special value
584 <literal>routers-only
</literal>. When true, incoming LLDP packets are accepted and a database of all LLDP
585 neighbors maintained. If
<literal>routers-only
</literal> is set only LLDP data of various types of routers
586 is collected and LLDP data about other types of devices ignored (such as stations, telephones and
587 others). If false, LLDP reception is disabled. Defaults to
<literal>routers-only
</literal>. Use
588 <citerefentry><refentrytitle>networkctl
</refentrytitle><manvolnum>1</manvolnum></citerefentry> to query the
589 collected neighbor data. LLDP is only available on Ethernet links. See
<varname>EmitLLDP=
</varname> below
590 for enabling LLDP packet emission from the local system.
595 <term><varname>EmitLLDP=
</varname></term>
597 <para>Controls support for Ethernet LLDP packet emission. Accepts a boolean parameter or the special values
598 <literal>nearest-bridge
</literal>,
<literal>non-tpmr-bridge
</literal> and
599 <literal>customer-bridge
</literal>. Defaults to false, which turns off LLDP packet emission. If not false,
600 a short LLDP packet with information about the local system is sent out in regular intervals on the
601 link. The LLDP packet will contain information about the local hostname, the local machine ID (as stored
602 in
<citerefentry><refentrytitle>machine-id
</refentrytitle><manvolnum>5</manvolnum></citerefentry>) and the
603 local interface name, as well as the pretty hostname of the system (as set in
604 <citerefentry><refentrytitle>machine-info
</refentrytitle><manvolnum>5</manvolnum></citerefentry>). LLDP
605 emission is only available on Ethernet links. Note that this setting passes data suitable for
606 identification of host to the network and should thus not be enabled on untrusted networks, where such
607 identification data should not be made available. Use this option to permit other systems to identify on
608 which interfaces they are connected to this system. The three special values control propagation of the
609 LLDP packets. The
<literal>nearest-bridge
</literal> setting permits propagation only to the nearest
610 connected bridge,
<literal>non-tpmr-bridge
</literal> permits propagation across Two-Port MAC Relays, but
611 not any other bridges, and
<literal>customer-bridge
</literal> permits propagation until a customer bridge
612 is reached. For details about these concepts, see
<ulink
613 url=
"https://standards.ieee.org/findstds/standard/802.1AB-2016.html">IEEE
802.1AB-
2016</ulink>. Note that
614 configuring this setting to true is equivalent to
<literal>nearest-bridge
</literal>, the recommended and
615 most restricted level of propagation. See
<varname>LLDP=
</varname> above for an option to enable LLDP
621 <term><varname>BindCarrier=
</varname></term>
623 <para>A link name or a list of link names. When set, controls the behavior of the current
624 link. When all links in the list are in an operational down state, the current link is brought
625 down. When at least one link has carrier, the current interface is brought up.
</para>
627 <para>This forces
<varname>ActivationPolicy=
</varname> to be set to
<literal>bound
</literal>.
</para>
631 <term><varname>Address=
</varname></term>
633 <para>A static IPv4 or IPv6 address and its prefix length,
634 separated by a
<literal>/
</literal> character. Specify
635 this key more than once to configure several addresses.
636 The format of the address must be as described in
637 <citerefentry project='man-pages'
><refentrytitle>inet_pton
</refentrytitle><manvolnum>3</manvolnum></citerefentry>.
638 This is a short-hand for an [Address] section only
639 containing an Address key (see below). This option may be
640 specified more than once.
643 <para>If the specified address is
<literal>0.0.0.0</literal> (for IPv4) or
<literal>::
</literal>
644 (for IPv6), a new address range of the requested size is automatically allocated from a
645 system-wide pool of unused ranges. Note that the prefix length must be equal or larger than
8 for
646 IPv4, and
64 for IPv6. The allocated range is checked against all current network interfaces and
647 all known network configuration files to avoid address range conflicts. The default system-wide
648 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.
649 This functionality is useful to manage a large number of dynamically created network interfaces
650 with the same network configuration and automatic address range assignment.
</para>
655 <term><varname>Gateway=
</varname></term>
657 <para>The gateway address, which must be in the format
659 <citerefentry project='man-pages'
><refentrytitle>inet_pton
</refentrytitle><manvolnum>3</manvolnum></citerefentry>.
660 This is a short-hand for a [Route] section only containing
661 a Gateway key. This option may be specified more than
666 <term><varname>DNS=
</varname></term>
668 <para>A DNS server address, which must be in the format described in
669 <citerefentry project='man-pages'
><refentrytitle>inet_pton
</refentrytitle><manvolnum>3</manvolnum></citerefentry>.
670 This option may be specified more than once. Each address can optionally take a port number
671 separated with
<literal>:
</literal>, a network interface name or index separated with
672 <literal>%
</literal>, and a Server Name Indication (SNI) separated with
<literal>#
</literal>.
673 When IPv6 address is specified with a port number, then the address must be in the square
674 brackets. That is, the acceptable full formats are
675 <literal>111.222.333.444:
9953%ifname#example.com
</literal> for IPv4 and
676 <literal>[
1111:
2222::
3333]:
9953%ifname#example.com
</literal> for IPv6. If an empty string is
677 assigned, then the all previous assignments are cleared. This setting is read by
678 <citerefentry><refentrytitle>systemd-resolved.service
</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
</para>
682 <term><varname>Domains=
</varname></term>
684 <para>A whitespace-separated list of domains which should be resolved using the DNS servers on
685 this link. Each item in the list should be a domain name, optionally prefixed with a tilde
686 (
<literal>~
</literal>). The domains with the prefix are called
"routing-only domains". The
687 domains without the prefix are called
"search domains" and are first used as search suffixes for
688 extending single-label hostnames (hostnames containing no dots) to become fully qualified
689 domain names (FQDNs). If a single-label hostname is resolved on this interface, each of the
690 specified search domains are appended to it in turn, converting it into a fully qualified domain
691 name, until one of them may be successfully resolved.
</para>
693 <para>Both
"search" and
"routing-only" domains are used for routing of DNS queries: look-ups for hostnames
694 ending in those domains (hence also single label names, if any
"search domains" are listed), are routed to
695 the DNS servers configured for this interface. The domain routing logic is particularly useful on
696 multi-homed hosts with DNS servers serving particular private DNS zones on each interface.
</para>
698 <para>The
"routing-only" domain
<literal>~.
</literal> (the tilde indicating definition of a routing domain,
699 the dot referring to the DNS root domain which is the implied suffix of all valid DNS names) has special
700 effect. It causes all DNS traffic which does not match another configured domain routing entry to be routed
701 to DNS servers specified for this interface. This setting is useful to prefer a certain set of DNS servers
702 if a link on which they are connected is available.
</para>
704 <para>This setting is read by
705 <citerefentry><refentrytitle>systemd-resolved.service
</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
706 "Search domains" correspond to the
<varname>domain
</varname> and
<varname>search
</varname> entries in
707 <citerefentry project='man-pages'
><refentrytitle>resolv.conf
</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
708 Domain name routing has no equivalent in the traditional glibc API, which has no concept of domain
709 name servers limited to a specific link.
</para>
713 <term><varname>DNSDefaultRoute=
</varname></term>
715 <para>Takes a boolean argument. If true, this link's configured DNS servers are used for resolving domain
716 names that do not match any link's configured
<varname>Domains=
</varname> setting. If false, this link's
717 configured DNS servers are never used for such domains, and are exclusively used for resolving names that
718 match at least one of the domains configured on this link. If not specified defaults to an automatic mode:
719 queries not matching any link's configured domains will be routed to this link if it has no routing-only
720 domains configured.
</para>
724 <term><varname>NTP=
</varname></term>
726 <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
727 <citerefentry><refentrytitle>systemd-timesyncd.service
</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
</para>
731 <term><varname>IPForward=
</varname></term>
732 <listitem><para>Configures IP packet forwarding for the
733 system. If enabled, incoming packets on any network
734 interface will be forwarded to any other interfaces
735 according to the routing table. Takes a boolean,
736 or the values
<literal>ipv4
</literal> or
737 <literal>ipv6
</literal>, which only enable IP packet
738 forwarding for the specified address family. This controls
739 the
<filename>net.ipv4.ip_forward
</filename> and
740 <filename>net.ipv6.conf.all.forwarding
</filename> sysctl
741 options of the network interface (see
<ulink
742 url=
"https://www.kernel.org/doc/Documentation/networking/ip-sysctl.txt">ip-sysctl.txt
</ulink>
743 for details about sysctl options). Defaults to
744 <literal>no
</literal>.
</para>
746 <para>Note: this setting controls a global kernel option,
747 and does so one way only: if a network that has this setting
748 enabled is set up the global setting is turned on. However,
749 it is never turned off again, even after all networks with
750 this setting enabled are shut down again.
</para>
752 <para>To allow IP packet forwarding only between specific
753 network interfaces use a firewall.
</para>
757 <term><varname>IPMasquerade=
</varname></term>
758 <listitem><para>Configures IP masquerading for the network
759 interface. If enabled, packets forwarded from the network
760 interface will be appear as coming from the local host.
761 Takes a boolean argument. Implies
762 <varname>IPForward=ipv4
</varname>. Defaults to
763 <literal>no
</literal>.
</para></listitem>
766 <term><varname>IPv6PrivacyExtensions=
</varname></term>
767 <listitem><para>Configures use of stateless temporary
768 addresses that change over time (see
<ulink
769 url=
"https://tools.ietf.org/html/rfc4941">RFC
4941</ulink>,
770 Privacy Extensions for Stateless Address Autoconfiguration
771 in IPv6). Takes a boolean or the special values
772 <literal>prefer-public
</literal> and
773 <literal>kernel
</literal>. When true, enables the privacy
774 extensions and prefers temporary addresses over public
775 addresses. When
<literal>prefer-public
</literal>, enables the
776 privacy extensions, but prefers public addresses over
777 temporary addresses. When false, the privacy extensions
778 remain disabled. When
<literal>kernel
</literal>, the kernel's
779 default setting will be left in place. Defaults to
780 <literal>no
</literal>.
</para></listitem>
783 <term><varname>IPv6AcceptRA=
</varname></term>
784 <listitem><para>Takes a boolean. Controls IPv6 Router Advertisement (RA) reception support for the
785 interface. If true, RAs are accepted; if false, RAs are ignored. When RAs are accepted, they may
786 trigger the start of the DHCPv6 client if the relevant flags are set in the RA data, or if no
787 routers are found on the link. The default is to disable RA reception for bridge devices or when IP
788 forwarding is enabled, and to enable it otherwise. Cannot be enabled on bond devices and when link
789 local addressing is disabled.
</para>
791 <para>Further settings for the IPv6 RA support may be configured in the [IPv6AcceptRA] section, see
794 <para>Also see
<ulink
795 url=
"https://www.kernel.org/doc/Documentation/networking/ip-sysctl.txt">ip-sysctl.txt
</ulink> in the kernel
796 documentation regarding
<literal>accept_ra
</literal>, but note that systemd's setting of
797 <constant>1</constant> (i.e. true) corresponds to kernel's setting of
<constant>2</constant>.
</para>
799 <para>Note that kernel's implementation of the IPv6 RA protocol is always disabled,
800 regardless of this setting. If this option is enabled, a userspace implementation of the IPv6
801 RA protocol is used, and the kernel's own implementation remains disabled, since
802 <command>systemd-networkd
</command> needs to know all details supplied in the advertisements,
803 and these are not available from the kernel if the kernel's own implementation is used.
</para>
807 <term><varname>IPv6DuplicateAddressDetection=
</varname></term>
808 <listitem><para>Configures the amount of IPv6 Duplicate
809 Address Detection (DAD) probes to send. When unset, the kernel's default will be used.
813 <term><varname>IPv6HopLimit=
</varname></term>
814 <listitem><para>Configures IPv6 Hop Limit. For each router that
815 forwards the packet, the hop limit is decremented by
1. When the
816 hop limit field reaches zero, the packet is discarded.
817 When unset, the kernel's default will be used.
821 <term><varname>IPv4AcceptLocal=
</varname></term>
822 <listitem><para>Takes a boolean. Accept packets with local source addresses. In combination
823 with suitable routing, this can be used to direct packets between two local interfaces over
824 the wire and have them accepted properly. When unset, the kernel's default will be used.
828 <term><varname>IPv4ProxyARP=
</varname></term>
829 <listitem><para>Takes a boolean. Configures proxy ARP for IPv4. Proxy ARP is the technique in which one host,
830 usually a router, answers ARP requests intended for another machine. By
"faking" its identity,
831 the router accepts responsibility for routing packets to the
"real" destination. See
<ulink
832 url=
"https://tools.ietf.org/html/rfc1027">RFC
1027</ulink>.
833 When unset, the kernel's default will be used.
837 <term><varname>IPv6ProxyNDP=
</varname></term>
838 <listitem><para>Takes a boolean. Configures proxy NDP for IPv6. Proxy NDP (Neighbor Discovery
839 Protocol) is a technique for IPv6 to allow routing of addresses to a different
840 destination when peers expect them to be present on a certain physical link.
841 In this case a router answers Neighbour Advertisement messages intended for
842 another machine by offering its own MAC address as destination.
843 Unlike proxy ARP for IPv4, it is not enabled globally, but will only send Neighbour
844 Advertisement messages for addresses in the IPv6 neighbor proxy table,
845 which can also be shown by
<command>ip -
6 neighbour show proxy
</command>.
846 systemd-networkd will control the per-interface `proxy_ndp` switch for each configured
847 interface depending on this option.
848 When unset, the kernel's default will be used.
852 <term><varname>IPv6ProxyNDPAddress=
</varname></term>
853 <listitem><para>An IPv6 address, for which Neighbour Advertisement messages will be
854 proxied. This option may be specified more than once. systemd-networkd will add the
855 <option>IPv6ProxyNDPAddress=
</option> entries to the kernel's IPv6 neighbor proxy table.
856 This option implies
<option>IPv6ProxyNDP=yes
</option> but has no effect if
857 <option>IPv6ProxyNDP
</option> has been set to false. When unset, the kernel's default will be used.
861 <term><varname>IPv6SendRA=
</varname></term>
862 <listitem><para>Whether to enable or disable Router Advertisement sending on a link. Takes a
863 boolean value. When enabled, prefixes configured in [IPv6Prefix] sections and routes
864 configured in [IPv6RoutePrefix] sections are distributed as defined in the [IPv6SendRA]
865 section. If
<varname>DHCPv6PrefixDelegation=
</varname> is enabled, then the delegated
866 prefixes are also distributed. See
<varname>DHCPv6PrefixDelegation=
</varname> setting and the
867 [IPv6SendRA], [IPv6Prefix], [IPv6RoutePrefix], and [DHCPv6PrefixDelegation] sections for more
868 configuration options.
</para></listitem>
871 <term><varname>DHCPv6PrefixDelegation=
</varname></term>
872 <listitem><para>Takes a boolean value. When enabled, requests prefixes using a DHCPv6 client
873 configured on another link. By default, an address within each delegated prefix will be
874 assigned, and the prefixes will be announced through IPv6 Router Advertisement when
875 <varname>IPv6SendRA=
</varname> is enabled. Such default settings can be configured in
876 [DHCPv6PrefixDelegation] section. Defaults to disabled.
</para></listitem>
879 <term><varname>IPv6MTUBytes=
</varname></term>
880 <listitem><para>Configures IPv6 maximum transmission unit (MTU).
881 An integer greater than or equal to
1280 bytes. When unset, the kernel's default will be used.
885 <term><varname>Bridge=
</varname></term>
887 <para>The name of the bridge to add the link to. See
888 <citerefentry><refentrytitle>systemd.netdev
</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
893 <term><varname>Bond=
</varname></term>
895 <para>The name of the bond to add the link to. See
896 <citerefentry><refentrytitle>systemd.netdev
</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
901 <term><varname>VRF=
</varname></term>
903 <para>The name of the VRF to add the link to. See
904 <citerefentry><refentrytitle>systemd.netdev
</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
909 <term><varname>VLAN=
</varname></term>
911 <para>The name of a VLAN to create on the link. See
912 <citerefentry><refentrytitle>systemd.netdev
</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
913 This option may be specified more than once.
</para>
917 <term><varname>IPVLAN=
</varname></term>
919 <para>The name of a IPVLAN to create on the link. See
920 <citerefentry><refentrytitle>systemd.netdev
</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
921 This option may be specified more than once.
</para>
925 <term><varname>MACVLAN=
</varname></term>
927 <para>The name of a MACVLAN to create on the link. See
928 <citerefentry><refentrytitle>systemd.netdev
</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
929 This option may be specified more than once.
</para>
933 <term><varname>VXLAN=
</varname></term>
935 <para>The name of a VXLAN to create on the link. See
936 <citerefentry><refentrytitle>systemd.netdev
</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
937 This option may be specified more than once.
</para>
941 <term><varname>Tunnel=
</varname></term>
943 <para>The name of a Tunnel to create on the link. See
944 <citerefentry><refentrytitle>systemd.netdev
</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
945 This option may be specified more than once.
</para>
949 <term><varname>MACsec=
</varname></term>
951 <para>The name of a MACsec device to create on the link. See
952 <citerefentry><refentrytitle>systemd.netdev
</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
953 This option may be specified more than once.
</para>
957 <term><varname>ActiveSlave=
</varname></term>
959 <para>Takes a boolean. Specifies the new active slave. The
<literal>ActiveSlave=
</literal>
960 option is only valid for following modes:
961 <literal>active-backup
</literal>,
962 <literal>balance-alb
</literal> and
963 <literal>balance-tlb
</literal>. Defaults to false.
968 <term><varname>PrimarySlave=
</varname></term>
970 <para>Takes a boolean. Specifies which slave is the primary device. The specified
971 device will always be the active slave while it is available. Only when the
972 primary is off-line will alternate devices be used. This is useful when
973 one slave is preferred over another, e.g. when one slave has higher throughput
974 than another. The
<literal>PrimarySlave=
</literal> option is only valid for
976 <literal>active-backup
</literal>,
977 <literal>balance-alb
</literal> and
978 <literal>balance-tlb
</literal>. Defaults to false.
983 <term><varname>ConfigureWithoutCarrier=
</varname></term>
985 <para>Takes a boolean. Allows networkd to configure a specific link even if it has no carrier.
986 Defaults to false. If
<option>IgnoreCarrierLoss=
</option> is not explicitly set, it will
987 default to this value.
992 <term><varname>IgnoreCarrierLoss=
</varname></term>
994 <para>Takes a boolean. Allows networkd to retain both the static and dynamic configuration
995 of the interface even if its carrier is lost. When unset, the value specified with
996 <option>ConfigureWithoutCarrier=
</option> is used.
999 <para>When
<varname>ActivationPolicy=
</varname> is set to
<literal>always-up
</literal>, this
1000 is forced to
<literal>true
</literal>.
1005 <term><varname>Xfrm=
</varname></term>
1007 <para>The name of the xfrm to create on the link. See
1008 <citerefentry><refentrytitle>systemd.netdev
</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
1009 This option may be specified more than once.
</para>
1013 <term><varname>KeepConfiguration=
</varname></term>
1015 <para>Takes a boolean or one of
<literal>static
</literal>,
<literal>dhcp-on-stop
</literal>,
1016 <literal>dhcp
</literal>. When
<literal>static
</literal>,
<command>systemd-networkd
</command>
1017 will not drop static addresses and routes on starting up process. When set to
1018 <literal>dhcp-on-stop
</literal>,
<command>systemd-networkd
</command> will not drop addresses
1019 and routes on stopping the daemon. When
<literal>dhcp
</literal>,
1020 the addresses and routes provided by a DHCP server will never be dropped even if the DHCP
1021 lease expires. This is contrary to the DHCP specification, but may be the best choice if,
1022 e.g., the root filesystem relies on this connection. The setting
<literal>dhcp
</literal>
1023 implies
<literal>dhcp-on-stop
</literal>, and
<literal>yes
</literal> implies
1024 <literal>dhcp
</literal> and
<literal>static
</literal>. Defaults to
<literal>no
</literal>.
1034 <title>[Address] Section Options
</title>
1036 <para>An [Address] section accepts the following keys. Specify several [Address]
1037 sections to configure several addresses.
</para>
1039 <variablelist class='network-directives'
>
1041 <term><varname>Address=
</varname></term>
1043 <para>As in the [Network] section. This key is mandatory. Each [Address] section can contain one
1044 <varname>Address=
</varname> setting.
</para>
1048 <term><varname>Peer=
</varname></term>
1050 <para>The peer address in a point-to-point connection.
1051 Accepts the same format as the
<varname>Address=
</varname>
1056 <term><varname>Broadcast=
</varname></term>
1058 <para>The broadcast address, which must be in the format
1060 <citerefentry project='man-pages'
><refentrytitle>inet_pton
</refentrytitle><manvolnum>3</manvolnum></citerefentry>.
1061 This key only applies to IPv4 addresses. If it is not
1062 given, it is derived from the
<varname>Address=
</varname>
1067 <term><varname>Label=
</varname></term>
1069 <para>An address label.
</para>
1073 <term><varname>PreferredLifetime=
</varname></term>
1075 <para>Allows the default
"preferred lifetime" of the address to be overridden. Only three
1076 settings are accepted:
<literal>forever
</literal>,
<literal>infinity
</literal>, which is the
1077 default and means that the address never expires, and
<literal>0</literal>, which means that the
1078 address is considered immediately
"expired" and will not be used, unless explicitly requested. A
1079 setting of
<option>PreferredLifetime=
0</option> is useful for addresses which are added to be
1080 used only by a specific application, which is then configured to use them explicitly.
</para>
1084 <term><varname>Scope=
</varname></term>
1086 <para>The scope of the address, which can be
1087 <literal>global
</literal> (valid everywhere on the network, even through a gateway),
1088 <literal>link
</literal> (only valid on this device, will not traverse a gateway) or
1089 <literal>host
</literal> (only valid within the device itself, e.g.
127.0.0.1)
1090 or an unsigned integer in the range
0—
255.
1091 Defaults to
<literal>global
</literal>.
</para>
1095 <term><varname>HomeAddress=
</varname></term>
1097 <para>Takes a boolean. Designates this address the
"home address" as defined in
1098 <ulink url=
"https://tools.ietf.org/html/rfc6275">RFC
6275</ulink>.
1099 Supported only on IPv6. Defaults to false.
</para>
1103 <term><varname>DuplicateAddressDetection=
</varname></term>
1105 <para>Takes one of
<literal>ipv4
</literal>,
<literal>ipv6
</literal>,
1106 <literal>both
</literal>,
<literal>none
</literal>. When
<literal>ipv4
</literal>,
1107 performs IPv4 Duplicate Address Detection. See
1108 <ulink url=
"https://tools.ietf.org/html/rfc5227">RFC
5224</ulink>.
1109 When
<literal>ipv6
</literal>, performs IPv6 Duplicate Address Detection. See
1110 <ulink url=
"https://tools.ietf.org/html/rfc4862">RFC
4862</ulink>.
1111 Defaults to
<literal>ipv6
</literal>.
</para>
1115 <term><varname>ManageTemporaryAddress=
</varname></term>
1117 <para>Takes a boolean. If true the kernel manage temporary addresses created
1118 from this one as template on behalf of Privacy Extensions
1119 <ulink url=
"https://tools.ietf.org/html/rfc3041">RFC
3041</ulink>. For this to become
1120 active, the use_tempaddr sysctl setting has to be set to a value greater than zero.
1121 The given address needs to have a prefix length of
64. This flag allows using privacy
1122 extensions in a manually configured network, just like if stateless auto-configuration
1123 was active. Defaults to false.
</para>
1127 <term><varname>AddPrefixRoute=
</varname></term>
1129 <para>Takes a boolean. When true, the prefix route for the address is automatically added.
1130 Defaults to true.
</para>
1134 <term><varname>AutoJoin=
</varname></term>
1136 <para>Takes a boolean. Joining multicast group on ethernet level via
1137 <command>ip maddr
</command> command would not work if we have an Ethernet switch that does
1138 IGMP snooping since the switch would not replicate multicast packets on ports that did not
1139 have IGMP reports for the multicast addresses. Linux vxlan interfaces created via
1140 <command>ip link add vxlan
</command> or networkd's netdev kind vxlan have the group option
1141 that enables then to do the required join. By extending ip address command with option
1142 <literal>autojoin
</literal> we can get similar functionality for openvswitch (OVS) vxlan
1143 interfaces as well as other tunneling mechanisms that need to receive multicast traffic.
1144 Defaults to
<literal>no
</literal>.
</para>
1151 <title>[Neighbor] Section Options
</title>
1152 <para>A [Neighbor] section accepts the following keys. The neighbor section adds a permanent, static
1153 entry to the neighbor table (IPv6) or ARP table (IPv4) for the given hardware address on the links
1154 matched for the network. Specify several [Neighbor] sections to configure several static neighbors.
1157 <variablelist class='network-directives'
>
1159 <term><varname>Address=
</varname></term>
1161 <para>The IP address of the neighbor.
</para>
1165 <term><varname>LinkLayerAddress=
</varname></term>
1167 <para>The link layer address (MAC address or IP address) of the neighbor.
</para>
1174 <title>[IPv6AddressLabel] Section Options
</title>
1176 <para>An [IPv6AddressLabel] section accepts the following keys. Specify several [IPv6AddressLabel]
1177 sections to configure several address labels. IPv6 address labels are used for address selection. See
1178 <ulink url=
"https://tools.ietf.org/html/rfc3484">RFC
3484</ulink>. Precedence is managed by userspace,
1179 and only the label itself is stored in the kernel.
</para>
1181 <variablelist class='network-directives'
>
1183 <term><varname>Label=
</varname></term>
1185 <para>The label for the prefix, an unsigned integer in the range
0–
4294967294.
1186 0xffffffff is reserved. This setting is mandatory.
</para>
1190 <term><varname>Prefix=
</varname></term>
1192 <para>IPv6 prefix is an address with a prefix length, separated by a slash
<literal>/
</literal> character.
1193 This key is mandatory.
</para>
1200 <title>[RoutingPolicyRule] Section Options
</title>
1202 <para>An [RoutingPolicyRule] section accepts the following keys. Specify several [RoutingPolicyRule]
1203 sections to configure several rules.
</para>
1205 <variablelist class='network-directives'
>
1207 <term><varname>TypeOfService=
</varname></term>
1209 <para>Takes a number between
0 and
255 that specifies the type of service to match.
</para>
1213 <term><varname>From=
</varname></term>
1215 <para>Specifies the source address prefix to match. Possibly followed by a slash and the prefix length.
</para>
1219 <term><varname>To=
</varname></term>
1221 <para>Specifies the destination address prefix to match. Possibly followed by a slash and the prefix length.
</para>
1225 <term><varname>FirewallMark=
</varname></term>
1227 <para>Specifies the iptables firewall mark value to match (a number between
1 and
1228 4294967295). Optionally, the firewall mask (also a number between
1 and
4294967295) can be
1229 suffixed with a slash (
<literal>/
</literal>), e.g.,
<literal>7/
255</literal>.
</para>
1233 <term><varname>Table=
</varname></term>
1235 <para>Specifies the routing table identifier to lookup if the rule selector matches. Takes one of predefined names
1236 <literal>default
</literal>,
<literal>main
</literal>, and
<literal>local
</literal>, and names defined in
<varname>RouteTable=
</varname>
1237 in
<citerefentry><refentrytitle>networkd.conf
</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
1238 or a number between
1 and
4294967295. Defaults to
<literal>main
</literal>.
</para>
1242 <term><varname>Priority=
</varname></term>
1244 <para>Specifies the priority of this rule.
<varname>Priority=
</varname> is an unsigned
1245 integer. Higher number means lower priority, and rules get processed in order of increasing number.
</para>
1249 <term><varname>IncomingInterface=
</varname></term>
1251 <para>Specifies incoming device to match. If the interface is loopback, the rule only matches packets originating from this host.
</para>
1255 <term><varname>OutgoingInterface=
</varname></term>
1257 <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>
1261 <term><varname>SourcePort=
</varname></term>
1263 <para>Specifies the source IP port or IP port range match in forwarding information base (FIB) rules.
1264 A port range is specified by the lower and upper port separated by a dash. Defaults to unset.
</para>
1268 <term><varname>DestinationPort=
</varname></term>
1270 <para>Specifies the destination IP port or IP port range match in forwarding information base (FIB) rules.
1271 A port range is specified by the lower and upper port separated by a dash. Defaults to unset.
</para>
1275 <term><varname>IPProtocol=
</varname></term>
1277 <para>Specifies the IP protocol to match in forwarding information base (FIB) rules. Takes IP protocol name such as
<literal>tcp
</literal>,
1278 <literal>udp
</literal> or
<literal>sctp
</literal>, or IP protocol number such as
<literal>6</literal> for
<literal>tcp
</literal> or
1279 <literal>17</literal> for
<literal>udp
</literal>.
1280 Defaults to unset.
</para>
1284 <term><varname>InvertRule=
</varname></term>
1286 <para>A boolean. Specifies whether the rule is to be inverted. Defaults to false.
</para>
1290 <term><varname>Family=
</varname></term>
1292 <para>Takes a special value
<literal>ipv4
</literal>,
<literal>ipv6
</literal>, or
1293 <literal>both
</literal>. By default, the address family is determined by the address
1294 specified in
<varname>To=
</varname> or
<varname>From=
</varname>. If neither
1295 <varname>To=
</varname> nor
<varname>From=
</varname> are specified, then defaults to
1296 <literal>ipv4
</literal>.
</para>
1300 <term><varname>User=
</varname></term>
1302 <para>Takes a username, a user ID, or a range of user IDs separated by a dash. Defaults to
1307 <term><varname>SuppressPrefixLength=
</varname></term>
1309 <para>Takes a number
<replaceable>N
</replaceable> in the range
0-
128 and rejects routing
1310 decisions that have a prefix length of
<replaceable>N
</replaceable> or less. Defaults to
1315 <term><varname>Type=
</varname></term>
1317 <para>Specifies Routing Policy Database (RPDB) rule type. Takes one of
<literal>blackhole
</literal>,
1318 <literal>unreachable
</literal> or
<literal>prohibit
</literal>.
1326 <title>[NextHop] Section Options
</title>
1327 <para>The [NextHop] section is used to manipulate entries in the kernel's
"nexthop" tables. The
1328 [NextHop] section accepts the following keys. Specify several [NextHop] sections to configure several
1331 <variablelist class='network-directives'
>
1333 <term><varname>Gateway=
</varname></term>
1335 <para>As in the [Network] section. This is mandatory.
</para>
1339 <term><varname>Id=
</varname></term>
1341 <para>The id of the nexthop (an unsigned integer). If unspecified or '
0' then automatically chosen by kernel.
</para>
1348 <title>[Route] Section Options
</title>
1349 <para>The [Route] section accepts the following keys. Specify several [Route] sections to configure
1350 several routes.
</para>
1352 <variablelist class='network-directives'
>
1354 <term><varname>Gateway=
</varname></term>
1356 <para>Takes the gateway address or the special values
<literal>_dhcp4
</literal> and
1357 <literal>_ipv6ra
</literal>. If
<literal>_dhcp4
</literal> or
<literal>_ipv6ra
</literal> is
1358 set, then the gateway address provided by DHCPv4 or IPv6 RA is used.
</para>
1362 <term><varname>GatewayOnLink=
</varname></term>
1364 <para>Takes a boolean. If set to true, the kernel does not have
1365 to check if the gateway is reachable directly by the current machine (i.e., the kernel does
1366 not need to check if the gateway is attached to the local network), so that we can insert the
1367 route in the kernel table without it being complained about. Defaults to
<literal>no
</literal>.
1372 <term><varname>Destination=
</varname></term>
1374 <para>The destination prefix of the route. Possibly
1375 followed by a slash and the prefix length. If omitted, a
1376 full-length host route is assumed.
</para>
1380 <term><varname>Source=
</varname></term>
1382 <para>The source prefix of the route. Possibly followed by
1383 a slash and the prefix length. If omitted, a full-length
1384 host route is assumed.
</para>
1388 <term><varname>Metric=
</varname></term>
1390 <para>The metric of the route (an unsigned integer).
</para>
1394 <term><varname>IPv6Preference=
</varname></term>
1396 <para>Specifies the route preference as defined in
<ulink
1397 url=
"https://tools.ietf.org/html/rfc4191">RFC
4191</ulink> for Router Discovery messages. Which
1398 can be one of
<literal>low
</literal> the route has a lowest priority,
<literal>medium
</literal>
1399 the route has a default priority or
<literal>high
</literal> the route has a highest priority.
1404 <term><varname>Scope=
</varname></term>
1406 <para>The scope of the IPv4 route, which can be
<literal>global
</literal>,
<literal>site
</literal>,
1407 <literal>link
</literal>,
<literal>host
</literal>, or
1408 <literal>nowhere
</literal>:
</para>
1410 <listitem><para><literal>global
</literal> means the route can reach
1411 hosts more than one hop away.
</para></listitem>
1413 <listitem><para><literal>site
</literal> means an interior route in
1414 the local autonomous system.
</para></listitem>
1416 <listitem><para><literal>link
</literal> means the route can only
1417 reach hosts on the local network (one hop away).
</para></listitem>
1419 <listitem><para><literal>host
</literal> means the route will not
1420 leave the local machine (used for internal addresses like
1421 127.0.0.1).
</para></listitem>
1423 <listitem><para><literal>nowhere
</literal> means the destination
1424 doesn't exist.
</para></listitem>
1426 <para>For IPv4 route, defaults to
<literal>host
</literal> if
<varname>Type=
</varname> is
1427 <literal>local
</literal> or
<literal>nat
</literal>,
1428 and
<literal>link
</literal> if
<varname>Type=
</varname> is
1429 <literal>broadcast
</literal>,
<literal>multicast
</literal>, or
<literal>anycast
</literal>.
1430 In other cases, defaults to
<literal>global
</literal>. The value is
1431 not used for IPv6.
</para>
1435 <term><varname>PreferredSource=
</varname></term>
1437 <para>The preferred source address of the route. The address
1438 must be in the format described in
1439 <citerefentry project='man-pages'
><refentrytitle>inet_pton
</refentrytitle><manvolnum>3</manvolnum></citerefentry>.
</para>
1443 <term><varname>Table=
</varname></term>
1445 <para>The table identifier for the route. Takes one of predefined names
<literal>default
</literal>,
<literal>main
</literal>,
1446 and
<literal>local
</literal>, and names defined in
<varname>RouteTable=
</varname> in
<citerefentry><refentrytitle>networkd.conf
</refentrytitle>
1447 <manvolnum>5</manvolnum></citerefentry>, or a number between
1 and
4294967295. The table can be retrieved using
1448 <command>ip route show table
<replaceable>num
</replaceable></command>. If unset and
<varname>Type=
</varname> is
<literal>local
</literal>,
1449 <literal>broadcast
</literal>,
<literal>anycast
</literal>, or
<literal>nat
</literal>, then
<literal>local
</literal> is used.
1450 In other cases, defaults to
<literal>main
</literal>.
1455 <term><varname>Protocol=
</varname></term>
1457 <para>The protocol identifier for the route. Takes a number between
0 and
255 or the special values
1458 <literal>kernel
</literal>,
<literal>boot
</literal>,
<literal>static
</literal>,
1459 <literal>ra
</literal> and
<literal>dhcp
</literal>. Defaults to
<literal>static
</literal>.
1464 <term><varname>Type=
</varname></term>
1466 <para>Specifies the type for the route. Takes one of
<literal>unicast
</literal>,
1467 <literal>local
</literal>,
<literal>broadcast
</literal>,
<literal>anycast
</literal>,
1468 <literal>multicast
</literal>,
<literal>blackhole
</literal>,
<literal>unreachable
</literal>,
1469 <literal>prohibit
</literal>,
<literal>throw
</literal>,
<literal>nat
</literal>, and
1470 <literal>xresolve
</literal>. If
<literal>unicast
</literal>, a regular route is defined, i.e. a
1471 route indicating the path to take to a destination network address. If
<literal>blackhole
</literal>, packets
1472 to the defined route are discarded silently. If
<literal>unreachable
</literal>, packets to the defined route
1473 are discarded and the ICMP message
"Host Unreachable" is generated. If
<literal>prohibit
</literal>, packets
1474 to the defined route are discarded and the ICMP message
"Communication Administratively Prohibited" is
1475 generated. If
<literal>throw
</literal>, route lookup in the current routing table will fail and the route
1476 selection process will return to Routing Policy Database (RPDB). Defaults to
<literal>unicast
</literal>.
1481 <term><varname>InitialCongestionWindow=
</varname></term>
1483 <para>The TCP initial congestion window is used during the start of a TCP connection.
1484 During the start of a TCP session, when a client requests a resource, the server's initial
1485 congestion window determines how many packets will be sent during the initial burst of data
1486 without waiting for acknowledgement. Takes a number between
1 and
1023. Note that
100 is
1487 considered an extremely large value for this option. When unset, the kernel's default
1488 (typically
10) will be used.
</para>
1492 <term><varname>InitialAdvertisedReceiveWindow=
</varname></term>
1494 <para>The TCP initial advertised receive window is the amount of receive data (in bytes)
1495 that can initially be buffered at one time on a connection. The sending host can send only
1496 that amount of data before waiting for an acknowledgment and window update from the
1497 receiving host. Takes a number between
1 and
1023. Note that
100 is considered an extremely
1498 large value for this option. When unset, the kernel's default will be used.
</para>
1502 <term><varname>QuickAck=
</varname></term>
1504 <para>Takes a boolean. When true enables TCP quick ack mode for the route. When unset, the kernel's default will be used.
1509 <term><varname>FastOpenNoCookie=
</varname></term>
1511 <para>Takes a boolean. When true enables TCP fastopen without a cookie on a per-route basis.
1512 When unset, the kernel's default will be used.
1517 <term><varname>TTLPropagate=
</varname></term>
1519 <para>Takes a boolean. When true enables TTL propagation at Label Switched Path (LSP) egress.
1520 When unset, the kernel's default will be used.
1525 <term><varname>MTUBytes=
</varname></term>
1527 <para>The maximum transmission unit in bytes to set for the
1528 route. The usual suffixes K, M, G, are supported and are
1529 understood to the base of
1024.
</para>
1530 <para>Note that if IPv6 is enabled on the interface, and the MTU is chosen
1531 below
1280 (the minimum MTU for IPv6) it will automatically be increased to this value.
</para>
1535 <term><varname>IPServiceType=
</varname></term>
1537 <para>Takes string;
<literal>CS6
</literal> or
<literal>CS4
</literal>. Used to set IP
1538 service type to CS6 (network control) or CS4 (Realtime). Defaults to CS6.
</para>
1542 <term><varname>TCPAdvertisedMaximumSegmentSize=
</varname></term>
1544 <para>Specifies the Path MSS (in bytes) hints given on TCP layer. The usual suffixes K, M, G, are
1545 supported and are understood to the base of
1024. An unsigned integer in the range
1–
4294967294.
1546 When unset, the kernel's default will be used.
</para>
1550 <term><varname>MultiPathRoute=
<replaceable>address
</replaceable>[@
<replaceable>name
</replaceable>] [
<replaceable>weight
</replaceable>]
</varname></term>
1552 <para>Configures multipath route. Multipath routing is the technique of using multiple
1553 alternative paths through a network. Takes gateway address. Optionally, takes a network
1554 interface name or index separated with
<literal>@
</literal>, and a weight in
1.
.256 for
1555 this multipath route separated with whitespace. This setting can be specified multiple
1556 times. If an empty string is assigned, then the all previous assignments are cleared.
</para>
1563 <title>[DHCPv4] Section Options
</title>
1564 <para>The [DHCPv4] section configures the DHCPv4 client, if it is enabled with the
1565 <varname>DHCP=
</varname> setting described above:
</para>
1567 <variablelist class='network-directives'
>
1569 <term><varname>UseDNS=
</varname></term>
1571 <para>When true (the default), the DNS servers received
1572 from the DHCP server will be used and take precedence over
1573 any statically configured ones.
</para>
1575 <para>This corresponds to the
<option>nameserver
</option>
1576 option in
<citerefentry
1577 project='man-pages'
><refentrytitle>resolv.conf
</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
</para>
1581 <term><varname>RoutesToDNS=
</varname></term>
1583 <para>When true, the routes to the DNS servers received from the DHCP server will be
1584 configured. When
<varname>UseDNS=
</varname> is disabled, this setting is ignored.
1585 Defaults to false.
</para>
1589 <term><varname>UseNTP=
</varname></term>
1591 <para>When true (the default), the NTP servers received from the DHCP server will be used by
1592 <filename>systemd-timesyncd.service
</filename> and take precedence over any statically configured
1597 <term><varname>UseSIP=
</varname></term>
1599 <para>When true (the default), the SIP servers received from the DHCP server will be collected
1600 and made available to client programs.
</para>
1605 <term><varname>UseMTU=
</varname></term>
1607 <para>When true, the interface maximum transmission unit
1608 from the DHCP server will be used on the current link.
1609 If
<varname>MTUBytes=
</varname> is set, then this setting is ignored.
1610 Defaults to false.
</para>
1614 <term><varname>Anonymize=
</varname></term>
1616 <para>Takes a boolean. When true, the options sent to the DHCP server will
1617 follow the
<ulink url=
"https://tools.ietf.org/html/rfc7844">RFC
7844</ulink>
1618 (Anonymity Profiles for DHCP Clients) to minimize disclosure of identifying information.
1619 Defaults to false.
</para>
1621 <para>This option should only be set to true when
1622 <varname>MACAddressPolicy=
</varname> is set to
<literal>random
</literal>
1624 project='man-pages'
><refentrytitle>systemd.link
</refentrytitle><manvolnum>5</manvolnum></citerefentry>).
</para>
1626 <para>Note that this configuration will overwrite others.
1627 In concrete, the following variables will be ignored:
1628 <varname>SendHostname=
</varname>,
<varname>ClientIdentifier=
</varname>,
1629 <varname>UseRoutes=
</varname>,
<varname>UseMTU=
</varname>,
1630 <varname>VendorClassIdentifier=
</varname>,
<varname>UseTimezone=
</varname>.
</para>
1632 <para>With this option enabled DHCP requests will mimic those generated by Microsoft Windows, in
1633 order to reduce the ability to fingerprint and recognize installations. This means DHCP request
1634 sizes will grow and lease data will be more comprehensive than normally, though most of the
1635 requested data is not actually used.
</para>
1639 <term><varname>SendHostname=
</varname></term>
1641 <para>When true (the default), the machine's hostname will be sent to the DHCP server.
1642 Note that the machine's hostname must consist only of
7-bit ASCII lower-case characters and
1643 no spaces or dots, and be formatted as a valid DNS domain name. Otherwise, the hostname is not
1644 sent even if this is set to true.
</para>
1649 <term><varname>MUDURL=
</varname></term>
1651 <para>When configured, the specified Manufacturer Usage Description (MUD) URL will be sent to the
1652 DHCPv4 server. Takes a URL of length up to
255 characters. A superficial verification that the
1653 string is a valid URL will be performed. DHCPv4 clients are intended to have at most one MUD URL
1654 associated with them. See
<ulink url=
"https://tools.ietf.org/html/rfc8520">RFC
8520</ulink>.
1657 <para>MUD is an embedded software standard defined by the IETF that allows IoT device makers to
1658 advertise device specifications, including the intended communication patterns for their device
1659 when it connects to the network. The network can then use this to author a context-specific
1660 access policy, so the device functions only within those parameters.
</para>
1665 <term><varname>UseHostname=
</varname></term>
1667 <para>When true (the default), the hostname received from
1668 the DHCP server will be set as the transient hostname of the system.
1673 <term><varname>Hostname=
</varname></term>
1675 <para>Use this value for the hostname which is sent to the DHCP server, instead of machine's hostname.
1676 Note that the specified hostname must consist only of
7-bit ASCII lower-case characters and
1677 no spaces or dots, and be formatted as a valid DNS domain name.
</para>
1681 <term><varname>UseDomains=
</varname></term>
1683 <para>Takes a boolean, or the special value
<literal>route
</literal>. When true, the domain name
1684 received from the DHCP server will be used as DNS search domain over this link, similar to the effect of
1685 the
<option>Domains=
</option> setting. If set to
<literal>route
</literal>, the domain name received from
1686 the DHCP server will be used for routing DNS queries only, but not for searching, similar to the effect of
1687 the
<option>Domains=
</option> setting when the argument is prefixed with
<literal>~
</literal>. Defaults to
1690 <para>It is recommended to enable this option only on trusted networks, as setting this affects resolution
1691 of all hostnames, in particular of single-label names. It is generally safer to use the supplied domain
1692 only as routing domain, rather than as search domain, in order to not have it affect local resolution of
1693 single-label names.
</para>
1695 <para>When set to true, this setting corresponds to the
<option>domain
</option> option in
<citerefentry
1696 project='man-pages'
><refentrytitle>resolv.conf
</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
</para>
1700 <term><varname>UseRoutes=
</varname></term>
1702 <para>When true (the default), the static routes will be requested from the DHCP server and added to the
1703 routing table with a metric of
1024, and a scope of
"global",
"link" or
"host", depending on the route's
1704 destination and gateway. If the destination is on the local host, e.g.,
127.x.x.x, or the same as the
1705 link's own address, the scope will be set to
"host". Otherwise if the gateway is null (a direct route), a
1706 "link" scope will be used. For anything else, scope defaults to
"global".
</para>
1710 <term><varname>UseGateway=
</varname></term>
1712 <para>When true, the gateway will be requested from the DHCP server and added to the routing table with a
1713 metric of
1024, and a scope of
"link". When unset, the value specified with
<option>UseRoutes=
</option>
1718 <term><varname>UseTimezone=
</varname></term>
1720 <listitem><para>When true, the timezone received from the
1721 DHCP server will be set as timezone of the local
1722 system. Defaults to
<literal>no
</literal>.
</para></listitem>
1726 <term><varname>ClientIdentifier=
</varname></term>
1728 <para>The DHCPv4 client identifier to use. Takes one of
<literal>mac
</literal>,
<literal>duid
</literal> or
<literal>duid-only
</literal>.
1729 If set to
<literal>mac
</literal>, the MAC address of the link is used.
1730 If set to
<literal>duid
</literal>, an RFC4361-compliant Client ID, which is the combination of IAID and DUID (see below), is used.
1731 If set to
<literal>duid-only
</literal>, only DUID is used, this may not be RFC compliant, but some setups may require to use this.
1732 Defaults to
<literal>duid
</literal>.
</para>
1737 <term><varname>VendorClassIdentifier=
</varname></term>
1739 <para>The vendor class identifier used to identify vendor
1740 type and configuration.
</para>
1745 <term><varname>UserClass=
</varname></term>
1747 <para>A DHCPv4 client can use UserClass option to identify the type or category of user or applications
1748 it represents. The information contained in this option is a string that represents the user class of which
1749 the client is a member. Each class sets an identifying string of information to be used by the DHCP
1750 service to classify clients. Takes a whitespace-separated list of strings.
</para>
1755 <term><varname>MaxAttempts=
</varname></term>
1757 <para>Specifies how many times the DHCPv4 client configuration should be attempted. Takes a
1758 number or
<literal>infinity
</literal>. Defaults to
<literal>infinity
</literal>. Note that the
1759 time between retries is increased exponentially, up to approximately one per minute, so the
1760 network will not be overloaded even if this number is high. The default is suitable in most
1761 circumstances.
</para>
1766 <term><varname>DUIDType=
</varname></term>
1768 <para>Override the global
<varname>DUIDType
</varname> setting for this network. See
1769 <citerefentry><refentrytitle>networkd.conf
</refentrytitle><manvolnum>5</manvolnum></citerefentry>
1770 for a description of possible values.
</para>
1775 <term><varname>DUIDRawData=
</varname></term>
1777 <para>Override the global
<varname>DUIDRawData
</varname> setting for this network. See
1778 <citerefentry><refentrytitle>networkd.conf
</refentrytitle><manvolnum>5</manvolnum></citerefentry>
1779 for a description of possible values.
</para>
1784 <term><varname>IAID=
</varname></term>
1786 <para>The DHCP Identity Association Identifier (IAID) for the interface, a
32-bit unsigned integer.
</para>
1791 <term><varname>RequestBroadcast=
</varname></term>
1793 <para>Request the server to use broadcast messages before
1794 the IP address has been configured. This is necessary for
1795 devices that cannot receive RAW packets, or that cannot
1796 receive packets at all before an IP address has been
1797 configured. On the other hand, this must not be enabled on
1798 networks where broadcasts are filtered out.
</para>
1803 <term><varname>RouteMetric=
</varname></term>
1805 <para>Set the routing metric for routes specified by the DHCP server. Defaults to
1024.
</para>
1810 <term><varname>RouteTable=
<replaceable>num
</replaceable></varname></term>
1812 <para>The table identifier for DHCP routes (a number between
1 and
4294967295, or
0 to unset).
1813 The table can be retrieved using
<command>ip route show table
<replaceable>num
</replaceable></command>.
1815 <para>When used in combination with
<varname>VRF=
</varname>, the
1816 VRF's routing table is used when this parameter is not specified.
1822 <term><varname>RouteMTUBytes=
</varname></term>
1824 <para>Specifies the MTU for the DHCP routes. Please see the [Route] section for further details.
</para>
1829 <term><varname>ListenPort=
</varname></term>
1831 <para>Allow setting custom port for the DHCP client to listen on.
</para>
1836 <term><varname>FallbackLeaseLifetimeSec=
</varname></term>
1838 <para>Allows to set DHCPv4 lease lifetime when DHCPv4 server does not send the lease lifetime.
1839 Takes one of
<literal>forever
</literal> or
<literal>infinity
</literal> means that the address
1840 never expires. Defaults to unset.
</para>
1845 <term><varname>SendRelease=
</varname></term>
1847 <para>When true, the DHCPv4 client sends a DHCP release packet when it stops.
1848 Defaults to true.
</para>
1853 <term><varname>SendDecline=
</varname></term>
1855 <para>A boolean. When
<literal>true
</literal>, the DHCPv4 client receives the IP address from the
1856 DHCP server. After a new IP is received, the DHCPv4 client performs IPv4 Duplicate Address
1857 Detection. If duplicate use is detected, the DHCPv4 client rejects the IP by sending a
1858 DHCPDECLINE packet and tries to obtain an IP address again. See
<ulink
1859 url=
"https://tools.ietf.org/html/rfc5227">RFC
5224</ulink>. Defaults to
1860 <literal>unset
</literal>.
</para>
1865 <term><varname>DenyList=
</varname></term>
1867 <para>A whitespace-separated list of IPv4 addresses. DHCP offers from servers in the list are rejected. Note that
1868 if
<varname>AllowList=
</varname> is configured then
<varname>DenyList=
</varname> is ignored.
</para>
1873 <term><varname>AllowList=
</varname></term>
1875 <para>A whitespace-separated list of IPv4 addresses. DHCP offers from servers in the list are accepted.
</para>
1880 <term><varname>RequestOptions=
</varname></term>
1882 <para>Sets request options to be sent to the server in the DHCPv4 request options list. A
1883 whitespace-separated list of integers in the range
1.
.254. Defaults to unset.
</para>
1888 <term><varname>SendOption=
</varname></term>
1890 <para>Send an arbitrary raw option in the DHCPv4 request. Takes a DHCP option number, data type
1891 and data separated with a colon
1892 (
<literal><replaceable>option
</replaceable>:
<replaceable>type
</replaceable>:
<replaceable>value
</replaceable></literal>).
1893 The option number must be an integer in the range
1.
.254. The type takes one of
<literal>uint8
</literal>,
1894 <literal>uint16
</literal>,
<literal>uint32
</literal>,
<literal>ipv4address
</literal>, or
1895 <literal>string
</literal>. Special characters in the data string may be escaped using
1896 <ulink url=
"https://en.wikipedia.org/wiki/Escape_sequences_in_C#Table_of_escape_sequences">C-style
1897 escapes
</ulink>. This setting can be specified multiple times. If an empty string is specified,
1898 then all options specified earlier are cleared. Defaults to unset.
</para>
1903 <term><varname>SendVendorOption=
</varname></term>
1905 <para>Send an arbitrary vendor option in the DHCPv4 request. Takes a DHCP option number, data type
1906 and data separated with a colon
1907 (
<literal><replaceable>option
</replaceable>:
<replaceable>type
</replaceable>:
<replaceable>value
</replaceable></literal>).
1908 The option number must be an integer in the range
1.
.254. The type takes one of
<literal>uint8
</literal>,
1909 <literal>uint16
</literal>,
<literal>uint32
</literal>,
<literal>ipv4address
</literal>, or
1910 <literal>string
</literal>. Special characters in the data string may be escaped using
1911 <ulink url=
"https://en.wikipedia.org/wiki/Escape_sequences_in_C#Table_of_escape_sequences">C-style
1912 escapes
</ulink>. This setting can be specified multiple times. If an empty string is specified,
1913 then all options specified earlier are cleared. Defaults to unset.
</para>
1920 <title>[DHCPv6] Section Options
</title>
1921 <para>The [DHCPv6] section configures the DHCPv6 client, if it is enabled with the
1922 <varname>DHCP=
</varname> setting described above, or invoked by the IPv6 Router Advertisement:
</para>
1924 <variablelist class='network-directives'
>
1926 <term><varname>UseAddress=
</varname></term>
1928 <para>When true (the default), the IP addresses provided by the DHCPv6 server will be
1934 <term><varname>UseDNS=
</varname></term>
1935 <term><varname>UseNTP=
</varname></term>
1937 <para>As in the [DHCPv4] section.
</para>
1942 <term><varname>RouteMetric=
</varname></term>
1944 <para>Set the routing metric for routes specified by the DHCP server. Defaults to
1024.
</para>
1949 <term><varname>RapidCommit=
</varname></term>
1951 <para>Takes a boolean. The DHCPv6 client can obtain configuration parameters from a DHCPv6 server through
1952 a rapid two-message exchange (solicit and reply). When the rapid commit option is enabled by both
1953 the DHCPv6 client and the DHCPv6 server, the two-message exchange is used, rather than the default
1954 four-message exchange (solicit, advertise, request, and reply). The two-message exchange provides
1955 faster client configuration and is beneficial in environments in which networks are under a heavy load.
1956 See
<ulink url=
"https://tools.ietf.org/html/rfc3315#section-17.2.1">RFC
3315</ulink> for details.
1957 Defaults to true.
</para>
1962 <term><varname>MUDURL=
</varname></term>
1964 <para>When configured, the specified Manufacturer Usage Description (MUD) URL will be sent to
1965 the DHCPv6 server. The syntax and semantics are the same as for
<varname>MUDURL=
</varname> in the
1966 [DHCPv4] section described above.
</para>
1971 <term><varname>RequestOptions=
</varname></term>
1973 <para>When configured, allows to set arbitrary request options in the DHCPv6 request options list
1974 that will be sent to the DHCPv6 server. A whitespace-separated list of integers in the range
1975 1.
.254. Defaults to unset.
</para>
1980 <term><varname>SendVendorOption=
</varname></term>
1982 <para>Send an arbitrary vendor option in the DHCPv6 request. Takes an enterprise identifier, DHCP
1983 option number, data type, and data separated with a colon (
<literal><replaceable>enterprise
1984 identifier
</replaceable>:
<replaceable>option
</replaceable>:
<replaceable>type
</replaceable>:
1985 <replaceable>value
</replaceable></literal>). Enterprise identifier is an unsigned integer in the
1986 range
1–
4294967294. The option number must be an integer in the range
1–
254. Data type takes one
1987 of
<literal>uint8
</literal>,
<literal>uint16
</literal>,
<literal>uint32
</literal>,
1988 <literal>ipv4address
</literal>,
<literal>ipv6address
</literal>, or
1989 <literal>string
</literal>. Special characters in the data string may be escaped using
<ulink
1990 url=
"https://en.wikipedia.org/wiki/Escape_sequences_in_C#Table_of_escape_sequences">C-style
1991 escapes
</ulink>. This setting can be specified multiple times. If an empty string is specified,
1992 then all options specified earlier are cleared. Defaults to unset.
</para>
1997 <term><varname>ForceDHCPv6PDOtherInformation=
</varname></term>
1999 <para>Takes a boolean that enforces DHCPv6 stateful mode when the 'Other information' bit is set in
2000 Router Advertisement messages. By default setting only the 'O' bit in Router Advertisements
2001 makes DHCPv6 request network information in a stateless manner using a two-message Information
2002 Request and Information Reply message exchange.
2003 <ulink url=
"https://tools.ietf.org/html/rfc7084">RFC
7084</ulink>, requirement WPD-
4, updates
2004 this behavior for a Customer Edge router so that stateful DHCPv6 Prefix Delegation is also
2005 requested when only the 'O' bit is set in Router Advertisements. This option enables such a CE
2006 behavior as it is impossible to automatically distinguish the intention of the 'O' bit otherwise.
2007 By default this option is set to 'false', enable it if no prefixes are delegated when the device
2008 should be acting as a CE router.
</para>
2013 <term><varname>PrefixDelegationHint=
</varname></term>
2015 <para>Takes an IPv6 address with prefix length in the same format as the
2016 <varname>Address=
</varname> in the [Network] section. The DHCPv6 client will include a prefix
2017 hint in the DHCPv6 solicitation sent to the server. The prefix length must be in the range
2018 1–
128. Defaults to unset.
</para>
2023 <term><varname>WithoutRA=
</varname></term>
2025 <para>Allows DHCPv6 client to start without router advertisements's managed or other address
2026 configuration flag. Takes one of
<literal>solicit
</literal> or
2027 <literal>information-request
</literal>. Defaults to unset.
</para>
2032 <term><varname>SendOption=
</varname></term>
2034 <para>As in the [DHCPv4] section, however because DHCPv6 uses
16-bit fields to store
2035 option numbers, the option number is an integer in the range
1.
.65536.
</para>
2040 <term><varname>UserClass=
</varname></term>
2042 <para>A DHCPv6 client can use User Class option to identify the type or category of user or applications
2043 it represents. The information contained in this option is a string that represents the user class of which
2044 the client is a member. Each class sets an identifying string of information to be used by the DHCP
2045 service to classify clients. Special characters in the data string may be escaped using
2046 <ulink url=
"https://en.wikipedia.org/wiki/Escape_sequences_in_C#Table_of_escape_sequences">C-style
2047 escapes
</ulink>. This setting can be specified multiple times. If an empty string is specified,
2048 then all options specified earlier are cleared. Takes a whitespace-separated list of strings. Note that
2049 currently
<constant>NUL
</constant> bytes are not allowed.
</para>
2054 <term><varname>VendorClass=
</varname></term>
2056 <para>A DHCPv6 client can use VendorClass option to identify the vendor that
2057 manufactured the hardware on which the client is running. The information
2058 contained in the data area of this option is contained in one or more opaque
2059 fields that identify details of the hardware configuration. Takes a
2060 whitespace-separated list of strings.
</para>
2067 <title>[DHCPv6PrefixDelegation] Section Options
</title>
2068 <para>The [DHCPv6PrefixDelegation] section configures delegated prefixes assigned by DHCPv6 server.
2069 The settings in this section are used only when
<varname>DHCPv6PrefixDelegation=
</varname> setting
2072 <variablelist class='network-directives'
>
2074 <term><varname>SubnetId=
</varname></term>
2076 <para>Configure a specific subnet ID on the interface from a (previously) received prefix
2077 delegation. You can either set
"auto" (the default) or a specific subnet ID (as defined in
2078 <ulink url=
"https://tools.ietf.org/html/rfc4291#section-2.5.4">RFC
4291</ulink>, section
2079 2.5.4), in which case the allowed value is hexadecimal, from
0 to
0x7fffffffffffffff
2085 <term><varname>Announce=
</varname></term>
2087 <para>Takes a boolean. When enabled, and
<varname>IPv6SendRA=
</varname> in [Network] section
2088 is enabled, the delegated prefixes are distributed through the IPv6 Router Advertisement.
2089 Defaults to yes.
</para>
2094 <term><varname>Assign=
</varname></term>
2096 <para>Takes a boolean. Specifies whether to add an address from the delegated prefixes which
2097 are received from the WAN interface by the DHCPv6 Prefix Delegation. When true (on LAN
2098 interfce), the EUI-
64 algorithm will be used by default to form an interface identifier from
2099 the delegated prefixes. See also
<varname>Token=
</varname> setting below. Defaults to yes.
2105 <term><varname>Token=
</varname></term>
2107 <para>Specifies an optional address generation mode for assigning an address in each
2108 delegated prefix. Takes an IPv6 address. When set, the lower bits of the supplied address is
2109 combined with the upper bits of each delegatad prefix received from the WAN interface by the
2110 DHCPv6 Prefix Delegation to form a complete address. When
<varname>Assign=
</varname> is
2111 disabled, this setting is ignored. When unset, the EUI-
64 algorithm will be used to form
2112 addresses. Defaults to unset.
</para>
2117 <term><varname>ManageTemporaryAddress=
</varname></term>
2119 <para>As in the [Address] section, but defaults to true.
</para>
2126 <title>[IPv6AcceptRA] Section Options
</title>
2127 <para>The [IPv6AcceptRA] section configures the IPv6 Router Advertisement (RA) client, if it is enabled
2128 with the
<varname>IPv6AcceptRA=
</varname> setting described above:
</para>
2130 <variablelist class='network-directives'
>
2132 <term><varname>UseDNS=
</varname></term>
2134 <para>When true (the default), the DNS servers received in the Router Advertisement will be used and take
2135 precedence over any statically configured ones.
</para>
2137 <para>This corresponds to the
<option>nameserver
</option> option in
<citerefentry
2138 project='man-pages'
><refentrytitle>resolv.conf
</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
</para>
2143 <term><varname>UseDomains=
</varname></term>
2145 <para>Takes a boolean, or the special value
<literal>route
</literal>. When true, the domain name
2146 received via IPv6 Router Advertisement (RA) will be used as DNS search domain over this link, similar to
2147 the effect of the
<option>Domains=
</option> setting. If set to
<literal>route
</literal>, the domain name
2148 received via IPv6 RA will be used for routing DNS queries only, but not for searching, similar to the
2149 effect of the
<option>Domains=
</option> setting when the argument is prefixed with
2150 <literal>~
</literal>. Defaults to false.
</para>
2152 <para>It is recommended to enable this option only on trusted networks, as setting this affects resolution
2153 of all hostnames, in particular of single-label names. It is generally safer to use the supplied domain
2154 only as routing domain, rather than as search domain, in order to not have it affect local resolution of
2155 single-label names.
</para>
2157 <para>When set to true, this setting corresponds to the
<option>domain
</option> option in
<citerefentry
2158 project='man-pages'
><refentrytitle>resolv.conf
</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
</para>
2163 <term><varname>RouteTable=
<replaceable>num
</replaceable></varname></term>
2165 <para>The table identifier for the routes received in the Router Advertisement
2166 (a number between
1 and
4294967295, or
0 to unset).
2167 The table can be retrieved using
<command>ip route show table
<replaceable>num
</replaceable></command>.
2173 <term><varname>UseAutonomousPrefix=
</varname></term>
2175 <para>When true (the default), the autonomous prefix received in the Router Advertisement will be used and take
2176 precedence over any statically configured ones.
</para>
2181 <term><varname>UseOnLinkPrefix=
</varname></term>
2183 <para>When true (the default), the onlink prefix received in the Router Advertisement will be
2184 used and takes precedence over any statically configured ones.
</para>
2189 <term><varname>RouterDenyList=
</varname></term>
2191 <para>A whitespace-separated list of IPv6 router addresses. Any information advertised by
2192 the listed router is ignored.
</para>
2197 <term><varname>RouterAllowList=
</varname></term>
2199 <para>A whitespace-separated list of IPv6 router addresses. Only information advertised by
2200 the listed router is accepted. Note that if
<varname>RouterAllowList=
</varname> is
2201 configured then
<varname>RouterDenyList=
</varname> is ignored.
</para>
2206 <term><varname>PrefixDenyList=
</varname></term>
2208 <para>A whitespace-separated list of IPv6 prefixes. IPv6 prefixes supplied via router
2209 advertisements in the list are ignored.
</para>
2214 <term><varname>PrefixAllowList=
</varname></term>
2216 <para>A whitespace-separated list of IPv6 prefixes. IPv6 prefixes supplied via router
2217 advertisements in the list are allowed. Note that if
<varname>PrefixAllowList=
</varname> is
2218 configured then
<varname>PrefixDenyList=
</varname> is ignored.
</para>
2223 <term><varname>RouteDenyList=
</varname></term>
2225 <para>A whitespace-separated list of IPv6 route prefixes. IPv6 route prefixes supplied via
2226 router advertisements in the list are ignored.
</para>
2231 <term><varname>RouteAllowList=
</varname></term>
2233 <para>A whitespace-separated list of IPv6 route prefixes. IPv6 route prefixes supplied via
2234 router advertisements in the list are allowed. Note that if
<varname>RouteAllowList=
</varname> is
2235 configured then
<varname>RouteDenyList=
</varname> is ignored.
</para>
2240 <term><varname>DHCPv6Client=
</varname></term>
2242 <para>Takes a boolean, or the special value
<literal>always
</literal>. When true or
2243 <literal>always
</literal>, the DHCPv6 client will be started when the RA has the managed or
2244 other information flag. If set to
<literal>always
</literal>, the DHCPv6 client will also be
2245 started in managed mode when neither managed nor other information flag is set in the RA.
2246 Defaults to true.
</para>
2253 <title>[DHCPServer] Section Options
</title>
2254 <para>The [DHCPServer] section contains settings for the DHCP server, if enabled via the
2255 <varname>DHCPServer=
</varname> option described above:
</para>
2257 <variablelist class='network-directives'
>
2260 <term><varname>PoolOffset=
</varname></term>
2261 <term><varname>PoolSize=
</varname></term>
2263 <listitem><para>Configures the pool of addresses to hand out. The pool
2264 is a contiguous sequence of IP addresses in the subnet configured for
2265 the server address, which does not include the subnet nor the broadcast
2266 address.
<varname>PoolOffset=
</varname> takes the offset of the pool
2267 from the start of subnet, or zero to use the default value.
2268 <varname>PoolSize=
</varname> takes the number of IP addresses in the
2269 pool or zero to use the default value. By default, the pool starts at
2270 the first address after the subnet address and takes up the rest of
2271 the subnet, excluding the broadcast address. If the pool includes
2272 the server address (the default), this is reserved and not handed
2273 out to clients.
</para></listitem>
2277 <term><varname>DefaultLeaseTimeSec=
</varname></term>
2278 <term><varname>MaxLeaseTimeSec=
</varname></term>
2280 <listitem><para>Control the default and maximum DHCP lease
2281 time to pass to clients. These settings take time values in seconds or
2282 another common time unit, depending on the suffix. The default
2283 lease time is used for clients that did not ask for a specific
2284 lease time. If a client asks for a lease time longer than the
2285 maximum lease time, it is automatically shortened to the
2286 specified time. The default lease time defaults to
1h, the
2287 maximum lease time to
12h. Shorter lease times are beneficial
2288 if the configuration data in DHCP leases changes frequently
2289 and clients shall learn the new settings with shorter
2290 latencies. Longer lease times reduce the generated DHCP
2291 network traffic.
</para></listitem>
2295 <term><varname>EmitDNS=
</varname></term>
2296 <term><varname>DNS=
</varname></term>
2298 <listitem><para><varname>EmitDNS=
</varname> takes a boolean. Configures whether the DHCP leases
2299 handed out to clients shall contain DNS server information. Defaults to
<literal>yes
</literal>. The
2300 DNS servers to pass to clients may be configured with the
<varname>DNS=
</varname> option, which takes
2301 a list of IPv4 addresses. If the
<varname>EmitDNS=
</varname> option is enabled but no servers
2302 configured, the servers are automatically propagated from an
"uplink" interface that has appropriate
2303 servers set. The
"uplink" interface is determined by the default route of the system with the highest
2304 priority. Note that this information is acquired at the time the lease is handed out, and does not
2305 take uplink interfaces into account that acquire DNS server information at a later point. If no
2306 suitable uplink interface is found the DNS server data from
<filename>/etc/resolv.conf
</filename> is
2307 used. Also, note that the leases are not refreshed if the uplink network configuration changes. To
2308 ensure clients regularly acquire the most current uplink DNS server information, it is thus advisable
2309 to shorten the DHCP lease time via
<varname>MaxLeaseTimeSec=
</varname> described
2310 above.
</para></listitem>
2314 <term><varname>EmitNTP=
</varname></term>
2315 <term><varname>NTP=
</varname></term>
2316 <term><varname>EmitSIP=
</varname></term>
2317 <term><varname>SIP=
</varname></term>
2318 <term><varname>EmitPOP3=
</varname></term>
2319 <term><varname>POP3=
</varname></term>
2320 <term><varname>EmitSMTP=
</varname></term>
2321 <term><varname>SMTP=
</varname></term>
2322 <term><varname>EmitLPR=
</varname></term>
2323 <term><varname>LPR=
</varname></term>
2325 <listitem><para>Similar to the
<varname>EmitDNS=
</varname> and
<varname>DNS=
</varname> settings
2326 described above, these settings configure whether and what server information for the indicate
2327 protocol shall be emitted as part of the DHCP lease. The same syntax, propagation semantics and
2328 defaults apply as for
<varname>EmitDNS=
</varname> and
<varname>DNS=
</varname>.
</para></listitem>
2332 <term><varname>EmitRouter=
</varname></term>
2334 <listitem><para>Similar to the
<varname>EmitDNS=
</varname>
2335 setting described above, this setting configures whether the
2336 DHCP lease should contain the router option. The same syntax,
2337 propagation semantics and defaults apply as for
2338 <varname>EmitDNS=
</varname>.
</para></listitem>
2342 <term><varname>EmitTimezone=
</varname></term>
2343 <term><varname>Timezone=
</varname></term>
2345 <listitem><para>Takes a boolean. Configures whether the DHCP leases handed out
2346 to clients shall contain timezone information. Defaults to
<literal>yes
</literal>. The
2347 <varname>Timezone=
</varname> setting takes a timezone string
2348 (such as
<literal>Europe/Berlin
</literal> or
2349 <literal>UTC
</literal>) to pass to clients. If no explicit
2350 timezone is set, the system timezone of the local host is
2351 propagated, as determined by the
2352 <filename>/etc/localtime
</filename> symlink.
</para></listitem>
2356 <term><varname>SendOption=
</varname></term>
2358 <para>Send a raw option with value via DHCPv4 server. Takes a DHCP option number, data type
2359 and data (
<literal><replaceable>option
</replaceable>:
<replaceable>type
</replaceable>:
<replaceable>value
</replaceable></literal>).
2360 The option number is an integer in the range
1.
.254. The type takes one of
<literal>uint8
</literal>,
2361 <literal>uint16
</literal>,
<literal>uint32
</literal>,
<literal>ipv4address
</literal>,
<literal>ipv6address
</literal>, or
2362 <literal>string
</literal>. Special characters in the data string may be escaped using
2363 <ulink url=
"https://en.wikipedia.org/wiki/Escape_sequences_in_C#Table_of_escape_sequences">C-style
2364 escapes
</ulink>. This setting can be specified multiple times. If an empty string is specified,
2365 then all options specified earlier are cleared. Defaults to unset.
</para>
2370 <term><varname>SendVendorOption=
</varname></term>
2372 <para>Send a vendor option with value via DHCPv4 server. Takes a DHCP option number, data type
2373 and data (
<literal><replaceable>option
</replaceable>:
<replaceable>type
</replaceable>:
<replaceable>value
</replaceable></literal>).
2374 The option number is an integer in the range
1.
.254. The type takes one of
<literal>uint8
</literal>,
2375 <literal>uint16
</literal>,
<literal>uint32
</literal>,
<literal>ipv4address
</literal>, or
2376 <literal>string
</literal>. Special characters in the data string may be escaped using
2377 <ulink url=
"https://en.wikipedia.org/wiki/Escape_sequences_in_C#Table_of_escape_sequences">C-style
2378 escapes
</ulink>. This setting can be specified multiple times. If an empty string is specified,
2379 then all options specified earlier are cleared. Defaults to unset.
</para>
2387 <title>[IPv6SendRA] Section Options
</title>
2388 <para>The [IPv6SendRA] section contains settings for sending IPv6 Router Advertisements and whether
2389 to act as a router, if enabled via the
<varname>IPv6SendRA=
</varname> option described above. IPv6
2390 network prefixes or routes are defined with one or more [IPv6Prefix] or [IPv6RoutePrefix] sections.
2393 <variablelist class='network-directives'
>
2396 <term><varname>Managed=
</varname></term>
2397 <term><varname>OtherInformation=
</varname></term>
2399 <listitem><para>Takes a boolean. Controls whether a DHCPv6 server is used to acquire IPv6
2400 addresses on the network link when
<varname>Managed=
</varname>
2401 is set to
<literal>true
</literal> or if only additional network
2402 information can be obtained via DHCPv6 for the network link when
2403 <varname>OtherInformation=
</varname> is set to
2404 <literal>true
</literal>. Both settings default to
2405 <literal>false
</literal>, which means that a DHCPv6 server is not being
2406 used.
</para></listitem>
2410 <term><varname>RouterLifetimeSec=
</varname></term>
2412 <listitem><para>Takes a timespan. Configures the IPv6 router lifetime in seconds. When set to
2413 0, the host is not acting as a router. Defaults to
30 minutes.
</para>
2418 <term><varname>RouterPreference=
</varname></term>
2420 <listitem><para>Configures IPv6 router preference if
2421 <varname>RouterLifetimeSec=
</varname> is non-zero. Valid values are
2422 <literal>high
</literal>,
<literal>medium
</literal> and
2423 <literal>low
</literal>, with
<literal>normal
</literal> and
2424 <literal>default
</literal> added as synonyms for
2425 <literal>medium
</literal> just to make configuration easier. See
2426 <ulink url=
"https://tools.ietf.org/html/rfc4191">RFC
4191</ulink>
2427 for details. Defaults to
<literal>medium
</literal>.
</para></listitem>
2431 <term><varname>EmitDNS=
</varname></term>
2432 <term><varname>DNS=
</varname></term>
2434 <listitem><para><varname>DNS=
</varname> specifies a list of recursive DNS server IPv6 addresses that
2435 are distributed via Router Advertisement messages when
<varname>EmitDNS=
</varname> is
2436 true.
<varname>DNS=
</varname> also takes special value
<literal>_link_local
</literal>; in that case
2437 the IPv6 link local address is distributed. If
<varname>DNS=
</varname> is empty, DNS servers are read
2438 from the [Network] section. If the [Network] section does not contain any DNS servers either, DNS
2439 servers from the uplink with the highest priority default route are used. When
2440 <varname>EmitDNS=
</varname> is false, no DNS server information is sent in Router Advertisement
2441 messages.
<varname>EmitDNS=
</varname> defaults to true.
</para></listitem>
2445 <term><varname>EmitDomains=
</varname></term>
2446 <term><varname>Domains=
</varname></term>
2448 <listitem><para>A list of DNS search domains distributed via Router Advertisement messages when
2449 <varname>EmitDomains=
</varname> is true. If
<varname>Domains=
</varname> is empty, DNS search domains
2450 are read from the [Network] section. If the [Network] section does not contain any DNS search domains
2451 either, DNS search domains from the uplink with the highest priority default route are used. When
2452 <varname>EmitDomains=
</varname> is false, no DNS search domain information is sent in Router
2453 Advertisement messages.
<varname>EmitDomains=
</varname> defaults to true.
</para></listitem>
2457 <term><varname>DNSLifetimeSec=
</varname></term>
2459 <listitem><para>Lifetime in seconds for the DNS server addresses listed
2460 in
<varname>DNS=
</varname> and search domains listed in
2461 <varname>Domains=
</varname>.
</para></listitem>
2468 <title>[IPv6Prefix] Section Options
</title>
2469 <para>One or more [IPv6Prefix] sections contain the IPv6 prefixes that are announced via Router
2470 Advertisements. See
<ulink url=
"https://tools.ietf.org/html/rfc4861">RFC
4861</ulink> for further
2473 <variablelist class='network-directives'
>
2476 <term><varname>AddressAutoconfiguration=
</varname></term>
2477 <term><varname>OnLink=
</varname></term>
2479 <listitem><para>Takes a boolean to specify whether IPv6 addresses can be
2480 autoconfigured with this prefix and whether the prefix can be used for
2481 onlink determination. Both settings default to
<literal>true
</literal>
2482 in order to ease configuration.
2487 <term><varname>Prefix=
</varname></term>
2489 <listitem><para>The IPv6 prefix that is to be distributed to hosts. Similarly to configuring static
2490 IPv6 addresses, the setting is configured as an IPv6 prefix and its prefix length, separated by a
2491 <literal>/
</literal> character. Use multiple [IPv6Prefix] sections to configure multiple IPv6
2492 prefixes since prefix lifetimes, address autoconfiguration and onlink status may differ from one
2493 prefix to another.
</para></listitem>
2497 <term><varname>PreferredLifetimeSec=
</varname></term>
2498 <term><varname>ValidLifetimeSec=
</varname></term>
2500 <listitem><para>Preferred and valid lifetimes for the prefix measured in
2501 seconds.
<varname>PreferredLifetimeSec=
</varname> defaults to
604800
2502 seconds (one week) and
<varname>ValidLifetimeSec=
</varname> defaults
2503 to
2592000 seconds (
30 days).
</para></listitem>
2507 <term><varname>Assign=
</varname></term>
2508 <listitem><para>Takes a boolean. When true, adds an address from the prefix. Default to false.
2515 <title>[IPv6RoutePrefix] Section Options
</title>
2516 <para>One or more [IPv6RoutePrefix] sections contain the IPv6
2517 prefix routes that are announced via Router Advertisements. See
2518 <ulink url=
"https://tools.ietf.org/html/rfc4191">RFC
4191</ulink>
2519 for further details.
</para>
2521 <variablelist class='network-directives'
>
2524 <term><varname>Route=
</varname></term>
2526 <listitem><para>The IPv6 route that is to be distributed to hosts. Similarly to configuring static
2527 IPv6 routes, the setting is configured as an IPv6 prefix routes and its prefix route length,
2528 separated by a
<literal>/
</literal> character. Use multiple [IPv6PrefixRoutes] sections to configure
2529 multiple IPv6 prefix routes.
</para></listitem>
2533 <term><varname>LifetimeSec=
</varname></term>
2535 <listitem><para>Lifetime for the route prefix measured in
2536 seconds.
<varname>LifetimeSec=
</varname> defaults to
604800 seconds (one week).
2544 <title>[Bridge] Section Options
</title>
2545 <para>The [Bridge] section accepts the following keys:
</para>
2546 <variablelist class='network-directives'
>
2548 <term><varname>UnicastFlood=
</varname></term>
2550 <para>Takes a boolean. Controls whether the bridge should flood
2551 traffic for which an FDB entry is missing and the destination
2552 is unknown through this port. When unset, the kernel's default will be used.
2557 <term><varname>MulticastFlood=
</varname></term>
2559 <para>Takes a boolean. Controls whether the bridge should flood
2560 traffic for which an MDB entry is missing and the destination
2561 is unknown through this port. When unset, the kernel's default will be used.
2566 <term><varname>MulticastToUnicast=
</varname></term>
2568 <para>Takes a boolean. Multicast to unicast works on top of the multicast snooping feature of
2569 the bridge. Which means unicast copies are only delivered to hosts which are interested in it.
2570 When unset, the kernel's default will be used.
2575 <term><varname>NeighborSuppression=
</varname></term>
2577 <para>Takes a boolean. Configures whether ARP and ND neighbor suppression is enabled for
2578 this port. When unset, the kernel's default will be used.
2583 <term><varname>Learning=
</varname></term>
2585 <para>Takes a boolean. Configures whether MAC address learning is enabled for
2586 this port. When unset, the kernel's default will be used.
2591 <term><varname>HairPin=
</varname></term>
2593 <para>Takes a boolean. Configures whether traffic may be sent back out of the port on which it
2594 was received. When this flag is false, then the bridge will not forward traffic back out of the
2595 receiving port. When unset, the kernel's default will be used.
</para>
2599 <term><varname>UseBPDU=
</varname></term>
2601 <para>Takes a boolean. Configures whether STP Bridge Protocol Data Units will be
2602 processed by the bridge port. When unset, the kernel's default will be used.
</para>
2606 <term><varname>FastLeave=
</varname></term>
2608 <para>Takes a boolean. This flag allows the bridge to immediately stop multicast
2609 traffic on a port that receives an IGMP Leave message. It is only used with
2610 IGMP snooping if enabled on the bridge. When unset, the kernel's default will be used.
</para>
2614 <term><varname>AllowPortToBeRoot=
</varname></term>
2616 <para>Takes a boolean. Configures whether a given port is allowed to
2617 become a root port. Only used when STP is enabled on the bridge.
2618 When unset, the kernel's default will be used.
</para>
2622 <term><varname>ProxyARP=
</varname></term>
2624 <para>Takes a boolean. Configures whether proxy ARP to be enabled on this port.
2625 When unset, the kernel's default will be used.
</para>
2629 <term><varname>ProxyARPWiFi=
</varname></term>
2631 <para>Takes a boolean. Configures whether proxy ARP to be enabled on this port
2632 which meets extended requirements by IEEE
802.11 and Hotspot
2.0 specifications.
2633 When unset, the kernel's default will be used.
</para>
2637 <term><varname>MulticastRouter=
</varname></term>
2639 <para>Configures this port for having multicast routers attached. A port with a multicast
2640 router will receive all multicast traffic. Takes one of
<literal>no
</literal>
2641 to disable multicast routers on this port,
<literal>query
</literal> to let the system detect
2642 the presence of routers,
<literal>permanent
</literal> to permanently enable multicast traffic
2643 forwarding on this port, or
<literal>temporary
</literal> to enable multicast routers temporarily
2644 on this port, not depending on incoming queries. When unset, the kernel's default will be used.
</para>
2648 <term><varname>Cost=
</varname></term>
2650 <para>Sets the
"cost" of sending packets of this interface.
2651 Each port in a bridge may have a different speed and the cost
2652 is used to decide which link to use. Faster interfaces
2653 should have lower costs. It is an integer value between
1 and
2658 <term><varname>Priority=
</varname></term>
2660 <para>Sets the
"priority" of sending packets on this interface.
2661 Each port in a bridge may have a different priority which is used
2662 to decide which link to use. Lower value means higher priority.
2663 It is an integer value between
0 to
63. Networkd does not set any
2664 default, meaning the kernel default value of
32 is used.
</para>
2670 <title>[BridgeFDB] Section Options
</title>
2671 <para>The [BridgeFDB] section manages the forwarding database table of a port and accepts the following
2672 keys. Specify several [BridgeFDB] sections to configure several static MAC table entries.
</para>
2674 <variablelist class='network-directives'
>
2676 <term><varname>MACAddress=
</varname></term>
2678 <para>As in the [Network] section. This key is mandatory.
</para>
2682 <term><varname>Destination=
</varname></term>
2684 <para>Takes an IP address of the destination VXLAN tunnel endpoint.
</para>
2688 <term><varname>VLANId=
</varname></term>
2690 <para>The VLAN ID for the new static MAC table entry. If
2691 omitted, no VLAN ID information is appended to the new static MAC
2696 <term><varname>VNI=
</varname></term>
2698 <para>The VXLAN Network Identifier (or VXLAN Segment ID) to use to connect to
2699 the remote VXLAN tunnel endpoint. Takes a number in the range
1-
16777215.
2700 Defaults to unset.
</para>
2704 <term><varname>AssociatedWith=
</varname></term>
2706 <para>Specifies where the address is associated with. Takes one of
<literal>use
</literal>,
2707 <literal>self
</literal>,
<literal>master
</literal> or
<literal>router
</literal>.
2708 <literal>use
</literal> means the address is in use. User space can use this option to
2709 indicate to the kernel that the fdb entry is in use.
<literal>self
</literal> means
2710 the address is associated with the port drivers fdb. Usually hardware.
<literal>master
</literal>
2711 means the address is associated with master devices fdb.
<literal>router
</literal> means
2712 the destination address is associated with a router. Note that it's valid if the referenced
2713 device is a VXLAN type device and has route shortcircuit enabled. Defaults to
<literal>self
</literal>.
</para>
2719 <title>[BridgeMDB] Section Options
</title>
2720 <para>The [BridgeMDB] section manages the multicast membership entries forwarding database table of a port and accepts the following
2721 keys. Specify several [BridgeMDB] sections to configure several permanent multicast membership entries.
</para>
2723 <variablelist class='network-directives'
>
2725 <term><varname>MulticastGroupAddress=
</varname></term>
2727 <para>Specifies the IPv4 or IPv6 multicast group address to add. This setting is mandatory.
</para>
2731 <term><varname>VLANId=
</varname></term>
2733 <para>The VLAN ID for the new entry. Valid ranges are
0 (no VLAN) to
4094. Optional, defaults to
0.
</para>
2740 <title>[LLDP] Section Options
</title>
2741 <para>The [LLDP] section manages the Link Layer Discovery Protocol (LLDP) and accepts the following
2743 <variablelist class='network-directives'
>
2745 <term><varname>MUDURL=
</varname></term>
2747 <para>When configured, the specified Manufacturer Usage Descriptions (MUD) URL will be sent in
2748 LLDP packets. The syntax and semantics are the same as for
<varname>MUDURL=
</varname> in the
2749 [DHCPv4] section described above.
</para>
2751 <para>The MUD URLs received via LLDP packets are saved and can be read using the
2752 <function>sd_lldp_neighbor_get_mud_url()
</function> function.
</para>
2759 <title>[CAN] Section Options
</title>
2760 <para>The [CAN] section manages the Controller Area Network (CAN bus) and accepts the
2761 following keys:
</para>
2762 <variablelist class='network-directives'
>
2764 <term><varname>BitRate=
</varname></term>
2766 <para>The bitrate of CAN device in bits per second. The usual SI prefixes (K, M) with the base of
1000 can
2767 be used here. Takes a number in the range
1.
.4294967295.
</para>
2771 <term><varname>SamplePoint=
</varname></term>
2773 <para>Optional sample point in percent with one decimal (e.g.
<literal>75%
</literal>,
2774 <literal>87.5%
</literal>) or permille (e.g.
<literal>875‰
</literal>).
</para>
2778 <term><varname>DataBitRate=
</varname></term>
2779 <term><varname>DataSamplePoint=
</varname></term>
2781 <para>The bitrate and sample point for the data phase, if CAN-FD is used. These settings are
2782 analogous to the
<varname>BitRate=
</varname> and
<varname>SamplePoint=
</varname> keys.
</para>
2786 <term><varname>FDMode=
</varname></term>
2788 <para>Takes a boolean. When
<literal>yes
</literal>, CAN-FD mode is enabled for the interface.
2789 Note, that a bitrate and optional sample point should also be set for the CAN-FD data phase using
2790 the
<varname>DataBitRate=
</varname> and
<varname>DataSamplePoint=
</varname> keys.
</para>
2794 <term><varname>FDNonISO=
</varname></term>
2796 <para>Takes a boolean. When
<literal>yes
</literal>, non-ISO CAN-FD mode is enabled for the
2797 interface. When unset, the kernel's default will be used.
</para>
2801 <term><varname>RestartSec=
</varname></term>
2803 <para>Automatic restart delay time. If set to a non-zero value, a restart of the CAN controller will be
2804 triggered automatically in case of a bus-off condition after the specified delay time. Subsecond delays can
2805 be specified using decimals (e.g.
<literal>0.1s
</literal>) or a
<literal>ms
</literal> or
2806 <literal>us
</literal> postfix. Using
<literal>infinity
</literal> or
<literal>0</literal> will turn the
2807 automatic restart off. By default automatic restart is disabled.
</para>
2811 <term><varname>Termination=
</varname></term>
2813 <para>Takes a boolean. When
<literal>yes
</literal>, the termination resistor will be selected for
2814 the bias network. When unset, the kernel's default will be used.
</para>
2818 <term><varname>TripleSampling=
</varname></term>
2820 <para>Takes a boolean. When
<literal>yes
</literal>, three samples (instead of one) are used to determine
2821 the value of a received bit by majority rule. When unset, the kernel's default will be used.
</para>
2825 <term><varname>BusErrorReporting=
</varname></term>
2827 <para>Takes a boolean. When
<literal>yes
</literal>, reporting of CAN bus errors is activated
2828 (those include single bit, frame format, and bit stuffing errors, unable to send dominant bit,
2829 unable to send recessive bit, bus overload, active error announcement, error occurred on
2830 transmission). When unset, the kernel's default will be used. Note: in case of a CAN bus with a
2831 single CAN device, sending a CAN frame may result in a huge number of CAN bus errors.
</para>
2835 <term><varname>ListenOnly=
</varname></term>
2837 <para>Takes a boolean. When
<literal>yes
</literal>, listen-only mode is enabled. When the
2838 interface is in listen-only mode, the interface neither transmit CAN frames nor send ACK
2839 bit. Listen-only mode is important to debug CAN networks without interfering with the
2840 communication or acknowledge the CAN frame. When unset, the kernel's default will be used.
2848 <title>[QDisc] Section Options
</title>
2849 <para>The [QDisc] section manages the traffic control queueing discipline (qdisc).
</para>
2851 <variablelist class='network-directives'
>
2853 <term><varname>Parent=
</varname></term>
2855 <para>Specifies the parent Queueing Discipline (qdisc). Takes one of
<literal>clsact
</literal>
2856 or
<literal>ingress
</literal>. This is mandatory.
</para>
2860 <xi:include href=
"tc.xml" xpointer=
"qdisc-handle" />
2865 <title>[NetworkEmulator] Section Options
</title>
2866 <para>The [NetworkEmulator] section manages the queueing discipline (qdisc) of the network emulator. It
2867 can be used to configure the kernel packet scheduler and simulate packet delay and loss for UDP or TCP
2868 applications, or limit the bandwidth usage of a particular service to simulate internet connections.
2871 <variablelist class='network-directives'
>
2872 <xi:include href=
"tc.xml" xpointer=
"qdisc-parent" />
2873 <xi:include href=
"tc.xml" xpointer=
"qdisc-handle" />
2876 <term><varname>DelaySec=
</varname></term>
2878 <para>Specifies the fixed amount of delay to be added to all packets going out of the
2879 interface. Defaults to unset.
</para>
2884 <term><varname>DelayJitterSec=
</varname></term>
2886 <para>Specifies the chosen delay to be added to the packets outgoing to the network
2887 interface. Defaults to unset.
</para>
2892 <term><varname>PacketLimit=
</varname></term>
2894 <para>Specifies the maximum number of packets the qdisc may hold queued at a time.
2895 An unsigned integer in the range
0–
4294967294. Defaults to
1000.
</para>
2900 <term><varname>LossRate=
</varname></term>
2902 <para>Specifies an independent loss probability to be added to the packets outgoing from the
2903 network interface. Takes a percentage value, suffixed with
"%". Defaults to unset.
</para>
2908 <term><varname>DuplicateRate=
</varname></term>
2910 <para>Specifies that the chosen percent of packets is duplicated before queuing them.
2911 Takes a percentage value, suffixed with
"%". Defaults to unset.
</para>
2918 <title>[TokenBucketFilter] Section Options
</title>
2919 <para>The [TokenBucketFilter] section manages the queueing discipline (qdisc) of token bucket filter
2922 <variablelist class='network-directives'
>
2923 <xi:include href=
"tc.xml" xpointer=
"qdisc-parent" />
2924 <xi:include href=
"tc.xml" xpointer=
"qdisc-handle" />
2927 <term><varname>LatencySec=
</varname></term>
2929 <para>Specifies the latency parameter, which specifies the maximum amount of time a
2930 packet can sit in the Token Bucket Filter (TBF). Defaults to unset.
</para>
2935 <term><varname>LimitBytes=
</varname></term>
2937 <para>Takes the number of bytes that can be queued waiting for tokens to become available.
2938 When the size is suffixed with K, M, or G, it is parsed as Kilobytes, Megabytes, or Gigabytes,
2939 respectively, to the base of
1024. Defaults to unset.
</para>
2944 <term><varname>BurstBytes=
</varname></term>
2946 <para>Specifies the size of the bucket. This is the maximum amount of bytes that tokens
2947 can be available for instantaneous transfer. When the size is suffixed with K, M, or G, it is
2948 parsed as Kilobytes, Megabytes, or Gigabytes, respectively, to the base of
1024. Defaults to
2954 <term><varname>Rate=
</varname></term>
2956 <para>Specifies the device specific bandwidth. When suffixed with K, M, or G, the specified
2957 bandwidth is parsed as Kilobits, Megabits, or Gigabits, respectively, to the base of
1000.
2958 Defaults to unset.
</para>
2963 <term><varname>MPUBytes=
</varname></term>
2965 <para>The Minimum Packet Unit (MPU) determines the minimal token usage (specified in bytes)
2966 for a packet. When suffixed with K, M, or G, the specified size is parsed as Kilobytes,
2967 Megabytes, or Gigabytes, respectively, to the base of
1024. Defaults to zero.
</para>
2972 <term><varname>PeakRate=
</varname></term>
2974 <para>Takes the maximum depletion rate of the bucket. When suffixed with K, M, or G, the
2975 specified size is parsed as Kilobits, Megabits, or Gigabits, respectively, to the base of
2976 1000. Defaults to unset.
</para>
2981 <term><varname>MTUBytes=
</varname></term>
2983 <para>Specifies the size of the peakrate bucket. When suffixed with K, M, or G, the specified
2984 size is parsed as Kilobytes, Megabytes, or Gigabytes, respectively, to the base of
1024.
2985 Defaults to unset.
</para>
2992 <title>[PIE] Section Options
</title>
2993 <para>The [PIE] section manages the queueing discipline (qdisc) of Proportional Integral
2994 controller-Enhanced (PIE).
</para>
2996 <variablelist class='network-directives'
>
2997 <xi:include href=
"tc.xml" xpointer=
"qdisc-parent" />
2998 <xi:include href=
"tc.xml" xpointer=
"qdisc-handle" />
3001 <term><varname>PacketLimit=
</varname></term>
3003 <para>Specifies the hard limit on the queue size in number of packets. When this limit is reached, incoming packets are
3004 dropped. An unsigned integer in the range
1–
4294967294. Defaults to unset and kernel's default is used.
</para>
3011 <title>[FlowQueuePIE] Section Options
</title>
3012 <para>The
<literal>[FlowQueuePIE]
</literal> section manages the queueing discipline
3013 (qdisc) of Flow Queue Proportional Integral controller-Enhanced (fq_pie).
</para>
3015 <variablelist class='network-directives'
>
3016 <xi:include href=
"tc.xml" xpointer=
"qdisc-parent" />
3017 <xi:include href=
"tc.xml" xpointer=
"qdisc-handle" />
3020 <term><varname>PacketLimit=
</varname></term>
3022 <para>Specifies the hard limit on the queue size in number of packets. When this limit is reached,
3023 incoming packets are dropped. An unsigned integer ranges
1 to
4294967294. Defaults to unset and
3024 kernel's default is used.
</para>
3031 <title>[StochasticFairBlue] Section Options
</title>
3032 <para>The [StochasticFairBlue] section manages the queueing discipline (qdisc) of stochastic fair blue
3035 <variablelist class='network-directives'
>
3036 <xi:include href=
"tc.xml" xpointer=
"qdisc-parent" />
3037 <xi:include href=
"tc.xml" xpointer=
"qdisc-handle" />
3040 <term><varname>PacketLimit=
</varname></term>
3042 <para>Specifies the hard limit on the queue size in number of packets. When this limit is reached,
3043 incoming packets are dropped. An unsigned integer in the range
0–
4294967294. Defaults to unset and
3044 kernel's default is used.
</para>
3051 <title>[StochasticFairnessQueueing] Section Options
</title>
3052 <para>The [StochasticFairnessQueueing] section manages the queueing discipline (qdisc) of stochastic
3053 fairness queueing (sfq).
</para>
3055 <variablelist class='network-directives'
>
3056 <xi:include href=
"tc.xml" xpointer=
"qdisc-parent" />
3057 <xi:include href=
"tc.xml" xpointer=
"qdisc-handle" />
3060 <term><varname>PerturbPeriodSec=
</varname></term>
3062 <para>Specifies the interval in seconds for queue algorithm perturbation. Defaults to unset.
</para>
3069 <title>[BFIFO] Section Options
</title>
3070 <para>The [BFIFO] section manages the queueing discipline (qdisc) of Byte limited Packet First In First
3073 <variablelist class='network-directives'
>
3074 <xi:include href=
"tc.xml" xpointer=
"qdisc-parent" />
3075 <xi:include href=
"tc.xml" xpointer=
"qdisc-handle" />
3078 <term><varname>LimitBytes=
</varname></term>
3080 <para>Specifies the hard limit in bytes on the FIFO buffer size. The size limit prevents overflow
3081 in case the kernel is unable to dequeue packets as quickly as it receives them. When this limit is
3082 reached, incoming packets are dropped. When suffixed with K, M, or G, the specified size is parsed
3083 as Kilobytes, Megabytes, or Gigabytes, respectively, to the base of
1024. Defaults to unset and
3084 kernel default is used.
</para>
3091 <title>[PFIFO] Section Options
</title>
3092 <para>The [PFIFO] section manages the queueing discipline (qdisc) of Packet First In First Out
3095 <variablelist class='network-directives'
>
3096 <xi:include href=
"tc.xml" xpointer=
"qdisc-parent" />
3097 <xi:include href=
"tc.xml" xpointer=
"qdisc-handle" />
3100 <term><varname>PacketLimit=
</varname></term>
3102 <para>Specifies the hard limit on the number of packets in the FIFO queue. The size limit prevents
3103 overflow in case the kernel is unable to dequeue packets as quickly as it receives them. When this
3104 limit is reached, incoming packets are dropped. An unsigned integer in the range
3105 0–
4294967294. Defaults to unset and kernel's default is used.
</para>
3112 <title>[PFIFOHeadDrop] Section Options
</title>
3113 <para>The [PFIFOHeadDrop] section manages the queueing discipline (qdisc) of Packet First In First Out
3114 Head Drop (pfifo_head_drop).
</para>
3116 <variablelist class='network-directives'
>
3117 <xi:include href=
"tc.xml" xpointer=
"qdisc-parent" />
3118 <xi:include href=
"tc.xml" xpointer=
"qdisc-handle" />
3121 <term><varname>PacketLimit=
</varname></term>
3123 <para>As in [PFIFO] section.
</para></listitem>
3129 <title>[PFIFOFast] Section Options
</title>
3130 <para>The [PFIFOFast] section manages the queueing discipline (qdisc) of Packet First In First Out Fast
3131 (pfifo_fast).
</para>
3133 <variablelist class='network-directives'
>
3134 <xi:include href=
"tc.xml" xpointer=
"qdisc-parent" />
3135 <xi:include href=
"tc.xml" xpointer=
"qdisc-handle" />
3140 <title>[CAKE] Section Options
</title>
3141 <para>The [CAKE] section manages the queueing discipline (qdisc) of Common Applications Kept Enhanced
3144 <variablelist class='network-directives'
>
3145 <xi:include href=
"tc.xml" xpointer=
"qdisc-parent" />
3146 <xi:include href=
"tc.xml" xpointer=
"qdisc-handle" />
3149 <term><varname>OverheadBytes=
</varname></term>
3151 <para>Specifies that bytes to be addeded to the size of each packet. Bytes may be negative. Takes
3152 an integer in the range from -
64 to
256. Defaults to unset and kernel's default is used.
</para>
3157 <term><varname>Bandwidth=
</varname></term>
3159 <para>Specifies the shaper bandwidth. When suffixed with K, M, or G, the specified size is
3160 parsed as Kilobits, Megabits, or Gigabits, respectively, to the base of
1000. Defaults to
3161 unset and kernel's default is used.
</para>
3168 <title>[ControlledDelay] Section Options
</title>
3169 <para>The [ControlledDelay] section manages the queueing discipline (qdisc) of
3170 controlled delay (CoDel).
</para>
3172 <variablelist class='network-directives'
>
3173 <xi:include href=
"tc.xml" xpointer=
"qdisc-parent" />
3174 <xi:include href=
"tc.xml" xpointer=
"qdisc-handle" />
3177 <term><varname>PacketLimit=
</varname></term>
3179 <para>Specifies the hard limit on the queue size in number of packets. When this limit is reached,
3180 incoming packets are dropped. An unsigned integer in the range
0–
4294967294. Defaults to unset and
3181 kernel's default is used.
</para>
3186 <term><varname>TargetSec=
</varname></term>
3188 <para>Takes a timespan. Specifies the acceptable minimum standing/persistent queue delay.
3189 Defaults to unset and kernel's default is used.
</para>
3194 <term><varname>IntervalSec=
</varname></term>
3196 <para>Takes a timespan. This is used to ensure that the measured minimum delay does not
3197 become too stale. Defaults to unset and kernel's default is used.
</para>
3202 <term><varname>ECN=
</varname></term>
3204 <para>Takes a boolean. This can be used to mark packets instead of dropping them. Defaults to
3205 unset and kernel's default is used.
</para>
3210 <term><varname>CEThresholdSec=
</varname></term>
3212 <para>Takes a timespan. This sets a threshold above which all packets are marked with ECN
3213 Congestion Experienced (CE). Defaults to unset and kernel's default is used.
</para>
3220 <title>[DeficitRoundRobinScheduler] Section Options
</title>
3221 <para>The [DeficitRoundRobinScheduler] section manages the queueing discipline (qdisc) of Deficit Round
3222 Robin Scheduler (DRR).
</para>
3224 <variablelist class='network-directives'
>
3225 <xi:include href=
"tc.xml" xpointer=
"qdisc-parent" />
3226 <xi:include href=
"tc.xml" xpointer=
"qdisc-handle" />
3231 <title>[DeficitRoundRobinSchedulerClass] Section Options
</title>
3232 <para>The [DeficitRoundRobinSchedulerClass] section manages the traffic control class of Deficit Round
3233 Robin Scheduler (DRR).
</para>
3235 <variablelist class='network-directives'
>
3236 <xi:include href=
"tc.xml" xpointer=
"tclass-parent" />
3237 <xi:include href=
"tc.xml" xpointer=
"tclass-classid" />
3240 <term><varname>QuantumBytes=
</varname></term>
3242 <para>Specifies the amount of bytes a flow is allowed to dequeue before the scheduler moves
3243 to the next class. When suffixed with K, M, or G, the specified size is parsed as Kilobytes,
3244 Megabytes, or Gigabytes, respectively, to the base of
1024. Defaults to the MTU of the
3253 <title>[EnhancedTransmissionSelection] Section Options
</title>
3254 <para>The [EnhancedTransmissionSelection] section manages the queueing discipline (qdisc) of Enhanced
3255 Transmission Selection (ETS).
</para>
3257 <variablelist class='network-directives'
>
3258 <xi:include href=
"tc.xml" xpointer=
"qdisc-parent" />
3259 <xi:include href=
"tc.xml" xpointer=
"qdisc-handle" />
3262 <term><varname>Bands=
</varname></term>
3264 <para>Specifies the number of bands. An unsigned integer in the range
1–
16. This value has to be at
3265 least large enough to cover the strict bands specified through the
<varname>StrictBands=
</varname>
3266 and bandwidth-sharing bands specified in
<varname>QuantumBytes=
</varname>.
</para>
3271 <term><varname>StrictBands=
</varname></term>
3273 <para>Specifies the number of bands that should be created in strict mode. An unsigned integer in
3274 the range
1–
16.
</para>
3279 <term><varname>QuantumBytes=
</varname></term>
3281 <para>Specifies the white-space separated list of quantum used in band-sharing bands. When
3282 suffixed with K, M, or G, the specified size is parsed as Kilobytes, Megabytes, or Gigabytes,
3283 respectively, to the base of
1024. This setting can be specified multiple times. If an empty
3284 string is assigned, then the all previous assignments are cleared.
</para>
3289 <term><varname>PriorityMap=
</varname></term>
3291 <para>The priority map maps the priority of a packet to a band. The argument is a whitespace
3292 separated list of numbers. The first number indicates which band the packets with priority
0 should
3293 be put to, the second is for priority
1, and so on. There can be up to
16 numbers in the list. If
3294 there are fewer, the default band that traffic with one of the unmentioned priorities goes to is
3295 the last one. Each band number must be in the range
0.
.255. This setting can be specified multiple
3296 times. If an empty string is assigned, then the all previous assignments are cleared.
</para>
3303 <title>[GenericRandomEarlyDetection] Section Options
</title>
3304 <para>The [GenericRandomEarlyDetection] section manages the queueing discipline (qdisc) of Generic Random
3305 Early Detection (GRED).
</para>
3307 <variablelist class='network-directives'
>
3308 <xi:include href=
"tc.xml" xpointer=
"qdisc-parent" />
3309 <xi:include href=
"tc.xml" xpointer=
"qdisc-handle" />
3312 <term><varname>VirtualQueues=
</varname></term>
3314 <para>Specifies the number of virtual queues. Takes a integer in the range
1-
16. Defaults to unset and kernel's default is used.
</para>
3319 <term><varname>DefaultVirtualQueue=
</varname></term>
3321 <para>Specifies the number of default virtual queue. This must be less than
<varname>VirtualQueue=
</varname>.
3322 Defaults to unset and kernel's default is used.
</para>
3327 <term><varname>GenericRIO=
</varname></term>
3329 <para>Takes a boolean. It turns on the RIO-like buffering scheme. Defaults to
3330 unset and kernel's default is used.
</para>
3337 <title>[FairQueueingControlledDelay] Section Options
</title>
3338 <para>The [FairQueueingControlledDelay] section manages the queueing discipline (qdisc) of fair queuing
3339 controlled delay (FQ-CoDel).
</para>
3341 <variablelist class='network-directives'
>
3342 <xi:include href=
"tc.xml" xpointer=
"qdisc-parent" />
3343 <xi:include href=
"tc.xml" xpointer=
"qdisc-handle" />
3346 <term><varname>PacketLimit=
</varname></term>
3348 <para>Specifies the hard limit on the real queue size. When this limit is reached, incoming packets are
3349 dropped. Defaults to unset and kernel's default is used.
</para>
3354 <term><varname>MemoryLimitBytes=
</varname></term>
3356 <para>Specifies the limit on the total number of bytes that can be queued in this FQ-CoDel instance.
3357 When suffixed with K, M, or G, the specified size is parsed as Kilobytes, Megabytes, or Gigabytes,
3358 respectively, to the base of
1024. Defaults to unset and kernel's default is used.
</para>
3363 <term><varname>Flows=
</varname></term>
3365 <para>Specifies the number of flows into which the incoming packets are classified.
3366 Defaults to unset and kernel's default is used.
</para>
3371 <term><varname>TargetSec=
</varname></term>
3373 <para>Takes a timespan. Specifies the acceptable minimum standing/persistent queue delay.
3374 Defaults to unset and kernel's default is used.
</para>
3379 <term><varname>IntervalSec=
</varname></term>
3381 <para>Takes a timespan. This is used to ensure that the measured minimum delay does not
3382 become too stale. Defaults to unset and kernel's default is used.
</para>
3387 <term><varname>QuantumBytes=
</varname></term>
3389 <para>Specifies the number of bytes used as the
"deficit" in the fair queuing algorithm timespan.
3390 When suffixed with K, M, or G, the specified size is parsed as Kilobytes, Megabytes, or Gigabytes,
3391 respectively, to the base of
1024. Defaults to unset and kernel's default is used.
</para>
3396 <term><varname>ECN=
</varname></term>
3398 <para>Takes a boolean. This can be used to mark packets instead of dropping them. Defaults to
3399 unset and kernel's default is used.
</para>
3404 <term><varname>CEThresholdSec=
</varname></term>
3406 <para>Takes a timespan. This sets a threshold above which all packets are marked with ECN
3407 Congestion Experienced (CE). Defaults to unset and kernel's default is used.
</para>
3414 <title>[FairQueueing] Section Options
</title>
3415 <para>The [FairQueueing] section manages the queueing discipline (qdisc) of fair queue traffic policing
3418 <variablelist class='network-directives'
>
3419 <xi:include href=
"tc.xml" xpointer=
"qdisc-parent" />
3420 <xi:include href=
"tc.xml" xpointer=
"qdisc-handle" />
3423 <term><varname>PacketLimit=
</varname></term>
3425 <para>Specifies the hard limit on the real queue size. When this limit is reached, incoming packets are
3426 dropped. Defaults to unset and kernel's default is used.
</para>
3431 <term><varname>FlowLimit=
</varname></term>
3433 <para>Specifies the hard limit on the maximum number of packets queued per flow. Defaults to
3434 unset and kernel's default is used.
</para>
3439 <term><varname>QuantumBytes=
</varname></term>
3441 <para>Specifies the credit per dequeue RR round, i.e. the amount of bytes a flow is allowed
3442 to dequeue at once. When suffixed with K, M, or G, the specified size is parsed as Kilobytes,
3443 Megabytes, or Gigabytes, respectively, to the base of
1024. Defaults to unset and kernel's
3444 default is used.
</para>
3449 <term><varname>InitialQuantumBytes=
</varname></term>
3451 <para>Specifies the initial sending rate credit, i.e. the amount of bytes a new flow is
3452 allowed to dequeue initially. When suffixed with K, M, or G, the specified size is parsed as
3453 Kilobytes, Megabytes, or Gigabytes, respectively, to the base of
1024. Defaults to unset and
3454 kernel's default is used.
</para>
3459 <term><varname>MaximumRate=
</varname></term>
3461 <para>Specifies the maximum sending rate of a flow. When suffixed with K, M, or G, the
3462 specified size is parsed as Kilobits, Megabits, or Gigabits, respectively, to the base of
3463 1000. Defaults to unset and kernel's default is used.
</para>
3468 <term><varname>Buckets=
</varname></term>
3470 <para>Specifies the size of the hash table used for flow lookups. Defaults to unset and
3471 kernel's default is used.
</para>
3476 <term><varname>OrphanMask=
</varname></term>
3478 <para>Takes an unsigned integer. For packets not owned by a socket, fq is able to mask a part
3479 of hash and reduce number of buckets associated with the traffic. Defaults to unset and
3480 kernel's default is used.
</para>
3485 <term><varname>Pacing=
</varname></term>
3487 <para>Takes a boolean, and enables or disables flow pacing. Defaults to unset and kernel's
3488 default is used.
</para>
3493 <term><varname>CEThresholdSec=
</varname></term>
3495 <para>Takes a timespan. This sets a threshold above which all packets are marked with ECN
3496 Congestion Experienced (CE). Defaults to unset and kernel's default is used.
</para>
3503 <title>[TrivialLinkEqualizer] Section Options
</title>
3504 <para>The [TrivialLinkEqualizer] section manages the queueing discipline (qdisc) of trivial link
3505 equalizer (teql).
</para>
3507 <variablelist class='network-directives'
>
3508 <xi:include href=
"tc.xml" xpointer=
"qdisc-parent" />
3509 <xi:include href=
"tc.xml" xpointer=
"qdisc-handle" />
3512 <term><varname>Id=
</varname></term>
3514 <para>Specifies the interface ID
<literal>N
</literal> of teql. Defaults to
<literal>0</literal>.
3515 Note that when teql is used, currently, the module
<constant>sch_teql
</constant> with
3516 <constant>max_equalizers=N+
1</constant> option must be loaded before
3517 <command>systemd-networkd
</command> is started.
</para>
3524 <title>[HierarchyTokenBucket] Section Options
</title>
3525 <para>The [HierarchyTokenBucket] section manages the queueing discipline (qdisc) of hierarchy token
3526 bucket (htb).
</para>
3528 <variablelist class='network-directives'
>
3529 <xi:include href=
"tc.xml" xpointer=
"qdisc-parent" />
3530 <xi:include href=
"tc.xml" xpointer=
"qdisc-handle" />
3533 <term><varname>DefaultClass=
</varname></term>
3535 <para>Takes the minor id in hexadecimal of the default class. Unclassified traffic gets sent
3536 to the class. Defaults to unset.
</para>
3541 <term><varname>RateToQuantum=
</varname></term>
3543 <para>Takes an unsigned integer. The DRR quantums are calculated by dividing the value
3544 configured in
<varname>Rate=
</varname> by
<varname>RateToQuantum=
</varname>.
</para>
3551 <title>[HierarchyTokenBucketClass] Section Options
</title>
3552 <para>The [HierarchyTokenBucketClass] section manages the traffic control class of hierarchy token bucket
3555 <variablelist class='network-directives'
>
3556 <xi:include href=
"tc.xml" xpointer=
"tclass-parent" />
3557 <xi:include href=
"tc.xml" xpointer=
"tclass-classid" />
3560 <term><varname>Priority=
</varname></term>
3562 <para>Specifies the priority of the class. In the round-robin process, classes with the lowest
3563 priority field are tried for packets first.
</para>
3568 <term><varname>QuantumBytes=
</varname></term>
3570 <para>Specifies how many bytes to serve from leaf at once. When suffixed with K, M, or G, the
3571 specified size is parsed as Kilobytes, Megabytes, or Gigabytes, respectively, to the base of
3577 <term><varname>MTUBytes=
</varname></term>
3579 <para>Specifies the maximum packet size we create. When suffixed with K, M, or G, the specified
3580 size is parsed as Kilobytes, Megabytes, or Gigabytes, respectively, to the base of
1024.
</para>
3585 <term><varname>OverheadBytes=
</varname></term>
3587 <para>Takes an unsigned integer which specifies per-packet size overhead used in rate
3588 computations. When suffixed with K, M, or G, the specified size is parsed as Kilobytes,
3589 Megabytes, or Gigabytes, respectively, to the base of
1024.
</para>
3594 <term><varname>Rate=
</varname></term>
3596 <para>Specifies the maximum rate this class and all its children are guaranteed. When suffixed
3597 with K, M, or G, the specified size is parsed as Kilobits, Megabits, or Gigabits, respectively,
3598 to the base of
1000. This setting is mandatory.
</para>
3603 <term><varname>CeilRate=
</varname></term>
3605 <para>Specifies the maximum rate at which a class can send, if its parent has bandwidth to spare.
3606 When suffixed with K, M, or G, the specified size is parsed as Kilobits, Megabits, or Gigabits,
3607 respectively, to the base of
1000. When unset, the value specified with
<varname>Rate=
</varname>
3613 <term><varname>BufferBytes=
</varname></term>
3615 <para>Specifies the maximum bytes burst which can be accumulated during idle period. When suffixed
3616 with K, M, or G, the specified size is parsed as Kilobytes, Megabytes, or Gigabytes, respectively,
3617 to the base of
1024.
</para>
3622 <term><varname>CeilBufferBytes=
</varname></term>
3624 <para>Specifies the maximum bytes burst for ceil which can be accumulated during idle period.
3625 When suffixed with K, M, or G, the specified size is parsed as Kilobytes, Megabytes, or Gigabytes,
3626 respectively, to the base of
1024.
</para>
3633 <title>[HeavyHitterFilter] Section Options
</title>
3634 <para>The [HeavyHitterFilter] section manages the queueing discipline (qdisc) of Heavy Hitter Filter
3637 <variablelist class='network-directives'
>
3638 <xi:include href=
"tc.xml" xpointer=
"qdisc-parent" />
3639 <xi:include href=
"tc.xml" xpointer=
"qdisc-handle" />
3642 <term><varname>PacketLimit=
</varname></term>
3644 <para>Specifies the hard limit on the queue size in number of packets. When this limit is reached,
3645 incoming packets are dropped. An unsigned integer in the range
0–
4294967294. Defaults to unset and
3646 kernel's default is used.
</para>
3653 <title>[QuickFairQueueing] Section Options
</title>
3654 <para>The [QuickFairQueueing] section manages the queueing discipline (qdisc) of Quick Fair Queueing
3657 <variablelist class='network-directives'
>
3658 <xi:include href=
"tc.xml" xpointer=
"qdisc-parent" />
3659 <xi:include href=
"tc.xml" xpointer=
"qdisc-handle" />
3664 <title>[QuickFairQueueingClass] Section Options
</title>
3665 <para>The [QuickFairQueueingClass] section manages the traffic control class of Quick Fair Queueing
3668 <variablelist class='network-directives'
>
3669 <xi:include href=
"tc.xml" xpointer=
"tclass-parent" />
3670 <xi:include href=
"tc.xml" xpointer=
"tclass-classid" />
3673 <term><varname>Weight=
</varname></term>
3675 <para>Specifies the weight of the class. Takes an integer in the range
1.
.1023. Defaults to
3676 unset in which case the kernel default is used.
</para>
3681 <term><varname>MaxPacketBytes=
</varname></term>
3683 <para>Specifies the maximum packet size in bytes for the class. When suffixed with K, M, or G, the
3684 specified size is parsed as Kilobytes, Megabytes, or Gigabytes, respectively, to the base of
3685 1024. When unset, the kernel default is used.
</para>
3692 <title>[BridgeVLAN] Section Options
</title>
3693 <para>The [BridgeVLAN] section manages the VLAN ID configuration of a bridge port and accepts the
3694 following keys. Specify several [BridgeVLAN] sections to configure several VLAN entries. The
3695 <varname>VLANFiltering=
</varname> option has to be enabled, see the [Bridge] section in
3696 <citerefentry><refentrytitle>systemd.netdev
</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
</para>
3698 <variablelist class='network-directives'
>
3700 <term><varname>VLAN=
</varname></term>
3702 <para>The VLAN ID allowed on the port. This can be either a single ID or a range M-N. VLAN IDs are valid
3703 from
1 to
4094.
</para>
3707 <term><varname>EgressUntagged=
</varname></term>
3709 <para>The VLAN ID specified here will be used to untag frames on egress. Configuring
3710 <varname>EgressUntagged=
</varname> implicates the use of
<varname>VLAN=
</varname> above and will enable the
3711 VLAN ID for ingress as well. This can be either a single ID or a range M-N.
</para>
3715 <term><varname>PVID=
</varname></term>
3717 <para>The Port VLAN ID specified here is assigned to all untagged frames at ingress.
3718 <varname>PVID=
</varname> can be used only once. Configuring
<varname>PVID=
</varname> implicates the use of
3719 <varname>VLAN=
</varname> above and will enable the VLAN ID for ingress as well.
</para>
3726 <title>Examples
</title>
3728 <title>Static network configuration
</title>
3730 <programlisting># /etc/systemd/network/
50-static.network
3735 Address=
192.168.0.15/
24
3736 Gateway=
192.168.0.1</programlisting>
3738 <para>This brings interface
<literal>enp2s0
</literal> up with a static address. The
3739 specified gateway will be used for a default route.
</para>
3743 <title>DHCP on ethernet links
</title>
3745 <programlisting># /etc/systemd/network/
80-dhcp.network
3750 DHCP=yes
</programlisting>
3752 <para>This will enable DHCPv4 and DHCPv6 on all interfaces with names starting with
3753 <literal>en
</literal> (i.e. ethernet interfaces).
</para>
3757 <title>IPv6 Prefix Delegation
</title>
3759 <programlisting># /etc/systemd/network/
55-ipv6-pd-upstream.network
3764 DHCP=ipv6
</programlisting>
3766 <programlisting># /etc/systemd/network/
56-ipv6-pd-downstream.network
3772 DHCPv6PrefixDelegation=yes
</programlisting>
3774 <para>This will enable DHCPv6-PD on the interface enp1s0 as an upstream interface where the
3775 DHCPv6 client is running and enp2s0 as a downstream interface where the prefix is delegated to.
3776 The delegated prefixes are distributed by IPv6 Router Advertisement on the downstream network.
3781 <title>A bridge with two enslaved links
</title>
3783 <programlisting># /etc/systemd/network/
25-bridge-static.network
3788 Address=
192.168.0.15/
24
3790 DNS=
192.168.0.1</programlisting>
3792 <programlisting># /etc/systemd/network/
25-bridge-slave-interface-
1.network
3797 Bridge=bridge0
</programlisting>
3799 <programlisting># /etc/systemd/network/
25-bridge-slave-interface-
2.network
3804 Bridge=bridge0
</programlisting>
3806 <para>This creates a bridge and attaches devices
<literal>enp2s0
</literal> and
3807 <literal>wlp3s0
</literal> to it. The bridge will have the specified static address
3808 and network assigned, and a default route via the specified gateway will be
3809 added. The specified DNS server will be added to the global list of DNS resolvers.
3817 # /etc/systemd/network/
20-bridge-slave-interface-vlan.network
3833 EgressUntagged=
300-
400</programlisting>
3835 <para>This overrides the configuration specified in the previous example for the
3836 interface
<literal>enp2s0
</literal>, and enables VLAN on that bridge port. VLAN IDs
3837 1-
32,
42,
100-
400 will be allowed. Packets tagged with VLAN IDs
42,
300-
400 will be
3838 untagged when they leave on this interface. Untagged packets which arrive on this
3839 interface will be assigned VLAN ID
42.
</para>
3843 <title>Various tunnels
</title>
3845 <programlisting>/etc/systemd/network/
25-tunnels.network
3856 <programlisting>/etc/systemd/network/
25-tunnel-ipip.netdev
3862 <programlisting>/etc/systemd/network/
25-tunnel-sit.netdev
3868 <programlisting>/etc/systemd/network/
25-tunnel-gre.netdev
3874 <programlisting>/etc/systemd/network/
25-tunnel-vti.netdev
3880 <para>This will bring interface
<literal>ens1
</literal> up and create an IPIP tunnel,
3881 a SIT tunnel, a GRE tunnel, and a VTI tunnel using it.
</para>
3885 <title>A bond device
</title>
3887 <programlisting># /etc/systemd/network/
30-bond1.network
3895 <programlisting># /etc/systemd/network/
30-bond1.netdev
3901 <programlisting># /etc/systemd/network/
30-bond1-dev1.network
3903 MACAddress=
52:
54:
00:e9:
64:
41
3909 <programlisting># /etc/systemd/network/
30-bond1-dev2.network
3911 MACAddress=
52:
54:
00:e9:
64:
42
3917 <para>This will create a bond device
<literal>bond1
</literal> and enslave the two
3918 devices with MAC addresses
52:
54:
00:e9:
64:
41 and
52:
54:
00:e9:
64:
42 to it. IPv6 DHCP
3919 will be used to acquire an address.
</para>
3923 <title>Virtual Routing and Forwarding (VRF)
</title>
3924 <para>Add the
<literal>bond1
</literal> interface to the VRF master interface
3925 <literal>vrf1
</literal>. This will redirect routes generated on this interface to be
3926 within the routing table defined during VRF creation. For kernels before
4.8 traffic
3927 won't be redirected towards the VRFs routing table unless specific ip-rules are added.
3929 <programlisting># /etc/systemd/network/
25-vrf.network
3939 <title>MacVTap
</title>
3940 <para>This brings up a network interface
<literal>macvtap-test
</literal>
3941 and attaches it to
<literal>enp0s25
</literal>.
</para>
3942 <programlisting># /usr/lib/systemd/network/
25-macvtap.network
3947 MACVTAP=macvtap-test
3952 <title>A Xfrm interface with physical underlying device.
</title>
3954 <programlisting># /etc/systemd/network/
27-xfrm.netdev
3959 InterfaceId=
7</programlisting>
3961 <programlisting># /etc/systemd/network/
27-eth0.network
3966 Xfrm=xfrm0
</programlisting>
3968 <para>This creates a
<literal>xfrm0
</literal> interface and binds it to the
<literal>eth0
</literal> device.
3969 This allows hardware based ipsec offloading to the
<literal>eth0
</literal> nic.
3970 If offloading is not needed, xfrm interfaces can be assigned to the
<literal>lo
</literal> device.
3976 <title>See Also
</title>
3978 <citerefentry><refentrytitle>systemd
</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
3979 <citerefentry><refentrytitle>systemd-networkd.service
</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
3980 <citerefentry><refentrytitle>systemd.link
</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
3981 <citerefentry><refentrytitle>systemd.netdev
</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
3982 <citerefentry><refentrytitle>systemd-resolved.service
</refentrytitle><manvolnum>8</manvolnum></citerefentry>