tower_job_list - List Ansible Tower jobs.
New in version 2.3.
Synopsis
- List Ansible Tower jobs. 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 |
|---|---|---|---|---|
| all_pages | no | Fetch all the pages and return a single result. | ||
| page | no | Page number of the results to fetch. | ||
| query | no | Query used to further filter the list of jobs. {"foo":"bar"} will be passed at ?foo=bar | ||
| status | no |
| Only list jobs with this status. | |
| 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: 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"
Return Values
Common return values are documented here Return Values, the following are the fields unique to this module:
| name | description | returned | type | sample |
|---|---|---|---|---|
| count | Total count of objects return | success | int | 51 |
| next | next page available for the listing | success | int | 3 |
| previous | previous page available for the listing | success | int | 1 |
| results | a list of job objects represented as dictionaries | success | list | [{'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': ''}, '...'] |
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_list_module.html