Load and reset example runbooks

IBM® Runbook Automation provides ready-to-go sample runbooks. Load the examples to explore what you can do with runbooks.

• Load sample runbooks

  Load all pre-defined examples. You can also edit the example runbooks and create new versions.

  1. In the main navigation menu, select Administration and click Integration with other systems.
  2. Click Automation type.
  3. Ensure that a connection of type "SSH" has been configured. If it does not yet exist you can configure it now (with default values).
  4. Open the runbook Library page.
  5. Click Load sample runbooks and select Load sample runbooks.
  6. The sample runbooks are shown in the Library page. The runbooks will show up for Operators if they are published. The samples are marked by the text Example:.
  7. Click Preview to view the runbook and see what it does.
  8. Click Run to run your first runbook. For more information about how to run a runbook, see Run your first runbook.
• Sample runbooks with special administrative use cases
  Some of the following sample runbooks go beyond just illustrating the features of runbooks:

  • Example: Convert existing operational procedures into runbooks: This runbook explains how to convert your existing operational procedures into runbooks. It covers file based procedures and web/wiki based procedures.
  • Example: Import runbooks from an existing runbook deployment: Provides instructions on how to export runbooks from one deployment and import them to another deployment. It uses the RBA API for both operations.
  • Example: Reduce amount of data in runbook data stores and its automated variant Example: Automatically reduce amount of data in runbook data stores: Offload runbook execution data into a secondary data store for auditing or long-term storage purposes. This will delete that data from the production data store to ensure less disc space usage and faster response times on the active system.
  • Example: Add new SSH key to target systems and Example: Remove old SSH key from target systems: These sample runbooks assist you during deployment migration. As part of the migration, you must install the SSH key of the new deployment to all target systems that were previously reached from the old deployment, using that old deployment's SSH key. This is a prerequisite step when you plan to migrate your runbooks and script automations from the old deployment to the new deployment. For more details, see Installing new SSH key during migration.
• Reset sample runbooks

  Follow these steps if you edited the examples and would like to reload the original version, or if you have upgraded to a new version and want to get the latest versions of the examples:

  1. Open the runbook Library page.
  2. Open the Reload sample runbooks menu.
  3. Select Delete sample runbooks and wait for the sample runbooks to be deleted.
  4. Open the Load sample runbooks menu.
  5. Select the Load sample runbooks menu item and wait for the sample runbooks to be loaded.
• Convert a sample runbook to a regular runbook

  To save a sample runbook as a regular runbook:

  1. Open the Library page.
  2. On the runbook that you want to convert, click the menu overflow icon and select Copy runbook.
  3. Change the runbook name. You can optionally update the description.
  4. Click Save.

     After saving, the runbook will no longer be tagged as an example.

  5. If the sample runbook references an automation, then you need to create a "deep copy" manually:
     1. Navigate to the Automation table and select the referenced sample automation.
     2. Copy the sample automation and modify its name so you can identify the copy.
     3. Edit the copy of the sample runbook, and replace the reference to the original sample automation with a reference to your new copy of the sample automation.
• Delete sample runbooks
  1. Open the Library page.
  2. Click Load sample runbooks and select Delete sample runbooks.
  3. Confirm that you want to delete the sample runbooks from the Library page.