fortinet.fortios.fortios_firewall_shaping_profile 模块 – 在 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_firewall_shaping_profile。

fortinet.fortios 2.0.0 中的新增功能

概要

  • 此模块能够配置 FortiGate 或 FortiOS (FOS) 设备，允许用户设置和修改防火墙功能和 shaping_profile 类别。示例包括所有参数，在使用前需要将值调整为数据源。已在 FOS v6.0.0 上测试。

需求

执行此模块的主机需要以下需求。

  • ansible>=2.15

参数

参数

注释

access_token

字符串

基于令牌的身份验证。从 FortiGate 的 GUI 生成。

enable_log

布尔值

启用/禁用任务的日志记录。

选项

  • false ← (默认)

  • true

firewall_shaping_profile

字典

配置整形配置文件。

comment

字符串

注释。

default_class_id

整数

处理未分类数据包（包括所有本地流量）的默认类 ID。来源 firewall.traffic-class.class-id。

npu_offloading

字符串

启用/禁用 NPU 卸载。

选项

  • "disable"

  • "enable"

profile_name

字符串 / 必填

整形配置文件名称。

shaping_entries

列表 / 元素=字典

定义此整形配置文件的整形条目。

burst_in_msec

整数

可以以最大带宽速度突发的字节数。公式：burst = maximum-bandwidth*burst-in-msec。

cburst_in_msec

整数

可以以接口能够传输的最快速度突发的字节数。公式：cburst = maximum-bandwidth*cburst-in-msec。

class_id

整数

类 ID。来源 firewall.traffic-class.class-id。

guaranteed_bandwidth_percentage

整数

保证带宽的百分比。

id

整数 / 必填

ID 号。参见 备注。

limit

整数

实际队列大小的硬限制（以数据包为单位）。

max

整数

RED 丢包概率最大的平均队列大小（以数据包为单位）。

maximum_bandwidth_percentage

整数

最大带宽的百分比。

min

整数

RED 丢包概率开始成为可能的平均队列大小（以数据包为单位）。

priority

字符串

优先级。

选项

  • "top"

  • "critical"

  • "high"

  • "medium"

  • "low"

red_probability

整数

RED 标记的最大概率（百分比）。

type

字符串

选择整形配置文件类型：限速/排队。

选项

  • "policing"

  • "queuing"

member_path

字符串

要操作的成员属性路径。

如果有多个属性，则以斜杠字符分隔。

标有 member_path 的参数对于执行成员操作是合法的。

member_state

字符串

在指定的属性路径下添加或删除成员。

指定 member_state 时，将忽略 state 选项。

选项

  • "present"

  • "absent"

state

字符串 / 必填

指示是创建还是删除对象。

选项

  • "present"

  • "absent"

vdom

字符串

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

默认： "root"

备注

注意

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

  • 此模块支持 check_mode。

示例

- name: Configure shaping profiles.
  fortinet.fortios.fortios_firewall_shaping_profile:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      firewall_shaping_profile:
          comment: "Comment."
          default_class_id: "0"
          npu_offloading: "disable"
          profile_name: "<your_own_value>"
          shaping_entries:
              -
                  burst_in_msec: "0"
                  cburst_in_msec: "0"
                  class_id: "0"
                  guaranteed_bandwidth_percentage: "0"
                  id: "12"
                  limit: "1000"
                  max: "250"
                  maximum_bandwidth_percentage: "1"
                  min: "83"
                  priority: "top"
                  red_probability: "0"
          type: "policing"

返回值

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

键

描述

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"

状态

字符串

操作结果指示

返回： 始终

示例： "success"

vdom

字符串

使用的虚拟域

返回： 始终

示例： "root"

版本

字符串

FortiGate 版本

返回： 始终

示例： "v5.6.3"

作者

  • 郑链 (@chillancezen)

  • 薛杰 (@JieX19)

  • 卢洪宾 (@fgtdev-hblu)

  • 沈芳 (@frankshen01)

  • 米格尔·安赫尔·穆诺兹 (@mamunozgonzalez)

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