community.network.iap_start_workflow – Start a workflow in the Itential Automation Platform
Note
This plugin is part of the community.network collection (version 3.0.0).
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.
Parameters
| Parameter | Choices/Defaults | Comments |
|---|---|---|
| description
string / required
|
Provide the description for the workflow
|
|
| https
boolean
|
|
Use HTTPS to connect
By default using http
|
| iap_fqdn
string / required
|
Provide the fqdn for the Itential Automation Platform
|
|
| iap_port
string / required
|
Provide the port number for the Itential Automation Platform
|
|
| token_key
string / required
|
Token key generated by iap_token module for the Itential Automation Platform
|
|
| validate_certs
boolean
|
|
If no, SSL certificates for the target url will not be validated. This should only be used on personally controlled sites using self-signed certificates.
|
| variables
dictionary / required
|
Provide the values to the job variables
|
|
| workflow_name
string / required
|
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 | 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>
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/network/iap_start_workflow_module.html