W3cubDocs

/Ansible

fortinet.fortimanager.fmgr_firewall_shaper_trafficshaper module – Configure shared traffic shaper.

Note

This module is part of the fortinet.fortimanager collection (version 2.10.0).

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.fortimanager.

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

New in fortinet.fortimanager 2.0.0

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

Comments

access_token

string

The token to access FortiManager without using username and password.

adom

string / required

The parameter (adom) in requested url.

bypass_validation

boolean

Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters.

Choices:

  • false ← (default)
  • true

enable_log

boolean

Enable/Disable logging for task.

Choices:

  • false ← (default)
  • true

firewall_shaper_trafficshaper

dictionary

The top level parameters set.

bandwidth_unit

aliases: bandwidth-unit

string

Unit of measurement for guaranteed and maximum bandwidth for this shaper

Choices:

  • "kbps"
  • "mbps"
  • "gbps"

cos

string

VLAN CoS mark.

cos_marking

aliases: cos-marking

string

Enable/disable VLAN CoS marking.

Choices:

  • "disable"
  • "enable"

cos_marking_method

aliases: cos-marking-method

string

Select VLAN CoS marking method.

Choices:

  • "multi-stage"
  • "static"

diffserv

string

Enable/disable changing the DiffServ setting applied to traffic accepted by this shaper.

Choices:

  • "disable"
  • "enable"

diffservcode

string

DiffServ setting to be applied to traffic accepted by this shaper.

dscp_marking_method

aliases: dscp-marking-method

string

Select DSCP marking method.

Choices:

  • "multi-stage"
  • "static"

exceed_bandwidth

aliases: exceed-bandwidth

integer

Exceed bandwidth used for DSCP multi-stage marking.

exceed_class_id

aliases: exceed-class-id

integer

Class ID for traffic in [guaranteed-bandwidth, maximum-bandwidth].

exceed_cos

aliases: exceed-cos

string

VLAN CoS mark for traffic in [guaranteed-bandwidth, exceed-bandwidth].

exceed_dscp

aliases: exceed-dscp

string

DSCP mark for traffic in [guaranteed-bandwidth, exceed-bandwidth].

guaranteed_bandwidth

aliases: guaranteed-bandwidth

integer

Amount of bandwidth guaranteed for this shaper

maximum_bandwidth

aliases: maximum-bandwidth

integer

Upper bandwidth limit enforced by this shaper

maximum_cos

aliases: maximum-cos

string

VLAN CoS mark for traffic in [exceed-bandwidth, maximum-bandwidth].

maximum_dscp

aliases: 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

aliases: per-policy

string

Enable/disable applying a separate shaper for each policy.

Choices:

  • "disable"
  • "enable"

priority

string

Higher priority traffic is more likely to be forwarded without delays and without compromising the guaranteed bandwidth.

Choices:

  • "high"
  • "medium"
  • "low"

forticloud_access_token

string

Authenticate Ansible client with forticloud API access token.

proposed_method

string

The overridden method for the underlying Json RPC request.

Choices:

  • "update"
  • "set"
  • "add"

rc_failed

list / elements=integer

The rc codes list with which the conditions to fail will be overriden.

rc_succeeded

list / elements=integer

The rc codes list with which the conditions to succeed will be overriden.

state

string / required

The directive to create, update or delete an object.

Choices:

  • "present"
  • "absent"

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

The maximum time in seconds to wait for other user to release the workspace lock.

Default: 300

Notes

Note

  • Starting in version 2.4.0, all input arguments are named using the underscore naming convention (snake_case). Please change the arguments such as “var-name” to “var_name”. Old argument names are still available yet you will receive deprecation warnings. You can ignore this warning by setting deprecation_warnings=False in ansible.cfg.
  • 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

- name: Example playbook
  hosts: fortimanagers
  gather_facts: false
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Configure shared traffic shaper.
      fortinet.fortimanager.fmgr_firewall_shaper_trafficshaper:
        bypass_validation: false
        adom: ansible
        state: present
        firewall_shaper_trafficshaper:
          bandwidth-unit: mbps # <value in [kbps, mbps, gbps]>
          diffserv: disable
          name: "ansible"
          per-policy: disable
          priority: medium # <value in [high, medium, low]>

- name: Gathering fortimanager facts
  hosts: fortimanagers
  gather_facts: false
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Retrieve all the shared traffic shapers
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "firewall_shaper_trafficshaper"
          params:
            adom: "ansible"
            traffic-shaper: "your_value"

Return Values

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

Key

Description

meta

dictionary

The result of the request.

Returned: always

request_url

string

The full url requested.

Returned: always

Sample: "/sys/login/user"

response_code

integer

The status of api request.

Returned: always

Sample: 0

response_data

list / elements=string

The api response.

Returned: always

response_message

string

The descriptive message of the api response.

Returned: always

Sample: "OK."

system_information

dictionary

The information of the target system.

Returned: always

rc

integer

The status the request.

Returned: always

Sample: 0

version_check_warning

list / elements=string

Warning if the parameters used in the playbook are not supported by the current FortiManager version.

Returned: complex

Authors

  • Xinwei Du (@dux-fortinet)
  • Xing Li (@lix-fortinet)
  • Jie Xue (@JieX19)
  • Link Zheng (@chillancezen)
  • Frank Shen (@fshen01)
  • Hongbin Lu (@fgtdev-hblu)

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