fortinet.fortimanager.fmgr_system_ha 模块 – HA 配置。

注意

此模块是 fortinet.fortimanager 集合（版本 2.8.2）的一部分。

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

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

要在 playbook 中使用它，请指定： fortinet.fortimanager.fmgr_system_ha。

在 fortinet.fortimanager 1.0.0 中新增

概要

  • 此模块能够配置 FortiManager 设备。

  • 示例包括所有参数和值，这些参数和值需要在使用前调整为数据源。

参数

参数

注释

access_token

字符串

无需使用用户名和密码即可访问 FortiManager 的令牌。

bypass_validation

布尔值

仅当模块模式与 FortiManager API 结构不同时才设置为 True，模块将继续执行而不验证参数。

选项

  • false ←（默认）

  • true

enable_log

布尔值

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

选项

  • false ←（默认）

  • true

forticloud_access_token

字符串

使用 forticloud API 访问令牌验证 Ansible 客户端。

proposed_method

字符串

底层 Json RPC 请求的重写方法。

选项

  • "update"

  • "set"

  • "add"

rc_failed

列表 / 元素=整数

将覆盖失败条件的 rc 代码列表。

rc_succeeded

列表 / 元素=整数

将覆盖成功条件的 rc 代码列表。

system_ha

字典

设置的顶层参数。

clusterid

整数

集群 ID 范围

failover_mode

别名：failover-mode

字符串

HA 故障转移模式。

manual - 手动故障转移

vrrp - 使用 VRRP

选项

  • "manual"

  • "vrrp"

file_quota

别名：file-quota

整数

文件配额，单位为 MB

hb_interval

别名：hb-interval

整数

心跳间隔

hb_lost_threshold

别名：hb-lost-threshold

整数

心跳丢失阈值

local_cert

别名：local-cert

字符串

设置 ha 本地证书。

mode

字符串

模式。

standalone - 独立。

master - 主。

slave - 从。

选项

  • "standalone"

  • "master"

  • "slave"

  • "primary"

  • "secondary"

monitored_interfaces

别名：monitored-interfaces

列表 / 元素=字典

受监控的接口。

interface_name

别名：interface-name

字符串

接口名称。

monitored_ips

别名：monitored-ips

列表 / 元素=字典

受监控的 IP。

id

整数

ID。

interface

字符串

接口名称。

ip

字符串

IP 地址。

password

任何

（列表）组密码。

peer

列表 / 元素=字典

对等方。

id

整数

ID。

ip

字符串

对等方的 IP 地址。

ip6

字符串

IP 地址

serial_number

别名：serial-number

字符串

对等方的序列号。

status

字符串

对等方管理状态。

disable - 禁用。

enable - 启用。

选项

  • "disable"

  • "enable"

priority

整数

运行时优先级 [1

unicast

字符串

对 VRRP 消息使用单播。

disable - 禁用。

enable - 启用。

选项

  • "disable"

  • "enable"

vip

字符串

虚拟 IP。

vip_interface

别名：vip-interface

字符串

Vip 接口。

vrrp_adv_interval

别名：vrrp-adv-interval

整数

VRRP 通告间隔 [1 - 30 秒]

vrrp_interface

别名：vrrp-interface

字符串

VRRP 和 vip 接口。

workspace_locking_adom

字符串

要为在工作区模式下运行的 FortiManager 锁定的 ADOM，该值可以是全局的和其他的，包括 root。

workspace_locking_timeout

整数

等待其他用户释放工作区锁定的最大时间（以秒为单位）。

默认值： 300

备注

注意

  • 从版本 2.4.0 开始，所有输入参数都使用下划线命名约定 (snake_case) 命名。请将 “var-name” 等参数更改为 “var_name”。旧参数名称仍然可用，但您会收到弃用警告。您可以通过在 ansible.cfg 中设置 deprecation_warnings=False 来忽略此警告。

  • 此 FortiManager 模块支持在工作区锁定模式下运行，顶层参数 workspace_locking_adom 和 workspace_locking_timeout 可帮助完成工作。

  • 通常，当返回非零 rc 时，运行一个模块可能会失败。您还可以使用参数 rc_failed 和 rc_succeeded 覆盖失败或成功的条件

示例

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: HA configuration.
      fortinet.fortimanager.fmgr_system_ha:
        # bypass_validation: false
        workspace_locking_adom: <value in [global, custom adom including root]>
        workspace_locking_timeout: 300
        # rc_succeeded: [0, -2, -3, ...]
        # rc_failed: [-2, -3, ...]
        system_ha:
          clusterid: <integer>
          file_quota: <integer>
          hb_interval: <integer>
          hb_lost_threshold: <integer>
          mode: <value in [standalone, master, slave, ...]>
          password: <list or string>
          peer:
            -
              id: <integer>
              ip: <string>
              ip6: <string>
              serial_number: <string>
              status: <value in [disable, enable]>
          local_cert: <string>
          failover_mode: <value in [manual, vrrp]>
          monitored_interfaces:
            -
              interface_name: <string>
          monitored_ips:
            -
              id: <integer>
              interface: <string>
              ip: <string>
          priority: <integer>
          unicast: <value in [disable, enable]>
          vip: <string>
          vrrp_adv_interval: <integer>
          vrrp_interface: <string>
          vip_interface: <string>

返回值

通用返回值在这里有文档记录，以下是此模块特有的字段

键

描述

meta

字典

请求的结果。

返回： 始终

request_url

字符串

请求的完整 URL。

返回： 始终

示例： "/sys/login/user"

response_code

整数

API 请求的状态。

返回： 始终

示例： 0

response_data

列表 / 元素=字符串

API 响应。

返回： 始终

response_message

字符串

API 响应的描述性消息。

返回： 始终

示例： "OK."

system_information

字典

目标系统的信息。

返回： 始终

rc

整数

请求的状态。

返回： 始终

示例： 0

version_check_warning

列表 / 元素=字符串

如果 playbook 中使用的参数不受当前 FortiManager 版本支持，则发出警告。

返回： 复杂

作者

  • Xinwei Du (@dux-fortinet)

  • Xing Li (@lix-fortinet)

  • Jie Xue (@JieX19)

  • Link Zheng (@chillancezen)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)