shanemcd.awx.ad_hoc_command (20.0.14) — module

Install collection

Install with ansible-galaxy collection install shanemcd.awx:==20.0.14

Add to requirements.yml

  collections:
    - name: shanemcd.awx
      version: 20.0.14

Description

Create, update, or destroy Automation Platform Controller ad hoc commands. See U(https://www.ansible.com/tower) for an overview.

Inputs

    
wait:
    default: false
    description:
    - Wait for the command to complete.
    type: bool

forks:
    description:
    - The number of forks to use for this ad hoc execution.
    type: int

limit:
    description:
    - Limit to use for the ad hoc command.
    type: str

timeout:
    description:
    - If waiting for the command to complete this will abort after this amount of seconds
    type: int

interval:
    default: 1
    description:
    - The interval to request an update from the controller.
    type: float

job_type:
    choices:
    - run
    - check
    description:
    - Job_type to use for the ad hoc command.
    type: str

diff_mode:
    description:
    - Show the changes made by Ansible tasks where supported
    type: bool

inventory:
    description:
    - Inventory to use for the ad hoc command.
    required: true
    type: str

verbosity:
    choices:
    - 0
    - 1
    - 2
    - 3
    - 4
    - 5
    description:
    - Verbosity level for this ad hoc command run
    type: int

credential:
    description:
    - Credential to use for ad hoc command.
    required: true
    type: str

extra_vars:
    description:
    - Extra variables to use for the ad hoc command..
    type: dict

module_args:
    default: ''
    description:
    - The arguments to pass to the module.
    type: str

module_name:
    description:
    - The Ansible module to execute.
    required: true
    type: str

become_enabled:
    description:
    - If the become flag should be set.
    type: bool

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

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

execution_environment:
    description:
    - Execution Environment to use for the ad hoc command.
    required: false
    type: str

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

Outputs

id:
  description: id of the newly launched command
  returned: success
  sample: 86
  type: int
status:
  description: status of newly launched command
  returned: success
  sample: pending
  type: str