fortinet.fortios.fortios_vpn_qkd 模块 – 在 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_qkd

在 fortinet.fortios 2.0.0 中新增

概要

  • 此模块能够通过允许用户设置和修改 vpn 功能和 qkd 类别来配置 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_qkd

字典

配置量子密钥分发服务器

certificate

列表 / elements=dictionary

最多 4 个要提供给 KME 的证书的名称。

name

字符串 / 必需

证书名称。源 vpn.certificate.local.name。

comment

字符串

注释。

id

字符串

由 KME 分配的量子密钥分发 ID。

name

字符串 / 必需

量子密钥分发配置名称。

peer

字符串

使用对等/peergrp 验证量子密钥设备”的证书。源 user.peer.name user.peergrp.name。

port

整数

连接到 KME 的端口。

server

字符串

KME 的 IPv4、IPv6 或 DNS 地址。

注释

注意

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

示例

- name: Configure Quantum Key Distribution servers
  fortinet.fortios.fortios_vpn_qkd:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      vpn_qkd:
          certificate:
              -
                  name: "default_name_4 (source vpn.certificate.local.name)"
          comment: "Comment."
          id: "6"
          name: "default_name_7"
          peer: "<your_own_value> (source user.peer.name user.peergrp.name)"
          port: "0"
          server: "192.168.100.40"

返回值

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

描述

build

字符串

FortiGate 映像的构建号

返回: 总是

示例: "1547"

http_method

字符串

上次用于将内容配置到 FortiGate 中的方法

返回: 总是

示例: "PUT"

http_status

字符串

上次应用操作时 FortiGate 给出的最后结果

返回: 总是

示例: "200"

mkey

字符串

上次调用 FortiGate 时使用的主密钥(id)

返回: 成功

示例: "id"

name

字符串

用于满足请求的表名称

返回: 总是

示例: "urlfilter"

path

字符串

用于满足请求的表的路径

返回: 总是

示例: "webfilter"

revision

字符串

内部修订号

返回: 总是

示例: "17.0.2.10658"

序列号

字符串

设备的序列号

返回: 总是

示例: "FGVMEVYYQT3AB5352"

状态

字符串

操作结果的指示

返回: 总是

示例: "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)