fortinet.fortios.fortios_system_switch_interface 模块 – 在 Fortinet 的 FortiOS 和 FortiGate 中，通过将物理和 WiFi 接口分组来配置软件交换机接口。

注意

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

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

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

要在 Playbook 中使用它，请指定：fortinet.fortios.fortios_system_switch_interface。

fortinet.fortios 2.0.0 中的新增功能

概要

  • 此模块能够配置 FortiGate 或 FortiOS (FOS) 设备，允许用户设置和修改系统功能和 switch_interface 类别。示例包括使用前需要调整到数据源的所有参数和值。使用 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_switch_interface

字典

通过对物理和 WiFi 接口进行分组来配置软件交换机接口。

intra_switch_policy

字符串

允许交换机接口之间的任何流量，或需要防火墙策略来允许交换机接口之间的流量。

选项

  • "implicit"

  • "explicit"

mac_ttl

整数

MAC 地址在 ARP 表中保留的时间（300 - 8640000 秒）。

member

列表 / elements=dictionary

属于虚拟交换机的接口的名称。

interface_name

字符串 / 必需

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

name

字符串 / 必需

接口名称（该名称不能被任何其他接口、VLAN 或 VDOM 间链接使用）。

span

字符串

启用/禁用端口镜像。端口镜像将软件交换机接收的流量回显到镜像目标端口。

选项

  • "disable"

  • "enable"

span_dest_port

字符串

SPAN 目标端口名称。SPAN 源端口上的所有流量都回显到 SPAN 目标端口。源 system.interface.name。

span_direction

字符串

SPAN 端口运行的方向，可以是：rx、tx 或两者。

选项

  • "rx"

  • "tx"

  • "both"

span_source_port

列表 / elements=dictionary

物理接口名称。端口镜像将 SPAN 源端口上的所有流量回显到 SPAN 目标端口。

interface_name

字符串 / 必需

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

type

字符串

基于功能类型的交换机：用于正常功能的交换机，或用于将数据包复制到所有端口成员的集线器。

选项

  • "switch"

  • "hub"

vdom

字符串

软件交换机所属的 VDOM。源 system.vdom.name。

vdom

字符串

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

默认值： "root"

备注

注意

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

  • 该模块支持 check_mode。

示例

- name: Configure software switch interfaces by grouping physical and WiFi interfaces.
  fortinet.fortios.fortios_system_switch_interface:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      system_switch_interface:
          intra_switch_policy: "implicit"
          mac_ttl: "300"
          member:
              -
                  interface_name: "<your_own_value> (source system.interface.name)"
          name: "default_name_7"
          span: "disable"
          span_dest_port: "<your_own_value> (source system.interface.name)"
          span_direction: "rx"
          span_source_port:
              -
                  interface_name: "<your_own_value> (source system.interface.name)"
          type: "switch"
          vdom: "<your_own_value> (source system.vdom.name)"

返回值

通用返回值记录在此处，以下是此模块特有的字段

键

描述

build

字符串

FortiGate 镜像的内部版本号

已返回： 始终

示例： "1547"

http_method

字符串

上次用于将内容配置到 FortiGate 的方法

已返回： 始终

示例： "PUT"

http_status

字符串

FortiGate 在上次操作中给出的最后结果

已返回： 始终

示例: "200"

mkey

字符串

上次调用 FortiGate 时使用的主密钥（id）

返回: 成功

示例: "id"

name

字符串

用于满足请求的表的名称

已返回： 始终

示例: "urlfilter"

路径

字符串

用于满足请求的表的路径

已返回： 始终

示例: "webfilter"

修订版本

字符串

内部修订号

已返回： 始终

示例: "17.0.2.10658"

序列号

字符串

设备的序列号

已返回： 始终

示例: "FGVMEVYYQT3AB5352"

状态

字符串

操作结果的指示

已返回： 始终

示例: "success"

vdom

字符串

使用的虚拟域

已返回： 始终

示例: "root"

版本

字符串

FortiGate 的版本

已返回： 始终

示例: "v5.6.3"

作者

  • Link Zheng (@chillancezen)

  • Jie Xue (@JieX19)

  • Hongbin Lu (@fgtdev-hblu)

  • Frank Shen (@frankshen01)

  • Miguel Angel Munoz (@mamunozgonzalez)

  • Nicolas Thomas (@thomnico)