fortinet.fortios.fortios_system_cluster_sync 模块 – 在 Fortinet 的 FortiOS 和 FortiGate 中配置 FortiGate 会话生命支持协议 (FGSP) 会话同步。

注意

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

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

要安装它，请使用： ansible-galaxy collection install fortinet.fortios。您需要其他要求才能使用此模块，请参阅 需求 获取详细信息。

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

fortinet.fortios 2.0.0 中的新增功能

概要

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

字典

配置 FortiGate 会话生命支持协议 (FGSP) 会话同步。

down_intfs_before_sess_sync

列表 / 元素=字典

会话同步完成后要关闭的接口列表。

name

字符串 / 必需

接口名称。来源 system.interface.name。

hb_interval

整数

心跳间隔 (1 - 10 秒)。

hb_lost_threshold

整数

丢失心跳阈值 (1 - 10)。

ike_heartbeat_interval

整数

IKE 心跳间隔 (1 - 60 秒)。

ike_monitor

字符串

启用/禁用 IKE HA 监控。

选项

  • "enable"

  • "disable"

ike_monitor_interval

整数

IKE HA 监控间隔 (10 - 300 秒)。

ike_seqjump_speed

整数

ESP 跳跃提前因子 (相当于 1G - 10G pps)。

ipsec_tunnel_sync

字符串

启用/禁用 IPsec 隧道同步。

选项

  • "enable"

  • "disable"

peerip

字符串

对等单元上用于会话同步链路的接口的 IP 地址。

peervd

字符串

包含对等单元上会话同步链路接口的 VDOM。通常两个对等体都具有相同的 peervd。来源 system.vdom.name。

secondary_add_ipsec_routes

字符串

启用/禁用备份单元上的 IKE 路由公告。

选项

  • "enable"

  • "disable"

session_sync_filter

字典

如果您只想同步某些会话，请添加一个或多个过滤器。使用过滤器配置要同步的会话类型。

custom_service

列表 / 元素=字典

仅同步使用这些自定义服务的会话。使用源端口和目标端口范围来定义这些自定义服务。

dst_port_range

字符串

自定义服务目标端口范围。

id

整数 / 必需

自定义服务 ID。请参阅 注释。

src_port_range

字符串

自定义服务源端口范围。

dstaddr

字符串

仅同步到此 IPv4 地址的会话。

dstaddr6

字符串

仅同步到此 IPv6 地址的会话。

dstintf

字符串

仅同步到此接口的会话。来源 system.interface.name。

srcaddr

字符串

仅同步来自此 IPv4 地址的会话。

srcaddr6

字符串

仅同步来自此 IPv6 地址的会话。

srcintf

字符串

仅同步来自此接口的会话。来源 system.interface.name。

slave_add_ike_routes

字符串

启用/禁用备份单元上的 IKE 路由公告。

选项

  • "enable"

  • "disable"

sync_id

整数 / 必需

同步 ID。请参阅 注释。

syncvd

列表 / 元素=字典

来自这些 VDOM 的会话使用此会话同步配置进行同步。

name

字符串 / 必需

VDOM 名称。来源 system.vdom.name。

vdom

字符串

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

默认： "root"

注释

注意

  • 我们强烈建议使用您自己的值作为 sync_id，而不是 0，而 '0' 是一个特殊的占位符，允许后端为对象分配最新的可用编号，但它确实有局限性。请在问答中查找更多详细信息。

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

  • 该模块支持 check_mode。

示例

- name: Configure FortiGate Session Life Support Protocol (FGSP) session synchronization.
  fortinet.fortios.fortios_system_cluster_sync:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      system_cluster_sync:
          down_intfs_before_sess_sync:
              -
                  name: "default_name_4 (source system.interface.name)"
          hb_interval: "2"
          hb_lost_threshold: "3"
          ike_heartbeat_interval: "3"
          ike_monitor: "enable"
          ike_monitor_interval: "15"
          ike_seqjump_speed: "10"
          ipsec_tunnel_sync: "enable"
          peerip: "<your_own_value>"
          peervd: "<your_own_value> (source system.vdom.name)"
          secondary_add_ipsec_routes: "enable"
          session_sync_filter:
              custom_service:
                  -
                      dst_port_range: "<your_own_value>"
                      id: "18"
                      src_port_range: "<your_own_value>"
              dstaddr: "<your_own_value>"
              dstaddr6: "<your_own_value>"
              dstintf: "<your_own_value> (source system.interface.name)"
              srcaddr: "<your_own_value>"
              srcaddr6: "<your_own_value>"
              srcintf: "<your_own_value> (source system.interface.name)"
          slave_add_ike_routes: "enable"
          sync_id: "<you_own_value>"
          syncvd:
              -
                  name: "default_name_29 (source system.vdom.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"

serial

字符串

设备的序列号

返回值：始终返回

示例： "FGVMEVYYQT3AB5352"

status

字符串

操作结果指示

返回值：始终返回

示例： "success"

vdom

字符串

使用的虚拟域

返回值：始终返回

示例： "root"

version

字符串

FortiGate的版本

返回值：始终返回

示例： "v5.6.3"

作者

  • 郑链 (@chillancezen)

  • 薛杰 (@JieX19)

  • 卢宏斌 (@fgtdev-hblu)

  • 沈方 (@frankshen01)

  • Miguel Angel Munoz (@mamunozgonzalez)

  • Nicolas Thomas (@thomnico)