awx.awx.workflow_launch – Run a workflow in Automation Platform Controller

Note

This plugin is part of the awx.awx collection (version 19.4.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install awx.awx.

To use it in a playbook, specify: awx.awx.workflow_launch.

Synopsis

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

Parameters

Parameter	Choices/Defaults	Comments
controller_config_file path		Path to the controller config file. If provided, the other locations for config files will not be considered. aliases: tower_config_file
controller_host string		URL to your Automation Platform Controller instance. If value not set, will try environment variable `CONTROLLER_HOST` and then config files If value not specified by any means, the value of `127.0.0.1` will be used aliases: tower_host
controller_oauthtoken raw added in 3.7.0 of awx.awx		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 `CONTROLLER_OAUTH_TOKEN` and then config files aliases: tower_oauthtoken
controller_password string		Password for your controller instance. If value not set, will try environment variable `CONTROLLER_PASSWORD` and then config files aliases: tower_password
controller_username string		Username for your controller instance. If value not set, will try environment variable `CONTROLLER_USERNAME` and then config files aliases: tower_username
extra_vars dictionary		Any extra vars required to launch the job.
interval float	Default: 1	The interval to request an update from the controller.
inventory string		Inventory to use for the job ran with this workflow, only used if prompt for inventory is set.
limit string		Limit to use for the job_template.
name string / required		The name of the workflow template to run. aliases: workflow_template
organization string		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.
scm_branch string		A specific branch of the SCM project to run the template on. This is only applicable if your project allows for branch override.
timeout integer		If waiting for the workflow to complete this will abort after this amount of seconds
validate_certs boolean	Choices: no yes	Whether to allow insecure connections to AWX. If `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 `CONTROLLER_VERIFY_SSL` and then config files aliases: tower_verify_ssl
wait boolean	Choices: no yes ←	Wait for the workflow to complete.

Notes

Note

If no config_file is provided we will attempt to use the tower-cli library defaults to find your host information.
config_file should be in the following format host=hostname username=username password=password

Examples

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

- 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

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Returned	Description
job_info dictionary	If workflow launched	dictionary containing information about the workflow executed

Authors

John Westcott IV (@john-westcott-iv)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/awx/awx/workflow_launch_module.html

Docs

Docs4dev

Title here