tower_job_cancel – Cancel an Ansible Tower Job¶
New in version 2.3.
Synopsis¶
Cancel Ansible Tower jobs. See https://www.ansible.com/tower for an overview.
Requirements¶
The below requirements are needed on the host that executes this module.
ansible-tower-cli >= 3.0.2
Parameters¶
| Parameter | Choices/Defaults | Comments |
|---|---|---|
|
fail_if_not_running
boolean
|
|
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
|
Path to the Tower config file.
|
|
|
tower_host
string
|
URL to your Tower instance.
|
|
|
tower_password
string
|
Password for your Tower instance.
|
|
|
tower_username
string
|
Username for your Tower instance.
|
|
|
validate_certs
boolean
|
|
Whether to 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.
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: Cancel job
tower_job_cancel:
job_id: job.id
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description |
|---|---|---|
|
id
integer
|
success |
job id requesting to cancel
Sample:
94
|
|
status
string
|
success |
status of the cancel request
Sample:
canceled
|
Status¶
This module is not guaranteed to have a backwards compatible interface. [preview]
This module is maintained by the Ansible Community. [community]