fortinet.fortios.fortios_firewall_shaping_policy module – Configure shaping policies in Fortinet’s FortiOS and FortiGate.
Note
This module is part of the fortinet.fortios collection (version 2.3.8).
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.fortios
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: fortinet.fortios.fortios_firewall_shaping_policy
.
New in fortinet.fortios 2.0.0
Synopsis
This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify firewall feature and shaping_policy category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
The below requirements are needed on the host that executes this module.
ansible>=2.15
Parameters
Parameter |
Comments |
---|---|
Token-based authentication. Generated from GUI of Fortigate. |
|
the action indiactor to move an object in the list Choices:
|
|
mkey of target identifier |
|
mkey of target identifier |
|
Enable/Disable logging for task. Choices:
|
|
Configure shaping policies. |
|
IDs of one or more application categories that this shaper applies application control traffic shaping to. |
|
Category IDs. see <a href=’#notes’>Notes</a>. |
|
One or more application group names. |
|
Application group name. Source application.group.name. |
|
IDs of one or more applications that this shaper applies application control traffic shaping to. |
|
Application IDs. see <a href=’#notes’>Notes</a>. |
|
Traffic class ID. Source firewall.traffic-class.class-id. |
|
Comments. |
|
VLAN CoS bit pattern. |
|
VLAN CoS evaluated bits. |
|
Enable to change packet”s DiffServ values to the specified diffservcode-forward value. Choices:
|
|
Enable to change packet”s reverse (reply) DiffServ values to the specified diffservcode-rev value. Choices:
|
|
Change packet”s DiffServ to this value. |
|
Change packet”s reverse (reply) DiffServ to this value. |
|
IPv4 destination address and address group names. |
|
Address name. Source firewall.address.name firewall.addrgrp.name. |
|
IPv6 destination address and address group names. |
|
Address name. Source firewall.address6.name firewall.addrgrp6.name. |
|
One or more outgoing (egress) interfaces. |
|
Interface name. Source system.interface.name system.zone.name system.sdwan.zone.name. |
|
Apply this traffic shaping policy to user groups that have authenticated with the FortiGate. |
|
Group name. Source user.group.name. |
|
Shaping policy ID (0 - 4294967295). see <a href=’#notes’>Notes</a>. |
|
Enable/disable use of Internet Services for this policy. If enabled, destination address and service are not used. Choices:
|
|
Custom Internet Service name. |
|
Custom Internet Service name. Source firewall.internet-service-custom.name. |
|
Custom Internet Service group name. |
|
Custom Internet Service group name. Source firewall.internet-service-custom-group.name. |
|
Internet Service group name. |
|
Internet Service group name. Source firewall.internet-service-group.name. |
|
Internet Service ID. |
|
Internet Service ID. see <a href=’#notes’>Notes</a>. Source firewall.internet-service.id. |
|
Internet Service ID. |
|
Internet Service name. Source firewall.internet-service-name.name. |
|
Enable/disable use of Internet Services in source for this policy. If enabled, source address is not used. Choices:
|
|
Custom Internet Service source name. |
|
Custom Internet Service name. Source firewall.internet-service-custom.name. |
|
Custom Internet Service source group name. |
|
Custom Internet Service group name. Source firewall.internet-service-custom-group.name. |
|
Internet Service source group name. |
|
Internet Service group name. Source firewall.internet-service-group.name. |
|
Internet Service source ID. |
|
Internet Service ID. see <a href=’#notes’>Notes</a>. Source firewall.internet-service.id. |
|
Internet Service source name. |
|
Internet Service name. Source firewall.internet-service-name.name. |
|
Apply this traffic shaping policy to IPv4 or IPv6 traffic. Choices:
|
|
Shaping policy name. |
|
Per-IP traffic shaper to apply with this policy. Source firewall.shaper.per-ip-shaper.name. |
|
Schedule name. Source firewall.schedule.onetime.name firewall.schedule.recurring.name firewall.schedule.group.name. |
|
Service and service group names. |
|
Service name. Source firewall.service.custom.name firewall.service.group.name. |
|
IPv4 source address and address group names. |
|
Address name. Source firewall.address.name firewall.addrgrp.name. |
|
IPv6 source address and address group names. |
|
Address name. Source firewall.address6.name firewall.addrgrp6.name. |
|
One or more incoming (ingress) interfaces. |
|
Interface name. Source system.interface.name system.zone.name system.sdwan.zone.name. |
|
Enable/disable this traffic shaping policy. Choices:
|
|
ToS (Type of Service) value used for comparison. |
|
Non-zero bit positions are used for comparison while zero bit positions are ignored. |
|
Enable negated TOS match. Choices:
|
|
Traffic shaper to apply to traffic forwarded by the firewall policy. Source firewall.shaper.traffic-shaper.name. |
|
Traffic shaper to apply to response traffic received by the firewall policy. Source firewall.shaper.traffic-shaper.name. |
|
Traffic type. Choices:
|
|
IDs of one or more FortiGuard Web Filtering categories that this shaper applies traffic shaping to. |
|
URL category ID. see <a href=’#notes’>Notes</a>. |
|
Apply this traffic shaping policy to individual users that have authenticated with the FortiGate. |
|
User name. Source user.local.name. |
|
Universally Unique Identifier (UUID; automatically assigned but can be manually reset). |
|
Member attribute path to operate on. Delimited by a slash character if there are more than one attribute. Parameter marked with member_path is legitimate for doing member operation. |
|
Add or delete a member under specified attribute path. When member_state is specified, the state option is ignored. Choices:
|
|
mkey of self identifier |
|
Indicates whether to create or remove the object. Choices:
|
|
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. Default: |
Notes
Note
We highly recommend using your own value as the id instead of 0, while ‘0’ is a special placeholder that allows the backend to assign the latest available number for the object, it does have limitations. Please find more details in Q&A.
Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Adjust object order by moving self after(before) another.
Only one of [after, before] must be specified when action is moving an object.
The module supports check_mode.
Examples
- name: Configure shaping policies.
fortinet.fortios.fortios_firewall_shaping_policy:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
firewall_shaping_policy:
app_category:
-
id: "4"
app_group:
-
name: "default_name_6 (source application.group.name)"
application:
-
id: "8"
class_id: "0"
comment: "Comments."
cos: "<your_own_value>"
cos_mask: "<your_own_value>"
diffserv_forward: "enable"
diffserv_reverse: "enable"
diffservcode_forward: "<your_own_value>"
diffservcode_rev: "<your_own_value>"
dstaddr:
-
name: "default_name_18 (source firewall.address.name firewall.addrgrp.name)"
dstaddr6:
-
name: "default_name_20 (source firewall.address6.name firewall.addrgrp6.name)"
dstintf:
-
name: "default_name_22 (source system.interface.name system.zone.name system.sdwan.zone.name)"
groups:
-
name: "default_name_24 (source user.group.name)"
id: "25"
internet_service: "enable"
internet_service_custom:
-
name: "default_name_28 (source firewall.internet-service-custom.name)"
internet_service_custom_group:
-
name: "default_name_30 (source firewall.internet-service-custom-group.name)"
internet_service_group:
-
name: "default_name_32 (source firewall.internet-service-group.name)"
internet_service_id:
-
id: "34 (source firewall.internet-service.id)"
internet_service_name:
-
name: "default_name_36 (source firewall.internet-service-name.name)"
internet_service_src: "enable"
internet_service_src_custom:
-
name: "default_name_39 (source firewall.internet-service-custom.name)"
internet_service_src_custom_group:
-
name: "default_name_41 (source firewall.internet-service-custom-group.name)"
internet_service_src_group:
-
name: "default_name_43 (source firewall.internet-service-group.name)"
internet_service_src_id:
-
id: "45 (source firewall.internet-service.id)"
internet_service_src_name:
-
name: "default_name_47 (source firewall.internet-service-name.name)"
ip_version: "4"
name: "default_name_49"
per_ip_shaper: "<your_own_value> (source firewall.shaper.per-ip-shaper.name)"
schedule: "<your_own_value> (source firewall.schedule.onetime.name firewall.schedule.recurring.name firewall.schedule.group.name)"
service:
-
name: "default_name_53 (source firewall.service.custom.name firewall.service.group.name)"
srcaddr:
-
name: "default_name_55 (source firewall.address.name firewall.addrgrp.name)"
srcaddr6:
-
name: "default_name_57 (source firewall.address6.name firewall.addrgrp6.name)"
srcintf:
-
name: "default_name_59 (source system.interface.name system.zone.name system.sdwan.zone.name)"
status: "enable"
tos: "<your_own_value>"
tos_mask: "<your_own_value>"
tos_negate: "enable"
traffic_shaper: "<your_own_value> (source firewall.shaper.traffic-shaper.name)"
traffic_shaper_reverse: "<your_own_value> (source firewall.shaper.traffic-shaper.name)"
traffic_type: "forwarding"
url_category:
-
id: "68"
users:
-
name: "default_name_70 (source user.local.name)"
uuid: "<your_own_value>"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
Build number of the fortigate image Returned: always Sample: |
|
Last method used to provision the content into FortiGate Returned: always Sample: |
|
Last result given by FortiGate on last operation applied Returned: always Sample: |
|
Master key (id) used in the last call to FortiGate Returned: success Sample: |
|
Name of the table used to fulfill the request Returned: always Sample: |
|
Path of the table used to fulfill the request Returned: always Sample: |
|
Internal revision number Returned: always Sample: |
|
Serial number of the unit Returned: always Sample: |
|
Indication of the operation’s result Returned: always Sample: |
|
Virtual domain used Returned: always Sample: |
|
Version of the FortiGate Returned: always Sample: |