2 <!DOCTYPE refentry PUBLIC
"-//OASIS//DTD DocBook XML V4.2//EN"
3 "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
6 SPDX-License-Identifier: LGPL-2.1+
9 <refentry id=
"systemd.network" conditional='ENABLE_NETWORKD'
>
12 <title>systemd.network
</title>
13 <productname>systemd
</productname>
17 <refentrytitle>systemd.network
</refentrytitle>
18 <manvolnum>5</manvolnum>
22 <refname>systemd.network
</refname>
23 <refpurpose>Network configuration
</refpurpose>
27 <para><filename><replaceable>network
</replaceable>.network
</filename></para>
31 <title>Description
</title>
33 <para>Network setup is performed by
34 <citerefentry><refentrytitle>systemd-networkd
</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
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
41 network directory
<filename>/usr/lib/systemd/network
</filename>, the volatile runtime network
42 directory
<filename>/run/systemd/network
</filename> and the local administration network
43 directory
<filename>/etc/systemd/network
</filename>. All configuration files are collectively
44 sorted and processed in lexical order, regardless of the directories in which they live.
45 However, files with identical filenames replace each other. Files in
<filename>/etc
</filename>
46 have the highest priority, files in
<filename>/run
</filename> take precedence over files with
47 the same name in
<filename>/usr/lib
</filename>. This can be used to override a system-supplied
48 configuration file with a local file if needed. As a special case, an empty file (file size
0)
49 or symlink with the same name pointing to
<filename>/dev/null
</filename> disables the
50 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 netdev file wherever located. (Of course, since
64 <filename>/run
</filename> is temporary and
<filename>/usr/lib
</filename> is for vendors, it is
65 unlikely drop-ins should be used in either of those places.)
</para>
67 <para>Note that an interface without any static IPv6 addresses configured, and neither DHCPv6
68 nor IPv6LL enabled, shall be considered to have no IPv6 support. IPv6 will be automatically
69 disabled for that interface by writing
"1" to
70 <filename>/proc/sys/net/ipv6/conf/
<replaceable>ifname
</replaceable>/disable_ipv6
</filename>.
75 <title>[Match] Section Options
</title>
77 <para>The network file contains a
<literal>[Match]
</literal>
78 section, which determines if a given network file may be applied
79 to a given device; and a
<literal>[Network]
</literal> section
80 specifying how the device should be configured. The first (in
81 lexical order) of the network files that matches a given device
82 is applied, all later files are ignored, even if they match as
85 <para>A network file is said to match a device if each of the
86 entries in the
<literal>[Match]
</literal> section matches, or if
87 the section is empty. The following keys are accepted:
</para>
89 <variablelist class='network-directives'
>
91 <term><varname>MACAddress=
</varname></term>
93 <para>A whitespace-separated list of hardware addresses. Use full colon-, hyphen- or dot-delimited hexadecimal. See the example below.
94 This option may appear more than one, in which case the lists are merged. If the empty string is assigned to this option, the list
95 of hardware addresses defined prior to this is reset.
</para>
98 <programlisting>MACAddress=
01:
23:
45:
67:
89:ab
00-
11-
22-
33-
44-
55 AABB.CCDD.EEFF
</programlisting></para>
102 <term><varname>Path=
</varname></term>
104 <para>A whitespace-separated list of shell-style globs
105 matching the persistent path, as exposed by the udev
106 property
<literal>ID_PATH
</literal>. If the list is
107 prefixed with a
"!", the test is inverted; i.e. it is
108 true when
<literal>ID_PATH
</literal> does not match any
109 item in the list.
</para>
113 <term><varname>Driver=
</varname></term>
115 <para>A whitespace-separated list of shell-style globs
116 matching the driver currently bound to the device, as
117 exposed by the udev property
<literal>DRIVER
</literal>
118 of its parent device, or if that is not set the driver
119 as exposed by
<literal>ethtool -i
</literal> of the
120 device itself. If the list is prefixed with a
"!", the
121 test is inverted.
</para>
125 <term><varname>Type=
</varname></term>
127 <para>A whitespace-separated list of shell-style globs
128 matching the device type, as exposed by the udev property
129 <literal>DEVTYPE
</literal>. If the list is prefixed with
130 a
"!", the test is inverted.
</para>
134 <term><varname>Name=
</varname></term>
136 <para>A whitespace-separated list of shell-style globs
137 matching the device name, as exposed by the udev property
138 <literal>INTERFACE
</literal>. If the list is prefixed
139 with a
"!", the test is inverted.
</para>
143 <term><varname>Host=
</varname></term>
145 <para>Matches against the hostname or machine ID of the
146 host. See
<literal>ConditionHost=
</literal> in
147 <citerefentry><refentrytitle>systemd.unit
</refentrytitle><manvolnum>5</manvolnum></citerefentry>
153 <term><varname>Virtualization=
</varname></term>
155 <para>Checks whether the system is executed in a virtualized
156 environment and optionally test whether it is a specific
157 implementation. See
<literal>ConditionVirtualization=
</literal> in
158 <citerefentry><refentrytitle>systemd.unit
</refentrytitle><manvolnum>5</manvolnum></citerefentry>
164 <term><varname>KernelCommandLine=
</varname></term>
166 <para>Checks whether a specific kernel command line option is
167 set (or if prefixed with the exclamation mark unset). See
168 <literal>ConditionKernelCommandLine=
</literal> in
169 <citerefentry><refentrytitle>systemd.unit
</refentrytitle><manvolnum>5</manvolnum></citerefentry>
175 <term><varname>KernelVersion=
</varname></term>
177 <para>Checks whether the kernel version (as reported by
<command>uname -r
</command>) matches a certain
178 expression (or if prefixed with the exclamation mark does not match it). See
179 <literal>ConditionKernelVersion=
</literal> in
180 <citerefentry><refentrytitle>systemd.unit
</refentrytitle><manvolnum>5</manvolnum></citerefentry> for
186 <term><varname>Architecture=
</varname></term>
188 <para>Checks whether the system is running on a specific
189 architecture. See
<literal>ConditionArchitecture=
</literal> in
190 <citerefentry><refentrytitle>systemd.unit
</refentrytitle><manvolnum>5</manvolnum></citerefentry>
200 <title>[Link] Section Options
</title>
202 <para> The
<literal>[Link]
</literal> section accepts the following keys:
</para>
204 <variablelist class='network-directives'
>
206 <term><varname>MACAddress=
</varname></term>
208 <para>The hardware address to set for the device.
</para>
212 <term><varname>MTUBytes=
</varname></term>
214 <para>The maximum transmission unit in bytes to set for the
215 device. The usual suffixes K, M, G, are supported and are
216 understood to the base of
1024.
</para>
217 <para>Note that if IPv6 is enabled on the interface, and the MTU is chosen
218 below
1280 (the minimum MTU for IPv6) it will automatically be increased to this value.
</para>
222 <term><varname>ARP=
</varname></term>
224 <para>A boolean. Enables or disables the ARP (low-level Address Resolution Protocol)
225 for this interface. Defaults to unset, which means that the kernel default will be used.
</para>
226 <para> For example, disabling ARP is useful when creating multiple MACVLAN or VLAN virtual
227 interfaces atop a single lower-level physical interface, which will then only serve as a
228 link/
"bridge" device aggregating traffic to the same physical link and not participate in
229 the network otherwise.
</para>
233 <term><varname>Multicast=
</varname></term>
235 <para>A boolean. Enables or disables the multicast flag on the device.
</para>
239 <term><varname>AllMulticast=
</varname></term>
241 <para>A boolean. When this flag is set the driver retrieves all multicast packets from the network.
242 This happens when multicast routing is enabled.
</para>
246 <term><varname>Unmanaged=
</varname></term>
248 <para>A boolean. When
<literal>yes
</literal>, no attempts are
249 made to bring up or configure matching links, equivalent to
250 when there are no matching network files. Defaults to
251 <literal>no
</literal>.
</para>
252 <para>This is useful for preventing later matching network
253 files from interfering with certain interfaces that are fully
254 controlled by other applications.
</para>
258 <term><varname>RequiredForOnline=
</varname></term>
260 <para>A boolean. When
<literal>yes
</literal>, the network is deemed
261 required when determining whether the system is online when running
262 <literal>systemd-networkd-wait-online
</literal>.
263 When
<literal>no
</literal>, the network is ignored when checking for
264 online state. Defaults to
<literal>yes
</literal>.
</para>
265 <para>The network will be brought up normally in all cases, but in
266 the event that there is no address being assigned by DHCP or the
267 cable is not plugged in, the link will simply remain offline and be
268 skipped automatically by
<literal>systemd-networkd-wait-online
</literal>
269 if
<literal>RequiredForOnline=true
</literal>.
</para>
276 <title>[Network] Section Options
</title>
278 <para>The
<literal>[Network]
</literal> section accepts the following keys:
</para>
280 <variablelist class='network-directives'
>
282 <term><varname>Description=
</varname></term>
284 <para>A description of the device. This is only used for
285 presentation purposes.
</para>
289 <term><varname>DHCP=
</varname></term>
291 <para>Enables DHCPv4 and/or DHCPv6 client support. Accepts
292 <literal>yes
</literal>,
<literal>no
</literal>,
293 <literal>ipv4
</literal>, or
<literal>ipv6
</literal>. Defaults
294 to
<literal>no
</literal>.
</para>
296 <para>Note that DHCPv6 will by default be triggered by Router
297 Advertisement, if that is enabled, regardless of this parameter.
298 By enabling DHCPv6 support explicitly, the DHCPv6 client will
299 be started regardless of the presence of routers on the link,
300 or what flags the routers pass. See
301 <literal>IPv6AcceptRA=
</literal>.
</para>
303 <para>Furthermore, note that by default the domain name
304 specified through DHCP is not used for name resolution.
305 See option
<option>UseDomains=
</option> below.
</para>
307 <para>See the
<literal>[DHCP]
</literal> section below for further configuration options for the DHCP client
312 <term><varname>DHCPServer=
</varname></term>
314 <para>A boolean. Enables DHCPv4 server support. Defaults
315 to
<literal>no
</literal>. Further settings for the DHCP
316 server may be set in the
<literal>[DHCPServer]
</literal>
317 section described below.
</para>
321 <term><varname>LinkLocalAddressing=
</varname></term>
323 <para>Enables link-local address autoconfiguration. Accepts
324 <literal>yes
</literal>,
<literal>no
</literal>,
325 <literal>ipv4
</literal>, or
<literal>ipv6
</literal>. Defaults to
326 <literal>ipv6
</literal>.
</para>
330 <term><varname>IPv4LLRoute=
</varname></term>
332 <para>A boolean. When true, sets up the route needed for
333 non-IPv4LL hosts to communicate with IPv4LL-only hosts. Defaults
339 <term><varname>IPv6Token=
</varname></term>
341 <para>An IPv6 address with the top
64 bits unset. When set, indicates the
342 64-bit interface part of SLAAC IPv6 addresses for this link. Note that
343 the token is only ever used for SLAAC, and not for DHCPv6 addresses, even
344 in the case DHCP is requested by router advertisement. By default, the
345 token is autogenerated.
</para>
349 <term><varname>LLMNR=
</varname></term>
351 <para>A boolean or
<literal>resolve
</literal>. When true,
353 url=
"https://tools.ietf.org/html/rfc4795">Link-Local
354 Multicast Name Resolution
</ulink> on the link. When set to
355 <literal>resolve
</literal>, only resolution is enabled,
356 but not host registration and announcement. Defaults to
357 true. This setting is read by
358 <citerefentry><refentrytitle>systemd-resolved.service
</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
</para>
362 <term><varname>MulticastDNS=
</varname></term>
364 <para>A boolean or
<literal>resolve
</literal>. When true,
366 url=
"https://tools.ietf.org/html/rfc6762">Multicast
367 DNS
</ulink> support on the link. When set to
368 <literal>resolve
</literal>, only resolution is enabled,
369 but not host or service registration and
370 announcement. Defaults to false. This setting is read by
371 <citerefentry><refentrytitle>systemd-resolved.service
</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
</para>
375 <term><varname>DNSOverTLS=
</varname></term>
378 <literal>opportunistic
</literal>. When set to
<literal>opportunistic
</literal>, enables
380 url=
"https://tools.ietf.org/html/rfc7858">DNS-over-TLS
</ulink>
381 support on the link. This option defines a
382 per-interface setting for
383 <citerefentry><refentrytitle>resolved.conf
</refentrytitle><manvolnum>5</manvolnum></citerefentry>'s
384 global
<varname>DNSOverTLS=
</varname> option. Defaults to
385 false. This setting is read by
386 <citerefentry><refentrytitle>systemd-resolved.service
</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
</para>
390 <term><varname>DNSSEC=
</varname></term>
393 <literal>allow-downgrade
</literal>. When true, enables
395 url=
"https://tools.ietf.org/html/rfc4033">DNSSEC
</ulink>
396 DNS validation support on the link. When set to
397 <literal>allow-downgrade
</literal>, compatibility with
398 non-DNSSEC capable networks is increased, by automatically
399 turning off DNSSEC in this case. This option defines a
400 per-interface setting for
401 <citerefentry><refentrytitle>resolved.conf
</refentrytitle><manvolnum>5</manvolnum></citerefentry>'s
402 global
<varname>DNSSEC=
</varname> option. Defaults to
403 false. This setting is read by
404 <citerefentry><refentrytitle>systemd-resolved.service
</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
</para>
408 <term><varname>DNSSECNegativeTrustAnchors=
</varname></term>
409 <listitem><para>A space-separated list of DNSSEC negative
410 trust anchor domains. If specified and DNSSEC is enabled,
411 look-ups done via the interface's DNS server will be subject
412 to the list of negative trust anchors, and not require
413 authentication for the specified domains, or anything below
414 it. Use this to disable DNSSEC authentication for specific
415 private domains, that cannot be proven valid using the
416 Internet DNS hierarchy. Defaults to the empty list. This
418 <citerefentry><refentrytitle>systemd-resolved.service
</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
</para>
422 <term><varname>LLDP=
</varname></term>
424 <para>Controls support for Ethernet LLDP packet reception. LLDP is a link-layer protocol commonly
425 implemented on professional routers and bridges which announces which physical port a system is connected
426 to, as well as other related data. Accepts a boolean or the special value
427 <literal>routers-only
</literal>. When true, incoming LLDP packets are accepted and a database of all LLDP
428 neighbors maintained. If
<literal>routers-only
</literal> is set only LLDP data of various types of routers
429 is collected and LLDP data about other types of devices ignored (such as stations, telephones and
430 others). If false, LLDP reception is disabled. Defaults to
<literal>routers-only
</literal>. Use
431 <citerefentry><refentrytitle>networkctl
</refentrytitle><manvolnum>1</manvolnum></citerefentry> to query the
432 collected neighbor data. LLDP is only available on Ethernet links. See
<varname>EmitLLDP=
</varname> below
433 for enabling LLDP packet emission from the local system.
438 <term><varname>EmitLLDP=
</varname></term>
440 <para>Controls support for Ethernet LLDP packet emission. Accepts a boolean parameter or the special values
441 <literal>nearest-bridge
</literal>,
<literal>non-tpmr-bridge
</literal> and
442 <literal>customer-bridge
</literal>. Defaults to false, which turns off LLDP packet emission. If not false,
443 a short LLDP packet with information about the local system is sent out in regular intervals on the
444 link. The LLDP packet will contain information about the local host name, the local machine ID (as stored
445 in
<citerefentry><refentrytitle>machine-id
</refentrytitle><manvolnum>5</manvolnum></citerefentry>) and the
446 local interface name, as well as the pretty hostname of the system (as set in
447 <citerefentry><refentrytitle>machine-info
</refentrytitle><manvolnum>5</manvolnum></citerefentry>). LLDP
448 emission is only available on Ethernet links. Note that this setting passes data suitable for
449 identification of host to the network and should thus not be enabled on untrusted networks, where such
450 identification data should not be made available. Use this option to permit other systems to identify on
451 which interfaces they are connected to this system. The three special values control propagation of the
452 LLDP packets. The
<literal>nearest-bridge
</literal> setting permits propagation only to the nearest
453 connected bridge,
<literal>non-tpmr-bridge
</literal> permits propagation across Two-Port MAC Relays, but
454 not any other bridges, and
<literal>customer-bridge
</literal> permits propagation until a customer bridge
455 is reached. For details about these concepts, see
<ulink
456 url=
"https://standards.ieee.org/findstds/standard/802.1AB-2016.html">IEEE
802.1AB-
2016</ulink>. Note that
457 configuring this setting to true is equivalent to
<literal>nearest-bridge
</literal>, the recommended and
458 most restricted level of propagation. See
<varname>LLDP=
</varname> above for an option to enable LLDP
463 <term><varname>BindCarrier=
</varname></term>
465 <para>A link name or a list of link names. When set, controls the behavior of the current
466 link. When all links in the list are in an operational down state, the current link is brought
467 down. When at least one link has carrier, the current interface is brought up.
472 <term><varname>Address=
</varname></term>
474 <para>A static IPv4 or IPv6 address and its prefix length,
475 separated by a
<literal>/
</literal> character. Specify
476 this key more than once to configure several addresses.
477 The format of the address must be as described in
478 <citerefentry project='man-pages'
><refentrytitle>inet_pton
</refentrytitle><manvolnum>3</manvolnum></citerefentry>.
479 This is a short-hand for an [Address] section only
480 containing an Address key (see below). This option may be
481 specified more than once.
484 <para>If the specified address is
0.0.0.0 (for IPv4) or
485 [::] (for IPv6), a new address range of the requested size
486 is automatically allocated from a system-wide pool of
487 unused ranges. The allocated range is checked against all
488 current network interfaces and all known network
489 configuration files to avoid address range conflicts. The
490 default system-wide pool consists of
192.168.0.0/
16,
491 172.16.0.0/
12 and
10.0.0.0/
8 for IPv4, and fc00::/
7 for
492 IPv6. This functionality is useful to manage a large
493 number of dynamically created network interfaces with the
494 same network configuration and automatic address range
500 <term><varname>Gateway=
</varname></term>
502 <para>The gateway address, which must be in the format
504 <citerefentry project='man-pages'
><refentrytitle>inet_pton
</refentrytitle><manvolnum>3</manvolnum></citerefentry>.
505 This is a short-hand for a [Route] section only containing
506 a Gateway key. This option may be specified more than
511 <term><varname>DNS=
</varname></term>
513 <para>A DNS server address, which must be in the format
515 <citerefentry project='man-pages'
><refentrytitle>inet_pton
</refentrytitle><manvolnum>3</manvolnum></citerefentry>.
516 This option may be specified more than once. This setting is read by
517 <citerefentry><refentrytitle>systemd-resolved.service
</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
</para>
521 <term><varname>Domains=
</varname></term>
523 <para>A list of domains which should be resolved using the DNS servers on this link. Each item in the list
524 should be a domain name, optionally prefixed with a tilde (
<literal>~
</literal>). The domains with the
525 prefix are called
"routing-only domains". The domains without the prefix are called
"search domains" and
526 are first used as search suffixes for extending single-label host names (host names containing no dots) to
527 become fully qualified domain names (FQDNs). If a single-label host name is resolved on this interface,
528 each of the specified search domains are appended to it in turn, converting it into a fully qualified
529 domain name, until one of them may be successfully resolved.
</para>
531 <para>Both
"search" and
"routing-only" domains are used for routing of DNS queries: look-ups for host names
532 ending in those domains (hence also single label names, if any
"search domains" are listed), are routed to
533 the DNS servers configured for this interface. The domain routing logic is particularly useful on
534 multi-homed hosts with DNS servers serving particular private DNS zones on each interface.
</para>
536 <para>The
"routing-only" domain
<literal>~.
</literal> (the tilde indicating definition of a routing domain,
537 the dot referring to the DNS root domain which is the implied suffix of all valid DNS names) has special
538 effect. It causes all DNS traffic which does not match another configured domain routing entry to be routed
539 to DNS servers specified for this interface. This setting is useful to prefer a certain set of DNS servers
540 if a link on which they are connected is available.
</para>
542 <para>This setting is read by
543 <citerefentry><refentrytitle>systemd-resolved.service
</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
544 "Search domains" correspond to the
<varname>domain
</varname> and
<varname>search
</varname> entries in
545 <citerefentry project='man-pages'
><refentrytitle>resolv.conf
</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
546 Domain name routing has no equivalent in the traditional glibc API, which has no concept of domain
547 name servers limited to a specific link.
</para>
551 <term><varname>NTP=
</varname></term>
553 <para>An NTP server address. This option may be specified more than once. This setting is read by
554 <citerefentry><refentrytitle>systemd-timesyncd.service
</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
</para>
558 <term><varname>IPForward=
</varname></term>
559 <listitem><para>Configures IP packet forwarding for the
560 system. If enabled, incoming packets on any network
561 interface will be forwarded to any other interfaces
562 according to the routing table. Takes either a boolean
563 argument, or the values
<literal>ipv4
</literal> or
564 <literal>ipv6
</literal>, which only enable IP packet
565 forwarding for the specified address family. This controls
566 the
<filename>net.ipv4.ip_forward
</filename> and
567 <filename>net.ipv6.conf.all.forwarding
</filename> sysctl
568 options of the network interface (see
<ulink
569 url=
"https://www.kernel.org/doc/Documentation/networking/ip-sysctl.txt">ip-sysctl.txt
</ulink>
570 for details about sysctl options). Defaults to
571 <literal>no
</literal>.
</para>
573 <para>Note: this setting controls a global kernel option,
574 and does so one way only: if a network that has this setting
575 enabled is set up the global setting is turned on. However,
576 it is never turned off again, even after all networks with
577 this setting enabled are shut down again.
</para>
579 <para>To allow IP packet forwarding only between specific
580 network interfaces use a firewall.
</para>
584 <term><varname>IPMasquerade=
</varname></term>
585 <listitem><para>Configures IP masquerading for the network
586 interface. If enabled, packets forwarded from the network
587 interface will be appear as coming from the local host.
588 Takes a boolean argument. Implies
589 <varname>IPForward=ipv4
</varname>. Defaults to
590 <literal>no
</literal>.
</para></listitem>
593 <term><varname>IPv6PrivacyExtensions=
</varname></term>
594 <listitem><para>Configures use of stateless temporary
595 addresses that change over time (see
<ulink
596 url=
"https://tools.ietf.org/html/rfc4941">RFC
4941</ulink>,
597 Privacy Extensions for Stateless Address Autoconfiguration
598 in IPv6). Takes a boolean or the special values
599 <literal>prefer-public
</literal> and
600 <literal>kernel
</literal>. When true, enables the privacy
601 extensions and prefers temporary addresses over public
602 addresses. When
<literal>prefer-public
</literal>, enables the
603 privacy extensions, but prefers public addresses over
604 temporary addresses. When false, the privacy extensions
605 remain disabled. When
<literal>kernel
</literal>, the kernel's
606 default setting will be left in place. Defaults to
607 <literal>no
</literal>.
</para></listitem>
610 <term><varname>IPv6AcceptRA=
</varname></term>
611 <listitem><para>Enable or disable IPv6 Router Advertisement (RA) reception support for the interface. Takes
612 a boolean parameter. If true, RAs are accepted; if false, RAs are ignored, independently of the local
613 forwarding state. When not set, the kernel default is used, and RAs are accepted only when local forwarding
614 is disabled for that interface. When RAs are accepted, they may trigger the start of the DHCPv6 client if
615 the relevant flags are set in the RA data, or if no routers are found on the link.
</para>
617 <para>Further settings for the IPv6 RA support may be configured in the
618 <literal>[IPv6AcceptRA]
</literal> section, see below.
</para>
620 <para>Also see
<ulink
621 url=
"https://www.kernel.org/doc/Documentation/networking/ip-sysctl.txt">ip-sysctl.txt
</ulink> in the kernel
622 documentation regarding
<literal>accept_ra
</literal>, but note that systemd's setting of
623 <constant>1</constant> (i.e. true) corresponds to kernel's setting of
<constant>2</constant>.
</para>
627 <term><varname>IPv6DuplicateAddressDetection=
</varname></term>
628 <listitem><para>Configures the amount of IPv6 Duplicate
629 Address Detection (DAD) probes to send. Defaults to unset.
633 <term><varname>IPv6HopLimit=
</varname></term>
634 <listitem><para>Configures IPv6 Hop Limit. For each router that
635 forwards the packet, the hop limit is decremented by
1. When the
636 hop limit field reaches zero, the packet is discarded.
641 <term><varname>IPv4ProxyARP=
</varname></term>
642 <listitem><para>A boolean. Configures proxy ARP for IPv4. Proxy ARP is the technique in which one host,
643 usually a router, answers ARP requests intended for another machine. By
"faking" its identity,
644 the router accepts responsibility for routing packets to the
"real" destination. (see
<ulink
645 url=
"https://tools.ietf.org/html/rfc1027">RFC
1027</ulink>.
650 <term><varname>IPv6ProxyNDP=
</varname></term>
651 <listitem><para>A boolean. Configures proxy NDP for IPv6. Proxy NDP (Neighbor Discovery
652 Protocol) is a technique for IPv6 to allow routing of addresses to a different
653 destination when peers expect them to be present on a certain physical link.
654 In this case a router answers Neighbour Advertisement messages intended for
655 another machine by offering its own MAC address as destination.
656 Unlike proxy ARP for IPv4, it is not enabled globally, but will only send Neighbour
657 Advertisement messages for addresses in the IPv6 neighbor proxy table,
658 which can also be shown by
<command>ip -
6 neighbour show proxy
</command>.
659 systemd-networkd will control the per-interface `proxy_ndp` switch for each configured
660 interface depending on this option.
665 <term><varname>IPv6ProxyNDPAddress=
</varname></term>
666 <listitem><para>An IPv6 address, for which Neighbour Advertisement messages will be
667 proxied. This option may be specified more than once. systemd-networkd will add the
668 <option>IPv6ProxyNDPAddress=
</option> entries to the kernel's IPv6 neighbor proxy table.
669 This option implies
<option>IPv6ProxyNDP=true
</option> but has no effect if
670 <option>IPv6ProxyNDP
</option> has been set to false. Defaults to unset.
674 <term><varname>IPv6PrefixDelegation=
</varname></term>
675 <listitem><para>Whether to enable or disable Router Advertisement sending on a link.
676 Allowed values are
<literal>static
</literal> which distributes prefixes as defined in
677 the
<literal>[IPv6PrefixDelegation]
</literal> and any
<literal>[IPv6Prefix]
</literal>
678 sections,
<literal>dhcpv6
</literal> which requests prefixes using a DHCPv6 client
679 configured for another link and any values configured in the
680 <literal>[IPv6PrefixDelegation]
</literal> section while ignoring all static prefix
681 configuration sections,
<literal>yes
</literal> which uses both static configuration
682 and DHCPv6, and
<literal>false
</literal> which turns off IPv6 prefix delegation
683 altogether. Defaults to
<literal>false
</literal>. See the
684 <literal>[IPv6PrefixDelegation]
</literal> and the
<literal>[IPv6Prefix]
</literal>
685 sections for more configuration options.
689 <term><varname>IPv6MTUBytes=
</varname></term>
690 <listitem><para>Configures IPv6 maximum transmission unit (MTU).
691 An integer greater than or equal to
1280 bytes. Defaults to unset.
695 <term><varname>Bridge=
</varname></term>
697 <para>The name of the bridge to add the link to. See
698 <citerefentry><refentrytitle>systemd.netdev
</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
703 <term><varname>Bond=
</varname></term>
705 <para>The name of the bond to add the link to. See
706 <citerefentry><refentrytitle>systemd.netdev
</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
711 <term><varname>VRF=
</varname></term>
713 <para>The name of the VRF to add the link to. See
714 <citerefentry><refentrytitle>systemd.netdev
</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
719 <term><varname>VLAN=
</varname></term>
721 <para>The name of a VLAN to create on the link. See
722 <citerefentry><refentrytitle>systemd.netdev
</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
723 This option may be specified more than once.
</para>
727 <term><varname>IPVLAN=
</varname></term>
729 <para>The name of a IPVLAN to create on the link. See
730 <citerefentry><refentrytitle>systemd.netdev
</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
731 This option may be specified more than once.
</para>
735 <term><varname>MACVLAN=
</varname></term>
737 <para>The name of a MACVLAN to create on the link. See
738 <citerefentry><refentrytitle>systemd.netdev
</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
739 This option may be specified more than once.
</para>
743 <term><varname>VXLAN=
</varname></term>
745 <para>The name of a VXLAN to create on the link. See
746 <citerefentry><refentrytitle>systemd.netdev
</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
747 This option may be specified more than once.
</para>
751 <term><varname>Tunnel=
</varname></term>
753 <para>The name of a Tunnel to create on the link. See
754 <citerefentry><refentrytitle>systemd.netdev
</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
755 This option may be specified more than once.
</para>
759 <term><varname>ActiveSlave=
</varname></term>
761 <para>A boolean. Specifies the new active slave. The
<literal>ActiveSlave=
</literal>
762 option is only valid for following modes:
763 <literal>active-backup
</literal>,
764 <literal>balance-alb
</literal> and
765 <literal>balance-tlb
</literal>. Defaults to false.
770 <term><varname>PrimarySlave=
</varname></term>
772 <para>A boolean. Specifies which slave is the primary device. The specified
773 device will always be the active slave while it is available. Only when the
774 primary is off-line will alternate devices be used. This is useful when
775 one slave is preferred over another, e.g. when one slave has higher throughput
776 than another. The
<literal>PrimarySlave=
</literal> option is only valid for
778 <literal>active-backup
</literal>,
779 <literal>balance-alb
</literal> and
780 <literal>balance-tlb
</literal>. Defaults to false.
785 <term><varname>ConfigureWithoutCarrier=
</varname></term>
787 <para>A boolean. Allows networkd to configure a specific link even if it has no carrier.
797 <title>[Address] Section Options
</title>
799 <para>An
<literal>[Address]
</literal> section accepts the
800 following keys. Specify several
<literal>[Address]
</literal>
801 sections to configure several addresses.
</para>
803 <variablelist class='network-directives'
>
805 <term><varname>Address=
</varname></term>
807 <para>As in the
<literal>[Network]
</literal> section. This
808 key is mandatory.
</para>
812 <term><varname>Peer=
</varname></term>
814 <para>The peer address in a point-to-point connection.
815 Accepts the same format as the
<literal>Address
</literal>
820 <term><varname>Broadcast=
</varname></term>
822 <para>The broadcast address, which must be in the format
824 <citerefentry project='man-pages'
><refentrytitle>inet_pton
</refentrytitle><manvolnum>3</manvolnum></citerefentry>.
825 This key only applies to IPv4 addresses. If it is not
826 given, it is derived from the
<literal>Address
</literal>
831 <term><varname>Label=
</varname></term>
833 <para>An address label.
</para>
837 <term><varname>PreferredLifetime=
</varname></term>
839 <para>Allows the default
"preferred lifetime" of the address to be overridden.
840 Only three settings are accepted:
<literal>forever
</literal> or
<literal>infinity
</literal>
841 which is the default and means that the address never expires, and
<literal>0</literal> which means
842 that the address is considered immediately
"expired" and will not be used,
843 unless explicitly requested. A setting of PreferredLifetime=
0 is useful for
844 addresses which are added to be used only by a specific application,
845 which is then configured to use them explicitly.
</para>
849 <term><varname>Scope=
</varname></term>
851 <para>The scope of the address, which can be
<literal>global
</literal>,
852 <literal>link
</literal> or
<literal>host
</literal> or an unsigned integer ranges
0 to
255.
853 Defaults to
<literal>global
</literal>.
</para>
857 <term><varname>HomeAddress=
</varname></term>
859 <para>Takes a boolean argument. Designates this address the
"home address" as defined in
860 <ulink url=
"https://tools.ietf.org/html/rfc6275">RFC
6275</ulink>.
861 Supported only on IPv6. Defaults to false.
</para>
865 <term><varname>DuplicateAddressDetection=
</varname></term>
867 <para>Takes a boolean argument. Do not perform Duplicate Address Detection
868 <ulink url=
"https://tools.ietf.org/html/rfc4862">RFC
4862</ulink> when adding this address.
869 Supported only on IPv6. Defaults to false.
</para>
873 <term><varname>ManageTemporaryAddress=
</varname></term>
875 <para>Takes a boolean argument. If true the kernel manage temporary addresses created
876 from this one as template on behalf of Privacy Extensions
877 <ulink url=
"https://tools.ietf.org/html/rfc3041">RFC
3041</ulink>. For this to become
878 active, the use_tempaddr sysctl setting has to be set to a value greater than zero.
879 The given address needs to have a prefix length of
64. This flag allows to use privacy
880 extensions in a manually configured network, just like if stateless auto-configuration
881 was active. Defaults to false.
</para>
885 <term><varname>PrefixRoute=
</varname></term>
887 <para>Takes a boolean argument. When adding or modifying an IPv6 address, the userspace
888 application needs a way to suppress adding a prefix route. This is for example relevant
889 together with IFA_F_MANAGERTEMPADDR, where userspace creates autoconf generated addresses,
890 but depending on on-link, no route for the prefix should be added. Defaults to false.
</para>
894 <term><varname>AutoJoin=
</varname></term>
896 <para>Takes a boolean argument. Joining multicast group on ethernet level via
897 <command>ip maddr
</command> command would not work if we have an Ethernet switch that does
898 IGMP snooping since the switch would not replicate multicast packets on ports that did not
899 have IGMP reports for the multicast addresses. Linux vxlan interfaces created via
900 <command>ip link add vxlan
</command> or networkd's netdev kind vxlan have the group option
901 that enables then to do the required join. By extending ip address command with option
902 <literal>autojoin
</literal> we can get similar functionality for openvswitch (OVS) vxlan
903 interfaces as well as other tunneling mechanisms that need to receive multicast traffic.
904 Defaults to
<literal>no
</literal>.
</para>
911 <title>[IPv6AddressLabel] Section Options
</title>
913 <para>An
<literal>[IPv6AddressLabel]
</literal> section accepts the
914 following keys. Specify several
<literal>[IPv6AddressLabel]
</literal>
915 sections to configure several address labels. IPv6 address labels are
916 used for address selection. See
<ulink url=
"https://tools.ietf.org/html/rfc3484">RFC
3484</ulink>.
917 Precedence is managed by userspace, and only the label itself is stored in the kernel
</para>
919 <variablelist class='network-directives'
>
921 <term><varname>Label=
</varname></term>
923 <para> The label for the prefix (an unsigned integer) ranges
0 to
4294967294.
924 0xffffffff is reserved. This key is mandatory.
</para>
928 <term><varname>Prefix=
</varname></term>
930 <para>IPv6 prefix is an address with a prefix length, separated by a slash
<literal>/
</literal> character.
931 This key is mandatory.
</para>
938 <title>[RoutingPolicyRule] Section Options
</title>
940 <para>An
<literal>[RoutingPolicyRule]
</literal> section accepts the
941 following keys. Specify several
<literal>[RoutingPolicyRule]
</literal>
942 sections to configure several rules.
</para>
944 <variablelist class='network-directives'
>
946 <term><varname>TypeOfService=
</varname></term>
948 <para>Specifies the type of service to match a number between
0 to
255.
</para>
952 <term><varname>From=
</varname></term>
954 <para>Specifies the source address prefix to match. Possibly followed by a slash and the prefix length.
</para>
958 <term><varname>To=
</varname></term>
960 <para>Specifies the destination address prefix to match. Possibly followed by a slash and the prefix length.
</para>
964 <term><varname>FirewallMark=
</varname></term>
966 <para>Specifies the iptables firewall mark value to match (a number between
1 and
4294967295).
</para>
970 <term><varname>Table=
</varname></term>
972 <para>Specifies the routing table identifier to lookup if the rule
973 selector matches. The table identifier for a route (a number between
1 and
4294967295).
</para>
977 <term><varname>Priority=
</varname></term>
979 <para>Specifies the priority of this rule.
<varname>Priority=
</varname> is an unsigned
980 integer. Higher number means lower priority, and rules get processed in order of increasing number.
</para>
984 <term><varname>IncomingInterface=
</varname></term>
986 <para>Specifies incoming device to match. If the interface is loopback, the rule only matches packets originating from this host.
</para>
990 <term><varname>OutgoingInterface=
</varname></term>
992 <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>
999 <title>[Route] Section Options
</title>
1000 <para>The
<literal>[Route]
</literal> section accepts the
1001 following keys. Specify several
<literal>[Route]
</literal>
1002 sections to configure several routes.
</para>
1004 <variablelist class='network-directives'
>
1006 <term><varname>Gateway=
</varname></term>
1008 <para>As in the
<literal>[Network]
</literal> section.
</para>
1012 <term><varname>GatewayOnlink=
</varname></term>
1014 <para>The
<literal>GatewayOnlink
</literal> option tells the kernel that it does not have
1015 to check if the gateway is reachable directly by the current machine (i.e., the kernel does
1016 not need to check if the gateway is attached to the local network), so that we can insert the
1017 route in the kernel table without it being complained about. A boolean, defaults to
<literal>no
</literal>.
1022 <term><varname>Destination=
</varname></term>
1024 <para>The destination prefix of the route. Possibly
1025 followed by a slash and the prefix length. If omitted, a
1026 full-length host route is assumed.
</para>
1030 <term><varname>Source=
</varname></term>
1032 <para>The source prefix of the route. Possibly followed by
1033 a slash and the prefix length. If omitted, a full-length
1034 host route is assumed.
</para>
1038 <term><varname>Metric=
</varname></term>
1040 <para>The metric of the route (an unsigned integer).
</para>
1044 <term><varname>IPv6Preference=
</varname></term>
1046 <para>Specifies the route preference as defined in
<ulink
1047 url=
"https://tools.ietf.org/html/rfc4191">RFC4191
</ulink> for Router Discovery messages.
1048 Which can be one of
<literal>low
</literal> the route has a lowest priority,
1049 <literal>medium
</literal> the route has a default priority or
1050 <literal>high
</literal> the route has a highest priority.
</para>
1054 <term><varname>Scope=
</varname></term>
1056 <para>The scope of the route, which can be
<literal>global
</literal>,
1057 <literal>link
</literal> or
<literal>host
</literal>. Defaults to
1058 <literal>global
</literal>.
</para>
1062 <term><varname>PreferredSource=
</varname></term>
1064 <para>The preferred source address of the route. The address
1065 must be in the format described in
1066 <citerefentry project='man-pages'
><refentrytitle>inet_pton
</refentrytitle><manvolnum>3</manvolnum></citerefentry>.
</para>
1070 <term><varname>Table=
<replaceable>num
</replaceable></varname></term>
1072 <para>The table identifier for the route (a number between
1 and
4294967295, or
0 to unset).
1073 The table can be retrieved using
<command>ip route show table
<replaceable>num
</replaceable></command>.
1078 <term><varname>Protocol=
</varname></term>
1080 <para>The Protocol identifier for the route. Takes a number between
0 and
255 or the special values
1081 <literal>kernel
</literal>,
<literal>boot
</literal> and
<literal>static
</literal>. Defaults to
1082 <literal>static
</literal>.
1087 <term><varname>Type=
</varname></term>
1089 <para>The Type identifier for special route types, which can be
1090 <literal>unicast
</literal> route to a destination network address which describes the path to the destination,
1091 <literal>blackhole
</literal> packets are discarded silently,
1092 <literal>unreachable
</literal> packets are discarded and the ICMP message host unreachable is generated,
1093 <literal>prohibit
</literal> packets are discarded and the ICMP message communication administratively
1094 prohibited is generated. Defaults to
<literal>unicast
</literal>.
1099 <term><varname>InitialCongestionWindow=
</varname></term>
1101 <para>The TCP initial congestion window is used during the start of a TCP connection. During the start of a TCP
1102 session, when a client requests a resource, the server's initial congestion window determines how many data bytes
1103 will be sent during the initial burst of data. Takes a size in bytes between
1 and
4294967295 (
2^
32 -
1). The usual
1104 suffixes K, M, G are supported and are understood to the base of
1024. Defaults to unset.
1109 <term><varname>InitialAdvertisedReceiveWindow=
</varname></term>
1111 <para>The TCP initial advertised receive window is the amount of receive data (in bytes) that can initally be buffered at one time
1112 on a connection. The sending host can send only that amount of data before waiting for an acknowledgment and window update
1113 from the receiving host. Takes a size in bytes between
1 and
4294967295 (
2^
32 -
1). The usual suffixes K, M, G are supported
1114 and are understood to the base of
1024. Defaults to unset.
1119 <term><varname>QuickAck=
</varname></term>
1121 <para>Takes a boolean argument. When true enables TCP quick ack mode for the route. Defaults to unset.
1126 <term><varname>MTUBytes=
</varname></term>
1128 <para>The maximum transmission unit in bytes to set for the
1129 route. The usual suffixes K, M, G, are supported and are
1130 understood to the base of
1024.
</para>
1131 <para>Note that if IPv6 is enabled on the interface, and the MTU is chosen
1132 below
1280 (the minimum MTU for IPv6) it will automatically be increased to this value.
</para>
1139 <title>[DHCP] Section Options
</title>
1140 <para>The
<literal>[DHCP]
</literal> section configures the
1141 DHCPv4 and DHCP6 client, if it is enabled with the
1142 <varname>DHCP=
</varname> setting described above:
</para>
1144 <variablelist class='network-directives'
>
1146 <term><varname>UseDNS=
</varname></term>
1148 <para>When true (the default), the DNS servers received
1149 from the DHCP server will be used and take precedence over
1150 any statically configured ones.
</para>
1152 <para>This corresponds to the
<option>nameserver
</option>
1153 option in
<citerefentry
1154 project='man-pages'
><refentrytitle>resolv.conf
</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
</para>
1158 <term><varname>UseNTP=
</varname></term>
1160 <para>When true (the default), the NTP servers received
1161 from the DHCP server will be used by systemd-timesyncd
1162 and take precedence over any statically configured ones.
</para>
1166 <term><varname>UseMTU=
</varname></term>
1168 <para>When true, the interface maximum transmission unit
1169 from the DHCP server will be used on the current link.
1170 Defaults to false.
</para>
1174 <term><varname>Anonymize=
</varname></term>
1176 <para>Takes a boolean argument. When true, the options sent to the DHCP server will
1177 follow the
<ulink url=
"https://tools.ietf.org/html/rfc7844">RFC
7844</ulink>
1178 (Anonymity Profiles for DHCP Clients) to minimize disclosure of identifying information.
1179 Defaults to false.
</para>
1181 <para>This option should only be set to true when
1182 <varname>MACAddressPolicy=
</varname> is set to
<literal>random
</literal>
1184 project='man-pages'
><refentrytitle>systemd.link
</refentrytitle><manvolnum>5</manvolnum></citerefentry>).
</para>
1186 <para>Note that this configuration will overwrite others.
1187 In concrete, the following variables will be ignored:
1188 <varname>SendHostname=
</varname>,
<varname>ClientIdentifier=
</varname>,
1189 <varname>UseRoutes=
</varname>,
<varname>SendHostname=
</varname>,
1190 <varname>UseMTU=
</varname>,
<varname>VendorClassIdentifier=
</varname>,
1191 <varname>UseTimezone=
</varname>.
</para>
1195 <term><varname>SendHostname=
</varname></term>
1197 <para>When true (the default), the machine's hostname will
1198 be sent to the DHCP server.
</para>
1202 <term><varname>UseHostname=
</varname></term>
1204 <para>When true (the default), the hostname received from
1205 the DHCP server will be set as the transient hostname of the system
1210 <term><varname>Hostname=
</varname></term>
1212 <para>Use this value for the hostname which is sent to the
1213 DHCP server, instead of machine's hostname.
</para>
1217 <term><varname>UseDomains=
</varname></term>
1219 <para>Takes a boolean argument, or the special value
<literal>route
</literal>. When true, the domain name
1220 received from the DHCP server will be used as DNS search domain over this link, similar to the effect of
1221 the
<option>Domains=
</option> setting. If set to
<literal>route
</literal>, the domain name received from
1222 the DHCP server will be used for routing DNS queries only, but not for searching, similar to the effect of
1223 the
<option>Domains=
</option> setting when the argument is prefixed with
<literal>~
</literal>. Defaults to
1226 <para>It is recommended to enable this option only on trusted networks, as setting this affects resolution
1227 of all host names, in particular of single-label names. It is generally safer to use the supplied domain
1228 only as routing domain, rather than as search domain, in order to not have it affect local resolution of
1229 single-label names.
</para>
1231 <para>When set to true, this setting corresponds to the
<option>domain
</option> option in
<citerefentry
1232 project='man-pages'
><refentrytitle>resolv.conf
</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
</para>
1236 <term><varname>UseRoutes=
</varname></term>
1238 <para>When true (the default), the static routes will be requested from the DHCP server and added to the
1239 routing table with a metric of
1024, and a scope of
"global",
"link" or
"host", depending on the route's
1240 destination and gateway. If the destination is on the local host, e.g.,
127.x.x.x, or the same as the
1241 link's own address, the scope will be set to
"host". Otherwise if the gateway is null (a direct route), a
1242 "link" scope will be used. For anything else, scope defaults to
"global".
</para>
1247 <term><varname>UseTimezone=
</varname></term>
1249 <listitem><para>When true, the timezone received from the
1250 DHCP server will be set as timezone of the local
1251 system. Defaults to
<literal>no
</literal>.
</para></listitem>
1255 <term><varname>CriticalConnection=
</varname></term>
1257 <para>When true, the connection will never be torn down
1258 even if the DHCP lease expires. This is contrary to the
1259 DHCP specification, but may be the best choice if, say,
1260 the root filesystem relies on this connection. Defaults to
1266 <term><varname>ClientIdentifier=
</varname></term>
1268 <para>The DHCPv4 client identifier to use. Takes one of
<literal>mac
</literal>,
<literal>duid
</literal> or
<literal>duid-only
</literal>.
1269 If set to
<literal>mac
</literal>, the MAC address of the link is used.
1270 If set to
<literal>duid
</literal>, an RFC4361-compliant Client ID, which is the combination of IAID and DUID (see below), is used.
1271 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.
1272 Defaults to
<literal>duid
</literal>.
</para>
1277 <term><varname>VendorClassIdentifier=
</varname></term>
1279 <para>The vendor class identifier used to identify vendor
1280 type and configuration.
</para>
1285 <term><varname>UserClass=
</varname></term>
1287 <para>A DHCPv4 client can use UserClass option to identify the type or category of user or applications
1288 it represents. The information contained in this option is a string that represents the user class of which
1289 the client is a member. Each class sets an identifying string of information to be used by the DHCP
1290 service to classify clients. Takes a whitespace-separated list of strings.
</para>
1295 <term><varname>DUIDType=
</varname></term>
1297 <para>Override the global
<varname>DUIDType
</varname> setting for this network. See
1298 <citerefentry><refentrytitle>networkd.conf
</refentrytitle><manvolnum>5</manvolnum></citerefentry>
1299 for a description of possible values.
</para>
1304 <term><varname>DUIDRawData=
</varname></term>
1306 <para>Override the global
<varname>DUIDRawData
</varname> setting for this network. See
1307 <citerefentry><refentrytitle>networkd.conf
</refentrytitle><manvolnum>5</manvolnum></citerefentry>
1308 for a description of possible values.
</para>
1313 <term><varname>IAID=
</varname></term>
1315 <para>The DHCP Identity Association Identifier (IAID) for the interface, a
32-bit unsigned integer.
</para>
1320 <term><varname>RequestBroadcast=
</varname></term>
1322 <para>Request the server to use broadcast messages before
1323 the IP address has been configured. This is necessary for
1324 devices that cannot receive RAW packets, or that cannot
1325 receive packets at all before an IP address has been
1326 configured. On the other hand, this must not be enabled on
1327 networks where broadcasts are filtered out.
</para>
1332 <term><varname>RouteMetric=
</varname></term>
1334 <para>Set the routing metric for routes specified by the
1340 <term><varname>RouteTable=
<replaceable>num
</replaceable></varname></term>
1342 <para>The table identifier for DHCP routes (a number between
1 and
4294967295, or
0 to unset).
1343 The table can be retrieved using
<command>ip route show table
<replaceable>num
</replaceable></command>.
1345 <para>When used in combination with
<varname>VRF=
</varname> the
1346 VRF's routing table is used unless this parameter is specified.
1352 <term><varname>ListenPort=
</varname></term>
1354 <para>Allow setting custom port for the DHCP client to listen on.
</para>
1359 <term><varname>RapidCommit=
</varname></term>
1361 <para>A boolean. The DHCPv6 client can obtain configuration parameters from a DHCPv6 server through
1362 a rapid two-message exchange (solicit and reply). When the rapid commit option is enabled by both
1363 the DHCPv6 client and the DHCPv6 server, the two-message exchange is used, rather than the default
1364 four-method exchange (solicit, advertise, request, and reply). The two-message exchange provides
1365 faster client configuration and is beneficial in environments in which networks are under a heavy load.
1366 See
<ulink url=
"https://tools.ietf.org/html/rfc3315#section-17.2.1">RFC
3315</ulink> for details.
1367 Defaults to true.
</para>
1375 <title>[IPv6AcceptRA] Section Options
</title>
1376 <para>The
<literal>[IPv6AcceptRA]
</literal> section configures the IPv6 Router Advertisement
1377 (RA) client, if it is enabled with the
<varname>IPv6AcceptRA=
</varname> setting described
1380 <variablelist class='network-directives'
>
1382 <term><varname>UseDNS=
</varname></term>
1384 <para>When true (the default), the DNS servers received in the Router Advertisement will be used and take
1385 precedence over any statically configured ones.
</para>
1387 <para>This corresponds to the
<option>nameserver
</option> option in
<citerefentry
1388 project='man-pages'
><refentrytitle>resolv.conf
</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
</para>
1393 <term><varname>UseDomains=
</varname></term>
1395 <para>Takes a boolean argument, or the special value
<literal>route
</literal>. When true, the domain name
1396 received via IPv6 Router Advertisement (RA) will be used as DNS search domain over this link, similar to
1397 the effect of the
<option>Domains=
</option> setting. If set to
<literal>route
</literal>, the domain name
1398 received via IPv6 RA will be used for routing DNS queries only, but not for searching, similar to the
1399 effect of the
<option>Domains=
</option> setting when the argument is prefixed with
1400 <literal>~
</literal>. Defaults to false.
</para>
1402 <para>It is recommended to enable this option only on trusted networks, as setting this affects resolution
1403 of all host names, in particular of single-label names. It is generally safer to use the supplied domain
1404 only as routing domain, rather than as search domain, in order to not have it affect local resolution of
1405 single-label names.
</para>
1407 <para>When set to true, this setting corresponds to the
<option>domain
</option> option in
<citerefentry
1408 project='man-pages'
><refentrytitle>resolv.conf
</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
</para>
1413 <term><varname>RouteTable=
<replaceable>num
</replaceable></varname></term>
1415 <para>The table identifier for the routes received in the Router Advertisement
1416 (a number between
1 and
4294967295, or
0 to unset).
1417 The table can be retrieved using
<command>ip route show table
<replaceable>num
</replaceable></command>.
1425 <title>[DHCPServer] Section Options
</title>
1426 <para>The
<literal>[DHCPServer]
</literal> section contains
1427 settings for the DHCP server, if enabled via the
1428 <varname>DHCPServer=
</varname> option described above:
</para>
1430 <variablelist class='network-directives'
>
1433 <term><varname>PoolOffset=
</varname></term>
1434 <term><varname>PoolSize=
</varname></term>
1436 <listitem><para>Configures the pool of addresses to hand out. The pool
1437 is a contiguous sequence of IP addresses in the subnet configured for
1438 the server address, which does not include the subnet nor the broadcast
1439 address.
<varname>PoolOffset=
</varname> takes the offset of the pool
1440 from the start of subnet, or zero to use the default value.
1441 <varname>PoolSize=
</varname> takes the number of IP addresses in the
1442 pool or zero to use the default value. By default, the pool starts at
1443 the first address after the subnet address and takes up the rest of
1444 the subnet, excluding the broadcast address. If the pool includes
1445 the server address (the default), this is reserved and not handed
1446 out to clients.
</para></listitem>
1450 <term><varname>DefaultLeaseTimeSec=
</varname></term>
1451 <term><varname>MaxLeaseTimeSec=
</varname></term>
1453 <listitem><para>Control the default and maximum DHCP lease
1454 time to pass to clients. These settings take time values in seconds or
1455 another common time unit, depending on the suffix. The default
1456 lease time is used for clients that did not ask for a specific
1457 lease time. If a client asks for a lease time longer than the
1458 maximum lease time, it is automatically shortened to the
1459 specified time. The default lease time defaults to
1h, the
1460 maximum lease time to
12h. Shorter lease times are beneficial
1461 if the configuration data in DHCP leases changes frequently
1462 and clients shall learn the new settings with shorter
1463 latencies. Longer lease times reduce the generated DHCP
1464 network traffic.
</para></listitem>
1468 <term><varname>EmitDNS=
</varname></term>
1469 <term><varname>DNS=
</varname></term>
1471 <listitem><para>Configures whether the DHCP leases handed out
1472 to clients shall contain DNS server information. The
1473 <varname>EmitDNS=
</varname> setting takes a boolean argument
1474 and defaults to
<literal>yes
</literal>. The DNS servers to
1475 pass to clients may be configured with the
1476 <varname>DNS=
</varname> option, which takes a list of IPv4
1477 addresses. If the
<varname>EmitDNS=
</varname> option is
1478 enabled but no servers configured, the servers are
1479 automatically propagated from an
"uplink" interface that has
1480 appropriate servers set. The
"uplink" interface is determined
1481 by the default route of the system with the highest
1482 priority. Note that this information is acquired at the time
1483 the lease is handed out, and does not take uplink interfaces
1484 into account that acquire DNS or NTP server information at a
1485 later point. DNS server propagation does not take
1486 <filename>/etc/resolv.conf
</filename> into account. Also, note
1487 that the leases are not refreshed if the uplink network
1488 configuration changes. To ensure clients regularly acquire the
1489 most current uplink DNS server information, it is thus
1490 advisable to shorten the DHCP lease time via
1491 <varname>MaxLeaseTimeSec=
</varname> described
1492 above.
</para></listitem>
1496 <term><varname>EmitNTP=
</varname></term>
1497 <term><varname>NTP=
</varname></term>
1499 <listitem><para>Similar to the
<varname>EmitDNS=
</varname> and
1500 <varname>DNS=
</varname> settings described above, these
1501 settings configure whether and what NTP server information
1502 shall be emitted as part of the DHCP lease. The same syntax,
1503 propagation semantics and defaults apply as for
1504 <varname>EmitDNS=
</varname> and
1505 <varname>DNS=
</varname>.
</para></listitem>
1509 <term><varname>EmitRouter=
</varname></term>
1511 <listitem><para>Similar to the
<varname>EmitDNS=
</varname>
1512 setting described above, this setting configures whether the
1513 DHCP lease should contain the router option. The same syntax,
1514 propagation semantics and defaults apply as for
1515 <varname>EmitDNS=
</varname>.
</para></listitem>
1519 <term><varname>EmitTimezone=
</varname></term>
1520 <term><varname>Timezone=
</varname></term>
1522 <listitem><para>Configures whether the DHCP leases handed out
1523 to clients shall contain timezone information. The
1524 <varname>EmitTimezone=
</varname> setting takes a boolean
1525 argument and defaults to
<literal>yes
</literal>. The
1526 <varname>Timezone=
</varname> setting takes a timezone string
1527 (such as
<literal>Europe/Berlin
</literal> or
1528 <literal>UTC
</literal>) to pass to clients. If no explicit
1529 timezone is set, the system timezone of the local host is
1530 propagated, as determined by the
1531 <filename>/etc/localtime
</filename> symlink.
</para></listitem>
1538 <title>[IPv6PrefixDelegation] Section Options
</title>
1539 <para>The
<literal>[IPv6PrefixDelegation]
</literal> section contains
1540 settings for sending IPv6 Router Advertisements and whether to act as
1541 a router, if enabled via the
<varname>IPv6PrefixDelegation=
</varname>
1542 option described above. IPv6 network prefixes are defined with one or
1543 more
<literal>[IPv6Prefix]
</literal> sections.
</para>
1545 <variablelist class='network-directives'
>
1548 <term><varname>Managed=
</varname></term>
1549 <term><varname>OtherInformation=
</varname></term>
1551 <listitem><para>Controls whether a DHCPv6 server is used to acquire IPv6
1552 addresses on the network link when
<varname>Managed=
</varname> boolean
1553 is set to
<literal>true
</literal> or if only additional network
1554 information can be obtained via DHCPv6 for the network link when
1555 <varname>OtherInformation=
</varname> boolean is set to
1556 <literal>true
</literal>. Both settings default to
1557 <literal>false
</literal>, which means that a DHCPv6 server is not being
1558 used.
</para></listitem>
1562 <term><varname>RouterLifetimeSec=
</varname></term>
1564 <listitem><para>Configures the IPv6 router lifetime in seconds. If set,
1565 this host also announces itself in Router Advertisements as an IPv6
1566 router for the network link. Defaults to unset, which means the host is
1567 not acting as a router.
</para>
1572 <term><varname>RouterPreference=
</varname></term>
1574 <listitem><para>Configures IPv6 router preference if
1575 <varname>RouterLifetimeSec=
</varname> is non-zero. Valid values are
1576 <literal>high
</literal>,
<literal>medium
</literal> and
1577 <literal>low
</literal>, with
<literal>normal
</literal> and
1578 <literal>default
</literal> added as synonyms for
1579 <literal>medium
</literal> just to make configuration easier. See
1580 <ulink url=
"https://tools.ietf.org/html/rfc4191">RFC
4191</ulink>
1581 for details. Defaults to
<literal>medium
</literal>.
</para></listitem>
1585 <term><varname>EmitDNS=
</varname></term>
1586 <term><varname>DNS=
</varname></term>
1588 <listitem><para><varname>DNS=
</varname> specifies a list of recursive
1589 DNS server IPv6 addresses that distributed via Router Advertisement
1590 messages when
<varname>EmitDNS=
</varname> is true. If
<varname>DNS=
1591 </varname> is empty, DNS servers are read from the
1592 <literal>[Network]
</literal> section. If the
1593 <literal>[Network]
</literal> section does not contain any DNS servers
1594 either, DNS servers from the uplink with the highest priority default
1595 route are used. When
<varname>EmitDNS=
</varname> is false, no DNS server
1596 information is sent in Router Advertisement messages.
1597 <varname>EmitDNS=
</varname> defaults to true.
1602 <term><varname>EmitDomains=
</varname></term>
1603 <term><varname>Domains=
</varname></term>
1605 <listitem><para>A list of DNS search domains distributed via Router
1606 Advertisement messages when
<varname>EmitDomains=
</varname> is true. If
1607 <varname>Domains=
</varname> is empty, DNS search domains are read from the
1608 <literal>[Network]
</literal> section. If the
<literal>[Network]
</literal>
1609 section does not contain any DNS search domains either, DNS search
1610 domains from the uplink with the highest priority default route are
1611 used. When
<varname>EmitDomains=
</varname> is false, no DNS search domain
1612 information is sent in Router Advertisement messages.
1613 <varname>EmitDomains=
</varname> defaults to true.
1618 <term><varname>DNSLifetimeSec=
</varname></term>
1620 <listitem><para>Lifetime in seconds for the DNS server addresses listed
1621 in
<varname>DNS=
</varname> and search domains listed in
1622 <varname>Domains=
</varname>.
</para></listitem>
1629 <title>[IPv6Prefix] Section Options
</title>
1630 <para>One or more
<literal>[IPv6Prefix]
</literal> sections contain the IPv6
1631 prefixes that are announced via Router Advertisements. See
1632 <ulink url=
"https://tools.ietf.org/html/rfc4861">RFC
4861</ulink>
1633 for further details.
</para>
1635 <variablelist class='network-directives'
>
1638 <term><varname>AddressAutoconfiguration=
</varname></term>
1639 <term><varname>OnLink=
</varname></term>
1641 <listitem><para>Boolean values to specify whether IPv6 addresses can be
1642 autoconfigured with this prefix and whether the prefix can be used for
1643 onlink determination. Both settings default to
<literal>true
</literal>
1644 in order to ease configuration.
1649 <term><varname>Prefix=
</varname></term>
1651 <listitem><para>The IPv6 prefix that is to be distributed to hosts.
1652 Similarly to configuring static IPv6 addresses, the setting is
1653 configured as an IPv6 prefix and its prefix length, separated by a
1654 <literal>/
</literal> character. Use multiple
1655 <literal>[IPv6Prefix]
</literal> sections to configure multiple IPv6
1656 prefixes since prefix lifetimes, address autoconfiguration and onlink
1657 status may differ from one prefix to another.
</para></listitem>
1661 <term><varname>PreferredLifetimeSec=
</varname></term>
1662 <term><varname>ValidLifetimeSec=
</varname></term>
1664 <listitem><para>Preferred and valid lifetimes for the prefix measured in
1665 seconds.
<varname>PreferredLifetimeSec=
</varname> defaults to
604800
1666 seconds (one week) and
<varname>ValidLifetimeSec=
</varname> defaults
1667 to
2592000 seconds (
30 days).
</para></listitem>
1674 <title>[Bridge] Section Options
</title>
1675 <para>The
<literal>[Bridge]
</literal> section accepts the
1676 following keys.
</para>
1677 <variablelist class='network-directives'
>
1679 <term><varname>UnicastFlood=
</varname></term>
1681 <para>A boolean. Controls whether the bridge should flood
1682 traffic for which an FDB entry is missing and the destination
1683 is unknown through this port. Defaults to unset.
1688 <term><varname>HairPin=
</varname></term>
1690 <para>A boolean. Configures whether traffic may be sent back
1691 out of the port on which it was received. Defaults to unset. When this
1692 flag is false, and the bridge will not forward traffic back
1693 out of the receiving port.
</para>
1697 <term><varname>UseBPDU=
</varname></term>
1699 <para>A boolean. Configures whether STP Bridge Protocol Data Units will be
1700 processed by the bridge port. Defaults to unset.
</para>
1704 <term><varname>FastLeave=
</varname></term>
1706 <para>A boolean. This flag allows the bridge to immediately stop multicast
1707 traffic on a port that receives an IGMP Leave message. It is only used with
1708 IGMP snooping if enabled on the bridge. Defaults to unset.
</para>
1712 <term><varname>AllowPortToBeRoot=
</varname></term>
1714 <para>A boolean. Configures whether a given port is allowed to
1715 become a root port. Only used when STP is enabled on the bridge.
1716 Defaults to unset.
</para>
1720 <term><varname>Cost=
</varname></term>
1722 <para>Sets the
"cost" of sending packets of this interface.
1723 Each port in a bridge may have a different speed and the cost
1724 is used to decide which link to use. Faster interfaces
1725 should have lower costs. It is an integer value between
1 and
1730 <term><varname>Priority=
</varname></term>
1732 <para>Sets the
"priority" of sending packets on this interface.
1733 Each port in a bridge may have a different priority which is used
1734 to decide which link to use. Lower value means higher priority.
1735 It is an integer value between
0 to
63. Networkd does not set any
1736 default, meaning the kernel default value of
32 is used.
</para>
1742 <title>[BridgeFDB] Section Options
</title>
1743 <para>The
<literal>[BridgeFDB]
</literal> section manages the
1744 forwarding database table of a port and accepts the following
1745 keys. Specify several
<literal>[BridgeFDB]
</literal> sections to
1746 configure several static MAC table entries.
</para>
1748 <variablelist class='network-directives'
>
1750 <term><varname>MACAddress=
</varname></term>
1752 <para>As in the
<literal>[Network]
</literal> section. This
1753 key is mandatory.
</para>
1757 <term><varname>VLANId=
</varname></term>
1759 <para>The VLAN ID for the new static MAC table entry. If
1760 omitted, no VLAN ID information is appended to the new static MAC
1768 <title>[CAN] Section Options
</title>
1769 <para>The
<literal>[CAN]
</literal> section manages the Controller Area Network (CAN bus) and accepts the
1770 following keys.
</para>
1771 <variablelist class='network-directives'
>
1773 <term><varname>BitRate=
</varname></term>
1775 <para>The bitrate of CAN device in bits per second. The usual SI prefixes (K, M) with the base of
1000 can
1776 be used here.
</para>
1780 <term><varname>SamplePoint=
</varname></term>
1782 <para>Optional sample point in percent with one decimal (e.g.
<literal>75%
</literal>,
1783 <literal>87.5%
</literal>) or permille (e.g.
<literal>875‰
</literal>).
</para>
1787 <term><varname>RestartSec=
</varname></term>
1789 <para>Automatic restart delay time. If set to a non-zero value, a restart of the CAN controller will be
1790 triggered automatically in case of a bus-off condition after the specified delay time. Subsecond delays can
1791 be specified using decimals (e.g.
<literal>0.1s
</literal>) or a
<literal>ms
</literal> or
1792 <literal>us
</literal> postfix. Using
<literal>infinity
</literal> or
<literal>0</literal> will turn the
1793 automatic restart off. By default automatic restart is disabled.
</para>
1800 <title>[BridgeVLAN] Section Options
</title>
1801 <para>The
<literal>[BridgeVLAN]
</literal> section manages the VLAN ID configuration of a bridge port and accepts
1802 the following keys. Specify several
<literal>[BridgeVLAN]
</literal> sections to configure several VLAN entries.
1803 The
<varname>VLANFiltering=
</varname> option has to be enabled, see
<literal>[Bridge]
</literal> section in
1804 <citerefentry><refentrytitle>systemd.netdev
</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
</para>
1806 <variablelist class='network-directives'
>
1808 <term><varname>VLAN=
</varname></term>
1810 <para>The VLAN ID allowed on the port. This can be either a single ID or a range M-N. VLAN IDs are valid
1811 from
1 to
4094.
</para>
1815 <term><varname>EgressUntagged=
</varname></term>
1817 <para>The VLAN ID specified here will be used to untag frames on egress. Configuring
1818 <varname>EgressUntagged=
</varname> implicates the use of
<varname>VLAN=
</varname> above and will enable the
1819 VLAN ID for ingress as well. This can be either a single ID or a range M-N.
</para>
1823 <term><varname>PVID=
</varname></term>
1825 <para>The Port VLAN ID specified here is assigned to all untagged frames at ingress.
1826 <varname>PVID=
</varname> can be used only once. Configuring
<varname>PVID=
</varname> implicates the use of
1827 <varname>VLAN=
</varname> above and will enable the VLAN ID for ingress as well.
</para>
1834 <title>Examples
</title>
1836 <title>Static network configuration
</title>
1838 <programlisting># /etc/systemd/network/
50-static.network
1843 Address=
192.168.0.15/
24
1844 Gateway=
192.168.0.1</programlisting>
1846 <para>This brings interface
<literal>enp2s0
</literal> up with a static address. The
1847 specified gateway will be used for a default route.
</para>
1851 <title>DHCP on ethernet links
</title>
1853 <programlisting># /etc/systemd/network/
80-dhcp.network
1858 DHCP=yes
</programlisting>
1860 <para>This will enable DHCPv4 and DHCPv6 on all interfaces with names starting with
1861 <literal>en
</literal> (i.e. ethernet interfaces).
</para>
1865 <title>A bridge with two enslaved links
</title>
1867 <programlisting># /etc/systemd/network/
25-bridge-static.network
1872 Address=
192.168.0.15/
24
1874 DNS=
192.168.0.1</programlisting>
1876 <programlisting># /etc/systemd/network/
25-bridge-slave-interface-
1.network
1881 Bridge=bridge0
</programlisting>
1883 <programlisting># /etc/systemd/network/
25-bridge-slave-interface-
2.network
1888 Bridge=bridge0
</programlisting>
1890 <para>This creates a bridge and attaches devices
<literal>enp2s0
</literal> and
1891 <literal>wlp3s0
</literal> to it. The bridge will have the specified static address
1892 and network assigned, and a default route via the specified gateway will be
1893 added. The specified DNS server will be added to the global list of DNS resolvers.
1901 # /etc/systemd/network/
20-bridge-slave-interface-vlan.network
1917 EgressUntagged=
300-
400</programlisting>
1919 <para>This overrides the configuration specified in the previous example for the
1920 interface
<literal>enp2s0
</literal>, and enables VLAN on that bridge port. VLAN IDs
1921 1-
32,
42,
100-
400 will be allowed. Packets tagged with VLAN IDs
42,
300-
400 will be
1922 untagged when they leave on this interface. Untagged packets which arrive on this
1923 interface will be assigned VLAN ID
42.
</para>
1927 <title>Various tunnels
</title>
1929 <programlisting>/etc/systemd/network/
25-tunnels.network
1940 <programlisting>/etc/systemd/network/
25-tunnel-ipip.netdev
1946 <programlisting>/etc/systemd/network/
25-tunnel-sit.netdev
1952 <programlisting>/etc/systemd/network/
25-tunnel-gre.netdev
1958 <programlisting>/etc/systemd/network/
25-tunnel-vti.netdev
1964 <para>This will bring interface
<literal>ens1
</literal> up and create an IPIP tunnel,
1965 a SIT tunnel, a GRE tunnel, and a VTI tunnel using it.
</para>
1969 <title>A bond device
</title>
1971 <programlisting># /etc/systemd/network/
30-bond1.network
1979 <programlisting># /etc/systemd/network/
30-bond1.netdev
1985 <programlisting># /etc/systemd/network/
30-bond1-dev1.network
1987 MACAddress=
52:
54:
00:e9:
64:
41
1993 <programlisting># /etc/systemd/network/
30-bond1-dev2.network
1995 MACAddress=
52:
54:
00:e9:
64:
42
2001 <para>This will create a bond device
<literal>bond1
</literal> and enslave the two
2002 devices with MAC addresses
52:
54:
00:e9:
64:
41 and
52:
54:
00:e9:
64:
42 to it. IPv6 DHCP
2003 will be used to acquire an address.
</para>
2007 <title>Virtual Routing and Forwarding (VRF)
</title>
2008 <para>Add the
<literal>bond1
</literal> interface to the VRF master interface
2009 <literal>vrf1
</literal>. This will redirect routes generated on this interface to be
2010 within the routing table defined during VRF creation. For kernels before
4.8 traffic
2011 won't be redirected towards the VRFs routing table unless specific ip-rules are added.
2013 <programlisting># /etc/systemd/network/
25-vrf.network
2023 <title>MacVTap
</title>
2024 <para>This brings up a network interface
<literal>macvtap-test
</literal>
2025 and attaches it to
<literal>enp0s25
</literal>.
</para>
2026 <programlisting># /usr/lib/systemd/network/
25-macvtap.network
2031 MACVTAP=macvtap-test
2037 <title>See Also
</title>
2039 <citerefentry><refentrytitle>systemd
</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
2040 <citerefentry><refentrytitle>systemd-networkd.service
</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
2041 <citerefentry><refentrytitle>systemd.link
</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
2042 <citerefentry><refentrytitle>systemd.netdev
</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
2043 <citerefentry><refentrytitle>systemd-resolved.service
</refentrytitle><manvolnum>8</manvolnum></citerefentry>
projects / thirdparty / systemd.git / blob