alancoding.awx.tower_job_launch (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

Launch an Ansible Tower jobs. 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: Launch a job template with extra_vars on remote Tower instance
  tower_job_launch:
    job_template: "My Job Template"
    extra_vars:
      var1: "My First Variable"
      var2: "My Second Variable"
      var3: "My Third Variable"
    job_type: run

Scanned by Steampunk Spotter

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

- name: Launch a job with inventory and credential
  tower_job_launch:
    job_template: "My Job Template"
    inventory: "My Inventory"
    credential: "My Credential"
  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

    
name:
    aliases:
    - job_template
    description:
    - Name of the job template to use.
    required: true
    type: str

tags:
    description:
    - Specific tags to use for from playbook.
    elements: str
    type: list

limit:
    description:
    - Limit to use for the I(job_template).
    type: str

job_type:
    choices:
    - run
    - check
    description:
    - Job_type to use for the job, only used if prompt for job_type is set.
    type: str

diff_mode:
    description:
    - Show the changes made by Ansible tasks where supported
    type: bool
    version_added: '3.7'
    version_added_collection: alancoding.awx

inventory:
    description:
    - Inventory to use for the job, only used if prompt for inventory is set.
    type: str

skip_tags:
    description:
    - Specific tags to skip from the playbook.
    elements: str
    type: list
    version_added: '3.7'
    version_added_collection: alancoding.awx

verbosity:
    choices:
    - 0
    - 1
    - 2
    - 3
    - 4
    - 5
    description:
    - Verbosity level for this job run
    type: int
    version_added: '3.7'
    version_added_collection: alancoding.awx

extra_vars:
    description:
    - extra_vars to use for the Job Template.
    - ask_extra_vars needs to be set to True via tower_job_template module when creating
      the Job Template.
    type: dict

scm_branch:
    description:
    - A specific of the SCM project to run the template on.
    - This is only applicable if your project allows for branch override.
    type: str
    version_added: '3.7'
    version_added_collection: alancoding.awx

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

credentials:
    aliases:
    - credential
    description:
    - Credential to use for job, only used if prompt for credential is set.
    elements: str
    type: list

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
    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

credential_passwords:
    description:
    - Passwords for credentials which are set to prompt on launch
    type: dict
    version_added: '3.7'
    version_added_collection: alancoding.awx

Outputs

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