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 6001–7000 of 7,055

          string is assigned, then the all previous assignments are cleared.</para>
 
          <xi:include href="version-info.xml" xpointer="v246"/>
        </listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>PriorityMap=</varname></term>
        <listitem>
          <para>The priority map maps the priority of a packet to a band. The argument is a whitespace
          separated list of numbers. The first number indicates which band the packets with priority 0 should
          be put to, the second is for priority 1, and so on. There can be up to 16 numbers in the list. If
          there are fewer, the default band that traffic with one of the unmentioned priorities goes to is
          the last one. Each band number must be in the range 0…255. This setting can be specified multiple
          times. If an empty string is assigned, then the all previous assignments are cleared.</para>
 
          <xi:include href="version-info.xml" xpointer="v246"/>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>
 
  <refsect1>
    <title>[GenericRandomEarlyDetection] Section Options</title>
    <para>The [GenericRandomEarlyDetection] section manages the queueing discipline (qdisc) of Generic Random
    Early Detection (GRED).</para>
 
    <variablelist class='network-directives'>
      <xi:include href="tc.xml" xpointer="qdisc-parent" />
      <xi:include href="tc.xml" xpointer="qdisc-handle" />
 
      <varlistentry>
        <term><varname>VirtualQueues=</varname></term>
        <listitem>
          <para>Specifies the number of virtual queues. Takes an integer in the range 1…16. Defaults to unset
          and kernel's default is used.</para>
 
          <xi:include href="version-info.xml" xpointer="v246"/>
        </listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>DefaultVirtualQueue=</varname></term>
        <listitem>
          <para>Specifies the number of default virtual queue. This must be less than <varname>VirtualQueue=</varname>.
          Defaults to unset and kernel's default is used.</para>
 
        <xi:include href="version-info.xml" xpointer="v246"/>
        </listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>GenericRIO=</varname></term>
        <listitem>
          <para>Takes a boolean. It turns on the RIO-like buffering scheme. Defaults to
          unset and kernel's default is used.</para>
 
          <xi:include href="version-info.xml" xpointer="v246"/>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>
 
  <refsect1>
    <title>[FairQueueingControlledDelay] Section Options</title>
    <para>The [FairQueueingControlledDelay] section manages the queueing discipline (qdisc) of fair queuing
    controlled delay (FQ-CoDel).</para>
 
    <variablelist class='network-directives'>
      <xi:include href="tc.xml" xpointer="qdisc-parent" />
      <xi:include href="tc.xml" xpointer="qdisc-handle" />
 
      <varlistentry>
        <term><varname>PacketLimit=</varname></term>
        <listitem>
          <para>Specifies the hard limit on the real queue size. When this limit is reached, incoming packets are
          dropped. Defaults to unset and kernel's default is used.</para>
 
          <xi:include href="version-info.xml" xpointer="v245"/>
        </listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>MemoryLimitBytes=</varname></term>
        <listitem>
          <para>Specifies the limit on the total number of bytes that can be queued in this FQ-CoDel instance.
          When suffixed with K, M, or G, the specified size is parsed as Kilobytes, Megabytes, or Gigabytes,
          respectively, to the base of 1024. Defaults to unset and kernel's default is used.</para>
 
          <xi:include href="version-info.xml" xpointer="v246"/>
        </listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>Flows=</varname></term>
        <listitem>
          <para>Specifies the number of flows into which the incoming packets are classified.
          Defaults to unset and kernel's default is used.</para>
 
          <xi:include href="version-info.xml" xpointer="v245"/>
        </listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>TargetSec=</varname></term>
        <listitem>
          <para>Takes a timespan. Specifies the acceptable minimum standing/persistent queue delay.
          Defaults to unset and kernel's default is used.</para>
 
          <xi:include href="version-info.xml" xpointer="v245"/>
        </listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>IntervalSec=</varname></term>
        <listitem>
          <para>Takes a timespan. This is used to ensure that the measured minimum delay does not
          become too stale. Defaults to unset and kernel's default is used.</para>
 
          <xi:include href="version-info.xml" xpointer="v245"/>
        </listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>QuantumBytes=</varname></term>
        <listitem>
          <para>Specifies the number of bytes used as the "deficit" in the fair queuing algorithm timespan.
          When suffixed with K, M, or G, the specified size is parsed as Kilobytes, Megabytes, or Gigabytes,
          respectively, to the base of 1024. Defaults to unset and kernel's default is used.</para>
 
          <xi:include href="version-info.xml" xpointer="v246"/>
        </listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>ECN=</varname></term>
        <listitem>
          <para>Takes a boolean. This can be used to mark packets instead of dropping them. Defaults to
          unset and kernel's default is used.</para>
 
          <xi:include href="version-info.xml" xpointer="v245"/>
        </listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>CEThresholdSec=</varname></term>
        <listitem>
          <para>Takes a timespan. This sets a threshold above which all packets are marked with ECN
          Congestion Experienced (CE). Defaults to unset and kernel's default is used.</para>
 
          <xi:include href="version-info.xml" xpointer="v245"/>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>
 
  <refsect1>
    <title>[FairQueueing] Section Options</title>
    <para>The [FairQueueing] section manages the queueing discipline (qdisc) of fair queue traffic policing
    (FQ).</para>
 
    <variablelist class='network-directives'>
      <xi:include href="tc.xml" xpointer="qdisc-parent" />
      <xi:include href="tc.xml" xpointer="qdisc-handle" />
 
      <varlistentry>
        <term><varname>PacketLimit=</varname></term>
        <listitem>
          <para>Specifies the hard limit on the real queue size. When this limit is reached, incoming packets are
          dropped. Defaults to unset and kernel's default is used.</para>
 
          <xi:include href="version-info.xml" xpointer="v245"/>
        </listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>FlowLimit=</varname></term>
        <listitem>
          <para>Specifies the hard limit on the maximum number of packets queued per flow. Defaults to
          unset and kernel's default is used.</para>
 
          <xi:include href="version-info.xml" xpointer="v245"/>
        </listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>QuantumBytes=</varname></term>
        <listitem>
          <para>Specifies the credit per dequeue RR round, i.e. the amount of bytes a flow is allowed
          to dequeue at once. When suffixed with K, M, or G, the specified size is parsed as Kilobytes,
          Megabytes, or Gigabytes, respectively, to the base of 1024. Defaults to unset and kernel's
          default is used.</para>
 
          <xi:include href="version-info.xml" xpointer="v246"/>
        </listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>InitialQuantumBytes=</varname></term>
        <listitem>
          <para>Specifies the initial sending rate credit, i.e. the amount of bytes a new flow is
          allowed to dequeue initially. When suffixed with K, M, or G, the specified size is parsed as
          Kilobytes, Megabytes, or Gigabytes, respectively, to the base of 1024. Defaults to unset and
          kernel's default is used.</para>
 
          <xi:include href="version-info.xml" xpointer="v245"/>
        </listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>MaximumRate=</varname></term>
        <listitem>
          <para>Specifies the maximum sending rate of a flow. When suffixed with K, M, or G, the
          specified size is parsed as Kilobits, Megabits, or Gigabits, respectively, to the base of
          1000. Defaults to unset and kernel's default is used.</para>
 
          <xi:include href="version-info.xml" xpointer="v245"/>
        </listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>Buckets=</varname></term>
        <listitem>
          <para>Specifies the size of the hash table used for flow lookups. Defaults to unset and
          kernel's default is used.</para>
 
          <xi:include href="version-info.xml" xpointer="v245"/>
        </listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>OrphanMask=</varname></term>
        <listitem>
          <para>Takes an unsigned integer. For packets not owned by a socket, fq is able to mask a part
          of hash and reduce number of buckets associated with the traffic. Defaults to unset and
          kernel's default is used.</para>
 
          <xi:include href="version-info.xml" xpointer="v245"/>
        </listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>Pacing=</varname></term>
        <listitem>
          <para>Takes a boolean, and enables or disables flow pacing. Defaults to unset and kernel's
          default is used.</para>
 
          <xi:include href="version-info.xml" xpointer="v245"/>
        </listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>CEThresholdSec=</varname></term>
        <listitem>
          <para>Takes a timespan. This sets a threshold above which all packets are marked with ECN
          Congestion Experienced (CE). Defaults to unset and kernel's default is used.</para>
 
          <xi:include href="version-info.xml" xpointer="v245"/>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>
 
  <refsect1>
    <title>[TrivialLinkEqualizer] Section Options</title>
    <para>The [TrivialLinkEqualizer] section manages the queueing discipline (qdisc) of trivial link
    equalizer (teql).</para>
 
    <variablelist class='network-directives'>
      <xi:include href="tc.xml" xpointer="qdisc-parent" />
      <xi:include href="tc.xml" xpointer="qdisc-handle" />
 
      <varlistentry>
        <term><varname>Id=</varname></term>
        <listitem>
          <para>Specifies the interface ID <literal>N</literal> of teql. Defaults to <literal>0</literal>.
          Note that when teql is used, currently, the module <constant>sch_teql</constant> with
          <constant>max_equalizers=N+1</constant> option must be loaded before
          <command>systemd-networkd</command> is started.</para>
 
        <xi:include href="version-info.xml" xpointer="v245"/>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>
 
  <refsect1>
    <title>[HierarchyTokenBucket] Section Options</title>
    <para>The [HierarchyTokenBucket] section manages the queueing discipline (qdisc) of hierarchy token
    bucket (htb).</para>
 
    <variablelist class='network-directives'>
      <xi:include href="tc.xml" xpointer="qdisc-parent" />
      <xi:include href="tc.xml" xpointer="qdisc-handle" />
 
      <varlistentry>
        <term><varname>DefaultClass=</varname></term>
        <listitem>
          <para>Takes the minor id in hexadecimal of the default class. Unclassified traffic gets sent
          to the class. Defaults to unset.</para>
 
          <xi:include href="version-info.xml" xpointer="v246"/>
        </listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>RateToQuantum=</varname></term>
        <listitem>
          <para>Takes an unsigned integer. The DRR quantums are calculated by dividing the value
          configured in <varname>Rate=</varname> by <varname>RateToQuantum=</varname>.</para>
 
          <xi:include href="version-info.xml" xpointer="v246"/>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>
 
  <refsect1>
    <title>[HierarchyTokenBucketClass] Section Options</title>
    <para>The [HierarchyTokenBucketClass] section manages the traffic control class of hierarchy token bucket
    (htb).</para>
 
    <variablelist class='network-directives'>
      <xi:include href="tc.xml" xpointer="tclass-parent" />
      <xi:include href="tc.xml" xpointer="tclass-classid" />
 
      <varlistentry>
        <term><varname>Priority=</varname></term>
        <listitem>
          <para>Specifies the priority of the class. In the round-robin process, classes with the lowest
          priority field are tried for packets first.</para>
 
          <xi:include href="version-info.xml" xpointer="v246"/>
        </listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>QuantumBytes=</varname></term>
        <listitem>
          <para>Specifies how many bytes to serve from leaf at once. When suffixed with K, M, or G, the
          specified size is parsed as Kilobytes, Megabytes, or Gigabytes, respectively, to the base of
          1024.</para>
 
          <xi:include href="version-info.xml" xpointer="v246"/>
        </listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>MTUBytes=</varname></term>
        <listitem>
          <para>Specifies the maximum packet size we create. When suffixed with K, M, or G, the specified
          size is parsed as Kilobytes, Megabytes, or Gigabytes, respectively, to the base of 1024.</para>
 
          <xi:include href="version-info.xml" xpointer="v246"/>
        </listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>OverheadBytes=</varname></term>
        <listitem>
          <para>Takes an unsigned integer which specifies per-packet size overhead used in rate
          computations. When suffixed with K, M, or G, the specified size is parsed as Kilobytes,
          Megabytes, or Gigabytes, respectively, to the base of 1024.</para>
 
          <xi:include href="version-info.xml" xpointer="v246"/>
        </listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>Rate=</varname></term>
        <listitem>
          <para>Specifies the maximum rate this class and all its children are guaranteed. When suffixed
          with K, M, or G, the specified size is parsed as Kilobits, Megabits, or Gigabits, respectively,
          to the base of 1000. This setting is mandatory.</para>
 
          <xi:include href="version-info.xml" xpointer="v246"/>
        </listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>CeilRate=</varname></term>
        <listitem>
          <para>Specifies the maximum rate at which a class can send, if its parent has bandwidth to spare.
          When suffixed with K, M, or G, the specified size is parsed as Kilobits, Megabits, or Gigabits,
          respectively, to the base of 1000. When unset, the value specified with <varname>Rate=</varname>
          is used.</para>
 
          <xi:include href="version-info.xml" xpointer="v246"/>
        </listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>BufferBytes=</varname></term>
        <listitem>
          <para>Specifies the maximum bytes burst which can be accumulated during idle period. When suffixed
          with K, M, or G, the specified size is parsed as Kilobytes, Megabytes, or Gigabytes, respectively,
          to the base of 1024.</para>
 
          <xi:include href="version-info.xml" xpointer="v246"/>
        </listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>CeilBufferBytes=</varname></term>
        <listitem>
          <para>Specifies the maximum bytes burst for ceil which can be accumulated during idle period.
          When suffixed with K, M, or G, the specified size is parsed as Kilobytes, Megabytes, or Gigabytes,
          respectively, to the base of 1024.</para>
 
          <xi:include href="version-info.xml" xpointer="v246"/>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>
 
  <refsect1>
    <title>[ClassfulMultiQueueing] Section Options</title>
    <para>The [ClassfulMultiQueueing] section manages the queueing discipline (qdisc) of Classful Multi Queueing (mq).</para>
 
    <variablelist class='network-directives'>
      <xi:include href="tc.xml" xpointer="qdisc-parent" />
      <xi:include href="tc.xml" xpointer="qdisc-handle" />
    </variablelist>
  </refsect1>
 
  <refsect1>
    <title>[BandMultiQueueing] Section Options</title>
    <para>The [BandMultiQueueing] section manages the queueing discipline (qdisc) of Band Multi Queueing (multiq).</para>
 
    <variablelist class='network-directives'>
      <xi:include href="tc.xml" xpointer="qdisc-parent" />
      <xi:include href="tc.xml" xpointer="qdisc-handle" />
    </variablelist>
  </refsect1>
 
  <refsect1>
    <title>[HeavyHitterFilter] Section Options</title>
    <para>The [HeavyHitterFilter] section manages the queueing discipline (qdisc) of Heavy Hitter Filter
    (hhf).</para>
 
    <variablelist class='network-directives'>
      <xi:include href="tc.xml" xpointer="qdisc-parent" />
      <xi:include href="tc.xml" xpointer="qdisc-handle" />
 
      <varlistentry>
        <term><varname>PacketLimit=</varname></term>
        <listitem>
          <para>Specifies the hard limit on the queue size in number of packets. When this limit is reached,
          incoming packets are dropped. An unsigned integer in the range 0…4294967294. Defaults to unset and
          kernel's default is used.</para>
 
          <xi:include href="version-info.xml" xpointer="v246"/>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>
 
  <refsect1>
    <title>[QuickFairQueueing] Section Options</title>
    <para>The [QuickFairQueueing] section manages the queueing discipline (qdisc) of Quick Fair Queueing
    (QFQ).</para>
 
    <variablelist class='network-directives'>
      <xi:include href="tc.xml" xpointer="qdisc-parent" />
      <xi:include href="tc.xml" xpointer="qdisc-handle" />
    </variablelist>
  </refsect1>
 
  <refsect1>
    <title>[QuickFairQueueingClass] Section Options</title>
    <para>The [QuickFairQueueingClass] section manages the traffic control class of Quick Fair Queueing
    (qfq).</para>
 
    <variablelist class='network-directives'>
      <xi:include href="tc.xml" xpointer="tclass-parent" />
      <xi:include href="tc.xml" xpointer="tclass-classid" />
 
      <varlistentry>
        <term><varname>Weight=</varname></term>
        <listitem>
          <para>Specifies the weight of the class. Takes an integer in the range 1…1023. Defaults to
          unset in which case the kernel default is used.</para>
 
          <xi:include href="version-info.xml" xpointer="v246"/>
        </listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>MaxPacketBytes=</varname></term>
        <listitem>
          <para>Specifies the maximum packet size in bytes for the class. When suffixed with K, M, or G, the
          specified size is parsed as Kilobytes, Megabytes, or Gigabytes, respectively, to the base of
          1024. When unset, the kernel default is used.</para>
 
          <xi:include href="version-info.xml" xpointer="v246"/>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>
 
  <refsect1>
    <title>[BridgeVLAN] Section Options</title>
    <para>
      The [BridgeVLAN] section manages the VLAN ID configuration of a bridge master or enslaved device.
      To make the settings in this section take an effect,
      <varname>VLANFiltering=</varname> option has to be enabled on the bridge master, see the [Bridge]
      section in
      <citerefentry><refentrytitle>systemd.netdev</refentrytitle><manvolnum>5</manvolnum></citerefentry>, and
      each enslaved device needs to define the relevant VLAN IDs in its own [BridgeVLAN] section, which it
      has in common with the bridge master.
      All assigned VLAN IDs on the interface that are not configured in the .network file will be removed. If
      VLAN IDs on an interface need to be managed by other tools, then the settings in this section cannot
      be used in the matching .network file and <varname>VLANFiltering=</varname> needs to be disabled on
      the bridge master.
    </para>
 
    <variablelist class='network-directives'>
      <varlistentry>
        <term><varname>VLAN=</varname></term>
        <listitem>
          <para>The VLAN ID allowed on the port. This can be either a single ID or a range M-N. Takes an
          integer in the range 1…4094. This setting can be specified multiple times. If an empty string is
          assigned, then the all previous assignments are cleared.</para>
 
          <xi:include href="version-info.xml" xpointer="v231"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>EgressUntagged=</varname></term>
        <listitem>
          <para>The VLAN ID specified here will be used to untag frames on egress. Configuring
          <varname>EgressUntagged=</varname> implicates the use of <varname>VLAN=</varname> above and will
          enable the VLAN ID for ingress as well. This can be either a single ID or a range M-N. This
          setting can be specified multiple times. If an empty string is assigned, then the all previous
          assignments are cleared.</para>
 
          <xi:include href="version-info.xml" xpointer="v231"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>PVID=</varname></term>
        <listitem>
          <para>The port VLAN ID specified here is assigned to all untagged frames at ingress. Takes an
          VLAN ID or negative boolean value (e.g. <literal>no</literal>). When false, the currently
          assigned port VLAN ID will be dropped. Configuring <varname>PVID=</varname> implicates the use of
          <varname>VLAN=</varname> setting in the above and will enable the VLAN ID for ingress as well.
          Defaults to unset, and will keep the assigned port VLAN ID if exists.</para>
 
          <xi:include href="version-info.xml" xpointer="v231"/>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>
 
  <refsect1>
    <title>[MobileNetwork] Section Options</title>
 
    <para>This section configures the default setting of the ModemManager integration. See
    <ulink url="https://modemmanager.org/docs/modemmanager/" /> for more information about ModemManager.</para>
 
    <para>Regardless of the [MobileNetwork] section settings consider using the following for LTE modems (take into account
    that LTE modems do not typically support LLDP because LLDP is a Layer 2 protocol for Ethernet networks and an LTE
    modem connects to a cellular network, not a local Ethernet LAN):
      <programlisting>[Network]
LLDP=no
LinkLocalAddressing=no
IPv6AcceptRA=no
      </programlisting>
    </para>
 
    <para>The following options are available in the [MobileNetwork] section:</para>
    <variablelist class='network-directives'>
      <varlistentry>
        <term><varname>APN=</varname></term>
        <listitem>
          <para>An Access Point Name (APN) is the name of a gateway between a mobile network
          (GSM, GPRS, 3G, 4G and 5G) and another computer network. Required in 3GPP.
          Defaults to unset and no attempt to establish the connection is made.</para>
 
          <xi:include href="version-info.xml" xpointer="v260"/>
        </listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>AllowedAuthenticationMechanisms=</varname></term>
        <listitem>
          <para>Authentication method to use. Specifies the white-space separated list of
          <literal>none</literal>, <literal>pap</literal>, <literal>chap</literal>,
          <literal>mschap</literal>, <literal>mschapv2</literal>, or <literal>eap</literal>
          methods. Optional in 3GPP. Defaults to unset and an automatically picked
          authentication method will be used.</para>
 
          <xi:include href="version-info.xml" xpointer="v260"/>
        </listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>User=</varname></term>
        <listitem>
          <para>User name (if any) required by the network. Optional in 3GPP.
          Defaults to unset.</para>
 
          <xi:include href="version-info.xml" xpointer="v260"/>
        </listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>Password=</varname></term>
        <listitem>
          <para>Password (if any) required by the network. Optional in 3GPP.
          Defaults to unset.</para>
 
          <xi:include href="version-info.xml" xpointer="v260"/>
        </listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>IPFamily=</varname></term>
        <listitem>
          <para>Addressing type. Takes one of <literal>ipv4</literal>, <literal>ipv6</literal>,
          <literal>both</literal>, or <literal>any</literal>. Optional in 3GPP and CDMA.
          Defaults to unset and automatically selected.</para>
 
          <xi:include href="version-info.xml" xpointer="v260"/>
        </listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>AllowRoaming=</varname></term>
        <listitem>
          <para>A boolean. When true, connection is allowed during roaming. When false,
          connection is not allowed during roaming.
          Optional in 3GPP. Defaults to <literal>yes</literal>.</para>
 
          <xi:include href="version-info.xml" xpointer="v260"/>
        </listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>PIN=</varname></term>
        <listitem>
          <para>SIM-PIN unlock code. Defaults to unset.</para>
 
          <xi:include href="version-info.xml" xpointer="v260"/>
        </listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>OperatorId=</varname></term>
        <listitem>
          <para>ETSI MCC-MNC of a network to force registration. Defaults to unset.</para>
 
          <xi:include href="version-info.xml" xpointer="v260"/>
        </listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>RouteMetric=</varname></term>
        <listitem>
          <para>Set the routing metric for routes specified by the mobile network (including the prefix route
          added for the specified prefix). Takes an unsigned integer in the range 0…4294967295.
          When unset or set to 0, the kernel's default value will be used.</para>
 
          <xi:include href="version-info.xml" xpointer="v260"/>
        </listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>UseGateway=</varname></term>
        <listitem>
          <para>When true (the default), the router address will be configured as the default gateway.</para>
 
          <xi:include href="version-info.xml" xpointer="v260"/>
        </listitem>
      </varlistentry>
 
    </variablelist>
  </refsect1>
 
  <refsect1>
    <title>Examples</title>
    <example>
      <title>Static network configuration</title>
 
      <programlisting># /etc/systemd/network/50-static.network
[Match]
Name=enp2s0
 
[Network]
Address=192.168.0.15/24
Gateway=192.168.0.1</programlisting>
 
      <para>This brings interface <literal>enp2s0</literal> up with a static address. The
      specified gateway will be used for a default route.</para>
    </example>
 
    <example>
      <title>DHCP on ethernet links</title>
 
      <programlisting># /etc/systemd/network/60-dhcp.network
[Match]
Name=en*
 
[Network]
DHCP=yes</programlisting>
 
      <para>This will enable DHCPv4 and DHCPv6 on all interfaces with names starting with
      <literal>en</literal> (i.e. ethernet interfaces).</para>
    </example>
 
    <example>
      <title>IPv6 Prefix Delegation (DHCPv6 PD)</title>
 
      <programlisting># /etc/systemd/network/55-dhcpv6-pd-upstream.network
[Match]
Name=enp1s0
 
[Network]
DHCP=ipv6
 
# The lines below are optional, to also assign an address in the delegated prefix
# to the upstream interface. Uncomment the lines below if necessary.
#[Network]
#DHCPPrefixDelegation=yes
#[DHCPPrefixDelegation]
#UplinkInterface=:self
#SubnetId=0
#Announce=no
 
# If the upstream network does not provides any Router Advertisement (RA) messages,
# then uncomment the lines below to make the DHCPv6 client forcibly started in the
# managed mode.
#[Network]
#IPv6AcceptRA=no
#[DHCPv6]
#WithoutRA=solicit
 
# If the upstream network provides Router Advertisement (RA) messages with the
# Managed bit unset, then uncomment the lines below to make the DHCPv6 client
# forcibly started in the managed mode when an RA is received.
#[DHCPv6]
#UseAddress=no
#[IPv6AcceptRA]
#DHCPv6Client=always</programlisting>
 
      <programlisting># /etc/systemd/network/55-dhcpv6-pd-downstream.network
[Match]
Name=enp2s0
 
[Network]
DHCPPrefixDelegation=yes
IPv6SendRA=yes
 
# It is expected that the host is acting as a router. So, usually it is not
# necessary to receive Router Advertisement from other hosts in the downstream network.
IPv6AcceptRA=no
 
[DHCPPrefixDelegation]
UplinkInterface=enp1s0
SubnetId=1
Announce=yes</programlisting>
 
      <para>This will enable DHCPv6-PD on the interface enp1s0 as an upstream interface where the
      DHCPv6 client is running and enp2s0 as a downstream interface where the prefix is delegated to.
      The delegated prefixes are distributed by IPv6 Router Advertisement on the downstream network.
      </para>
    </example>
 
    <example>
      <title>IPv6 Prefix Delegation (DHCPv4 6RD)</title>
 
      <programlisting># /etc/systemd/network/55-dhcpv4-6rd-upstream.network
[Match]
Name=enp1s0
 
[Network]
DHCP=ipv4
 
# When DHCPv4-6RD is used, the upstream network does not support IPv6.
# Hence, it is not necessary to wait for Router Advertisement, which is enabled by default.
IPv6AcceptRA=no
 
[DHCPv4]
Use6RD=yes</programlisting>
 
      <programlisting># /etc/systemd/network/55-dhcpv4-6rd-downstream.network
[Match]
Name=enp2s0
 
[Network]
DHCPPrefixDelegation=yes
IPv6SendRA=yes
 
# It is expected that the host is acting as a router. So, usually it is not
# necessary to receive Router Advertisement from other hosts in the downstream network.
IPv6AcceptRA=no
 
[DHCPPrefixDelegation]
UplinkInterface=enp1s0
SubnetId=1
Announce=yes</programlisting>
 
      <para>This will enable DHCPv4-6RD on the interface enp1s0 as an upstream interface where the
      DHCPv4 client is running and enp2s0 as a downstream interface where the prefix is delegated to.
      The delegated prefixes are distributed by IPv6 Router Advertisement on the downstream network.
      </para>
    </example>
 
    <example>
      <title>A bridge with two enslaved links</title>
 
      <programlisting># /etc/systemd/network/25-bridge-static.netdev
[NetDev]
Name=bridge0
Kind=bridge</programlisting>
 
      <programlisting># /etc/systemd/network/25-bridge-static.network
[Match]
Name=bridge0
 
[Network]
Address=192.168.0.15/24
Gateway=192.168.0.1
DNS=192.168.0.1</programlisting>
 
      <programlisting># /etc/systemd/network/25-bridge-slave-interface-1.network
[Match]
Name=enp2s0
 
[Network]
Bridge=bridge0</programlisting>
 
      <programlisting># /etc/systemd/network/25-bridge-slave-interface-2.network
[Match]
Name=wlp3s0
 
[Network]
Bridge=bridge0</programlisting>
 
      <para>This creates a bridge and attaches devices <literal>enp2s0</literal> and
      <literal>wlp3s0</literal> to it. The bridge will have the specified static address
      and network assigned, and a default route via the specified gateway will be
      added. The specified DNS server will be added to the global list of DNS resolvers.
      </para>
    </example>
 
    <example>
      <title>Bridge port with VLAN forwarding</title>
 
      <programlisting>
# /etc/systemd/network/25-bridge-slave-interface-1.network
[Match]
Name=enp2s0
 
[Network]
Bridge=bridge0
 
[BridgeVLAN]
VLAN=1-32
PVID=42
EgressUntagged=42
 
[BridgeVLAN]
VLAN=100-299
 
[BridgeVLAN]
EgressUntagged=300-400</programlisting>
 
    <para>This overrides the configuration specified in the previous example for the
    interface <literal>enp2s0</literal>, and enables VLAN on that bridge port. VLAN IDs
    1-32, 42, 100-400 will be allowed. Packets tagged with VLAN IDs 42, 300-400 will be
    untagged when they leave on this interface. Untagged packets which arrive on this
    interface will be assigned VLAN ID 42.</para>
    </example>
 
    <example>
      <title>Various tunnels</title>
 
      <programlisting>/etc/systemd/network/25-tunnels.network
[Match]
Name=ens1
 
[Network]
Tunnel=ipip-tun
Tunnel=sit-tun
Tunnel=gre-tun
Tunnel=vti-tun
</programlisting>
 
      <programlisting>/etc/systemd/network/25-tunnel-ipip.netdev
[NetDev]
Name=ipip-tun
Kind=ipip
</programlisting>
 
      <programlisting>/etc/systemd/network/25-tunnel-sit.netdev
[NetDev]
Name=sit-tun
Kind=sit
</programlisting>
 
      <programlisting>/etc/systemd/network/25-tunnel-gre.netdev
[NetDev]
Name=gre-tun
Kind=gre
</programlisting>
 
      <programlisting>/etc/systemd/network/25-tunnel-vti.netdev
[NetDev]
Name=vti-tun
Kind=vti
</programlisting>
 
      <para>This will bring interface <literal>ens1</literal> up and create an IPIP tunnel,
      a SIT tunnel, a GRE tunnel, and a VTI tunnel using it.</para>
    </example>
 
    <example>
      <title>A bond device</title>
 
      <programlisting># /etc/systemd/network/30-bond1.network
[Match]
Name=bond1
 
[Network]
DHCP=ipv6
</programlisting>
 
      <programlisting># /etc/systemd/network/30-bond1.netdev
[NetDev]
Name=bond1
Kind=bond
</programlisting>
 
      <programlisting># /etc/systemd/network/30-bond1-dev1.network
[Match]
MACAddress=52:54:00:e9:64:41
 
[Network]
Bond=bond1
</programlisting>
 
      <programlisting># /etc/systemd/network/30-bond1-dev2.network
[Match]
MACAddress=52:54:00:e9:64:42
 
[Network]
Bond=bond1
</programlisting>
 
    <para>This will create a bond device <literal>bond1</literal> and enslave the two
    devices with MAC addresses 52:54:00:e9:64:41 and 52:54:00:e9:64:42 to it. IPv6 DHCP
    will be used to acquire an address.</para>
    </example>
 
    <example>
      <title>Virtual Routing and Forwarding (VRF)</title>
      <para>Add the <literal>bond1</literal> interface to the VRF master interface
      <literal>vrf1</literal>. This will redirect routes generated on this interface to be
      within the routing table defined during VRF creation. For kernels before 4.8 traffic
      will not be redirected towards the VRFs routing table unless specific ip-rules are added.
      </para>
      <programlisting># /etc/systemd/network/25-vrf.network
[Match]
Name=bond1
 
[Network]
VRF=vrf1
</programlisting>
    </example>
 
    <example>
      <title>MacVTap</title>
      <para>This brings up a network interface <literal>macvtap-test</literal>
      and attaches it to <literal>enp0s25</literal>.</para>
      <programlisting># /usr/lib/systemd/network/25-macvtap.network
[Match]
Name=enp0s25
 
[Network]
MACVTAP=macvtap-test
</programlisting>
    </example>
 
    <example>
      <title>A Xfrm interface with physical underlying device.</title>
 
      <programlisting># /etc/systemd/network/27-xfrm.netdev
[NetDev]
Name=xfrm0
Kind=xfrm
 
[Xfrm]
InterfaceId=7</programlisting>
 
      <programlisting># /etc/systemd/network/27-eth0.network
[Match]
Name=eth0
 
[Network]