Runbooks

Runbooks

Settings

Runbooks

Configure automated remediation scripts that execute on agent-monitored devices when an alarm fires. Cloudmon provides over 100 pre-built runbook templates and supports custom runbooks for organisation-specific tasks.

Overview

Runbooks in Cloudmon are ready-to-run scripts that can be executed automatically on agent-monitored devices when an alarm trigger fires, or run manually at any time. Automated remediation through runbooks reduces mean time to resolution, eliminates manual intervention for known recurring issues, and helps prevent downtime by acting on problems the moment they are detected.

Cloudmon includes over 100 built-in runbook templates covering tasks such as restarting services, clearing DNS caches, taking screenshots, fetching email status, and more. If the built-in templates do not cover a specific requirement, custom runbooks can be created. Runbooks are exclusively available for agent-monitored devices. Navigate to Settings → General Settings → Runbooks to view and manage all runbooks.

Using Runbook Templates

  1. Navigate to Settings → General Settings → Runbooks.
  2. Browse or search the list of over 100 pre-defined runbook templates.
  3. Click the runbook you want to use to view its details and script content.
  4. To attach it to an alarm, navigate to Settings → Configurations → Alarm Rules, open the relevant rule, add a trigger, and in the THEN section enable Run Script. Select whether to run on the controller or the agent, then choose the runbook from the dropdown.

Creating a Custom Runbook

  1. Navigate to Settings → General Settings → Runbooks.
  2. Click Add in the top right corner.
  3. Fill in the fields as described in the table below.
  4. Click Save. The custom runbook is now available for selection in alarm rule triggers alongside the built-in templates.
FieldDescription
NameA descriptive name for the runbook.
DescriptionA brief description of the runbook's purpose, such as what it does and when it should be used.
TypeSelect Script to write or paste a script into the editor, or Command to enter a single command to be executed on the agent.
Operating SystemThe target operating system for this runbook. Cloudmon uses this to ensure the script or command is only executed on compatible agents (Windows or Linux/macOS).
Timeout (seconds)The maximum time the system waits for the script or command to complete before stopping the execution.
ArgumentsAdditional parameters passed to the script or command to customise its execution. Hover over the info icon to view the expected format.
FilterOptional filter to restrict which agents this runbook can be executed on. Hover over the info icon next to the filter field to view the format.

Supported Script Types

When Type is set to Script, the script content you provide is executed on the target agent. The supported scripting languages depend on the selected operating system:

  1. Batch (CMD) | Windows
  2. PowerShell | Windows
  3. Bash | Linux
  4. Python
  5. Nodejs

When Type is set to Command, a single shell or PowerShell command is executed directly on the agent without a script file.

Running Runbooks

Runbooks can be executed in three ways:

Automatic Execution via Alarm Rules

When an alarm fires, Cloudmon automatically executes the runbook attached to the alarm trigger. Navigate to Settings → Configurations → Alarm Rules, open the rule, add a trigger, and in the THEN section enable Run Script. Select whether to run on the controller or the agent, then choose the runbook. When the alarm is raised, the runbook executes automatically and the output is shown in the alarm overlay.

Manual Execution via an Active Alarm

When an alarm is triggered, click on the alarm, hover over Execute Runbook to view the list of available runbooks, and select the desired script. This allows for manual control over which runbook is executed for a specific active alarm.

Manual Execution via Agent Actions

Runbooks can also be executed directly from any agent's detail page without needing an active alarm. Navigate to Agents → All Agents, select an agent, and click the Actions icon. A list of all available runbooks including any custom runbooks is displayed. Click the run icon to execute a runbook, or the history icon to view past executions and their outputs. You can also click the command icon to manually execute a one-off command on the agent and view the output under All History.

    • Related Articles

    • Can we execute runbooks from the alarms page only?

      Runbooks can be triggered once an alarm is activated, and you have the flexibility to execute them directly from the alarm. Additionally, you can configure a runbook in the alarm rule, ensuring its execution when the threshold is crossed. ...
    • Are the runbooks predefined scripts or can the user add it manually? What are the supported formats that can be added as runbooks?

      Cloudmon has over 100 runbooks that are provided in the platform by default. In addition, Cloudmon has the option to add custom runbooks – Python, PowerShell scripts, bash scripts, bat scripts, and JS scripts are supported.
    • Settings

      Settings Settings Configure and manage every aspect of your Cloudmon deployment from a single location. Settings covers user access and roles, credentials, monitoring profiles, log rules, runbooks, device dependencies, and more. The Settings section ...
    • Benefits of Cloudmon

      Overview Benefits of Cloudmon Cloudmon delivers measurable value at every level of the IT organisation. The table below outlines the key benefits for each stakeholder group. Benefits by Stakeholder Stakeholder Key Benefits IT Teams Monitor IT from a ...
    • Audience

      Overview Audience This guide is intended for IT professionals responsible for deploying, configuring, and operating Cloudmon in their organisation. Intended Audience The Cloudmon User Guide is written for the following roles: Role How they use ...