Configuring SSH performance monitors
- Last Updated: June 21, 2023
- 2 minute read
- WhatsUp Gold
The Secure Shell (SSH) performance 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. Each monitor returns a single numeric value that is recorded in the database, then is used later by different Network Performance Monitor functions such as reporting or to compare against a threshold in Alert Center.
The Secure Shell (SSH) performance monitor requires the following credential:
- SSH
Configure the Secure Shell (SSH) performance monitors using the following boxes:
- Name. Enter a unique name for the performance monitor. This name displays in the Monitor Library.
- Description. (Optional) Enter a short description for the performance monitor. This description displays next to the performance monitor in the 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, you can use a Unix shell command or a Perl script. The command or script must return a single numeric value. For example: Single-line Unix-style:
free -m | awk 'NR==2{print $3}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. Network Performance Monitor does not support manipulation of the remote script. - Line end character. Select the appropriate character type: None, Linefeed, Carriage return, or Carriage return linefeed. Multi-line 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 Network Performance Monitor to replace the line-ending characters with the selected characters prior to connection and command execution.
- SSH Credential. Select the appropriate SSH credential that Network Performance Monitor uses to connect to the remote device. If you select Use the device SSH credential, Network Performance Monitor 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 assigned, click browse (...) to open the Network Performance Monitor Credentials Library and configure a set of credentials.