alancoding.awx.tower_job_wait (11.2.0) — module

Install collection

Install with ansible-galaxy collection install alancoding.awx:==11.2.0

Add to requirements.yml

  collections:
    - name: alancoding.awx
      version: 11.2.0

Description

Wait for Ansible Tower 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
  tower_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
  tower_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 Tower.
    - For backwards compatability if unset this will be set to the average of min and
      max intervals
    required: false
    type: float

tower_host:
    description:
    - URL to your Tower or AWX instance.
    - If value not set, will try environment variable C(TOWER_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

max_interval:
    description:
    - Maximum interval in seconds, to request an update from Tower.
    - deprecated, use interval instead
    type: float

min_interval:
    description:
    - Minimum interval in seconds, to request an update from Tower.
    - deprecated, use interval instead
    type: float

tower_password:
    description:
    - Password for your Tower or AWX instance.
    - If value not set, will try environment variable C(TOWER_PASSWORD) and then config
      files
    type: str

tower_username:
    description:
    - Username for your Tower or AWX instance.
    - If value not set, will try environment variable C(TOWER_USERNAME) and then config
      files
    type: str

validate_certs:
    aliases:
    - tower_verify_ssl
    description:
    - Whether to allow insecure connections to Tower or 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(TOWER_VERIFY_SSL) and then config
      files
    type: bool

tower_oauthtoken:
    description:
    - The Tower OAuth token to use.
    - If value not set, will try environment variable C(TOWER_OAUTH_TOKEN) and then config
      files
    required: false
    type: str
    version_added: '3.7'
    version_added_collection: alancoding.awx

tower_config_file:
    description:
    - Path to the Tower or AWX config file.
    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