Create a SSH Runbook
Overview
SSH Runbooks in Motadata AIOps serve as a tool to execute specific actions on monitors, leveraging the Secure Shell (SSH) protocol for secure access. Primarily utilized for Linux and Network devices, SSH Runbooks facilitate the execution of tasks remotely, ensuring secure and authenticated communications between two hosts.
Navigation
Go to Menu, Select Settings . After that, Go to Plugin Library . Select Runbook. The Runbook screen is now displayed.
Select to start creating a Runbook. SSH Runbook is selected by default.
SSH Runbook Configuration
The SSH Runbook creation screen presents various parameters to define the runbook's functionality and assign it to monitors or groups. Below is a detailed breakdown of each parameter:
Field | Description |
---|---|
Runbook Name | Assign a logical and unique name that identifies the task performed by the runbook. |
Monitor/Group/IP-Host | Select Monitor, Group, IP/Host based on the device to which you want to assign the runbook. |
Select Monitor | Select desired monitor from the 'Monitors' dropdown if you want to assign the Runbook to an individual monitor. |
Select Group | Select desired group from the 'Groups' dropdown if you want to assign the Runbook to a group of monitors. |
Select IP/Host | Specify the IP/Host if you want to assign the Runbook to a device that is not discovered in Motadata AIOps as a Monitor. |
Credential Profile | Select the credential profile from the dropdown to enable the Runbook to access and perform tasks on the monitor securely. |
Create Credential Profile | Select this option if you need to create a new credential profile. |
SSH Script | Write the script detailing the task that you wish to execute using the Runbook. |
Script Language | Specify the language(Go or Python) you want use to write the parsing script. |
Parsing Script | Write the script to parse the output derived post SSH script execution. |
Add Variable | Add a variable if required in the parsing script. |
Click on Test option to validate the credential profile against the selected monitor.
Click on the Create Runbook Plugin to create the Runbook ensuring all parameters are defined as per your requirements. Note that this option becomes available only after successful testing.
Click on the Reset option to clear all input fields.