ansible.builtin.iap_start_workflow (v2.9.27) — module

Install Ansible via pip

Install with pip install ansible==2.9.27

Description

This will start a specified workflow in the Itential Automation Platform with given arguments.

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- 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

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- debug: var=result

Inputs

    
https:
    default: false
    description:
    - Use HTTPS to connect
    - By default using http
    type: bool

iap_fqdn:
    default: null
    description:
    - Provide the fqdn for the Itential Automation Platform
    required: true
    type: str

iap_port:
    default: null
    description:
    - Provide the port number for the Itential Automation Platform
    required: true
    type: str

token_key:
    default: null
    description:
    - Token key generated by iap_token module for the Itential Automation Platform
    required: true
    type: str

variables:
    default: null
    description:
    - Provide the values to the job variables
    required: true
    type: dict

description:
    default: null
    description:
    - Provide the description for the workflow
    required: true
    type: str

workflow_name:
    default: null
    description:
    - Provide the workflow name
    required: true
    type: str

validate_certs:
    default: false
    description:
    - If C(no), SSL certificates for the target url will not be validated. This should
      only be used on personally controlled sites using self-signed certificates.
    type: bool

Outputs

msg:
  description: The msg will contain the error code or status of the workflow
  returned: always
  type: str
response:
  description: The result contains the response from the call
  returned: always
  type: dict