shanemcd / shanemcd.awx / 20.0.14 / module / ad_hoc_command_cancel Cancel an Ad Hoc Command. Authors: John Westcott IV (@john-westcott-iv) preview | supported by communityshanemcd.awx.ad_hoc_command_cancel (20.0.14) — module
Install with ansible-galaxy collection install shanemcd.awx:==20.0.14
collections: - name: shanemcd.awx version: 20.0.14
Cancel ad hoc command. See U(https://www.ansible.com/tower) for an overview.
- name: Cancel command ad_hoc_command_cancel: command_id: command.id
timeout: description: - Maximum time in seconds to wait for a job to finish. - Not specifying means the task will wait until the controller cancels the command. type: int interval: default: 1 description: - The interval in seconds, to request an update from . required: false type: float command_id: description: - ID of the command to cancel required: true type: int validate_certs: aliases: - tower_verify_ssl description: - Whether to allow insecure connections to 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(CONTROLLER_VERIFY_SSL) and then config files type: bool controller_host: aliases: - tower_host description: - URL to your Automation Platform Controller instance. - If value not set, will try environment variable C(CONTROLLER_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 controller_password: aliases: - tower_password description: - Password for your controller instance. - If value not set, will try environment variable C(CONTROLLER_PASSWORD) and then config files type: str controller_username: aliases: - tower_username description: - Username for your controller instance. - If value not set, will try environment variable C(CONTROLLER_USERNAME) and then config files type: str fail_if_not_running: default: false description: - Fail loudly if the I(command_id) can not be canceled type: bool controller_oauthtoken: aliases: - tower_oauthtoken description: - 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 C(CONTROLLER_OAUTH_TOKEN) and then config files type: raw version_added: 3.7.0 version_added_collection: shanemcd.awx controller_config_file: aliases: - tower_config_file description: - Path to the controller config file. - If provided, the other locations for config files will not be considered. type: path
id: description: command id requesting to cancel returned: success sample: 94 type: int