W3cubDocs

/Ansible 2.11

awx.awx.tower_ad_hoc_command_cancel – Cancel an Ansible Tower Ad Hoc Command.

Note

This plugin is part of the awx.awx collection (version 17.0.1).

To install it use: ansible-galaxy collection install awx.awx.

To use it in a playbook, specify: awx.awx.tower_ad_hoc_command_cancel.

Synopsis

Parameters

Parameter Choices/Defaults Comments
command_id
integer / required
ID of the command to cancel
fail_if_not_running
boolean
    Choices:
  • no ←
  • yes
Fail loudly if the command_id can not be canceled
interval
float
Default:
1
The interval in seconds, to request an update from Tower.
timeout
integer
Maximum time in seconds to wait for a job to finish.
Not specifying means the task will wait until Tower cancels the command.
tower_config_file
path
Path to the Tower or AWX config file.
If provided, the other locations for config files will not be considered.
tower_host
string
URL to your Tower or AWX instance.
If value not set, will try environment variable TOWER_HOST and then config files
If value not specified by any means, the value of 127.0.0.1 will be used
tower_oauthtoken
raw
added in 3.7 of awx.awx
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 TOWER_OAUTH_TOKEN and then config files
tower_password
string
Password for your Tower or AWX instance.
If value not set, will try environment variable TOWER_PASSWORD and then config files
tower_username
string
Username for your Tower or AWX instance.
If value not set, will try environment variable TOWER_USERNAME and then config files
validate_certs
boolean
    Choices:
  • no
  • yes
Whether to allow insecure connections to Tower or AWX.
If 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 TOWER_VERIFY_SSL and then config files

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 command
  tower_ad_hoc_command_cancel:
    command_id: command.id

Return Values

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

Key Returned Description
id
integer
success
command id requesting to cancel

Sample:
94


Authors

  • John Westcott IV (@john-westcott-iv)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/awx/awx/tower_ad_hoc_command_cancel_module.html