fmgr_qosprofile – Configure WiFi quality of service (QoS) profiles.

New in version 2.10.

Synopsis

  • This module is able to configure a FortiManager device.
  • Examples include all parameters and values need to be adjusted to data sources before usage.

Requirements

The below requirements are needed on the host that executes this module.

  • ansible>=2.9.0

FortiManager Version Compatibility


6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0
qosprofile yes yes yes yes yes yes yes yes yes

Parameters

  • enable_log - Enable/Disable logging for task type: bool required: false default: False
  • forticloud_access_token - Access token of forticloud managed API users, this option is available with FortiManager later than 6.4.0 type: str required: false
  • proposed_method - The overridden method for the underlying Json RPC request type: str required: false choices: set, update, add
  • bypass_validation - Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters type: bool required: false default: False
  • workspace_locking_adom - Acquire the workspace lock if FortiManager is running in workspace mode type: str required: false choices: global, custom adom including root
  • workspace_locking_timeout - The maximum time in seconds to wait for other users to release workspace lock type: integer required: false default: 300
  • rc_succeeded - The rc codes list with which the conditions to succeed will be overriden type: list required: false
  • rc_failed - The rc codes list with which the conditions to fail will be overriden type: list required: false
  • state - The directive to create, update or delete an object type: str required: true choices: present, absent
  • adom - The parameter in requested url type: str required: true
  • qosprofile - no description type: dict
    • bandwidth-admission-control - Enable/disable WMM bandwidth admission control. type: str choices: [disable, enable] more...
    • bandwidth-capacity - Maximum bandwidth capacity allowed (1 - 600000 Kbps, default = 2000). type: int more...
    • burst - Enable/disable client rate burst. type: str choices: [disable, enable] more...
    • call-admission-control - Enable/disable WMM call admission control. type: str choices: [disable, enable] more...
    • call-capacity - Maximum number of Voice over WLAN (VoWLAN) phones allowed (0 - 60, default = 10). type: int more...
    • comment - Comment. type: str more...
    • downlink - Maximum downlink bandwidth for Virtual Access Points (VAPs) (0 - 2097152 Kbps, default = 0, 0 means no limit). type: int more...
    • downlink-sta - Maximum downlink bandwidth for clients (0 - 2097152 Kbps, default = 0, 0 means no limit). type: int more...
    • dscp-wmm-be - DSCP mapping for best effort access (default = 0 24). type: int more...
    • dscp-wmm-bk - DSCP mapping for background access (default = 8 16). type: int more...
    • dscp-wmm-mapping - Enable/disable Differentiated Services Code Point (DSCP) mapping. type: str choices: [disable, enable] more...
    • dscp-wmm-vi - DSCP mapping for video access (default = 32 40). type: int more...
    • dscp-wmm-vo - DSCP mapping for voice access (default = 48 56). type: int more...
    • name - WiFi QoS profile name. type: str more...
    • uplink - Maximum uplink bandwidth for Virtual Access Points (VAPs) (0 - 2097152 Kbps, default = 0, 0 means no limit). type: int more...
    • uplink-sta - Maximum uplink bandwidth for clients (0 - 2097152 Kbps, default = 0, 0 means no limit). type: int more...
    • wmm - Enable/disable WiFi multi-media (WMM) control. type: str choices: [disable, enable] more...
    • wmm-uapsd - Enable/disable WMM Unscheduled Automatic Power Save Delivery (U-APSD) power save mode. type: str choices: [disable, enable] more...
    • wmm-be-dscp - DSCP marking for best effort access (default = 0). type: int more...
    • wmm-bk-dscp - DSCP marking for background access (default = 8). type: int more...
    • wmm-dscp-marking - Enable/disable WMM Differentiated Services Code Point (DSCP) marking. type: str choices: [disable, enable] more...
    • wmm-vi-dscp - DSCP marking for video access (default = 32). type: int more...
    • wmm-vo-dscp - DSCP marking for voice access (default = 48). type: int more...

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: no description
     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: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, the following are the fields unique to this module:

  • request_url - The full url requested returned: always type: str sample: /sys/login/user
  • response_code - The status of api request returned: always type: int sample: 0
  • response_message - The descriptive message of the api response returned: always type: str sample: OK
  • response_data - The data body of the api response returned: optional type: list or dict

Status

  • This module is not guaranteed to have a backwards compatible interface.

Authors

  • Link Zheng (@chillancezen)
  • Jie Xue (@JieX19)
  • Frank Shen (@fshen01)
  • Hongbin Lu (@fgtdev-hblu)

Hint

If you notice any issues in this documentation, you can create a pull request to improve it.