Editing a runbook

The runbook editor provides editing capabilities as well as runbook elements that help to document operational procedures. Runbook elements are designed to avoid mistakes.

  1. Click the navigation icon at the upper-left corner of the screen to go to the main navigation menu.

  2. In the main navigation menu, click Operate > Automations.

  3. Click Runbooks.

    The Library tab is displayed by default.

  4. Click Create runbook to create a new runbook, or scroll through the list of runbooks and click the menu overflow icon and select Edit to open an existing runbook in the editor.

    Runbook editor
    Figure. Runbook editor

Region 1 Runbook details: Enter descriptive data about the runbook.

  • Name: the name identifies the runbook. Try to be as precise as possible and describe the problem that this runbook solves.

  • Description: describe the problems that this runbook solves in more detail and sketch out the solution.

  • Tags: provide tags to filter runbooks. You can select any existing tags from the drop-down list and click the plus icon "+" to add them. To create a new tag, type the text into the field, select the text string displayed, and click the plus icon "+".

  • Runbook ID: this field is generated by Runbook Automation. The Runbook ID can be used to identify the runbook using the Runbook Automation HTTP REST Interface. Use the copy button to copy the ID to the clipboard.

Region 2 Editor: Provides text edit actions and runbook elements to describe operational tasks. Each step has its own section with an optional title. Manual steps cannot contain automation elements. Automated steps must be added for actions.

Region 3 Parameters: Create parameters that are used in this runbook.

Region 4 Actions: Add pre-defined actions to the runbook. Action steps only contain an action, no text.

Region 5 Save and Publish the runbook.

For more information about editing a runbook, see the following topics: