awx.awx.workflow_approval module – Approve an approval node in a workflow job.
Note
This module is part of the awx.awx collection (version 21.12.0).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install awx.awx
.
To use it in a playbook, specify: awx.awx.workflow_approval
.
Synopsis
Approve an approval node in a workflow job. See https://www.ansible.com/tower for an overview.
Parameters
Parameter |
Comments |
---|---|
Type of action to take. Choices:
|
|
Path to the controller config file. If provided, the other locations for config files will not be considered. |
|
URL to your Automation Platform Controller instance. If value not set, will try environment variable If value not specified by any means, the value of |
|
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 |
|
Password for your controller instance. If value not set, will try environment variable |
|
Username for your controller instance. If value not set, will try environment variable |
|
The interval in sections, to request an update from the controller. Default: |
|
Name of the Approval node to approve or deny. |
|
Maximum time in seconds to wait for a workflow job to to reach approval node. Default: |
|
Whether to allow insecure connections to AWX. If This should only be used on personally controlled sites using self-signed certificates. If value not set, will try environment variable Choices:
|
|
ID of the workflow job to monitor for approval. |
Notes
Note
If no config_file is provided we will attempt to use the tower-cli library defaults to find your host information.
config_file should be in the following format host=hostname username=username password=password
Examples
- name: Launch a workflow with a timeout of 10 seconds
workflow_launch:
workflow_template: "Test Workflow"
wait: False
register: workflow
- name: Wait for approval node to activate and approve
workflow_approval:
workflow_job_id: "{{ workflow.id }}"
name: Approve Me
interval: 10
timeout: 20
action: deny