tower_job_cancel - Cancel an Ansible Tower Job.¶

New in version 2.3.

Synopsis ¶

python >= 2.6

ansible-tower-cli >= 3.0.2

parameter	required	default	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.

- name: Cancel job
  tower_job_cancel:
    job_id: job.id

Common return values are documented here Return Values, the following are the fields unique to this module:

name	description	returned	type	sample
id	job id requesting to cancel	success	int	94
status	status of the cancel request	success	string	canceled

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

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.