Ansible Playbook

Executes a Red Hat Ansible playbook.

Object Representation (YAML)

id: String
name: String
tool_version: String
type: String
depends: [String]
tags: [String]
condition: Boolean
each: Array
verbosity: 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
  credential: String
  env:
    - name: String
      value: String

Fields

PropertyDetails
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.

tool_version

String

The version to use. This version is only installed for the subprocess run by the step, and will not propagate to other operating system sessions.

type *

String

The type of the step. Can be pipeline or a step module type.

depends[]

[String]

A list of dependencies of this step.

This step will not be executed until all steps with ids in this list are finished executing.

tags[]

[String]

Tags are used to group related steps. Steps with the same tag can be retrieved using the findStepsByTag() helper function.

Can contain hyphens and underscores, but not spaces.

condition

Boolean

An expression which is evaluated before the step executes. If it evaluates to false, the step will be skipped. The step.result.status field will be "Skipped".

each

Array

An array of elements to execute the step once for each of them.

verbosity

String

Step event verbosity. Determines how much information about step execution is sent back to the application.

ignore_errors

Boolean

If true, errors in the step module will not halt pipeline execution, and subsequent steps will still be executed. The step.result.status field will be "Failed" if the step encounters an error.

properties.playbook_content

String

Inline playbook content. Provide exactly one of playbook_content or playbook_path.

properties.playbook_path

String

Path to an existing playbook on the agent. Provide exactly one of playbook_content or playbook_path.

properties.inventory_content

String

Inline inventory content. Provide exactly one of inventory_content or inventory_path.

properties.inventory_path

String

Path to an existing inventory on the agent. Provide exactly one of inventory_content or inventory_path.

properties.vars

String

Inline variables. Can be provided as YAML or JSON.

properties.verbosity

String

Verbosity of the output. One of v, vv, vvv, vvvv, vvvvv, vvvvvv.

properties.args

String

Extra command line arguments to pass to ansible-playbook.

properties.cwd

String

Working directory for the playbook run. Defaults to the run directory.

properties.credential

String

The ID of a SSH Key credential for authentication with the remote machine.

properties.env[]

[Object]

A list of environment variables that will be set for script execution.

properties.env[].name *

String

Environment variable name.

properties.env[].value *

String

Environment variable value.

Result Fields

The following are the step execution result fields available at steps.<step id>.result after a step executes.

KeyDetails
result.status

String

A string indicating the step execution status. Can be Succeeded, Failed, or Skipped.