New in version 2.8.
The below requirements are needed on the host that executes this module.
Parameter | Choices/Defaults | Comments | ||
---|---|---|---|---|
firewall_shaping_profile
-
|
Default: null
|
Configure shaping profiles.
|
||
comment
-
|
Comment.
|
|||
default-class-id
-
|
Default class ID to handle unclassified packets (including all local traffic).
|
|||
profile-name
-
/ required
|
Shaping profile name.
|
|||
shaping-entries
-
|
Define shaping entries of this shaping profile.
|
|||
class-id
-
|
Class ID.
|
|||
guaranteed-bandwidth-percentage
-
|
Guaranteed bandwith in percentage.
|
|||
id
-
/ required
|
ID number.
|
|||
maximum-bandwidth-percentage
-
|
Maximum bandwith in percentage.
|
|||
priority
-
|
|
Priority.
|
||
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 shaping profiles.
fortios_firewall_shaping_profile:
host: "{{ host }}"
username: "{{ username }}"
password: "{{ password }}"
vdom: "{{ vdom }}"
https: "False"
firewall_shaping_profile:
state: "present"
comment: "Comment."
default-class-id: "4"
profile-name: "<your_own_value>"
shaping-entries:
-
class-id: "7"
guaranteed-bandwidth-percentage: "8"
id: "9"
maximum-bandwidth-percentage: "10"
priority: "high"
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.