fgate

This section describes:

Description

Installs and uninstalls the QoS policy on the managed Security Gateways.

Shows the status of the QoS Software Blade on the managed Security Gateways.

For more information, see:

Syntax

fgate [-d]

      load <Name of QoS Policy>.F <GW1> <GW2> ... <GWN>

      stat

            -h

            <GW1> <GW2> ... <GWN>

      unload <GW1> <GW2> ... <GWN>

      ver

Parameters

Parameter

Description

-d

Runs the command in debug mode.

Use only if you troubleshoot the command itself.

Best Practice - If you use this parameter, then redirect the output to a file, or use the script command to save the entire CLI session.

load <Name of QoS Policy>.F <GW1> <GW2> ... <GWN>

Runs a verifier on the QoS policy <Name_of_QoS_Policy>.

If the QoS policy is valid, the Management Server compiles and installs the QoS Policy on the specified Security Gateways <GW1> <GW2> ... <GWN>.

Notes:

  • The maximal supported length of the <Name of QoS Policy> string is 32 characters.

  • To specify a Security Gateway, enter the main IP address of the name of its object as configured in SmartConsole. You can specify several Security Gateways or cluster members in the same command.

stat -h

Shows the built-in usage for the "stat" parameter.

stat <GW1> <GW2> ... <GWN>

Shows the status of the QoS Software Blade and policy on the managed Security Gateways.

Note - To specify a Security Gateway, enter the main IP address of the name of its object as configured in SmartConsole. You can specify several Security Gateways or cluster members in the same command.

Important - This command is outdated and exists only for backward compatibility with very old versions. Use the "cpstat" command.

unload <GW1> <GW2> ... <GWN>

Uninstalls the QoS Policy from the specified Security Gateways <GW1> <GW2> ... <GWN>.

Note - To specify a Security Gateway, enter the main IP address of the name of its object as configured in SmartConsole. You can specify several Security Gateways or cluster members in the same command.

ver

Shows the QoS Software Blade version on the Management Server.

Examples

[Expert@MGMT:0]# fgate load MyPolicy.F 192.168.3.52
 QoS rules verified OK!
 Downloading QoS Policy: MyPolicy.F...
 Target(s): MyGW
   MyGW: QoS policy transferred to module: MyGW.
   MyGW: QoS policy installed succesfully.
 Done.
[Expert@MGMT:0]#
 
[Expert@MGMT:0]# fgate load MyPolicy.F MyClusterMember1 MyClusterMember2
 QoS rules verified OK!
 Downloading QoS Policy: MyPolicy.F...
   MyClusterMember1: QoS policy transferred to module: MyClusterMember1.
   MyClusterMember1: QoS policy installed succesfully.
   MyClusterMember2: QoS policy transferred to module: MyClusterMember2.
   MyClusterMember2: QoS policy installed succesfully.
 Done.
[Expert@MGMT:0]#
 
[Expert@MGMT:0]# fgate stat MyGW
 
Module name: MyGW
=======================
 
Product: QoS Software Blade
Version: R81
Kernel Build: 456
Policy Name: MyPolicy
Install time: Wed Dec 4 19:53:48 2019
Interfaces Num: 1
 
 
Interface table
----------------------------------------------------------------
|Name|Dir|Limit (Bps)|Avg Rate (Bps)|Conns|Pend pkts|Pend bytes|
----------------------------------------------------------------
|eth0|in | 1250000000|             0|    0|        0|         0|
|eth0|out| 1250000000|             0|    0|        0|         0|
----------------------------------------------------------------
 
[Expert@MGMT:0]#
 
[Expert@MGMT:0]# fgate ver
This is Check Point QoS Software Blade R81 - Build 123
[Expert@MGMT:0]#

Description

Installs and uninstalls the QoS policy on the managed Security Gateways.

Shows the status of the QoS Software Blade on the managed Security Gateways.

Controls the QoS debug.

For more information, see:

Syntax

fgate [-d]

      ctl

            -h

            <QoS Module> {on | off}

      debug

            on

            off

      fetch

            -f

            <Management Server>

      kill [-t <Signal Number>] <Name of QoS Process>

      load

      log

            on

            off

            stat

      stat [-h]

      ver [-k]

      unload

Parameters

Parameter

Description

-d

Runs the command in debug mode.

Use only if you troubleshoot the command itself.

Best Practice - If you use this parameter, then redirect the output to a file, or use the script command to save the entire CLI session.

ctl -h

Shows the expected syntax and the list of the available QoS modules.

ctl <QoS Module> {on | off}

Controls the specified QoS module:

  • on - Enables the module (default)

  • off - Disables the module

Note - In R81, the only available QoS module is etmreg.

debug {on | off}

Controls the debug mode of the QoS user space daemon fgd50 (see sk41585):

  • on - Enables the debug

  • off - Disables the debug (default)

This sends additional debugging information to the fgd50 daemon's log file $FGDIR/log/fgd.elg.

fetch -f

Fetches and installs the QoS Policy from all the Management Servers configured in the $FWDIR/conf/masters file.

fetch <Management Server>

Fetches and installs the QoS Policy from the specified Management Server.

Enter the main IP address or the name of the Management Server object as configured in SmartConsole.

kill [-t <Signal Number>] <Name of QoS Process>

Sends the specified signal to the specified QoS user space process.

Notes:

  • In R81, the only available QoS user space process is fgd50.

  • The QoS fgd50 daemon, upon its startup, writes the PIDs of the applicable QoS user spaces processes to the $FWDIR/tmp/<Name of QoS Process>.pid files.

    For example: $FWDIR/tmp/fgd50.pid

  • If the file $FWDIR/tmp/<Name of QoS Process>.pid exists, then this command sends the specified Signal Number to the PID in that file.

  • If you do not specify the signal explicitly, the command sends Signal 15 (SIGTERM).

  • For the list of available signals and their numbers, run the kill -l command. For information about the signals, see the manual pages for the kill and signal.

  • To restart the QoS fgd50 daemon manually, run the etmstop and then etmstart commands.

load

Installs the local QoS Policy on the Security Gateway.

If this command fails, run the etmstop and then etmstart commands.

log {on | off | stat}

Controls the state of QoS logging in the Security Gateway kernel:

  • on - Enables the QoS logging (default)

  • off - Disables the QoS logging

  • stat - Shows the current QoS logging status

You can disable the QoS logging to save resources without reinstalling the QoS policy.

stat [-h]

Shows the status of the QoS Software Blade and policy on the Security Gateway.

The -h parameter shows the built-in usage for the "stat" parameter.

Important - This command is outdated and exists only for backward compatibility with very old versions. Use the "cpstat" command.

unload

Uninstalls the QoS Policy from the Security Gateway.

ver [-k]

Shows the QoS Software Blade version.

If you specify the "-k" parameter, the output also shows the kernel version.

Examples

[Expert@MyGW]# fgate fetch -f
Fetching QoS Software Blade Policy:
 Received Policy. Downloading...
 
eth0(inbound), eth0(outbound).
Download OK.
Done.
[Expert@MyGW]#
 
[Expert@MyGW]# fgate fetch 192.168.3.240
Fetching QoS Software Blade Policy:
 Received Policy. Downloading...
 
eth0(inbound), eth0(outbound).
Download OK.
Done.
[Expert@MyGW]#
 
[Expert@MyGW]# fgate stat
 
Product:        QoS Software Blade
Version:        R81
Kernel Build:   456
Policy Name:    MyPolicy
Install time:   Wed Dec 4 19:53:48 2019
Interfaces Num: 1
 
 
Interface table
----------------------------------------------------------------
|Name|Dir|Limit (Bps)|Avg Rate (Bps)|Conns|Pend pkts|Pend bytes|
----------------------------------------------------------------
|eth0|in | 1250000000|             0|    0|        0|         0|
|eth0|out| 1250000000|             0|    0|        0|         0|
----------------------------------------------------------------
 
[Expert@MyGW]#
 
[Expert@MyGW:0]# fgate ver
This is Check Point QoS Software Blade R81 - Build 123
[Expert@MyGW:0]#
[Expert@MyGW:0]# fgate ver -k
This is Check Point QoS Software Blade R81 - Build 123
kernel: R81 - Build 456
[Expert@MyGW:0]#