awx.awx.job_wait module – Wait for Automation Platform Controller job to finish.
Note
This module is part of the awx.awx collection (version 24.6.1).
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.job_wait
.
Synopsis
Wait for Automation Platform Controller job to finish and report success or failure. See https://www.ansible.com/tower for an overview.
Aliases: tower_job_wait
Parameters
Parameter |
Comments |
---|---|
Path to the controller config file. If provided, the other locations for config files will not be considered. |
|
URL to your Automation Platform Controller instance. If value not set, will try environment variable If value not specified by any means, the value of |
|
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 |
|
Password for your controller instance. If value not set, will try environment variable |
|
Username for your controller instance. If value not set, will try environment variable |
|
The interval in sections, to request an update from the controller. For backwards compatibility if unset this will be set to the average of min and max intervals Default: |
|
ID of the job to monitor. |
|
Job type to wait for Choices:
|
|
Specify the timeout Ansible should use in requests to the controller host. Defaults to 10s, but this is handled by the shared module_utils code |
|
Maximum time in seconds to wait for a job to finish. |
|
Whether to allow insecure connections to AWX. If This should only be used on personally controlled sites using self-signed certificates. If value not set, will try environment variable Choices:
|
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 job
job_launch:
job_template: "My Job Template"
register: job
- name: Wait for job max 120s
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 |
Description |
---|---|
total time in seconds the job took to run Returned: success Sample: |
|
timestamp of when the job finished running Returned: success Sample: |
|
job id that is being waited on Returned: success Sample: |
|
timestamp of when the job started running Returned: success Sample: |
|
current status of job Returned: success Sample: |