Skip to main content

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.

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:

FieldDescription
Runbook NameAssign a logical and unique name that identifies the task performed by the runbook.
DescriptionProvide a description of the Runbook.
Monitor/Group/IP-HostSelect Monitor, Group, or IP/Host based on the device(s) 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. This option is available when you select Monitor in the previous field.
Select GroupSelect desired group from the 'Groups' dropdown if you want to assign the Runbook to a group of monitors. This option is available when you select Group in the previous field.
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. This option is available when you select IP/Host in the previous field.
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 in this field. In case you select a credential profile, the port number specified in the credential profile will be used. You can override the port number from the credential profile by specifying a port number in this field.
TimeoutSpecify the timeout in this field. In case you select a credential profile, the timeout specified in the credential profile will be used. You can override the timeout from the credential profile by specifying a timeout in this field.
Log CollectionEnable this check-box to use the runbook for log collection. When you enable this field, the runbook will be available for selection while creating a log collection profile
URL TypeSelect the type of connection (HTTP/HTTPS) for which you want to create the Runbook.
URL MethodSelect the method (GET/POST) for which you want to create this Runbook.
JSON URLSelect whether the URL is a JSON URL or not.
URL EndpointSpecify the URL Endpoint where the HTTP request will be sent.
URL ContentEnter a keyword to search within the page mapped to the URL.
Add ParameterAdd any additional parameters required for the API call.
Add HeaderSpecify any additional header information required for the API call.
Script LanguageSpecify the language(Go or Python) you want use to write the parsing script.
Parsing ScriptWrite the script to parse the output derived from the API call.
Add VariableAdd 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.