tower_job_launch – Launch an Ansible Job
tower_job_launch – Launch an Ansible Job
New in version 2.3.
Synopsis
- Launch an Ansible Tower jobs. 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
Parameters
Parameter | Choices/Defaults | Comments |
---|---|---|
credential - |
Credential to use for job, only used if prompt for credential is set. | |
extra_vars - |
Extra_vars to use for the job_template. Prepend | |
inventory - |
Inventory to use for the job, only used if prompt for inventory is set. | |
job_explanation - |
Job explanation field. | |
job_template - / required |
Name of the job template to use. | |
job_type - |
|
Job_type to use for the job, only used if prompt for job_type is set. |
limit - |
Limit to use for the job_template. | |
tags - |
Specific tags to use for from playbook. | |
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. | |
use_job_endpoint boolean |
|
Disable launching jobs from job template. |
validate_certs boolean |
|
Whether to allow insecure connections to Tower. If This should only be used on personally controlled sites using self-signed certificates.
|
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
# Launch a job template
- name: Launch a job
tower_job_launch:
job_template: "My Job Template"
register: job
- name: Wait for job max 120s
tower_job_wait:
job_id: "{{ job.id }}"
timeout: 120
# Launch job template with inventory and credential for prompt on launch
- name: Launch a job with inventory and credential
tower_job_launch:
job_template: "My Job Template"
inventory: "My Inventory"
credential: "My Credential"
register: job
- name: Wait for job max 120s
tower_job_wait:
job_id: "{{ job.id }}"
timeout: 120
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
id integer |
success |
job id of the newly launched job
Sample: 86 |
status string |
success |
status of newly launched job
Sample: pending |
Status
- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Community. [community]
Authors
- Wayne Witzel III (@wwitzel3)
© 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_job_launch_module.html