diff --git a/blog-csoar/2025-04-21-content.md b/blog-csoar/2025-04-21-content.md index d4208bdc7c..5f7d428722 100644 --- a/blog-csoar/2025-04-21-content.md +++ b/blog-csoar/2025-04-21-content.md @@ -28,6 +28,7 @@ import useBaseUrl from '@docusaurus/useBaseUrl'; * Added a confirmation dialog to alert users about pre-existing playbook drafts to avoid accidental overwriting while editing playbooks. * Implemented an alert popup to prevent accidental loss of unsaved changes when closing a node popup. * Added audit logs for failed nodes due to errors or exceptions during playbook execution. +* Added the ability to enable or disable playbooks. ### Bug fixes diff --git a/docs/platform-services/automation-service/automation-service-playbooks.md b/docs/platform-services/automation-service/automation-service-playbooks.md index ee3f706d8b..ecdfc6d1ce 100644 --- a/docs/platform-services/automation-service/automation-service-playbooks.md +++ b/docs/platform-services/automation-service/automation-service-playbooks.md @@ -226,6 +226,34 @@ Every time you publish a playbook, a new version of the playbook is retained. In Playbook versions +## Enable or disable playbooks + +You can enable playbooks for use in automations, or disable them to prevent them from being used. This gives you greater control over when a playbook can be run. If for example a playbook is causing a problem, such as exceeding your actions limit or sending too many emails, you could temporarily disable the playbook until you remedy the issue. + +When enabling or disabling playbooks, keep in mind: +* By default, draft playbooks are disabled. +* Playbooks without any published versions are initially disabled and will be automatically enabled upon publishing their first version. +* Disabled playbooks cannot be triggered automatically. +* Deleted playbooks are set to disabled and remain so after restoration. +* Cloned or imported playbooks are enabled by default, irrespective of the original playbook's status. +* [Audit logs](/docs/platform-services/automation-service/automation-service-audit-logging/) are generated whenever playbooks are enabled or disabled manually. + +### How to enable or disable a playbook + +To enable or disable a playbook, open the playbook and click the toggle.
Playbook enabled toggle
Playbook disabled toggle + +The **Status** column shows whether a playbook is enabled Playbook enabled symbol or disabled Playbook disabled symbol. + +Playbook status column + +### Enable on publish + +To publish a playbook, click the **Publish** button at the bottom of the playbook window:
Publish the playbook + +When you publish a playbook: +* Playbooks without any published versions are automatically enabled. +* Playbooks that have previously published versions will display an **Enable playbook on publish** option if they are in a disabled state:
Publish enable on publish + ## Playbook preferences 1. Click the preferences button in the upper-right corner of the screen.
Playbook preferences button diff --git a/static/img/platform-services/automation-service/playbook-disabled-symbol.png b/static/img/platform-services/automation-service/playbook-disabled-symbol.png new file mode 100644 index 0000000000..001eba9257 Binary files /dev/null and b/static/img/platform-services/automation-service/playbook-disabled-symbol.png differ diff --git a/static/img/platform-services/automation-service/playbook-disabled-toggle.png b/static/img/platform-services/automation-service/playbook-disabled-toggle.png new file mode 100644 index 0000000000..8844c55c0a Binary files /dev/null and b/static/img/platform-services/automation-service/playbook-disabled-toggle.png differ diff --git a/static/img/platform-services/automation-service/playbook-enable-on-publish-toggle.png b/static/img/platform-services/automation-service/playbook-enable-on-publish-toggle.png new file mode 100644 index 0000000000..12ba105dc4 Binary files /dev/null and b/static/img/platform-services/automation-service/playbook-enable-on-publish-toggle.png differ diff --git a/static/img/platform-services/automation-service/playbook-enabled-symbol.png b/static/img/platform-services/automation-service/playbook-enabled-symbol.png new file mode 100644 index 0000000000..be053903f8 Binary files /dev/null and b/static/img/platform-services/automation-service/playbook-enabled-symbol.png differ diff --git a/static/img/platform-services/automation-service/playbook-enabled-toggle.png b/static/img/platform-services/automation-service/playbook-enabled-toggle.png new file mode 100644 index 0000000000..62b566c3ea Binary files /dev/null and b/static/img/platform-services/automation-service/playbook-enabled-toggle.png differ diff --git a/static/img/platform-services/automation-service/playbook-status-enabled-disabled.png b/static/img/platform-services/automation-service/playbook-status-enabled-disabled.png new file mode 100644 index 0000000000..47c3eeb8ba Binary files /dev/null and b/static/img/platform-services/automation-service/playbook-status-enabled-disabled.png differ