tower_job_template - create, update, or destroy Ansible Tower job_template.
New in version 2.3.
Synopsis
- Create, update, or destroy Ansible Tower job templates. See https://www.ansible.com/tower for an overview.
Requirements
The below requirements are needed on the host that executes this module.
- ansible-tower-cli >= 3.0.2
Parameters
| Parameter | Choices/Defaults | Comments |
|---|---|---|
| ask_credential | Default: no | Prompt user for credential on launch. |
| ask_extra_vars | Default: no | Prompt user for extra_vars on launch. |
| ask_inventory | Default: no | Propmt user for inventory on launch. |
| ask_job_type | Default: no | Prompt user for job type on launch. |
| ask_tags | Default: no | Prompt user for job tags on launch. |
| become_enabled | Default: no | Should become_enabled. |
| cloud_credential | Default: None | Cloud_credential to use for the job_template. |
| description | Default: None | Description to use for the job_template. |
| extra_vars_path | Default: None | Path to the extra_vars yaml file. |
| forks | Default: None | The number of parallel or simultaneous processes to use while executing the playbook. |
| host_config_key | Default: None | Allow provisioning callbacks using this host config key. |
| inventory | Default: None | Inventory to use for the job_template. |
| job_tags | Default: None | The job_tags to use for the job_template. |
| job_type required |
| The job_type to use for the job_template. |
| limit | Default: None | A host pattern to further constrain the list of hosts managed or affected by the playbook |
| machine_credential | Default: None | Machine_credential to use for the job_template. |
| name required | Name to use for the job_template. | |
| network_credential | Default: None | The network_credential to use for the job_template. |
| playbook required | Playbook to use for the job_template. | |
| project required | Project to use for the job_template. | |
| skip_tags | Default: None | The skip_tags to use for the job_template. |
| state |
| Desired state of the resource. |
| tower_config_file | Default: None | Path to the Tower config file. See notes. |
| tower_host | Default: None | URL to your Tower instance. |
| tower_password | Default: None | Password for your Tower instance. |
| tower_username | Default: None | Username for your Tower instance. |
| tower_verify_ssl | Default: yes | 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. |
| verbosity |
None | Control the output level Ansible produces as the playbook runs. |
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: Create tower Ping job template
tower_job_template:
name: Ping
job_type: run
inventory: Local
project: Demo
playbook: ping.yml
machine_credential: Local
state: present
tower_config_file: "~/tower_cli.cfg"
Status
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
Author
- Wayne Witzel III (@wwitzel3)
Hint
If you notice any issues in this documentation you can edit this document to improve it.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.5/modules/tower_job_template_module.html