New in version 2.3.
- python >= 2.6
- ansible-tower-cli >= 3.0.2
parameter | required | default | choices | comments |
---|---|---|---|---|
fail_if_not_running |
no | Fail loudly if the job_id does not reference a running job. | ||
job_id |
yes | ID of the job to cancel | ||
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. |
Common return values are documented here Return Values, the following are the fields unique to this module:
name | description | returned | type | sample |
---|---|---|---|---|
status | status of the cancel request | success | string | canceled |
id | job id requesting to cancel | success | int | 94 |
Note
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
This module is community maintained without core committer oversight.
For more information on what this means please read Module Support
For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Helping Testing PRs and Developing Modules.