Configure the NGFW Engine tester

The NGFW Engine tester runs various checks on the NGFW Engine and initiates responses based on the success or failure of these tests.

The following tests are available:
  • Engine Properties Test External — Runs a command or custom script stored on the NGFW Engine. If the command or script returns the code zero (0), the test is considered successful, otherwise the test is considered failed.
  • Engine Properties Test File Space — Checks the free disk space on a hard disk partition.
  • Engine Properties Test Swap Space — Checks the available swap space on the hard disk.
  • Engine Properties Test Inline Link — Checks whether the network settings (speed/duplex) match on the two ports that form the inline pair and can force ports to use the same settings.
    Note: Inline interfaces are not yet supported on the NGFW Manager.
  • Engine Properties Test Link Status — Checks whether a network port reports the link as up or down.
  • Engine Properties Test Multiping — Sends out a series of ping requests to determine whether there is connectivity through a network link.

The results of the tests are shown in the Logs view.

Steps

  1. Browse to NGFW > Properties > General.
  2. Select Tester Parameters, then configure the global tester settings.
  3. To add a new test, do the following:
    1. Click New.
    2. Click the cell in the Test column.
    3. Click New, then select the test that you want to add.
    4. Configure the test-specific settings, then click Save.
  4. To delete a test, select the row, then select > Delete.
  5. To temporarily deactivate a test without deleting it, select the cell in the Active column, then deselect the Active option.
  6. Click Save.
  7. Publish the changes.

Example

Fields marked with an asterisk in the user interface are mandatory.

Table 1. NGFW > Status > General
Option Definition
Tester Parameters When selected, you can configure the global tester parameters.
Alert Interval Specify the time in minutes the NGFW Engine waits before sending a new alert when the same test keeps failing repeatedly. The default value is 60 minutes. If the interval is too short, the alerts can overload the system or the alert recipient.
Delay After Boot Specify the time in seconds that the NGFW Engine waits before it resumes running the tests after the NGFW Engine starts. The delay prevents false test failures that can occur due to variations in how quickly different processes and subsystems can start and stop. The maximum value is 1800.
Delay After Reconfiguration Specify the time in seconds that the NGFW Engine waits before it resumes running the tests after the NGFW Engine is reconfigured. The delay prevents false test failures that can occur due to variations in how quickly different processes and subsystems can start and stop. The maximum value is 1800.
Delay After Status Change Specify the time in seconds that the NGFW Engine waits before it resumes running the tests after the status of the NGFW Engine changes. The delay prevents false test failures that can occur due to variations in how quickly different processes and subsystems can start and stop. The maximum value is 1800.
Is Auto Recovery When selected, the NGFW Engine automatically goes back online when a previously failed test completes successfully. Run the test in both online and offline states if you activate this option.
Is Boot Recovery When selected, the NGFW Engine automatically goes back online after restarting if all offline tests report a success.
Table 2. Engine Properties Test External dialog box
Option Definition
Name The name of the test. If you want to run more than one instance of the same test type with different parameters, give each test a unique name.
Description An optional description of the test.
Is Run Online When selected, the test is run when the NGFW Engine node is online.
Is Run Offline When selected, the test is run when the NGFW Engine node is offline.
Is Run Standby This option is only available for clusters. Clusters are not yet supported on the NGFW Manager.
Test Interval Specify how frequently the test is run. The minimum interval is one second and the maximum is 86400 (one day). We recommend a minimum interval of four seconds. Running a test too frequently can increase overhead.
Action in Failure Select the action taken if a test fails.
  • NoneNo action is taken.
  • OfflineThis option is only available for clusters. Clusters are not yet supported on the NGFW Manager.
  • Force Offline — The NGFW Engine goes offline.
Note: To bring the NGFW Engine back online, you must enter sg-cluster online on the command line.
Is Alert When selected, sends an alert to notify administrators that a test has failed.
Retry Count Enter the number of times the tester tries to execute the test. We recommend always setting the retry count to more than 1 to avoid creating overly sensitive tests that burden the system unnecessarily.
Timeout Enter the timeout in milliseconds. If the test being run does not return a response in the specified time, the test has failed. Avoid overly short timeout values. We recommend a timeout of 500–1000 ms, depending on the test.
Command Line Enter the command or script path. The result must return an exit code of 0 (zero) if it succeeds. Any non-zero return value is a failure.

Example:

/data/home/root/connectivity.sh

You can add multiple commands. To remove a row, click Remove next to the row. To remove all rows, click Clear All.

Table 3. Engine Properties Test File Space dialog box
Option Definition
Name The name of the test. If you want to run more than one instance of the same test type with different parameters, give each test a unique name.
Description An optional description of the test.
Is Run Online When selected, the test is run when the NGFW Engine node is online.
Is Run Offline When selected, the test is run when the NGFW Engine node is offline.
Is Run Standby This option is only available for clusters. Clusters are not yet supported on the NGFW Manager.
Test Interval Specify how frequently the test is run. The minimum interval is one second and the maximum is 86400 (one day). We recommend a minimum interval of four seconds. Running a test too frequently can increase overhead.
Action in Failure Select the action taken if a test fails.
  • NoneNo action is taken.
  • OfflineThis option is only available for clusters. Clusters are not yet supported on the NGFW Manager.
  • Force Offline — The NGFW Engine goes offline.
Note: To bring the NGFW Engine back online, you must enter sg-cluster online on the command line.
Is Alert When selected, sends an alert to notify administrators that a test has failed.
Partition Specify the partition to test.
Free File Space Enter the minimum amount of free space in kilobytes. When the amount of free space drops below this amount, the NGFW Engine executes the chosen action.
Table 4. Engine Properties Test Swap Space dialog box
Option Definition
Name The name of the test. If you want to run more than one instance of the same test type with different parameters, give each test a unique name.
Description An optional description of the test.
Is Run Online When selected, the test is run when the NGFW Engine node is online.
Is Run Offline When selected, the test is run when the NGFW Engine node is offline.
Is Run Standby This option is only available for clusters. Clusters are not yet supported on the NGFW Manager.
Test Interval Specify how frequently the test is run. The minimum interval is one second and the maximum is 86400 (one day). We recommend a minimum interval of four seconds. Running a test too frequently can increase overhead.
Action in Failure Select the action taken if a test fails.
  • NoneNo action is taken.
  • OfflineThis option is only available for clusters. Clusters are not yet supported on the NGFW Manager.
  • Force Offline — The NGFW Engine goes offline.
Note: To bring the NGFW Engine back online, you must enter sg-cluster online on the command line.
Is Alert When selected, sends an alert to notify administrators that a test has failed.
Free Swap Space Enter the minimum amount of free space in kilobytes. When the amount of free space drops below this amount, the NGFW Engine executes the chosen action.
Table 5. Engine Properties Test Inline Link dialog box
Option Definition
Note: Inline interfaces are not yet supported on the NGFW Manager.
Name The name of the test. If you want to run more than one instance of the same test type with different parameters, give each test a unique name.
Description An optional description of the test.
Is Run Online When selected, the test is run when the NGFW Engine node is online.
Is Run Offline When selected, the test is run when the NGFW Engine node is offline.
Is Run Standby This option is only available for clusters. Clusters are not yet supported on the NGFW Manager.
Test Interval Specify how frequently the test is run. The minimum interval is one second and the maximum is 86400 (one day). We recommend a minimum interval of four seconds. Running a test too frequently can increase overhead.
Action in Failure Select the action taken if a test fails.
  • NoneNo action is taken.
  • OfflineThis option is only available for clusters. Clusters are not yet supported on the NGFW Manager.
  • Force Offline — The NGFW Engine goes offline.
Note: To bring the NGFW Engine back online, you must enter sg-cluster online on the command line.
Is Alert When selected, sends an alert to notify administrators that a test has failed.
Inline Link Timeout Enter the timeout in milliseconds. If the test being run does not return a response in the specified time, the test has failed. Avoid overly short timeout values.
Table 6. Engine Properties Test Link Status dialog box
Option Definition
Name The name of the test. If you want to run more than one instance of the same test type with different parameters, give each test a unique name.
Description An optional description of the test.
Is Run Online When selected, the test is run when the NGFW Engine node is online.
Is Run Offline When selected, the test is run when the NGFW Engine node is offline.
Is Run Standby This option is only available for clusters. Clusters are not yet supported on the NGFW Manager.
Test Interval Specify how frequently the test is run. The minimum interval is one second and the maximum is 86400 (one day). We recommend a minimum interval of four seconds. Running a test too frequently can increase overhead.
Action in Failure Select the action taken if a test fails.
  • NoneNo action is taken.
  • OfflineThis option is only available for clusters. Clusters are not yet supported on the NGFW Manager.
  • Force Offline — The NGFW Engine goes offline.
Note: To bring the NGFW Engine back online, you must enter sg-cluster online on the command line.
Is Alert When selected, sends an alert to notify administrators that a test has failed.
Link Scope Select the interface on which the test is run.
  • AllAll physical, modem, ADSL, and wireless interfaces.
  • All With CVIThis option is only available for clusters. Clusters are not yet supported on the NGFW Manager.
  • Specific — A specific physical interface only.
Physical Interface

(When Link Scope is Specific)

Select the physical interface to run the test on.
Table 7. Engine Properties Test Multiping dialog box
Option Definition
Name The name of the test. If you want to run more than one instance of the same test type with different parameters, give each test a unique name.
Description An optional description of the test.
Is Run Online When selected, the test is run when the NGFW Engine node is online.
Is Run Offline When selected, the test is run when the NGFW Engine node is offline.
Is Run Standby This option is only available for clusters. Clusters are not yet supported on the NGFW Manager.
Test Interval Specify how frequently the test is run. The minimum interval is one second and the maximum is 86400 (one day). We recommend a minimum interval of four seconds. Running a test too frequently can increase overhead.
Action in Failure Select the action taken if a test fails.
  • NoneNo action is taken.
  • OfflineThis option is only available for clusters. Clusters are not yet supported on the NGFW Manager.
  • Force Offline — The NGFW Engine goes offline.
Note: To bring the NGFW Engine back online, you must enter sg-cluster online on the command line.
Is Alert When selected, sends an alert to notify administrators that a test has failed.
Retry Count Enter the number of times the tester tries to execute the test. We recommend always setting the retry count to more than 1 to avoid creating overly sensitive tests that burden the system unnecessarily.
Timeout Enter the timeout in milliseconds. If the test being run does not return a response in the specified time, the test has failed. Avoid overly short timeout values. We recommend a timeout of 500–1000 ms, depending on the test.
Target Addresses Enter the IP addresses that you want to ping.

Enter one IP address per row. If you have a list of IP addresses where each IP address is on a separate row, you can copy and paste the list.

To remove a row, click Remove next to the row. To remove all rows, click Clear All.
Source Address Select the IP address to use as the source.