Note
This plugin is part of the awx.awx collection.
To install it use: ansible-galaxy collection install awx.awx
.
To use it in a playbook, specify: awx.awx.tower_workflow_job_template
.
Parameter | Choices/Defaults | Comments |
---|---|---|
allow_simultaneous boolean |
| Allow simultaneous runs of the workflow job template. |
ask_inventory_on_launch boolean |
| Prompt user for inventory on launch of this workflow job template |
ask_limit_on_launch boolean |
| Prompt user for limit on launch of this workflow job template |
ask_scm_branch_on_launch boolean |
| Prompt user for SCM branch on launch of this workflow job template |
ask_variables_on_launch boolean |
| 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 |
| Desired state of the resource. |
survey dictionary | The definition of the survey associated to the workflow. | |
survey_enabled boolean |
| 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 filesIf 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 |
| 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 filesaliases: tower_verify_ssl |
webhook_credential string | Personal Access Token for posting back the status to the service API | |
webhook_service string |
| Service that webhook requests will be accepted from |
Note
- name: Create a workflow job template tower_workflow_job_template: name: example-workflow description: created by Ansible Playbook organization: Default
© 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