New in version 2.8.
The below requirements are needed on the host that executes this module.
Parameter | Choices/Defaults | Comments | |
---|---|---|---|
firewall_shaper_per_ip_shaper
-
|
Default: null
|
Configure per-IP traffic shaper.
|
|
bandwidth-unit
-
|
|
Unit of measurement for maximum bandwidth for this shaper (Kbps, Mbps or Gbps).
|
|
diffserv-forward
-
|
|
Enable/disable changing the Forward (original) DiffServ setting applied to traffic accepted by this shaper.
|
|
diffserv-reverse
-
|
|
Enable/disable changing the Reverse (reply) DiffServ setting applied to traffic accepted by this shaper.
|
|
diffservcode-forward
-
|
Forward (original) DiffServ setting to be applied to traffic accepted by this shaper.
|
||
diffservcode-rev
-
|
Reverse (reply) DiffServ setting to be applied to traffic accepted by this shaper.
|
||
max-bandwidth
-
|
Upper bandwidth limit enforced by this shaper (0 - 16776000). 0 means no limit. Units depend on the bandwidth-unit setting.
|
||
max-concurrent-session
-
|
Maximum number of concurrent sessions allowed by this shaper (0 - 2097000). 0 means no limit.
|
||
name
-
/ required
|
Traffic shaper name.
|
||
state
-
|
|
Indicates whether to create or remove the object
|
|
host
-
/ required
|
FortiOS or FortiGate ip adress.
|
||
https
boolean
|
|
Indicates if the requests towards FortiGate must use HTTPS protocol
|
|
password
-
|
Default: ""
|
FortiOS or FortiGate password.
|
|
username
-
/ required
|
FortiOS or FortiGate username.
|
||
vdom
-
|
Default: "root"
|
Virtual domain, among those defined previously. A vdom is a virtual instance of the FortiGate that can be configured and used as a different unit.
|
Note
- hosts: localhost
vars:
host: "192.168.122.40"
username: "admin"
password: ""
vdom: "root"
tasks:
- name: Configure per-IP traffic shaper.
fortios_firewall_shaper_per_ip_shaper:
host: "{{ host }}"
username: "{{ username }}"
password: "{{ password }}"
vdom: "{{ vdom }}"
https: "False"
firewall_shaper_per_ip_shaper:
state: "present"
bandwidth-unit: "kbps"
diffserv-forward: "enable"
diffserv-reverse: "enable"
diffservcode-forward: "<your_own_value>"
diffservcode-rev: "<your_own_value>"
max-bandwidth: "8"
max-concurrent-session: "9"
name: "default_name_10"
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
build
string
|
always |
Build number of the fortigate image
Sample:
1547
|
http_method
string
|
always |
Last method used to provision the content into FortiGate
Sample:
PUT
|
http_status
string
|
always |
Last result given by FortiGate on last operation applied
Sample:
200
|
mkey
string
|
success |
Master key (id) used in the last call to FortiGate
Sample:
id
|
name
string
|
always |
Name of the table used to fulfill the request
Sample:
urlfilter
|
path
string
|
always |
Path of the table used to fulfill the request
Sample:
webfilter
|
revision
string
|
always |
Internal revision number
Sample:
17.0.2.10658
|
serial
string
|
always |
Serial number of the unit
Sample:
FGVMEVYYQT3AB5352
|
status
string
|
always |
Indication of the operation's result
Sample:
success
|
vdom
string
|
always |
Virtual domain used
Sample:
root
|
version
string
|
always |
Version of the FortiGate
Sample:
v5.6.3
|
Hint
If you notice any issues in this documentation you can edit this document to improve it.