shanemcd.awx.job_wait (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

Wait for Automation Platform Controller job to finish and report success or failure. See U(https://www.ansible.com/tower) for an overview.

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Launch a job
  job_launch:
    job_template: "My Job Template"
  register: job

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Wait for job max 120s
  job_wait:
    job_id: "{{ job.id }}"
    timeout: 120

Inputs

    
job_id:
    description:
    - ID of the job to monitor.
    required: true
    type: int

timeout:
    description:
    - Maximum time in seconds to wait for a job to finish.
    type: int

interval:
    default: 1
    description:
    - The interval in sections, to request an update from the controller.
    - For backwards compatibility if unset this will be set to the average of min and
      max intervals
    required: false
    type: float

job_type:
    choices:
    - project_updates
    - jobs
    - inventory_updates
    - workflow_jobs
    default: jobs
    description:
    - Job type to wait for
    type: str

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

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

elapsed:
  description: total time in seconds the job took to run
  returned: success
  sample: 10.879
  type: float
finished:
  description: timestamp of when the job finished running
  returned: success
  sample: '2017-03-01T17:04:04.078782Z'
  type: str
id:
  description: job id that is being waited on
  returned: success
  sample: 99
  type: int
started:
  description: timestamp of when the job started running
  returned: success
  sample: '2017-03-01T17:03:53.200234Z'
  type: str
status:
  description: current status of job
  returned: success
  sample: successful
  type: str