fortinet.fortios.fortios_vpn_kmip_server 模块 – 在 Fortinet 的 FortiOS 和 FortiGate 中配置 KMIP 服务器条目。

注意

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

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

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

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

fortinet.fortios 2.0.0 中的新增功能

概要

  • 此模块能够通过允许用户设置和修改 vpn 功能和 kmip_server 类别来配置 FortiGate 或 FortiOS (FOS) 设备。示例包括所有参数，在使用前需要将值调整为数据源。已在 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_kmip_server

字典

KMIP 服务器条目配置。

interface

字符串

指定到达服务器的出站接口。源系统.接口.名称。

interface_select_method

字符串

指定如何选择到达服务器的出站接口。

选项

  • "auto"

  • "sdwan"

  • "specify"

name

字符串 / 必需

KMIP 服务器条目名称。

password

字符串

用于连接到 KMIP 服务器的密码。

server_identity_check

字符串

启用/禁用 KMIP 服务器身份检查（将服务器 FQDN/IP 地址与服务器证书进行验证）。

选项

  • "enable"

  • "disable"

server_list

列表 / 元素=字典

KMIP 服务器列表。

cert

字符串

用于连接到 KMIP 服务器的客户端证书。源 vpn.certificate.local.name。

id

整数 / 必需

ID 请参见 <a href=’#notes’>备注</a>。

port

整数

KMIP 服务器端口。

server

字符串

KMIP 服务器 FQDN 或 IP 地址。

status

字符串

启用/禁用 KMIP 服务器。

选项

  • "enable"

  • "disable"

source_ip

字符串

将用于与 KMIP 服务器通信的 FortiGate IP 地址。

ssl_min_proto_version

字符串

SSL/TLS 连接支持的最低协议版本。

选项

  • "default"

  • "SSLv3"

  • "TLSv1"

  • "TLSv1-1"

  • "TLSv1-2"

  • "TLSv1-3"

username

字符串

用于连接到 KMIP 服务器的用户名。

备注

注意

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

示例

- name: KMIP server entry configuration.
  fortinet.fortios.fortios_vpn_kmip_server:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      vpn_kmip_server:
          interface: "<your_own_value> (source system.interface.name)"
          interface_select_method: "auto"
          name: "default_name_5"
          password: "<your_own_value>"
          server_identity_check: "enable"
          server_list:
              -
                  cert: "<your_own_value> (source vpn.certificate.local.name)"
                  id: "10"
                  port: "5696"
                  server: "192.168.100.40"
                  status: "enable"
          source_ip: "84.230.14.43"
          ssl_min_proto_version: "default"
          username: "<your_own_value>"

返回值

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

键

描述

build

字符串

FortiGate 镜像的版本号

返回：始终

示例： "1547"

http_method

字符串

最后用于将内容置备到 FortiGate 的方法

返回：始终

示例： "PUT"

http_status

字符串

FortiGate 在最后一次操作中返回的最终结果

返回：始终

示例： "200"

mkey

字符串

最后一次调用 FortiGate 时使用的主密钥 (ID)

返回： 成功

示例： "id"

name

字符串

用于完成请求的表名称

返回：始终

示例： "urlfilter"

path

字符串

用于完成请求的表路径

返回：始终

示例： "webfilter"

revision

字符串

内部修订号

返回：始终

示例： "17.0.2.10658"

serial

字符串

设备的序列号

返回：始终

示例： "FGVMEVYYQT3AB5352"

status

字符串

操作结果指示

返回：始终

示例： "success"

vdom

字符串

使用的虚拟域

返回：始终

示例： "root"

version

字符串

FortiGate 的版本

返回：始终

示例： "v5.6.3"

作者

  • 郑链 (@chillancezen)

  • 薛杰 (@JieX19)

  • 卢洪滨 (@fgtdev-hblu)

  • 沈方 (@frankshen01)

  • Miguel Angel Munoz (@mamunozgonzalez)

  • Nicolas Thomas (@thomnico)