awx.awx.ad_hoc_command_cancel module – Cancel an Ad Hoc Command.
Note
This module is part of the awx.awx collection (version 24.6.1).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install awx.awx
.
To use it in a playbook, specify: awx.awx.ad_hoc_command_cancel
.
Synopsis
Cancel ad hoc command. See https://www.ansible.com/tower for an overview.
Aliases: tower_ad_hoc_command_cancel
Parameters
Parameter |
Comments |
---|---|
ID of the command to cancel |
|
Path to the controller config file. If provided, the other locations for config files will not be considered. |
|
URL to your Automation Platform Controller instance. If value not set, will try environment variable If value not specified by any means, the value of |
|
The 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 token module. If value not set, will try environment variable |
|
Password for your controller instance. If value not set, will try environment variable |
|
Username for your controller instance. If value not set, will try environment variable |
|
Fail loudly if the command_id can not be canceled Choices:
|
|
The interval in seconds, to request an update from . Default: |
|
Specify the timeout Ansible should use in requests to the controller host. Defaults to 10s, but this is handled by the shared module_utils code |
|
Maximum time in seconds to wait for a job to finish. Not specifying means the task will wait until the controller cancels the command. Default: |
|
Whether to allow insecure connections to AWX. If This should only be used on personally controlled sites using self-signed certificates. If value not set, will try environment variable Choices:
|
Notes
Note
If no config_file is provided we will attempt to use the tower-cli library defaults to find your host information.
config_file should be in the following format host=hostname username=username password=password
Examples
- name: Cancel command
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 |
Description |
---|---|
command id requesting to cancel Returned: success Sample: |