🌙
 

Subscribe to the Taegis™ XDR Documentation RSS Feed at .

Learn more about RSS readers or RSS browser extensions.

Configured Playbooks

automation playbooks


The Configured tab displays all previously configured playbooks that are ready to be executed.

Use the search bar to filter the list of configured playbooks.

Edit Configured Playbook Columns

Hover over any column heading to edit all displayed columns.

Drag the columns to adjust their width.

Tip

Secureworks recommends adding the Version and Status columns to your configured playbooks list.

Adding a New Column to the Playbooks Overview

Adding a New Column to the Playbooks Overview

View Configured Playbook Details

To view details of a configured playbook, select its Name from the Configured tab of the Playbooks overview.

Itemized Playbook Details Page

Itemized Playbook Details Page

Playbook details include:

  1. Version — The playbook template version that this configured playbook is using, as well as a link to manage versions. See Manage Playbook Versions for more information.
  2. Documentation — A link to the playbook's definition requirements. See Edit and Configure Playbooks for more information.
  3. Status — An option to Enable or Disable this playbook. See Enable or Disable a Playbook for more.
  4. Copy Share Link — Copy a direct link to this playbook.
  5. More Actions — Actions you can take on a playbook:
  6. Configure — Edit this particular playbook. See Edit and Configure Playbooks for more information.
  7. Executions and Failures — A line chart displaying the trend of successful vs. failed executions for this playbook. Use the date/time picker above the chart to adjust the time period.
  8. Playbook History — A history of all execution instances of this particular playbook. See Playbooks History for more information.

Edit and Configure Playbooks

To edit a configured playbook:

  1. Open the playbook details page.
  2. Select Configure.
  3. Edit the playbook’s details, connections, trigger, and inputs.

Tip

Select Documentation at the top of the edit screen to view definition requirements for this playbook.

Viewing Playbook Documentation

Viewing Playbook Documentation

  1. Select Save and Next after each section to save your progress.
  2. Select Save and Finish to complete the playbook’s configuration.

Note

Only one connection per playbook may be used.

Enable or Disable a Playbook

Note

New playbooks are enabled by default upon creation.

To disable or enable a playbook:

  1. Select the name of the desired playbook from the Configured tab of the Playbooks overview.
  2. On the Playbook details page, select the Status toggle to enable or disable the playbook.

Manually Execute a Playbook

Important

Refer to the playbook’s documentation to learn if it is designed to be executed manually. The majority of playbooks are not designed for this purpose and will fail if run manually.

To manually execute a playbook:

  1. Select the name of the desired playbook from the Configured tab of the Playbooks overview.
  2. On the Playbook details page, select More Actions > Trigger Manually.
  3. The Execute Playbook modal is displayed. Review the inputs, making changes if desired, and then select Execute.

Cancel Instance Executions of a Playbook

To cancel ALL running executions for a configured playbook, follow these steps:

  1. Select the name of the desired playbook from the Configured tab of the Playbooks overview.
  2. On the Playbook details page, select More Actions > Cancel Instance Executions.
  3. Enter a date and time period in which the executions you wish to cancel or clear appear, or leave blank to cancel or clear all.
  4. Select Proceed.

Tip

To cancel one or more individual executions, see Cancel Playbook Execution Instances.

Delete a Configured Playbook

To delete a configured playbook:

  1. Select the name of the desired playbook from the Configured tab of the Playbooks overview.
  2. On the Playbook details page, select More Actions > Delete.
  3. A delete modal is displayed. Select Delete to confirm your action.

 

On this page: