New in version 2.3.
The below requirements are needed on the host that executes this module.
Parameter |
Choices/Defaults |
Comments |
---|---|---|
all_pages
|
Default:
no
|
Fetch all the pages and return a single result.
|
page
|
Default:
None
|
Page number of the results to fetch.
|
query
|
Default:
None
|
Query used to further filter the list of jobs. {"foo":"bar"} will be passed at ?foo=bar
|
status
|
None
|
Only list jobs with this status.
|
tower_config_file
|
Default:
None
|
Path to the Tower config file. See notes.
|
tower_host
|
Default:
None
|
URL to your Tower instance.
|
tower_password
|
Default:
None
|
Password for your Tower instance.
|
tower_username
|
Default:
None
|
Username for your Tower instance.
|
tower_verify_ssl
|
Default:
yes
|
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. |
Note
- name: List running jobs for the testing.yml playbook
tower_job_list:
status: running
query: {"playbook": "testing.yml"}
register: testing_jobs
tower_config_file: "~/tower_cli.cfg"
Common return values are documented here, the following are the fields unique to this module:
Key |
Returned |
Description |
---|---|---|
count
int
|
success |
Total count of objects return
Sample:
51
|
next
int
|
success |
next page available for the listing
Sample:
3
|
previous
int
|
success |
previous page available for the listing
Sample:
1
|
results
list
|
success |
a list of job objects represented as dictionaries
Sample:
[{'force_handlers': False, 'job_template': 5, 'ask_credential_on_launch': False, 'artifacts': {}, 'ask_job_type_on_launch': False, 'job_tags': '', 'job_type': 'run', 'allow_simultaneous': False, 'failed': False, 'finished': '2017-02-22T15:09:05.633942Z', 'ask_inventory_on_launch': False, 'inventory': 1, 'id': 2, 'forks': 0, 'job_explanation': ''}, '...']
|
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
Hint
If you notice any issues in this documentation you can edit this document to improve it.