fortios_firewall_shaping_profile – Configure shaping profiles in Fortinet’s FortiOS and FortiGate.¶
New in version 2.10.
Synopsis¶
- This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify firewall feature and shaping_profile category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements¶
The below requirements are needed on the host that executes this module.
- ansible>=2.9.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 |
|
| fortios_firewall_shaping_profile | 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
- state - Indicates whether to create or remove the object. type: str required: True choices: present, absent
- firewall_shaping_profile - Configure shaping profiles. type: dict more...
- comment - Comment. type: str more...
- default_class_id - Default class ID to handle unclassified packets (including all local traffic). Source firewall.traffic-class.class-id. type: int more...
- profile_name - Shaping profile name. type: str more...
- shaping_entries - Define shaping entries of this shaping profile. type: list more...
- burst_in_msec - Number of bytes that can be burst at maximum-bandwidth speed. Formula: burst = maximum-bandwidth*burst-in-msec. type: int more...
- cburst_in_msec - Number of bytes that can be burst as fast as the interface can transmit. Formula: cburst = maximum-bandwidth*cburst-in-msec. type: int more...
- class_id - Class ID. Source firewall.traffic-class.class-id. type: int more...
- guaranteed_bandwidth_percentage - Guaranteed bandwith in percentage. type: int more...
- id - ID number. type: int required: True more...
- limit - Hard limit on the real queue size in packets. type: int more...
- max - Average queue size in packets at which RED drop probability is maximal. type: int more...
- maximum_bandwidth_percentage - Maximum bandwith in percentage. type: int more...
- min - Average queue size in packets at which RED drop becomes a possibility. type: int more...
- priority - Priority. type: str choices: high, medium, low, top, critical more...
- red_probability - Maximum probability (in percentage) for RED marking. type: int more...
- type - Select shaping profile type: policing / queuing. type: str choices: policing, queuing 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 shaping profiles.
fortios_firewall_shaping_profile:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
firewall_shaping_profile:
comment: "Comment."
default_class_id: "4 (source firewall.traffic-class.class-id)"
profile_name: "<your_own_value>"
shaping_entries:
-
burst_in_msec: "7"
cburst_in_msec: "8"
class_id: "9 (source firewall.traffic-class.class-id)"
guaranteed_bandwidth_percentage: "10"
id: "11"
limit: "12"
max: "13"
maximum_bandwidth_percentage: "14"
min: "15"
priority: "high"
red_probability: "17"
type: "policing"
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