shanemcd.awx.workflow_launch (20.0.14) — module

Install collection

Install with ansible-galaxy collection install shanemcd.awx:==20.0.14

Add to requirements.yml

  collections:
    - name: shanemcd.awx
      version: 20.0.14

Description

Launch an Automation Platform Controller workflows. See U(https://www.ansible.com/tower) for an overview.

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Launch a workflow with a timeout of 10 seconds
  workflow_launch:
    workflow_template: "Test Workflow"
    timeout: 10

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Launch a Workflow with extra_vars without waiting
  workflow_launch:
    workflow_template: "Test workflow"
    extra_vars:
      var1: My First Variable
      var2: My Second Variable
    wait: False

Inputs

    
name:
    aliases:
    - workflow_template
    description:
    - The name of the workflow template to run.
    required: true
    type: str

wait:
    default: true
    description:
    - Wait for the workflow to complete.
    type: bool

limit:
    description:
    - Limit to use for the I(job_template).
    type: str

timeout:
    description:
    - If waiting for the workflow to complete this will abort after this amount of seconds
    type: int

interval:
    default: 1
    description:
    - The interval to request an update from the controller.
    required: false
    type: float

inventory:
    description:
    - Inventory to use for the job ran with this workflow, only used if prompt for inventory
      is set.
    type: str

extra_vars:
    description:
    - Any extra vars required to launch the job.
    type: dict

scm_branch:
    description:
    - A specific branch of the SCM project to run the template on.
    - This is only applicable if your project allows for branch override.
    type: str

organization:
    description:
    - Organization the workflow job template exists in.
    - Used to help lookup the object, cannot be modified using this module.
    - If not provided, will lookup by name only, which does not work with duplicates.
    type: str

validate_certs:
    aliases:
    - tower_verify_ssl
    description:
    - Whether to allow insecure connections to AWX.
    - If C(no), SSL certificates will not be validated.
    - This should only be used on personally controlled sites using self-signed certificates.
    - If value not set, will try environment variable C(CONTROLLER_VERIFY_SSL) and then
      config files
    type: bool

controller_host:
    aliases:
    - tower_host
    description:
    - URL to your Automation Platform Controller instance.
    - If value not set, will try environment variable C(CONTROLLER_HOST) and then config
      files
    - If value not specified by any means, the value of C(127.0.0.1) will be used
    type: str

controller_password:
    aliases:
    - tower_password
    description:
    - Password for your controller instance.
    - If value not set, will try environment variable C(CONTROLLER_PASSWORD) and then
      config files
    type: str

controller_username:
    aliases:
    - tower_username
    description:
    - Username for your controller instance.
    - If value not set, will try environment variable C(CONTROLLER_USERNAME) and then
      config files
    type: str

controller_oauthtoken:
    aliases:
    - tower_oauthtoken
    description:
    - The OAuth token to use.
    - This value can be in one of two formats.
    - A string which is the token itself. (i.e. bqV5txm97wqJqtkxlMkhQz0pKhRMMX)
    - A dictionary structure as returned by the token module.
    - If value not set, will try environment variable C(CONTROLLER_OAUTH_TOKEN) and then
      config files
    type: raw
    version_added: 3.7.0
    version_added_collection: shanemcd.awx

controller_config_file:
    aliases:
    - tower_config_file
    description:
    - Path to the controller config file.
    - If provided, the other locations for config files will not be considered.
    type: path

Outputs

job_info:
  description: dictionary containing information about the workflow executed
  returned: If workflow launched
  type: dict