community.network.iap_start_workflow 模块 – 在 Itential 自动化平台中启动工作流

注意

此模块是 community.network 集合 (版本 5.1.0) 的一部分。

如果您正在使用 ansible 包，则可能已经安装了此集合。它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用： ansible-galaxy collection install community.network。

要在 playbook 中使用它，请指定： community.network.iap_start_workflow。

注意

community.network 集合已弃用，将从 Ansible 12 中删除。有关更多信息，请参阅讨论线程。

已弃用

移除于:

版本 6.0.0

原因:

此集合及其中的所有内容均未维护且已弃用。

替代方案:

未知。

概要

  • 这将使用给定的参数在 Itential 自动化平台中启动指定的工作流。

别名：network.itential.iap_start_workflow

参数

参数

注释

description

字符串 / 必需

提供工作流的描述

https

布尔值

使用 HTTPS 连接

默认使用 HTTP

选择

  • false ← (默认)

  • true

iap_fqdn

字符串 / 必需

提供 Itential 自动化平台的 FQDN

iap_port

字符串 / 必需

提供 Itential 自动化平台的端口号

token_key

字符串 / 必需

由 iap_token 模块为 Itential 自动化平台生成的令牌密钥

validate_certs

布尔值

如果为 no，则不会验证目标 URL 的 SSL 证书。这应该仅在个人控制的使用自签名证书的站点上使用。

选择

  • false ← (默认)

  • true

variables

字典 / 必需

提供作业变量的值

workflow_name

字符串 / 必需

提供工作流名称

示例

- 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

返回值

常见的返回值已在此处记录 此处，以下是此模块独有的字段

键

描述

msg

字符串

msg 将包含错误代码或工作流的状态

返回： 始终

response

字典

结果包含来自调用的响应

返回： 始终

状态

  • 此模块将在版本 6.0.0 中删除。[已弃用]

  • 有关更多信息，请参阅已弃用。

作者

  • Itential (@cma0)