awx.awx.tower_workflow_launch – Run a workflow in Ansible Tower¶
Note
This plugin is part of the awx.awx collection (version 17.1.0).
To install it use: ansible-galaxy collection install awx.awx
.
To use it in a playbook, specify: awx.awx.tower_workflow_launch
.
Synopsis¶
Launch an Ansible Tower workflows. See https://www.ansible.com/tower for an overview.
Parameters¶
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 with a timeout of 10 seconds
tower_workflow_launch:
workflow_template: "Test Workflow"
timeout: 10
- name: Launch a Workflow with extra_vars without waiting
tower_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)