fortinet.fortios.fortios_switch_controller_system 模块 – 在 Fortinet 的 FortiOS 和 FortiGate 中配置系统范围的交换机控制器设置。

注意

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

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

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

要在剧本中使用它，请指定：fortinet.fortios.fortios_switch_controller_system。

fortinet.fortios 2.0.0 中的新增功能

概要

  • 此模块能够通过允许用户设置和修改 switch_controller 功能和系统类别来配置 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"

switch_controller_system

字典

配置系统范围的交换机控制器设置。

caputp_echo_interval

整数

来自 swtp 的 caputp 回显请求的回显间隔。

caputp_max_retransmit

整数

caputp 隧道数据包的最大重传次数。

data_sync_interval

整数

收集交换机数据的时间间隔 (30-1800 秒)。

dynamic_periodic_interval

整数

运行动态端口策略引擎的周期性时间间隔 (5-180 秒)。

iot_holdoff

整数

MAC 条目的创建时间。条目创建的时间必须大于此值 (0-10080 分钟)。

iot_mac_idle

整数

MAC 条目的空闲时间。超过此值后将删除 MAC 条目 (0-10080 分钟)。

iot_scan_interval

整数

物联网扫描间隔 (2-10080 分钟)。

iot_weight_threshold

整数

MAC 条目的置信度值。低于此值时将重新查询该值。

nac_periodic_interval

整数

运行 NAC 引擎的周期性时间间隔 (5-180 秒)。

parallel_process

整数

最大并行进程数。

parallel_process_override

字符串

启用/禁用并行进程覆盖。

选项

  • "disable"

  • "enable"

tunnel_mode

字符串

兼容/严格的隧道模式。

选项

  • "compatible"

  • "moderate"

  • "strict"

vdom

字符串

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

默认值： "root"

备注

注意

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

示例

- name: Configure system-wide switch controller settings.
  fortinet.fortios.fortios_switch_controller_system:
      vdom: "{{ vdom }}"
      switch_controller_system:
          caputp_echo_interval: "30"
          caputp_max_retransmit: "5"
          data_sync_interval: "60"
          dynamic_periodic_interval: "60"
          iot_holdoff: "5"
          iot_mac_idle: "1440"
          iot_scan_interval: "60"
          iot_weight_threshold: "1"
          nac_periodic_interval: "60"
          parallel_process: "1"
          parallel_process_override: "disable"
          tunnel_mode: "compatible"

返回值

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

键

描述

build

字符串

Fortigate 镜像的构建编号

返回： 始终

示例： "1547"

http_method

字符串

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

返回： 始终

示例： "PUT"

http_status

字符串

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

返回： 始终

示例： "200"

mkey

字符串

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

返回： 成功

示例： "id"

name

字符串

用于完成请求的表的名称

返回： 始终

示例： "urlfilter"

path

字符串

用于完成请求的表的路径

返回： 始终

示例： "webfilter"

revision

字符串

内部修订号

返回： 始终

示例： "17.0.2.10658"

serial

字符串

设备的序列号

返回： 始终

示例： "FGVMEVYYQT3AB5352"

status

字符串

操作结果的指示

返回： 始终

示例： "success"

vdom

字符串

使用的虚拟域

返回： 始终

示例： "root"

版本

字符串

FortiGate 版本

返回： 始终

示例： "v5.6.3"

作者

  • 郑链 (@chillancezen)

  • 薛杰 (@JieX19)

  • 陆洪斌 (@fgtdev-hblu)

  • 沈方 (@frankshen01)

  • Miguel Angel Munoz (@mamunozgonzalez)

  • Nicolas Thomas (@thomnico)