awx.awx.tower_job_launch – Launch an Ansible Job.

Note

This plugin is part of the awx.awx collection (version 14.1.0).

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

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

Synopsis
Parameters
Notes
Examples
Return Values

Synopsis

Launch an Ansible Tower jobs. See https://www.ansible.com/tower for an overview.

Parameters

Parameter	Choices/Defaults	Comments
credential_passwords dictionary		Passwords for credentials which are set to prompt on launch
credentials list / elements=string		Credential to use for job, only used if prompt for credential is set. aliases: credential
diff_mode boolean	no yes	Show the changes made by Ansible tasks where supported
extra_vars dictionary		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.
inventory string		Inventory to use for the job, only used if prompt for inventory is set.
job_type string	run check	Job_type to use for the job, only used if prompt for job_type is set.
limit string		Limit to use for the job_template.
name string / required		Name of the job template to use. aliases: job_template
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.
tower_config_file path		Path to the Tower or AWX config file. If provided, the other locations for config files will not be considered.
tower_host string		URL to your Tower or AWX instance. If value not set, will try environment variable `TOWER_HOST` and then config files If value not specified by any means, the value of `127.0.0.1` will be used
tower_oauthtoken raw added in 3.7 of awx.awx		The Tower 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 tower_token module. If value not set, will try environment variable `TOWER_OAUTH_TOKEN` and then config files
tower_password string		Password for your Tower or AWX instance. If value not set, will try environment variable `TOWER_PASSWORD` and then config files
tower_username string		Username for your Tower or AWX instance. If value not set, will try environment variable `TOWER_USERNAME` and then config files
validate_certs boolean	no yes	Whether to allow insecure connections to Tower or 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 `TOWER_VERIFY_SSL` and then config files aliases: tower_verify_ssl
verbosity integer	0 1 2 3 4 5	Verbosity level for this job run

Notes

Note

If no config_file is provided we will attempt to use the tower-cli library defaults to find your Tower host information.
config_file should contain Tower configuration in the following format host=hostname username=username password=password

Examples

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

- 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

- name: Launch a job with inventory and credential
  tower_job_launch:
    job_template: "My Job Template"
    inventory: "My Inventory"
    credential: "My Credential"
  register: job
- name: Wait for job max 120s
  tower_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	Returned	Description
id integer	success	job id of the newly launched job Sample: 86
status string	success	status of newly launched job Sample: pending

Authors

Wayne Witzel III (@wwitzel3)

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/awx/awx/tower_job_launch_module.html