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

注意

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

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

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

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

fortinet.fortios 2.0.0 中的新增功能

概要

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

system_stp

字典

配置生成树协议 (STP)。

config_revision

整数

STP 配置修订号 (0 - 4294967295)。

forward_delay

整数

转发延迟 (4 - 30 秒)。

hello_time

整数

Hello 时间(1 - 10 秒)。

max_age

整数

最大数据包生存时间(6 - 40 秒)。

max_hops

整数

最大跳数 (1 - 40)。

region_name

字符串

设置区域名称。

status

字符串

启用/禁用 STP 设置。

switch_priority

字符串

STP 交换机优先级; 数字越低,优先级越高(从 0、4096、8192、12288、16384、20480、24576、28672、32768、36864、40960、45056、49152、53248 和 57344 中选择)。

选项

  • "0"

  • "4096"

  • "8192"

  • "12288"

  • "16384"

  • "20480"

  • "24576"

  • "28672"

  • "32768"

  • "36864"

  • "40960"

  • "45056"

  • "49152"

  • "53248"

  • "57344"

vdom

字符串

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

默认: "root"

注释

注意

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

示例

- name: Configure Spanning Tree Protocol (STP).
  fortinet.fortios.fortios_system_stp:
      vdom: "{{ vdom }}"
      system_stp:
          config_revision: "2147483647"
          forward_delay: "15"
          hello_time: "2"
          max_age: "20"
          max_hops: "20"
          region_name: "<your_own_value>"
          status: "<your_own_value>"
          switch_priority: "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)

  • 米格尔·安赫尔·穆尼奥斯 (@mamunozgonzalez)

  • 尼古拉斯·托马斯 (@thomnico)