fortinet / fortinet.fortios / 2.3.6 / module / fortios_firewall_shaping_profile Configure shaping profiles in Fortinet's FortiOS and FortiGate. | "added in version" 2.0.0 of fortinet.fortios" Authors: Link Zheng (@chillancezen), Jie Xue (@JieX19), Hongbin Lu (@fgtdev-hblu), Frank Shen (@frankshen01), Miguel Angel Munoz (@mamunozgonzalez), Nicolas Thomas (@thomnico) preview | supported by communityfortinet.fortios.fortios_firewall_shaping_profile (2.3.6) — module
Install with ansible-galaxy collection install fortinet.fortios:==2.3.6
collections: - name: fortinet.fortios version: 2.3.6
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
- name: Configure shaping profiles. fortinet.fortios.fortios_firewall_shaping_profile: vdom: "{{ vdom }}" state: "present" access_token: "<your_own_value>" firewall_shaping_profile: comment: "Comment." default_class_id: "0" profile_name: "<your_own_value>" shaping_entries: - burst_in_msec: "0" cburst_in_msec: "0" class_id: "0" guaranteed_bandwidth_percentage: "0" id: "11" limit: "1000" max: "250" maximum_bandwidth_percentage: "1" min: "83" priority: "top" red_probability: "0" type: "policing"
vdom: default: root description: - 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 state: choices: - present - absent description: - Indicates whether to create or remove the object. required: true type: str enable_log: default: false description: - Enable/Disable logging for task. required: false type: bool member_path: description: - Member attribute path to operate on. - Delimited by a slash character if there are more than one attribute. - Parameter marked with member_path is legitimate for doing member operation. type: str access_token: description: - Token-based authentication. Generated from GUI of Fortigate. required: false type: str member_state: choices: - present - absent description: - Add or delete a member under specified attribute path. - When member_state is specified, the state option is ignored. type: str firewall_shaping_profile: default: null description: - Configure shaping profiles. suboptions: comment: description: - Comment. type: str default_class_id: description: - Default class ID to handle unclassified packets (including all local traffic). Source firewall.traffic-class.class-id. type: int profile_name: description: - Shaping profile name. required: true type: str shaping_entries: description: - Define shaping entries of this shaping profile. elements: dict suboptions: burst_in_msec: description: - 'Number of bytes that can be burst at maximum-bandwidth speed. Formula: burst = maximum-bandwidth*burst-in-msec.' type: int cburst_in_msec: description: - 'Number of bytes that can be burst as fast as the interface can transmit. Formula: cburst = maximum-bandwidth*cburst-in-msec.' type: int class_id: description: - Class ID. Source firewall.traffic-class.class-id. type: int guaranteed_bandwidth_percentage: description: - Guaranteed bandwidth in percentage. type: int id: description: - ID number. see <a href='#notes'>Notes</a>. required: true type: int limit: description: - Hard limit on the real queue size in packets. type: int max: description: - Average queue size in packets at which RED drop probability is maximal. type: int maximum_bandwidth_percentage: description: - Maximum bandwidth in percentage. type: int min: description: - Average queue size in packets at which RED drop becomes a possibility. type: int priority: choices: - top - critical - high - medium - low description: - Priority. type: str red_probability: description: - Maximum probability (in percentage) for RED marking. type: int type: list type: choices: - policing - queuing description: - 'Select shaping profile type: policing / queuing.' type: str type: dict
build: description: Build number of the fortigate image returned: always sample: '1547' type: str http_method: description: Last method used to provision the content into FortiGate returned: always sample: PUT type: str http_status: description: Last result given by FortiGate on last operation applied returned: always sample: '200' type: str mkey: description: Master key (id) used in the last call to FortiGate returned: success sample: id type: str name: description: Name of the table used to fulfill the request returned: always sample: urlfilter type: str path: description: Path of the table used to fulfill the request returned: always sample: webfilter type: str revision: description: Internal revision number returned: always sample: 17.0.2.10658 type: str serial: description: Serial number of the unit returned: always sample: FGVMEVYYQT3AB5352 type: str status: description: Indication of the operation's result returned: always sample: success type: str vdom: description: Virtual domain used returned: always sample: root type: str version: description: Version of the FortiGate returned: always sample: v5.6.3 type: str