SSH Runbook
An SSH runbook runs a shell command over SSH on a Linux, Solaris, AIX, or any SSH-reachable host, and parses the output back into values on the result screen.
When to Use
Use SSH when the target speaks SSH and you need to run a shell command, read a file, or capture top, df, netstat, systemctl, or any other POSIX utility output.
Fields
| Field | What to enter |
|---|---|
| Runbook Name | A short, unique name. |
| Description | One line on what the runbook returns. |
| Runbook Category | Diagnostics, Performance Monitoring, Troubleshooting, System Management, Log Collection, Network Config, or Integration. |
| Monitor | Pick by Group, Tag, IP/Host, or Monitors. |
| Credential Profile | The SSH credential. Click Create Credential Profile if none fits. |
| Port | SSH port. Defaults to the credential profile's port (22 if not set). |
| Timeout | Seconds to wait before marking the run Failed. |
| SSH Script | The shell command the agent runs over SSH. |
| Script Language | GO or Python, for the parsing script. |
| Parsing Script | Turns the raw SSH output into the result values shown on the result screen. |
| Add Variable | Prompts the user for a value at run time. Reference it as $$$variable.name$$$ in both scripts. |
The right-side Sample Parsing Script > SSH Availability panel shows a working parser you can copy and adjust.
Steps
- Open Settings > Plugin Library > Runbook and click Create Runbook Plugin.
- Pick SSH from the top menu (SSH is the default).
- Fill in the fields above.
- Click Test to run once against the chosen monitor.
- Review the raw output and parsed values. Adjust the parsing script if any value is empty.
- Click Save.