Documentation

tower_job_template - create, update, or destroy Ansible Tower job_template.

New in version 2.3.

Synopsis

Requirements (on host that executes module)

  • python >= 2.6
  • ansible-tower-cli >= 3.0.3

Options

parameter required default choices comments
ask_credential
no
Prompt user for credential on launch.
ask_extra_vars
no
Prompt user for extra_vars on launch.
ask_inventory
no
Propmt user for inventory on launch.
ask_job_type
no
Prompt user for job type on launch.
ask_tags
no
Prompt user for job tags on launch.
become_enabled
no
Should become_enabled.
cloud_credential
no
Cloud_credential to use for the job_template.
description
no
Description to use for the job_template.
extra_vars_path
no
Path to the extra_vars yaml file.
forks
no
The number of parallel or simultaneous processes to use while executing the playbook.
host_config_key
no
Allow provisioning callbacks using this host config key.
inventory
no
Inventory to use for the job_template.
job_tags
no
The job_tags to use for the job_template.
job_type
yes
  • run
  • check
  • scan
The job_type to use for the job_template.
limit
no
A host pattern to further constrain the list of hosts managed or affected by the playbook
machine_credential
no
Machine_credential to use for the job_template.
name
yes
Name to use for the job_template.
network_credential
no
The network_credential to use for the job_template.
playbook
yes
Playbook to use for the job_template.
project
yes
Project to use for the job_template.
skip_tags
no
The skip_tags to use for the job_template.
state
no present
  • present
  • absent
Desired state of the resource.
tower_config_file
no
Path to the Tower config file. See notes.
tower_host
no
URL to your Tower instance.
tower_password
no
Password for your Tower instance.
tower_username
no
Username for your Tower instance.
tower_verify_ssl
no True
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
no
  • verbose
  • debug
Control the output level Ansible produces as the playbook runs.

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"

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

Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Support

This module is community maintained without core committer oversight.

For more information on what this means please read Module Support

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Helping Testing PRs and Developing Modules.