ansible.builtin.tower_workflow_template (v2.9.24) — module

Install Ansible via pip

Install with pip install ansible==2.9.24

Description

Create, update, or destroy Ansible Tower workflows. 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.

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

Scanned by Steampunk Spotter

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

- tower_worflow_template:
    name: Workflow Template
    state: absent

Inputs

    
name:
    description:
    - The name to use for the workflow.
    required: true

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

schema:
    description:
    - 'The schema is a JSON- or YAML-formatted string defining the hierarchy structure
      that connects the nodes. Refer to Tower documentation for more information.

      '

survey:
    description:
    - The definition of the survey associated to the workflow.

inventory:
    description:
    - Name of the inventory to use for the job template.
    version_added: '2.9'
    version_added_collection: ansible.builtin

extra_vars:
    description:
    - Extra variables used by Ansible in YAML or key=value format.

description:
    description:
    - The description to use for the workflow.

organization:
    description:
    - The organization the workflow is linked to.

ask_inventory:
    description:
    - Prompt user for inventory on launch.
    type: bool
    version_added: '2.9'
    version_added_collection: ansible.builtin

ask_extra_vars:
    description:
    - Prompt user for (extra_vars) on launch.
    type: bool
    version_added: '2.9'
    version_added_collection: ansible.builtin

survey_enabled:
    description:
    - Setting that variable will prompt the user for job type on the workflow launch.
    type: bool

validate_certs:
    aliases:
    - tower_verify_ssl
    description:
    - Whether to allow insecure connections to 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(CONTROLLER_VERIFY_SSL) and then
      config files
    type: bool

controller_host:
    aliases:
    - tower_host
    description:
    - URL to your Automation Platform Controller instance.
    - If value not set, will try environment variable C(CONTROLLER_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

allow_simultaneous:
    description:
    - If enabled, simultaneous runs of this job template will be allowed.
    type: bool

controller_password:
    aliases:
    - tower_password
    description:
    - Password for your controller instance.
    - If value not set, will try environment variable C(CONTROLLER_PASSWORD) and then
      config files
    type: str

controller_username:
    aliases:
    - tower_username
    description:
    - Username for your controller instance.
    - If value not set, will try environment variable C(CONTROLLER_USERNAME) and then
      config files
    type: str

controller_oauthtoken:
    aliases:
    - tower_oauthtoken
    description:
    - The 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 token module.
    - If value not set, will try environment variable C(CONTROLLER_OAUTH_TOKEN) and then
      config files
    type: raw
    version_added: 3.7.0
    version_added_collection: awx.awx

controller_config_file:
    aliases:
    - tower_config_file
    description:
    - Path to the controller config file.
    - If provided, the other locations for config files will not be considered.
    type: path