awx.awx.job_launch module – Launch an Ansible Job.
Note
This module is part of the awx.awx collection (version 24.6.1).
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
Launch an Automation Platform Controller jobs. See https://www.ansible.com/tower for an overview.
Aliases: tower_job_launch
Parameters
Parameter |
Comments |
---|---|
Path to the controller config file. If provided, the other locations for config files will not be considered. |
|
URL to your Automation Platform Controller instance. If value not set, will try environment variable If value not specified by any means, the value of |
|
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 |
|
Password for your controller instance. If value not set, will try environment variable |
|
Username for your controller instance. If value not set, will try environment variable |
|
Passwords for credentials which are set to prompt on launch |
|
Credential names, IDs, or named URLs to use for job, only used if prompt for credential is set. |
|
Show the changes made by Ansible tasks where supported Choices:
|
|
Execution environment name, ID, or named URL to use for the job, only used if prompt for execution environment is set. |
|
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. |
|
Forks to use for the job, only used if prompt for forks is set. |
|
Instance group names, IDs, or named URLs to use for the job, only used if prompt for instance groups is set. |
|
The interval to request an update from the controller. Default: |
|
Inventory name, ID, or named URL to use for the job, only used if prompt for inventory is set. |
|
Job slice count to use for the job, only used if prompt for job slice count is set. |
|
Timeout to use for the job, only used if prompt for timeout is set. This parameter is sent through the API to the job. |
|
Job_type to use for the job, only used if prompt for job_type is set. Choices:
|
|
Labels to use for the job, only used if prompt for labels is set. |
|
Limit to use for the job_template. |
|
Name of the job template to use. |
|
Organization name, ID, or named URL 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. |
|
Specify the timeout Ansible should use in requests to the controller host. Defaults to 10s, but this is handled by the shared module_utils code |
|
A specific of the SCM project to run the template on. This is only applicable if your project allows for branch override. |
|
Specific tags to skip from the playbook. |
|
Specific tags to use for from playbook. |
|
If waiting for the job to complete this will abort after this amount of seconds. This happens on the module side. |
|
Whether to allow insecure connections to AWX. If This should only be used on personally controlled sites using self-signed certificates. If value not set, will try environment variable Choices:
|
|
Verbosity level for this job run Choices:
|
|
Wait for the job to complete. Choices:
|
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"
credentials:
- "My Credential"
- "suplementary cred"
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 |
---|---|
job id of the newly launched job Returned: success Sample: |
|
status of newly launched job Returned: success Sample: |