fortios_wireless_controller_qos_profile – Configure WiFi quality of service (QoS) profiles in Fortinet’s FortiOS and FortiGate.
New in version 2.0.0.
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.15
Tips
Using member operation to add an element to an existing object.
FortiOS Version Compatibility
Supported Version Ranges: v6.0.0 -> 7.4.3
Parameters
- access_token - Token-based authentication. Generated from GUI of Fortigate. type: str required: false
- enable_log - Enable/Disable logging for task. type: bool required: false default: False
- vdom - 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. type: str default: root
- member_path - Member attribute path to operate on. type: str
- member_state - Add or delete a member under specified attribute path. type: str choices: present, absent
- state - Indicates whether to create or remove the object. type: str required: true choices: present, absent
- wireless_controller_qos_profile - Configure WiFi quality of service (QoS) profiles. type: dict more...
- bandwidth_admission_control - Enable/disable WMM bandwidth admission control. type: str choices: enable, disable more...
- bandwidth_capacity - Maximum bandwidth capacity allowed (1 - 600000 Kbps). type: int more...
- burst - Enable/disable client rate burst. type: str choices: enable, disable more...
- call_admission_control - Enable/disable WMM call admission control. type: str choices: enable, disable more...
- call_capacity - Maximum number of Voice over WLAN (VoWLAN) phones allowed (0 - 60). type: int more...
- comment - Comment. type: str more...
- downlink - Maximum downlink bandwidth for Virtual Access Points (VAPs) (0 - 2097152 Kbps). type: int more...
- downlink_sta - Maximum downlink bandwidth for clients (0 - 2097152 Kbps). type: int more...
- dscp_wmm_be - DSCP mapping for best effort access . type: list member_path: dscp_wmm_be:id more...
- dscp_wmm_bk - DSCP mapping for background access . type: list member_path: dscp_wmm_bk:id more...
- dscp_wmm_mapping - Enable/disable Differentiated Services Code Point (DSCP) mapping. type: str choices: enable, disable more...
- dscp_wmm_vi - DSCP mapping for video access . type: list member_path: dscp_wmm_vi:id more...
- dscp_wmm_vo - DSCP mapping for voice access . type: list member_path: dscp_wmm_vo:id more...
- name - WiFi QoS profile name. type: str required: true more...
- uplink - Maximum uplink bandwidth for Virtual Access Points (VAPs) (0 - 2097152 Kbps). type: int more...
- uplink_sta - Maximum uplink bandwidth for clients (0 - 2097152 Kbps). type: int more...
- wmm - Enable/disable WiFi multi-media (WMM) control. type: str choices: enable, disable more...
- wmm_be_dscp - DSCP marking for best effort access . type: int more...
- wmm_bk_dscp - DSCP marking for background access . type: int more...
- wmm_dscp_marking - Enable/disable WMM Differentiated Services Code Point (DSCP) marking. type: str choices: enable, disable more...
- wmm_uapsd - Enable/disable WMM Unscheduled Automatic Power Save Delivery (U-APSD) power save mode. type: str choices: enable, disable more...
- wmm_vi_dscp - DSCP marking for video access . type: int more...
- wmm_vo_dscp - DSCP marking for voice access . type: int more...
Notes
Note
Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
- 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"
Return Values
Common return values are documented: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, the following are the fields unique to this module:
- build - Build number of the fortigate image returned: always type: str sample: 1547
- http_method - Last method used to provision the content into FortiGate returned: always type: str sample: PUT
- http_status - Last result given by FortiGate on last operation applied returned: always type: str sample: 200
- mkey - Master key (id) used in the last call to FortiGate returned: success type: str sample: id
- name - Name of the table used to fulfill the request returned: always type: str sample: urlfilter
- path - Path of the table used to fulfill the request returned: always type: str sample: webfilter
- revision - Internal revision number returned: always type: str sample: 17.0.2.10658
- serial - Serial number of the unit returned: always type: str sample: FGVMEVYYQT3AB5352
- status - Indication of the operation's result returned: always type: str sample: success
- vdom - Virtual domain used returned: always type: str sample: root
- version - Version of the FortiGate returned: always type: str sample: v5.6.3
Status
This module is not guaranteed to have a backwards compatible interface.