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

注意

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

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

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

要在剧本中使用它，请指定：fortinet.fortios.fortios_vpn_ipsec_manualkey_interface。

fortinet.fortios 2.0.0 中的新增功能

概要

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

字典

配置 IPsec 手动密钥。

addr_type

字符串

用于 IP 数据包的 IP 版本。

选项

  • "4"

  • "6"

auth_alg

字符串

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

选项

  • "null"

  • "md5"

  • "sha1"

  • "sha256"

  • "sha384"

  • "sha512"

auth_key

字符串

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

enc_alg

字符串

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

选项

  • "null"

  • "des"

  • "3des"

  • "aes128"

  • "aes192"

  • "aes256"

  • "aria128"

  • "aria192"

  • "aria256"

  • "seed"

enc_key

字符串

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

interface

字符串

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

ip_version

字符串

用于 VPN 接口的 IP 版本。

选项

  • "4"

  • "6"

local_gw

字符串

本地网关外部接口的 IPv4 地址。

local_gw6

字符串

VPN 网关的本地 IPv6 地址。

local_spi

字符串

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

name

字符串 / 必需

IPsec 隧道名称。

npu_offload

字符串

启用/禁用将 IPsec VPN 手动密钥会话卸载到 NPU。

选项

  • "enable"

  • "disable"

remote_gw

字符串

远程网关外部接口的 IPv4 地址。

remote_gw6

字符串

VPN 网关的远程 IPv6 地址。

remote_spi

字符串

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

备注

注意

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

  • 该模块支持 check_mode。

示例

- name: Configure IPsec manual keys.
  fortinet.fortios.fortios_vpn_ipsec_manualkey_interface:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      vpn_ipsec_manualkey_interface:
          addr_type: "4"
          auth_alg: "null"
          auth_key: "<your_own_value>"
          enc_alg: "null"
          enc_key: "<your_own_value>"
          interface: "<your_own_value> (source system.interface.name)"
          ip_version: "4"
          local_gw: "<your_own_value>"
          local_gw6: "<your_own_value>"
          local_spi: "<your_own_value>"
          name: "default_name_13"
          npu_offload: "enable"
          remote_gw: "<your_own_value>"
          remote_gw6: "<your_own_value>"
          remote_spi: "<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"

版本

字符串

FortiGate 版本

返回：始终

示例： "v5.6.3"

作者

  • Link Zheng (@chillancezen)

  • 薛杰 (@JieX19)

  • 卢洪斌 (@fgtdev-hblu)

  • 沈方 (@frankshen01)

  • Miguel Angel Munoz (@mamunozgonzalez)

  • Nicolas Thomas (@thomnico)