fortinet.fortimanager.fmgr_firewall_shaper_trafficshaper module – Configure shared traffic shaper.
Note
This module is part of the fortinet.fortimanager collection (version 2.4.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 |
|---|---|
The token to access FortiManager without using username and password. |
|
The parameter (adom) in requested url. |
|
Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. Choices:
|
|
Enable/Disable logging for task. Choices:
|
|
The top level parameters set. |
|
Deprecated, please rename it to bandwidth_unit. Unit of measurement for guaranteed and maximum bandwidth for this shaper Choices:
|
|
VLAN CoS mark. |
|
Deprecated, please rename it to cos_marking. Enable/disable VLAN CoS marking. Choices:
|
|
Deprecated, please rename it to cos_marking_method. Select VLAN CoS marking method. Choices:
|
|
Enable/disable changing the DiffServ setting applied to traffic accepted by this shaper. Choices:
|
|
DiffServ setting to be applied to traffic accepted by this shaper. |
|
Deprecated, please rename it to dscp_marking_method. Select DSCP marking method. Choices:
|
|
Deprecated, please rename it to exceed_bandwidth. Exceed bandwidth used for DSCP multi-stage marking. |
|
Deprecated, please rename it to exceed_class_id. Class ID for traffic in [guaranteed-bandwidth, maximum-bandwidth]. |
|
Deprecated, please rename it to exceed_cos. VLAN CoS mark for traffic in [guaranteed-bandwidth, exceed-bandwidth]. |
|
Deprecated, please rename it to exceed_dscp. DSCP mark for traffic in [guaranteed-bandwidth, exceed-bandwidth]. |
|
Deprecated, please rename it to guaranteed_bandwidth. Amount of bandwidth guaranteed for this shaper |
|
Deprecated, please rename it to maximum_bandwidth. Upper bandwidth limit enforced by this shaper |
|
Deprecated, please rename it to maximum_cos. VLAN CoS mark for traffic in [exceed-bandwidth, maximum-bandwidth]. |
|
Deprecated, please rename it to maximum_dscp. DSCP mark for traffic in [exceed-bandwidth, maximum-bandwidth]. |
|
Traffic shaper name. |
|
Per-packet size overhead used in rate computations. |
|
Deprecated, please rename it to per_policy. Enable/disable applying a separate shaper for each policy. Choices:
|
|
Higher priority traffic is more likely to be forwarded without delays and without compromising the guaranteed bandwidth. Choices:
|
|
Authenticate Ansible client with forticloud API access token. |
|
The overridden method for the underlying Json RPC request. Choices:
|
|
The rc codes list with which the conditions to fail will be overriden. |
|
The rc codes list with which the conditions to succeed will be overriden. |
|
The directive to create, update or delete an object. Choices:
|
|
The adom to lock for FortiManager running in workspace mode, the value can be global and others including root. |
|
The maximum time in seconds to wait for other user to release the workspace lock. Default: |
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
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 |
|---|---|
The result of the request. Returned: always |
|
The full url requested. Returned: always Sample: |
|
The status of api request. Returned: always Sample: |
|
The api response. Returned: always |
|
The descriptive message of the api response. Returned: always Sample: |
|
The information of the target system. Returned: always |
|
The status the request. Returned: always Sample: |
|
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)