Manage Runbook

  1. Runbook configuration will help to identify and execute the runbooks (Ansible/BigFix) to resolve the ticket
  2. When executing the runbooks, set of parameters has to be passed
  3. Those parameters can be configured along with runbook configuration
  4. Following actions can be performed on the “Manage Runbook” page.
    1. Create Runbook (Individual, Bulk upload)
    2. Edit Runbook
    3. Delete Runbook
    4. Search Runbooks
    5. Download Runbooks
    6. Enable Auto Execution
    7. Disable Auto Execution

Runbooks List

  1. Navigate to the customers list
    Figure 1. Customer Navigation
  2. Click on customer edit
  3. Expand the Automation Menu
  4. Click on Manage Runbook menu
    Figure 2. Manage Runbook Menu
  5. Select the Runbook tool from dropdown
    Figure 3. Runbook Tool Selection
  6. Available Runbooks can be seen in list
    Figure 4. Runbooks List

Create Runbook

  • Runbooks can be created in two ways a) Individual b) Bulk upload
  • Individual options can be helpful to create one runbook at once using a runbook creation page.
  • Bulk upload option can be helpful to create multiple runbooks at once using file upload.
  1. Individual
    1. Click on “New Runbook”
      Figure 5. Create Runbook Option
    2. Select a Runbook tool against which runbook needs to be created
    3. Provide the mandatory details for following fields.
    4. Provide other optional details
      Figure 6. Create Runbook Page
    5. Add parameters to be passed for runbook execution by using the “Add New Parameter” option.
      Figure 7. Add Runbook Parameter Option
    6. For each parameter provide relevant details like name, description, type, etc..
    7. Save each parameter against runbook using “save” option
      Figure 8. Save Runbook Parameter
    8. After providing the runbook and parameter details click on “Submit” to save a runbook.
      Figure 9. Save Runbook

  2. Bulk Upload

    1. Click on “New Runbook”
      Figure 10. Create Runbook Option
    2. Select “bulk upload” option
    3. Click on “download template” option to get a file format
      Figure 11. Download Template Option
    4. Download file success
      Figure 12. Download Template Success
    5. Provide all the required details in a file
    6. Select a Runbook tool on the bulk upload page against which runbook needs to be created.
    7. Click on “Choose file” and select a file to be uploaded.
    8. Click on “Upload”
      Figure 13. Upload File Option
    9. Upload runbooks success and can be seen in the list.
      Figure 14. Bulk Upload Success

Edit Runbook

  1. Select a Runbook tool and get the available runbooks
    Figure 15. Runbook Tool Selection
  2. Click on “Edit” option on respective Runbook
    Figure 16. Edit Runbook Option
  3. Runbook Name and Runbook Tools are readonly fields.
  4. Provide if any other details to be updated on the edit page.
    Figure 17. Edit Runbook Page
  5. If existing parameters need to be updated click on the “Edit” option on respective parameters.
    Figure 18. Edit Runbook Parameter
  6. If existing parameter needs to be removed click on “delete” option on respective parameter
    Figure 19. Delete Runbook Parameter
  7. Add new parameters if required to be passed for runbook execution by using the “Add New Parameter” option.
    Figure 20. Add New Runbook Parameter
  8. For each parameter provide relevant details like name, description, type, etc..
  9. Save each parameter against runbook using “save” option
    Figure 21. Save Runbook Parameter
  10. After providing the runbook and parameter details click on “Update” to save a runbook.
    Figure 22. Update Runbook
  11. Update runbook successful
    Figure 23. Runbook Update Successful

Delete Runbook

  1. Select a Runbook tool and get all the available Runbooks.
    Figure 24. Runbook Tool Selection
  2. Click on the “Delete” option against runbook to be deleted.
    Figure 25. Delete Runbook
  3. Confirm the delete action
    Figure 26. Delete Runbook Confirmation
  4. Runbook deletion success.
    Figure 27. Runbook Delete Success

Search Runbooks

  1. Select a Runbook tool and get all the available Runbooks.
    Figure 28. Runbook Tool Selection
  2. Select a column name from the dropdown against which we need to filter the runbooks.
  3. Provide a filter value for the selected column.
  4. Click on the Search button.
    Figure 29. Runbooks Search Option
  5. Specific runbooks will be visible which are matches filter criteria.
    Figure 30. Filtered Runbooks List

Download Runbooks

  1. Select a Runbook tool and get all the available Runbooks.
    Figure 31. Runbook Tool Selection
  2. Click on “Download Runbooks” option
    Figure 32. Download Runbooks Option
  3. It will download all the available runbooks for a tool.
    Figure 33. Download Runbooks Success
  4. The downloaded file contains all the runbooks details along with parameter details.

Enable/Disable Auto Execution

  1. Select a Runbook tool and get all the available Runbooks.
    Figure 34. Runbook Tool Selection
  2. Select the Runbooks from a list for which need to perform enable/disable auto execution.
  3. Click on “Enable Auto Execution” if needs to be enabled
    Figure 35. Enable Auto execution
  4. Click on “Disable Auto Execution” if needs to be disabled
    Figure 36. Disable Auto Execution
  5. After updating, it can be visible on Runbooks list with the latest modifications.