extern/shorewall_code
1
0
Fork 1
mirror of https://gitlab.com/shorewall/code.git synced 2025-06-20 09:47:51 +02:00
Code Issues Packages Projects Releases Wiki Activity

Update RATE column documentation

Browse Source 
Signed-off-by: Tom Eastep <teastep@shorewall.net>
This commit is contained in:
Tom Eastep 2018-07-02 10:50:56 -07:00
parent 49514e2d58
commit b271c52603
No known key found for this signature in database
GPG Key ID: 96E6B3F2423A4D10
2 changed files with 48 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
Shorewall/manpages/shorewall-policy.xml
View File

@ -295,21 +295,21 @@
<para>where limit is one of:</para> <para>where limit is one of:</para>
<simplelist> <simplelist>
<member>[<emphasis <member>[<emphasis role="bold">-</emphasis>|[{<emphasis
role="bold">-</emphasis>|[{<emphasis>s</emphasis>|<emphasis role="bold">s</emphasis>|<emphasis
role="bold">d</emphasis>}:[[<replaceable>name</replaceable>]:]]]<emphasis>rate</emphasis><emphasis role="bold">d</emphasis>}[/<replaceable>vlsm</replaceable>]:[[<replaceable>name</replaceable>][(ht-buckets,ht-max)]:]]]<emphasis>rate</emphasis><emphasis
role="bold">/</emphasis>{<emphasis role="bold">/</emphasis>{<emphasis
role="bold">sec</emphasis>|<emphasis role="bold">sec</emphasis>|<emphasis
role="bold">min</emphasis>|<emphasis role="bold">min</emphasis>|<emphasis
role="bold">hour</emphasis>|<emphasis role="bold">hour</emphasis>|<emphasis
role="bold">day</emphasis>}[:<emphasis>burst</emphasis>]</member> role="bold">day</emphasis>}[:<emphasis>burst</emphasis>]</member>
<member>[<replaceable>name</replaceable>1]:<emphasis>rate1</emphasis><emphasis <member>[<replaceable>name</replaceable>1:]<emphasis>rate1</emphasis><emphasis
role="bold">/</emphasis>{<emphasis role="bold">/</emphasis>{<emphasis
role="bold">sec</emphasis>|<emphasis role="bold">sec</emphasis>|<emphasis
role="bold">min</emphasis>|<emphasis role="bold">min</emphasis>|<emphasis
role="bold">hour</emphasis>|<emphasis role="bold">hour</emphasis>|<emphasis
role="bold">day</emphasis>}[:<emphasis>burst1</emphasis>],[<replaceable>name</replaceable>2]:<emphasis>rate2</emphasis><emphasis role="bold">day</emphasis>}[:<emphasis>burst1</emphasis>],[<replaceable>name</replaceable>2:]<emphasis>rate2</emphasis><emphasis
role="bold">/</emphasis>{<emphasis role="bold">/</emphasis>{<emphasis
role="bold">sec</emphasis>|<emphasis role="bold">sec</emphasis>|<emphasis
role="bold">min</emphasis>|<emphasis role="bold">min</emphasis>|<emphasis
@ -331,7 +331,14 @@
role="bold">shorewall</emphasis> is assumed. Where more than one role="bold">shorewall</emphasis> is assumed. Where more than one
POLICY or rule specifies the same name, the connections counts for POLICY or rule specifies the same name, the connections counts for
the policies are aggregated and the individual rates apply to the the policies are aggregated and the individual rates apply to the
aggregated count.</para> aggregated count. Beginning with Shorewall 5.2.1, the <emphasis
role="bold">s</emphasis> or <emphasis role="bold">d</emphasis> may
be followed by a slash ("/") and an integer
<replaceable>vlsm</replaceable>. When a
<replaceable>vlsm</replaceable> is specified, all source or
destination addresses encountered will be grouped according to the
given prefix length and the so-created subnet will be subject to the
rate limit.</para>
<para>Beginning with Shorewall 4.6.5, two<replaceable> <para>Beginning with Shorewall 4.6.5, two<replaceable>
limit</replaceable>s may be specified, separated by a comma. In this limit</replaceable>s may be specified, separated by a comma. In this
@ -342,6 +349,17 @@
<para>Example: <emphasis <para>Example: <emphasis
role="bold">client:10/sec:20,:60/sec:100</emphasis></para> role="bold">client:10/sec:20,:60/sec:100</emphasis></para>
<para>Beginning with Shorewall 5.2.1, the table name, if any, may be
followed by two integers separated by commas and enclosed in
parentheses. The first integer
(<replaceable>ht-buckets</replaceable>) specifies the number of
buckets in the generated hash table. The second integer
(<replaceable>ht-max</replaceable>) specifies the maximum number of
entries in the hash table.</para>
<para>Example: <emphasis
role="bold">s:client(1024,65536):10/sec</emphasis></para>
</listitem> </listitem>
</varlistentry> </varlistentry>

28
Shorewall/manpages/shorewall-rules.xml
View File

@ -1900,19 +1900,19 @@
<simplelist> <simplelist>
<member>[<emphasis role="bold">-</emphasis>|[{<emphasis <member>[<emphasis role="bold">-</emphasis>|[{<emphasis
role="bold">s</emphasis>|<emphasis role="bold">s</emphasis>|<emphasis
role="bold">d</emphasis>}:[[<replaceable>name</replaceable>]:]]]<emphasis>rate</emphasis><emphasis role="bold">d</emphasis>}[/<replaceable>vlsm</replaceable>]:[[<replaceable>name</replaceable>][(<replaceable>ht-buckets</replaceable>,<replaceable>ht-max</replaceable>)]:]<emphasis>rate</emphasis><emphasis
role="bold">/</emphasis>{<emphasis role="bold">/</emphasis>{<emphasis
role="bold">sec</emphasis>|<emphasis role="bold">sec</emphasis>|<emphasis
role="bold">min</emphasis>|<emphasis role="bold">min</emphasis>|<emphasis
role="bold">hour</emphasis>|<emphasis role="bold">hour</emphasis>|<emphasis
role="bold">day</emphasis>}[:<emphasis>burst</emphasis>]</member> role="bold">day</emphasis>}[:<emphasis>burst</emphasis>]</member>
<member>[<replaceable>name</replaceable>1]:<emphasis>rate1</emphasis><emphasis <member>[<replaceable>name</replaceable>1:]<emphasis>rate1</emphasis><emphasis
role="bold">/</emphasis>{<emphasis role="bold">/</emphasis>{<emphasis
role="bold">sec</emphasis>|<emphasis role="bold">sec</emphasis>|<emphasis
role="bold">min</emphasis>|<emphasis role="bold">min</emphasis>|<emphasis
role="bold">hour</emphasis>|<emphasis role="bold">hour</emphasis>|<emphasis
role="bold">day</emphasis>}[:<emphasis>burst1</emphasis>],[<replaceable>name</replaceable>2]:<emphasis>rate2</emphasis><emphasis role="bold">day</emphasis>}[:<emphasis>burst1</emphasis>],[<replaceable>name</replaceable>2:]<emphasis>rate2</emphasis><emphasis
role="bold">/</emphasis>{<emphasis role="bold">/</emphasis>{<emphasis
role="bold">sec</emphasis>|<emphasis role="bold">sec</emphasis>|<emphasis
role="bold">min</emphasis>|<emphasis role="bold">min</emphasis>|<emphasis
@ -1940,7 +1940,16 @@
role="bold">shorewallN</emphasis> (where N is a unique integer) is role="bold">shorewallN</emphasis> (where N is a unique integer) is
assumed. Where more than one rule or POLICY specifies the same name, assumed. Where more than one rule or POLICY specifies the same name,
the connections counts for the rules are aggregated and the the connections counts for the rules are aggregated and the
individual rates apply to the aggregated count.</para> individual rates apply to the aggregated count. Beginning with
Shorewall 5.2.1, the <emphasis role="bold">s</emphasis> or <emphasis
role="bold">d</emphasis> may be followed by a slash ("/") and an
integer <replaceable>vlsm</replaceable>. When a
<replaceable>vlsm</replaceable> is specified, all source or
destination addresses encountered will be grouped according to the
given prefix length and the so-created subnet will be subject to the
rate limit.</para>
<para>Example: <emphasis role="bold">s/24::10/sec</emphasis></para>
<para>Beginning with Shorewall 4.6.5, two<replaceable> <para>Beginning with Shorewall 4.6.5, two<replaceable>
limit</replaceable>s may be specified, separated by a comma. In this limit</replaceable>s may be specified, separated by a comma. In this
@ -1957,6 +1966,17 @@
name for the hash table that tracks the per-destination name for the hash table that tracks the per-destination
limit.</para> limit.</para>
<para>Beginning with Shorewall 5.2.1, the table name, if any, may be
followed by two integers separated by commas and enclosed in
parentheses. The first integer
(<replaceable>ht-buckets</replaceable>) specifies the number of
buckets in the generated hash table. The second integer
(<replaceable>ht-max</replaceable>) specifies the maximum number of
entries in the hash table.</para>
<para>Example: <emphasis
role="bold">s:netfw(1024,65536):10/sec</emphasis></para>
<para>This column was formerly labelled RATE LIMIT.</para> <para>This column was formerly labelled RATE LIMIT.</para>
</listitem> </listitem>
</varlistentry> </varlistentry>