Skip to main content

Cyware Orchestrate

Terminate Playbook Runs

You can terminate playbooks to free up resources and mitigate any unintended consequences on the playbook execution. You can terminate individual playbooks or terminate multiple playbooks at a time. You can terminate playbooks that are in progress, in-queue, waiting, or on-hold status.

Terminate a Playbook Run

You can terminate a playbook with the run status such as in progress, in-queue, waiting, or on-hold status from the run logs. You can terminate a playbook either from the run logs listing page or from a specific run log.

Steps

To terminate a playbook from the run logs listing page, follow these steps:

  1. Go to Main Menu > Run Logs.

  2. Select the playbook that you must terminate and select the checkbox. You can search for a required playbook using the playbook name or playbook ID.

  3. Click Terminate on the top bar and accept the confirmation prompt to terminate the playbook.

To terminate a run log from the run log detailed page, you should open a run log, click Terminate, and accept the confirmation prompt.

Note

If you terminate a playbook run, all associated Cyware Agent tasks are also terminated, including tasks from sub-playbooks. To view terminated Cyware Agent tasks, go to Main Menu > Cyware Agent Tasks.

Bulk Terminate Playbook Runs

Notice

This feature is available in Orchestrate from the release version v3.5.0 and later.

Analysts can terminate multiple playbook runs at a time such as playbooks that are in-queue status. This eliminates the need to terminate multiple playbooks individually, thereby saving time and effort. Terminating a playbook also terminates the associated sub-playbooks.

You can terminate a maximum of 100 playbook runs at a time with the run status in progress, in-queue, waiting, or on hold.

Steps

To bulk terminate playbook runs, follow these steps:

  1. Go to Main Menu > Run Logs.

  2. Select the playbook run that you need to terminate in one of the following ways: 

    • Click the checkbox adjacent to the required run logs.

    • Click the select checkbox adjacent to the Terminate button and select a status to terminate the playbook by run status.

  3. Click on Terminate and accept the confirmation prompt to terminate the playbook. 

    Note

    If you bulk terminate playbooks, all associated Cyware Agent tasks are also terminated, including tasks from sub-playbooks. To view terminated Cyware Agent tasks, go to Main Menu > Cyware Agent Tasks.