fortinet.fortimanager.fmgr_qosprofile module – Configure WiFi quality of service
Note
This module is part of the fortinet.fortimanager collection (version 2.1.5).
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 |
Comments |
|---|---|
the parameter (adom) in requested url |
|
only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters Choices:
|
|
Enable/Disable logging for task Choices:
|
|
The overridden method for the underlying Json RPC request Choices:
|
|
the top level parameters set |
|
Enable/disable WMM bandwidth admission control. Choices:
|
|
Maximum bandwidth capacity allowed (1 - 600000 Kbps, default = 2000). |
|
Enable/disable client rate burst. Choices:
|
|
Enable/disable WMM call admission control. Choices:
|
|
Maximum number of Voice over WLAN (VoWLAN) phones allowed (0 - 60, default = 10). |
|
Comment. |
|
Maximum downlink bandwidth for Virtual Access Points (VAPs) (0 - 2097152 Kbps, default = 0, 0 means no limit). |
|
Maximum downlink bandwidth for clients (0 - 2097152 Kbps, default = 0, 0 means no limit). |
|
DSCP mapping for best effort access (default = 0 24). |
|
DSCP mapping for background access (default = 8 16). |
|
Enable/disable Differentiated Services Code Point (DSCP) mapping. Choices:
|
|
DSCP mapping for video access (default = 32 40). |
|
DSCP mapping for voice access (default = 48 56). |
|
WiFi QoS profile name. |
|
Maximum uplink bandwidth for Virtual Access Points (VAPs) (0 - 2097152 Kbps, default = 0, 0 means no limit). |
|
Maximum uplink bandwidth for clients (0 - 2097152 Kbps, default = 0, 0 means no limit). |
|
Enable/disable WiFi multi-media (WMM) control. Choices:
|
|
DSCP marking for best effort access (default = 0). |
|
DSCP marking for background access (default = 8). |
|
Enable/disable WMM Differentiated Services Code Point (DSCP) marking. Choices:
|
|
Enable/disable WMM Unscheduled Automatic Power Save Delivery (U-APSD) power save mode. Choices:
|
|
DSCP marking for video access (default = 32). |
|
DSCP marking for voice access (default = 48). |
|
the rc codes list with which the conditions to fail will be overriden |
|
the rc codes list with which the conditions to succeed will be overriden |
|
the directive to create, update or delete an object Choices:
|
|
the adom to lock for FortiManager running in workspace mode, the value can be global and others including root |
|
the maximum time in seconds to wait for other user to release the workspace lock Default: 300 |
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 |
Description |
|---|---|
The full url requested Returned: always Sample: “/sys/login/user” |
|
The status of api request Returned: always Sample: 0 |
|
The descriptive message of the api response Returned: always Sample: “OK.” |
Authors
Link Zheng (@chillancezen)
Jie Xue (@JieX19)
Frank Shen (@fshen01)
Hongbin Lu (@fgtdev-hblu)