fortinet.fortimanager.fmgr_firewall_shaper_trafficshaper – Configure shared traffic shaper.

Note

This plugin is part of the fortinet.fortimanager collection (version 2.1.3).

To install it use: ansible-galaxy collection install fortinet.fortimanager.

To use it in a playbook, specify: fortinet.fortimanager.fmgr_firewall_shaper_trafficshaper.

New in version 2.10: of fortinet.fortimanager

Synopsis

  • This module is able to configure a FortiManager device.

  • Examples include all parameters and values which need to be adjusted to data sources before usage.

Parameters

Parameter Choices/Defaults Comments
adom
string / required
the parameter (adom) in requested url
bypass_validation
boolean
    Choices:
  • no ←
  • yes
only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters
enable_log
boolean
    Choices:
  • no ←
  • yes
Enable/Disable logging for task
firewall_shaper_trafficshaper
dictionary
the top level parameters set
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:
  • disable
  • enable
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].
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
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 separat...
priority
string
    Choices:
  • high
  • medium
  • low
Higher priority traffic is more likely to be forwarded without delays and without compromising the guaranteed bandwidth.
proposed_method
string
    Choices:
  • update
  • set
  • add
The overridden method for the underlying Json RPC request
rc_failed
list / elements=string
the rc codes list with which the conditions to fail will be overriden
rc_succeeded
list / elements=string
the rc codes list with which the conditions to succeed will be overriden
state
string / required
    Choices:
  • present
  • absent
the directive to create, update or delete an object
workspace_locking_adom
string
the adom to lock for FortiManager running in workspace mode, the value can be global and others including root
workspace_locking_timeout
integer
Default:
300
the maximum time in seconds to wait for other user to release the workspace lock

Notes

Note

  • Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace_locking_adom and workspace_locking_timeout help do the work.

  • To create or update an object, use state present directive.

  • To delete an object, use state absent directive.

  • Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc_failed and rc_succeeded

Examples

- hosts: fortimanager-inventory
  collections:
    - fortinet.fortimanager
  connection: httpapi
  vars:
     ansible_httpapi_use_ssl: True
     ansible_httpapi_validate_certs: False
     ansible_httpapi_port: 443
  tasks:
   - name: Configure shared traffic shaper.
     fmgr_firewall_shaper_trafficshaper:
        bypass_validation: False
        workspace_locking_adom: <value in [global, custom adom including root]>
        workspace_locking_timeout: 300
        rc_succeeded: [0, -2, -3, ...]
        rc_failed: [-2, -3, ...]
        adom: <your own value>
        state: <value in [present, absent]>
        firewall_shaper_trafficshaper:
           bandwidth-unit: <value in [kbps, mbps, gbps]>
           diffserv: <value in [disable, enable]>
           diffservcode: <value of string>
           guaranteed-bandwidth: <value of integer>
           maximum-bandwidth: <value of integer>
           name: <value of string>
           per-policy: <value in [disable, enable]>
           priority: <value in [high, medium, low]>
           dscp-marking-method: <value in [multi-stage, static]>
           exceed-bandwidth: <value of integer>
           exceed-class-id: <value of integer>
           exceed-dscp: <value of string>
           maximum-dscp: <value of string>
           overhead: <value of integer>

Return Values

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

Key Returned Description
request_url
string
always
The full url requested

Sample:
/sys/login/user
response_code
integer
always
The status of api request

response_message
string
always
The descriptive message of the api response

Sample:
OK.


Authors

  • Link Zheng (@chillancezen)

  • Jie Xue (@JieX19)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)