Try SpotterConfigure WiFi quality of service
| "added in version" 2.0.0 of fortinet.fortimanager"
Authors: Xinwei Du (@dux-fortinet), Xing Li (@lix-fortinet), Jie Xue (@JieX19), Link Zheng (@chillancezen), Frank Shen (@fshen01), Hongbin Lu (@fgtdev-hblu)
preview | supported by community
Install with ansible-galaxy collection install fortinet.fortimanager:==2.4.0
collections:
- name: fortinet.fortimanager
version: 2.4.0This module is able to configure a FortiManager device.
Examples include all parameters and values which need to be adjusted to data sources before usage.
- 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>
adom:
description: The parameter (adom) in requested url.
required: true
type: str
state:
choices:
- present
- absent
description: The directive to create, update or delete an object.
required: true
type: str
rc_failed:
description: The rc codes list with which the conditions to fail will be overriden.
elements: int
type: list
enable_log:
default: false
description: Enable/Disable logging for task.
type: bool
qosprofile:
description: The top level parameters set.
required: false
suboptions:
bandwidth-admission-control:
choices:
- disable
- enable
description: Deprecated, please rename it to bandwidth_admission_control. Enable/disable
WMM bandwidth admission control.
type: str
bandwidth-capacity:
description: Deprecated, please rename it to bandwidth_capacity. Maximum bandwidth
capacity allowed
type: int
burst:
choices:
- disable
- enable
description: Enable/disable client rate burst.
type: str
call-admission-control:
choices:
- disable
- enable
description: Deprecated, please rename it to call_admission_control. Enable/disable
WMM call admission control.
type: str
call-capacity:
description: Deprecated, please rename it to call_capacity. Maximum number of
Voice over WLAN
type: int
comment:
description: Comment.
type: str
downlink:
description: Maximum downlink bandwidth for Virtual Access Points
type: int
downlink-sta:
description: Deprecated, please rename it to downlink_sta. Maximum downlink bandwidth
for clients
type: int
dscp-wmm-be:
description: (list) Deprecated, please rename it to dscp_wmm_be. DSCP mapping
for best effort access
type: raw
dscp-wmm-bk:
description: (list) Deprecated, please rename it to dscp_wmm_bk. DSCP mapping
for background access
type: raw
dscp-wmm-mapping:
choices:
- disable
- enable
description: Deprecated, please rename it to dscp_wmm_mapping. Enable/disable
Differentiated Services Code Point
type: str
dscp-wmm-vi:
description: (list) Deprecated, please rename it to dscp_wmm_vi. DSCP mapping
for video access
type: raw
dscp-wmm-vo:
description: (list) Deprecated, please rename it to dscp_wmm_vo. DSCP mapping
for voice access
type: raw
name:
description: WiFi QoS profile name.
required: true
type: str
uplink:
description: Maximum uplink bandwidth for Virtual Access Points
type: int
uplink-sta:
description: Deprecated, please rename it to uplink_sta. Maximum uplink bandwidth
for clients
type: int
wmm:
choices:
- disable
- enable
description: Enable/disable WiFi multi-media
type: str
wmm-be-dscp:
description: Deprecated, please rename it to wmm_be_dscp. DSCP marking for best
effort access
type: int
wmm-bk-dscp:
description: Deprecated, please rename it to wmm_bk_dscp. DSCP marking for background
access
type: int
wmm-dscp-marking:
choices:
- disable
- enable
description: Deprecated, please rename it to wmm_dscp_marking. Enable/disable
WMM Differentiated Services Code Point
type: str
wmm-uapsd:
choices:
- disable
- enable
description: Deprecated, please rename it to wmm_uapsd. Enable/disable WMM Unscheduled
Automatic Power Save Delivery
type: str
wmm-vi-dscp:
description: Deprecated, please rename it to wmm_vi_dscp. DSCP marking for video
access
type: int
wmm-vo-dscp:
description: Deprecated, please rename it to wmm_vo_dscp. DSCP marking for voice
access
type: int
type: dict
access_token:
description: The token to access FortiManager without using username and password.
type: str
rc_succeeded:
description: The rc codes list with which the conditions to succeed will be overriden.
elements: int
type: list
proposed_method:
choices:
- update
- set
- add
description: The overridden method for the underlying Json RPC request.
type: str
bypass_validation:
default: false
description: Only set to True when module schema diffs with FortiManager API structure,
module continues to execute without validating parameters.
type: bool
workspace_locking_adom:
description: The adom to lock for FortiManager running in workspace mode, the value
can be global and others including root.
type: str
forticloud_access_token:
description: Authenticate Ansible client with forticloud API access token.
type: str
workspace_locking_timeout:
default: 300
description: The maximum time in seconds to wait for other user to release the workspace
lock.
type: int
meta:
contains:
request_url:
description: The full url requested.
returned: always
sample: /sys/login/user
type: str
response_code:
description: The status of api request.
returned: always
sample: 0
type: int
response_data:
description: The api response.
returned: always
type: list
response_message:
description: The descriptive message of the api response.
returned: always
sample: OK.
type: str
system_information:
description: The information of the target system.
returned: always
type: dict
description: The result of the request.
returned: always
type: dict
rc:
description: The status the request.
returned: always
sample: 0
type: int
version_check_warning:
description: Warning if the parameters used in the playbook are not supported by
the current FortiManager version.
returned: complex
type: list