iap_start_workflow – Start a workflow in the Itential Automation Platform¶
New in version 2.8.
Synopsis¶
- This will start a specified workflow in the Itential Automation Platform with given arguments.
Parameters¶
Examples¶
- name: Start a workflow in the Itential Automation Platform
  iap_start_workflow:
    iap_port: 3000
    iap_fqdn: localhost
    token_key: "DFSFSFHFGFGF[DSFSFAADAFASD%3D"
    workflow_name: "RouterUpgradeWorkflow"
    description: "OS-Router-Upgrade"
    variables: {"deviceName":"ASR9K"}
  register: result
- debug: var=result
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description | 
|---|---|---|
| msg 
                  string
                                       | always | The msg will contain the error code or status of the workflow | 
| response 
                  dictionary
                                       | always | The result contains the response from the call | 
Status¶
- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Community. [community]
Authors¶
- Itential (@cma0) <opensource@itential.com>
Hint
If you notice any issues in this documentation, you can edit this document to improve it.
