Execution step parameters
The array of execution step elements describes a playbook's logic. The execution steps are performed in the order described in the playbook. There are several types of execution steps:
- ResponseAction
- Split
- Scatter-gather
- Switch
- UpdateData
ResponseAction parameters
The Response action parameters call the response function.
Parameter ID | Description |
| An object that defines a response action. For more information, refer to ResponseFunction parameters. |
| This parameter allows you to filter components to perform a response action. When requested, the component plug-ins are filtered by allowed and restricted components. For example, the parameter can be specified as follows:
|
| This parameter allows you to edit the value returned by the response action, by using a jq expression and placing it in the playbook data (local or operational). |
| This parameter allows you to set timeouts for calling the response function. You can specify the name of the timeout policy set in the playbook or set timeout values manually. If the value is not specified, the default timeout is applied. |
| This parameter allows you to configure a manual approval of a response action. Possible values:
|
| This parameter defines the behavior when an error occurs during the execution of a response action. Possible values:
By default, the value is Note that, if a system error occurs, the playbook execution completes with an error regardless of the specified value of the |
Timeout policy
The timeout policy of execution steps. The system automatically determines the default timeout policy.
The default timeout policy can be reconfigured by using the default policy name. In this case, the new policy will be automatically applied to all execution steps.
Parameter ID | Description |
| Timeout policy name. |
| The maximum execution time, including waiting in the queue and retries. The parameter is specified in the Go string format. If the value is not specified or 0, the value from the |
Output
The output parameter generates operational data at the end of a step, which will then be transferred to the next step. Specify the output parameter if you want to use the results of the current step of the playbook in the next step.
To avoid overloading the system, it is recommended to limit the data placed in the playbook data (local or operational).
Parameter ID | Description |
| This parameter defines whether the playbook data (local or operational) will be overwritten or merged. Possible values:
|
| This parameter defines the jq expression for processing output data. |
Manual approve
Parameter ID | Description |
| The timeout for manual approval in minutes. The minimum value is 10 minutes ( By default, the value is 60 minutes ( |
| This parameter allows you to configure the sending of email notifications. |
Email notification settings
Parameter ID | Description |
| Flag for enabling email notifications. |
| This parameter defines the delay before sending the email notification. The value is specified in minutes. The minimum value is 5 minutes ( By default, the value is 10 minutes ( |
