awx.awx.tower_ad_hoc_command – create, update, or destroy Ansible Tower ad hoc commands.

From Get docs
Ansible/docs/2.11/collections/awx/awx/tower ad hoc command module


awx.awx.tower_ad_hoc_command – create, update, or destroy Ansible Tower ad hoc commands.

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.


New in version 4.0: of awx.awx


Synopsis

Parameters

Parameter Choices/Defaults Comments

become_enabled

boolean

  • no
  • yes

If the become flag should be set.

credential

string / required

Credential to use for ad hoc command.

diff_mode

boolean

  • no
  • yes

Show the changes made by Ansible tasks where supported

extra_vars

dictionary

Extra variables to use for the ad hoc command..

forks

integer

The number of forks to use for this ad hoc execution.

interval

float

Default:

1

The interval to request an update from Tower.

inventory

string / required

Inventory to use for the ad hoc command.

job_type

string

  • run
  • check

Job_type to use for the ad hoc command.

limit

string

Limit to use for the ad hoc command.

module_args

string

Default:

""

The arguments to pass to the module.

module_name

string / required

The Ansible module to execute.

timeout

integer

If waiting for the command to complete this will abort after this amount of seconds

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

  • 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

verbosity

integer

  • 0
  • 1
  • 2
  • 3
  • 4
  • 5

Verbosity level for this ad hoc command run

wait

boolean

  • no

  • yes

Wait for the command to complete.



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

Return Values

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

Key Returned Description

id

integer

success

id of the newly launched command


Sample:

86

status

string

success

status of newly launched command


Sample:

pending




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_module.html