New in version 2.3.
The below requirements are needed on the host that executes this module.
| Parameter | Choices/Defaults | Comments |
|---|---|---|
| credential |
Credential to use for job, only used if prompt for credential is set.
|
|
| extra_vars |
Extra_vars to use for the job_template. Prepend
@ if a file. |
|
| inventory |
Inventory to use for the job, only used if prompt for inventory is set.
|
|
| job_explanation |
Job explanation field.
|
|
|
job_template
required |
Name of the job template to use.
|
|
| job_type |
|
Job_type to use for the job, only used if prompt for job_type is set.
|
| limit |
Limit to use for the job_template.
|
|
| tags |
Specific tags to use for from playbook.
|
|
| tower_config_file |
Path to the Tower config file. See notes.
|
|
| tower_host |
URL to your Tower instance.
|
|
| tower_password |
Password for your Tower instance.
|
|
| tower_username |
Username for your Tower instance.
|
|
| tower_verify_ssl |
|
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 |
|
Disable launching jobs from job template.
|
Note
- 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
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description |
|---|---|---|
|
id
int
|
success |
job id of the newly launched job
Sample:
86
|
|
status
string
|
success |
status of newly launched job
Sample:
pending
|
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
Hint
If you notice any issues in this documentation you can edit this document to improve it.