tower_job_wait - Wait for Ansible Tower job to finish.
New in version 2.3.
Synopsis
- Wait for Ansible Tower job to finish and report success or failure. See https://www.ansible.com/tower for an overview.
Requirements (on host that executes module)
- python >= 2.6
- ansible-tower-cli >= 3.0.2
Options
| parameter | required | default | choices | comments |
|---|---|---|---|---|
| job_id | yes | ID of the job to monitor. | ||
| max_interval | no | 30 | Maximum interval in seconds, to request an update from Tower. | |
| min_interval | no | 1 | Minimum interval in seconds, to request an update from Tower. | |
| timeout | no | Maximum time in seconds to wait for a job to finish. | ||
| tower_config_file | no | Path to the Tower config file. See notes. | ||
| tower_host | no | URL to your Tower instance. | ||
| tower_password | no | Password for your Tower instance. | ||
| tower_username | no | Username for your Tower instance. | ||
| tower_verify_ssl | no | True | Dis/allow insecure connections to Tower. If no, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. |
Examples
- 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
Return Values
Common return values are documented here Return Values, the following are the fields unique to this module:
| name | description | returned | type | sample |
|---|---|---|---|---|
| elapsed | total time in seconds the job took to run | success | float | 10.879 |
| finished | timestamp of when the job finished running | success | string | 2017-03-01T17:04:04.078782Z |
| id | job id that is being waited on | success | int | 99 |
| started | timestamp of when the job started running | success | string | 2017-03-01T17:03:53.200234Z |
| status | current status of job | success | string | successful |
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
Status
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/tower_job_wait_module.html