ansible / ansible.builtin / v2.8.13 / module / tower_job_cancel Cancel an Ansible Tower Job. | "added in version" 2.3 of ansible.builtin" Authors: Wayne Witzel III (@wwitzel3) preview | supported by communityansible.builtin.tower_job_cancel (v2.8.13) — module
pip
Install with pip install ansible==2.8.13
Cancel Ansible Tower jobs. See U(https://www.ansible.com/tower) for an overview.
- name: Cancel job tower_job_cancel: job_id: job.id
job_id: description: - ID of the job to cancel required: true tower_host: description: - URL to your Tower or AWX instance. - If value not set, will try environment variable C(TOWER_HOST) and then config files - If value not specified by any means, the value of C(127.0.0.1) will be used type: str tower_password: description: - Password for your Tower or AWX instance. - If value not set, will try environment variable C(TOWER_PASSWORD) and then config files type: str tower_username: description: - Username for your Tower or AWX instance. - If value not set, will try environment variable C(TOWER_USERNAME) and then config files type: str validate_certs: aliases: - tower_verify_ssl description: - Whether to allow insecure connections to Tower or AWX. - If C(no), SSL certificates will not be validated. - This should only be used on personally controlled sites using self-signed certificates. - If value not set, will try environment variable C(TOWER_VERIFY_SSL) and then config files type: bool tower_oauthtoken: description: - The Tower OAuth token to use. - This value can be in one of two formats. - A string which is the token itself. (i.e. bqV5txm97wqJqtkxlMkhQz0pKhRMMX) - A dictionary structure as returned by the tower_token module. - If value not set, will try environment variable C(TOWER_OAUTH_TOKEN) and then config files type: raw version_added: '3.7' version_added_collection: awx.awx tower_config_file: description: - Path to the Tower or AWX config file. - If provided, the other locations for config files will not be considered. type: path fail_if_not_running: default: false description: - Fail loudly if the I(job_id) does not reference a running job. type: bool
id: description: job id requesting to cancel returned: success sample: 94 type: int status: description: status of the cancel request returned: success sample: canceled type: str