# tower_job_template – create, update, or destroy Ansible Tower job template

- Synopsis

- Requirements

- Parameters

- Notes

- Examples

- Status

## 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
boolean

Choices:
- no ←
- yes

Prompt user for credential on launch.

ask_diff_mode
boolean
added in 2.7

Choices:
- no ←
- yes

Prompt user to enable diff mode (show changes) to files when supported by modules.

ask_extra_vars
boolean

Choices:
- no ←
- yes

Prompt user for (extra_vars) on launch.

ask_inventory
boolean

Choices:
- no ←
- yes

Prompt user for inventory on launch.

ask_job_type
boolean

Choices:
- no ←
- yes

Prompt user for job type on launch.

ask_limit
boolean
added in 2.7

Choices:
- no ←
- yes

Prompt user for a limit on launch.

ask_skip_tags
boolean
added in 2.7

Choices:
- no ←
- yes

Prompt user for job tags to skip on launch.

ask_tags
boolean

Choices:
- no ←
- yes

Prompt user for job tags on launch.

ask_verbosity
boolean
added in 2.7

Choices:
- no ←
- yes

Prompt user to choose a verbosity level on launch.

become_enabled
boolean

Choices:
- no ←
- yes

Activate privilege escalation.

concurrent_jobs_enabled
boolean
added in 2.7

Choices:
- no ←
- yes

Allow simultaneous runs of the job template.

credential - added in 2.7 |  | Name of the credential to use for the job template.
description - |  | Description to use for the job template.

diff_mode_enabled
boolean
added in 2.7

Choices:
- no ←
- yes

Enable diff mode for the job template.

extra_vars_path - |  | Path to the `extra_vars` YAML file.

fact_caching_enabled
boolean
added in 2.7

Choices:
- no ←
- yes

Enable use of fact caching for the job template.

force_handlers_enabled
boolean
added in 2.7

Choices:
- no ←
- yes

Enable forcing playbook handlers to run even if a task fails.

forks - |  | The number of parallel or simultaneous processes to use while executing the playbook.
host_config_key - |  | Allow provisioning callbacks using this host config key.
inventory - |  | Name of the inventory to use for the job template.
job_tags - |  | Comma separated list of the tags to use for the job template.

job_type
- / required

Choices:
- run
- check
- scan

The job type to use for the job template.

limit - |  | A host pattern to further constrain the list of hosts managed or affected by the playbook
name - / required |  | Name to use for the job template.
playbook - / required |  | Path to the playbook to use for the job template within the project provided.
project - / required |  | Name of the project to use for the job template.
skip_tags - |  | Comma separated list of the tags to skip for the job template.
start_at_task - added in 2.7 |  | Start the playbook at the task matching this name.

state
-

Choices:
- present ←
- absent

Desired state of the resource.

survey_enabled
boolean
added in 2.7

Choices:
- no ←
- yes

Enable a survey on the job template.

survey_spec dictionary added in 2.8 |  | JSON/YAML dict formatted survey definition.
tower_config_file path |  | Path to the Tower config file.
tower_host string |  | URL to your Tower instance.
tower_password string |  | Password for your Tower instance.
tower_username string |  | Username for your Tower instance.

validate_certs
boolean

Choices:
- no
- yes

Whether to 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.
aliases: tower_verify_ssl

vault_credential - added in 2.7 |  | Name of the vault credential to use for the job template.

verbosity
-

Choices:
- 0 ←
- 1
- 2
- 3
- 4

Control the output level Ansible produces as the playbook runs. 0 - Normal, 1 - Verbose, 2 - More Verbose, 3 - Debug, 4 - Connection Debug.

## Notes

Note

- JSON for survey_spec can be found in Tower API Documentation. See https://docs.ansible.com/ansible-tower/latest/html/towerapi/api_ref.html#/Job_Templates/Job_Templates_job_templates_survey_spec_create for POST operation payload example.

- 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"
        credential: "Local"
        state: "present"
        tower_config_file: "~/tower_cli.cfg"
        survey_enabled: yes
        survey_spec: "{{ lookup('file', 'my_survey.json') }}"

## Status

- This module is not guaranteed to have a backwards compatible interface. [preview]

- This module is maintained by the Ansible Community. [community]

### Authors

- Wayne Witzel III (@wwitzel3)

Hint

If you notice any issues in this documentation, you can edit this document to improve it.