community.network.iap_start_workflow module – Start a workflow in the Itential Automation Platform
Note
This module is part of the community.network collection (version 5.0.3).
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 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.
Aliases: network.itential.iap_start_workflow
Parameters
Parameter |
Comments |
---|---|
Provide the description for the workflow |
|
Use HTTPS to connect By default using http Choices:
|
|
Provide the fqdn for the Itential Automation Platform |
|
Provide the port number for the Itential Automation Platform |
|
Token key generated by iap_token module for the Itential Automation Platform |
|
If Choices:
|
|
Provide the values to the job variables |
|
Provide the workflow name |
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 |
Description |
---|---|
The msg will contain the error code or status of the workflow Returned: always |
|
The result contains the response from the call Returned: always |