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 中的新增功能

概要

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

要求

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

  • ansible>=2.15

参数

参数

注释

access_token

string

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

enable_log

boolean

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

选项

  • false ←（默认）

  • true

firewall_shaping_profile

dictionary

配置整形配置文件。

comment

string

注释。

default_class_id

integer

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

npu_offloading

string

启用/禁用 NPU 卸载。

选项

  • "disable"

  • "enable"

profile_name

string / required

整形配置文件名称。

shaping_entries

list / elements=dictionary

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

burst_in_msec

integer

可以以最大带宽速度突发的字节数。 公式：突发 = 最大带宽*突发毫秒数。

cburst_in_msec

integer

可以以接口可以传输的速度突发的字节数。 公式：cburst = 最大带宽*cburst 毫秒数。

class_id

integer

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

guaranteed_bandwidth_percentage

integer

保证的带宽百分比。

id

integer / required

ID 号。 请参阅 <a href=’#notes’>注释</a>。

limit

integer

数据包中真实队列大小的硬限制。

max

integer

RED 丢弃概率最大的数据包中的平均队列大小。

maximum_bandwidth_percentage

integer

最大带宽百分比。

min

integer

RED 丢弃成为可能的数据包中的平均队列大小。

priority

string

优先级。

选项

  • "top"

  • "critical"

  • "high"

  • "medium"

  • "low"

red_probability

integer

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

type

string

选择整形配置文件类型：监管/排队。

选项

  • "policing"

  • "queuing"

member_path

string

要操作的成员属性路径。

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

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

member_state

string

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

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

选项

  • "present"

  • "absent"

state

string / required

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

选项

  • "present"

  • "absent"

vdom

string

虚拟域，在先前定义的那些中。 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

string

FortiGate 映像的构建号

返回值： 始终

示例： "1547"

http_method

string

最后一次用于将内容配置到 FortiGate 中的方法

返回值： 始终

示例： "PUT"

http_status

string

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

返回值： 始终

示例： "200"

mkey

string

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

返回值： 成功

示例： "id"

name

string

用于满足请求的表的名称

返回值： 始终

示例： "urlfilter"

path

string

用于满足请求的表的路径

返回值： 始终

示例： "webfilter"

revision

string

内部修订号

返回值： 始终

示例： "17.0.2.10658"

serial

string

设备的序列号

返回值： 始终

示例: "FGVMEVYYQT3AB5352"

状态

string

操作结果的指示

返回值： 始终

示例: "success"

vdom

string

使用的虚拟域

返回值： 始终

示例: "root"

版本

string

FortiGate 的版本

返回值： 始终

示例: "v5.6.3"

作者

  • Link Zheng (@chillancezen)

  • Jie Xue (@JieX19)

  • Hongbin Lu (@fgtdev-hblu)

  • Frank Shen (@frankshen01)

  • Miguel Angel Munoz (@mamunozgonzalez)

  • Nicolas Thomas (@thomnico)