Create a HTTP Runbook
Overview
HTTP Runbooks in Motadata AIOps provide a versatile tool for executing actions on monitors using the HTTP protocol, particularly beneficial in scenarios where triggering actions on an API under specific conditions is required. This can be important for interacting with various devices and platforms like Ruckus devices, VMware, and any platform providing API endpoints, enabling automated interactions and data retrieval through API calls, in turn enhancing the automation and response mechanism in your IT environment.
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. Select HTTP to create a HTTP Runbook.
HTTP Runbook Configuration
The HTTP 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:
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. |
URL Endpoint | Specify the URL Endpoint where the HTTP request will be sent. |
URL Type | Select the type of connection (HTTP/HTTPS) for which you want to create the Runbook. |
URL Method | Select the method (GET/POST) for which you want to create this Runbook. |
JSON URL | Select whether the URL is a JSON URL or not. |
URL Content | Enter a keyword to search within the page mapped to the URL. |
Add Parameter | Add any additional parameters required for the API call. |
Add Header | Specify any additional header information required for the API call. |
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 from the API call. |
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.