id: String
name: String
depends: [String]
tags: [String]
condition: String
ignore_errors: Boolean
properties:
playbook_content: String
playbook_path: String
inventory_content: String
inventory_path: String
vars: String
verbosity: String
args: String
cwd: String
Property | Details |
---|---|
id * | String A unique identifier for the step. Can contain hyphens and underscores, but not spaces. |
name * | String A friendly name for the step. This name will appear in the pipeline designer and run output. |
depends[] | [String] A list of dependencies of this step. This step will not be executed until all steps with |
tags[] | [String] Tags are used to group related steps. Steps with the same tag can be retrieved using the Can contain hyphens and underscores, but not spaces. |
condition | String An expression which is evaluated before the step executes. If it evaluates to false, the step will be skipped. The |
ignore_errors | Boolean If |
properties.playbook_content | String Inline playbook content. Provide exactly one of |
properties.playbook_path | String Path to an existing playbook on the agent. Provide exactly one of |
properties.inventory_content | String Inline inventory content. Provide exactly one of |
properties.inventory_path | String Path to an existing inventory on the agent. Provide exactly one of |
properties.vars | String Inline variables. Can be provided as YAML or JSON. |
properties.verbosity | String Verbosity of the output. One of |
properties.args | String Extra command line arguments to pass to |
properties.cwd | String Working directory for the playbook run. Defaults to the run directory. |
The following are the step execution result fields available at step.result
after a step executes.
Key | Details |
---|---|
result.status | String A string indicating the step execution status. Can be Succeeded, Failed, or Skipped. |