Try SpotterConfigure shared traffic shaper.
| "added in version" 2.0.0 of drmofu.fortimanager"
Authors: Xinwei Du (@dux-fortinet), Xing Li (@lix-fortinet), Jie Xue (@JieX19), Link Zheng (@chillancezen), Frank Shen (@fshen01), Hongbin Lu (@fgtdev-hblu)
preview | supported by community
Install with ansible-galaxy collection install drmofu.fortimanager:==2.2.2
collections:
- name: drmofu.fortimanager
version: 2.2.2This module is able to configure a FortiManager device.
Examples include all parameters and values which need to be adjusted to data sources before usage.
- name: gathering fortimanager facts
hosts: fortimanager00
gather_facts: no
connection: httpapi
collections:
- fortinet.fortimanager
vars:
ansible_httpapi_use_ssl: True
ansible_httpapi_validate_certs: False
ansible_httpapi_port: 443
tasks:
- name: retrieve all the shared traffic shapers
fmgr_fact:
facts:
selector: 'firewall_shaper_trafficshaper'
params:
adom: 'ansible'
traffic-shaper: 'your_value'
- hosts: fortimanager00
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
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]>
adom:
description: the parameter (adom) in requested url
required: true
type: str
state:
choices:
- present
- absent
description: The directive to create, update or delete an object.
required: true
type: str
rc_failed:
description: The rc codes list with which the conditions to fail will be overriden.
elements: int
required: false
type: list
enable_log:
default: false
description: Enable/Disable logging for task.
required: false
type: bool
access_token:
description: The token to access FortiManager without using username and password.
required: false
type: str
rc_succeeded:
description: The rc codes list with which the conditions to succeed will be overriden.
elements: int
required: false
type: list
proposed_method:
choices:
- update
- set
- add
description: The overridden method for the underlying Json RPC request.
required: false
type: str
bypass_validation:
default: false
description: Only set to True when module schema diffs with FortiManager API structure,
module continues to execute without validating parameters.
required: false
type: bool
workspace_locking_adom:
description: The adom to lock for FortiManager running in workspace mode, the value
can be global and others including root.
required: false
type: str
forticloud_access_token:
description: Authenticate Ansible client with forticloud API access token.
required: false
type: str
workspace_locking_timeout:
default: 300
description: The maximum time in seconds to wait for other user to release the workspace
lock.
required: false
type: int
firewall_shaper_trafficshaper:
description: the top level parameters set
required: false
suboptions:
bandwidth-unit:
choices:
- kbps
- mbps
- gbps
description: Unit of measurement for guaranteed and maximum bandwidth for this
shaper
type: str
cos:
description: VLAN CoS mark.
type: str
cos-marking:
choices:
- disable
- enable
description: Enable/disable VLAN CoS marking.
type: str
cos-marking-method:
choices:
- multi-stage
- static
description: Select VLAN CoS marking method.
type: str
diffserv:
choices:
- disable
- enable
description: Enable/disable changing the DiffServ setting applied to traffic accepted
by this shaper.
type: str
diffservcode:
description: DiffServ setting to be applied to traffic accepted by this shaper.
type: str
dscp-marking-method:
choices:
- multi-stage
- static
description: Select DSCP marking method.
type: str
exceed-bandwidth:
description: Exceed bandwidth used for DSCP multi-stage marking.
type: int
exceed-class-id:
description: Class ID for traffic in [guaranteed-bandwidth, maximum-bandwidth].
type: int
exceed-cos:
description: VLAN CoS mark for traffic in [guaranteed-bandwidth, exceed-bandwidth].
type: str
exceed-dscp:
description: DSCP mark for traffic in [guaranteed-bandwidth, exceed-bandwidth].
type: str
guaranteed-bandwidth:
description: Amount of bandwidth guaranteed for this shaper
type: int
maximum-bandwidth:
description: Upper bandwidth limit enforced by this shaper
type: int
maximum-cos:
description: VLAN CoS mark for traffic in [exceed-bandwidth, maximum-bandwidth].
type: str
maximum-dscp:
description: DSCP mark for traffic in [exceed-bandwidth, maximum-bandwidth].
type: str
name:
description: Traffic shaper name.
type: str
overhead:
description: Per-packet size overhead used in rate computations.
type: int
per-policy:
choices:
- disable
- enable
description: Enable/disable applying a separate shaper for each policy.
type: str
priority:
choices:
- high
- medium
- low
description: Higher priority traffic is more likely to be forwarded without delays
and without compromising the guaranteed bandwidth.
type: str
type: dict
meta:
contains:
request_url:
description: The full url requested.
returned: always
sample: /sys/login/user
type: str
response_code:
description: The status of api request.
returned: always
sample: 0
type: int
response_data:
description: The api response.
returned: always
type: list
response_message:
description: The descriptive message of the api response.
returned: always
sample: OK.
type: str
system_information:
description: The information of the target system.
returned: always
type: dict
description: The result of the request.
returned: always
type: dict
rc:
description: The status the request.
returned: always
sample: 0
type: int
version_check_warning:
description: Warning if the parameters used in the playbook are not supported by
the current FortiManager version.
returned: complex
type: list