awx.awx.ad_hoc_command_cancel – Cancel an Ad Hoc Command.

Note

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

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

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

Synopsis

Parameters

Parameter Choices/Defaults Comments
command_id
integer / required
ID of the command to cancel
controller_config_file
path
Path to the controller config file.
If provided, the other locations for config files will not be considered.

aliases: tower_config_file
controller_host
string
URL to your Automation Platform Controller instance.
If value not set, will try environment variable CONTROLLER_HOST and then config files
If value not specified by any means, the value of 127.0.0.1 will be used

aliases: tower_host
controller_oauthtoken
raw
added in 3.7.0 of awx.awx
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 CONTROLLER_OAUTH_TOKEN and then config files

aliases: tower_oauthtoken
controller_password
string
Password for your controller instance.
If value not set, will try environment variable CONTROLLER_PASSWORD and then config files

aliases: tower_password
controller_username
string
Username for your controller instance.
If value not set, will try environment variable CONTROLLER_USERNAME and then config files

aliases: tower_username
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 .
timeout
integer
Maximum time in seconds to wait for a job to finish.
Not specifying means the task will wait until the controller cancels the command.
validate_certs
boolean
    Choices:
  • no
  • yes
Whether to allow insecure connections to 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 CONTROLLER_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 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 Returned Description
id
integer
success
command id requesting to cancel

Sample:
94


Authors

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