fortinet.fortios.fortios_wireless_controller_qos_profile 模块 – 在 Fortinet 的 FortiOS 和 FortiGate 中配置 WiFi 服务质量 (QoS) 配置文件。

注意

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

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

要安装它,请使用:ansible-galaxy collection install fortinet.fortios。您需要其他要求才能使用此模块,请参阅 需求 了解详情。

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

fortinet.fortios 2.0.0 中的新增功能

概要

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

vdom

字符串

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

默认值: "root"

wireless_controller_qos_profile

字典

配置 WiFi 服务质量 (QoS) 配置文件。

bandwidth_admission_control

字符串

启用/禁用 WMM 带宽准入控制。

选项

  • "enable"

  • "disable"

bandwidth_capacity

整数

允许的最大带宽容量 (1 - 600000 Kbps)。

burst

字符串

启用/禁用客户端速率突发。

选项

  • "enable"

  • "disable"

call_admission_control

字符串

启用/禁用 WMM 呼叫接入控制。

选项

  • "enable"

  • "disable"

call_capacity

整数

允许的最大语音WLAN (VoWLAN) 电话数量 (0 - 60)。

comment

字符串

注释。

整数

虚拟接入点 (VAP) 的最大下行带宽 (0 - 2097152 Kbps)。

整数

客户端的最大下行带宽 (0 - 2097152 Kbps)。

dscp_wmm_be

列表 / 元素=字典

最佳努力访问的 DSCP 映射。

id

整数 / 必需

DSCP WMM 映射编号 (0 - 63)。参见 备注

dscp_wmm_bk

列表 / 元素=字典

后台访问的 DSCP 映射。

id

整数 / 必需

DSCP WMM 映射编号 (0 - 63)。参见 备注

dscp_wmm_mapping

字符串

启用/禁用区分服务代码点 (DSCP) 映射。

选项

  • "enable"

  • "disable"

dscp_wmm_vi

列表 / 元素=字典

视频访问的 DSCP 映射。

id

整数 / 必需

DSCP WMM 映射编号 (0 - 63)。参见 备注

dscp_wmm_vo

列表 / 元素=字典

语音访问的 DSCP 映射。

id

整数 / 必需

DSCP WMM 映射编号 (0 - 63)。参见 备注

name

字符串 / 必需

WiFi QoS 配置文件名称。

整数

虚拟接入点 (VAP) 的最大上行带宽 (0 - 2097152 Kbps)。

整数

客户端的最大上行带宽 (0 - 2097152 Kbps)。

wmm

字符串

启用/禁用 WiFi 多媒体 (WMM) 控制。

选项

  • "enable"

  • "disable"

wmm_be_dscp

整数

最佳努力访问的 DSCP 标记。

wmm_bk_dscp

整数

后台访问的 DSCP 标记。

wmm_dscp_marking

字符串

启用/禁用 WMM 区分服务代码点 (DSCP) 标记。

选项

  • "enable"

  • "disable"

wmm_uapsd

字符串

启用/禁用 WMM 计划外自动节电传递 (U-APSD) 节电模式。

选项

  • "enable"

  • "disable"

wmm_vi_dscp

整数

视频访问的 DSCP 标记。

wmm_vo_dscp

整数

语音访问的 DSCP 标记。

备注

注意

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

  • 该模块支持 check_mode。

示例

- name: Configure WiFi quality of service (QoS) profiles.
  fortinet.fortios.fortios_wireless_controller_qos_profile:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      wireless_controller_qos_profile:
          bandwidth_admission_control: "enable"
          bandwidth_capacity: "2000"
          burst: "enable"
          call_admission_control: "enable"
          call_capacity: "10"
          comment: "Comment."
          downlink: "0"
          downlink_sta: "0"
          dscp_wmm_be:
              -
                  id: "12"
          dscp_wmm_bk:
              -
                  id: "14"
          dscp_wmm_mapping: "enable"
          dscp_wmm_vi:
              -
                  id: "17"
          dscp_wmm_vo:
              -
                  id: "19"
          name: "default_name_20"
          uplink: "0"
          uplink_sta: "0"
          wmm: "enable"
          wmm_be_dscp: "0"
          wmm_bk_dscp: "8"
          wmm_dscp_marking: "enable"
          wmm_uapsd: "enable"
          wmm_vi_dscp: "32"
          wmm_vo_dscp: "48"

返回值

公共返回值已在此处记录 此处,以下是此模块特有的字段。

描述

build

字符串

FortiGate 镜像的内部版本号。

返回:始终

示例: "1547"

http_method

字符串

上次用于将内容置备到 FortiGate 的方法。

返回:始终

示例: "PUT"

http_status

字符串

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

返回:始终

示例: "200"

mkey

字符串

上次调用 FortiGate 时使用的主密钥 (id)。

返回:成功

示例: "id"

name

字符串

用于完成请求的表名称。

返回:始终

示例: "urlfilter"

path

字符串

用于完成请求的表的路径。

返回:始终

示例: "webfilter"

版本号

字符串

内部版本号

返回:始终

示例: "17.0.2.10658"

序列号

字符串

设备序列号

返回:始终

示例: "FGVMEVYYQT3AB5352"

状态

字符串

操作结果指示

返回:始终

示例: "success"

vdom

字符串

使用的虚拟域

返回:始终

示例: "root"

版本

字符串

FortiGate版本

返回:始终

示例: "v5.6.3"

作者

  • 郑链 (@chillancezen)

  • 薛杰 (@JieX19)

  • 陆洪宾 (@fgtdev-hblu)

  • 沈芳 (@frankshen01)

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

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