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"

status

字符串

操作结果的指示

返回值：始终

示例： "success"

vdom

字符串

使用的虚拟域

返回值：始终

示例： "root"

version

字符串

FortiGate 的版本

返回值：始终

示例： "v5.6.3"

作者

  • Link Zheng (@chillancezen)

  • Jie Xue (@JieX19)

  • Hongbin Lu (@fgtdev-hblu)

  • Frank Shen (@frankshen01)

  • Miguel Angel Munoz (@mamunozgonzalez)

  • Nicolas Thomas (@thomnico)