fortinet.fortios.fortios_system_gre_tunnel 模块 – 在 Fortinet 的 FortiOS 和 FortiGate 中配置 GRE 隧道。

注意

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

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

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

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

fortinet.fortios 2.0.0 中的新增功能

概要

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

system_gre_tunnel

字典

配置 GRE 隧道。

auto_asic_offload

字符串

启用/禁用自动 ASIC 卸载。

选项

  • "enable"

  • "disable"

checksum_reception

字符串

启用/禁用验证接收到的 GRE 数据包中的校验和。

选项

  • "disable"

  • "enable"

checksum_transmission

字符串

启用/禁用在发送的 GRE 数据包中包含校验和。

选项

  • "disable"

  • "enable"

diffservcode

字符串

要应用于 GRE 隧道外部 IP 头部的 DiffServ 设置。

dscp_copying

字符串

启用/禁用 DSCP 复制。

选项

  • "disable"

  • "enable"

interface

字符串

接口名称。源 system.interface.name。

ip_version

字符串

用于 VPN 接口的 IP 版本。

选项

  • "4"

  • "6"

keepalive_failtimes

整数

在将 GRE 连接视为关闭之前，连续未返回的 keepalive 消息数 (1 - 255)。

keepalive_interval

整数

Keepalive 消息间隔 (0 - 32767，0 = 禁用)。

key_inbound

整数

要求接收到的 GRE 数据包包含此密钥 (0 - 4294967295)。

key_outbound

整数

在发送的 GRE 数据包中包含此密钥 (0 - 4294967295)。

local_gw

字符串

本地网关的 IP 地址。

local_gw6

字符串

本地网关的 IPv6 地址。

name

字符串 / 必需

隧道名称。

remote_gw

字符串

远程网关的 IP 地址。

remote_gw6

字符串

远程网关的 IPv6 地址。

sequence_number_reception

字符串

启用/禁用验证接收到的 GRE 数据包中的序列号。

选项

  • "disable"

  • "enable"

sequence_number_transmission

字符串

启用/禁用在发送的 GRE 数据包中包含序列号。

选项

  • "disable"

  • "enable"

use_sdwan

字符串

启用/禁用使用 SD-WAN 来访问远程网关。

选项

  • "disable"

  • "enable"

vdom

字符串

虚拟域，在先前定义的那些虚拟域中。vdom 是 FortiGate 的虚拟实例，可以将其配置并用作不同的单元。

默认： "root"

备注

注意

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

  • 此模块支持 check_mode。

示例

- name: Configure GRE tunnel.
  fortinet.fortios.fortios_system_gre_tunnel:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      system_gre_tunnel:
          auto_asic_offload: "enable"
          checksum_reception: "disable"
          checksum_transmission: "disable"
          diffservcode: "<your_own_value>"
          dscp_copying: "disable"
          interface: "<your_own_value> (source system.interface.name)"
          ip_version: "4"
          keepalive_failtimes: "10"
          keepalive_interval: "0"
          key_inbound: "0"
          key_outbound: "0"
          local_gw: "<your_own_value>"
          local_gw6: "<your_own_value>"
          name: "default_name_16"
          remote_gw: "<your_own_value>"
          remote_gw6: "<your_own_value>"
          sequence_number_reception: "disable"
          sequence_number_transmission: "disable"
          use_sdwan: "disable"

返回值

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

键

描述

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"

作者

  • 郑琳 (@chillancezen)

  • 薛杰 (@JieX19)

  • 陆洪斌 (@fgtdev-hblu)

  • 沈芳 (@frankshen01)

  • Miguel Angel Munoz (@mamunozgonzalez)

  • Nicolas Thomas (@thomnico)