Skip to main content

Create a PowerShell Runbook

Overview

PowerShell Runbooks in Motadata AIOps stand as a robust tool, enabling the execution of specific actions on monitors by utilizing the PowerShell protocol. Predominantly employed for Windows environments, PowerShell Runbooks empower administrators to perform tasks remotely, ensuring secure and authenticated communications between the orchestrator and the hosts.

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

PowerShell 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:

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
PowerShell ScriptWrite the script detailing the task that you wish to execute using the Runbook.
Script LanguageSpecify the language (Go or Python) you want use to write the parsing script.
Parsing ScriptWrite the script to parse the output derived post PowerShell script execution.
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.