fortinet.fortios.fortios_vpn_ssl_web_realm 模块 – Fortinet FortiOS 和 FortiGate 中的 Realm。

注意

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

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

要安装它，请使用： ansible-galaxy collection install fortinet.fortios。您需要更多要求才能使用此模块，请参阅 要求 以了解详细信息。

要在 playbook 中使用它，请指定： fortinet.fortios.fortios_vpn_ssl_web_realm。

fortinet.fortios 2.0.0 中的新增功能

概要

  • 此模块能够通过允许用户设置和修改 vpn_ssl_web 功能和 realm 类别来配置 FortiGate 或 FortiOS (FOS) 设备。 示例包括所有参数和值，需要在使用前调整到数据源。 使用 FOS v6.0.0 进行了测试

要求

执行此模块的主机需要满足以下要求。

  • ansible>=2.15

参数

参数

注释

access_token

string

基于令牌的身份验证。从 Fortigate 的 GUI 生成。

enable_log

boolean

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

选项

  • false ← (默认)

  • true

member_path

string

要操作的成员属性路径。

如果存在多个属性，则用斜杠字符分隔。

标记有 member_path 的参数对于执行成员操作是合法的。

member_state

string

在指定的属性路径下添加或删除成员。

当指定 member_state 时，将忽略 state 选项。

选项

  • "present"

  • "absent"

state

string / required

指示是创建还是删除对象。

选项

  • "present"

  • "absent"

vdom

string

虚拟域，在先前定义的域中。vdom 是 FortiGate 的虚拟实例，可以配置并用作不同的单元。

默认值： "root"

vpn_ssl_web_realm

dictionary

Realm。

login_page

string

SSL-VPN 登录页面的替换 HTML。

max_concurrent_user

integer

最大并发用户数（0 - 65535，0 表示无限制）。

nas_ip

string

用作 NAS-IP 与 RADIUS 服务器通信的 IP 地址。

radius_port

integer

RADIUS 服务端口号（0 - 65535，0 表示 user.radius.radius-port）。

radius_server

string

与 realm 关联的 RADIUS 服务器。源 user.radius.name。

url_path

string / required

用于访问 SSL-VPN 登录页面的 URL 路径。

virtual_host

string

realm 的虚拟主机名。

virtual_host_only

string

启用/禁用对 SSL-VPN 客户端访问的虚拟主机方法的强制执行。

选项

  • "enable"

  • "disable"

virtual_host_server_cert

string

用于此 realm 的服务器证书的名称。源 vpn.certificate.local.name。

注释

注意

  • 旧版 fortiosapi 已被弃用，httpapi 是运行 playbook 的首选方式

  • 该模块支持 check_mode。

示例

- name: Realm.
  fortinet.fortios.fortios_vpn_ssl_web_realm:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      vpn_ssl_web_realm:
          login_page: "<your_own_value>"
          max_concurrent_user: "0"
          nas_ip: "<your_own_value>"
          radius_port: "0"
          radius_server: "<your_own_value> (source user.radius.name)"
          url_path: "<your_own_value>"
          virtual_host: "myhostname"
          virtual_host_only: "enable"
          virtual_host_server_cert: "myhostname (source vpn.certificate.local.name)"

返回值

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

键

描述

build

string

fortigate 映像的构建编号

返回： 始终

示例： "1547"

http_method

string

上次用于将内容提供到 FortiGate 的方法

返回： 始终

示例： "PUT"

http_status

string

FortiGate 在上次应用的操作中给出的最后一个结果

返回： 始终

示例： "200"

mkey

string

上次调用 FortiGate 中使用的主键 (id)

返回： 成功

示例： "id"

name

string

用于满足请求的表名称

返回： 始终

示例： "urlfilter"

路径

string

用于满足请求的表的路径

返回： 始终

示例： "webfilter"

修订版本

string

内部修订号

返回： 始终

示例： "17.0.2.10658"

序列号

string

设备的序列号

返回： 始终

示例： "FGVMEVYYQT3AB5352"

状态

string

操作结果的指示

返回： 始终

示例： "success"

vdom

string

使用的虚拟域

返回： 始终

示例： "root"

版本

string

FortiGate 的版本

返回： 始终

示例： "v5.6.3"

作者

  • Link Zheng (@chillancezen)

  • Jie Xue (@JieX19)

  • Hongbin Lu (@fgtdev-hblu)

  • Frank Shen (@frankshen01)

  • Miguel Angel Munoz (@mamunozgonzalez)

  • Nicolas Thomas (@thomnico)