fortinet.fortimanager.fmgr_firewall_ldbmonitor 模块 – 配置服务器负载均衡健康检查。

注意

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

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

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

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

fortinet.fortimanager 2.0.0 中的新增功能

概要

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

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

参数

参数

注释

access_token

字符串

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

adom

字符串 / 必需

请求URL中的参数 (adom)。

bypass_validation

布尔值

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

选项

  • false ← (默认)

  • true

enable_log

布尔值

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

选项

  • false ← (默认)

  • true

firewall_ldbmonitor

字典

设置的顶级参数。

dns_match_ip

别名：dns-match-ip

字符串

DNS服务器期望的响应IP。

dns_protocol

别名：dns-protocol

字符串

选择DNS健康检查监控程序用于检查服务器运行状况的协议

选项

  • "udp"

  • "tcp"

dns_request_domain

别名：dns-request-domain

字符串

要为DNS探测解析的完全限定域名。

http_get

别名：http-get

字符串

用于发送GET请求以检查HTTP服务器运行状况的URL。

http_match

别名：http-match

字符串

与HTTP-GET请求响应中预期值匹配的字符串。

http_max_redirects

别名：http-max-redirects

整数

允许的最大HTTP重定向次数

interval

整数

健康检查之间的时间间隔

name

字符串 / 必需

监控器名称。

port

整数

用于执行健康检查的服务端口。

retry

整数

在服务器被认为已关闭之前的健康检查尝试次数

src_ip

别名：src-ip

字符串

ldb-monitor 的源 IP。

timeout

整数

等待从服务器接收健康检查响应的时间。

type

字符串

选择健康检查监控程序用于检查服务器运行状况的监控器类型

选项

  • "ping"

  • "tcp"

  • "http"

  • "passive-sip"

  • "https"

  • "dns"

forticloud_access_token

字符串

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

proposed_method

字符串

底层 Json RPC 请求的覆盖方法。

选项

  • "update"

  • "set"

  • "add"

rc_failed

列表 / 元素=整数

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

rc_succeeded

列表 / 元素=整数

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

state

字符串 / 必需

创建、更新或删除对象的指令。

选项

  • "present"

  • "absent"

workspace_locking_adom

字符串

在工作区模式下运行 FortiManager 时要锁定的 adom，该值可以是 global 和其他值，包括 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 有助于完成此工作。

  • 要创建或更新对象，请使用 state present 指令。

  • 要删除对象，请使用 state absent 指令。

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

示例

- name: Example playbook
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Configure server load balancing health monitors.
      fortinet.fortimanager.fmgr_firewall_ldbmonitor:
        bypass_validation: false
        adom: ansible
        state: present
        firewall_ldbmonitor:
          name: "ansible-test"
          port: 1
          type: tcp # <value in [ping, tcp, http, ...]>

- name: Gathering fortimanager facts
  hosts: fortimanagers
  gather_facts: false
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Retrieve all the server load balancing health monitors
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "firewall_ldbmonitor"
          params:
            adom: "ansible"
            ldb-monitor: "your_value"

返回值

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

键

描述

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

列表 / 元素=字符串

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

返回值： 复杂类型

作者

  • 杜欣伟 (@dux-fortinet)

  • 李星 (@lix-fortinet)

  • 薛杰 (@JieX19)

  • 郑林 (@chillancezen)

  • 沈芳 (@fshen01)

  • 陆洪斌 (@fgtdev-hblu)