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¶
Launch an Ansible Tower jobs. See https://www.ansible.com/tower for an overview.
Parameters¶
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)