fortios_firewall_shaping_policy – Configure shaping policies in Fortinet’s FortiOS and FortiGate.¶
New in version 2.8.
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.9.0
Parameters¶
- access_token - Token-based authentication. Generated from GUI of Fortigate. type: str required: False
- vdom - 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. type: str default: root
- state - Indicates whether to create or remove the object. This attribute was present already in previous version in a deeper level. It has been moved out to this outer level. type: str required: False choices: present, absent
- firewall_shaping_policy - Configure shaping policies. type: dict
- state - B(Deprecated) type: str required: False choices: present, absent
- app_category - IDs of one or more application categories that this shaper applies application control traffic shaping to. type: list
- id - Category IDs. type: int required: True
- application - IDs of one or more applications that this shaper applies application control traffic shaping to. type: list
- id - Application IDs. type: int required: True
- class_id - Traffic class ID. type: int
- comment - Comments. type: str
- dstaddr - IPv4 destination address and address group names. type: list
- name - Address name. Source firewall.address.name firewall.addrgrp.name. type: str required: True
- dstaddr6 - IPv6 destination address and address group names. type: list
- name - Address name. Source firewall.address6.name firewall.addrgrp6.name. type: str required: True
- dstintf - One or more outgoing (egress) interfaces. type: list
- name - Interface name. Source system.interface.name system.zone.name. type: str required: True
- groups - Apply this traffic shaping policy to user groups that have authenticated with the FortiGate. type: list
- name - Group name. Source user.group.name. type: str required: True
- id - Shaping policy ID. type: int required: True
- internet_service - Enable/disable use of Internet Services for this policy. If enabled, destination address and service are not used. type: str choices: enable, disable
- internet_service_custom - Custom Internet Service name. type: list
- name - Custom Internet Service name. Source firewall.internet-service-custom.name. type: str required: True
- internet_service_id - Internet Service ID. type: list
- id - Internet Service ID. Source firewall.internet-service.id. type: int required: True
- internet_service_src - Enable/disable use of Internet Services in source for this policy. If enabled, source address is not used. type: str choices: enable, disable
- internet_service_src_custom - Custom Internet Service source name. type: list
- name - Custom Internet Service name. Source firewall.internet-service-custom.name. type: str required: True
- internet_service_src_id - Internet Service source ID. type: list
- id - Internet Service ID. Source firewall.internet-service.id. type: int required: True
- ip_version - Apply this traffic shaping policy to IPv4 or IPv6 traffic. type: str choices: 4, 6
- per_ip_shaper - Per-IP traffic shaper to apply with this policy. Source firewall.shaper.per-ip-shaper.name. type: str
- schedule - Schedule name. Source firewall.schedule.onetime.name firewall.schedule.recurring.name firewall.schedule.group.name. type: str
- service - Service and service group names. type: list
- name - Service name. Source firewall.service.custom.name firewall.service.group.name. type: str required: True
- srcaddr - IPv4 source address and address group names. type: list
- name - Address name. Source firewall.address.name firewall.addrgrp.name. type: str required: True
- srcaddr6 - IPv6 source address and address group names. type: list
- name - Address name. Source firewall.address6.name firewall.addrgrp6.name. type: str required: True
- status - Enable/disable this traffic shaping policy. type: str choices: enable, disable
- traffic_shaper - Traffic shaper to apply to traffic forwarded by the firewall policy. Source firewall.shaper.traffic-shaper.name. type: str
- traffic_shaper_reverse - Traffic shaper to apply to response traffic received by the firewall policy. Source firewall.shaper.traffic-shaper.name. type: str
- url_category - IDs of one or more FortiGuard Web Filtering categories that this shaper applies traffic shaping to. type: list
- id - URL category ID. type: int required: True
- users - Apply this traffic shaping policy to individual users that have authenticated with the FortiGate. type: list
- name - User name. Source user.local.name. type: str required: True
Examples¶
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure shaping policies.
fortios_firewall_shaping_policy:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
firewall_shaping_policy:
app_category:
-
id: "4"
application:
-
id: "6"
class_id: "7"
comment: "Comments."
dstaddr:
-
name: "default_name_10 (source firewall.address.name firewall.addrgrp.name)"
dstaddr6:
-
name: "default_name_12 (source firewall.address6.name firewall.addrgrp6.name)"
dstintf:
-
name: "default_name_14 (source system.interface.name system.zone.name)"
groups:
-
name: "default_name_16 (source user.group.name)"
id: "17"
internet_service: "enable"
internet_service_custom:
-
name: "default_name_20 (source firewall.internet-service-custom.name)"
internet_service_id:
-
id: "22 (source firewall.internet-service.id)"
internet_service_src: "enable"
internet_service_src_custom:
-
name: "default_name_25 (source firewall.internet-service-custom.name)"
internet_service_src_id:
-
id: "27 (source firewall.internet-service.id)"
ip_version: "4"
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_32 (source firewall.service.custom.name firewall.service.group.name)"
srcaddr:
-
name: "default_name_34 (source firewall.address.name firewall.addrgrp.name)"
srcaddr6:
-
name: "default_name_36 (source firewall.address6.name firewall.addrgrp6.name)"
status: "enable"
traffic_shaper: "<your_own_value> (source firewall.shaper.traffic-shaper.name)"
traffic_shaper_reverse: "<your_own_value> (source firewall.shaper.traffic-shaper.name)"
url_category:
-
id: "41"
users:
-
name: "default_name_43 (source user.local.name)"
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:
- build - Build number of the fortigate image returned: always type: str sample: 1547
- http_method - Last method used to provision the content into FortiGate returned: always type: str sample: PUT
- http_status - Last result given by FortiGate on last operation applied returned: always type: str sample: 200
- mkey - Master key (id) used in the last call to FortiGate returned: success type: str sample: id
- name - Name of the table used to fulfill the request returned: always type: str sample: urlfilter
- path - Path of the table used to fulfill the request returned: always type: str sample: webfilter
- revision - Internal revision number returned: always type: str sample: 17.0.2.10658
- serial - Serial number of the unit returned: always type: str sample: FGVMEVYYQT3AB5352
- status - Indication of the operation's result returned: always type: str sample: success
- vdom - Virtual domain used returned: always type: str sample: root
- version - Version of the FortiGate returned: always type: str sample: v5.6.3