ansible / ansible.builtin / v2.8.13 / module / tower_workflow_launch Run a workflow in Ansible Tower | "added in version" 2.8 of ansible.builtin" Authors: John Westcott IV (@john-westcott-iv) preview | supported by communityansible.builtin.tower_workflow_launch (v2.8.13) — module
pip
Install with pip install ansible==2.8.13
Launch an Ansible Tower workflows. See U(https://www.ansible.com/tower) for an overview.
- name: Launch a workflow tower_workflow_launch: name: "Test Workflow" delegate_to: localhost run_once: true register: workflow_results
- name: Launch a Workflow with parameters without waiting tower_workflow_launch: workflow_template: "Test workflow" extra_vars: "--- my: var" wait: False delegate_to: localhost run_once: true register: workflow_task_info
wait: default: true description: - Wait for the workflow to complete. required: false type: bool timeout: description: - If waiting for the workflow to complete this will abort after this amount of seconds extra_vars: description: - Any extra vars required to launch the job. required: false 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 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. - 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 C(TOWER_OAUTH_TOKEN) and then config files type: raw version_added: '3.7' version_added_collection: awx.awx tower_config_file: description: - Path to the Tower or AWX config file. - If provided, the other locations for config files will not be considered. type: path workflow_template: description: - The name of the workflow template to run. required: true
job_info: description: dictionary containing information about the workflow executed returned: If workflow launched type: dict tower_version: description: The version of Tower we connected to returned: If connection to Tower works sample: 3.4.0 type: str