Splunk® SOAR (On-premises)

Build Playbooks with the Playbook Editor

Acrobat logo Download manual as PDF


Acrobat logo Download topic as PDF

Manage settings for a playbook in

After you've saved a playbook, you can manage the settings for a specific playbook.

  1. In , from the Home menu, select Playbooks.
  2. Locate the playbook that you want to review settings for and click on the playbook name.
  3. In the playbook editor, click Playbook Settings.

The following table describes the fields in the playbook settings. The fields you will see depend on whether you are configuring a classic or modern playbook, and whether your modern playbook is an input or automation playbook.

Field Description Available in classic playbook? Available in modern automation playbook? Available in modern input playbook?
Operates on Select the event label or labels that this playbook runs on in the Operates on field. Most playbooks are designed to work with data in a particular category, and therefore a particular label for events. Every event in has a label associated with it, such as Events or Email. For more on labels in , see Configure labels to apply to containers in Administer . Yes Yes No
Category Use categories to organize your playbooks. For example, you can create a Production category for playbooks that are ready to be marked active, and a Test category for playbooks that are under development. Yes Yes Yes
Run as The automation user used to run the playbook. Yes Yes No
Tags Use tags to provide additional metadata to group playbooks together. You can create tags for playbook within the same category or across multiple categories. Yes Yes Yes
Logging Toggle this switch to turn on debug logging each time the playbook is run. This might be useful when create a new playbook. If the playbook has an error, you are able to see what the problem was using debug logging. Eventually, when the playbook works like you expect, turn logging off to save disk space. Yes Yes Yes
Active Toggle this switch to make the playbook run automatically on every new event or artifact that comes into . Yes Yes No
Safe Mode Toggle this switch to put the playbook in read-only mode. Read and write permissions are defined by each connector in . For example, in an LDAP connector, get users is a read-only action, while reset password is read-write.


Specifying the Safe Mode setting applies only to the current playbook, and not to any child playbooks called by that playbook. Specify Safe Mode for child playbooks directly.

Yes Yes Yes
Draft Mode Toggle this switch to save a draft of your playbook, even if your playbook is incomplete or has errors. Playbooks in draft mode can't be marked active. Yes Yes Yes
Description Enter a description for the playbook. The description becomes a triple-quoted comment in the playbook, and appears on the playbooks page. Yes Yes Yes
Notes Notes aren't visible anywhere else in and can only be viewed by editing the playbook. Yes Yes Yes
Export Playbook Export a playbook to download the current version of the playbook. This setting allows you to share playbooks with other users. You can import the file on the playbooks page. Yes No No
Parent Playbooks Expand the Parent Playbooks section to view or open the parent playbooks associated with this playbook. If there aren't any parent playbooks associated with this playbook, this section is not displayed. No Yes Yes
View Keyboard Shortcuts Click View Keyboard Shortcuts to see more information about keyboard shortcuts or to view the documentation. No Yes Yes
Revision History Click Revision History to view a playbook's revision history.
  • Click View to view a previous revision of the playbook. You can make edits, then save the edits as a new version.
  • Click Revert to use the corresponding previous version of the playbook as the most current version.
Yes Yes Yes
Audit Trail Click Audit Trail to download a comma-separated value (CSV) file that shows the full audit trail of the playbook, including dates and times. Yes Yes Yes
Docs
  • Click the Docs link in the classic playbook editor to go to the documentation page for .
  • Click the View Documentation link in the modern playbook editor to go to the documentation page for .
Yes Yes Yes
Tenants Select one or more tenants to run the playbook against the containers belonging to the selected tenants. Use an asterisk (*) to run the playbook on containers for all tenants.

This field is only available in Splunk SOAR on-premises deployments.

Yes Yes Yes
Last modified on 19 August, 2022
PREVIOUS
Export and import playbooks in
  NEXT
Edit playbook properties in

This documentation applies to the following versions of Splunk® SOAR (On-premises): 5.1.0, 5.2.1, 5.3.1, 5.3.2, 5.3.3, 5.3.4, 5.3.5


Was this documentation topic helpful?


You must be logged into splunk.com in order to post comments. Log in now.

Please try to keep this discussion focused on the content covered in this documentation topic. If you have a more general question about Splunk functionality or are experiencing a difficulty with Splunk, consider posting a question to Splunkbase Answers.

0 out of 1000 Characters