fortinet.fortimanager.fmgr_firewall_shaper_trafficshaper 模块 – 配置共享流量整形。

注意

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

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

要安装它，请使用：ansible-galaxy collection install fortinet.fortimanager。

要在 playbook 中使用它，请指定：fortinet.fortimanager.fmgr_firewall_shaper_trafficshaper。

fortinet.fortimanager 2.0.0 中的新增功能

概要

  • 此模块能够配置 FortiManager 设备。

  • 示例包含所有需要在使用前根据数据源调整的参数和值。

参数

参数

注释

access_token

字符串

无需使用用户名和密码即可访问 FortiManager 的令牌。

adom

字符串 / 必需

请求 URL 中的参数 (adom)。

bypass_validation

布尔值

仅当模块模式与 FortiManager API 结构不同时才设置为 True，模块将继续执行而无需验证参数。

选项

  • false ← (默认)

  • true

enable_log

布尔值

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

选项

  • false ← (默认)

  • true

firewall_shaper_trafficshaper

字典

设置的顶级参数。

bandwidth_unit

别名：bandwidth-unit

字符串

此整形器的保证带宽和最大带宽的度量单位

选项

  • "kbps"

  • "mbps"

  • "gbps"

cos

字符串

VLAN CoS 标记。

cos_marking

别名：cos-marking

字符串

启用/禁用 VLAN CoS 标记。

选项

  • "disable"

  • "enable"

cos_marking_method

别名：cos-marking-method

字符串

选择 VLAN CoS 标记方法。

选项

  • "multi-stage"

  • "static"

diffserv

字符串

启用/禁用更改应用于此整形器接受的流量的 DiffServ 设置。

选项

  • "disable"

  • "enable"

diffservcode

字符串

要应用于此整形器接受的流量的 DiffServ 设置。

dscp_marking_method

别名：dscp-marking-method

字符串

选择 DSCP 标记方法。

选项

  • "multi-stage"

  • "static"

exceed_bandwidth

别名：exceed-bandwidth

整数

用于 DSCP 多阶段标记的超出带宽。

exceed_class_id

别名：exceed-class-id

整数

介于 [guaranteed-bandwidth, maximum-bandwidth] 之间的流量的类 ID。

exceed_cos

别名：exceed-cos

字符串

介于 [guaranteed-bandwidth, exceed-bandwidth] 之间的流量的 VLAN CoS 标记。

exceed_dscp

别名：exceed-dscp

字符串

介于 [guaranteed-bandwidth, exceed-bandwidth] 之间的流量的 DSCP 标记。

guaranteed_bandwidth

别名：guaranteed-bandwidth

整数

此整形器保证的带宽量

maximum_bandwidth

别名：maximum-bandwidth

整数

此整形器强制执行的带宽上限

maximum_cos

别名：maximum-cos

字符串

介于 [exceed-bandwidth, maximum-bandwidth] 之间的流量的 VLAN CoS 标记。

maximum_dscp

别名：maximum-dscp

字符串

介于 [exceed-bandwidth, maximum-bandwidth] 之间的流量的 DSCP 标记。

name

字符串 / 必需

流量整形器名称。

overhead

整数

速率计算中使用的每个数据包大小开销。

per_policy

别名：per-policy

字符串

启用/禁用为每个策略应用单独的整形器。

选项

  • "disable"

  • "enable"

priority

字符串

优先级较高的流量更有可能在不延迟且不影响保证带宽的情况下转发。

选项

  • "high"

  • "medium"

  • "low"

forticloud_access_token

字符串

使用 forticloud API 访问令牌对 Ansible 客户端进行身份验证。

proposed_method

字符串

底层 Json RPC 请求的覆盖方法。

选项

  • "update"

  • "set"

  • "add"

rc_failed

列表 / 元素=整数

将覆盖失败条件的 rc 代码列表。

rc_succeeded

列表 / 元素=整数

将覆盖成功条件的 rc 代码列表。

state

字符串 / 必需

创建、更新或删除对象的指令。

选项

  • "present"

  • "absent"

workspace_locking_adom

字符串

要在工作区模式下运行 FortiManager 时锁定的 adom，该值可以是全局的和其他值，包括 root。

workspace_locking_timeout

整数

等待其他用户释放工作区锁定的最大时间（秒）。

默认： 300

备注

注意

  • 从 2.4.0 版本开始，所有输入参数都使用下划线命名约定 (snake_case)。请将诸如“var-name”之类的参数更改为“var_name”。旧的参数名称仍然可用，但您会收到弃用警告。您可以通过在 ansible.cfg 中设置 deprecation_warnings=False 来忽略此警告。

  • 此 FortiManager 模块支持在工作区锁定模式下运行，顶级参数 workspace_locking_adom 和 workspace_locking_timeout 有助于完成此工作。

  • 要创建或更新对象，请使用 state present 指令。

  • 要删除对象，请使用 state absent 指令。

  • 通常情况下，当返回非零 rc 时，运行一个模块可能会失败。您还可以使用参数 rc_failed 和 rc_succeeded 来覆盖失败或成功的条件。

示例

- name: Example playbook
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Configure shared traffic shaper.
      fortinet.fortimanager.fmgr_firewall_shaper_trafficshaper:
        bypass_validation: false
        adom: ansible
        state: present
        firewall_shaper_trafficshaper:
          bandwidth-unit: mbps # <value in [kbps, mbps, gbps]>
          diffserv: disable
          name: "ansible"
          per-policy: disable
          priority: medium # <value in [high, medium, low]>

- name: Gathering fortimanager facts
  hosts: fortimanagers
  gather_facts: false
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Retrieve all the shared traffic shapers
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "firewall_shaper_trafficshaper"
          params:
            adom: "ansible"
            traffic-shaper: "your_value"

返回值

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

键

描述

meta

字典

请求的结果。

返回：始终

request_url

字符串

请求的完整 URL。

返回：始终

示例： "/sys/login/user"

response_code

整数

API请求的状态。

返回：始终

示例： 0

response_data

列表 / 元素=字符串

API响应。

返回：始终

response_message

字符串

API响应的描述性消息。

返回：始终

示例： "OK."

system_information

字典

目标系统的信息。

返回：始终

rc

整数

请求的状态。

返回：始终

示例： 0

version_check_warning

列表 / 元素=字符串

如果剧本中使用的参数不受当前FortiManager版本支持，则会发出警告。

返回： 复杂类型

作者

  • 杜欣伟 (@dux-fortinet)

  • 李星 (@lix-fortinet)

  • 薛杰 (@JieX19)

  • 郑琳 (@chillancezen)

  • 沈方 (@fshen01)

  • 陆洪斌 (@fgtdev-hblu)