Configure settings for the External engine test

For the tester to run External tests, configure the available settings.

  For more details about the product and how to configure features, click Help or press F1.

Steps

  1. In the Retry Count field, 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.
  2. In the Test Timeout field, enter the timeout in milliseconds.
    • If the test being run does not return a response in the specified time, the test is considered to have failed.
    • We recommend a timeout of 500–1000 milliseconds, depending on the external test script.
  3. In the Command Line field, enter the script path.
    Example: /data/home/root/connectivity.sh
  4. Click OK.
    Note: The external script must return an exit code of 0 (zero) if it succeeds. Any non-zero return value is a failure.
  5. Click Save and Refresh to transfer the new configuration to the engines.

External Test Properties dialog box

Use this dialog box to run a custom script stored on the engine.

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.
Node

(Clusters only)

Select whether to run the test on ALL nodes or only on a specific node.
States to Test Select one or more NGFW Engine states in which to run the test:
  • Online — Test is run when the node is online.
  • Offline — Test is run when the node is offline.
  • Standby (Clusters only) — Test is run when the node is in the Standby state.
Test Interval Specifies how often the test is run. The minimum interval is one second and the maximum is 86400 (one day).
Note: We recommend a minimum interval of four seconds. Running a test too frequently can increase overhead.
Retry Count Enter the number of times the tester tries to execute the test.
Tip: We recommend always setting the retry count to more than 1 to avoid creating overly sensitive tests that burden the system unnecessarily.
Test Timeout Enter the Test Timeout in milliseconds. If the test being run does not return a response in the specified time, the test has failed.
Tip: Avoid overly short timeout values. We recommend a timeout of 500–1000 ms, depending on the test.
Command Line Enter the script path in the Command Line field. The external script must return an exit code of 0 (zero) if it succeeds. Any non-zero return value is a failure.
Failure section
Action Select the action taken if a test fails:
  • None — The state is not changed.
  • Offline (Clusters only) — The test switches the node offline. However, the tester does not turn offline the last active node in a cluster or nodes in the Locked Online state.
  • Force Offline — The node is forced to an offline state, even if it is the last node online in a cluster or if it is in the Locked Online state. Use in cases in which a complete cut in traffic is a better option than a partially working NGFW Engine.
  • Force Speed (Inline Pair Link Speed test only) — If the test finds that the pair of inline ports has different speed/duplex settings, the speed/duplex on the higher speed/full duplex link is set to match the lower speed/half duplex setting on the other port. Correct and reliable operation requires identical settings.
Send Alert Select to send an alert to notify administrators that a test has failed.
Send SNMP Trap Sends an SNMP Trap.