fortinet.fortios.fortios_firewall_shaper_traffic_shaper – Configure shared traffic shaper in Fortinet’s FortiOS and FortiGate.

Note

This plugin is part of the fortinet.fortios collection (version 2.1.2).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install fortinet.fortios.

To use it in a playbook, specify: fortinet.fortios.fortios_firewall_shaper_traffic_shaper.

New in version 2.10: of fortinet.fortios

Synopsis

  • This 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

Requirements

The below requirements are needed on the host that executes this module.

  • ansible>=2.9.0

Parameters

Parameter Choices/Defaults Comments
access_token
string
Token-based authentication. Generated from GUI of Fortigate.
enable_log
boolean
    Choices:
  • no ←
  • yes
Enable/Disable logging for task.
firewall_shaper_traffic_shaper
dictionary
Configure shared traffic shaper.
bandwidth_unit
string
    Choices:
  • kbps
  • mbps
  • gbps
Unit of measurement for guaranteed and maximum bandwidth for this shaper (Kbps, Mbps or Gbps).
diffserv
string
    Choices:
  • enable
  • disable
Enable/disable changing the DiffServ setting applied to traffic accepted by this shaper.
diffservcode
string
DiffServ setting to be applied to traffic accepted by this shaper.
dscp_marking_method
string
    Choices:
  • multi-stage
  • static
Select DSCP marking method.
exceed_bandwidth
integer
Exceed bandwidth used for DSCP multi-stage marking. Units depend on the bandwidth-unit setting.
exceed_class_id
integer
Class ID for traffic in [guaranteed-bandwidth, maximum-bandwidth]. Source firewall.traffic-class.class-id.
exceed_dscp
string
DSCP mark for traffic in [guaranteed-bandwidth, exceed-bandwidth].
guaranteed_bandwidth
integer
Amount of bandwidth guaranteed for this shaper (0 - 16776000). Units depend on the bandwidth-unit setting.
maximum_bandwidth
integer
Upper bandwidth limit enforced by this shaper (0 - 16776000). 0 means no limit. Units depend on the bandwidth-unit setting.
maximum_dscp
string
DSCP mark for traffic in [exceed-bandwidth, maximum-bandwidth].
name
string / required
Traffic shaper name.
overhead
integer
Per-packet size overhead used in rate computations.
per_policy
string
    Choices:
  • disable
  • enable
Enable/disable applying a separate shaper for each policy. For example, if enabled the guaranteed bandwidth is applied separately for each policy.
priority
string
    Choices:
  • low
  • medium
  • high
Higher priority traffic is more likely to be forwarded without delays and without compromising the guaranteed bandwidth.
state
string / required
    Choices:
  • present
  • absent
Indicates whether to create or remove the object.
vdom
string
Default:
"root"
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.

Notes

Note

  • Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks

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 shared traffic shaper.
    fortios_firewall_shaper_traffic_shaper:
      vdom:  "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      firewall_shaper_traffic_shaper:
        bandwidth_unit: "kbps"
        diffserv: "enable"
        diffservcode: "<your_own_value>"
        dscp_marking_method: "multi-stage"
        exceed_bandwidth: "7"
        exceed_class_id: "8 (source firewall.traffic-class.class-id)"
        exceed_dscp: "<your_own_value>"
        guaranteed_bandwidth: "10"
        maximum_bandwidth: "11"
        maximum_dscp: "<your_own_value>"
        name: "default_name_13"
        overhead: "14"
        per_policy: "disable"
        priority: "low"

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
build
string
always
Build number of the fortigate image

Sample:
1547
http_method
string
always
Last method used to provision the content into FortiGate

Sample:
PUT
http_status
string
always
Last result given by FortiGate on last operation applied

Sample:
200
mkey
string
success
Master key (id) used in the last call to FortiGate

Sample:
id
name
string
always
Name of the table used to fulfill the request

Sample:
urlfilter
path
string
always
Path of the table used to fulfill the request

Sample:
webfilter
revision
string
always
Internal revision number

Sample:
17.0.2.10658
serial
string
always
Serial number of the unit

Sample:
FGVMEVYYQT3AB5352
status
string
always
Indication of the operation's result

Sample:
success
vdom
string
always
Virtual domain used

Sample:
root
version
string
always
Version of the FortiGate

Sample:
v5.6.3


Authors

  • Link Zheng (@chillancezen)
  • Jie Xue (@JieX19)
  • Hongbin Lu (@fgtdev-hblu)
  • Frank Shen (@frankshen01)
  • Miguel Angel Munoz (@mamunozgonzalez)
  • Nicolas Thomas (@thomnico)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortios/fortios_firewall_shaper_traffic_shaper_module.html