shorewall_code/Shorewall/manpages/shorewall-tos.xml

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
"http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd">
<refentry>
  <refmeta>
    <refentrytitle>shorewall-tos</refentrytitle>

    <manvolnum>5</manvolnum>

    <refmiscinfo>Configuration Files</refmiscinfo>
  </refmeta>

  <refnamediv>
    <refname>tos</refname>

    <refpurpose>Shorewall Type of Service rules file</refpurpose>
  </refnamediv>

  <refsynopsisdiv>
    <cmdsynopsis>
      <command>/etc/shorewall/tos</command>
    </cmdsynopsis>
  </refsynopsisdiv>

  <refsect1>
    <title>Description</title>

    <para>This file defines rules for setting Type Of Service (TOS). Its use
    is deprecated, beginning in Shorewall 4.5.1, in favor of the TOS target in
    <ulink url="/manpages/shorewall-mangle.html">shorewall-mangle</ulink>
    (5).</para>

    <para>The columns in the file are as follows (where the column name is
    followed by a different name in parentheses, the different name is used in
    the alternate specification syntax).</para>

    <variablelist>
      <varlistentry>
        <term><emphasis role="bold">SOURCE</emphasis> - {<emphasis
        role="bold">all</emphasis>|<emphasis>address</emphasis>]|<emphasis
        role="bold">all</emphasis>:<emphasis>address</emphasis>|<emphasis
        role="bold">$FW</emphasis>}</term>

        <listitem>
          <para>If <emphasis role="bold">all</emphasis>, may optionally be
          followed by ":" and an IP address, a MAC address, a subnet
          specification or the name of an interface.</para>

          <para>Example: all:192.168.2.3</para>

          <para>MAC addresses must be prefixed with "~" and use "-" as a
          separator.</para>

          <para>Example: ~00-A0-C9-15-39-78</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><emphasis role="bold">DEST</emphasis> - {<emphasis
        role="bold">all</emphasis>|<emphasis>address</emphasis>]|<emphasis
        role="bold">all</emphasis>:<emphasis>address</emphasis>}</term>

        <listitem>
          <para>Example: 192.168.2.3</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><emphasis role="bold">PROTOCOL</emphasis> (proto) -
        <emphasis>proto-name-or-number</emphasis></term>

        <listitem>
          <para>Protocol name or number.</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><emphasis role="bold">SOURCE PORT(S)</emphasis> (sport) -
        {-|<emphasis>port</emphasis>|<emphasis>lowport</emphasis><emphasis
        role="bold">:</emphasis><emphasis>highport</emphasis>}</term>

        <listitem>
          <para>Source port or port range. If all ports, use "-".</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><emphasis role="bold">DEST PORT(S)</emphasis> (dport) -
        {-|<emphasis>port</emphasis>|<emphasis>lowport</emphasis><emphasis
        role="bold">:</emphasis><emphasis>highport</emphasis>}</term>

        <listitem>
          <para>Destination port or port range. If all ports, use "-"</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><emphasis role="bold">TOS</emphasis> -
        <emphasis>tos</emphasis></term>

        <listitem>
          <para>Must may one of the following;</para>

          <programlisting>        <emphasis role="bold">tos-minimize-delay</emphasis> (16)
        <emphasis role="bold">tos-maximize-throughput</emphasis> (8)
        <emphasis role="bold">tos-maximize-reliability</emphasis> (4)
        <emphasis role="bold">tos-minimize-cost</emphasis> (2)
        <emphasis role="bold">tos-normal-service</emphasis> (0)</programlisting>

          <para>To specify more than one flag, add their values together and
          specify the numeric result.</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><emphasis role="bold">MARK</emphasis> - [<emphasis
        role="bold">!</emphasis>]<emphasis>value</emphasis>[/<emphasis>mask</emphasis>][<emphasis
        role="bold">:C</emphasis>]</term>

        <listitem>
          <para>If you don't want to define a test but need to specify
          anything in the following columns, place a "-" in this field.</para>

          <variablelist>
            <varlistentry>
              <term>!</term>

              <listitem>
                <para>Inverts the test (not equal)</para>
              </listitem>
            </varlistentry>

            <varlistentry>
              <term><emphasis>value</emphasis></term>

              <listitem>
                <para>Value of the packet or connection mark.</para>
              </listitem>
            </varlistentry>

            <varlistentry>
              <term><emphasis>mask</emphasis></term>

              <listitem>
                <para>A mask to be applied to the mark before testing.</para>
              </listitem>
            </varlistentry>

            <varlistentry>
              <term><emphasis role="bold">:C</emphasis></term>

              <listitem>
                <para>Designates a connection mark. If omitted, the packet
                mark's value is tested.</para>
              </listitem>
            </varlistentry>
          </variablelist>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>

  <refsect1>
    <title>FILES</title>

    <para>/etc/shorewall/tos</para>
  </refsect1>

  <refsect1>
    <title>See ALSO</title>

    <para><ulink
    url="/configuration_file_basics.htm#Pairs">http://www.shorewall.net/configuration_file_basics.htm#Pairs</ulink></para>

    <para>shorewall(8), shorewall-accounting(5), shorewall-actions(5),
    shorewall-blacklist(5), shorewall-hosts(5), shorewall_interfaces(5),
    shorewall-ipsets(5), shorewall-maclist(5), shorewall-masq(5),
    shorewall-nat(5), shorewall-netmap(5), shorewall-params(5),
    shorewall-policy(5), shorewall-providers(5), shorewall-proxyarp(5),
    shorewall-rtrules(5), shorewall-routestopped(5), shorewall-rules(5),
    shorewall.conf(5), shorewall-secmarks(5), shorewall-tcclasses(5),
    shorewall-tcdevices(5), shorewall-mangle(5), shorewall-tunnels(5),
    shorewall-zones(5)</para>
  </refsect1>
</refentry>