Docs4dev
Docs
ansible / 2.10 / collections / awx / awx / tower_workflow_template_module.html

awx.awx.tower_workflow_template – create, update, or destroy Ansible Tower workflow template.

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_template.

DEPRECATED

Removed in

version 14.0.0

Why

Deprecated in favor of _workflow_job_template and _workflow_job_template_node modules.

Alternative

Use tower_workflow_job_template and _workflow_job_template_node instead.

Synopsis

  • A tower-cli based module for CRUD actions on workflow job templates.
  • Enables use of the old schema functionality.
  • Not updated for new features, convert to the modules for workflow_job_template and workflow_job_template node instead.

Requirements

The below requirements are needed on the host that executes this module.

  • ansible-tower-cli >= 3.0.2

Parameters

Parameter Choices/Defaults Comments
allow_simultaneous
boolean
    Choices:
  • no
  • yes
If enabled, simultaneous runs of this job template will be allowed.
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.
description
string
The description to use for the workflow.
extra_vars
dictionary
Extra variables used by Ansible in YAML or key=value format.
inventory
string
Name of the inventory to use for the job template.
name
string / required
The name to use for the workflow.
organization
string
The organization the workflow is linked to.
schema
list / elements=dictionary
The schema is a JSON- or YAML-formatted string defining the hierarchy structure that connects the nodes. Refer to Tower documentation for more information.
state
string
    Choices:
  • present ←
  • absent
Desired state of the resource.
survey
dictionary
The definition of the survey associated to the workflow.
survey_enabled
boolean
    Choices:
  • 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_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
    Choices:
  • 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

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

- tower_workflow_template:
    name: Workflow Template
    description: My very first Workflow Template
    organization: My optional Organization
    schema: "{{ lookup('file', 'my_workflow.json') }}"

- tower_workflow_template:
    name: Workflow Template
    state: absent

Status

  • This module will be removed in version 14.0.0. [deprecated]
  • For more information see DEPRECATED.

Authors

  • Adrien Fleury (@fleu42)

© 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_template_module.html