fortinet.fortimanager.fmgr_firewall_vip_dynamicmapping_realservers 模块 – 选择此服务器负载均衡 VIP 将向其分发流量的真实服务器。

注意

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

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

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

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

fortinet.fortimanager 2.0.0 中的新增功能

概要

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

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

参数

参数

注释

access_token

字符串

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

adom

字符串 / 必需

请求 URL 中的参数 (adom)。

bypass_validation

布尔值

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

选项

  • false ← (默认)

  • true

dynamic_mapping

字符串 / 必需

请求 URL 中的参数 (dynamic_mapping)。

enable_log

布尔值

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

选项

  • false ← (默认)

  • true

firewall_vip_dynamicmapping_realservers

字典

设置的顶级参数。

address

字符串

地址。

client_ip

别名：client-ip

任意

(列表) 客户端 IP。

health_check_proto

别名：health-check-proto

字符串

健康检查协议。

选项

  • "ping"

  • "http"

healthcheck

字符串

健康检查。

选项

  • "disable"

  • "enable"

  • "vip"

holddown_interval

别名：holddown-interval

整数

保持时间间隔。

http_host

别名：http-host

字符串

HTTP 主机。

id

整数

ID。

ip

字符串

IP。

max_connections

别名：max-connections

整数

最大连接数。

monitor

任意

(列表或字符串) 监控。

port

整数

端口。

seq

整数 / 必需

序列。

status

字符串

状态。

选项

  • "active"

  • "standby"

  • "disable"

translate_host

别名：translate-host

字符串

启用/禁用从虚拟服务器到真实服务器的主机名/IP 转换。

选项

  • "disable"

  • "enable"

type

字符串

类型。

选项

  • "ip"

  • "address"

weight

整数

权重。

forticloud_access_token

字符串

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

proposed_method

字符串

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

选项

  • "update"

  • "set"

  • "add"

rc_failed

列表 / 元素=整数

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

rc_succeeded

列表 / 元素=整数

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

state

字符串 / 必需

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

选项

  • "present"

  • "absent"

vip

字符串 / 必需

请求 URL 中的参数 (vip)。

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 (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: Select the real servers that this server load balancing VIP will distribute traffic to.
      fortinet.fortimanager.fmgr_firewall_vip_dynamicmapping_realservers:
        # 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>
        vip: <your own value>
        dynamic_mapping: <your own value>
        state: present # <value in [present, absent]>
        firewall_vip_dynamicmapping_realservers:
          client_ip: <list or string>
          healthcheck: <value in [disable, enable, vip]>
          holddown_interval: <integer>
          http_host: <string>
          ip: <string>
          max_connections: <integer>
          monitor: <list or string>
          port: <integer>
          seq: <integer>
          status: <value in [active, standby, disable]>
          weight: <integer>
          address: <string>
          id: <integer>
          type: <value in [ip, address]>
          translate_host: <value in [disable, enable]>
          health_check_proto: <value in [ping, http]>

返回值

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

键

描述

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 版本支持，则会发出警告。

返回： 复杂类型

作者

  • 杜欣伟 (@dux-fortinet)

  • 李星 (@lix-fortinet)

  • 薛杰 (@JieX19)

  • 郑琳 (@chillancezen)

  • 沈方 (@fshen01)

  • 陆洪斌 (@fgtdev-hblu)