27.3. IP Rule table

27.3. IP Rule table
	Chapter 27. IPSH - IP Shaping

Changes on IP Rule table are active only after an init ipsh command.

The command save conf saves all rules inside the table. In the configuration files up to 32 rules are saved.

The available commands for managing the IP rule table are the following:

27.3.1. D IPSH RULE (Display IP Shaping Rule)

It shows the IP shaping rule table. By typing d ipsh rule ? command it's possible to display the meaning of all parameters.

[14:36:28] ABILIS_CPX:d ipsh rule

ID:1   DESCR:
       TI1:ALL,00:00-23:59                 TI2:#
       TYPE:VARIANCE      PERIOD:300       THRESHOLD:10
                          STEP-DOWN:50     STEP-UP:200

Meaning of the parameters:

ID

IP Shaping rule identifier [1..32].

DESCR

Entry description. Max 70 chars. Spaces require double quotes (E.g. "str1 str2"). It is displayed only when not empty.

TI1

Time interval within which the rule is active [#, ALL, *, string in format day,hh:mm-hh:mm], # = never, ALL and * = always. Value 'day' can be:

a single day of the week [MO, TU, WE, TH, FR, SA, SU];
a set of days of the week (E.g. MO+TH or TU+TH+SU);
an interval of days of the week (E.g. MO-WE or TH-SU);
ALL.

TI2

Time interval within which the rule is active [#, ALL, *, string in format day,hh:mm-hh:mm], # = never, ALL and * = always. Value 'day' can be:

a single day of the week [MO, TU, WE, TH, FR, SA, SU];
a set of days of the week (E.g. MO+TH or TU+TH+SU);
an interval of days of the week (E.g. MO-WE or TH-SU);
ALL.

TYPE

Rule type [#, VARIANCE, VARIANCE-WH]

When '#', rule type isn't defined.
When 'VARIANCE', rule must follow variance algorithm.
When 'VARIANCE-WH', rule must follow variance algorithm. Bandwidth range is affected by working hours (WH-TI).

PERIOD

Time interval used for algorithm rule calculation [30..1800 sec].

THRESHOLD

Variance threshold: above or equal threshold the traffic is interactive, below it's stream. [0..20].

STEP-DOWN

Reduction percentage for each reduction step, calculated respect to current bandwidth limit. [0..90].

STEP-UP

Increasing percentage for each increase step, calculated respect to current bandwidth limit. [110..500].

WH-TI1

Time interval during which the WH-LOWBW: and WH-HIGHBW: reductions take place [#, ALL, *, string in format day,hh:mm-hh:mm], # = never, ALL and * = always. Value 'day' can be:

a single day of the week [MO, TU, WE, TH, FR, SA, SU];
a set of days of the week (E.g. MO+TH or TU+TH+SU);
an interval of days of the week (E.g. MO-WE or TH-SU);
ALL.

	Note
	Only for `TYPE`:`VARIANCE-HW`.

WH-TI2

Time interval during which the WH-LOWBW: and WH-HIGHBW: reductions take place [#, ALL, *, string in format day,hh:mm-hh:mm], # = never, ALL and * = always. Value 'day' can be:

a single day of the week [MO, TU, WE, TH, FR, SA, SU];
a set of days of the week (E.g. MO+TH or TU+TH+SU);
an interval of days of the week (E.g. MO-WE or TH-SU);
ALL.

	Note
	Only for `TYPE`:`VARIANCE-HW`.

WH-LOWBW

Reduction percentage during working hours applied to LOWBW: value specified in the IPSH FLOW that references this rule. [10..90].

	Note
	Only for `TYPE`:`VARIANCE-HW`.

WH-HIGHBW

Reduction percentage during working hours applied to HIGHBW: value specified in the IPSH FLOW that references this rule. [10..90].

	Note
	Only for `TYPE`:`VARIANCE-HW`.

27.3.2. A IPSH RULE (Add IP Shaping Rule)

It adds a new IP rule definition with the specified parameters. Unspecified ones are set to their default values.

To display the syntax of the command, type a ipsh rule ?.

Some examples follow:

[14:00:15] ABILIS_CPX:a ipsh rule id:1 type:variance step-up:200

COMMAND EXECUTED

[14:01:01] ABILIS_CPX:d ipsh rule

ID:1   DESCR:
       TI1:ALL,00:00-23:59                 TI2:#
       TYPE:VARIANCE      PERIOD:300       THRESHOLD:10
                          STEP-DOWN:50     STEP-UP:200

27.3.3. C IPSH RULE (Clear IP Shaping Rule)

It deletes from the table the IP rule identified by the specified “ID:xx”.

To display the syntax of the command, type c ipsh rule ?.

Some examples follow:

[13:55:27] ABILIS_CPX:d ipsh rule

ID:1   DESCR:
       TI1:ALL,00:00-23:59                 TI2:#
       TYPE:VARIANCE      PERIOD:300       THRESHOLD:10
                          STEP-DOWN:50     STEP-UP:200 
ID:2   DESCR:
       TI1:ALL,00:00-23:59                 TI2:#
       TYPE:VARIANCE-WH   PERIOD:300       THRESHOLD:10
                          STEP-DOWN:50     STEP-UP:150
                          WH-TI1:ALL,00:00-23:59
                          WH-TI2:#
                          WH-LOWBW:50      WH-HIGHBW:50 

[13:55:27] ABILIS_CPX:c ipsh rule id:2

COMMAND EXECUTED

[13:55:27] ABILIS_CPX:d ipsh rule

ID:1   DESCR:
       TI1:ALL,00:00-23:59                 TI2:#
       TYPE:VARIANCE      PERIOD:300       THRESHOLD:10
                          STEP-DOWN:50     STEP-UP:200

27.3.4. S IPSH RULE (Set IP Shaping Rule)

It sets one or more parameters to their new values in an IP rule table, identified by the specified “ID:xx”.. This command can only be used to modify specific IP rule definitions in the table.

Type s ipsh rule ? to display the syntax of the command.

Some examples follow:

[13:56:01] ABILIS_CPX:d ipsh rule

ID:1   DESCR:
       TI1:ALL,00:00-23:59                 TI2:#
       TYPE:VARIANCE      PERIOD:300       THRESHOLD:10
                          STEP-DOWN:50     STEP-UP:200 

[13:56:25] ABILIS_CPX:s ipsh rule id:1 period:60 ti1:mo-fr,08:30-12:30 ti2:mo-fr,14:00-18:00

COMMAND EXECUTED

[13:57:38] ABILIS_CPX:d ipsh rule

ID:1   DESCR:
       TI1:MO-FR,08:30-12:30               TI2:MO-FR,14:00-18:00
       TYPE:VARIANCE      PERIOD:60        THRESHOLD:10
                          STEP-DOWN:50     STEP-UP:200


27.2. IP Flow table		27.4. IP User table