fortinet.fortios.fortios_system_automation_stitch 模块 – Fortinet FortiOS 和 FortiGate 的自动化连接。

注意

此模块是 fortinet.fortios 集合 (版本 2.3.8) 的一部分。

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

要安装它，请使用： ansible-galaxy collection install fortinet.fortios。您需要其他要求才能使用此模块，请参阅 需求了解详情。

要在 playbook 中使用它，请指定： fortinet.fortios.fortios_system_automation_stitch。

fortinet.fortios 2.0.0 中的新增功能

概要

  • 此模块能够通过允许用户设置和修改系统功能和 automation_stitch 类别来配置 FortiGate 或 FortiOS (FOS) 设备。示例包括所有参数和值，需要在使用前调整为数据源。已在 FOS v6.0.0 上测试。

需求

执行此模块的主机需要以下要求。

  • ansible>=2.15

参数

参数

注释

access_token

字符串

基于令牌的身份验证。从 FortiGate 的 GUI 生成。

enable_log

布尔值

启用/禁用任务日志记录。

选项

  • false ← (默认)

  • true

member_path

字符串

要操作的成员属性路径。

如果有多个属性，则用斜杠字符分隔。

标有 member_path 的参数对于执行成员操作是合法的。

member_state

字符串

在指定的属性路径下添加或删除成员。

指定 member_state 时，将忽略 state 选项。

选项

  • "present"

  • "absent"

state

字符串 / 必需

指示是创建还是删除对象。

选项

  • "present"

  • "absent"

system_automation_stitch

字典

自动化连接。

action

列表 / 元素=字典

操作名称。

name

字符串 / 必需

操作名称。来源 system.automation-action.name。

actions

列表 / 元素=字典

配置连接操作。

action

字符串

操作名称。来源 system.automation-action.name。

delay

整数

执行前的延迟（以秒为单位）。

id

整数 / 必需

条目 ID。请参阅 备注。

required

字符串

在操作链中必需。

选项

  • "enable"

  • "disable"

description

字符串

描述。

destination

列表 / 元素=字典

目标设备的序列号/HA 组名。

name

字符串 / 必需

目标名称。来源 system.automation-destination.name。

name

字符串 / 必需

名称。

status

字符串

启用/禁用此连接。

选项

  • "enable"

  • "disable"

trigger

字符串

触发器名称。来源 system.automation-trigger.name。

vdom

字符串

虚拟域，在先前定义的虚拟域中。vdom 是 FortiGate 的虚拟实例，可以将其配置并用作不同的单元。

默认值： "root"

备注

注意

  • 旧版 fortiosapi 已弃用，httpapi 是运行 playbook 的首选方法。

  • 此模块支持 check_mode。

示例

- name: Automation stitches.
  fortinet.fortios.fortios_system_automation_stitch:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      system_automation_stitch:
          action:
              -
                  name: "default_name_4 (source system.automation-action.name)"
          actions:
              -
                  action: "<your_own_value> (source system.automation-action.name)"
                  delay: "0"
                  id: "8"
                  required: "enable"
          description: "<your_own_value>"
          destination:
              -
                  name: "default_name_12 (source system.automation-destination.name)"
          name: "default_name_13"
          status: "enable"
          trigger: "<your_own_value> (source system.automation-trigger.name)"

返回值

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

键

描述

build

字符串

FortiGate 映像的版本号。

返回：始终

示例： "1547"

http_method

字符串

上次用于将内容置备到 FortiGate 的方法。

返回：始终

示例： "PUT"

http_status

字符串

FortiGate 在上次应用的操作中给出的最后结果。

返回：始终

示例： "200"

mkey

字符串

上次调用 FortiGate 时使用的主密钥 (id)。

返回：成功

示例： "id"

name

字符串

用于完成请求的表的名称。

返回：始终

示例： "urlfilter"

path

字符串

用于完成请求的表的路径。

返回：始终

示例： "webfilter"

revision

字符串

内部修订号

返回：始终

示例： "17.0.2.10658"

序列号

字符串

设备的序列号

返回：始终

示例： "FGVMEVYYQT3AB5352"

status

字符串

操作结果指示

返回：始终

示例： "success"

vdom

字符串

使用的虚拟域

返回：始终

示例： "root"

版本

字符串

FortiGate 的版本

返回：始终

示例： "v5.6.3"

作者

  • 郑链 (@chillancezen)

  • 薛杰 (@JieX19)

  • 陆洪宾 (@fgtdev-hblu)

  • 沈方 (@frankshen01)

  • Miguel Angel Munoz (@mamunozgonzalez)

  • Nicolas Thomas (@thomnico)