fortinet.fortimanager.fmgr_webproxy_forwardservergroup 模块 – 配置一个由多个转发服务器组成的转发服务器组。

注意

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

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

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

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

fortinet.fortimanager 2.0.0 中的新增功能

概要

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

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

参数

参数

注释

access_token

字符串

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

adom

字符串 / 必需

请求 url 中的参数 (adom)。

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 代码列表。

state

字符串 / 必需

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

选项

  • "present"

  • "absent"

webproxy_forwardservergroup

字典

设置的顶层参数。

affinity

字符串

启用/禁用亲缘性，将源 IP 的流量附加到指定的转发服务器，直到转发服务器亲缘性……

选项

  • "disable"

  • "enable"

group_down_option

别名: group-down-option

字符串

当转发服务器组中的所有服务器都关闭时要执行的操作

选项

  • "block"

  • "pass"

ldb_method

别名: ldb-method

字符串

负载均衡方法

选项

  • "weighted"

  • "least-session"

  • "active-passive"

name

字符串 / 必需

配置一个由一个或多个转发服务器组成的转发服务器组。

server_list

别名: server-list

列表 / 元素=字典

服务器列表。

name

字符串

转发服务器名称。

weight

整数

可以选择为加权负载均衡分配转发服务器的权重

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 有助于完成此工作。

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

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

  • 通常，当返回非零 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: Configure a forward server group consisting or multiple forward servers.
      fortinet.fortimanager.fmgr_webproxy_forwardservergroup:
        # 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, ...]
        adom: <your own value>
        state: present # <value in [present, absent]>
        webproxy_forwardservergroup:
          affinity: <value in [disable, enable]>
          group_down_option: <value in [block, pass]>
          ldb_method: <value in [weighted, least-session, active-passive]>
          name: <string>
          server_list:
            -
              name: <string>
              weight: <integer>

返回值

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

键

描述

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)