tower_workflow_launch – Run a workflow in Ansible Tower
tower_workflow_launch – Run a workflow in Ansible Tower
New in version 2.8.
Synopsis
- Launch an Ansible Tower workflows. See https://www.ansible.com/tower for an overview.
Requirements
The below requirements are needed on the host that executes this module.
- ansible-tower-cli >= 3.0.2
- python >= 2.6
Parameters
Parameter | Choices/Defaults | Comments |
---|---|---|
extra_vars - |
Any extra vars required to launch the job. | |
timeout - |
If waiting for the workflow to complete this will abort after this amount of seconds | |
tower_config_file path |
Path to the Tower config file. | |
tower_host string |
URL to your Tower instance. | |
tower_password string |
Password for your Tower instance. | |
tower_username string |
Username for your Tower instance. | |
validate_certs boolean |
|
Whether to allow insecure connections to Tower. If This should only be used on personally controlled sites using self-signed certificates.
|
wait boolean |
|
Wait for the workflow to complete. |
workflow_template - / required |
The name of the workflow template to run. |
Notes
Note
- If no config_file is provided we will attempt to use the tower-cli library defaults to find your Tower host information.
- config_file should contain Tower configuration in the following format host=hostname username=username password=password
Examples
- name: Launch a workflow
tower_workflow_launch:
name: "Test Workflow"
delegate_to: localhost
run_once: true
register: workflow_results
- 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
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
|
tower_version string |
If connection to Tower works |
The version of Tower we connected to
Sample: 3.4.0 |
Status
- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Community. [community]
Authors
- John Westcott IV (@john-westcott-iv)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.8/modules/tower_workflow_launch_module.html