awx.awx.tower_workflow_job_template – create, update, or destroy Ansible Tower workflow job templates.

From Get docs
Ansible/docs/2.10/collections/awx/awx/tower workflow job template module


awx.awx.tower_workflow_job_template – create, update, or destroy Ansible Tower workflow job templates.

Note

This plugin is part of the awx.awx collection (version 14.1.0).

To install it use: ansible-galaxy collection install awx.awx.

To use it in a playbook, specify: awx.awx.tower_workflow_job_template.


Synopsis

  • Create, update, or destroy Ansible Tower workflow job templates.
  • Replaces the deprecated tower_workflow_template module.
  • Use the tower_workflow_job_template_node after this to build the workflow’s graph.

Parameters

Parameter Choices/Defaults Comments

allow_simultaneous

boolean

  • no
  • yes

Allow simultaneous runs of the workflow job template.

ask_inventory_on_launch

boolean

  • no
  • yes

Prompt user for inventory on launch of this workflow job template

ask_limit_on_launch

boolean

  • no
  • yes

Prompt user for limit on launch of this workflow job template

ask_scm_branch_on_launch

boolean

  • no
  • yes

Prompt user for SCM branch on launch of this workflow job template

ask_variables_on_launch

boolean

  • no
  • yes

Prompt user for extra_vars on launch.

description

string

Optional description of this workflow job template.

extra_vars

dictionary

Variables which will be made available to jobs ran inside the workflow.

inventory

string

Inventory applied as a prompt, assuming job template prompts for inventory

limit

string

Limit applied as a prompt, assuming job template prompts for limit

name

string / required

Name of this workflow job template.

new_name

string

Setting this option will change the existing name.

notification_templates_approvals

list / elements=string

list of notifications to send on start

notification_templates_error

list / elements=string

list of notifications to send on error

notification_templates_started

list / elements=string

list of notifications to send on start

notification_templates_success

list / elements=string

list of notifications to send on success

organization

string

Organization the workflow 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.

scm_branch

string

SCM branch applied as a prompt, assuming job template prompts for SCM branch

state

string

  • present

  • absent

Desired state of the resource.

survey

dictionary

The definition of the survey associated to the workflow.

survey_enabled

boolean

  • no
  • yes

Setting that variable will prompt the user for job type on the workflow launch.

tower_config_file

path

Path to the Tower or AWX config file.

If provided, the other locations for config files will not be considered.

tower_host

string

URL to your Tower or AWX instance.

If value not set, will try environment variable TOWER_HOST and then config files

If value not specified by any means, the value of 127.0.0.1 will be used

tower_oauthtoken

raw

added in 3.7 of awx.awx

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 TOWER_OAUTH_TOKEN and then config files

tower_password

string

Password for your Tower or AWX instance.

If value not set, will try environment variable TOWER_PASSWORD and then config files

tower_username

string

Username for your Tower or AWX instance.

If value not set, will try environment variable TOWER_USERNAME and then config files

validate_certs

boolean

  • no
  • yes

Whether to allow insecure connections to Tower or AWX.

If 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 TOWER_VERIFY_SSL and then config files


aliases: tower_verify_ssl

webhook_credential

string

Personal Access Token for posting back the status to the service API

webhook_service

string

  • github
  • gitlab

Service that webhook requests will be accepted from



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 a workflow job template
  tower_workflow_job_template:
    name: example-workflow
    description: created by Ansible Playbook
    organization: Default

Authors

  • John Westcott IV (@john-westcott-iv)

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/awx/awx/tower_workflow_job_template_module.html