fortinet.fortimanager.fmgr_qosprofile module – Configure WiFi quality of service

Note

This module is part of the fortinet.fortimanager collection (version 2.7.0).

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.fortimanager.

To use it in a playbook, specify: fortinet.fortimanager.fmgr_qosprofile.

New in fortinet.fortimanager 2.0.0

Synopsis

• This module is able to configure a FortiManager device.

• Examples include all parameters and values which need to be adjusted to data sources before usage.

Parameters

Parameter	Comments
access_token string	The token to access FortiManager without using username and password.
adom string / required	The parameter (adom) in requested url.
bypass_validation boolean	Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. Choices: false ← (default) true
enable_log boolean	Enable/Disable logging for task. Choices: false ← (default) true
forticloud_access_token string	Authenticate Ansible client with forticloud API access token.
proposed_method string	The overridden method for the underlying Json RPC request. Choices: "update" "set" "add"
qosprofile dictionary	The top level parameters set.
bandwidth-admission-control string	Deprecated, please rename it to bandwidth_admission_control. Enable/disable WMM bandwidth admission control. Choices: "disable" "enable"
bandwidth-capacity integer	Deprecated, please rename it to bandwidth_capacity. Maximum bandwidth capacity allowed
burst string	Enable/disable client rate burst. Choices: "disable" "enable"
call-admission-control string	Deprecated, please rename it to call_admission_control. Enable/disable WMM call admission control. Choices: "disable" "enable"
call-capacity integer	Deprecated, please rename it to call_capacity. Maximum number of Voice over WLAN
comment string	Comment.
downlink integer	Maximum downlink bandwidth for Virtual Access Points
downlink-sta integer	Deprecated, please rename it to downlink_sta. Maximum downlink bandwidth for clients
dscp-wmm-be any	(list) Deprecated, please rename it to dscp_wmm_be. DSCP mapping for best effort access
dscp-wmm-bk any	(list) Deprecated, please rename it to dscp_wmm_bk. DSCP mapping for background access
dscp-wmm-mapping string	Deprecated, please rename it to dscp_wmm_mapping. Enable/disable Differentiated Services Code Point Choices: "disable" "enable"
dscp-wmm-vi any	(list) Deprecated, please rename it to dscp_wmm_vi. DSCP mapping for video access
dscp-wmm-vo any	(list) Deprecated, please rename it to dscp_wmm_vo. DSCP mapping for voice access
name string / required	WiFi QoS profile name.
uplink integer	Maximum uplink bandwidth for Virtual Access Points
uplink-sta integer	Deprecated, please rename it to uplink_sta. Maximum uplink bandwidth for clients
wmm string	Enable/disable WiFi multi-media Choices: "disable" "enable"
wmm-be-dscp integer	Deprecated, please rename it to wmm_be_dscp. DSCP marking for best effort access
wmm-bk-dscp integer	Deprecated, please rename it to wmm_bk_dscp. DSCP marking for background access
wmm-dscp-marking string	Deprecated, please rename it to wmm_dscp_marking. Enable/disable WMM Differentiated Services Code Point Choices: "disable" "enable"
wmm-uapsd string	Deprecated, please rename it to wmm_uapsd. Enable/disable WMM Unscheduled Automatic Power Save Delivery Choices: "disable" "enable"
wmm-vi-dscp integer	Deprecated, please rename it to wmm_vi_dscp. DSCP marking for video access
wmm-vo-dscp integer	Deprecated, please rename it to wmm_vo_dscp. DSCP marking for voice access
rc_failed list / elements=integer	The rc codes list with which the conditions to fail will be overriden.
rc_succeeded list / elements=integer	The rc codes list with which the conditions to succeed will be overriden.
state string / required	The directive to create, update or delete an object. Choices: "present" "absent"
workspace_locking_adom string	The adom to lock for FortiManager running in workspace mode, the value can be global and others including root.
workspace_locking_timeout integer	The maximum time in seconds to wait for other user to release the workspace lock. Default: 300

Notes

Note

• Starting in version 2.4.0, all input arguments are named using the underscore naming convention (snake_case). Please change the arguments such as “var-name” to “var_name”. Old argument names are still available yet you will receive deprecation warnings. You can ignore this warning by setting deprecation_warnings=False in ansible.cfg.

• Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace_locking_adom and workspace_locking_timeout help do the work.

• To create or update an object, use state present directive.

• To delete an object, use state absent directive.

• Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc_failed and rc_succeeded

Examples

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

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Description
meta dictionary	The result of the request. Returned: always
request_url string	The full url requested. Returned: always Sample: "/sys/login/user"
response_code integer	The status of api request. Returned: always Sample: 0
response_data list / elements=string	The api response. Returned: always
response_message string	The descriptive message of the api response. Returned: always Sample: "OK."
system_information dictionary	The information of the target system. Returned: always
rc integer	The status the request. Returned: always Sample: 0
version_check_warning list / elements=string	Warning if the parameters used in the playbook are not supported by the current FortiManager version. Returned: complex

Authors

• Xinwei Du (@dux-fortinet)

• Xing Li (@lix-fortinet)

• Jie Xue (@JieX19)

• Link Zheng (@chillancezen)

• Frank Shen (@fshen01)

• Hongbin Lu (@fgtdev-hblu)

Collection links

• Issue Tracker
• Homepage
• Repository (Sources)