ansible.builtin.tower_job_template (v2.6.20) — module

Install Ansible via pip

Install with pip install ansible==2.6.20

Description

Create, update, or destroy Ansible Tower job templates. See U(https://www.ansible.com/tower) for an overview.

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- 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"

Inputs

    
name:
    description:
    - Name to use for the job_template.
    required: true

forks:
    description:
    - The number of parallel or simultaneous processes to use while executing the playbook.

limit:
    description:
    - A host pattern to further constrain the list of hosts managed or affected by the
      playbook

state:
    choices:
    - present
    - absent
    default: present
    description:
    - Desired state of the resource.

project:
    description:
    - Project to use for the job template.
    required: true

ask_tags:
    default: 'no'
    description:
    - Prompt user for job tags on launch.
    type: bool

job_tags:
    description:
    - The job_tags to use for the job template.

job_type:
    choices:
    - run
    - check
    - scan
    description:
    - The job_type to use for the job template.
    required: true

playbook:
    description:
    - Playbook to use for the job template.
    required: true

inventory:
    description:
    - Inventory to use for the job template.

skip_tags:
    description:
    - The skip_tags to use for the job template.

verbosity:
    choices:
    - verbose
    - debug
    description:
    - Control the output level Ansible produces as the playbook runs.

tower_host:
    description:
    - URL to your Tower or AWX instance.
    - If value not set, will try environment variable C(TOWER_HOST) and then config files
    - If value not specified by any means, the value of C(127.0.0.1) will be used
    type: str

description:
    description:
    - Description to use for the job template.

ask_job_type:
    default: 'no'
    description:
    - Prompt user for job type on launch.
    type: bool

ask_inventory:
    default: 'no'
    description:
    - Propmt user for inventory on launch.
    type: bool

ask_credential:
    default: 'no'
    description:
    - Prompt user for credential on launch.
    type: bool

ask_extra_vars:
    default: 'no'
    description:
    - Prompt user for C(extra_vars) on launch.
    type: bool

become_enabled:
    default: 'no'
    description:
    - Activate privilege escalation.
    type: bool

tower_password:
    description:
    - Password for your Tower or AWX instance.
    - If value not set, will try environment variable C(TOWER_PASSWORD) and then config
      files
    type: str

tower_username:
    description:
    - Username for your Tower or AWX instance.
    - If value not set, will try environment variable C(TOWER_USERNAME) and then config
      files
    type: str

validate_certs:
    aliases:
    - tower_verify_ssl
    description:
    - Whether to allow insecure connections to Tower or AWX.
    - If C(no), SSL certificates will not be validated.
    - This should only be used on personally controlled sites using self-signed certificates.
    - If value not set, will try environment variable C(TOWER_VERIFY_SSL) and then config
      files
    type: bool

extra_vars_path:
    description:
    - Path to the C(extra_vars) YAML file.

host_config_key:
    description:
    - Allow provisioning callbacks using this host config key.

cloud_credential:
    description:
    - Cloud_credential to use for the job template.

tower_oauthtoken:
    description:
    - The Tower 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 tower_token module.
    - If value not set, will try environment variable C(TOWER_OAUTH_TOKEN) and then config
      files
    type: raw
    version_added: '3.7'
    version_added_collection: awx.awx

tower_config_file:
    description:
    - Path to the Tower or AWX config file.
    - If provided, the other locations for config files will not be considered.
    type: path

machine_credential:
    description:
    - Machine_credential to use for the job template.

network_credential:
    description:
    - The network_credential to use for the job template.