Configure settings for the External test

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

CAUTION:
This test allows administrators who have permissions to edit the properties of Engines to run arbitrary commands in the Engine operating system.

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 command or script path.
    Example:
    /data/home/root/connectivity.sh
    Tip: You can use custom properties profiles to upload the script to the Engine.
  4. Click OK.
    Note: The command or 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.

External Test Properties dialog box

Use this dialog box to run a custom script that has been uploaded to 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 Engine states in which to run the test.
  • OnlineWhen selected, the test is run when the Engine Engine node is online.
  • Offline When selected, the test is run when the Engine Engine node is offline.
  • Standby(Clusters only) When selected, the test is run when the Engine Engine node is in the Standby state.
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.
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.
Test 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.
CAUTION:
This test allows administrators who have permissions to edit the properties of Engines to run arbitrary commands in the Engine operating system.
Failure section
Action Select the action taken if a test fails.
  • NoneNo action is taken.
  • Offline(Clusters only) The Engine node goes offline, unless it is the last active node in a cluster or the node is in the Locked Online state.
  • Force Offline The Engine node goes offline, even if it is the last node active node in a cluster or the node is in the Locked Online state. Use in cases in which a complete cut in traffic is a better option than a partially working 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 When selected, sends an alert to notify administrators that a test has failed.
Send SNMP Trap When selected, sends an SNMP Trap.