alancoding.awx.tower_workflow_job_template (11.2.0) — module

Install collection

Install with ansible-galaxy collection install alancoding.awx:==11.2.0

Add to requirements.yml

  collections:
    - name: alancoding.awx
      version: 11.2.0

Description

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.

Usage examples

Scanned by Steampunk Spotter

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

- name: Create a workflow job template
  tower_workflow_job_template:
    name: example-workflow
    description: created by Ansible Playbook
    organization: Default

Inputs

    
name:
    description:
    - Name of this workflow job template.
    required: true
    type: str

limit:
    description:
    - Limit applied as a prompt, assuming job template prompts for limit
    type: str

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

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

new_name:
    description:
    - Setting this option will change the existing name.
    type: str

inventory:
    description:
    - Inventory applied as a prompt, assuming job template prompts for inventory
    type: str

extra_vars:
    description:
    - Variables which will be made available to jobs ran inside the workflow.
    type: dict

scm_branch:
    description:
    - SCM branch applied as a prompt, assuming job template prompts for SCM branch
    type: str

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:
    - Optional description of this workflow job template.
    type: str

organization:
    description:
    - 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.
    type: str

survey_enabled:
    description:
    - Setting that variable will prompt the user for job type on the workflow launch.
    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

webhook_service:
    choices:
    - github
    - gitlab
    description:
    - Service that webhook requests will be accepted from
    type: str

tower_oauthtoken:
    description:
    - The Tower OAuth token to use.
    - If value not set, will try environment variable C(TOWER_OAUTH_TOKEN) and then config
      files
    type: str
    version_added: '3.7'
    version_added_collection: alancoding.awx

tower_config_file:
    description:
    - Path to the Tower or AWX config file.
    type: path

allow_simultaneous:
    description:
    - Allow simultaneous runs of the workflow job template.
    type: bool

webhook_credential:
    description:
    - Personal Access Token for posting back the status to the service API
    type: str

ask_limit_on_launch:
    description:
    - Prompt user for limit on launch of this workflow job template
    type: bool

ask_inventory_on_launch:
    description:
    - Prompt user for inventory on launch of this workflow job template
    type: bool

ask_variables_on_launch:
    description:
    - Prompt user for C(extra_vars) on launch.
    type: bool

ask_scm_branch_on_launch:
    description:
    - Prompt user for SCM branch on launch of this workflow job template
    type: bool

notification_templates_error:
    description:
    - list of notifications to send on error
    elements: str
    type: list

notification_templates_started:
    description:
    - list of notifications to send on start
    elements: str
    type: list

notification_templates_success:
    description:
    - list of notifications to send on success
    elements: str
    type: list

notification_templates_approvals:
    description:
    - list of notifications to send on start
    elements: str
    type: list