fortinet.fortios.fortios_vpn_ipsec_manualkey 模块 – 在 Fortinet 的 FortiOS 和 FortiGate 中配置 IPsec 手动密钥。

注意

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

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

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

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

fortinet.fortios 2.0.0 中的新增功能

概要

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

字典

配置 IPsec 手动密钥。

authentication

字符串

身份验证算法。必须与隧道的两端相同。

选项

  • "null"

  • "md5"

  • "sha1"

  • "sha256"

  • "sha384"

  • "sha512"

authkey

字符串

16 位（8 字节）段的十六进制身份验证密钥，用连字符分隔。

enckey

字符串

16 位（8 字节）段的十六进制加密密钥，用连字符分隔。

encryption

字符串

加密算法。必须与隧道的两端相同。

选项

  • "null"

  • "des"

  • "3des"

  • "aes128"

  • "aes192"

  • "aes256"

  • "aria128"

  • "aria192"

  • "aria256"

  • "seed"

interface

字符串

物理、聚合或 VLAN 接口的名称。源 system.interface.name。

local_gw

字符串

本地网关。

localspi

字符串

本地 SPI，一个十六进制 8 位（4 字节）标签。区分具有不同加密规则的两个流量流。

name

字符串 / 必需

IPsec 隧道名称。

npu_offload

字符串

启用/禁用 NPU 卸载。

选项

  • "enable"

  • "disable"

remote_gw

字符串

对端网关。

remotespi

字符串

远程 SPI，一个十六进制 8 位（4 字节）标签。区分具有不同加密规则的两个流量流。

备注

注意

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

  • 此模块支持 check_mode。

示例

- name: Configure IPsec manual keys.
  fortinet.fortios.fortios_vpn_ipsec_manualkey:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      vpn_ipsec_manualkey:
          authentication: "null"
          authkey: "<your_own_value>"
          enckey: "<your_own_value>"
          encryption: "null"
          interface: "<your_own_value> (source system.interface.name)"
          local_gw: "<your_own_value>"
          localspi: "<your_own_value>"
          name: "default_name_10"
          npu_offload: "enable"
          remote_gw: "<your_own_value>"
          remotespi: "<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"

状态

字符串

操作结果指示

返回： 始终

示例： "success"

vdom

字符串

使用的虚拟域

返回： 始终

示例： "root"

版本

字符串

FortiGate版本

返回： 始终

示例： "v5.6.3"

作者

  • 郑链 (@chillancezen)

  • 薛杰 (@JieX19)

  • 卢洪斌 (@fgtdev-hblu)

  • 沈方 (@frankshen01)

  • 米格尔·安赫尔·穆诺斯 (@mamunozgonzalez)

  • 尼古拉斯·托马斯 (@thomnico)