fortinet.fortios.fortios_system_speed_test_schedule 模块 – Fortinet FortiOS 和 FortiGate 中每个接口的速度测试计划。

注意

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

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

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

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

在 fortinet.fortios 2.0.0 中新增

概要

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

字典

每个接口的速度测试计划。

ctrl_port

整数

控制器用于获取访问令牌的端口。

diffserv

字符串

用于速度测试的 DSCP。

dynamic_server

字符串

启用/禁用动态服务器选项。

选项

  • "disable"

  • "enable"

interface

字符串 / 必需

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

mode

字符串

用于速度测试的协议 Auto（默认）、TCP 或 UDP。

选项

  • "UDP"

  • "TCP"

  • "Auto"

schedules

列表 / 元素=字典

接口的计划。

name

字符串 / 必需

防火墙重复计划的名称。源 firewall.schedule.recurring.name。

server_name

字符串

速度测试服务器名称。

server_port

整数

运行速度测试的服务器端口。

status

字符串

启用/禁用计划的速度测试。

选项

  • "disable"

  • "enable"

update_inbandwidth

字符串

启用/禁用绕过接口的入站带宽设置。

选项

  • "disable"

  • "enable"

update_inbandwidth_maximum

整数

速度测试中要使用的最大下载带宽 (kbps)。

update_inbandwidth_minimum

整数

要被认为有效的最小下载带宽 (kbps)。

update_outbandwidth

字符串

启用/禁用绕过接口的出站带宽设置。

选项

  • "disable"

  • "enable"

update_outbandwidth_maximum

整数

速度测试中要使用的最大上传带宽 (kbps)。

update_outbandwidth_minimum

整数

要被认为有效的最小上传带宽 (kbps)。

update_shaper

字符串

根据测试结果设置出口整形器。

选项

  • "disable"

  • "local"

  • "remote"

  • "both"

vdom

字符串

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

默认值： "root"

注意

注意

  • 传统的 fortiosapi 已被弃用，httpapi 是运行 playbook 的首选方式

示例

- name: Speed test schedule for each interface.
  fortinet.fortios.fortios_system_speed_test_schedule:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      system_speed_test_schedule:
          ctrl_port: "5200"
          diffserv: "<your_own_value>"
          dynamic_server: "disable"
          interface: "<your_own_value> (source system.interface.name)"
          mode: "UDP"
          schedules:
              -
                  name: "default_name_9 (source firewall.schedule.recurring.name)"
          server_name: "<your_own_value>"
          server_port: "5201"
          status: "disable"
          update_inbandwidth: "disable"
          update_inbandwidth_maximum: "0"
          update_inbandwidth_minimum: "0"
          update_outbandwidth: "disable"
          update_outbandwidth_maximum: "0"
          update_outbandwidth_minimum: "0"
          update_shaper: "disable"

返回值

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

键

描述

build

字符串

Fortigate 映像的构建号

返回值： 始终

示例： "1547"

http_method

字符串

最后用于将内容置备到 FortiGate 的方法

返回值： 始终

示例： "PUT"

http_status

字符串

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

返回值： 始终

示例： "200"

mkey

字符串

上次调用 FortiGate 时使用的主键 (id)

返回值： 成功

示例： "id"

name

字符串

用于满足请求的表的名称

返回值： 始终

示例： "urlfilter"

路径

字符串

用于满足请求的表的路径

返回值： 始终

示例： "webfilter"

修订版本

字符串

内部修订号

返回值： 始终

示例： "17.0.2.10658"

序列号

字符串

设备的序列号

返回值： 始终

示例： "FGVMEVYYQT3AB5352"

status

字符串

操作结果的指示

返回值： 始终

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