SSH (Performance)
The SSH monitor uses SSH authentication to connect to a remote device to execute commands or scripts which can be either embedded in the monitor or placed as an executable script file on the remote machine with a command embedded in the monitor to run the script. Each monitor returns a single numeric value which is recorded in the database and then used later by other WhatsUp Gold functions as needed.
Provide a unique name and description for the monitor, then configure the following:
- . Enter the command to run and execute on the remote device. The command can be anything the device can interpret and run; for example, a UNIX shell command or a perl script. Please note, if you create a script to run on the remote device, it must be developed, tested, and/or debugged on the remote machine. Select one of the following script options:
- . The command or script must return a single numeric value. The script can be as complex as required, but MUST only return a numeric value. For example, old, single-line UNIX-style:
free -m | awk 'NR==2{print $3}'
This is the script format required prior to WhatsUp Gold 16.2.3. - . This script is not constrained to only returning single numeric values; however, the output MUST contain the string 'Result=xxxx' where xxxx represents a numeric value. For example, new multi-line Linux-style:
echo Result=$(free -m | awk 'NR==2{print $3}')
This newer script format supports all the features of the target script interpreters without burdening the script developer to limit the output to a single numeric value.
- . Select the appropriate line end type: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.
- . Select the appropriate SSH credential WhatsUp Gold uses to connect to the remote device. WhatsUp Gold uses the SSH credential assigned to the monitored device if Use the device SSH credential is selected.