awx.awx.tower_job_wait – Wait for Ansible Tower job to finish.

Note

This plugin is part of the awx.awx collection (version 17.0.1).

To install it use: ansible-galaxy collection install awx.awx.

To use it in a playbook, specify: awx.awx.tower_job_wait.

Synopsis
Parameters
Notes
Examples
Return Values

Synopsis

Wait for Ansible Tower job to finish and report success or failure. See https://www.ansible.com/tower for an overview.

Parameters

Parameter	Choices/Defaults	Comments
interval float	Default: 1	The interval in sections, to request an update from Tower. For backwards compatibility if unset this will be set to the average of min and max intervals
job_id integer / required		ID of the job to monitor.
job_type string	Choices: project_updates jobs ← inventory_updates workflow_jobs	Job type to wait for
max_interval float		Maximum interval in seconds, to request an update from Tower. deprecated, use interval instead
min_interval float		Minimum interval in seconds, to request an update from Tower. deprecated, use interval instead
timeout integer		Maximum time in seconds to wait for a job to finish.
tower_config_file path		Path to the Tower or AWX config file. If provided, the other locations for config files will not be considered.
tower_host string		URL to your Tower or AWX instance. If value not set, will try environment variable `TOWER_HOST` and then config files If value not specified by any means, the value of `127.0.0.1` will be used
tower_oauthtoken raw added in 3.7 of awx.awx		The Tower 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 tower_token module. If value not set, will try environment variable `TOWER_OAUTH_TOKEN` and then config files
tower_password string		Password for your Tower or AWX instance. If value not set, will try environment variable `TOWER_PASSWORD` and then config files
tower_username string		Username for your Tower or AWX instance. If value not set, will try environment variable `TOWER_USERNAME` and then config files
validate_certs boolean	Choices: no yes	Whether to allow insecure connections to Tower or AWX. If `no`, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. If value not set, will try environment variable `TOWER_VERIFY_SSL` and then config files aliases: tower_verify_ssl

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 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, the following are the fields unique to this module:

Key	Returned	Description
elapsed float	success	total time in seconds the job took to run Sample: 10.879
finished string	success	timestamp of when the job finished running Sample: 2017-03-01T17:04:04.078782Z
id integer	success	job id that is being waited on Sample: 99
started string	success	timestamp of when the job started running Sample: 2017-03-01T17:03:53.200234Z
status string	success	current status of job Sample: successful

Authors

Wayne Witzel III (@wwitzel3)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/awx/awx/tower_job_wait_module.html