HALF ECHO LEARN / REFERENCE COLLECTION
v262.2man/systemd.network.xml
Git blob: e2c51fab906918295d81d99c105f64e31fc8a207
Lines 3001–4000 of 7,055
time between retries is increased exponentially, up to approximately one per minute, so the
network will not be overloaded even if this number is high. The default is suitable in most
circumstances.</para>
<xi:include href="version-info.xml" xpointer="v243"/>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>ListenPort=</varname></term>
<listitem>
<para>Set the port from which the DHCP client packets originate.</para>
<xi:include href="version-info.xml" xpointer="v233"/>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>ServerPort=</varname></term>
<listitem>
<para>Set the port on which the DHCP server is listening.</para>
<xi:include href="version-info.xml" xpointer="v256"/>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>DenyList=</varname></term>
<listitem>
<para>A whitespace-separated list of IPv4 addresses. Each address can optionally take a
prefix length after <literal>/</literal>. DHCP offers from servers in the list are rejected.
Note that if <varname>AllowList=</varname> is configured then <varname>DenyList=</varname> is
ignored.</para>
<para>Note that this filters only DHCP offers, so the filtering might not work when
<varname>RapidCommit=</varname> is enabled. See also <varname>RapidCommit=</varname> above.
</para>
<xi:include href="version-info.xml" xpointer="v246"/>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>AllowList=</varname></term>
<listitem>
<para>A whitespace-separated list of IPv4 addresses. Each address can optionally take a
prefix length after <literal>/</literal>. DHCP offers from servers in the list are accepted.
</para>
<para>Note that this filters only DHCP offers, so the filtering might not work when
<varname>RapidCommit=</varname> is enabled. See also <varname>RapidCommit=</varname> above.
</para>
<xi:include href="version-info.xml" xpointer="v246"/>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>SendRelease=</varname></term>
<listitem>
<para>When true, the DHCPv4 client sends a DHCP release packet when it stops. Defaults to
true.</para>
<xi:include href="version-info.xml" xpointer="v243"/>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>SendDecline=</varname></term>
<listitem>
<para>A boolean. When true, <command>systemd-networkd</command> performs IPv4 Duplicate
Address Detection to the acquired address by the DHCPv4 client. If duplicate is detected,
the DHCPv4 client rejects the address by sending a <constant>DHCPDECLINE</constant> packet to
the DHCP server, and tries to obtain an IP address again. See
<ulink url="https://tools.ietf.org/html/rfc5227">RFC 5227</ulink>. Defaults to false.</para>
<xi:include href="version-info.xml" xpointer="v245"/>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>NetLabel=</varname></term>
<listitem>
<para>This applies the NetLabel for the addresses received with DHCP, like
<varname>NetLabel=</varname> in [Address] section applies it to statically configured
addresses. See <varname>NetLabel=</varname> in [Address] section for more details.</para>
<xi:include href="version-info.xml" xpointer="v252"/>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>NFTSet=</varname></term>
<listitem>
<para>This applies the NFT set for the network configuration received with DHCP, like
<varname>NFTSet=</varname> in [Address] section applies it to static configuration. See
<varname>NFTSet=</varname> in [Address] section for more details. For <literal>address</literal> or
<literal>prefix</literal> source types, the type of the element used in the NFT filter must be
<literal>ipv4_addr</literal>.</para>
<xi:include href="version-info.xml" xpointer="v255"/>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>[DHCPv6] Section Options</title>
<para>The [DHCPv6] section configures the DHCPv6 client, if it is enabled with the
<varname>DHCP=</varname> setting described above, or invoked by the IPv6 Router Advertisement:
</para>
<variablelist class='network-directives'>
<!-- DHCP packet contents -->
<varlistentry>
<term><varname>MUDURL=</varname></term>
<term><varname>IAID=</varname></term>
<term><varname>DUIDType=</varname></term>
<term><varname>DUIDRawData=</varname></term>
<term><varname>RequestOptions=</varname></term>
<listitem>
<para>As in the [DHCPv4] section.</para>
<xi:include href="version-info.xml" xpointer="v246"/>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>SendOption=</varname></term>
<listitem>
<para>As in the [DHCPv4] section, however because DHCPv6 uses 16-bit fields to store option
numbers, the option number is an integer in the range 1…65536.</para>
<xi:include href="version-info.xml" xpointer="v246"/>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>SendVendorOption=</varname></term>
<listitem>
<para>Send an arbitrary vendor option in the DHCPv6 request. Takes an enterprise identifier,
DHCP option number, data type, and data separated with a colon
(<literal><replaceable>enterprise identifier</replaceable>:<replaceable>option</replaceable>:<replaceable>type</replaceable>:<replaceable>value</replaceable></literal>).
Enterprise identifier is an unsigned integer in the range 1…4294967294. The option number
must be an integer in the range 1…254. Data type takes one of <literal>uint8</literal>,
<literal>uint16</literal>, <literal>uint32</literal>, <literal>ipv4address</literal>,
<literal>ipv6address</literal>, or <literal>string</literal>. Special characters in the data
string may be escaped using
<ulink url="https://en.wikipedia.org/wiki/Escape_sequences_in_C#Table_of_escape_sequences">C-style
escapes</ulink>. This setting can be specified multiple times. If an empty string is
specified, then all options specified earlier are cleared. Defaults to unset.</para>
<xi:include href="version-info.xml" xpointer="v246"/>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>UserClass=</varname></term>
<listitem>
<para>A DHCPv6 client can use User Class option to identify the type or category of user or
applications it represents. The information contained in this option is a string that
represents the user class of which the client is a member. Each class sets an identifying
string of information to be used by the DHCP service to classify clients. Special characters
in the data string may be escaped using
<ulink url="https://en.wikipedia.org/wiki/Escape_sequences_in_C#Table_of_escape_sequences">C-style
escapes</ulink>. This setting can be specified multiple times. If an empty string is
specified, then all options specified earlier are cleared. Takes a whitespace-separated list
of strings. Note that currently <constant>NUL</constant> bytes are not allowed.</para>
<xi:include href="version-info.xml" xpointer="v246"/>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>VendorClass=</varname></term>
<listitem>
<para>A DHCPv6 client can use VendorClass option to identify the vendor that manufactured the
hardware on which the client is running. The information contained in the data area of this
option is contained in one or more opaque fields that identify details of the hardware
configuration. Takes a whitespace-separated list of strings.</para>
<xi:include href="version-info.xml" xpointer="v246"/>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>PrefixDelegationHint=</varname></term>
<listitem>
<para>Takes an IPv6 address with prefix length in the same format as the
<varname>Address=</varname> in the [Network] section. The DHCPv6 client will include a prefix
hint in the DHCPv6 solicitation sent to the server. The prefix length must be in the range
1…128. Defaults to unset.</para>
<xi:include href="version-info.xml" xpointer="v244"/>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>UnassignedSubnetPolicy=</varname></term>
<listitem>
<para>Takes <literal>none</literal> or one of the reject types: <literal>unreachable</literal>,
<literal>prohibit</literal>, <literal>blackhole</literal>, or <literal>throw</literal>. If a reject
type is specified, the reject route corresponding to the delegated prefix will be configured.
For example, when <literal>unreachable</literal>,
<programlisting>unreachable 2001:db8::/56 dev lo proto dhcp metric 1024 pref medium</programlisting>
will be configured. See <ulink url="https://datatracker.ietf.org/doc/html/rfc7084">RFC 7084</ulink>.
If <literal>none</literal> is specified, such route will not be configured. This may be useful when
custom firewall rules that handle packets for unassigned subnets will be configured.
Defaults to <literal>unreachable</literal>.</para>
<xi:include href="version-info.xml" xpointer="v257"/>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>RouteTable=<replaceable>num</replaceable></varname></term>
<listitem>
<para>The table identifier for routes installed by the DHCPv6 client, e.g. unreachable
routes for delegated prefixes. Takes one of the predefined names <literal>default</literal>,
<literal>main</literal>, and <literal>local</literal>, names defined in
<varname>RouteTable=</varname> in
<citerefentry><refentrytitle>networkd.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
or a number between 1…4294967295.</para>
<para>When used in combination with <varname>VRF=</varname>, the VRF's routing table is
used when this parameter is not specified.</para>
<xi:include href="version-info.xml" xpointer="v261"/>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>RapidCommit=</varname></term>
<listitem>
<para>Takes a boolean. The DHCPv6 client can obtain configuration parameters from a DHCPv6 server
through a rapid two-message exchange (solicit and reply). When the rapid commit option is set by
both the DHCPv6 client and the DHCPv6 server, the two-message exchange is used. Otherwise, the
four-message exchange (solicit, advertise, request, and reply) is used. The two-message exchange
provides faster client configuration. See
<ulink url="https://tools.ietf.org/html/rfc3315#section-17.2.1">RFC 3315</ulink> for details.
Defaults to true, and the two-message exchange will be used if the server support it.</para>
<xi:include href="version-info.xml" xpointer="v252"/>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>SendHostname=</varname></term>
<listitem>
<para>When true (the default), the machine's hostname (or the value specified with
<varname>Hostname=</varname>, described below) will be sent to the DHCPv6 server. Note that the
hostname must consist only of 7-bit ASCII lower-case characters and no spaces or dots, and be
formatted as a valid DNS domain name. Otherwise, the hostname is not sent even if this option
is true.</para>
<xi:include href="version-info.xml" xpointer="v255"/>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>Hostname=</varname></term>
<listitem>
<para>Use this value for the hostname which is sent to the DHCPv6 server, instead of machine's
hostname. Note that the specified hostname must consist only of 7-bit ASCII lower-case
characters and no spaces or dots, and be formatted as a valid DNS domain name.</para>
<xi:include href="version-info.xml" xpointer="v255"/>
</listitem>
</varlistentry>
<!-- How to use the DHCP lease -->
<varlistentry>
<term><varname>UseAddress=</varname></term>
<listitem>
<para>When true (the default), the IP addresses provided by the DHCPv6 server will be
assigned.</para>
<xi:include href="version-info.xml" xpointer="v248"/>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>UseCaptivePortal=</varname></term>
<listitem>
<para>When true (the default), the captive portal advertised by the DHCPv6 server will be recorded
and made available to client programs and displayed in the
<citerefentry><refentrytitle>networkctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>
status output per-link.</para>
<xi:include href="version-info.xml" xpointer="v254"/>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>UseDelegatedPrefix=</varname></term>
<listitem>
<para>When true (the default), the client will request the DHCPv6 server to delegate
prefixes. If the server provides prefixes to be delegated, then subnets of the prefixes are
assigned to the interfaces that have <varname>DHCPPrefixDelegation=yes</varname>.
See also the <varname>DHCPPrefixDelegation=</varname> setting in the [Network] section,
settings in the [DHCPPrefixDelegation] section, and
<ulink url="https://www.rfc-editor.org/rfc/rfc8415.html#section-6.3">RFC 8415</ulink>.
</para>
<xi:include href="version-info.xml" xpointer="v250"/>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>UseDNS=</varname></term>
<term><varname>UseDNR=</varname></term>
<term><varname>UseNTP=</varname></term>
<term><varname>UseSIP=</varname></term>
<term><varname>UseHostname=</varname></term>
<term><varname>UseDomains=</varname></term>
<term><varname>NetLabel=</varname></term>
<term><varname>SendRelease=</varname></term>
<listitem>
<para>As in the [DHCPv4] section.</para>
<xi:include href="version-info.xml" xpointer="v243"/>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>NFTSet=</varname></term>
<listitem>
<para>This applies the NFT set for the network configuration received with DHCP, like
<varname>NFTSet=</varname> in [Address] section applies it to static configuration. See
<varname>NFTSet=</varname> in [Address] section for more details. For <literal>address</literal>
or <literal>prefix</literal> source types, the type of the element used in the NFT filter must be
<literal>ipv6_addr</literal>.</para>
<xi:include href="version-info.xml" xpointer="v255"/>
</listitem>
</varlistentry>
<!-- How to communicate with the server -->
<varlistentry>
<term><varname>WithoutRA=</varname></term>
<listitem>
<para>Allows DHCPv6 client to start without router advertisements's
<literal>managed</literal> or <literal>other configuration</literal> flag. Takes one of
<literal>no</literal>, <literal>solicit</literal>, or
<literal>information-request</literal>. If this is not specified,
<literal>solicit</literal> is used when <varname>DHCPPrefixDelegation=</varname> is enabled
and <varname>UplinkInterface=:self</varname> is specified in the [DHCPPrefixDelegation]
section. Otherwise, defaults to <literal>no</literal>, and the DHCPv6 client will be started
when an RA is received. See also the <varname>DHCPv6Client=</varname> setting in the
[IPv6AcceptRA] section.</para>
<xi:include href="version-info.xml" xpointer="v246"/>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>[DHCPPrefixDelegation] Section Options</title>
<para>The [DHCPPrefixDelegation] section configures subnet prefixes of the delegated prefixes
acquired by a DHCPv6 client or by a DHCPv4 client through the 6RD option on another interface.
The settings in this section are used only when the <varname>DHCPPrefixDelegation=</varname>
setting in the [Network] section is enabled.</para>
<variablelist class='network-directives'>
<varlistentry>
<term><varname>UplinkInterface=</varname></term>
<listitem>
<para>Specifies the name or the index of the uplink interface, or one of the special values
<literal>:self</literal> and <literal>:auto</literal>. When <literal>:self</literal>, the
interface itself is considered the uplink interface, and
<varname>WithoutRA=solicit</varname> is implied if the setting is not explicitly specified.
When <literal>:auto</literal>, the first link which acquired prefixes to be delegated from
the DHCPv6 or DHCPv4 server is selected. Defaults to <literal>:auto</literal>.</para>
<xi:include href="version-info.xml" xpointer="v250"/>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>SubnetId=</varname></term>
<listitem>
<para>Configure a specific subnet ID on the interface from a (previously) received prefix
delegation. You can either set "auto" (the default) or a specific subnet ID (as defined in
<ulink url="https://tools.ietf.org/html/rfc4291#section-2.5.4">RFC 4291</ulink>, section
2.5.4), in which case the allowed value is hexadecimal, from 0 to 0x7fffffffffffffff
inclusive.</para>
<xi:include href="version-info.xml" xpointer="v246"/>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>Announce=</varname></term>
<listitem>
<para>Takes a boolean. When enabled, and <varname>IPv6SendRA=</varname> in [Network] section
is enabled, the delegated prefixes are distributed through the IPv6 Router Advertisement.
This setting will be ignored when the <varname>DHCPPrefixDelegation=</varname> setting is
enabled on the upstream interface. Defaults to yes.</para>
<xi:include href="version-info.xml" xpointer="v247"/>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>Assign=</varname></term>
<listitem>
<para>Takes a boolean. Specifies whether to add an address from the delegated prefixes which
are received from the WAN interface by the DHCPv6 Prefix Delegation. When true (on LAN
interface), the EUI-64 algorithm will be used by default to form an interface identifier from
the delegated prefixes. See also <varname>Token=</varname> setting below. Defaults to yes.
</para>
<xi:include href="version-info.xml" xpointer="v246"/>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>Token=</varname></term>
<listitem>
<para>Specifies an optional address generation mode for assigning an address in each
delegated prefix. This accepts the same syntax as <varname>Token=</varname> in the
[IPv6AcceptRA] section. If <varname>Assign=</varname> is set to false, then this setting will
be ignored. Defaults to unset, which means the EUI-64 algorithm will be used.</para>
<xi:include href="version-info.xml" xpointer="v246"/>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>ManageTemporaryAddress=</varname></term>
<listitem>
<para>As in the [Address] section, but defaults to true.</para>
<xi:include href="version-info.xml" xpointer="v248"/>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>RouteMetric=</varname></term>
<listitem>
<para>The metric of the route to the delegated prefix subnet. Takes an unsigned integer in
the range 0…4294967295. When set to 0, the kernel's default value is used. Defaults to 256.
</para>
<xi:include href="version-info.xml" xpointer="v249"/>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>NetLabel=</varname></term>
<listitem>
<para>This applies the NetLabel for the addresses received with DHCP, like
<varname>NetLabel=</varname> in [Address] section applies it to statically configured
addresses. See <varname>NetLabel=</varname> in [Address] section for more details.</para>
<xi:include href="version-info.xml" xpointer="v252"/>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>NFTSet=</varname></term>
<listitem>
<para>This applies the NFT set for the network configuration received with DHCP, like
<varname>NFTSet=</varname> in [Address] section applies it to static configuration. See
<varname>NFTSet=</varname> in [Address] section for more details. For <literal>address</literal> or
<literal>prefix</literal> source types, the type of the element used in the NFT filter must be
<literal>ipv6_addr</literal>.</para>
<xi:include href="version-info.xml" xpointer="v255"/>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>[IPv6AcceptRA] Section Options</title>
<para>The [IPv6AcceptRA] section configures the IPv6 Router Advertisement (RA) client, if it is enabled
with the <varname>IPv6AcceptRA=</varname> setting described above:</para>
<variablelist class='network-directives'>
<varlistentry>
<term><varname>UseRedirect=</varname></term>
<listitem>
<para>When true (the default), Redirect message sent by the current first-hop router will be
accepted, and routes to redirected nodes will be configured.</para>
<xi:include href="version-info.xml" xpointer="v256"/>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>Token=</varname></term>
<listitem>
<para>Specifies an optional address generation mode for the Stateless Address
Autoconfiguration (SLAAC). The following values are supported:</para>
<variablelist>
<varlistentry>
<term><option>eui64</option></term>
<listitem>
<para>
The EUI-64 algorithm will be used to generate an address for that prefix. Only
supported by Ethernet or InfiniBand interfaces.
</para>
<xi:include href="version-info.xml" xpointer="v250"/>
</listitem>
</varlistentry>
<varlistentry>
<term><option>static:<replaceable>ADDRESS</replaceable></option></term>
<listitem>
<para>
An IPv6 address must be specified after a colon (<literal>:</literal>), and the
lower bits of the supplied address are combined with the upper bits of a prefix
received in a Router Advertisement (RA) message to form a complete address. Note
that if multiple prefixes are received in an RA message, or in multiple RA messages,
addresses will be formed from each of them using the supplied address. This mode
implements SLAAC but uses a static interface identifier instead of an identifier
generated by using the EUI-64 algorithm. Because the interface identifier is static,
if Duplicate Address Detection detects that the computed address is a duplicate
(in use by another node on the link), then this mode will fail to provide an address
for that prefix. If an IPv6 address without <literal>static</literal> is specified, then
<literal>static</literal> mode is assumed.
</para>
<xi:include href="version-info.xml" xpointer="v250"/>
</listitem>
</varlistentry>
<varlistentry>
<term><option>prefixstable[:<replaceable>ADDRESS</replaceable>][,<replaceable>UUID</replaceable>]</option></term>
<listitem>
<para>
The algorithm specified in
<ulink url="https://tools.ietf.org/html/rfc7217">RFC 7217</ulink> will be used to
generate interface identifiers. This mode can optionally take an IPv6 address
separated with a colon (<literal>:</literal>). If an IPv6 address is specified,
then an interface identifier is generated only when a prefix received in an RA
message matches the supplied address.
</para>
<para>
This mode can also optionally take a non-null UUID in the format which
<function>sd_id128_from_string()</function> accepts, e.g.
<literal>86b123b969ba4b7eb8b3d8605123525a</literal> or
<literal>86b123b9-69ba-4b7e-b8b3-d8605123525a</literal>. If a UUID is specified, the
value is used as the secret key to generate interface identifiers. If not specified,
then an application specific ID generated with the system's machine-ID will be used
as the secret key. See
<citerefentry><refentrytitle>sd-id128</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
<citerefentry><refentrytitle>sd_id128_from_string</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
and
<citerefentry><refentrytitle>sd_id128_get_machine</refentrytitle><manvolnum>3</manvolnum></citerefentry>.
</para>
<para>
Note that the <literal>prefixstable</literal> algorithm uses both the interface
name and MAC address as input to the hash to compute the interface identifier, so
if either of those are changed the resulting interface identifier (and address)
will be changed, even if the prefix received in the RA message has not been
changed.
</para>
<xi:include href="version-info.xml" xpointer="v250"/>
</listitem>
</varlistentry>
</variablelist>
<para>If no address generation mode is specified (which is the default), or a received
prefix does not match any of the addresses provided in <literal>prefixstable</literal>
mode, then the EUI-64 algorithm will be used for Ethernet or InfiniBand interfaces,
otherwise <literal>prefixstable</literal> will be used to form an interface identifier for
that prefix.</para>
<para>This setting can be specified multiple times. If an empty string is assigned, then
the all previous assignments are cleared.</para>
<para>Examples:
<programlisting>Token=eui64
Token=::1a:2b:3c:4d
Token=static:::1a:2b:3c:4d
Token=prefixstable
Token=prefixstable:2002:da8:1::</programlisting></para>
<xi:include href="version-info.xml" xpointer="v250"/>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>UseDNS=</varname></term>
<listitem>
<para>When true (the default), the DNS servers received in the Router Advertisement will be used.</para>
<para>This corresponds to the <option>nameserver</option> option in <citerefentry
project='man-pages'><refentrytitle>resolv.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para>
<xi:include href="version-info.xml" xpointer="v231"/>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>UseDNR=</varname></term>
<listitem>
<para> When true, the DNR servers received in the Router Advertisement will be used. Defaults to
the value of <option>UseDNS=</option>.</para>
<xi:include href="version-info.xml" xpointer="v257"/>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>UseDomains=</varname></term>
<listitem>
<para>Takes a boolean, or the special value <literal>route</literal>. When true, the domain name
received via IPv6 Router Advertisement (RA) will be used as DNS search domain over this link,
similarly to the effect of the <option>Domains=</option> setting. If set to
<literal>route</literal>, the domain name received via IPv6 RA will be used for routing DNS queries
only, but not for searching, similarly to the effect of the <option>Domains=</option> setting when
the argument is prefixed with <literal>~</literal>. Defaults to false.</para>
<para>It is recommended to enable this option only on trusted networks, as setting this affects resolution
of all hostnames, in particular of single-label names. It is generally safer to use the supplied domain
only as routing domain, rather than as search domain, in order to not have it affect local resolution of
single-label names.</para>
<para>When set to true, this setting corresponds to the <option>domain</option> option in <citerefentry
project='man-pages'><refentrytitle>resolv.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para>
<xi:include href="version-info.xml" xpointer="v231"/>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>RouteTable=<replaceable>num</replaceable></varname></term>
<listitem>
<para>The table identifier for the routes received in the Router Advertisement. Takes one of
predefined names <literal>default</literal>, <literal>main</literal>, and <literal>local</literal>,
and names defined in <varname>RouteTable=</varname> in
<citerefentry><refentrytitle>networkd.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
or a number between 1…4294967295.</para>
<para>When used in combination with <varname>VRF=</varname>, the VRF's routing table is
used when this parameter is not specified.</para>
<xi:include href="version-info.xml" xpointer="v232"/>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>RouteMetric=</varname></term>
<listitem>
<para>Set the routing metric for the routes received in the Router Advertisement. Takes an unsigned
integer in the range 0…4294967295, or three unsigned integer separated with <literal>:</literal>,
in that case the first one is used when the router preference is high, the second is for medium
preference, and the last is for low preference
(<literal><replaceable>high</replaceable>:<replaceable>medium</replaceable>:<replaceable>low</replaceable></literal>).
Defaults to <literal>512:1024:2048</literal>.</para>
<xi:include href="version-info.xml" xpointer="v249"/>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>QuickAck=</varname></term>
<listitem>
<para>Takes a boolean. When true, the TCP quick ACK mode is enabled for the routes configured by
the received RAs. When unset, the kernel's default will be used.</para>
<xi:include href="version-info.xml" xpointer="v253"/>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>UseMTU=</varname></term>
<listitem>
<para>Takes a boolean. When true, the MTU received in the Router Advertisement will be
used. Defaults to true.</para>
<xi:include href="version-info.xml" xpointer="v250"/>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>UseHopLimit=</varname></term>
<listitem>
<para>Takes a boolean. When true, the hop limit received in the Router Advertisement will be set to routes
configured based on the advertisement. See also <varname>IPv6HopLimit=</varname>. Defaults to true.</para>
<xi:include href="version-info.xml" xpointer="v255"/>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>UseReachableTime=</varname></term>
<listitem>
<para>Takes a boolean. When true, the reachable time received in the Router Advertisement will be
set on the interface receiving the advertisement. It is used as the base timespan of the validity
of a neighbor entry. Defaults to true.</para>
<xi:include href="version-info.xml" xpointer="v256"/>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>UseRetransmissionTime=</varname></term>
<listitem>
<para>Takes a boolean. When true, the retransmission time received in the Router Advertisement will be set
on the interface receiving the advertisement. It is used as the time between retransmissions of Neighbor
Solicitation messages to a neighbor when resolving the address or when probing the reachability of a neighbor.
Defaults to true.</para>
<xi:include href="version-info.xml" xpointer="v256"/>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>UseGateway=</varname></term>
<listitem>
<para>When true (the default), the router address will be configured as the default gateway.
</para>
<xi:include href="version-info.xml" xpointer="v250"/>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>UseRoutePrefix=</varname></term>
<listitem>
<para>When true (the default), the routes corresponding to the route prefixes received in
the Router Advertisement will be configured.</para>
<xi:include href="version-info.xml" xpointer="v250"/>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>UseCaptivePortal=</varname></term>
<listitem>
<para>When true (the default), the captive portal received in the Router Advertisement will be recorded
and made available to client programs and displayed in the
<citerefentry><refentrytitle>networkctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>
status output per-link.</para>
<xi:include href="version-info.xml" xpointer="v254"/>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>UsePREF64=</varname></term>
<listitem>
<para>When true, the IPv6 PREF64 (or NAT64) prefixes received in the Router Advertisement will be
recorded and made available to client programs and displayed in the
<citerefentry><refentrytitle>networkctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>
status output per-link. See <ulink url="https://tools.ietf.org/html/rfc8781">RFC 8781</ulink>.
Defaults to false.</para>
<xi:include href="version-info.xml" xpointer="v255"/>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>UseAutonomousPrefix=</varname></term>
<listitem>
<para>When true (the default), the autonomous prefix received in the Router Advertisement will be used and take
precedence over any statically configured ones.</para>
<xi:include href="version-info.xml" xpointer="v242"/>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>UseOnLinkPrefix=</varname></term>
<listitem>
<para>When true (the default), the onlink prefix received in the Router Advertisement will be
used and takes precedence over any statically configured ones.</para>
<xi:include href="version-info.xml" xpointer="v242"/>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>RouterDenyList=</varname></term>
<listitem>
<para>A whitespace-separated list of IPv6 router addresses. Each address can optionally
take a prefix length after <literal>/</literal>. Any information advertised by the listed
router is ignored.</para>
<xi:include href="version-info.xml" xpointer="v248"/>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>RouterAllowList=</varname></term>
<listitem>
<para>A whitespace-separated list of IPv6 router addresses. Each address can optionally
take a prefix length after <literal>/</literal>. Only information advertised by the listed
router is accepted. Note that if <varname>RouterAllowList=</varname> is configured then
<varname>RouterDenyList=</varname> is ignored.</para>
<xi:include href="version-info.xml" xpointer="v248"/>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>PrefixDenyList=</varname></term>
<listitem>
<para>A whitespace-separated list of IPv6 prefixes. Each prefix can optionally take its
prefix length after <literal>/</literal>. IPv6 prefixes supplied via router advertisements
in the list are ignored.</para>
<xi:include href="version-info.xml" xpointer="v248"/>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>PrefixAllowList=</varname></term>
<listitem>
<para>A whitespace-separated list of IPv6 prefixes. Each prefix can optionally take its
prefix length after <literal>/</literal>. IPv6 prefixes supplied via router advertisements
in the list are allowed. Note that if <varname>PrefixAllowList=</varname> is configured
then <varname>PrefixDenyList=</varname> is ignored.</para>
<xi:include href="version-info.xml" xpointer="v248"/>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>RouteDenyList=</varname></term>
<listitem>
<para>A whitespace-separated list of IPv6 route prefixes. Each prefix can optionally take
its prefix length after <literal>/</literal>. IPv6 route prefixes supplied via router
advertisements in the list are ignored.</para>
<xi:include href="version-info.xml" xpointer="v248"/>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>RouteAllowList=</varname></term>
<listitem>
<para>A whitespace-separated list of IPv6 route prefixes. Each prefix can optionally take
its prefix length after <literal>/</literal>. IPv6 route prefixes supplied via router
advertisements in the list are allowed. Note that if <varname>RouteAllowList=</varname> is
configured then <varname>RouteDenyList=</varname> is ignored.</para>
<xi:include href="version-info.xml" xpointer="v248"/>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>DHCPv6Client=</varname></term>
<listitem>
<para>Takes a boolean, or the special value <literal>always</literal>. When true, the
DHCPv6 client will be started in <literal>solicit</literal> mode if the RA has the
<literal>managed</literal> flag or <literal>information-request</literal> mode if the RA
lacks the <literal>managed</literal> flag but has the
<literal>other configuration</literal> flag. If set to <literal>always</literal>, the
DHCPv6 client will be started in <literal>solicit</literal> mode when an RA is received,
even if neither the <literal>managed</literal> nor the
<literal>other configuration</literal> flag is set in the RA. This will be ignored when
<varname>WithoutRA=</varname> in the [DHCPv6] section is enabled, or
<varname>UplinkInterface=:self</varname> in the [DHCPPrefixDelegation] section is
specified. Defaults to true.</para>
<xi:include href="version-info.xml" xpointer="v246"/>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>NetLabel=</varname></term>
<listitem>
<para>This applies the NetLabel for the addresses received with RA, like
<varname>NetLabel=</varname> in [Address] section applies it to statically configured
addresses. See <varname>NetLabel=</varname> in [Address] section for more details.</para>
<xi:include href="version-info.xml" xpointer="v252"/>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>NFTSet=</varname></term>
<listitem>
<para>This applies the NFT set for the network configuration received with RA, like
<varname>NFTSet=</varname> in [Address] section applies it to static configuration. See
<varname>NFTSet=</varname> in [Address] section for more details. For <literal>address</literal> or
<literal>prefix</literal> source types, the type of the element used in the NFT filter must be
<literal>ipv6_addr</literal>.</para>
<xi:include href="version-info.xml" xpointer="v255"/>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>[DHCPRelay] Section Options</title>
<para>The [DHCPRelay] section contains per-interface settings for the DHCP relay agent. The settings in
this section are only used when <varname>DHCPRelay=</varname> in the [Network] section is configured.
</para>
<variablelist class='network-directives'>
<varlistentry>
<term><varname>AgentAddress=</varname></term>
<listitem>
<para>Takes an IPv4 address. The specified address is used as the source IP address of packets
forwarded to the upstream DHCP server. The address may also be used for the Server Identifier
Override sub-option and the Link Selection sub-option in the Relay Agent Information option
appended to DHCP messages forwarded to the upstream DHCP server. This setting applies to both
upstream and downstream interfaces. Defaults to unset. If unset, a statically configured IPv4
address in the .network file is selected automatically. When multiple static IPv4 addresses are
configured, it is recommended to specify this setting explicitly.</para>
<xi:include href="version-info.xml" xpointer="v261"/>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>GatewayAddress=</varname></term>
<listitem>
<para>Takes an IPv4 address. The specified address is set to the <literal>giaddr</literal> field of
the DHCP message header when the DHCP message is forwarded to the upstream DHCP server. This is
used only when <varname>DHCPRelay=downstream</varname>, and ignored otherwise. Defaults to unset,
and the same address specified with <varname>AgentAddress=</varname> will be used.</para>
<xi:include href="version-info.xml" xpointer="v261"/>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>CircuitId=</varname></term>
<listitem>
<para>Specifies the circuit ID of the downstream interface. This is set as the Circuit ID
sub-option in the Relay Agent Information option in the forwarded DHCP message. Takes a data type
and data separated with a colon
(<literal><replaceable>type</replaceable>:<replaceable>value</replaceable></literal>). The type
takes one of <literal>uint8</literal>, <literal>uint16</literal>, <literal>uint32</literal>,
<literal>ipv4address</literal>, <literal>ipv6address</literal>, or <literal>string</literal>.
Special characters in the data string may be escaped using
<ulink url="https://en.wikipedia.org/wiki/Escape_sequences_in_C#Table_of_escape_sequences">C-style escapes</ulink>.
This is used only when <varname>DHCPRelay=downstream</varname>, and ignored otherwise. If unset,
the name of the interface will be used.</para>
<xi:include href="version-info.xml" xpointer="v261"/>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>VirtualSubnetSelection=</varname></term>
<listitem>
<para>Specifies a unique identifier used by the DHCP server to select the downstream subnet
independently of giaddr. This value is used as the Virtual Subnet Selection sub-option in the Relay
Agent Information option in the forwarded DHCP message. Takes a value in the same format as
<varname>CircuitId=</varname>. This is used only when <varname>DHCPRelay=downstream</varname>, and
ignored otherwise. Defaults to unset, and the sub-option is not set.</para>
<xi:include href="version-info.xml" xpointer="v261"/>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>ExtraOption=</varname></term>
<listitem>
<para>Specifies an extra sub-option in the Relay Agent Information option, which is appended to
DHCP messages forwarded to the upstream DHCP server. Takes a sub-option code, data type, and data
separated with a colon
(<literal><replaceable>code</replaceable>:<replaceable>type</replaceable>:<replaceable>value</replaceable></literal>).
The code is an integer in 1…254. See <varname>CircuitId=</varname> in the above for the acceptable
type and data. This setting can be specified multiple times. When an empty string is specified,
all previous assignments are cleared. This is used only when
<varname>DHCPRelay=downstream</varname>, and ignored otherwise. Defaults to unset, and no extra
sub-option will be appended.</para>
<xi:include href="version-info.xml" xpointer="v261"/>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>InterfacePriority=</varname></term>
<listitem>
<para>Specifies the priority of the upstream interface. Takes an integer value. When the host has
multiple upstream interfaces, the upstream interface with the highest (largest) priority will be
used for forwarding DHCP messages to the upstream DHCP server. When multiple interfaces have the
same priority, which interface is used is unspecified. This is used only when
<varname>DHCPRelay=upstream</varname>, and ignored otherwise. Defaults to zero.</para>
<xi:include href="version-info.xml" xpointer="v261"/>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>[DHCPServer] Section Options</title>
<para>The [DHCPServer] section contains settings for the DHCP server, if enabled via the
<varname>DHCPServer=</varname> option described above:</para>
<variablelist class='network-directives'>