fortiswitch_switch_qos_qos_policy – QOS egress policy in Fortinet’s FortiSwitch

New in version 1.0.0.

Synopsis

  • This module is able to configure a FortiSwitch device by allowing the user to set and modify switch_qos feature and qos_policy category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v7.0.0

Requirements

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

  • ansible>=2.11

FortiSW Version Compatibility


v7.0.0 v7.0.1 v7.0.2 v7.0.3
fortiswitch_switch_qos_qos_policy yes yes yes yes

Parameters

  • enable_log - Enable/Disable logging for task. type: bool required: false default: False
  • member_path - Member attribute path to operate on. type: str
  • member_state - Add or delete a member under specified attribute path. type: str choices: present, absent
  • state - Indicates whether to create or remove the object. type: str required: true choices: present, absent
  • switch_qos_qos_policy - QOS egress policy. type: dict
    • cos_queue - COS queue configuration. type: list member_path: cos_queue:name
      • description - Description of the COS queue. type: str
      • drop_policy - COS queue drop policy. type: str choices: taildrop, weighted-random-early-detection
      • ecn - Update frame IP ECN field in lieu of packet drop. type: str choices: disable, enable
      • max_rate - Maximum rate (kbps). 0 to disable. type: int
      • max_rate_percent - Maximum rate (% of link speed). type: int
      • min_rate - Minimum rate (kbps). 0 to disable. type: int
      • min_rate_percent - Minimum rate (% of link speed). type: int
      • name - COS queue ID. type: str required: true
      • weight - Weight of weighted round robin scheduling. type: int
      • wred_slope - Slope of WRED drop probability. type: int
    • name - QOS policy name. type: str required: true
    • rate_by - COS queue rate by kbps or percent. type: str choices: kbps, percent
    • schedule - COS queue scheduling. type: str choices: strict, round-robin, weighted

Examples

- hosts: fortiswitch01
  collections:
    - fortinet.fortiswitch
  connection: httpapi
  vars:
   ansible_httpapi_use_ssl: yes
   ansible_httpapi_validate_certs: no
   ansible_httpapi_port: 443
  tasks:
  - name: QOS egress policy.
    fortiswitch_switch_qos_qos_policy:
      state: "present"
      switch_qos_qos_policy:
        cos_queue:
         -
            description: "<your_own_value>"
            drop_policy: "taildrop"
            ecn: "disable"
            max_rate: "7"
            max_rate_percent: "8"
            min_rate: "9"
            min_rate_percent: "10"
            name: "default_name_11"
            weight: "12"
            wred_slope: "13"
        name: "default_name_14"
        rate_by: "kbps"
        schedule: "strict"

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:

  • build - Build number of the fortiSwitch image returned: always type: str sample: 1547
  • http_method - Last method used to provision the content into FortiSwitch returned: always type: str sample: PUT
  • http_status - Last result given by FortiSwitch on last operation applied returned: always type: str sample: 200
  • mkey - Master key (id) used in the last call to FortiSwitch returned: success type: str sample: id
  • name - Name of the table used to fulfill the request returned: always type: str sample: urlfilter
  • path - Path of the table used to fulfill the request returned: always type: str sample: webfilter
  • serial - Serial number of the unit returned: always type: str sample: FS1D243Z13000122
  • status - Indication of the operation's result returned: always type: str sample: success
  • version - Version of the FortiSwitch returned: always type: str sample: v7.0.0

Status

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

Authors

  • Link Zheng (@chillancezen)
  • Jie Xue (@JieX19)
  • Hongbin Lu (@fgtdev-hblu)
  • Frank Shen (@frankshen01)
  • Miguel Angel Munoz (@mamunozgonzalez)

Hint

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