Try SpotterConfigure shared traffic shaper 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 community
Install with ansible-galaxy collection install fortinet.fortios:==2.3.6
collections:
- name: fortinet.fortios
version: 2.3.6This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify firewall_shaper feature and traffic_shaper category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
- name: Configure shared traffic shaper.
fortinet.fortios.fortios_firewall_shaper_traffic_shaper:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
firewall_shaper_traffic_shaper:
bandwidth_unit: "kbps"
cos: "<your_own_value>"
cos_marking: "enable"
cos_marking_method: "multi-stage"
diffserv: "enable"
diffservcode: "<your_own_value>"
dscp_marking_method: "multi-stage"
exceed_bandwidth: "0"
exceed_class_id: "0"
exceed_cos: "<your_own_value>"
exceed_dscp: "<your_own_value>"
guaranteed_bandwidth: "0"
maximum_bandwidth: "0"
maximum_cos: "<your_own_value>"
maximum_dscp: "<your_own_value>"
name: "default_name_18"
overhead: "0"
per_policy: "disable"
priority: "low"
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_traffic_shaper:
default: null
description:
- Configure shared traffic shaper.
suboptions:
bandwidth_unit:
choices:
- kbps
- mbps
- gbps
description:
- Unit of measurement for guaranteed and maximum bandwidth for this shaper (Kbps,
Mbps or Gbps).
type: str
cos:
description:
- VLAN CoS mark.
type: str
cos_marking:
choices:
- enable
- disable
description:
- Enable/disable VLAN CoS marking.
type: str
cos_marking_method:
choices:
- multi-stage
- static
description:
- Select VLAN CoS marking method.
type: str
diffserv:
choices:
- enable
- disable
description:
- Enable/disable changing the DiffServ setting applied to traffic accepted by
this shaper.
type: str
diffservcode:
description:
- DiffServ setting to be applied to traffic accepted by this shaper.
type: str
dscp_marking_method:
choices:
- multi-stage
- static
description:
- Select DSCP marking method.
type: str
exceed_bandwidth:
description:
- Exceed bandwidth used for DSCP/VLAN CoS multi-stage marking. Units depend on
the bandwidth-unit setting.
type: int
exceed_class_id:
description:
- Class ID for traffic in guaranteed-bandwidth and maximum-bandwidth. Source firewall.traffic-class.class-id.
type: int
exceed_cos:
description:
- VLAN CoS mark for traffic in [guaranteed-bandwidth, exceed-bandwidth].
type: str
exceed_dscp:
description:
- DSCP mark for traffic in guaranteed-bandwidth and exceed-bandwidth.
type: str
guaranteed_bandwidth:
description:
- Amount of bandwidth guaranteed for this shaper (0 - 80000000). Units depend
on the bandwidth-unit setting.
type: int
maximum_bandwidth:
description:
- Upper bandwidth limit enforced by this shaper (0 - 80000000). 0 means no limit.
Units depend on the bandwidth-unit setting.
type: int
maximum_cos:
description:
- VLAN CoS mark for traffic in [exceed-bandwidth, maximum-bandwidth].
type: str
maximum_dscp:
description:
- DSCP mark for traffic in exceed-bandwidth and maximum-bandwidth.
type: str
name:
description:
- Traffic shaper name.
required: true
type: str
overhead:
description:
- Per-packet size overhead used in rate computations.
type: int
per_policy:
choices:
- disable
- enable
description:
- Enable/disable applying a separate shaper for each policy. For example, if enabled
the guaranteed bandwidth is applied separately for each policy.
type: str
priority:
choices:
- low
- medium
- high
description:
- Higher priority traffic is more likely to be forwarded without delays and without
compromising the guaranteed bandwidth.
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