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 2001–3000 of 7,055

 
  <refsect1>
    <title>[NextHop] Section Options</title>
 
    <para>The [NextHop] section is used to manipulate entries in the kernel's "nexthop" tables. The
    [NextHop] section accepts the following settings. Specify several [NextHop] sections to configure
    several hops.</para>
 
    <variablelist class='network-directives'>
      <varlistentry>
        <term><varname>Id=</varname></term>
        <listitem>
          <para>The id of the next hop. Takes an integer in the range 1…4294967295.
          This is mandatory if <varname>ManageForeignNextHops=no</varname> is specified in
          <citerefentry><refentrytitle>networkd.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
          Otherwise, if unspecified, an unused ID will be automatically picked.</para>
 
          <xi:include href="version-info.xml" xpointer="v244"/>
        </listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>Gateway=</varname></term>
        <listitem>
          <para>As in the [Network] section.</para>
 
        <xi:include href="version-info.xml" xpointer="v244"/>
        </listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>Family=</varname></term>
        <listitem>
          <para>Takes one of the special values <literal>ipv4</literal> or <literal>ipv6</literal>.
          By default, the family is determined by the address specified in
          <varname>Gateway=</varname>. If <varname>Gateway=</varname> is not specified, then defaults
          to <literal>ipv4</literal>.</para>
 
        <xi:include href="version-info.xml" xpointer="v248"/>
        </listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>OnLink=</varname></term>
        <listitem>
          <para>Takes a boolean. If set to true, the kernel does not have to check if the gateway is
          reachable directly by the current machine (i.e., attached to the local network), so that we
          can insert the nexthop in the kernel table without it being complained about. Defaults to
          <literal>no</literal>.</para>
 
          <xi:include href="version-info.xml" xpointer="v248"/>
        </listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>Blackhole=</varname></term>
        <listitem>
          <para>Takes a boolean. If enabled, packets to the corresponding routes are discarded
          silently, and <varname>Gateway=</varname> cannot be specified. Defaults to
          <literal>no</literal>.</para>
 
          <xi:include href="version-info.xml" xpointer="v248"/>
        </listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>Group=</varname></term>
        <listitem>
          <para>Takes a whitespace separated list of nexthop IDs. Each ID must be in the range
          1…4294967295. Optionally, each nexthop ID can take a weight after a colon
          (<literal><replaceable>id</replaceable><optional>:<replaceable>weight</replaceable></optional></literal>).
          The weight must be in the range 1…255. If the weight is not specified, then it is assumed
          that the weight is 1. This setting cannot be specified with <varname>Gateway=</varname>,
          <varname>Family=</varname>, <varname>Blackhole=</varname>. This setting can be specified
          multiple times. If an empty string is assigned, then the all previous assignments are
          cleared. Defaults to unset.</para>
 
          <xi:include href="version-info.xml" xpointer="v249"/>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>
 
  <refsect1>
    <title>[Route] Section Options</title>
 
    <para>The [Route] section accepts the following settings. Specify several [Route] sections to
    configure several routes.</para>
 
    <variablelist class='network-directives'>
      <varlistentry>
        <term><varname>Gateway=</varname></term>
        <listitem>
          <para>Takes the gateway address or the special values <literal>_dhcp4</literal> and
          <literal>_ipv6ra</literal>. If <literal>_dhcp4</literal> or <literal>_ipv6ra</literal> is set, then
          the gateway address provided by DHCPv4 or IPv6 RA is used. When<literal>_dhcp4</literal>, the
          acquired DHCPv4 address will be used as the preferred source address of the route, unless it is
          explicitly configured in <varname>PreferredSource=</varname>.</para>
 
        <xi:include href="version-info.xml" xpointer="v211"/>
        </listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>GatewayOnLink=</varname></term>
        <listitem>
          <para>Takes a boolean. If set to true, the kernel does not have to check if the gateway is
          reachable directly by the current machine (i.e., attached to the local network), so that we
          can insert the route in the kernel table without it being complained about. Defaults to
          <literal>no</literal>.</para>
 
          <xi:include href="version-info.xml" xpointer="v234"/>
        </listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>Destination=</varname></term>
        <listitem>
          <para>The destination prefix of the route. Possibly followed by a slash and the prefix
          length. If omitted, a full-length host route is assumed.</para>
 
          <xi:include href="version-info.xml" xpointer="v211"/>
        </listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>Source=</varname></term>
        <listitem>
          <para>The source prefix of the route. Possibly followed by a slash and the prefix length. If
          omitted, a full-length host route is assumed.</para>
 
          <xi:include href="version-info.xml" xpointer="v218"/>
        </listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>Metric=</varname></term>
        <listitem>
          <para>The metric of the route. Takes an unsigned integer in the range 0…4294967295. Defaults
          to unset, and the kernel's default will be used.</para>
 
          <xi:include href="version-info.xml" xpointer="v216"/>
        </listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>IPv6Preference=</varname></term>
        <listitem>
          <para>Specifies the route preference as defined in
          <ulink url="https://tools.ietf.org/html/rfc4191">RFC 4191</ulink> for Router Discovery
          messages. Which can be one of <literal>low</literal> the route has a lowest priority,
          <literal>medium</literal> the route has a default priority or <literal>high</literal> the
          route has a highest priority.</para>
 
          <xi:include href="version-info.xml" xpointer="v234"/>
        </listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>Scope=</varname></term>
        <listitem>
          <para>The scope of the IPv4 route, which can be <literal>global</literal>,
          <literal>site</literal>, <literal>link</literal>, <literal>host</literal>, or
          <literal>nowhere</literal>:</para>
          <itemizedlist>
            <listitem>
              <para><literal>global</literal> means the route can reach hosts more than one hop away.
              </para>
            </listitem>
 
            <listitem>
              <para><literal>site</literal> means an interior route in the local autonomous system.
              </para>
            </listitem>
 
            <listitem>
              <para><literal>link</literal> means the route can only reach hosts on the local network
              (one hop away).</para>
            </listitem>
 
            <listitem>
              <para><literal>host</literal> means the route will not leave the local machine (used for
              internal addresses like 127.0.0.1).</para>
            </listitem>
 
            <listitem>
              <para><literal>nowhere</literal> means the destination does not exist.</para>
            </listitem>
          </itemizedlist>
 
          <para>For IPv4 route, defaults to <literal>host</literal> if <varname>Type=</varname> is
          <literal>local</literal> or <literal>nat</literal>, and <literal>link</literal> if
          <varname>Type=</varname> is <literal>broadcast</literal>, <literal>multicast</literal>,
          <literal>anycast</literal>, or <literal>unicast</literal>. In other cases,
          defaults to <literal>global</literal>. The value is not used for IPv6.</para>
 
          <xi:include href="version-info.xml" xpointer="v219"/>
        </listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>PreferredSource=</varname></term>
        <listitem>
          <para>The preferred source address of the route. Takes <literal>no</literal> or an address
          in the format described in
          <citerefentry project='man-pages'><refentrytitle>inet_pton</refentrytitle><manvolnum>3</manvolnum></citerefentry>.
          If <varname>Gateway=_dhcp4</varname> is specified, defaults to the acquired DHCPv4 address.
          Otherwise, defaults to unset. The value <literal>no</literal> may be useful to configure a route
          with <varname>Gateway=_dhcp4</varname> without setting preferred source route address.</para>
 
          <xi:include href="version-info.xml" xpointer="v227"/>
        </listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>Table=</varname></term>
        <listitem>
          <para>The table identifier for the route. 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 and 4294967295. The table can be retrieved using
          <command>ip route show table <replaceable>num</replaceable></command>. If unset and
          <varname>Type=</varname> is <literal>local</literal>, <literal>broadcast</literal>,
          <literal>anycast</literal>, or <literal>nat</literal>, then <literal>local</literal> is used.
          In other cases, defaults to <literal>main</literal>.</para>
 
          <xi:include href="version-info.xml" xpointer="v230"/>
        </listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>HopLimit=</varname></term>
        <listitem>
          <para>Configures per route hop limit. Takes an integer in the range 1…255. See also
          <varname>IPv6HopLimit=</varname>.</para>
 
          <xi:include href="version-info.xml" xpointer="v255"/>
        </listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>Protocol=</varname></term>
        <listitem>
          <para>The protocol identifier for the route. Takes a number between 0 and 255 or the special
          values <literal>kernel</literal>, <literal>boot</literal>, <literal>static</literal>,
          <literal>ra</literal> and <literal>dhcp</literal>. Defaults to <literal>static</literal>.
          </para>
 
          <xi:include href="version-info.xml" xpointer="v234"/>
        </listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>Type=</varname></term>
        <listitem>
          <para>Specifies the type for the route. Takes one of <literal>unicast</literal>,
          <literal>local</literal>, <literal>broadcast</literal>, <literal>anycast</literal>,
          <literal>multicast</literal>, <literal>blackhole</literal>, <literal>unreachable</literal>,
          <literal>prohibit</literal>, <literal>throw</literal>, <literal>nat</literal>, and
          <literal>xresolve</literal>. If <literal>unicast</literal>, a regular route is defined, i.e.
          a route indicating the path to take to a destination network address. If
          <literal>blackhole</literal>, packets to the defined route are discarded silently. If
          <literal>unreachable</literal>, packets to the defined route are discarded and the ICMP
          message "Host Unreachable" is generated. If <literal>prohibit</literal>, packets to the
          defined route are discarded and the ICMP message "Communication Administratively Prohibited"
          is generated. If <literal>throw</literal>, route lookup in the current routing table will
          fail and the route selection process will return to Routing Policy Database (RPDB). Defaults
          to <literal>unicast</literal>.</para>
 
        <xi:include href="version-info.xml" xpointer="v235"/>
        </listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>InitialCongestionWindow=</varname></term>
        <listitem>
          <para>The TCP initial congestion window is used during the start of a TCP connection.
          During the start of a TCP session, when a client requests a resource, the server's initial
          congestion window determines how many packets will be sent during the initial burst of data
          without waiting for acknowledgement. Takes a number between 1 and 1023. Note that 100 is
          considered an extremely large value for this option. When unset, the kernel's default
          (typically 10) will be used.</para>
 
          <xi:include href="version-info.xml" xpointer="v237"/>
        </listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>InitialAdvertisedReceiveWindow=</varname></term>
        <listitem>
          <para>The TCP initial advertised receive window is the amount of receive data (in bytes)
          that can initially be buffered at one time on a connection. The sending host can send only
          that amount of data before waiting for an acknowledgment and window update from the
          receiving host. Takes a number between 1 and 1023. Note that 100 is considered an extremely
          large value for this option. When unset, the kernel's default will be used.</para>
 
          <xi:include href="version-info.xml" xpointer="v237"/>
        </listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>QuickAck=</varname></term>
        <listitem>
          <para>Takes a boolean. When true, the TCP quick ACK mode for the route is enabled. When unset,
          the kernel's default will be used.</para>
 
          <xi:include href="version-info.xml" xpointer="v237"/>
        </listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>FastOpenNoCookie=</varname></term>
        <listitem>
          <para>Takes a boolean. When true enables TCP fastopen without a cookie on a per-route basis.
          When unset, the kernel's default will be used.</para>
 
          <xi:include href="version-info.xml" xpointer="v243"/>
        </listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>MTUBytes=</varname></term>
        <listitem>
          <para>The maximum transmission unit in bytes to set for the route. The usual suffixes K, M,
          G, are supported and are understood to the base of 1024.</para>
 
          <xi:include href="version-info.xml" xpointer="v239"/>
        </listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>TCPAdvertisedMaximumSegmentSize=</varname></term>
        <listitem>
          <para>Specifies the Path MSS (in bytes) hints given on TCP layer. The usual suffixes K, M, G,
          are supported and are understood to the base of 1024. An unsigned integer in the range
          1…4294967294. When unset, the kernel's default will be used.</para>
 
          <xi:include href="version-info.xml" xpointer="v248"/>
        </listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>TCPCongestionControlAlgorithm=</varname></term>
        <listitem>
          <para>Specifies the TCP congestion control algorithm for the route. Takes a name of the algorithm,
          e.g. <literal>bbr</literal>, <literal>dctcp</literal>, or <literal>vegas</literal>. When unset,
          the kernel's default will be used.</para>
 
          <xi:include href="version-info.xml" xpointer="v252"/>
        </listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>TCPRetransmissionTimeoutSec=</varname></term>
        <listitem>
          <para>Specifies the TCP Retransmission Timeout (RTO) for the route. Takes time values in seconds.
          This value specifies the timeout of an alive TCP connection, when retransmissions remain
          unacknowledged. When unset, the kernel's default will be used.</para>
 
          <xi:include href="version-info.xml" xpointer="v255"/>
        </listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>MultiPathRoute=</varname></term>
        <listitem>
          <para>Configures multipath route. Multipath routing is the technique of using multiple
          alternative paths through a network. Takes a gateway address and/or a network interface
          name or index (prefixed with <literal>@</literal>). At least one of these must be specified.
          Optionally, a weight in 1..256 can be specified, separated with whitespace. This setting
          can be specified multiple times. If an empty string is assigned, then all previous
          assignments are cleared.</para>
 
          <para>Examples:</para>
          <programlisting>MultiPathRoute=10.0.0.1@eth0 20
MultiPathRoute=192.168.1.1 50
MultiPathRoute=@wg0 15
MultiPathRoute=2001:db8::1@eth0</programlisting>
 
          <xi:include href="version-info.xml" xpointer="v245"/>
        </listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>NextHop=</varname></term>
        <listitem>
          <para>Specifies the nexthop id. Takes an unsigned integer in the range 1…4294967295. If set,
          the corresponding [NextHop] section must be configured. Defaults to unset.</para>
 
          <xi:include href="version-info.xml" xpointer="v248"/>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>
 
  <refsect1>
    <title>[DHCPv4] Section Options</title>
 
    <para>The [DHCPv4] section configures the DHCPv4 client, if it is enabled with the
    <varname>DHCP=</varname> setting described above:</para>
 
    <variablelist class='network-directives'>
 
      <!-- DHCP packet contents -->
 
      <varlistentry>
        <term><varname>RequestAddress=</varname></term>
        <listitem>
          <para>Takes an IPv4 address. When specified, the Requested IP Address option (option code 50) is
          added with it to the initial DHCPDISCOVER message sent by the DHCP client. Defaults to unset, and
          an already assigned dynamic address to the interface is automatically picked.</para>
 
          <xi:include href="version-info.xml" xpointer="v255"/>
        </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 DHCP server. Note that the
          hostname must consist only of 7-bit ASCII lower-case characters and no spaces, and be
          formatted as a valid DNS domain name. A single-label hostname is sent as DHCP option 12
          (Host Name, <ulink url="https://tools.ietf.org/html/rfc2132">RFC 2132</ulink>);
          a multi-label hostname (FQDN) is sent instead as DHCP option 81 (Client FQDN,
          <ulink url="https://tools.ietf.org/html/rfc4702">RFC 4702</ulink>).
          Otherwise, the hostname is not sent even if this option is true.</para>
 
          <xi:include href="version-info.xml" xpointer="v215"/>
        </listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>Hostname=</varname></term>
        <listitem>
          <para>Use this value for the hostname which is sent to the DHCP server, instead of machine's
          hostname. Note that the specified hostname must consist only of 7-bit ASCII lower-case
          characters and no spaces, and be formatted as a valid DNS domain name. Multi-label hostnames
          (FQDNs) are acceptable; see <varname>SendHostname=</varname> above for details.</para>
 
          <xi:include href="version-info.xml" xpointer="v223"/>
        </listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>MUDURL=</varname></term>
        <listitem>
          <para>When configured, the specified Manufacturer Usage Description (MUD) URL will be sent
          to the DHCPv4 server. Takes a URL of length up to 255 characters. A superficial verification
          that the string is a valid URL will be performed. DHCPv4 clients are intended to have at most
          one MUD URL associated with them. See
          <ulink url="https://tools.ietf.org/html/rfc8520">RFC 8520</ulink>.</para>
 
          <para>MUD is an embedded software standard defined by the IETF that allows IoT device makers
          to advertise device specifications, including the intended communication patterns for their
          device when it connects to the network. The network can then use this to author a
          context-specific access policy, so the device functions only within those parameters.</para>
 
          <xi:include href="version-info.xml" xpointer="v246"/>
        </listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>ClientIdentifier=</varname></term>
        <listitem>
          <para>The DHCPv4 client identifier to use. Takes one of <option>mac</option> or
          <option>duid</option>. If set to <option>mac</option>, the MAC address of the link is used. If set
          to <option>duid</option>, an RFC4361-compliant Client ID, which is the combination of IAID and
          DUID, is used. IAID can be configured by <varname>IAID=</varname>. DUID can be configured by
          <varname>DUIDType=</varname> and <varname>DUIDRawData=</varname>. When
          <varname>Anonymize=</varname> is enabled, <option>mac</option> is unconditionally used and the
          specified value will be ignored. When unspecified, the value specified in the same setting in
          <citerefentry><refentrytitle>networkd.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>
          will be used.</para>
 
        <xi:include href="version-info.xml" xpointer="v220"/>
        </listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>VendorClassIdentifier=</varname></term>
        <listitem>
          <para>The vendor class identifier used to identify vendor type and configuration.</para>
 
        <xi:include href="version-info.xml" xpointer="v216"/>
        </listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>UserClass=</varname></term>
        <listitem>
          <para>A DHCPv4 client can use UserClass 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. Takes a
          whitespace-separated list of strings.</para>
 
          <xi:include href="version-info.xml" xpointer="v239"/>
        </listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>DUIDType=</varname></term>
        <listitem>
          <para>Override the global <varname>DUIDType=</varname> setting for this network. See
          <citerefentry><refentrytitle>networkd.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>
          for a description of possible values.</para>
 
        <xi:include href="version-info.xml" xpointer="v230"/>
        </listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>DUIDRawData=</varname></term>
        <listitem>
          <para>Override the global <varname>DUIDRawData=</varname> setting for this network. See
          <citerefentry><refentrytitle>networkd.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>
          for a description of possible values.</para>
 
        <xi:include href="version-info.xml" xpointer="v230"/>
        </listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>IAID=</varname></term>
        <listitem>
          <para>The DHCP Identity Association Identifier (IAID) for the interface, a 32-bit unsigned
          integer.</para>
 
          <xi:include href="version-info.xml" xpointer="v230"/>
        </listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>RapidCommit=</varname></term>
        <listitem>
          <para>Takes a boolean. The DHCPv4 client can obtain configuration parameters from a DHCPv4 server
          through a rapid two-message exchange (discover and ack). When the rapid commit option is set by
          both the DHCPv4 client and the DHCPv4 server, the two-message exchange is used. Otherwise, the
          four-message exchange (discover, offer, request, and ack) is used. The two-message exchange
          provides faster client configuration. See
          <ulink url="https://tools.ietf.org/html/rfc4039">RFC 4039</ulink> for details.
          Defaults to true when <varname>Anonymize=no</varname> and neither <varname>AllowList=</varname>
          nor <varname>DenyList=</varname> is specified, and false otherwise.</para>
 
          <xi:include href="version-info.xml" xpointer="v255"/>
        </listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>Anonymize=</varname></term>
        <listitem>
          <para>Takes a boolean. When true, the options sent to the DHCP server will follow the
          <ulink url="https://tools.ietf.org/html/rfc7844">RFC 7844</ulink> (Anonymity Profiles for
          DHCP Clients) to minimize disclosure of identifying information. Defaults to false.</para>
 
          <para>This option should only be set to true when <varname>MACAddressPolicy=</varname> is set
          to <option>random</option> (see
          <citerefentry><refentrytitle>systemd.link</refentrytitle><manvolnum>5</manvolnum></citerefentry>).
          </para>
 
          <para>When true,
          <varname>ClientIdentifier=mac</varname>,
          <varname>RapidCommit=no</varname>,
          <varname>SendHostname=no</varname>,
          <varname>Use6RD=no</varname>,
          <varname>UseCaptivePortal=no</varname>,
          <varname>UseMTU=no</varname>,
          <varname>UseNTP=no</varname>,
          <varname>UseSIP=no</varname>, and
          <varname>UseTimezone=no</varname>
          are implied and these settings in the .network file are silently ignored. Also,
          <varname>Hostname=</varname>,
          <varname>MUDURL=</varname>,
          <varname>RequestAddress=</varname>,
          <varname>RequestOptions=</varname>,
          <varname>SendOption=</varname>,
          <varname>SendVendorOption=</varname>,
          <varname>UserClass=</varname>, and
          <varname>VendorClassIdentifier=</varname>
          are silently ignored.</para>
 
          <para>With this option enabled DHCP requests will mimic those generated by Microsoft
          Windows, in order to reduce the ability to fingerprint and recognize installations. This
          means DHCP request sizes will grow and lease data will be more comprehensive than normally,
          though most of the requested data is not actually used.</para>
 
          <xi:include href="version-info.xml" xpointer="v235"/>
        </listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>RequestOptions=</varname></term>
        <listitem>
          <para>Sets request options to be sent to the server in the DHCPv4 request options list. A
          whitespace-separated list of integers in the range 1…254. Defaults to unset.</para>
 
          <xi:include href="version-info.xml" xpointer="v244"/>
        </listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>SendOption=</varname></term>
        <listitem>
          <para>Send an arbitrary raw option in the DHCPv4 request. Takes a DHCP option number, data
          type and data separated with a colon
          (<literal><replaceable>option</replaceable>:<replaceable>type</replaceable>:<replaceable>value</replaceable></literal>).
          The option number must be 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="v244"/>
        </listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>SendVendorOption=</varname></term>
        <listitem>
          <para>Send an arbitrary vendor option in the DHCPv4 request. Takes a DHCP option number, data
          type and data separated with a colon
          (<literal><replaceable>option</replaceable>:<replaceable>type</replaceable>:<replaceable>value</replaceable></literal>).
          The option number must be 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>IPServiceType=</varname></term>
        <listitem>
          <para>Takes one of the special values <literal>none</literal>, <literal>CS6</literal>, or
          <literal>CS4</literal>. When <literal>none</literal> no IP service type is set to the packet
          sent from the DHCPv4 client. When <literal>CS6</literal> (network control) or
          <literal>CS4</literal> (realtime), the corresponding service type will be set. Defaults to
          <literal>CS6</literal>.</para>
 
        <xi:include href="version-info.xml" xpointer="v244"/>
        </listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>SocketPriority=</varname></term>
        <listitem>
          <para>The Linux socket option <constant>SO_PRIORITY</constant> applied to the raw IP socket used for
          initial DHCPv4 messages. Unset by default. Usual values range from 0 to 6.
          More details about <constant>SO_PRIORITY</constant> socket option in
          <citerefentry project='man-pages'><refentrytitle>socket</refentrytitle><manvolnum>7</manvolnum></citerefentry>.
          Can be used in conjunction with [VLAN] section <varname>EgressQOSMaps=</varname> setting of .netdev
          file to set the 802.1Q VLAN ethernet tagged header priority, see
          <citerefentry><refentrytitle>systemd.netdev</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
          </para>
 
        <xi:include href="version-info.xml" xpointer="v253"/>
        </listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>BOOTP=</varname></term>
        <listitem>
          <para>Takes a boolean. When enabled, the DHCPv4 client will be configured to communicate with BOOTP
          servers, rather than with DHCP servers. Defaults to off.</para>
 
          <xi:include href="version-info.xml" xpointer="v258"/>
        </listitem>
      </varlistentry>
 
      <!-- How to use the DHCP lease -->
 
      <varlistentry>
        <term><varname>Label=</varname></term>
        <listitem>
          <para>Specifies the label for the IPv4 address received from the DHCP server. The label must
          be a 7-bit ASCII string with a length of 1…15 characters. Defaults to unset.</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 from the DHCP server 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="v211"/>
        </listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>RoutesToDNS=</varname></term>
        <listitem>
          <para>When true, the routes to the DNS servers received from the DHCP server will be
          configured. When <varname>UseDNS=</varname> is disabled, this setting is ignored. Defaults to
          true.</para>
 
          <xi:include href="version-info.xml" xpointer="v243"/>
        </listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>UseNTP=</varname></term>
        <listitem>
          <para>When true (the default), the NTP servers received from the DHCP server will be used by
          <filename>systemd-timesyncd.service</filename>.</para>
 
          <xi:include href="version-info.xml" xpointer="v220"/>
        </listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>RoutesToNTP=</varname></term>
        <listitem>
          <para>When true, the routes to the NTP servers received from the DHCP server will be
          configured. When <varname>UseNTP=</varname> is disabled, this setting is ignored. Defaults to
          true.</para>
 
          <xi:include href="version-info.xml" xpointer="v249"/>
        </listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>UseSIP=</varname></term>
        <listitem>
          <para>When true (the default), the SIP servers received from the DHCP server will be collected
          and made available to client programs.</para>
 
          <xi:include href="version-info.xml" xpointer="v244"/>
        </listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>UseCaptivePortal=</varname></term>
        <listitem>
          <para>When true (the default), the captive portal advertised by the DHCP 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>UseDNR=</varname></term>
        <listitem>
          <para>When true, designated resolvers advertised by the DHCP server will be used as encrypted
          DNS servers. See <ulink url="https://datatracker.ietf.org/doc/html/rfc9463">RFC 9463</ulink>.</para>
 
          <para>Defaults to unset, and the value for <varname>UseDNS=</varname> will be used.</para>
 
          <xi:include href="version-info.xml" xpointer="v257"/>
        </listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>UseMTU=</varname></term>
        <listitem>
          <para>When true, the interface maximum transmission unit from the DHCP server will be used on
          the current link. If <varname>MTUBytes=</varname> is set, then this setting is ignored.
          Defaults to false.</para>
 
          <para>Note, some drivers will reset the interfaces if the MTU is changed. For such
          interfaces, please try to use <varname>IgnoreCarrierLoss=</varname> with a short timespan,
          e.g. <literal>3 seconds</literal>.</para>
 
          <xi:include href="version-info.xml" xpointer="v211"/>
        </listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>UseHostname=</varname></term>
        <listitem>
          <para>When true (the default), the hostname received from the DHCP server will be set as the
          transient hostname of the system.</para>
 
          <xi:include href="version-info.xml" xpointer="v211"/>
        </listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>UseDomains=</varname></term>
        <listitem>
          <para>Takes a boolean, or the special value <option>route</option>. When true, the domain name
          received from the DHCP server will be used as DNS search domain over this link, similarly to the
          effect of the <option>Domains=</option> setting. If set to <option>route</option>, the domain name
          received from the DHCP server 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>.</para>
 
          <para>When unspecified, the value specified in the same setting in the [Network] section will be
          used. When it is unspecified, the value specified in the same setting in the [DHCPv4] section in
          <citerefentry><refentrytitle>networkd.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>
          will be used. When it is unspecified, the value specified in the same setting in the [Network]
          section in
          <citerefentry><refentrytitle>networkd.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>
          will be used. When none of them are specified, defaults to <literal>no</literal>.</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="v216"/>
        </listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>UseRoutes=</varname></term>
        <listitem>
          <para>When true (the default), the static routes will be requested from the DHCP server and
          added to the routing table with a metric of 1024, and a scope of <option>global</option>,
          <option>link</option> or <option>host</option>, depending on the route's destination and
          gateway. If the destination is on the local host, e.g., 127.x.x.x, or the same as the link's
          own address, the scope will be set to <option>host</option>. Otherwise, if the gateway is null
          (a direct route), a <option>link</option> scope will be used. For anything else, scope
          defaults to <option>global</option>.</para>
 
          <xi:include href="version-info.xml" xpointer="v215"/>
        </listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>RouteMetric=</varname></term>
        <listitem>
          <para>Set the routing metric for routes specified by the DHCP server (including the prefix
          route added for the specified prefix). Takes an unsigned integer in the range 0…4294967295.
          Defaults to 1024.</para>
 
          <xi:include href="version-info.xml" xpointer="v217"/>
        </listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>RouteTable=<replaceable>num</replaceable></varname></term>
        <listitem>
          <para>The table identifier for DHCP routes. 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>RouteMTUBytes=</varname></term>
        <listitem>
          <para>Specifies the MTU for the DHCP routes. Please see the [Route] section for further
          details.</para>
 
          <xi:include href="version-info.xml" xpointer="v245"/>
        </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 acquired DHCPv4 lease. When unset, the kernel's default will be used.</para>
 
          <xi:include href="version-info.xml" xpointer="v253"/>
        </listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>InitialCongestionWindow=</varname></term>
        <listitem>
          <para>As in the [Route] section.</para>
 
        <xi:include href="version-info.xml" xpointer="v255"/>
        </listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>InitialAdvertisedReceiveWindow=</varname></term>
        <listitem>
          <para>As in the [Route] section.</para>
 
        <xi:include href="version-info.xml" xpointer="v255"/>
        </listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>UseGateway=</varname></term>
        <listitem>
          <para>When true, and the DHCP server provides a Router option, the default gateway based on the
          router address will be configured. Defaults to unset, and the value specified with
          <varname>UseRoutes=</varname> will be used.</para>
 
          <para>Note, when the server provides both the Router and Classless Static Routes option, and
          <varname>UseRoutes=</varname> is enabled, the Router option is always ignored regardless of this
          setting. See <ulink url="https://datatracker.ietf.org/doc/html/rfc3442">RFC 3442</ulink>.</para>
 
          <xi:include href="version-info.xml" xpointer="v246"/>
        </listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>UseTimezone=</varname></term>
        <listitem><para>When true, the timezone received from the DHCP server will be set as timezone
        of the local system. Defaults to false.</para>
 
        <xi:include href="version-info.xml" xpointer="v226"/></listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>Use6RD=</varname></term>
        <listitem>
          <para>When true, subnets of the received IPv6 prefix are assigned to downstream interfaces
          which enables <varname>DHCPPrefixDelegation=</varname>. See also
          <varname>DHCPPrefixDelegation=</varname> in the [Network] section, the [DHCPPrefixDelegation]
          section, and <ulink url="https://tools.ietf.org/html/rfc5969">RFC 5969</ulink>. Defaults to
          false.</para>
 
          <xi:include href="version-info.xml" xpointer="v250"/>
        </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 acquired 6RD 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>IPv6OnlyMode=</varname></term>
        <listitem>
          <para>When true, the DHCPv4 configuration will be delayed by the timespan provided by the DHCP
          server and skip to configure dynamic IPv4 network connectivity if IPv6 connectivity is provided
          within the timespan. See <ulink url="https://tools.ietf.org/html/rfc8925">RFC 8925</ulink>.
          Defaults to false.</para>
 
          <xi:include href="version-info.xml" xpointer="v255"/>
        </listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>FallbackLeaseLifetimeSec=</varname></term>
        <listitem>
          <para>Allows one to set DHCPv4 lease lifetime when DHCPv4 server does not send the lease
          lifetime. Takes one of <literal>forever</literal> or <literal>infinity</literal>. If
          specified, the acquired address never expires. Defaults to unset.</para>
 
          <xi:include href="version-info.xml" xpointer="v246"/>
        </listitem>
      </varlistentry>
 
      <!-- How to communicate with the server -->
 
      <varlistentry>
        <term><varname>RequestBroadcast=</varname></term>
        <listitem>
          <para>Request the server to use broadcast messages before the IP address has been configured.
          This is necessary for devices that cannot receive RAW packets, or that cannot receive packets
          at all before an IP address has been configured. On the other hand, this must not be enabled
          on networks where broadcasts are filtered out.</para>
 
          <xi:include href="version-info.xml" xpointer="v216"/>
        </listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>MaxAttempts=</varname></term>
        <listitem>
          <para>Specifies how many times the DHCPv4 client configuration should be attempted. Takes a
          number or <literal>infinity</literal>. Defaults to <literal>infinity</literal>. Note that the