Motadata Docs

Custom Runbook

Overview

Custom Runbook can be used to perform certain actions on a monitor using custom settings.

After selecting the , a screen appears to create a Runbook.

SSH Runbook is selected by default. Select the Custom Runbook to start creating the Runbook.

Custom Runbook Screen

The following parameters appear on the Create Runbook screen for Database protocol.

Runbook Name Enter a unique name of the Runbook you wish to create. The name should be given logically based on the task performed by the Runbook
Monitor/Group

Select a Monitor or Group based on your requirement.

  • Select Monitor if you wish to assign the runbook you create to an individual monitor. Select the monitor to which you wish to assign the Runbook from the dropdown titled Monitors.
  • Select Group if you wish to assign the Runbook to a group of monitors. Select the group to which you wish to assign the Runbook from the dropdown titled Groups.
Credential Profile Select the credential profile so that your runbook is able to access the monitor using the appropriate credentials and perform its task on the monitor.
Create Credential Profile Select this option if you wish to create a new credential profile.
Port Kindly enter the port number of the database instance.
Timeout Enter the time (in Seconds) that AIOps will try to establish the connection before it times out. If the connection cannot be established due to unforeseen reasons, the Runbook execution will timeout in the time mentioned here instead of running indefinitely.
Script Kindly write the script for the operation you want your Runbook to perform.
Script Language Select the language (GO or Python) in which you write your script.
Parsing Script Enter the script to parse the output received after executing the SQL script..
Add variable Add a variable, if needed to be used in the parsing script.

Select the Create Runbook Plugin button to create the Runbook based on the parameters entered.

Select the Test button to verify the correctness of the script and the validity of the credential profile.

Select the Reset button to erase all the current field values, if required.

Note: The Create Runbook Plugin option is enabled only after the Test is successfully completed.