fortinet.fortios.fortios_switch_controller_stp_settings 模块 – 在 Fortinet 的 FortiOS 和 FortiGate 中配置 FortiSwitch 生成树协议 (STP)。

注意

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

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

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

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

fortinet.fortios 2.0.0 中的新增功能

概要

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

switch_controller_stp_settings

字典

配置 FortiSwitch 生成树协议 (STP)。

forward_time

整数

端口处于侦听和学习状态的时间段 (4-30 秒)。

hello_time

整数

在端口上发送连续 STP 帧桥接协议数据单元 (BPDU) 之间的时间段 (1-10 秒)。

max_age

整数

桥接端口在其配置 BPDU 信息过期之前的时间 (6-40 秒)。

max_hops

整数

根桥和最远桥之间的最大跳数 (1-40)。

name

字符串

全局 STP 设置配置的名称。

pending_timer

整数

挂起时间 (1-15 秒)。

revision

整数

STP 修订号 (0-65535)。

status

字符串

启用/禁用 STP。

选项

  • "enable"

  • "disable"

vdom

字符串

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

默认值: "root"

注释

注意

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

示例

- name: Configure FortiSwitch spanning tree protocol (STP).
  fortinet.fortios.fortios_switch_controller_stp_settings:
      vdom: "{{ vdom }}"
      switch_controller_stp_settings:
          forward_time: "15"
          hello_time: "2"
          max_age: "20"
          max_hops: "20"
          name: "default_name_7"
          pending_timer: "4"
          revision: "0"
          status: "enable"

返回值

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

描述

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"

作者

  • 郑琳 (@chillancezen)

  • 薛杰 (@JieX19)

  • 卢宏斌 (@fgtdev-hblu)

  • 沈芳 (@frankshen01)

  • Miguel Angel Munoz (@mamunozgonzalez)

  • Nicolas Thomas (@thomnico)