fortinet.fortios.fortios_wireless_controller_qos_profile (2.3.6) — module

Configure WiFi quality of service (QoS) profiles in Fortinet's FortiOS and FortiGate.

| "added in version" 2.0.0 of fortinet.fortios"

Authors: Link Zheng (@chillancezen), Jie Xue (@JieX19), Hongbin Lu (@fgtdev-hblu), Frank Shen (@frankshen01), Miguel Angel Munoz (@mamunozgonzalez), Nicolas Thomas (@thomnico)

preview | supported by community

Install collection

Install with ansible-galaxy collection install fortinet.fortios:==2.3.6


Add to requirements.yml

  collections:
    - name: fortinet.fortios
      version: 2.3.6

Description

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

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- 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"

Inputs

    
vdom:
    default: root
    description:
    - 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

state:
    choices:
    - present
    - absent
    description:
    - Indicates whether to create or remove the object.
    required: true
    type: str

enable_log:
    default: false
    description:
    - Enable/Disable logging for task.
    required: false
    type: bool

member_path:
    description:
    - Member attribute path to operate on.
    - Delimited by a slash character if there are more than one attribute.
    - Parameter marked with member_path is legitimate for doing member operation.
    type: str

access_token:
    description:
    - Token-based authentication. Generated from GUI of Fortigate.
    required: false
    type: str

member_state:
    choices:
    - present
    - absent
    description:
    - Add or delete a member under specified attribute path.
    - When member_state is specified, the state option is ignored.
    type: str

wireless_controller_qos_profile:
    default: null
    description:
    - Configure WiFi quality of service (QoS) profiles.
    suboptions:
      bandwidth_admission_control:
        choices:
        - enable
        - disable
        description:
        - Enable/disable WMM bandwidth admission control.
        type: str
      bandwidth_capacity:
        description:
        - Maximum bandwidth capacity allowed (1 - 600000 Kbps).
        type: int
      burst:
        choices:
        - enable
        - disable
        description:
        - Enable/disable client rate burst.
        type: str
      call_admission_control:
        choices:
        - enable
        - disable
        description:
        - Enable/disable WMM call admission control.
        type: str
      call_capacity:
        description:
        - Maximum number of Voice over WLAN (VoWLAN) phones allowed (0 - 60).
        type: int
      comment:
        description:
        - Comment.
        type: str
      downlink:
        description:
        - Maximum downlink bandwidth for Virtual Access Points (VAPs) (0 - 2097152 Kbps).
        type: int
      downlink_sta:
        description:
        - Maximum downlink bandwidth for clients (0 - 2097152 Kbps).
        type: int
      dscp_wmm_be:
        description:
        - DSCP mapping for best effort access .
        elements: dict
        suboptions:
          id:
            description:
            - DSCP WMM mapping numbers (0 - 63). see <a href='#notes'>Notes</a>.
            required: true
            type: int
        type: list
      dscp_wmm_bk:
        description:
        - DSCP mapping for background access .
        elements: dict
        suboptions:
          id:
            description:
            - DSCP WMM mapping numbers (0 - 63). see <a href='#notes'>Notes</a>.
            required: true
            type: int
        type: list
      dscp_wmm_mapping:
        choices:
        - enable
        - disable
        description:
        - Enable/disable Differentiated Services Code Point (DSCP) mapping.
        type: str
      dscp_wmm_vi:
        description:
        - DSCP mapping for video access .
        elements: dict
        suboptions:
          id:
            description:
            - DSCP WMM mapping numbers (0 - 63). see <a href='#notes'>Notes</a>.
            required: true
            type: int
        type: list
      dscp_wmm_vo:
        description:
        - DSCP mapping for voice access .
        elements: dict
        suboptions:
          id:
            description:
            - DSCP WMM mapping numbers (0 - 63). see <a href='#notes'>Notes</a>.
            required: true
            type: int
        type: list
      name:
        description:
        - WiFi QoS profile name.
        required: true
        type: str
      uplink:
        description:
        - Maximum uplink bandwidth for Virtual Access Points (VAPs) (0 - 2097152 Kbps).
        type: int
      uplink_sta:
        description:
        - Maximum uplink bandwidth for clients (0 - 2097152 Kbps).
        type: int
      wmm:
        choices:
        - enable
        - disable
        description:
        - Enable/disable WiFi multi-media (WMM) control.
        type: str
      wmm_be_dscp:
        description:
        - DSCP marking for best effort access .
        type: int
      wmm_bk_dscp:
        description:
        - DSCP marking for background access .
        type: int
      wmm_dscp_marking:
        choices:
        - enable
        - disable
        description:
        - Enable/disable WMM Differentiated Services Code Point (DSCP) marking.
        type: str
      wmm_uapsd:
        choices:
        - enable
        - disable
        description:
        - Enable/disable WMM Unscheduled Automatic Power Save Delivery (U-APSD) power
          save mode.
        type: str
      wmm_vi_dscp:
        description:
        - DSCP marking for video access .
        type: int
      wmm_vo_dscp:
        description:
        - DSCP marking for voice access .
        type: int
    type: dict

Outputs

build:
  description: Build number of the fortigate image
  returned: always
  sample: '1547'
  type: str
http_method:
  description: Last method used to provision the content into FortiGate
  returned: always
  sample: PUT
  type: str
http_status:
  description: Last result given by FortiGate on last operation applied
  returned: always
  sample: '200'
  type: str
mkey:
  description: Master key (id) used in the last call to FortiGate
  returned: success
  sample: id
  type: str
name:
  description: Name of the table used to fulfill the request
  returned: always
  sample: urlfilter
  type: str
path:
  description: Path of the table used to fulfill the request
  returned: always
  sample: webfilter
  type: str
revision:
  description: Internal revision number
  returned: always
  sample: 17.0.2.10658
  type: str
serial:
  description: Serial number of the unit
  returned: always
  sample: FGVMEVYYQT3AB5352
  type: str
status:
  description: Indication of the operation's result
  returned: always
  sample: success
  type: str
vdom:
  description: Virtual domain used
  returned: always
  sample: root
  type: str
version:
  description: Version of the FortiGate
  returned: always
  sample: v5.6.3
  type: str