awx.awx.ad_hoc_command_wait module – Wait for Automation Platform Controller Ad Hoc Command to finish.

Note

This module is part of the awx.awx collection (version 21.0.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

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

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

Synopsis

  • Wait for Automation Platform Controller ad hoc command to finish and report success or failure. See https://www.ansible.com/tower for an overview.

Parameters

Parameter

Comments

command_id

integer / required

ID of the ad hoc command to monitor.

controller_config_file

aliases: tower_config_file

path

Path to the controller config file.

If provided, the other locations for config files will not be considered.

controller_host

aliases: tower_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

controller_oauthtoken

aliases: tower_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

controller_password

aliases: tower_password

string

Password for your controller instance.

If value not set, will try environment variable CONTROLLER_PASSWORD and then config files

controller_username

aliases: tower_username

string

Username for your controller instance.

If value not set, will try environment variable CONTROLLER_USERNAME and then config files

interval

float

The interval in sections, to request an update from the controller.

Default: 1

timeout

integer

Maximum time in seconds to wait for a ad hoc command to finish.

validate_certs

aliases: tower_verify_ssl

boolean

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

Choices:

  • no

  • yes

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: Launch an ad hoc command
  ad_hoc_command:
    inventory: "Demo Inventory"
    credential: "Demo Credential"
    wait: false
  register: command

- name: Wait for ad joc command max 120s
  ad_hoc_command_wait:
    command_id: "{{ command.id }}"
    timeout: 120

Return Values

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

Key

Description

elapsed

float

total time in seconds the command took to run

Returned: success

Sample: 10.879

finished

string

timestamp of when the command finished running

Returned: success

Sample: “2017-03-01T17:04:04.078782Z”

id

integer

Ad hoc command id that is being waited on

Returned: success

Sample: 99

started

string

timestamp of when the command started running

Returned: success

Sample: “2017-03-01T17:03:53.200234Z”

status

string

current status of command

Returned: success

Sample: “successful”

Authors

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