fortinet.fortimanager.fmgr_firewall_accessproxy6_apigateway_realservers 模块 – 选择此访问代理将向其分发流量的实际服务器。

注意

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

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

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

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

fortinet.fortimanager 2.2.0 中的新增功能

概要

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

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

参数

参数

注释

access-proxy6

字符串

已弃用，请使用“access_proxy6”

access_proxy6

字符串

请求 URL 中的参数 (access-proxy6)。

access_token

字符串

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

adom

字符串 / 必填

请求 URL 中的参数 (adom)。

api-gateway

字符串

已弃用，请使用“api_gateway”

api_gateway

字符串

请求 URL 中的参数 (api-gateway)。

bypass_validation

布尔值

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

选项

  • false ← (默认)

  • true

enable_log

布尔值

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

选项

  • false ← (默认)

  • true

firewall_accessproxy6_apigateway_realservers

字典

设置的顶级参数。

addr_type

别名：addr-type

字符串

地址类型。

选项

  • "fqdn"

  • "ip"

address

字符串

实际服务器的地址或地址组。

domain

字符串

实际服务器的通配符域名。

external_auth

别名：external-auth

字符串

启用/禁用使用外部浏览器作为 SAML 用户身份验证的用户代理。

选项

  • "disable"

  • "enable"

health_check

别名：health-check

字符串

启用检查实际服务器在转发流量之前的响应能力。

选项

  • "disable"

  • "enable"

health_check_proto

别名：health-check-proto

字符串

轮询以确定服务器连接状态时要使用的运行状况检查监视器的协议。

选项

  • "ping"

  • "http"

  • "tcp-connect"

holddown_interval

别名：holddown-interval

字符串

启用/禁用保持时间计时器。

选项

  • "disable"

  • "enable"

http_host

别名：http-host

字符串

HTTP 头中的 HTTP 服务器域名。

id

整数 / 必填

实际服务器 ID。

ip

字符串

实际服务器的 IP 地址。

mappedport

任意

(列表或字符串) 与实际服务器通信的端口。

port

整数

与实际服务器通信的端口。

ssh_client_cert

别名：ssh-client-cert

字符串

设置访问代理 SSH 客户端证书配置文件。

ssh_host_key

别名：ssh-host-key

任意

(列表) 一个或多个服务器主机密钥。

ssh_host_key_validation

别名：ssh-host-key-validation

字符串

启用/禁用 SSH 实际服务器主机密钥验证。

选项

  • "disable"

  • "enable"

status

字符串

将实际服务器的状态设置为活动状态，以便它可以接受流量，或者设置为备用或禁用状态，以便不发送流量。

选项

  • "active"

  • "standby"

  • "disable"

translate_host

别名：translate-host

字符串

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

选项

  • "disable"

  • "enable"

tunnel_encryption

别名：tunnel-encryption

字符串

隧道加密。

选项

  • "disable"

  • "enable"

type

字符串

TCP 转发服务器类型。

选项

  • "tcp-forwarding"

  • "ssh"

weight

整数

实际服务器的权重。

forticloud_access_token

字符串

使用 forticloud API 访问令牌对 Ansible 客户端进行身份验证。

proposed_method

字符串

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

选项

  • "update"

  • "set"

  • 添加

rc_failed

列表 / 元素=整数

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

rc_succeeded

列表 / 元素=整数

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

状态

字符串 / 必填

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

选项

  • 存在

  • 不存在

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 Access Proxy will distribute traffic to.
      fortinet.fortimanager.fmgr_firewall_accessproxy6_apigateway_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>
        access_proxy6: <your own value>
        api_gateway: <your own value>
        state: present # <value in [present, absent]>
        firewall_accessproxy6_apigateway_realservers:
          addr_type: <value in [fqdn, ip]>
          address: <string>
          domain: <string>
          health_check: <value in [disable, enable]>
          health_check_proto: <value in [ping, http, tcp-connect]>
          holddown_interval: <value in [disable, enable]>
          http_host: <string>
          id: <integer>
          ip: <string>
          mappedport: <list or string>
          port: <integer>
          ssh_client_cert: <string>
          ssh_host_key: <list or string>
          ssh_host_key_validation: <value in [disable, enable]>
          status: <value in [active, standby, disable]>
          type: <value in [tcp-forwarding, ssh]>
          weight: <integer>
          translate_host: <value in [disable, enable]>
          external_auth: <value in [disable, enable]>
          tunnel_encryption: <value in [disable, enable]>

返回值

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

键

描述

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)