Skip to main content

How to Clone a Runbook

Clone a runbook when you want to tweak a user-created runbook or build a new one that is only slightly different from an existing custom runbook. The clone is a fully editable copy; the original is left untouched.

note

Clone Runbook is available only on user-created runbooks. Inbuilt runbooks are read-only and cannot be cloned from the UI. The row menu on an inbuilt runbook shows only Assign Monitor, Remove Assigned Monitor, and Schedule Runbook. To base a new runbook on an inbuilt one, open the inbuilt runbook's view page, copy the script source, and paste it into a new runbook created with Create Runbook Plugin.

Before You Begin​

  • The source runbook is a user-created runbook listed on Settings > Plugin Library > Runbook.
  • You have identified the fields you want to change on the clone (name, script, parsing, monitor, credential, variables).

Steps​

  1. Go to Settings > Plugin Library > Runbook.
  2. On the row of the source user-created runbook, open the actions menu (three-dot icon). The menu shows: Assign Monitor, Remove Assigned Monitor, Clone Runbook, Schedule Runbook, Edit Runbook, Delete Runbook.
  3. Click Clone Runbook.
  4. The Create Runbook screen opens, pre-filled with every field from the source. The runbook type cannot be changed on the clone.
  5. Change the fields you need:
    • Give the clone a new Runbook Name.
    • Update the Script (or SSH Script, Telnet Script, Powershell Script, SQL Script, depending on the type).
    • Update the Parsing Script if the output format changed.
    • Add, remove, or rename variables under Add Variable. The script must reference them as $$$variable.name$$$.
    • Pick a different Monitor or Credential Profile if the clone targets a different host.
  6. Click Test to run the clone once and verify the parsed values.
  7. Click Save. The clone appears on the Runbook screen as a new user-created runbook; its row menu exposes Edit Runbook and Delete Runbook in addition to the standard actions.

Result​

The clone behaves like any custom runbook: you can assign it to monitors, schedule it, use it as a policy action, and edit or delete it from its row menu.

Troubleshooting​

IssueCauseFix
Clone Runbook is missing from the actions menuThe row is an inbuilt runbook. Clone is not available on inbuilt rows.Build a new runbook from scratch with Create Runbook Plugin and paste the script from the inbuilt runbook's view page.
Clone fails to save with "name already exists"A runbook with that name is already in the library.Give the clone a different name.
Clone's Test returns empty valuesThe parsing script references a variable that was renamed in the clone.Open Add Variable, confirm the names, and update the parsing script to use the exact $$$variable.name$$$ syntax.

Next Steps​