Documentation

tower_job_launch - Launch an Ansible Job.

New in version 2.3.

Synopsis

Requirements (on host that executes module)

  • python >= 2.6
  • ansible-tower-cli >= 3.0.2

Options

parameter required default choices comments
credential
no
Credential to use for job, only used if prompt for credential is set.
extra_vars
no
Extra_vars to use for the job_template. Use '@' for a file.
inventory
no
Inventory to use for the job, only used if prompt for inventory is set.
job_explanation
no
Job explanation field.
job_template
yes
Name of the job_template to use.
job_type
no
  • run
  • check
  • scan
Job_type to use for the job, only used if prompt for job_type is set.
limit
no
Limit to use for the job_template.
tags
no
Specific tags to use for from playbook.
tower_config_file
no
Path to the Tower config file. See notes.
tower_host
no
URL to your Tower instance.
tower_password
no
Password for your Tower instance.
tower_username
no
Username for your Tower instance.
tower_verify_ssl
no True
Dis/allow insecure connections to Tower. If no, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates.
use_job_endpoint
no
Disable launching jobs from job template.

Examples

- name: Launch a job
  tower_job_launch:
    job_template: "My Job Template"
    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 Return Values, the following are the fields unique to this module:

name description returned type sample
status status of newly launched job success string pending
id job id of the newly launched job success int 86


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

Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Support

This module is community maintained without core committer oversight.

For more information on what this means please read Module Support

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Helping Testing PRs and Developing Modules.