fmgr_firewall_shaper_trafficshaper – Configure shared traffic shaper.
Added in version 2.0.0.
Warning
Starting in version 3.0.0, all input arguments will be named using the underscore naming convention (snake_case).
Argument name before 3.0.0:
var-name
,var name
,var.name
New argument name starting in 3.0.0:
var_name
FortiManager Ansible v2.4+ supports both previous argument name and new underscore name. You will receive deprecation warnings if you keep using the previous argument name. You can ignore the warning by setting deprecation_warnings=False in ansible.cfg.
Synopsis
This module is able to configure a FortiManager device.
Examples include all parameters and values need to be adjusted to data sources before usage.
Tested with FortiManager v7.x.
Requirements
The below requirements are needed on the host that executes this module.
ansible>=2.15.0
FortiManager Version Compatibility
Supported Version Ranges: v6.0.0 -> latest
Parameters
- access_token -The token to access FortiManager without using username and password. type: str required: false
- bypass_validation - Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. type: bool required: false default: False
- enable_log - Enable/Disable logging for task. type: bool required: false default: False
- forticloud_access_token - Access token of forticloud managed API users, this option is available with FortiManager later than 6.4.0. type: str required: false
- proposed_method - The overridden method for the underlying Json RPC request. type: str required: false choices: set, update, add
- rc_succeeded - The rc codes list with which the conditions to succeed will be overriden. type: list required: false
- rc_failed - The rc codes list with which the conditions to fail will be overriden. type: list required: false
- state - The directive to create, update or delete an object type: str required: true choices: present, absent
- workspace_locking_adom - Acquire the workspace lock if FortiManager is running in workspace mode. type: str required: false choices: global, custom adom including root
- workspace_locking_timeout - The maximum time in seconds to wait for other users to release workspace lock. type: integer required: false default: 300
- adom - The parameter in requested url type: str required: true
- firewall_shaper_trafficshaper - Configure shared traffic shaper. type: dict
- bandwidth_unit (Alias name: bandwidth-unit) Unit of measurement for guaranteed and maximum bandwidth for this shaper (kbps, mbps or gbps). type: str choices: [kbps, mbps, gbps]
more...
Supported Version Ranges:
v6.0.0 -> latest
- diffserv Enable/disable changing the diffserv setting applied to traffic accepted by this shaper. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.0.0 -> latest
- diffservcode Diffserv setting to be applied to traffic accepted by this shaper. type: str
more...
Supported Version Ranges:
v6.0.0 -> latest
- guaranteed_bandwidth (Alias name: guaranteed-bandwidth) Amount of bandwidth guaranteed for this shaper (0 - 16776000). type: int
more...
Supported Version Ranges:
v6.0.0 -> latest
- maximum_bandwidth (Alias name: maximum-bandwidth) Upper bandwidth limit enforced by this shaper (0 - 16776000). type: int
more...
Supported Version Ranges:
v6.0.0 -> latest
- name Traffic shaper name. type: str
more...
Supported Version Ranges:
v6.0.0 -> latest
- per_policy (Alias name: per-policy) Enable/disable applying a separate shaper for each policy. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.0.0 -> latest
- priority Higher priority traffic is more likely to be forwarded without delays and without compromising the guaranteed bandwidth. type: str choices: [high, medium, low]
more...
Supported Version Ranges:
v6.0.0 -> latest
- dscp_marking_method (Alias name: dscp-marking-method) Select dscp marking method. type: str choices: [multi-stage, static]
more...
Supported Version Ranges:
v6.2.1 -> latest
- exceed_bandwidth (Alias name: exceed-bandwidth) Exceed bandwidth used for dscp multi-stage marking. type: int
more...
Supported Version Ranges:
v6.2.1 -> latest
- exceed_class_id (Alias name: exceed-class-id) Class id for traffic in [guaranteed-bandwidth, maximum-bandwidth]. type: int
more...
Supported Version Ranges:
v6.2.1 -> latest
- exceed_dscp (Alias name: exceed-dscp) Dscp mark for traffic in [guaranteed-bandwidth, exceed-bandwidth]. type: str
more...
Supported Version Ranges:
v6.2.1 -> latest
- maximum_dscp (Alias name: maximum-dscp) Dscp mark for traffic in [exceed-bandwidth, maximum-bandwidth]. type: str
more...
Supported Version Ranges:
v6.2.1 -> latest
- overhead Per-packet size overhead used in rate computations. type: int
more...
Supported Version Ranges:
v6.2.1 -> latest
- cos Vlan cos mark. type: str
more...
Supported Version Ranges:
v7.4.0 -> latest
- cos_marking (Alias name: cos-marking) Enable/disable vlan cos marking. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v7.4.0 -> latest
- cos_marking_method (Alias name: cos-marking-method) Select vlan cos marking method. type: str choices: [multi-stage, static]
more...
Supported Version Ranges:
v7.4.0 -> latest
- exceed_cos (Alias name: exceed-cos) Vlan cos mark for traffic in [guaranteed-bandwidth, exceed-bandwidth]. type: str
more...
Supported Version Ranges:
v7.4.0 -> latest
- maximum_cos (Alias name: maximum-cos) Vlan cos mark for traffic in [exceed-bandwidth, maximum-bandwidth]. type: str
more...
Supported Version Ranges:
v7.4.0 -> latest
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
- 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: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, the following are the fields unique to this module:
- meta - The result of the request.returned: always type: dict
- request_url - The full url requested. returned: always type: str sample: /sys/login/user
- response_code - The status of api request. returned: always type: int sample: 0
- response_data - The data body of the api response. returned: optional type: list or dict
- response_message - The descriptive message of the api response. returned: always type: str sample: OK
- system_information - The information of the target system. returned: always type: dict
- rc - The status the request. returned: always type: int sample: 0
- version_check_warning - Warning if the parameters used in the playbook are not supported by the current FortiManager version. returned: if at least one parameter not supported by the current FortiManager version type: list
Status
This module is not guaranteed to have a backwards compatible interface.
Authors
Xinwei Du (@dux-fortinet)
Xing Li (@lix-fortinet)
Jie Xue (@JieX19)
Link Zheng (@chillancezen)
Frank Shen (@fshen01)
Hongbin Lu (@fgtdev-hblu)