awx.awx.job_launch – Launch an Ansible Job.

Note

This plugin is part of the awx.awx collection (version 19.4.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.job_launch.

Synopsis

Parameters

Parameter

Comments

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

credential_passwords

dictionary

Passwords for credentials which are set to prompt on launch

credentials

aliases: credential

list / elements=string

Credential to use for job, only used if prompt for credential is set.

diff_mode

boolean

Show the changes made by Ansible tasks where supported

Choices:

  • no

  • yes

extra_vars

dictionary

extra_vars to use for the Job Template.

ask_extra_vars needs to be set to True via job_template module when creating the Job Template.

interval

float

The interval to request an update from the controller.

Default: 1

inventory

string

Inventory to use for the job, only used if prompt for inventory is set.

job_type

string

Job_type to use for the job, only used if prompt for job_type is set.

Choices:

  • run

  • check

limit

string

Limit to use for the job_template.

name

aliases: job_template

string / required

Name of the job template to use.

organization

string

Organization the job template exists in.

Used to help lookup the object, cannot be modified using this module.

If not provided, will lookup by name only, which does not work with duplicates.

scm_branch

string

A specific of the SCM project to run the template on.

This is only applicable if your project allows for branch override.

skip_tags

list / elements=string

Specific tags to skip from the playbook.

tags

list / elements=string

Specific tags to use for from playbook.

timeout

integer

If waiting for the job to complete this will abort after this amount of seconds

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

verbosity

integer

Verbosity level for this job run

Choices:

  • 0

  • 1

  • 2

  • 3

  • 4

  • 5

wait

boolean

Wait for the job to complete.

Choices:

  • no ← (default)

  • 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 a job
  job_launch:
    job_template: "My Job Template"
  register: job

- name: Launch a job template with extra_vars on remote controller instance
  job_launch:
    job_template: "My Job Template"
    extra_vars:
      var1: "My First Variable"
      var2: "My Second Variable"
      var3: "My Third Variable"
    job_type: run

- name: Launch a job with inventory and credential
  job_launch:
    job_template: "My Job Template"
    inventory: "My Inventory"
    credential: "My Credential"
  register: job
- name: Wait for job max 120s
  job_wait:
    job_id: "{{ job.id }}"
    timeout: 120

Return Values

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

Key

Description

id

integer

job id of the newly launched job

Returned: success

Sample: 86

status

string

status of newly launched job

Returned: success

Sample: “pending”

Authors

  • Wayne Witzel III (@wwitzel3)