/ home / avantra / avantra.core / 24.0.0 / module / workflow_execution

avantra.core.workflow_execution (24.0.0) — module

execute Avantra workflows

| "added in version" 23.0.0 of avantra.core"

Authors: Michael Szediwy (@avantra-mis)

This plugin has a corresponding action plugin.

Install collection

Install with ansible-galaxy collection install avantra.core:==24.0.0

Add to requirements.yml

  collections:
    - name: avantra.core
      version: 24.0.0

Description

Allow you to trigger Avantra workflows and setting the input variables.

It is not possible to stop or cancel the execution using this module.

Usage examples

Scanned by Steampunk Spotter

- name: "Workflow Start"
  avantra.core.workflow_execution:
    name: call_api
    namespace: demo
    args:
      user: <user>
      pw: <password>
      data1: <data1>

Inputs

    
args:
    default: {}
    description:
    - 'Allows you to define the input parameters for the workflow to start in the form
      C(key: value).'
    required: false
    type: dict

name:
    description:
    - Select workflow name to execute
    required: true
    type: str

variant:
    description:
    - You can select a specific workflow variant to execute.
    required: false
    type: str

namespace:
    description:
    - Select the namespace of the workflow namespace to execute.
    - I(name) and I(namespace) identify the workflow that is executed.
    required: true
    type: str

avantra_api_url:
    description:
    - A valid URL pointing to an Avantra UI.
    - For example C(https://avantra-ui/xn)
    required: true
    type: str

avantra_api_user:
    description:
    - Valid Avantra user principal.
    required: true
    type: str

avantra_api_password:
    description:
    - The password or API key for the selected Avantra user.
    - We highly recommend to use Ansible Vaults to protect you sensitive content.
    required: true
    type: str

ignore_default_variant:
    default: false
    description:
    - If there is a default I(variant) configured for the selected workflow it can be
      ignored with C(ignore_default_variant=false).
    type: bool

Outputs

execution_id:
  description: The ID of the triggered execution.
  returned: success
  sample: '457'
  type: str