awx.awx.ad_hoc_command – create, update, or destroy Automation Platform Controller ad hoc commands.

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.

New in version 4.0.0: of awx.awx

Synopsis

Parameters

Parameter Choices/Defaults Comments
become_enabled
boolean
    Choices:
  • no
  • yes
If the become flag should be set.
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
credential
string / required
Credential to use for ad hoc command.
diff_mode
boolean
    Choices:
  • no
  • yes
Show the changes made by Ansible tasks where supported
execution_environment
string
Execution Environment to use for the ad hoc command.
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 the controller.
inventory
string / required
Inventory to use for the ad hoc command.
job_type
string
    Choices:
  • 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
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
verbosity
integer
    Choices:
  • 0
  • 1
  • 2
  • 3
  • 4
  • 5
Verbosity level for this ad hoc command run
wait
boolean
    Choices:
  • 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 host information.

  • config_file should be in the following format host=hostname username=username password=password

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)