fwaccel dos rate

Description

The "fwaccel dos rate" (for IPv4) and "fwaccel6 dos rate" (for IPv6) commands show and install the Rate Limiting policy in SecureXL.

Important:

  • By default, the Rate Limiting policy feature is enabled without any rules.

  • In a Cluster, you must configure all the Cluster Members in the same way.

  • On Scalable Platforms (ElasticXL, Maestro, and Chassis), you must connect to the Gaia Portal of the applicable Security Group.

    On Scalable Platforms (ElasticXL, Maestro, Scalable Chassis), you must run the required commands only in this way:

    • On the Security Group command line, only on the SMO Security Group Member.

    • In the Global Gaia Clish (gclish), must run these commands:

      • fwaccel dos <Options>

      • fwaccel6 dos <Options>

    • In the Expert mode, must run these commands (start with the "g_" prefix):

      • g_fwaccel dos <Options>

      • g_fwaccel6 dos <Options>

  • In the VSNext mode / Traditional VSX mode, you must go to the context of an applicable Virtual Gateway / Virtual System.

    • In Gaia Clish, run: set virtual-system <VSID>

    • In the Expert mode, run: vsenv <VSID>

Notes

  • If you install a new rate limiting policy with more than one rule, it automatically enables the rate limiting feature.

    To disable the rate limiting feature manually, run this command (see fwaccel dos config):

    {fwaccel | fwaccel6} dos config set --disable-rate-limit

  • To delete the current rate limiting policy, install a new policy with zero rules.

Syntax

{fwaccel | fwaccel6} dos rate {-h | --help}

{fwaccel | fwaccel6} dos rate

      add --help

      add [<SIC Connection>] <Options> <Match Conditions> <Limit> <Tracking>

      add batch /<Path>/<Name of File>

{fwaccel | fwaccel6} dos rate

      counters --help

      counters

      counters '<Rule Index>'

      counters '<Rule UID>'

{fwaccel | fwaccel6} dos rate

      del --help

      del all

      del '<Rule UID>'

      del batch /<Path>/<Name of File>

{fwaccel | fwaccel6} dos rate

      get --help

      get {-r | -l | -o /<Path>/<Name of File>}

      get [-n] -u '<Rule UID>'

      get [-n] -k <Search Key>

      get [-n] -v <Search Value>

      get --show-tab

      get --show-counters

{fwaccel | fwaccel6} dos rate

      {-c | --show-config}

      {-E | --set-enabled} {on | off}

      {-G | --set-log-drops} {on | off}

      {-I | --set-enforce-internal} {on | off}

      {-M | --set-monitor-only} {on | off}

      {-O | --set-notif-rate} <Number>}

      {-R | --set-rule-cache} {on | off}

Parameters

Parameter

Description

No Parameters

Shows the applicable built-in usage.

-h

--help}

Shows the applicable built-in usage.

add [<SIC Connection>] <Options> <Match Conditions> <Limit> <Tracking>

Adds one IPv4 rule to the Rate Limiting policy.

See Adding an IPv4 rule to the Rate Limiting policy.

add batch /<Path>/<Name of File>

Adds IPv4 rules in a batch mode to the Rate Limiting policy.

See Adding IPv4 rules in a batch mode to the Rate Limiting policy.

counters <options>

Shows the counters for all rules in the Rate Limiting policy.

See Viewing DoS / Rate Limiting Counters.

To reset counters, see fwaccel dos stats.

del all

Deletes all rules from the Rate Limiting policy.

del '<Rule UID>'

Deletes the specified rule from the Rate Limiting policy.

Important - The quote marks (single or double) and angle brackets ('<...>') are mandatory.

The '<Rule UID>' value is generated automatically when you add a rule.

To see the UID for each rule, run:

{fwaccel | fwaccel6} dos rate get

Example:

fwaccel dos rate del '<5779378c,00000000,64291eac,00005584>'

del batch /<Path>/<Name of File>

Deletes the specified rules in a batch mode from the Rate Limiting policy.

  1. Get the UID for each rule:

    {fwaccel | fwaccel6} dos rate get

  2. Save the required UID value in a plain-text file, one UID on each line.

  3. Delete the specified rules:

    {fwaccel | fwaccel6} del batch /<Path>/<Name of File>

get <options>

Shows information about the rules the Rate Limiting policy.

See Viewing information about the rules the Rate Limiting policy.

-c

--show-config

Shows the current configuration.

Example:

[Expert@MyGW:0]# fwaccel dos rate -c
Rate Limit Rules:
    Status                            on (without policy)
    Internal Interfaces               off
    Monitor-Only                      off
    Log Drops                         on
    Max Notifications Per-Second      100 logs/second
    Rule Cache                        on
[Expert@MyGW:0]#

-E {on | off}

--set-enabled {on | off}

Enables (on) or disables (off) the feature.

Notes:

  • By default, the Rate Limiting policy feature is enabled without any rules.

  • This change survives a reboot.

-G {on | off}

--set-log-drops {on | off}

Enables (on) or disables (off) the logging of packet drops.

Notes:

  • By default, the Security Gateway generates the "Drop" logs for traffic that the DoS / Rate Limiting feature blocked.

  • By default, logging of packet drops is enabled.

-I {on | off}

--set-enforce-internal {on | off}

Enables (on) or disables (off) the enforcement on interfaces, whose topology is configured as "Internal" in the Security Gateway object.

Notes:

  • By default, DoS / Rate Limiting enforcement is disabled on interfaces, for which you configured the "Internal" topology in the Security Gateway / Cluster object.

    This is because the internal interfaces are assumed to be connected to trusted networks.

  • This change survives a reboot.

-M {on | off}

--set-monitor-only {on | off}

Enables (on) or disables (off) the monitor-only mode for the IP deny-list.

In the monitor-only mode you can test the drops of IP Fragments without blocking the traffic.

The Security Gateway does not block traffic, but still generates a log.

Notes:

  • By default, the monitor-only mode is disabled.

  • This change survives a reboot.

  • This command affects only the IP deny-list (does not affect the fw samp rules, etc.).

  • In addition to the Monitor-only mode, DoS / Rate Limiting has a more granular option to monitor packets on a rule-by-rule basis by specifying the action to be "notify" instead of the default action "drop".

-O <Number>

--set-notif-rate <Number>

Configures the maximum number of logs per second for packet drops.

When DoS / Rate Limiting blocks many packets, it can be important to limit the maximum number of the drop logs that the Security Gateway generates per second.

Notes:

  • The default logging rate is 100 logs/second.

  • This change survives a reboot.

-R {on | off}

--set-rule-cache {on | off}

Enables (on) or disables (off) the rule cache.

Notes:

  • By default, the rule cache is enabled for maximum performance.

  • This change survives a reboot.

Adding an IPv4 rule to the Rate Limiting policy

Adding IPv4 rules in a batch mode to the Rate Limiting policy

Viewing information about the rules the Rate Limiting policy

Viewing DoS / Rate Limiting Counters