New in version 2.3.
The below requirements are needed on the host that executes this module.
Parameter | Choices/Defaults | Comments |
---|---|---|
fail_if_not_running | Default: no | Fail loudly if the job_id does not reference a running job. |
job_id required | ID of the job to cancel | |
tower_config_file | Path to the Tower config file. See notes. | |
tower_host | URL to your Tower instance. | |
tower_password | Password for your Tower instance. | |
tower_username | Username for your Tower instance. | |
tower_verify_ssl bool |
| 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: Cancel job tower_job_cancel: job_id: job.id
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
id int | success | job id requesting to cancel Sample: 94 |
status string | success | status of the cancel request Sample: canceled |
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
This module is flagged as community which means that it is maintained by the Ansible Community. See Module Maintenance & Support for more info.
For a list of other modules that are also maintained by the Ansible Community, see here.
Hint
If you notice any issues in this documentation you can edit this document to improve it.
© 2012–2018 Michael DeHaan
© 2018 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/tower_job_cancel_module.html