fortios_wireless_controller_qos_profile – Configure WiFi quality of service (QoS) profiles in Fortinet’s FortiOS and FortiGate — Ansible Documentation

- AnsibleFest
- Products
- Community
- Webinars & Training
- Blog

Documentation

# fortios_wireless_controller_qos_profile – Configure WiFi quality of service (QoS) profiles in Fortinet’s FortiOS and FortiGate

New in version 2.9.

- Synopsis
- Requirements
- Parameters
- Notes
- Examples
- Return Values
- Status

## 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.5

## Requirements

The below requirements are needed on the host that executes this module.

- fortiosapi>=0.9.8

## Parameters

Parameter | Choices/Defaults | Comments
--- | --- | ---
host string |  | FortiOS or FortiGate IP address.
https boolean | Choices: no yes ← | Indicates if the requests towards FortiGate must use HTTPS protocol.
password string | Default: "" | FortiOS or FortiGate password.
ssl_verify boolean | Choices: no yes ← | Ensures FortiGate certificate must be verified by a proper CA.
state string / required | Choices: present absent | Indicates whether to create or remove the object.
username string |  | FortiOS or FortiGate username.
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 | Default: null | Configure WiFi quality of service (QoS) profiles.
| bandwidth_admission_control string | Choices: enable disable | Enable/disable WMM bandwidth admission control.
| bandwidth_capacity integer |  | Maximum bandwidth capacity allowed (1 - 600000 Kbps).
| burst string | Choices: enable disable | Enable/disable client rate burst.
| call_admission_control string | Choices: enable disable | 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 |  | DSCP mapping for best effort access .
|  | id integer / required |  | DSCP WMM mapping numbers (0 - 63).
| dscp_wmm_bk list |  | DSCP mapping for background access .
|  | id integer / required |  | DSCP WMM mapping numbers (0 - 63).
| dscp_wmm_mapping string | Choices: enable disable | Enable/disable Differentiated Services Code Point (DSCP) mapping.
| dscp_wmm_vi list |  | DSCP mapping for video access .
|  | id integer / required |  | DSCP WMM mapping numbers (0 - 63).
| dscp_wmm_vo list |  | 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 | Choices: enable disable | Enable/disable WiFi multi-media (WMM) control.
| wmm_uapsd string | Choices: enable disable | Enable/disable WMM Unscheduled Automatic Power Save Delivery (U-APSD) power save mode.

## Notes

Note

- Requires fortiosapi library developed by Fortinet
- Run as a local_action in your playbook

## Examples

    - hosts: localhost
      vars:
       host: "192.168.122.40"
       username: "admin"
       password: ""
       vdom: "root"
       ssl_verify: "False"
      tasks:
      - name: Configure WiFi quality of service (QoS) profiles.
        fortios_wireless_controller_qos_profile:
          host:  "{{ host }}"
          username: "{{ username }}"
          password: "{{ password }}"
          vdom:  "{{ vdom }}"
          https: "False"
          state: "present"
          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_uapsd: "enable"

## 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

## Status

- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Community. [community]

### Authors

- Miguel Angel Munoz (@mamunozgonzalez)
- Nicolas Thomas (@thomnico)

Hint

If you notice any issues in this documentation, you can edit this document to improve it.