Adding and editing an SSH Active Monitor

The Secure Shell (SSH) monitor connects to a remote device using SSH to execute commands or scripts. You can either embed the script in the monitor or place a script file on the remote machine (making sure it's executable) and enter a command in the monitor to run the script. The success or failure of the monitor is dependent upon values returned by the commands or scripts that can be interpreted by WhatsUp Gold as up or down.

To add a new SSH active monitor:

1. From the WhatsUp Gold web interface, go to Admin > Monitors. The Monitor Library dialog appears.
2. Click the Active tab. The Active Monitor list appears.
3. Click New. The Select Active Monitor Type dialog appears.
4. Select SSH Monitor, then click OK. The New SSH Active Monitor dialog appears.
5. Enter or select the appropriate information:
   • Name. Enter a unique name for the active monitor. This name displays in the Active Monitor Library.
   • Description. (Optional) Enter additional information about the monitor. This description displays next to the monitor in the Active Monitor Library.
   • Command to run. Enter the command you want to run and execute on the remote device. This command can be anything that the device can interpret and run; for example, a Unix shell command or a perl script. The command or script must return a string value.

   Note: If you create a script to run on the remote device, the script must be developed, tested, and/or debugged on the remote machine. WhatsUp Gold does not support manipulation of the remote script.

   • Line end character. Select the appropriate character type; either None, Linefeed, Carriage return, or Carriage return linefeed. Multiline scripts are entered and persisted on a Windows operating system, and include line-ending characters that may not be recognized on the target device. This configuration feature instructs WhatsUp Gold to replace the line-ending characters with the selected characters prior to connection and command execution.
   • The monitor is considered Up if the following output ____. Either Contains or Does not contain. Select the appropriate output criteria. For example, if you are checking to see that a specific network connection is present on the remote device, make sure that the output contains the specific connection. If the network connection you specify is not present when the monitor checks, the monitor is considered down.
   • Use regular expression. Select this option to have WhatsUp Gold apply the target string as a regular expression as it searches the output from the command and considers the match criteria (contains, does not contain). If unchecked, the target string is evaluated as simple text.
   • SSH credential. Select the appropriate SSH credential that WhatsUp Gold uses to connect to the remote device. If you select Use the device SSH credential, WhatsUp Gold uses the SSH credential assigned to the device to which the monitor is assigned. If the appropriate SSH credential is not listed, or the device has no SSH credentials are assigned, browse (...) to the WhatsUp Gold Credentials Library to configure a set of credentials.
6. Click OK to save changes.
7. After configuring an active monitor in the Active Monitor Library, add the monitor to devices.

To edit an existing SSH active monitor:

1. From the WhatsUp Gold web interface, go to Admin > Monitors. The Monitor Library dialog appears.
2. Click the Active tab. The Active Monitor list appears.
3. Select the monitor you would like to edit, then click Edit. The Edit SSH Active Monitor dialog appears.
4. Enter or select the appropriate information:
   • Name. Enter a unique name for the active monitor. This name displays in the Active Monitor Library.
   • Description. (Optional) Enter additional information about the monitor. This description displays next to the monitor in the Active Monitor Library.
   • Command to run. Enter the command you want to run and execute on the remote device. This command can be anything that the device can interpret and run; for example, a Unix shell command or a perl script. The command or script must return a string value.

   Note: If you create a script to run on the remote device, the script must be developed, tested, and/or debugged on the remote machine. WhatsUp Gold does not support manipulation of the remote script.

   • The monitor is considered Up if the following output ____. Either Contains or Does not contain. Select the appropriate output criteria. For example, if you are checking to see that a specific network connection is present on the remote device, make sure that the output contains the specific connection. If the network connection you specify is not present when the monitor checks, the monitor is considered down.
   • Use regular expression. Select this option to have WhatsUp Gold apply the target string as a regular expression as it searches the output from the command and considers the match criteria (contains, does not contain). If unchecked, the target string is evaluated as simple text.
   • SSH credential. Select the appropriate SSH credential that WhatsUp Gold uses to connect to the remote device. If you select Use the device SSH credential, WhatsUp Gold uses the SSH credential assigned to the device to which the monitor is assigned. If the appropriate SSH credential is not listed, or the device has no SSH credentials are assigned, browse (...) to the WhatsUp Gold Credentials Library to configure a set of credentials.
5. Click OK to save changes.

See Also Configuring Active Monitors Adding and editing an Active Script Active Monitor Adding and editing a Domain Service (DNS) Monitor Adding and editing a Service Monitor Adding and editing a Ping Monitor Adding and editing a Power Supply Monitor Adding and editing a SNMP Active Monitor Adding and editing a Telnet Monitor Using telnet to determine "Expect on Connect" string Adding and editing a TCPIP Monitor Adding and editing a WAP Radio Monitor