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

注意

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

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

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

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

fortinet.fortios 2.0.0 中的新增功能

概要

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

字典

配置 VXLAN 设备。

dstport

整数

VXLAN 目标端口 (1 - 65535)。

evpn_id

整数

EVPN 实例。源 system.evpn.id。

interface

字符串

用于 VXLAN 封装流量的传出接口。源 system.interface.name。

ip_version

字符串

用于 VXLAN 接口以及通过 VXLAN 进行通信的 IP 版本。IPv4 或 IPv6 单播或多播。

选项

  • "ipv4-unicast"

  • "ipv6-unicast"

  • "ipv4-multicast"

  • "ipv6-multicast"

learn_from_traffic

字符串

启用/禁用从流量学习 VXLAN MAC。

选项

  • "enable"

  • "disable"

multicast_ttl

整数

VXLAN 多播 TTL (1-255)。

name

字符串 / 必填

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

remote_ip

列表 / elements=dictionary

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

ip

字符串 / 必填

IPv4 地址。

remote_ip6

列表 / elements=dictionary

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

ip6

字符串 / 必填

IPv6 地址。

vni

整数

VXLAN 网络 ID。

vdom

字符串

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

默认值： "root"

注意

注意

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

  • 该模块支持 check_mode。

示例

- name: Configure VXLAN devices.
  fortinet.fortios.fortios_system_vxlan:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      system_vxlan:
          dstport: "4789"
          evpn_id: "0"
          interface: "<your_own_value> (source system.interface.name)"
          ip_version: "ipv4-unicast"
          learn_from_traffic: "enable"
          multicast_ttl: "0"
          name: "default_name_9"
          remote_ip:
              -
                  ip: "<your_own_value>"
          remote_ip6:
              -
                  ip6: "<your_own_value>"
          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

字符串

设备的序列号

返回：始终

示例： "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)