fortinet.fortios.fortios_vpn_ssl_client 模块 – Fortinet FortiOS 和 FortiGate 中的客户端。

注意

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

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

要安装它，请使用：ansible-galaxy collection install fortinet.fortios。您需要其他要求才能使用此模块，有关详细信息，请参阅 要求。

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

fortinet.fortios 2.0.0 中的新增功能

概要

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

要求

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

• ansible>=2.15

参数

参数	注释
access_token 字符串	基于令牌的身份验证。从 FortiGate 的 GUI 生成。
enable_log 布尔值	启用/禁用任务日志记录。 选项 false ←（默认） true
member_path 字符串	要操作的成员属性路径。 如果存在多个属性，则用斜杠字符分隔。 标记有 member_path 的参数对于执行成员操作是合法的。
member_state 字符串	在指定的属性路径下添加或删除成员。 当指定 member_state 时，将忽略 state 选项。 选项 "present" "absent"
state 字符串 / 必需	指示是创建还是删除对象。 选项 "present" "absent"
vdom 字符串	虚拟域，在先前定义的那些之中。vdom 是 FortiGate 的虚拟实例，可以配置并用作不同的单元。 默认值： "root"
vpn_ssl_client 字典	客户端。
certificate 字符串	如果 SSL-VPN 服务器请求证书，则提供给它的证书。来源 vpn.certificate.local.name。
class_id 整数	流量类别 ID。来源 firewall.traffic-class.class-id。
comment 字符串	注释。
distance 整数	SSL-VPN 添加的路由的距离 (1 - 255)。
interface 字符串	用于发送/接收流量的 SSL 接口。来源 system.interface.name。
ipv4_subnets 字符串	客户端正在保护的 IPv4 子网。来源 firewall.address.name firewall.addrgrp.name。
ipv6_subnets 字符串	客户端正在保护的 IPv6 子网。来源 firewall.address6.name firewall.addrgrp6.name。
name 字符串 / 必需	SSL-VPN 隧道名称。
peer 字符串	使用 peer/peergrp 验证对等证书。来源 user.peer.name user.peergrp.name。
port 整数	SSL-VPN 服务器端口。
priority 整数	SSL-VPN 添加的路由的优先级 (1 - 65535)。
psk 字符串	用于与服务器进行身份验证的预共享密钥（ASCII 字符串或带有前导 0x 的十六进制编码）。
realm 字符串	在 SSL-VPN 服务器上配置的领域名称。
server 字符串	SSL-VPN 服务器的 IPv4、IPv6 或 DNS 地址。
source_ip 字符串	用作与服务器的 SSL-VPN 连接源的 IPv4 或 IPv6 地址。
status 字符串	启用/禁用此 SSL-VPN 客户端配置。 选项 "enable" "disable"
user 字符串	提供给对等方以验证客户端的用户名。

注意

注意

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

示例

- name: Client.
  fortinet.fortios.fortios_vpn_ssl_client:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      vpn_ssl_client:
          certificate: "<your_own_value> (source vpn.certificate.local.name)"
          class_id: "0"
          comment: "Comment."
          distance: "10"
          interface: "<your_own_value> (source system.interface.name)"
          ipv4_subnets: "<your_own_value> (source firewall.address.name firewall.addrgrp.name)"
          ipv6_subnets: "<your_own_value> (source firewall.address6.name firewall.addrgrp6.name)"
          name: "default_name_10"
          peer: "<your_own_value> (source user.peer.name user.peergrp.name)"
          port: "443"
          priority: "1"
          psk: "<your_own_value>"
          realm: "<your_own_value>"
          server: "192.168.100.40"
          source_ip: "84.230.14.43"
          status: "enable"
          user: "<your_own_value>"

返回值

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

键	描述
build 字符串	Fortigate 镜像的内部版本号 返回： 始终 示例： "1547"
http_method 字符串	上次用于将内容置备到 FortiGate 中的方法 返回： 始终 示例： "PUT"
http_status 字符串	FortiGate 在上次应用的操作中给出的最后一个结果 返回： 始终 示例： "200"
mkey 字符串	上次调用 FortiGate 时使用的主键 (id) 返回： 成功 示例： "id"
name 字符串	用于满足请求的表名称 返回： 始终 示例： "urlfilter"
path 字符串	用于满足请求的表路径 返回： 始终 示例： "webfilter"
修订版本 字符串	内部修订号 返回： 始终 示例： "17.0.2.10658"
序列号 字符串	设备的序列号 返回： 始终 示例： "FGVMEVYYQT3AB5352"
status 字符串	操作结果的指示 返回： 始终 示例： "success"
vdom 字符串	使用的虚拟域 返回： 始终 示例： "root"
版本 字符串	FortiGate 的版本 返回： 始终 示例： "v5.6.3"

作者

• Link Zheng (@chillancezen)

• Jie Xue (@JieX19)

• Hongbin Lu (@fgtdev-hblu)

• Frank Shen (@frankshen01)

• Miguel Angel Munoz (@mamunozgonzalez)

• Nicolas Thomas (@thomnico)

集合链接

• 问题跟踪器
• 主页
• 存储库（源代码）