fortios_switch_controller_qos_queue_policy – Configure FortiSwitch QoS egress queue policy in Fortinet’s FortiOS and FortiGate.¶
New in version 2.0.0.
Synopsis¶
- This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify switch_controller_qos feature and queue_policy category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
FortiOS Version Compatibility¶
v6.0.0 |
v6.0.5 |
v6.0.11 |
v6.2.0 |
v6.2.3 |
v6.2.5 |
v6.2.7 |
v6.4.0 |
v6.4.1 |
v6.4.4 |
v7.0.0 |
v7.0.1 |
v7.0.2 |
v7.0.3 |
v7.0.4 |
v7.0.5 |
v7.0.6 |
v7.0.7 |
v7.0.8 |
v7.2.0 |
v7.2.1 |
v7.2.2 |
v7.2.4 |
v7.4.0 |
|
fortios_switch_controller_qos_queue_policy | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes |
Parameters¶
- access_token - Token-based authentication. Generated from GUI of Fortigate. type: str required: false
- enable_log - Enable/Disable logging for task. type: bool required: false default: False
- vdom - Virtual domain, among those defined previously. A vdom is a virtual instance of the FortiGate that can be configured and used as a different unit. type: str default: root
- 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_controller_qos_queue_policy - Configure FortiSwitch QoS egress queue policy. type: dict more...
- cos_queue - COS queue configuration. type: list member_path: cos_queue:name more...
- description - Description of the COS queue. type: str more...
- drop_policy - COS queue drop policy. type: str choices: taildrop, weighted-random-early-detection more...
- ecn - Enable/disable ECN packet marking to drop eligible packets. type: str choices: disable, enable more...
- max_rate - Maximum rate (0 - 4294967295 kbps, 0 to disable). type: int more...
- max_rate_percent - Maximum rate (% of link speed). type: int more...
- min_rate - Minimum rate (0 - 4294967295 kbps, 0 to disable). type: int more...
- min_rate_percent - Minimum rate (% of link speed). type: int more...
- name - Cos queue ID. type: str required: true more...
- weight - Weight of weighted round robin scheduling. type: int more...
- name - QoS policy name. type: str required: true more...
- rate_by - COS queue rate by kbps or percent. type: str choices: kbps, percent more...
- schedule - COS queue scheduling. type: str choices: strict, round-robin, weighted more...
Examples¶
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure FortiSwitch QoS egress queue policy.
fortios_switch_controller_qos_queue_policy:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
switch_controller_qos_queue_policy:
cos_queue:
-
description: "<your_own_value>"
drop_policy: "taildrop"
ecn: "disable"
max_rate: "0"
max_rate_percent: "0"
min_rate: "0"
min_rate_percent: "0"
name: "default_name_11"
weight: "1"
name: "default_name_13"
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 fortigate image returned: always type: str sample: 1547
- http_method - Last method used to provision the content into FortiGate returned: always type: str sample: PUT
- http_status - Last result given by FortiGate on last operation applied returned: always type: str sample: 200
- mkey - Master key (id) used in the last call to FortiGate 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
- revision - Internal revision number returned: always type: str sample: 17.0.2.10658
- serial - Serial number of the unit returned: always type: str sample: FGVMEVYYQT3AB5352
- status - Indication of the operation's result returned: always type: str sample: success
- vdom - Virtual domain used returned: always type: str sample: root
- version - Version of the FortiGate returned: always type: str sample: v5.6.3