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 5001–6000 of 7,055

    keys:</para>
 
    <variablelist class='network-directives'>
      <varlistentry>
        <term><varname>MUDURL=</varname></term>
        <listitem>
          <para>When configured, the specified Manufacturer Usage Descriptions (MUD) URL will be sent in
          LLDP packets. The syntax and semantics are the same as for <varname>MUDURL=</varname> in the
          [DHCPv4] section described above.</para>
 
          <para>The MUD URLs received via LLDP packets are saved and can be read using the
          <function>sd_lldp_neighbor_get_mud_url()</function> function.</para>
 
          <xi:include href="version-info.xml" xpointer="v246"/>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>
 
  <refsect1>
    <title>[CAN] Section Options</title>
    <para>The [CAN] section manages the Controller Area Network (CAN bus) and accepts the
    following keys:</para>
    <variablelist class='network-directives'>
      <varlistentry>
        <term><varname>BitRate=</varname></term>
        <listitem>
          <para>The bitrate of CAN device in bits per second. The usual SI prefixes (K, M) with the base of 1000 can
          be used here. Takes a number in the range 1…4294967295.</para>
 
          <xi:include href="version-info.xml" xpointer="v239"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>SamplePoint=</varname></term>
        <listitem>
          <para>Optional sample point in percent with one decimal (e.g. <literal>75%</literal>,
          <literal>87.5%</literal>) or permille (e.g. <literal>875‰</literal>). This will be ignored when
          <varname>BitRate=</varname> is unspecified.</para>
 
          <xi:include href="version-info.xml" xpointer="v239"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>TimeQuantaNSec=</varname></term>
        <term><varname>PropagationSegment=</varname></term>
        <term><varname>PhaseBufferSegment1=</varname></term>
        <term><varname>PhaseBufferSegment2=</varname></term>
        <term><varname>SyncJumpWidth=</varname></term>
        <listitem>
          <para>Specifies the time quanta, propagation segment, phase buffer segment 1 and 2, and the
          synchronization jump width, which allow one to define the CAN bit-timing in a hardware
          independent format as proposed by the Bosch CAN 2.0 Specification.
          <varname>TimeQuantaNSec=</varname> takes a timespan in nanoseconds.
          <varname>PropagationSegment=</varname>, <varname>PhaseBufferSegment1=</varname>,
          <varname>PhaseBufferSegment2=</varname>, and <varname>SyncJumpWidth=</varname> take number
          of time quantum specified in <varname>TimeQuantaNSec=</varname> and must be an unsigned
          integer in the range 0…4294967295. These settings except for
          <varname>SyncJumpWidth=</varname> will be ignored when <varname>BitRate=</varname> is
          specified.</para>
 
          <xi:include href="version-info.xml" xpointer="v250"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>DataBitRate=</varname></term>
        <term><varname>DataSamplePoint=</varname></term>
        <listitem>
          <para>The bitrate and sample point for the data phase, if CAN-FD is used. These settings are
          analogous to the <varname>BitRate=</varname> and <varname>SamplePoint=</varname> keys.</para>
 
          <xi:include href="version-info.xml" xpointer="v246"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>DataTimeQuantaNSec=</varname></term>
        <term><varname>DataPropagationSegment=</varname></term>
        <term><varname>DataPhaseBufferSegment1=</varname></term>
        <term><varname>DataPhaseBufferSegment2=</varname></term>
        <term><varname>DataSyncJumpWidth=</varname></term>
        <listitem>
          <para>Specifies the time quanta, propagation segment, phase buffer segment 1 and 2, and the
          synchronization jump width for the data phase, if CAN-FD is used. These settings are
          analogous to the <varname>TimeQuantaNSec=</varname> or related settings.</para>
 
          <xi:include href="version-info.xml" xpointer="v250"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>FDMode=</varname></term>
        <listitem>
          <para>Takes a boolean. When <literal>yes</literal>, CAN-FD mode is enabled for the interface.
          Note, that a bitrate and optional sample point should also be set for the CAN-FD data phase using
          the <varname>DataBitRate=</varname> and <varname>DataSamplePoint=</varname> keys, or
          <varname>DataTimeQuanta=</varname> and related settings.</para>
 
          <xi:include href="version-info.xml" xpointer="v246"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>FDNonISO=</varname></term>
        <listitem>
          <para>Takes a boolean. When <literal>yes</literal>, non-ISO CAN-FD mode is enabled for the
          interface. When unset, the kernel's default will be used.</para>
 
          <xi:include href="version-info.xml" xpointer="v246"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>RestartSec=</varname></term>
        <listitem>
          <para>Automatic restart delay time. If set to a non-zero value, a restart of the CAN controller will be
          triggered automatically in case of a bus-off condition after the specified delay time. Subsecond delays can
          be specified using decimals (e.g. <literal>0.1s</literal>) or a <literal>ms</literal> or
          <literal>us</literal> postfix. Using <literal>infinity</literal> or <literal>0</literal> will turn the
          automatic restart off. By default, automatic restart is disabled.</para>
 
          <xi:include href="version-info.xml" xpointer="v239"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>Termination=</varname></term>
        <listitem>
          <para>Takes a boolean or a termination resistor value in ohm in the range 0…65535. When
          <literal>yes</literal>, the termination resistor is set to 120 ohm. When
          <literal>no</literal> or <literal>0</literal> is set, the termination resistor is disabled.
          When unset, the kernel's default will be used.</para>
 
          <xi:include href="version-info.xml" xpointer="v246"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>TripleSampling=</varname></term>
        <listitem>
          <para>Takes a boolean. When <literal>yes</literal>, three samples (instead of one) are used to determine
          the value of a received bit by majority rule. When unset, the kernel's default will be used.</para>
 
          <xi:include href="version-info.xml" xpointer="v242"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>BusErrorReporting=</varname></term>
        <listitem>
          <para>Takes a boolean. When <literal>yes</literal>, reporting of CAN bus errors is activated
          (those include single bit, frame format, and bit stuffing errors, unable to send dominant bit,
          unable to send recessive bit, bus overload, active error announcement, error occurred on
          transmission). When unset, the kernel's default will be used. Note: in case of a CAN bus with a
          single CAN device, sending a CAN frame may result in a huge number of CAN bus errors.</para>
 
          <xi:include href="version-info.xml" xpointer="v248"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>ListenOnly=</varname></term>
        <listitem>
          <para>Takes a boolean. When <literal>yes</literal>, listen-only mode is enabled. When the
          interface is in listen-only mode, the interface neither transmit CAN frames nor send ACK
          bit. Listen-only mode is important to debug CAN networks without interfering with the
          communication or acknowledge the CAN frame. When unset, the kernel's default will be used.
          </para>
 
          <xi:include href="version-info.xml" xpointer="v246"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>Loopback=</varname></term>
        <listitem>
          <para>Takes a boolean. When <literal>yes</literal>, loopback mode is enabled. When the
          loopback mode is enabled, the interface treats messages transmitted by itself as received
          messages. The loopback mode is important to debug CAN networks. When unset, the kernel's
          default will be used.</para>
 
          <xi:include href="version-info.xml" xpointer="v250"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>OneShot=</varname></term>
        <listitem>
          <para>Takes a boolean. When <literal>yes</literal>, one-shot mode is enabled. When unset,
          the kernel's default will be used.</para>
 
          <xi:include href="version-info.xml" xpointer="v250"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>PresumeACK=</varname></term>
        <listitem>
          <para>Takes a boolean. When <literal>yes</literal>, the interface will ignore missing CAN
          ACKs. When unset, the kernel's default will be used.</para>
 
          <xi:include href="version-info.xml" xpointer="v250"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>ClassicDataLengthCode=</varname></term>
        <listitem>
          <para>Takes a boolean. When <literal>yes</literal>, the interface will handle the 4bit data
          length code (DLC). When unset, the kernel's default will be used.</para>
 
          <xi:include href="version-info.xml" xpointer="v250"/>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>
 
  <refsect1>
    <title>[IPoIB] Section Options</title>
    <para>The [IPoIB] section manages the IP over Infiniband and accepts the following keys:</para>
 
    <variablelist class='network-directives'>
      <xi:include href="systemd.netdev.xml" xpointer="ipoib_mode" />
      <xi:include href="systemd.netdev.xml" xpointer="ipoib_umcast" />
    </variablelist>
  </refsect1>
 
  <refsect1>
    <title>[QDisc] Section Options</title>
    <para>The [QDisc] section manages the traffic control queueing discipline (qdisc).</para>
 
    <variablelist class='network-directives'>
      <varlistentry>
        <term><varname>Parent=</varname></term>
        <listitem>
          <para>Specifies the parent Queueing Discipline (qdisc). Takes one of <literal>clsact</literal>
          or <literal>ingress</literal>. This is mandatory.</para>
 
          <xi:include href="version-info.xml" xpointer="v244"/>
        </listitem>
      </varlistentry>
 
      <xi:include href="tc.xml" xpointer="qdisc-handle" />
    </variablelist>
  </refsect1>
 
  <refsect1>
    <title>[NetworkEmulator] Section Options</title>
    <para>The [NetworkEmulator] section manages the queueing discipline (qdisc) of the network emulator. It
    can be used to configure the kernel packet scheduler and simulate packet delay and loss for UDP or TCP
    applications, or limit the bandwidth usage of a particular service to simulate internet connections.
    </para>
 
    <variablelist class='network-directives'>
      <xi:include href="tc.xml" xpointer="qdisc-parent" />
      <xi:include href="tc.xml" xpointer="qdisc-handle" />
 
      <varlistentry>
        <term><varname>DelaySec=</varname></term>
        <listitem>
          <para>Specifies the fixed amount of delay to be added to all packets going out of the
          interface. Defaults to unset.</para>
 
          <xi:include href="version-info.xml" xpointer="v245"/>
        </listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>DelayJitterSec=</varname></term>
        <listitem>
          <para>Specifies the chosen delay to be added to the packets outgoing to the network
          interface. Defaults to unset.</para>
 
          <xi:include href="version-info.xml" xpointer="v245"/>
        </listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>PacketLimit=</varname></term>
        <listitem>
          <para>Specifies the maximum number of packets the qdisc may hold queued at a time.
          An unsigned integer in the range 0…4294967294. Defaults to 1000.</para>
 
          <xi:include href="version-info.xml" xpointer="v245"/>
        </listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>LossRate=</varname></term>
        <listitem>
          <para>Specifies an independent loss probability to be added to the packets outgoing from the
          network interface. Takes a percentage value, suffixed with "%". Defaults to unset.</para>
 
          <xi:include href="version-info.xml" xpointer="v245"/>
        </listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>DuplicateRate=</varname></term>
        <listitem>
          <para>Specifies that the chosen percent of packets is duplicated before queuing them.
          Takes a percentage value, suffixed with "%". Defaults to unset.</para>
 
          <xi:include href="version-info.xml" xpointer="v245"/>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>
 
  <refsect1>
    <title>[TokenBucketFilter] Section Options</title>
    <para>The [TokenBucketFilter] section manages the queueing discipline (qdisc) of token bucket filter
    (tbf).</para>
 
    <variablelist class='network-directives'>
      <xi:include href="tc.xml" xpointer="qdisc-parent" />
      <xi:include href="tc.xml" xpointer="qdisc-handle" />
 
      <varlistentry>
        <term><varname>LatencySec=</varname></term>
        <listitem>
          <para>Specifies the latency parameter, which specifies the maximum amount of time a
          packet can sit in the Token Bucket Filter (TBF). Defaults to unset.</para>
 
          <xi:include href="version-info.xml" xpointer="v245"/>
        </listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>LimitBytes=</varname></term>
        <listitem>
          <para>Takes the number of bytes that can be queued waiting for tokens to become available.
          When the size is suffixed with K, M, or G, it is parsed as Kilobytes, Megabytes, or Gigabytes,
          respectively, to the base of 1024. Defaults to unset.</para>
 
          <xi:include href="version-info.xml" xpointer="v246"/>
        </listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>BurstBytes=</varname></term>
        <listitem>
          <para>Specifies the size of the bucket. This is the maximum amount of bytes that tokens
          can be available for instantaneous transfer. When the size is suffixed with K, M, or G, it is
          parsed as Kilobytes, Megabytes, or Gigabytes, respectively, to the base of 1024. Defaults to
          unset.</para>
 
          <xi:include href="version-info.xml" xpointer="v246"/>
        </listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>Rate=</varname></term>
        <listitem>
          <para>Specifies the device specific bandwidth. When suffixed with K, M, or G, the specified
          bandwidth is parsed as Kilobits, Megabits, or Gigabits, respectively, to the base of 1000.
          Defaults to unset.</para>
 
          <xi:include href="version-info.xml" xpointer="v245"/>
        </listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>MPUBytes=</varname></term>
        <listitem>
          <para>The Minimum Packet Unit (MPU) determines the minimal token usage (specified in bytes)
          for a packet. 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 zero.</para>
 
          <xi:include href="version-info.xml" xpointer="v245"/>
        </listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>PeakRate=</varname></term>
        <listitem>
          <para>Takes the maximum depletion rate of the bucket. 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.</para>
 
          <xi:include href="version-info.xml" xpointer="v245"/>
        </listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>MTUBytes=</varname></term>
        <listitem>
          <para>Specifies the size of the peakrate bucket. 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.</para>
 
          <xi:include href="version-info.xml" xpointer="v245"/>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>
 
  <refsect1>
    <title>[PIE] Section Options</title>
    <para>The [PIE] section manages the queueing discipline (qdisc) of Proportional Integral
    controller-Enhanced (PIE).</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 1…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>[FlowQueuePIE] Section Options</title>
    <para>The <literal>[FlowQueuePIE]</literal> section manages the queueing discipline
    (qdisc) of Flow Queue Proportional Integral controller-Enhanced (fq_pie).</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 ranges 1 to 4294967294. Defaults to unset and
          kernel's default is used.</para>
 
          <xi:include href="version-info.xml" xpointer="v247"/>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>
 
  <refsect1>
    <title>[StochasticFairBlue] Section Options</title>
    <para>The [StochasticFairBlue] section manages the queueing discipline (qdisc) of stochastic fair blue
    (sfb).</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>[StochasticFairnessQueueing] Section Options</title>
    <para>The [StochasticFairnessQueueing] section manages the queueing discipline (qdisc) of stochastic
    fairness queueing (sfq).</para>
 
    <variablelist class='network-directives'>
      <xi:include href="tc.xml" xpointer="qdisc-parent" />
      <xi:include href="tc.xml" xpointer="qdisc-handle" />
 
      <varlistentry>
        <term><varname>PerturbPeriodSec=</varname></term>
        <listitem>
          <para>Specifies the interval in seconds for queue algorithm perturbation. Defaults to unset.</para>
 
        <xi:include href="version-info.xml" xpointer="v245"/>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>
 
  <refsect1>
    <title>[BFIFO] Section Options</title>
    <para>The [BFIFO] section manages the queueing discipline (qdisc) of Byte limited Packet First In First
    Out (bfifo).</para>
 
    <variablelist class='network-directives'>
      <xi:include href="tc.xml" xpointer="qdisc-parent" />
      <xi:include href="tc.xml" xpointer="qdisc-handle" />
 
      <varlistentry>
        <term><varname>LimitBytes=</varname></term>
        <listitem>
          <para>Specifies the hard limit in bytes on the FIFO buffer size. The size limit prevents overflow
          in case the kernel is unable to dequeue packets as quickly as it receives them. When this limit is
          reached, incoming packets are dropped. 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 default is used.</para>
 
          <xi:include href="version-info.xml" xpointer="v246"/>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>
 
  <refsect1>
    <title>[PFIFO] Section Options</title>
    <para>The [PFIFO] section manages the queueing discipline (qdisc) of Packet First In First Out
    (pfifo).</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 number of packets in the FIFO queue. The size limit prevents
          overflow in case the kernel is unable to dequeue packets as quickly as it receives them. 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>[PFIFOHeadDrop] Section Options</title>
    <para>The [PFIFOHeadDrop] section manages the queueing discipline (qdisc) of Packet First In First Out
    Head Drop (pfifo_head_drop).</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>As in [PFIFO] section.</para>
 
        <xi:include href="version-info.xml" xpointer="v246"/></listitem>
      </varlistentry>
    </variablelist>
  </refsect1>
 
  <refsect1>
     <title>[PFIFOFast] Section Options</title>
     <para>The [PFIFOFast] section manages the queueing discipline (qdisc) of Packet First In First Out Fast
     (pfifo_fast).</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>[CAKE] Section Options</title>
    <para>The [CAKE] section manages the queueing discipline (qdisc) of Common Applications Kept Enhanced
    (CAKE).</para>
 
    <variablelist class='network-directives'>
      <xi:include href="tc.xml" xpointer="qdisc-parent" />
      <xi:include href="tc.xml" xpointer="qdisc-handle" />
 
      <varlistentry>
        <term><varname>Bandwidth=</varname></term>
        <listitem>
          <para>Specifies the shaper bandwidth. 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="v246"/>
        </listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>AutoRateIngress=</varname></term>
        <listitem>
          <para>Takes a boolean value. Enables automatic capacity estimation based on traffic arriving
          at this qdisc. This is most likely to be useful with cellular links, which tend to change
          quality randomly. If this setting is enabled, the <varname>Bandwidth=</varname> setting is
          used as an initial estimate. Defaults to unset, and the kernel's default is used.</para>
 
          <xi:include href="version-info.xml" xpointer="v250"/>
        </listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>OverheadBytes=</varname></term>
        <listitem>
          <para>Specifies that bytes to be addeded to the size of each packet. Bytes may be negative.
          Takes an integer in the range -64…256. Defaults to unset and kernel's default is used.
          </para>
 
          <xi:include href="version-info.xml" xpointer="v246"/>
        </listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>MPUBytes=</varname></term>
        <listitem>
          <para>Rounds each packet (including overhead) up to the specified bytes. Takes an integer in
          the range 1…256. Defaults to unset and kernel's default is used.</para>
 
          <xi:include href="version-info.xml" xpointer="v250"/>
        </listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>CompensationMode=</varname></term>
        <listitem>
          <para>Takes one of <literal>none</literal>, <literal>atm</literal>, or <literal>ptm</literal>.
          Specifies the compensation mode for overhead calculation. When <literal>none</literal>, no
          compensation is taken into account. When <literal>atm</literal>, enables the compensation for
          ATM cell framing, which is normally found on ADSL links. When <literal>ptm</literal>, enables
          the compensation for PTM encoding, which is normally found on VDSL2 links and uses a 64b/65b
          encoding scheme. Defaults to unset and the kernel's default is used.</para>
 
        <xi:include href="version-info.xml" xpointer="v250"/>
        </listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>UseRawPacketSize=</varname></term>
        <listitem>
          <para>Takes a boolean value. When true, the packet size reported by the Linux kernel will be
          used, instead of the underlying IP packet size. Defaults to unset, and the kernel's default
          is used.</para>
 
          <xi:include href="version-info.xml" xpointer="v250"/>
        </listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>FlowIsolationMode=</varname></term>
        <listitem>
          <para>CAKE places packets from different flows into different queues, then packets from each
          queue are delivered fairly. This specifies whether the fairness is based on source address,
          destination address, individual flows, or any combination of those. The available values are:
          </para>
 
          <variablelist>
            <varlistentry>
              <term><option>none</option></term>
              <listitem><para>
                The flow isolation is disabled, and all traffic passes through a single queue.
              </para>
 
              <xi:include href="version-info.xml" xpointer="v250"/></listitem>
            </varlistentry>
            <varlistentry>
              <term><option>src-host</option></term>
              <listitem><para>
                Flows are defined only by source address. Equivalent to the <literal>srchost</literal>
                option for <command>tc qdisc</command> command. See also
                <citerefentry project='man-pages'><refentrytitle>tc-cake</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
              </para>
 
                <xi:include href="version-info.xml" xpointer="v250"/></listitem>
            </varlistentry>
            <varlistentry>
              <term><option>dst-host</option></term>
              <listitem><para>
                Flows are defined only by destination address. Equivalent to the
                <literal>dsthost</literal> option for <command>tc qdisc</command> command. See also
                <citerefentry project='man-pages'><refentrytitle>tc-cake</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
              </para>
 
                <xi:include href="version-info.xml" xpointer="v250"/></listitem>
            </varlistentry>
            <varlistentry>
              <term><option>hosts</option></term>
              <listitem><para>
                Flows are defined by source-destination host pairs. Equivalent to the same option for
                <command>tc qdisc</command> command. See also
                <citerefentry project='man-pages'><refentrytitle>tc-cake</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
              </para>
 
                <xi:include href="version-info.xml" xpointer="v250"/></listitem>
            </varlistentry>
            <varlistentry>
              <term><option>flows</option></term>
              <listitem><para>
                Flows are defined by the entire 5-tuple of source address, destination address,
                transport protocol, source port and destination port. Equivalent to the same option for
                <command>tc qdisc</command> command. See also
                <citerefentry project='man-pages'><refentrytitle>tc-cake</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
              </para>
 
                <xi:include href="version-info.xml" xpointer="v250"/></listitem>
            </varlistentry>
            <varlistentry>
              <term><option>dual-src-host</option></term>
              <listitem><para>
                Flows are defined by the 5-tuple (see <literal>flows</literal> in the above), and
                fairness is applied first over source addresses, then over individual flows. Equivalent
                to the <literal>dual-srchost</literal> option for <command>tc qdisc</command> command.
                See also
                <citerefentry project='man-pages'><refentrytitle>tc-cake</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
              </para>
 
                <xi:include href="version-info.xml" xpointer="v250"/></listitem>
            </varlistentry>
            <varlistentry>
              <term><option>dual-dst-host</option></term>
              <listitem><para>
                Flows are defined by the 5-tuple (see <literal>flows</literal> in the above), and
                fairness is applied first over destination addresses, then over individual flows.
                Equivalent to the <literal>dual-dsthost</literal> option for
                <command>tc qdisc</command> command. See also
                <citerefentry project='man-pages'><refentrytitle>tc-cake</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
              </para>
 
                <xi:include href="version-info.xml" xpointer="v250"/></listitem>
            </varlistentry>
            <varlistentry>
              <term><option>triple</option></term>
              <listitem><para>
                Flows are defined by the 5-tuple (see <literal>flows</literal>), and fairness is
                applied over source and destination addresses, and also over individual flows.
                Equivalent to the <literal>triple-isolate</literal> option for
                <command>tc qdisc</command> command. See also
                <citerefentry project='man-pages'><refentrytitle>tc-cake</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
              </para>
 
                <xi:include href="version-info.xml" xpointer="v250"/></listitem>
            </varlistentry>
          </variablelist>
 
          <para>Defaults to unset and the kernel's default is used.</para>
 
          <xi:include href="version-info.xml" xpointer="v250"/>
        </listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>NAT=</varname></term>
        <listitem>
          <para>Takes a boolean value. When true, CAKE performs a NAT lookup before applying
          flow-isolation rules, to determine the true addresses and port numbers of the packet, to
          improve fairness between hosts inside the NAT. This has no practical effect when
          <varname>FlowIsolationMode=</varname> is <literal>none</literal> or <literal>flows</literal>,
          or if NAT is performed on a different host. Defaults to unset, and the kernel's default is
          used.</para>
 
          <xi:include href="version-info.xml" xpointer="v250"/>
        </listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>PriorityQueueingPreset=</varname></term>
        <listitem>
          <para>CAKE divides traffic into <literal>tins</literal>, and each tin has its own independent
          set of flow-isolation queues, bandwidth threshold, and priority. This specifies the preset of
          tin profiles. The available values are:</para>
 
          <variablelist>
            <varlistentry>
              <term><option>besteffort</option></term>
              <listitem><para>
                Disables priority queueing by placing all traffic in one tin.
              </para>
 
              <xi:include href="version-info.xml" xpointer="v250"/></listitem>
            </varlistentry>
            <varlistentry>
              <term><option>precedence</option></term>
              <listitem><para>
                Enables priority queueing based on the legacy interpretation of TOS
                <literal>Precedence</literal> field. Use of this preset on the modern Internet is
                firmly discouraged.
              </para>
 
                <xi:include href="version-info.xml" xpointer="v250"/></listitem>
            </varlistentry>
            <varlistentry>
              <term><option>diffserv8</option></term>
              <listitem><para>
                Enables priority queueing based on the Differentiated Service
                (<literal>DiffServ</literal>) field with eight tins: Background Traffic, High
                Throughput, Best Effort, Video Streaming, Low Latency Transactions, Interactive Shell,
                Minimum Latency, and Network Control.
              </para>
 
                <xi:include href="version-info.xml" xpointer="v250"/></listitem>
            </varlistentry>
            <varlistentry>
              <term><option>diffserv4</option></term>
              <listitem><para>
                Enables priority queueing based on the Differentiated Service
                (<literal>DiffServ</literal>) field with four tins: Background Traffic, Best Effort,
                Streaming Media, and Latency Sensitive.
              </para>
 
                <xi:include href="version-info.xml" xpointer="v250"/></listitem>
            </varlistentry>
            <varlistentry>
              <term><option>diffserv3</option></term>
              <listitem><para>
                Enables priority queueing based on the Differentiated Service
                (<literal>DiffServ</literal>) field with three tins: Background Traffic, Best Effort,
                and Latency Sensitive.
              </para>
 
                <xi:include href="version-info.xml" xpointer="v250"/></listitem>
            </varlistentry>
          </variablelist>
 
          <para>Defaults to unset, and the kernel's default is used.</para>
 
          <xi:include href="version-info.xml" xpointer="v250"/>
        </listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>FirewallMark=</varname></term>
        <listitem>
          <para>Takes an integer in the range 1…4294967295. When specified, firewall-mark-based
          overriding of CAKE's tin selection is enabled. Defaults to unset, and the kernel's default is
          used.</para>
 
          <xi:include href="version-info.xml" xpointer="v250"/>
        </listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>Wash=</varname></term>
        <listitem>
          <para>Takes a boolean value. When true, CAKE clears the DSCP fields, except for ECN bits, of
          any packet passing through CAKE. Defaults to unset, and the kernel's default is used.</para>
 
          <xi:include href="version-info.xml" xpointer="v250"/>
        </listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>SplitGSO=</varname></term>
        <listitem>
          <para>Takes a boolean value. When true, CAKE will split General Segmentation Offload (GSO)
          super-packets into their on-the-wire components and dequeue them individually. Defaults to
          unset, and the kernel's default is used.</para>
 
          <xi:include href="version-info.xml" xpointer="v250"/>
        </listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>RTTSec=</varname></term>
        <listitem>
          <para>Specifies the RTT for the filter. Takes a timespan. Typical values are e.g. 100us for
          extremely high-performance 10GigE+ networks like datacentre, 1ms for non-WiFi LAN connections,
          100ms for typical internet connections. Defaults to unset, and the kernel's default will be used.
          </para>
 
          <xi:include href="version-info.xml" xpointer="v253"/>
        </listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>AckFilter=</varname></term>
        <listitem>
          <para>Takes a boolean value, or special value <literal>aggressive</literal>. If enabled, ACKs in
          each flow are queued and redundant ACKs to the upstream are dropped. If yes, the filter will always
          keep at least two redundant ACKs in the queue, while in <literal>aggressive</literal> mode, it will
          filter down to a single ACK. This may improve download throughput on links with very asymmetrical
          rate limits. Defaults to unset, and the kernel's default will be used.</para>
 
        <xi:include href="version-info.xml" xpointer="v253"/>
        </listitem>
      </varlistentry>
 
    </variablelist>
  </refsect1>
 
  <refsect1>
    <title>[ControlledDelay] Section Options</title>
    <para>The [ControlledDelay] section manages the queueing discipline (qdisc) of
    controlled delay (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 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="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>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>[DeficitRoundRobinScheduler] Section Options</title>
    <para>The [DeficitRoundRobinScheduler] section manages the queueing discipline (qdisc) of Deficit Round
    Robin Scheduler (DRR).</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>[DeficitRoundRobinSchedulerClass] Section Options</title>
    <para>The [DeficitRoundRobinSchedulerClass] section manages the traffic control class of Deficit Round
    Robin Scheduler (DRR).</para>
 
    <variablelist class='network-directives'>
      <xi:include href="tc.xml" xpointer="tclass-parent" />
      <xi:include href="tc.xml" xpointer="tclass-classid" />
 
      <varlistentry>
        <term><varname>QuantumBytes=</varname></term>
        <listitem>
          <para>Specifies the amount of bytes a flow is allowed to dequeue before the scheduler moves
          to the next class. 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 the MTU of the
          interface.</para>
 
          <xi:include href="version-info.xml" xpointer="v246"/>
        </listitem>
      </varlistentry>
 
    </variablelist>
  </refsect1>
 
  <refsect1>
    <title>[EnhancedTransmissionSelection] Section Options</title>
    <para>The [EnhancedTransmissionSelection] section manages the queueing discipline (qdisc) of Enhanced
    Transmission Selection (ETS).</para>
 
    <variablelist class='network-directives'>
      <xi:include href="tc.xml" xpointer="qdisc-parent" />
      <xi:include href="tc.xml" xpointer="qdisc-handle" />
 
      <varlistentry>
        <term><varname>Bands=</varname></term>
        <listitem>
          <para>Specifies the number of bands. An unsigned integer in the range 1…16. This value has to be at
          least large enough to cover the strict bands specified through the <varname>StrictBands=</varname>
          and bandwidth-sharing bands specified in <varname>QuantumBytes=</varname>.</para>
 
          <xi:include href="version-info.xml" xpointer="v246"/>
        </listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>StrictBands=</varname></term>
        <listitem>
          <para>Specifies the number of bands that should be created in strict mode. An unsigned integer in
          the range 1…16.</para>
 
          <xi:include href="version-info.xml" xpointer="v246"/>
        </listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>QuantumBytes=</varname></term>
        <listitem>
          <para>Specifies the white-space separated list of quantum used in band-sharing bands. When
          suffixed with K, M, or G, the specified size is parsed as Kilobytes, Megabytes, or Gigabytes,
          respectively, to the base of 1024. This setting can be specified multiple times. If an empty