HALF ECHO LEARN / REFERENCE COLLECTION

v262.2

man/systemd.network.xml

332,374 bytesGit mode 100644Download original fileLGPL-2.1-or-later

Git blob: e2c51fab906918295d81d99c105f64e31fc8a207

Lines 4001–5000 of 7,055

      <varlistentry>
        <term><varname>ServerAddress=</varname></term>
        <listitem>
          <para>Specifies the server address for the DHCP server. Takes an IPv4 address with prefix length
          separated with a slash, e.g. <literal>192.168.0.1/24</literal>. Defaults to unset, and one of
          static IPv4 addresses configured in [Network] or [Address] section will be automatically selected.
          This setting may be useful when the interface on which the DHCP server is running has multiple
          static IPv4 addresses.</para>
          <para>This implies <varname>Address=</varname> in [Network] or [Address] section with the same
          address and prefix length. That is,
          <programlisting>[Network]
DHCPServer=yes
Address=192.168.0.1/24
Address=192.168.0.2/24
[DHCPServer]
ServerAddress=192.168.0.1/24</programlisting>
          or
          <programlisting>[Network]
DHCPServer=yes
[Address]
Address=192.168.0.1/24
[Address]
Address=192.168.0.2/24
[DHCPServer]
ServerAddress=192.168.0.1/24</programlisting>
          are equivalent to the following:
          <programlisting>[Network]
DHCPServer=yes
Address=192.168.0.2/24
[DHCPServer]
ServerAddress=192.168.0.1/24</programlisting>
          </para>
          <para>Since version 255, like the <varname>Address=</varname> setting in [Network] or [Address]
          section, this also supports a null address, e.g. <literal>0.0.0.0/24</literal>, and an unused
          address will be automatically selected. For more details about the automatic address selection,
          see <varname>Address=</varname> setting in [Network] section in the above.</para>
 
          <xi:include href="version-info.xml" xpointer="v249"/>
        </listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>PoolOffset=</varname></term>
        <term><varname>PoolSize=</varname></term>
 
        <listitem><para>Configures the pool of addresses to hand out. The pool
        is a contiguous sequence of IP addresses in the subnet configured for
        the server address, which does not include the subnet nor the broadcast
        address. <varname>PoolOffset=</varname> takes the offset of the pool
        from the start of subnet, or zero to use the default value.
        <varname>PoolSize=</varname> takes the number of IP addresses in the
        pool or zero to use the default value. By default, the pool starts at
        the first address after the subnet address and takes up the rest of
        the subnet, excluding the broadcast address. If the pool includes
        the server address (the default), this is reserved and not handed
        out to clients.</para>
 
        <xi:include href="version-info.xml" xpointer="v226"/></listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>DefaultLeaseTimeSec=</varname></term>
        <term><varname>MaxLeaseTimeSec=</varname></term>
 
        <listitem><para>Control the default and maximum DHCP lease
        time to pass to clients. These settings take time values in seconds or
        another common time unit, depending on the suffix. The default
        lease time is used for clients that did not ask for a specific
        lease time. If a client asks for a lease time longer than the
        maximum lease time, it is automatically shortened to the
        specified time. The default lease time defaults to 1h, the
        maximum lease time to 12h. Shorter lease times are beneficial
        if the configuration data in DHCP leases changes frequently
        and clients shall learn the new settings with shorter
        latencies. Longer lease times reduce the generated DHCP
        network traffic.</para>
 
        <xi:include href="version-info.xml" xpointer="v226"/></listitem>
      </varlistentry>
 
      <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>:none</literal> and <literal>:auto</literal>. When emitting DNS, NTP, or SIP
        servers is enabled but no servers are specified, the servers configured in the uplink interface
        will be emitted. When <literal>:auto</literal>, the link which has a default gateway with the
        highest priority will be automatically selected. When <literal>:none</literal>, no uplink
        interface will be selected. Defaults to <literal>:auto</literal>.</para>
 
        <xi:include href="version-info.xml" xpointer="v249"/></listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>EmitDNS=</varname></term>
        <term><varname>DNS=</varname></term>
 
        <listitem><para><varname>EmitDNS=</varname> takes a boolean. Configures whether the DHCP leases
        handed out to clients shall contain DNS server information. Defaults to <literal>yes</literal>.
        The DNS servers to pass to clients may be configured with the <varname>DNS=</varname> option,
        which takes a list of IPv4 addresses, or special value <literal>_server_address</literal> which
        will be converted to the address used by the DHCP server.</para>
 
        <para>If the <varname>EmitDNS=</varname> option is enabled but no servers configured, the
        servers are automatically propagated from an "uplink" interface that has appropriate servers
        set. The "uplink" interface is determined by the default route of the system with the highest
        priority. Note that this information is acquired at the time the lease is handed out, and does
        not take uplink interfaces into account that acquire DNS server information at a later point.
        If no suitable uplink interface is found the DNS server data from
        <filename>/etc/resolv.conf</filename> is used. Also, note that the leases are not refreshed if
        the uplink network configuration changes. To ensure clients regularly acquire the most current
        uplink DNS server information, it is thus advisable to shorten the DHCP lease time via
        <varname>MaxLeaseTimeSec=</varname> described above.</para>
 
        <para>This setting can be specified multiple times. If an empty string is specified, then all
        DNS servers specified earlier are cleared.</para>
 
        <xi:include href="version-info.xml" xpointer="v226"/></listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>EmitNTP=</varname></term>
        <term><varname>NTP=</varname></term>
        <term><varname>EmitSIP=</varname></term>
        <term><varname>SIP=</varname></term>
        <term><varname>EmitPOP3=</varname></term>
        <term><varname>POP3=</varname></term>
        <term><varname>EmitSMTP=</varname></term>
        <term><varname>SMTP=</varname></term>
        <term><varname>EmitLPR=</varname></term>
        <term><varname>LPR=</varname></term>
 
        <listitem><para>Similar to the <varname>EmitDNS=</varname> and <varname>DNS=</varname> settings
        described above, these settings configure whether and what server information for the indicate
        protocol shall be emitted as part of the DHCP lease. The same syntax, propagation semantics and
        defaults apply as for <varname>EmitDNS=</varname> and <varname>DNS=</varname>.</para>
 
        <xi:include href="version-info.xml" xpointer="v226"/></listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>EmitRouter=</varname></term>
        <term><varname>Router=</varname></term>
 
        <listitem><para>The <varname>EmitRouter=</varname> setting takes a boolean value, and configures
        whether the DHCP lease should contain the router option. The <varname>Router=</varname> setting
        takes an IPv4 address, and configures the router address to be emitted. When the
        <varname>Router=</varname> setting is not specified, then the server address will be used for
        the router option. When the <varname>EmitRouter=</varname> setting is disabled, the
        <varname>Router=</varname> setting will be ignored. The <varname>EmitRouter=</varname> setting
        defaults to true, and the <varname>Router=</varname> setting defaults to unset.
        </para>
 
        <xi:include href="version-info.xml" xpointer="v230"/></listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>EmitTimezone=</varname></term>
        <term><varname>Timezone=</varname></term>
 
        <listitem><para>Takes a boolean. Configures whether the DHCP leases handed out
        to clients shall contain timezone information. Defaults to <literal>yes</literal>. The
        <varname>Timezone=</varname> setting takes a timezone string
        (such as <literal>Europe/Berlin</literal> or
        <literal>UTC</literal>) to pass to clients. If no explicit
        timezone is set, the system timezone of the local host is
        propagated, as determined by the
        <filename>/etc/localtime</filename> symlink.</para>
 
        <xi:include href="version-info.xml" xpointer="v226"/></listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>EmitDomain=</varname></term>
 
        <listitem><para>Takes a boolean. Configures whether the DHCP leases handed out
        to clients shall contain domain name information (DHCP option 15). Defaults to
        <literal>no</literal>.</para>
 
        <xi:include href="version-info.xml" xpointer="v259"/></listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>Domain=</varname></term>
 
        <listitem><para>Takes a domain name (such as <literal>example.com</literal>)
        to pass to DHCP clients. This configures the DNS default domain for DHCP clients.
        When set, DHCP clients will use this as their DNS search domain.</para>
 
        <para>When <varname>EmitDomain=yes</varname> is set but <varname>Domain=</varname>
        is not configured, the domain name will be automatically derived from the system's
        fully qualified hostname. For example, if the system's hostname is
        <literal>host.example.com</literal>, the domain <literal>example.com</literal>
        will be sent to clients. If the system's hostname does not contain a domain part
        (e.g., hostname is just <literal>host</literal>), no domain name will be sent to
        DHCP clients. When empty or unset, defaults to no domain name.</para>
 
        <xi:include href="version-info.xml" xpointer="v259"/></listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>BootServerAddress=</varname></term>
 
        <listitem>
          <para>Takes an IPv4 address of the boot server used by e.g. PXE boot systems. When specified, this
          address is sent in the <option>siaddr</option> field of the DHCP message header. See <ulink
          url="https://www.rfc-editor.org/rfc/rfc2131.html">RFC 2131</ulink> for more details. Defaults to
          unset.</para>
 
          <xi:include href="version-info.xml" xpointer="v251"/>
        </listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>BootServerName=</varname></term>
 
        <listitem>
          <para>Takes a name of the boot server used by e.g. PXE boot systems. When specified, this name is
          sent in the DHCP option 66 ("TFTP server name"). See <ulink
          url="https://www.rfc-editor.org/rfc/rfc2132.html">RFC 2132</ulink> for more details. Defaults to
          unset.</para>
 
          <para>Note that typically setting one of <varname>BootServerName=</varname> or
          <varname>BootServerAddress=</varname> is sufficient, but both can be set too, if desired.</para>
 
          <xi:include href="version-info.xml" xpointer="v251"/>
        </listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>BootFilename=</varname></term>
 
        <listitem>
          <para>Takes a path or URL to a file loaded by e.g. a PXE boot loader. When specified, this path is
          sent in the DHCP option 67 ("Bootfile name"). See <ulink
          url="https://www.rfc-editor.org/rfc/rfc2132.html">RFC 2132</ulink> for more details. Defaults to
          unset.</para>
 
          <xi:include href="version-info.xml" xpointer="v251"/>
        </listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>IPv6OnlyPreferredSec=</varname></term>
 
        <listitem>
          <para>Takes a timespan. Controls the
          <ulink url="https://tools.ietf.org/html/rfc8925">RFC 8925</ulink> IPv6-Only Preferred option.
          Specifies the DHCPv4 option to indicate that a host supports an IPv6-only mode and is willing to
          forgo obtaining an IPv4 address if the network provides IPv6 connectivity. Defaults to unset, and
          not send the option. The minimum allowed value is 300 seconds.</para>
 
          <xi:include href="version-info.xml" xpointer="v255"/>
        </listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>SendOption=</varname></term>
        <listitem>
          <para>Send a raw option with value via DHCPv4 server. Takes a DHCP option number, data type
          and data (<literal><replaceable>option</replaceable>:<replaceable>type</replaceable>:<replaceable>value</replaceable></literal>).
          The option number is an integer in the range 1…254. 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 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="v244"/>
        </listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>SendVendorOption=</varname></term>
        <listitem>
          <para>Send a vendor option with value via DHCPv4 server. Takes a DHCP option number, data type
          and data (<literal><replaceable>option</replaceable>:<replaceable>type</replaceable>:<replaceable>value</replaceable></literal>).
          The option number is an integer in the range 1…254. The type takes one of <literal>uint8</literal>,
          <literal>uint16</literal>, <literal>uint32</literal>, <literal>ipv4address</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>RapidCommit=</varname></term>
        <listitem>
          <para>Takes a boolean. When true, the server supports
          <ulink url="https://datatracker.ietf.org/doc/html/rfc4039">RFC 4039</ulink>. When a client sends
          a DHCPDISCOVER message with the Rapid Commit option to the server, then the server will reply with
          a DHCPACK message to the client, instead of DHCPOFFER. Defaults to true.</para>
 
          <xi:include href="version-info.xml" xpointer="v255"/>
        </listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>PersistLeases=</varname></term>
        <listitem>
          <para>Takes a boolean or special value <literal>runtime</literal>. When <literal>yes</literal>, the
          DHCP server will load and save leases in the persistent storage. When <literal>runtime</literal>,
          the DHCP server will load and save leases in the runtime storage, hence bound leases will be lost
          when the runtime storage is cleared by e.g. by calling
          <command>systemctl clean systemd-networkd.service</command> or the system is rebooted. When
          <literal>no</literal>, the DHCP server will neither load nor save leases in the persistent storage,
          hence bound leases will be lost when the interface is reconfigured e.g. by
          <command>networkctl reconfigure</command>, or
          <citerefentry><refentrytitle>systemd-networkd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>
          is restarted. Using <literal>runtime</literal> and <literal>no</literal> may cause address conflict
          on the network after the leases are lost. So, please take an extra care when disable this setting.
          When unspecified, the value specified in the same setting in
          <citerefentry><refentrytitle>networkd.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
          which defaults to <literal>yes</literal>, will be used.</para>
 
          <xi:include href="version-info.xml" xpointer="v256"/>
        </listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>LocalLeaseDomain=</varname></term>
        <listitem>
          <para>Takes a DNS domain name as argument. If specified,
          <citerefentry><refentrytitle>systemd-networkd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>
          will integrate with
          <citerefentry><refentrytitle>systemd-resolved.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>
          and ensure that the hostnames associated with each handed out DHCP lease may be resolved to the IP
          addresses of the lease. The hostnames are suffixed with the specified domain name.</para>
 
          <para>Note that this purely about hostname resolution on the local system, i.e. from programs with
          access to the same <filename>systemd-resolved</filename> instances via D-Bus IPC, Varlink IPC, or
          the local DNS stub.</para>
          <xi:include href="version-info.xml" xpointer="v259"/>
        </listitem>
      </varlistentry>
 
    </variablelist>
  </refsect1>
 
  <refsect1>
    <title>[DHCPServerStaticLease] Section Options</title>
    <para>The <literal>[DHCPServerStaticLease]</literal> section configures a static DHCP lease to assign a
    fixed IPv4 address to a specific device based on its MAC address. This section can be specified multiple
    times.</para>
 
    <variablelist class='network-directives'>
      <varlistentry>
        <term><varname>MACAddress=</varname></term>
 
        <listitem><para>The hardware address of a device to match. This key is mandatory.</para>
 
        <xi:include href="version-info.xml" xpointer="v249"/></listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>Address=</varname></term>
 
        <listitem><para>The IPv4 address that should be assigned to the device that was matched with
        <varname>MACAddress=</varname>. This key is mandatory.</para>
 
        <xi:include href="version-info.xml" xpointer="v249"/></listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>Hostname=</varname></term>
 
        <listitem><para>The hostname to send to the client in DHCP replies. This can be either a simple
        hostname (e.g., <literal>mydevice</literal>) or a fully qualified domain name (e.g.,
        <literal>mydevice.example.com</literal>), following RFC 1123 naming conventions. Each label can be
        up to 63 characters, with a total maximum length of 253 characters for FQDNs. When this option is
        set, the DHCP server will include the hostname in DHCP replies (both OFFER and ACK) to the client
        with the matched MAC address.</para>
 
        <para>The server automatically selects the appropriate DHCP option based on the hostname format:
        simple hostnames (single DNS label) are sent via option 12 (Host Name) per RFC 2132, while FQDNs
        with multiple labels are sent via option 81 (Client FQDN) per RFC 4702 using DNS wire format
        encoding. The configured hostname is sent unconditionally, any hostname requested by the client in
        its DHCP message is ignored.</para>
 
        <xi:include href="version-info.xml" xpointer="v259"/></listitem>
      </varlistentry>
    </variablelist>
  </refsect1>
 
  <refsect1>
    <title>[IPv6SendRA] Section Options</title>
    <para>The [IPv6SendRA] section contains settings for sending IPv6 Router Advertisements and whether
    to act as a router, if enabled via the <varname>IPv6SendRA=</varname> option described above. IPv6
    network prefixes or routes are defined with one or more [IPv6Prefix] or [IPv6RoutePrefix] sections.
    </para>
 
    <variablelist class='network-directives'>
 
      <varlistentry>
        <term><varname>Managed=</varname></term>
        <term><varname>OtherInformation=</varname></term>
 
        <listitem><para>Takes a boolean. Controls whether a DHCPv6 server is used to acquire IPv6
        addresses on the network link when <varname>Managed=</varname>
        is set to <literal>true</literal> or if only additional network
        information can be obtained via DHCPv6 for the network link when
        <varname>OtherInformation=</varname> is set to
        <literal>true</literal>. Both settings default to
        <literal>false</literal>, which means that a DHCPv6 server is not being
        used.</para>
 
        <xi:include href="version-info.xml" xpointer="v235"/></listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>RouterLifetimeSec=</varname></term>
 
        <listitem><para>Takes a timespan. Configures the IPv6 router lifetime in seconds. The value must be 0
        seconds, or between 4 seconds and 9000 seconds. When set to 0, the host is not acting as a router.
        Defaults to 1800 seconds (30 minutes).</para>
 
        <xi:include href="version-info.xml" xpointer="v235"/>
        </listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>ReachableTimeSec=</varname></term>
 
        <listitem>
          <para>Configures the time, used in the Neighbor Unreachability Detection algorithm, for which
          clients can assume a neighbor is reachable after having received a reachability confirmation. Takes
          a time span in the range 0…4294967295 ms. When 0, clients will handle it as if the value was not
          specified. Defaults to 0.</para>
 
          <xi:include href="version-info.xml" xpointer="v256"/>
        </listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>RetransmitSec=</varname></term>
 
        <listitem>
          <para>Configures the time, used in the Neighbor Unreachability Detection algorithm, for which
          clients can use as retransmit time on address resolution and the Neighbor Unreachability Detection
          algorithm. Takes a time span in the range 0…4294967295 ms. When 0, clients will handle it as if
          the value wasn't specified. Defaults to 0.</para>
 
          <xi:include href="version-info.xml" xpointer="v255"/>
        </listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>RouterPreference=</varname></term>
 
        <listitem><para>Configures IPv6 router preference if
        <varname>RouterLifetimeSec=</varname> is non-zero. Valid values are
        <literal>high</literal>, <literal>medium</literal> and
        <literal>low</literal>, with <literal>normal</literal> and
        <literal>default</literal> added as synonyms for
        <literal>medium</literal> just to make configuration easier. See
        <ulink url="https://tools.ietf.org/html/rfc4191">RFC 4191</ulink>
        for details. Defaults to <literal>medium</literal>.</para>
 
        <xi:include href="version-info.xml" xpointer="v235"/></listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>HopLimit=</varname></term>
        <listitem>
          <para>Configures hop limit. Takes an integer in the range 0…255. See also
          <varname>IPv6HopLimit=</varname>.</para>
 
          <xi:include href="version-info.xml" xpointer="v255"/>
        </listitem>
      </varlistentry>
 
      <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>:none</literal> and <literal>:auto</literal>. When emitting DNS servers or
        search domains is enabled but no servers are specified, the servers configured in the uplink
        interface will be emitted. When <literal>:auto</literal>, the value specified to the same
        setting in the [DHCPPrefixDelegation] section will be used if
        <varname>DHCPPrefixDelegation=</varname> is enabled, otherwise the link which has a default
        gateway with the highest priority will be automatically selected. When <literal>:none</literal>,
        no uplink interface will be selected. Defaults to <literal>:auto</literal>.</para>
 
        <xi:include href="version-info.xml" xpointer="v250"/></listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>EmitDNS=</varname></term>
        <term><varname>DNS=</varname></term>
 
        <listitem><para><varname>DNS=</varname> specifies a list of recursive DNS server IPv6 addresses
        that are distributed via Router Advertisement messages when <varname>EmitDNS=</varname> is true.
        <varname>DNS=</varname> also takes special value <literal>_link_local</literal>; in that case
        the IPv6 link-local address is distributed. If <varname>DNS=</varname> is empty, DNS servers are
        read from the [Network] section. If the [Network] section does not contain any DNS servers
        either, DNS servers from the uplink interface specified in <varname>UplinkInterface=</varname>
        will be used. When <varname>EmitDNS=</varname> is false, no DNS server information is sent in
        Router Advertisement messages. <varname>EmitDNS=</varname> defaults to true.</para>
 
        <xi:include href="version-info.xml" xpointer="v235"/></listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>EmitDomains=</varname></term>
        <term><varname>Domains=</varname></term>
 
        <listitem><para>A list of DNS search domains distributed via Router Advertisement messages when
        <varname>EmitDomains=</varname> is true. If <varname>Domains=</varname> is empty, DNS search
        domains are read from the [Network] section. If the [Network] section does not contain any DNS
        search domains either, DNS search domains from the uplink interface specified in
        <varname>UplinkInterface=</varname> will be used. When <varname>EmitDomains=</varname> is false,
        no DNS search domain information is sent in Router Advertisement messages.
        <varname>EmitDomains=</varname> defaults to true.</para>
 
        <xi:include href="version-info.xml" xpointer="v235"/></listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>DNSLifetimeSec=</varname></term>
 
        <listitem><para>Lifetime in seconds for the DNS server addresses listed in
        <varname>DNS=</varname> and search domains listed in <varname>Domains=</varname>. Defaults to
        3600 seconds (one hour).</para>
 
        <xi:include href="version-info.xml" xpointer="v235"/></listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>HomeAgent=</varname></term>
 
        <listitem><para>Takes a boolean. Specifies that IPv6 router advertisements indicate to hosts that
        the router acts as a Home Agent and includes a Home Agent option. Defaults to false. See
        <ulink url="https://tools.ietf.org/html/rfc6275">RFC 6275</ulink> for further details.</para>
 
         <xi:include href="version-info.xml" xpointer="v255"/>
        </listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>HomeAgentLifetimeSec=</varname></term>
 
        <listitem><para>Takes a timespan. Specifies the lifetime of the Home Agent. An integer, the default unit is seconds,
        in the range 1…65535. Defaults to the value set to <varname>RouterLifetimeSec=</varname>.</para>
 
         <xi:include href="version-info.xml" xpointer="v255"/>
        </listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>HomeAgentPreference=</varname></term>
 
        <listitem><para>Configures IPv6 Home Agent preference. Takes an integer in the range 0…65535.
        Defaults to 0.</para>
 
         <xi:include href="version-info.xml" xpointer="v255"/>
        </listitem>
      </varlistentry>
 
    </variablelist>
  </refsect1>
 
  <refsect1>
    <title>[IPv6Prefix] Section Options</title>
    <para>One or more [IPv6Prefix] sections contain the IPv6 prefixes that are announced via Router
    Advertisements. See <ulink url="https://tools.ietf.org/html/rfc4861">RFC 4861</ulink> for further
    details.</para>
 
    <variablelist class='network-directives'>
 
      <varlistentry>
        <term><varname>AddressAutoconfiguration=</varname></term>
        <term><varname>OnLink=</varname></term>
 
        <listitem><para>Takes a boolean to specify whether IPv6 addresses can be
        autoconfigured with this prefix and whether the prefix can be used for
        onlink determination. Both settings default to <literal>true</literal>
        in order to ease configuration.
        </para>
 
        <xi:include href="version-info.xml" xpointer="v235"/></listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>Prefix=</varname></term>
 
        <listitem><para>The IPv6 prefix that is to be distributed to hosts. Similarly to configuring static
        IPv6 addresses, the setting is configured as an IPv6 prefix and its prefix length, separated by a
        <literal>/</literal> character. Use multiple [IPv6Prefix] sections to configure multiple IPv6
        prefixes since prefix lifetimes, address autoconfiguration and onlink status may differ from one
        prefix to another.</para>
 
        <xi:include href="version-info.xml" xpointer="v235"/></listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>PreferredLifetimeSec=</varname></term>
        <term><varname>ValidLifetimeSec=</varname></term>
 
        <listitem><para>Preferred and valid lifetimes for the prefix measured in seconds.
        <varname>PreferredLifetimeSec=</varname> defaults to 1800 seconds (30 minutes) and
        <varname>ValidLifetimeSec=</varname> defaults to 3600 seconds (one hour).</para>
 
        <xi:include href="version-info.xml" xpointer="v235"/></listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>Assign=</varname></term>
        <listitem><para>Takes a boolean. When true, adds an address from the prefix. Default to false.
        </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
          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="v250"/>
        </listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>RouteMetric=</varname></term>
        <listitem>
          <para>The metric of the prefix route. Takes an unsigned integer in the range 0…4294967295.
          When unset or set to 0, the kernel's default value is used. This setting is ignored when
          <varname>Assign=</varname> is false.</para>
 
          <xi:include href="version-info.xml" xpointer="v249"/>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>
 
  <refsect1>
    <title>[IPv6RoutePrefix] Section Options</title>
    <para>One or more [IPv6RoutePrefix] sections contain the IPv6
    prefix routes that are announced via Router Advertisements. See
    <ulink url="https://tools.ietf.org/html/rfc4191">RFC 4191</ulink>
    for further details.</para>
 
    <variablelist class='network-directives'>
 
      <varlistentry>
        <term><varname>Route=</varname></term>
 
        <listitem><para>The IPv6 route that is to be distributed to hosts. Similarly to configuring static
        IPv6 routes, the setting is configured as an IPv6 prefix routes and its prefix route length,
        separated by a <literal>/</literal> character. Use multiple [IPv6RoutePrefix] sections to configure
        multiple IPv6 prefix routes.</para>
 
        <xi:include href="version-info.xml" xpointer="v244"/></listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>LifetimeSec=</varname></term>
 
        <listitem><para>Lifetime for the route prefix measured in seconds.
        <varname>LifetimeSec=</varname> defaults to 3600 seconds (one hour).</para>
 
        <xi:include href="version-info.xml" xpointer="v244"/></listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>Preference=</varname></term>
 
        <listitem><para>Specifies the preference of the route option. Takes one of <literal>high</literal>,
        <literal>medium</literal>, or <literal>low</literal>. Defaults to <literal>medium</literal>.</para>
 
        <xi:include href="version-info.xml" xpointer="v258"/></listitem>
      </varlistentry>
 
    </variablelist>
  </refsect1>
 
  <refsect1>
    <title>[IPv6PREF64Prefix] Section Options</title>
    <para>One or more [IPv6PREF64Prefix] sections contain the IPv6 PREF64 (or NAT64) prefixes that are announced via Router
    Advertisements. See <ulink url="https://tools.ietf.org/html/rfc8781">RFC 8781</ulink> for further
    details.</para>
 
    <variablelist class='network-directives'>
 
      <varlistentry>
        <term><varname>Prefix=</varname></term>
 
        <listitem><para>The IPv6 PREF64 (or NAT64) prefix that is to be distributed to hosts. The setting holds
        an IPv6 prefix that should be set up for NAT64 translation (PLAT) to allow 464XLAT on the network segment.
        Use multiple [IPv6PREF64Prefix] sections to configure multiple IPv6 prefixes since prefix lifetime may differ
        from one prefix to another. The prefix is an address with a prefix length, separated by a slash
        <literal>/</literal> character. Valid NAT64 prefix length are 96, 64, 56, 48, 40, and 32 bits.</para>
 
        <xi:include href="version-info.xml" xpointer="v255"/></listitem></varlistentry>
 
      <varlistentry>
        <term><varname>LifetimeSec=</varname></term>
        <listitem><para>Lifetime for the prefix measured in seconds. Should be greater than or equal to <varname>RouterLifetimeSec=</varname>.
        <varname>LifetimeSec=</varname> defaults to 1800 seconds.</para>
 
        <xi:include href="version-info.xml" xpointer="v255"/></listitem>
      </varlistentry>
    </variablelist>
  </refsect1>
 
  <refsect1>
    <title>[Bridge] Section Options</title>
    <para>The [Bridge] section accepts the following keys:</para>
 
    <variablelist class='network-directives'>
      <varlistentry>
        <term><varname>UnicastFlood=</varname></term>
        <listitem>
          <para>Takes a boolean. Controls whether the bridge should flood
          traffic for which an FDB entry is missing and the destination
          is unknown through this port. When unset, the kernel's default will be used.
          </para>
 
          <xi:include href="version-info.xml" xpointer="v223"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>MulticastFlood=</varname></term>
        <listitem>
          <para>Takes a boolean. Controls whether the bridge should flood
          traffic for which an MDB entry is missing and the destination
          is unknown through this port. When unset, the kernel's default will be used.
          </para>
 
          <xi:include href="version-info.xml" xpointer="v242"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>MulticastToUnicast=</varname></term>
        <listitem>
          <para>Takes a boolean. Multicast to unicast works on top of the multicast snooping feature of
          the bridge. Which means unicast copies are only delivered to hosts which are interested in it.
          When unset, the kernel's default will be used.
          </para>
 
          <xi:include href="version-info.xml" xpointer="v240"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>NeighborSuppression=</varname></term>
        <listitem>
          <para>Takes a boolean. Configures whether ARP and ND neighbor suppression is enabled for
          this port. When unset, the kernel's default will be used.
          </para>
 
          <xi:include href="version-info.xml" xpointer="v242"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>Learning=</varname></term>
        <listitem>
          <para>Takes a boolean. Configures whether MAC address learning is enabled for
          this port. When unset, the kernel's default will be used.
          </para>
 
          <xi:include href="version-info.xml" xpointer="v242"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>HairPin=</varname></term>
        <listitem>
          <para>Takes a boolean. Configures whether traffic may be sent back out of the port on which it
          was received. When this flag is false, then the bridge will not forward traffic back out of the
          receiving port. When unset, the kernel's default will be used.</para>
 
          <xi:include href="version-info.xml" xpointer="v223"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>Isolated=</varname></term>
        <listitem>
          <para>Takes a boolean. Configures whether this port is isolated or not. Within a bridge,
          isolated ports can only communicate with non-isolated ports. When set to true, this port can only
          communicate with other ports whose Isolated setting is false.  When set to false, this port
          can communicate with any other ports. When unset, the kernel's default will be used.</para>
 
          <xi:include href="version-info.xml" xpointer="v251"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>UseBPDU=</varname></term>
        <listitem>
          <para>Takes a boolean. Configures whether STP Bridge Protocol Data Units will be
          processed by the bridge port. When unset, the kernel's default will be used.</para>
 
          <xi:include href="version-info.xml" xpointer="v223"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>FastLeave=</varname></term>
        <listitem>
          <para>Takes a boolean. This flag allows the bridge to immediately stop multicast
          traffic on a port that receives an IGMP Leave message. It is only used with
          IGMP snooping if enabled on the bridge. When unset, the kernel's default will be used.</para>
 
          <xi:include href="version-info.xml" xpointer="v223"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>AllowPortToBeRoot=</varname></term>
        <listitem>
          <para>Takes a boolean. Configures whether a given port is allowed to
          become a root port. Only used when STP is enabled on the bridge.
          When unset, the kernel's default will be used.</para>
 
          <xi:include href="version-info.xml" xpointer="v223"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>ProxyARP=</varname></term>
        <listitem>
          <para>Takes a boolean. Configures whether proxy ARP to be enabled on this port.
          When unset, the kernel's default will be used.</para>
 
          <xi:include href="version-info.xml" xpointer="v243"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>ProxyARPWiFi=</varname></term>
        <listitem>
          <para>Takes a boolean. Configures whether proxy ARP to be enabled on this port
          which meets extended requirements by IEEE 802.11 and Hotspot 2.0 specifications.
          When unset, the kernel's default will be used.</para>
 
          <xi:include href="version-info.xml" xpointer="v243"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>MulticastRouter=</varname></term>
        <listitem>
          <para>Configures this port for having multicast routers attached. A port with a multicast
          router will receive all multicast traffic. Takes one of <literal>no</literal>
          to disable multicast routers on this port, <literal>query</literal> to let the system detect
          the presence of routers, <literal>permanent</literal> to permanently enable multicast traffic
          forwarding on this port, or <literal>temporary</literal> to enable multicast routers temporarily
          on this port, not depending on incoming queries. When unset, the kernel's default will be used.</para>
 
          <xi:include href="version-info.xml" xpointer="v243"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>Cost=</varname></term>
        <listitem>
          <para>Sets the "cost" of sending packets of this interface.
          Each port in a bridge may have a different speed and the cost
          is used to decide which link to use. Faster interfaces
          should have lower costs. It is an integer value between 1 and
          65535.</para>
 
          <xi:include href="version-info.xml" xpointer="v218"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>Priority=</varname></term>
        <listitem>
          <para>Sets the "priority" of sending packets on this interface. Each port in a bridge may have a
          different priority which is used to decide which link to use. Lower value means higher priority.
          It is an integer value between 0 to 63. <command>systemd-networkd</command> does not set any
          default, meaning the kernel default value of 32 is used.</para>
 
          <xi:include href="version-info.xml" xpointer="v234"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>Locked=</varname></term>
        <listitem>
          <para>Takes a boolean. Configures whether the port is "locked" and does not allow traffic forwarded
          until fully authenticated, e.g. via 802.1x. When unset, the kernel's default will be used.</para>
 
          <xi:include href="version-info.xml" xpointer="v258"/>
        </listitem>
        <term><varname>MACAuthenticationBypass=</varname></term>
        <listitem>
          <para>Takes a boolean. Configures whether a locked port has "MAC Authentication Bypass" enabled and
          creates newly learned fdb entries in a "locked" state. User space can authenticate these entries by
          clearing the locked flag. Requires Learning to be enabled. When unset, the kernel's default will be
          used.</para>
 
          <xi:include href="version-info.xml" xpointer="v258"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>VLANTunnel=</varname></term>
        <listitem>
          <para>Takes a boolean. Configures whether vlan tunnel mode is to be enabled on this port.
          When unset, the kernel's default will be used.</para>
 
          <xi:include href="version-info.xml" xpointer="v258"/>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>
 
  <refsect1>
    <title>[BridgeFDB] Section Options</title>
 
    <para>The [BridgeFDB] section manages the forwarding database table of a port and accepts the following
    keys. Specify several [BridgeFDB] sections to configure several static MAC table entries.</para>
 
    <variablelist class='network-directives'>
      <varlistentry>
        <term><varname>MACAddress=</varname></term>
        <listitem>
          <para>As in the [Network] section. This key is mandatory.</para>
 
          <xi:include href="version-info.xml" xpointer="v219"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>Destination=</varname></term>
        <listitem>
          <para>Takes an IP address of the destination VXLAN tunnel endpoint.</para>
 
          <xi:include href="version-info.xml" xpointer="v243"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>VLANId=</varname></term>
        <listitem>
          <para>The VLAN ID for the new static MAC table entry. If
          omitted, no VLAN ID information is appended to the new static MAC
          table entry.</para>
 
          <xi:include href="version-info.xml" xpointer="v219"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>VNI=</varname></term>
        <listitem>
          <para>The VXLAN Network Identifier (or VXLAN Segment ID) to use to connect to
          the remote VXLAN tunnel endpoint. Takes a number in the range 1…16777215.
          Defaults to unset.</para>
 
          <xi:include href="version-info.xml" xpointer="v243"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>AssociatedWith=</varname></term>
        <listitem>
          <para>Specifies where the address is associated with. Takes one of <literal>use</literal>,
          <literal>self</literal>, <literal>master</literal> or <literal>router</literal>.
          <literal>use</literal> means the address is in use. User space can use this option to
          indicate to the kernel that the fdb entry is in use. <literal>self</literal> means
          the address is associated with the port drivers fdb. Usually hardware. <literal>master</literal>
          means the address is associated with master devices fdb. <literal>router</literal> means
          the destination address is associated with a router. Note that it is valid if the referenced
          device is a VXLAN type device and has route shortcircuit enabled. Defaults to <literal>self</literal>.</para>
 
          <xi:include href="version-info.xml" xpointer="v243"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>OutgoingInterface=</varname></term>
        <listitem>
          <para>Specifies the name or index of the outgoing interface for the VXLAN device driver to
          reach the remote VXLAN tunnel endpoint. Defaults to unset.</para>
 
          <xi:include href="version-info.xml" xpointer="v249"/>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>
 
  <refsect1>
    <title>[BridgeMDB] Section Options</title>
    <para>The [BridgeMDB] section manages the multicast membership entries forwarding database table of a port and accepts the following
    keys. Specify several [BridgeMDB] sections to configure several permanent multicast membership entries.</para>
 
    <variablelist class='network-directives'>
      <varlistentry>
        <term><varname>MulticastGroupAddress=</varname></term>
        <listitem>
          <para>Specifies the IPv4, IPv6, or L2 MAC multicast group address to add. This setting is mandatory.</para>
 
          <xi:include href="version-info.xml" xpointer="v247"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>VLANId=</varname></term>
        <listitem>
          <para>The VLAN ID for the new entry. Valid ranges are 0 (no VLAN) to 4094. Optional, defaults to 0.</para>
 
          <xi:include href="version-info.xml" xpointer="v247"/>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>
 
  <refsect1>
    <title>[LLDP] Section Options</title>
    <para>The [LLDP] section manages the Link Layer Discovery Protocol (LLDP) and accepts the following