community.network.iap_start_workflow – Start a workflow in the Itential Automation Platform¶
Note
This plugin is part of the community.network collection (version 2.1.1).
To install it use: ansible-galaxy collection install community.network
.
To use it in a playbook, specify: community.network.iap_start_workflow
.
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
community.network.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
- ansible.builtin.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
|
Authors¶
Itential (@cma0) <opensource@itential.com>