fortinet.fortios.fortios_system_ha_monitor 模块 – 在 Fortinet 的 FortiOS 和 FortiGate 中配置 HA 监控。

注意

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

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

要安装它,请使用:ansible-galaxy collection install fortinet.fortios。您需要满足其他要求才能使用此模块,请参阅 要求 了解详细信息。

要在 playbook 中使用它,请指定:fortinet.fortios.fortios_system_ha_monitor

在 fortinet.fortios 2.0.0 中新增

概要

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

system_ha_monitor

字典

配置 HA 监控。

monitor_vlan

字符串

启用/禁用监控 VLAN 接口。

选项

  • "enable"

  • "disable"

vlan_hb_interval

整数

配置心跳间隔(秒)。

vlan_hb_lost_threshold

整数

VLAN 丢失心跳阈值(1 - 60)。

vdom

字符串

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

默认: "root"

注释

注意

  • 传统的 fortiosapi 已被弃用,httpapi 是运行 playbook 的首选方式

示例

- name: Configure HA monitor.
  fortinet.fortios.fortios_system_ha_monitor:
      vdom: "{{ vdom }}"
      system_ha_monitor:
          monitor_vlan: "enable"
          vlan_hb_interval: "5"
          vlan_hb_lost_threshold: "3"

返回值

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

描述

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"

作者

  • Link Zheng (@chillancezen)

  • Jie Xue (@JieX19)

  • Hongbin Lu (@fgtdev-hblu)

  • Frank Shen (@frankshen01)

  • Miguel Angel Munoz (@mamunozgonzalez)

  • Nicolas Thomas (@thomnico)