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” |
|
请求 url 中的参数 (access-proxy6)。 |
|
在不使用用户名和密码的情况下访问 FortiManager 的令牌。 |
|
请求 url 中的参数 (adom)。 |
|
已弃用，请使用 “api_gateway” |
|
请求 url 中的参数 (api-gateway)。 |
|
仅当模块架构与 FortiManager API 结构存在差异时，才设置为 True，模块将继续执行而不验证参数。 选择
|
|
启用/禁用任务的日志记录。 选择
|
|
顶级参数集。 |
|
地址类型。 选择
|
|
真实服务器的地址或地址组。 |
|
真实服务器的通配符域名。 |
|
启用/禁用使用外部浏览器作为 SAML 用户身份验证的用户代理。 选择
|
|
启用以在转发流量之前检查真实服务器的响应能力。 选择
|
|
轮询以确定服务器连接状态时要使用的运行状况检查监视器的协议。 选择
|
|
启用/禁用保持计时器。 选择
|
|
HTTP 标头中的 HTTP 服务器域名。 |
|
真实服务器 ID。 |
|
真实服务器的 IP 地址。 |
|
(列表或字符串) 用于与真实服务器通信的端口。 |
|
用于与真实服务器通信的端口。 |
|
设置访问代理 SSH 客户端证书配置文件。 |
|
(列表) 一个或多个服务器主机密钥。 |
|
启用/禁用 SSH 真实服务器主机密钥验证。 选择
|
|
将真实服务器的状态设置为活动，以便它可以接受流量，或设置为备用或禁用，以便不发送流量。 选择
|
|
启用/禁用从虚拟服务器到真实服务器的主机名/IP 转换。 选择
|
|
隧道加密。 选择
|
|
TCP 转发服务器类型。 选择
|
|
真实服务器的权重。 |
|
使用 forticloud API 访问令牌验证 Ansible 客户端。 |
|
覆盖底层 Json RPC 请求的方法。 选择
|
|
将覆盖失败条件的返回码列表。 |
|
将覆盖成功条件的返回码列表。 |
|
创建、更新或删除对象的指令。 选择
|
|
在工作区模式下运行时，要锁定的 FortiManager 的 ADOM，该值可以是全局的或其他值，包括 root。 |
|
等待其他用户释放工作区锁定的最大时间（秒）。 默认值： |
说明
注意
从 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]>
返回值
常见的返回值记录在这里，以下是此模块特有的字段
键 |
描述 |
|---|---|
请求的结果。 返回： 始终 |
|
请求的完整 URL。 返回： 始终 示例： |
|
API 请求的状态。 返回： 始终 示例： |
|
API 响应。 返回： 始终 |
|
API 响应的描述性消息。 返回： 始终 示例： |
|
目标系统的信息。 返回： 始终 |
|
请求的状态。 返回： 始终 示例： |
|
如果 playbook 中使用的参数不受当前 FortiManager 版本支持，则会发出警告。 返回： 复杂 |