awx.awx.tower_job_list – List Ansible Tower jobs.
Note
This plugin is part of the awx.awx collection (version 14.1.0).
To install it use: ansible-galaxy collection install awx.awx.
To use it in a playbook, specify: awx.awx.tower_job_list.
Synopsis
- List Ansible Tower jobs. See https://www.ansible.com/tower for an overview.
Parameters
| Parameter | Choices/Defaults | Comments |
|---|---|---|
| all_pages
boolean
|
|
Fetch all the pages and return a single result.
|
| page
integer
|
Page number of the results to fetch.
|
|
| query
dictionary
|
Query used to further filter the list of jobs. {"foo":"bar"} will be passed at ?foo=bar
|
|
| status
string
|
|
Only list jobs with this status.
|
| 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
|
|
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: List running jobs for the testing.yml playbook
tower_job_list:
status: running
query: {"playbook": "testing.yml"}
tower_config_file: "~/tower_cli.cfg"
register: testing_jobs
Return Values
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description |
|---|---|---|
| count
integer
|
success |
Total count of objects return
Sample:
51
|
| next
integer
|
success |
next page available for the listing
Sample:
3
|
| previous
integer
|
success |
previous page available for the listing
Sample:
1
|
| results
list / elements=string
|
success |
a list of job objects represented as dictionaries
Sample:
[{'allow_simultaneous': False, 'artifacts': {}, 'ask_credential_on_launch': False, 'ask_inventory_on_launch': False, 'ask_job_type_on_launch': False, 'failed': False, 'finished': '2017-02-22T15:09:05.633942Z', 'force_handlers': False, 'forks': 0, 'id': 2, 'inventory': 1, 'job_explanation': '', 'job_tags': '', 'job_template': 5, 'job_type': 'run'}, '...']
|
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.10/collections/awx/awx/tower_job_list_module.html