fortinet.fortios.fortios_wireless_controller_qos_profile – Configure WiFi quality of service (QoS) profiles in Fortinet’s FortiOS and FortiGate.
Note
This plugin is part of the fortinet.fortios collection (version 2.1.2).
You might already have this collection installed if you are using the ansible
package. It is not included in ansible-core
. To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install fortinet.fortios
.
To use it in a playbook, specify: fortinet.fortios.fortios_wireless_controller_qos_profile
.
New in version 2.10: of fortinet.fortios
Synopsis
- This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify wireless_controller feature and qos_profile category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
The below requirements are needed on the host that executes this module.
- ansible>=2.9.0
Parameters
Parameter | Choices/Defaults | Comments | ||
---|---|---|---|---|
access_token string | Token-based authentication. Generated from GUI of Fortigate. | |||
enable_log boolean |
| Enable/Disable logging for task. | ||
state string / required |
| Indicates whether to create or remove the object. | ||
vdom string | Default: "root" | Virtual domain, among those defined previously. A vdom is a virtual instance of the FortiGate that can be configured and used as a different unit. | ||
wireless_controller_qos_profile dictionary | Configure WiFi quality of service (QoS) profiles. | |||
bandwidth_admission_control string |
| Enable/disable WMM bandwidth admission control. | ||
bandwidth_capacity integer | Maximum bandwidth capacity allowed (1 - 600000 Kbps). | |||
burst string |
| Enable/disable client rate burst. | ||
call_admission_control string |
| Enable/disable WMM call admission control. | ||
call_capacity integer | Maximum number of Voice over WLAN (VoWLAN) phones allowed (0 - 60). | |||
comment string | Comment. | |||
downlink integer | Maximum downlink bandwidth for Virtual Access Points (VAPs) (0 - 2097152 Kbps). | |||
downlink_sta integer | Maximum downlink bandwidth for clients (0 - 2097152 Kbps). | |||
dscp_wmm_be list / elements=string | DSCP mapping for best effort access . | |||
id integer / required | DSCP WMM mapping numbers (0 - 63). | |||
dscp_wmm_bk list / elements=string | DSCP mapping for background access . | |||
id integer / required | DSCP WMM mapping numbers (0 - 63). | |||
dscp_wmm_mapping string |
| Enable/disable Differentiated Services Code Point (DSCP) mapping. | ||
dscp_wmm_vi list / elements=string | DSCP mapping for video access . | |||
id integer / required | DSCP WMM mapping numbers (0 - 63). | |||
dscp_wmm_vo list / elements=string | DSCP mapping for voice access . | |||
id integer / required | DSCP WMM mapping numbers (0 - 63). | |||
name string / required | WiFi QoS profile name. | |||
uplink integer | Maximum uplink bandwidth for Virtual Access Points (VAPs) (0 - 2097152 Kbps). | |||
uplink_sta integer | Maximum uplink bandwidth for clients (0 - 2097152 Kbps). | |||
wmm string |
| Enable/disable WiFi multi-media (WMM) control. | ||
wmm_be_dscp integer | DSCP marking for best effort access . | |||
wmm_bk_dscp integer | DSCP marking for background access . | |||
wmm_dscp_marking string |
| Enable/disable WMM Differentiated Services Code Point (DSCP) marking. | ||
wmm_uapsd string |
| Enable/disable WMM Unscheduled Automatic Power Save Delivery (U-APSD) power save mode. | ||
wmm_vi_dscp integer | DSCP marking for video access . | |||
wmm_vo_dscp integer | DSCP marking for voice access . |
Notes
Note
- Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
- hosts: fortigates collections: - fortinet.fortios connection: httpapi vars: vdom: "root" ansible_httpapi_use_ssl: yes ansible_httpapi_validate_certs: no ansible_httpapi_port: 443 tasks: - name: Configure WiFi quality of service (QoS) profiles. fortios_wireless_controller_qos_profile: vdom: "{{ vdom }}" state: "present" access_token: "<your_own_value>" wireless_controller_qos_profile: bandwidth_admission_control: "enable" bandwidth_capacity: "4" burst: "enable" call_admission_control: "enable" call_capacity: "7" comment: "Comment." downlink: "9" downlink_sta: "10" 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: "21" uplink_sta: "22" wmm: "enable" wmm_be_dscp: "24" wmm_bk_dscp: "25" wmm_dscp_marking: "enable" wmm_uapsd: "enable" wmm_vi_dscp: "28" wmm_vo_dscp: "29"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
build string | always | Build number of the fortigate image Sample: 1547 |
http_method string | always | Last method used to provision the content into FortiGate Sample: PUT |
http_status string | always | Last result given by FortiGate on last operation applied Sample: 200 |
mkey string | success | Master key (id) used in the last call to FortiGate Sample: id |
name string | always | Name of the table used to fulfill the request Sample: urlfilter |
path string | always | Path of the table used to fulfill the request Sample: webfilter |
revision string | always | Internal revision number Sample: 17.0.2.10658 |
serial string | always | Serial number of the unit Sample: FGVMEVYYQT3AB5352 |
status string | always | Indication of the operation's result Sample: success |
vdom string | always | Virtual domain used Sample: root |
version string | always | Version of the FortiGate Sample: v5.6.3 |
Authors
- Link Zheng (@chillancezen)
- Jie Xue (@JieX19)
- Hongbin Lu (@fgtdev-hblu)
- Frank Shen (@frankshen01)
- Miguel Angel Munoz (@mamunozgonzalez)
- Nicolas Thomas (@thomnico)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortios/fortios_wireless_controller_qos_profile_module.html