alancoding.awx.tower_workflow_job_template_node (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 template nodes.

Use this to build a graph for a workflow, which dictates what the workflow runs.

Replaces the deprecated tower_workflow_template module schema command.

You can create nodes first, and link them afterwards, and not worry about ordering. For failsafe referencing of a node, specify identifier, WFJT, and organization. With those specified, you can choose to modify or not modify any other parameter.

Usage examples

Scanned by Steampunk Spotter

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

- name: Create a node, follows tower_workflow_job_template example
  tower_workflow_job_template_node:
    identifier: my-first-node
    workflow: example-workflow
    unified_job_template: jt-for-node-use
    organization: Default  # organization of workflow job template
    extra_data:
      foo_key: bar_value

Scanned by Steampunk Spotter

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

- name: Create parent node for prior node
  tower_workflow_job_template_node:
    identifier: my-root-node
    workflow: example-workflow
    unified_job_template: jt-for-node-use
    organization: Default
    success_nodes:
      - my-first-node

Inputs

    
limit:
    description:
    - Limit to act on, applied as a prompt, if job template prompts for limit
    type: str

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

job_tags:
    description:
    - Job tags applied as a prompt, if job template prompts for job tags
    type: str

job_type:
    choices:
    - run
    - check
    description:
    - Job type applied as a prompt, if job template prompts for job type
    type: str

diff_mode:
    description:
    - Run diff mode, applied as a prompt, if job template prompts for diff mode
    type: bool

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

skip_tags:
    description:
    - Tags to skip, applied as a prompt, if job tempalte prompts for job tags
    type: str

verbosity:
    choices:
    - '0'
    - '1'
    - '2'
    - '3'
    - '4'
    - '5'
    description:
    - Verbosity applied as a prompt, if job template prompts for verbosity
    type: str

extra_data:
    default: {}
    description:
    - Variables to apply at launch time.
    - Will only be accepted if job template prompts for vars or has a survey asking for
      those vars.
    type: dict

identifier:
    description:
    - An identifier for this node that is unique within its workflow.
    - It is copied to workflow job nodes corresponding to this node.
    required: true
    type: str

scm_branch:
    description:
    - SCM branch applied as a prompt, if 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

credentials:
    description:
    - Credentials to be applied to job as launch-time prompts.
    - List of credential names.
    - Uniqueness is not handled rigorously.
    elements: str
    type: list

always_nodes:
    description:
    - Nodes that will run after this node completes.
    - List of node identifiers.
    elements: str
    type: list

organization:
    description:
    - The organization of the workflow job template the node exists in.
    - Used for looking up the workflow, not a direct model field.
    type: str

failure_nodes:
    description:
    - Nodes that will run after this node on failure.
    - List of node identifiers.
    elements: str
    type: list

success_nodes:
    description:
    - Nodes that will run after this node on success.
    - List of node identifiers.
    elements: str
    type: list

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

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

unified_job_template:
    description:
    - Name of unified job template to run in the workflow.
    - Can be a job template, project, inventory source, etc.
    - Omit if creating an approval node (not yet implemented).
    type: str

workflow_job_template:
    aliases:
    - workflow
    description:
    - The workflow job template the node exists in.
    - Used for looking up the node, cannot be modified after creation.
    required: true
    type: str

all_parents_must_converge:
    description:
    - If enabled then the node will only run if all of the parent nodes have met the criteria
      to reach this node
    type: bool