lix_fortinet / lix_fortinet.fortios / 102.2.120 / module / fortios_firewall_shaper_per_ip_shaper Configure per-IP traffic shaper in Fortinet's FortiOS and FortiGate. | "added in version" 2.0.0 of lix_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 communitylix_fortinet.fortios.fortios_firewall_shaper_per_ip_shaper (102.2.120) — module
Install with ansible-galaxy collection install lix_fortinet.fortios:==102.2.120
collections: - name: lix_fortinet.fortios version: 102.2.120
This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify firewall_shaper feature and per_ip_shaper category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
- 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 per-IP traffic shaper. fortios_firewall_shaper_per_ip_shaper: vdom: "{{ vdom }}" state: "present" access_token: "<your_own_value>" firewall_shaper_per_ip_shaper: bandwidth_unit: "kbps" diffserv_forward: "enable" diffserv_reverse: "enable" diffservcode_forward: "<your_own_value>" diffservcode_rev: "<your_own_value>" max_bandwidth: "0" max_concurrent_session: "0" max_concurrent_tcp_session: "0" max_concurrent_udp_session: "0" name: "default_name_12"
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_shaper_per_ip_shaper: default: null description: - Configure per-IP traffic shaper. suboptions: bandwidth_unit: choices: - kbps - mbps - gbps description: - Unit of measurement for maximum bandwidth for this shaper (Kbps, Mbps or Gbps). type: str diffserv_forward: choices: - enable - disable description: - Enable/disable changing the Forward (original) DiffServ setting applied to traffic accepted by this shaper. type: str diffserv_reverse: choices: - enable - disable description: - Enable/disable changing the Reverse (reply) DiffServ setting applied to traffic accepted by this shaper. type: str diffservcode_forward: description: - Forward (original) DiffServ setting to be applied to traffic accepted by this shaper. type: str diffservcode_rev: description: - Reverse (reply) DiffServ setting to be applied to traffic accepted by this shaper. type: str max_bandwidth: description: - Upper bandwidth limit enforced by this shaper (0 - 80000000). 0 means no limit. Units depend on the bandwidth-unit setting. type: int max_concurrent_session: description: - Maximum number of concurrent sessions allowed by this shaper (0 - 2097000). 0 means no limit. type: int max_concurrent_tcp_session: description: - Maximum number of concurrent TCP sessions allowed by this shaper (0 - 2097000). 0 means no limit. type: int max_concurrent_udp_session: description: - Maximum number of concurrent UDP sessions allowed by this shaper (0 - 2097000). 0 means no limit. type: int name: description: - Traffic shaper name. required: true 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