fortinet.fortimanager.fmgr_qosprofile 模块 – 配置 WiFi 服务质量

注意

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

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

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

要在剧本中使用它，请指定： fortinet.fortimanager.fmgr_qosprofile。

fortinet.fortimanager 2.0.0 中的新增功能

概要

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

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

参数

参数

注释

access_token

字符串

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

adom

字符串 / 必填

请求 URL 中的参数 (adom)。

bypass_validation

布尔值

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

选项

  • false ← (默认)

  • true

enable_log

布尔值

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

选项

  • false ← (默认)

  • true

forticloud_access_token

字符串

使用 FortiCloud API 访问令牌验证 Ansible 客户端。

proposed_method

字符串

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

选项

  • "update"

  • "set"

  • "add"

qosprofile

字典

设置的顶级参数。

bandwidth_admission_control

别名：bandwidth-admission-control

字符串

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

选项

  • "disable"

  • "enable"

bandwidth_capacity

别名：bandwidth-capacity

整数

允许的最大带宽容量

burst

字符串

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

选项

  • "disable"

  • "enable"

call_admission_control

别名：call-admission-control

字符串

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

选项

  • "disable"

  • "enable"

call_capacity

别名：call-capacity

整数

无线局域网语音的最大数量

comment

字符串

注释。

整数

虚拟接入点的最大下行带宽

downlink_sta

别名：downlink-sta

整数

客户端的最大下行带宽

dscp_wmm_be

别名：dscp-wmm-be

任意

(列表) 最佳努力访问的 DSCP 映射

dscp_wmm_bk

别名：dscp-wmm-bk

任意

(列表) 背景访问的 DSCP 映射

dscp_wmm_mapping

别名：dscp-wmm-mapping

字符串

启用/禁用区分服务代码点

选项

  • "disable"

  • "enable"

dscp_wmm_vi

别名：dscp-wmm-vi

任意

(列表) 视频访问的 DSCP 映射

dscp_wmm_vo

别名：dscp-wmm-vo

任意

(列表) 语音访问的 DSCP 映射

name

字符串 / 必填

WiFi QoS 配置文件名称。

整数

虚拟接入点的最大上行带宽

uplink_sta

别名：uplink-sta

整数

客户端的最大上行带宽

wmm

字符串

启用/禁用 WiFi 多媒体

选项

  • "disable"

  • "enable"

wmm_be_dscp

别名：wmm-be-dscp

整数

最佳努力访问的 DSCP 标记

wmm_bk_dscp

别名：wmm-bk-dscp

整数

背景访问的 DSCP 标记

wmm_dscp_marking

别名：wmm-dscp-marking

字符串

启用/禁用 WMM 区分服务代码点

选项

  • "disable"

  • "enable"

wmm_uapsd

别名：wmm-uapsd

字符串

启用/禁用 WMM 非调度自动省电传输

选项

  • "disable"

  • "enable"

wmm_vi_dscp

别名：wmm-vi-dscp

整数

视频访问的 DSCP 标记

wmm_vo_dscp

别名：wmm-vo-dscp

整数

语音访问的DSCP标记

rc_failed

列表 / 元素=整数

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

rc_succeeded

列表 / 元素=整数

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

状态 (state)

字符串 / 必填

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

选项

  • "存在" (present)

  • "不存在" (absent)

workspace_locking_adom

字符串

在工作区模式下运行FortiManager时要锁定的ADOM，值可以是global和其他包括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 (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Configure WiFi quality of service
      fortinet.fortimanager.fmgr_qosprofile:
        # bypass_validation: false
        workspace_locking_adom: <value in [global, custom adom including root]>
        workspace_locking_timeout: 300
        # rc_succeeded: [0, -2, -3, ...]
        # rc_failed: [-2, -3, ...]
        adom: <your own value>
        state: present # <value in [present, absent]>
        qosprofile:
          bandwidth_admission_control: <value in [disable, enable]>
          bandwidth_capacity: <integer>
          burst: <value in [disable, enable]>
          call_admission_control: <value in [disable, enable]>
          call_capacity: <integer>
          comment: <string>
          downlink: <integer>
          downlink_sta: <integer>
          dscp_wmm_be: <list or integer>
          dscp_wmm_bk: <list or integer>
          dscp_wmm_mapping: <value in [disable, enable]>
          dscp_wmm_vi: <list or integer>
          dscp_wmm_vo: <list or integer>
          name: <string>
          uplink: <integer>
          uplink_sta: <integer>
          wmm: <value in [disable, enable]>
          wmm_uapsd: <value in [disable, enable]>
          wmm_be_dscp: <integer>
          wmm_bk_dscp: <integer>
          wmm_dscp_marking: <value in [disable, enable]>
          wmm_vi_dscp: <integer>
          wmm_vo_dscp: <integer>

返回值

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

键 (Key)

描述

元数据 (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)