Skip to main content

Create a Custom Runbook

Overview

Custom Runbooks in Motadata AIOps offer a flexible solution for executing specialized actions on monitors, utilizing user-defined settings and scripts. This type of Runbook is particularly useful in scenarios where predefined Runbook templates (such as SSH, HTTP, etc.) are not applicable or sufficient. Custom Runbooks allow IT professionals to define their own scripts and parameters, ensuring that specific, non-standardized actions can be automated and executed efficiently within the IT environment.

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. Select Custom to create a Custom Runbook.

Custom Runbook Configuration

The Custom Runbook creation screen presents various parameters to define the Runbook's functionality and assign it to monitors or groups. Here’s a detailed breakdown of each parameter:

FieldDescription
Runbook NameAssign a logical and unique name that identifies the task performed by the runbook.
Monitor/Group/IP-HostSelect Monitor, Group, IP/Host based on the device to which you want to assign the runbook.
Select MonitorSelect desired monitor from the 'Monitors' dropdown if you want to assign the Runbook to an individual monitor.
Select GroupSelect desired group from the 'Groups' dropdown if you want to assign the Runbook to a group of monitors.
Select IP/HostSpecify the IP/Host if you want to assign the Runbook to a device that is not discovered in Motadata AIOps as a Monitor.
Credential ProfileSelect the credential profile from the dropdown to enable the Runbook to access and perform tasks on the monitor securely.
Create Credential ProfileSelect this option if you need to create a new credential profile.
PortSpecify the port number of the instance to which the Runbook will connect.
TimeoutDefine the time (in Seconds) that AIOps will attempt to establish a connection before it times out.
Script LanguageSpecify the language(Go or Python) you want use to write the parsing script.
ScriptWrite the script to parse the output.
Add VariableAdd a variable if required in the 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.