fortinet.fortios.fortios_system_geneve 模块 – 在 Fortinet 的 FortiOS 和 FortiGate 中配置 GENEVE 设备。

注意

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

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

要安装它,请使用:ansible-galaxy collection install fortinet.fortios。您需要进一步的要求才能使用此模块,请参阅 需求 以了解详细信息。

要在 playbook 中使用它,请指定:fortinet.fortios.fortios_system_geneve

fortinet.fortios 2.0.0 中的新增功能

概要

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

字典

配置 GENEVE 设备。

dstport

整数

GENEVE 目标端口 (1 - 65535)。

interface

字符串

GENEVE 封装流量的出站接口。源 system.interface.name。

ip_version

字符串

用于 GENEVE 接口以及通过 GENEVE 通信的 IP 版本。IPv4 或 IPv6 单播。

选项

  • "ipv4-unicast"

  • "ipv6-unicast"

name

字符串 / 必需

GENEVE 设备或接口名称。必须是唯一的接口名称。

remote_ip

字符串

GENEVE 接口在 GENEVE 远程端设备上的 IPv4 地址。

remote_ip6

字符串

GENEVE 接口在 GENEVE 远程端设备上的 IPv6 IP 地址。

type

字符串

GENEVE 类型。

选项

  • "ethernet"

  • "ppp"

vni

整数

GENEVE 网络 ID。

vdom

字符串

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

默认值: "root"

备注

注意

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

  • 该模块支持 check_mode。

示例

- name: Configure GENEVE devices.
  fortinet.fortios.fortios_system_geneve:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      system_geneve:
          dstport: "6081"
          interface: "<your_own_value> (source system.interface.name)"
          ip_version: "ipv4-unicast"
          name: "default_name_6"
          remote_ip: "<your_own_value>"
          remote_ip6: "<your_own_value>"
          type: "ethernet"
          vni: "0"

返回值

常用的返回值已在 此处 记录,以下是此模块独有的字段

描述

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

返回: 始终

设备序列号

status

字符串

操作结果指示

返回: 始终

示例: "success"

vdom

字符串

使用的虚拟域

返回: 始终

示例: "root"

版本

字符串

FortiGate 版本

返回: 始终

示例: "v5.6.3"

作者

  • Link Zheng (@chillancezen)

  • 薛杰 (@JieX19)

  • 陆洪斌 (@fgtdev-hblu)

  • 沈芳 (@frankshen01)

  • Miguel Angel Munoz (@mamunozgonzalez)

  • Nicolas Thomas (@thomnico)