ansible.builtin.tower_workflow_launch (v2.9.24) — module

Install Ansible via pip

Install with pip install ansible==2.9.24

Description

Launch an Ansible Tower workflows. See U(https://www.ansible.com/tower) for an overview.

Requirements

• python >= 2.6

Usage examples

Scanned by Steampunk Spotter

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

- name: Launch a workflow
  tower_workflow_launch:
    workflow_template: "Test Workflow"
  delegate_to: localhost
  run_once: true
  register: workflow_results

Scanned by Steampunk Spotter

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

- name: Launch a Workflow with parameters without waiting
  tower_workflow_launch:
    workflow_template: "Test workflow"
    extra_vars: "---
my: var"
    wait: False
  delegate_to: localhost
  run_once: true
  register: workflow_task_info

Inputs

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

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

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

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

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

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: awx.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
tower_version:
  description: The version of Tower we connected to
  returned: If connection to Tower works
  sample: 3.4.0
  type: str