fortinet.fortimanager.fmgr_qosprofile – Configure WiFi quality of service
Note
This plugin is part of the fortinet.fortimanager collection (version 2.1.3).
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 version 2.10: of fortinet.fortimanager
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 | Choices/Defaults | Comments | |
|---|---|---|---|
| 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
|
|
| enable_log
boolean
|
|
Enable/Disable logging for task
|
|
| proposed_method
string
|
|
The overridden method for the underlying Json RPC request
|
|
| qosprofile
dictionary
|
the top level parameters set
|
||
| bandwidth-admission-control
string
|
|
Enable/disable WMM bandwidth admission control.
|
|
| bandwidth-capacity
integer
|
Maximum bandwidth capacity allowed (1 - 600000 Kbps, default = 2000).
|
||
| 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, default = 10).
|
||
| comment
string
|
Comment.
|
||
| downlink
integer
|
Maximum downlink bandwidth for Virtual Access Points (VAPs) (0 - 2097152 Kbps, default = 0, 0 means no limit).
|
||
| downlink-sta
integer
|
Maximum downlink bandwidth for clients (0 - 2097152 Kbps, default = 0, 0 means no limit).
|
||
| dscp-wmm-be
integer
|
no description
|
||
| dscp-wmm-bk
integer
|
no description
|
||
| dscp-wmm-mapping
string
|
|
Enable/disable Differentiated Services Code Point (DSCP) mapping.
|
|
| dscp-wmm-vi
integer
|
no description
|
||
| dscp-wmm-vo
integer
|
no description
|
||
| name
string
|
WiFi QoS profile name.
|
||
| uplink
integer
|
Maximum uplink bandwidth for Virtual Access Points (VAPs) (0 - 2097152 Kbps, default = 0, 0 means no limit).
|
||
| uplink-sta
integer
|
Maximum uplink bandwidth for clients (0 - 2097152 Kbps, default = 0, 0 means no limit).
|
||
| wmm
string
|
|
Enable/disable WiFi multi-media (WMM) control.
|
|
| wmm-be-dscp
integer
|
DSCP marking for best effort access (default = 0).
|
||
| wmm-bk-dscp
integer
|
DSCP marking for background access (default = 8).
|
||
| 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 (default = 32).
|
||
| wmm-vo-dscp
integer
|
DSCP marking for voice access (default = 48).
|
||
| rc_failed
list / elements=string
|
the rc codes list with which the conditions to fail will be overriden
|
||
| rc_succeeded
list / elements=string
|
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
|
|
| 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
|
Default:
300
|
the maximum time in seconds to wait for other user to release the workspace lock
|
|
Notes
Note
- 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
- hosts: fortimanager-inventory
collections:
- fortinet.fortimanager
connection: httpapi
vars:
ansible_httpapi_use_ssl: True
ansible_httpapi_validate_certs: False
ansible_httpapi_port: 443
tasks:
- name: Configure WiFi quality of service
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: <value in [present, absent]>
qosprofile:
bandwidth-admission-control: <value in [disable, enable]>
bandwidth-capacity: <value of integer>
burst: <value in [disable, enable]>
call-admission-control: <value in [disable, enable]>
call-capacity: <value of integer>
comment: <value of string>
downlink: <value of integer>
downlink-sta: <value of integer>
dscp-wmm-be: <value of integer>
dscp-wmm-bk: <value of integer>
dscp-wmm-mapping: <value in [disable, enable]>
dscp-wmm-vi: <value of integer>
dscp-wmm-vo: <value of integer>
name: <value of string>
uplink: <value of integer>
uplink-sta: <value of integer>
wmm: <value in [disable, enable]>
wmm-uapsd: <value in [disable, enable]>
wmm-be-dscp: <value of integer>
wmm-bk-dscp: <value of integer>
wmm-dscp-marking: <value in [disable, enable]>
wmm-vi-dscp: <value of integer>
wmm-vo-dscp: <value of integer>
Return Values
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description |
|---|---|---|
| request_url
string
|
always |
The full url requested
Sample:
/sys/login/user
|
| response_code
integer
|
always |
The status of api request
|
| response_message
string
|
always |
The descriptive message of the api response
Sample:
OK.
|
Authors
- Link Zheng (@chillancezen)
- Jie Xue (@JieX19)
- Frank Shen (@fshen01)
- Hongbin Lu (@fgtdev-hblu)
© 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/fortimanager/fmgr_qosprofile_module.html