Docs4dev
Docs
ansible / latest / collections / fortinet / fortios / fortios_firewall_shaping_policy_module.html

fortinet.fortios.fortios_firewall_shaping_policy – Configure shaping policies in Fortinet’s FortiOS and FortiGate.

Note

This plugin is part of the fortinet.fortios collection (version 2.1.2).

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.

To use it in a playbook, specify: fortinet.fortios.fortios_firewall_shaping_policy.

New in version 2.10: of fortinet.fortios

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

Parameter Choices/Defaults Comments
access_token
string
Token-based authentication. Generated from GUI of Fortigate.
enable_log
boolean
    Choices:
  • no ←
  • yes
Enable/Disable logging for task.
firewall_shaping_policy
dictionary
Configure shaping policies.
app_category
list / elements=string
IDs of one or more application categories that this shaper applies application control traffic shaping to.
id
integer / required
Category IDs.
app_group
list / elements=string
One or more application group names.
name
string / required
Application group name. Source application.group.name.
application
list / elements=string
IDs of one or more applications that this shaper applies application control traffic shaping to.
id
integer / required
Application IDs.
class_id
integer
Traffic class ID. Source firewall.traffic-class.class-id.
comment
string
Comments.
diffserv_forward
string
    Choices:
  • enable
  • disable
Enable to change packet"s DiffServ values to the specified diffservcode-forward value.
diffserv_reverse
string
    Choices:
  • enable
  • disable
Enable to change packet"s reverse (reply) DiffServ values to the specified diffservcode-rev value.
diffservcode_forward
string
Change packet"s DiffServ to this value.
diffservcode_rev
string
Change packet"s reverse (reply) DiffServ to this value.
dstaddr
list / elements=string
IPv4 destination address and address group names.
name
string / required
Address name. Source firewall.address.name firewall.addrgrp.name.
dstaddr6
list / elements=string
IPv6 destination address and address group names.
name
string / required
Address name. Source firewall.address6.name firewall.addrgrp6.name.
dstintf
list / elements=string
One or more outgoing (egress) interfaces.
name
string / required
Interface name. Source system.interface.name system.zone.name.
groups
list / elements=string
Apply this traffic shaping policy to user groups that have authenticated with the FortiGate.
name
string / required
Group name. Source user.group.name.
id
integer / required
Shaping policy ID.
internet_service
string
    Choices:
  • enable
  • disable
Enable/disable use of Internet Services for this policy. If enabled, destination address and service are not used.
internet_service_custom
list / elements=string
Custom Internet Service name.
name
string / required
Custom Internet Service name. Source firewall.internet-service-custom.name.
internet_service_custom_group
list / elements=string
Custom Internet Service group name.
name
string / required
Custom Internet Service group name. Source firewall.internet-service-custom-group.name.
internet_service_group
list / elements=string
Internet Service group name.
name
string / required
Internet Service group name. Source firewall.internet-service-group.name.
internet_service_id
list / elements=string
Internet Service ID.
id
integer / required
Internet Service ID. Source firewall.internet-service.id.
internet_service_name
list / elements=string
Internet Service ID.
name
string / required
Internet Service name. Source firewall.internet-service-name.name.
internet_service_src
string
    Choices:
  • enable
  • disable
Enable/disable use of Internet Services in source for this policy. If enabled, source address is not used.
internet_service_src_custom
list / elements=string
Custom Internet Service source name.
name
string / required
Custom Internet Service name. Source firewall.internet-service-custom.name.
internet_service_src_custom_group
list / elements=string
Custom Internet Service source group name.
name
string / required
Custom Internet Service group name. Source firewall.internet-service-custom-group.name.
internet_service_src_group
list / elements=string
Internet Service source group name.
name
string / required
Internet Service group name. Source firewall.internet-service-group.name.
internet_service_src_id
list / elements=string
Internet Service source ID.
id
integer / required
Internet Service ID. Source firewall.internet-service.id.
internet_service_src_name
list / elements=string
Internet Service source name.
name
string / required
Internet Service name. Source firewall.internet-service-name.name.
ip_version
string
    Choices:
  • 4
  • 6
Apply this traffic shaping policy to IPv4 or IPv6 traffic.
name
string
Shaping policy name.
per_ip_shaper
string
Per-IP traffic shaper to apply with this policy. Source firewall.shaper.per-ip-shaper.name.
schedule
string
Schedule name. Source firewall.schedule.onetime.name firewall.schedule.recurring.name firewall.schedule.group.name.
service
list / elements=string
Service and service group names.
name
string / required
Service name. Source firewall.service.custom.name firewall.service.group.name.
srcaddr
list / elements=string
IPv4 source address and address group names.
name
string / required
Address name. Source firewall.address.name firewall.addrgrp.name.
srcaddr6
list / elements=string
IPv6 source address and address group names.
name
string / required
Address name. Source firewall.address6.name firewall.addrgrp6.name.
srcintf
list / elements=string
One or more incoming (ingress) interfaces.
name
string / required
Interface name. Source system.interface.name system.zone.name.
status
string
    Choices:
  • enable
  • disable
Enable/disable this traffic shaping policy.
tos
string
ToS (Type of Service) value used for comparison.
tos_mask
string
Non-zero bit positions are used for comparison while zero bit positions are ignored.
tos_negate
string
    Choices:
  • enable
  • disable
Enable negated TOS match.
traffic_shaper
string
Traffic shaper to apply to traffic forwarded by the firewall policy. Source firewall.shaper.traffic-shaper.name.
traffic_shaper_reverse
string
Traffic shaper to apply to response traffic received by the firewall policy. Source firewall.shaper.traffic-shaper.name.
url_category
list / elements=string
IDs of one or more FortiGuard Web Filtering categories that this shaper applies traffic shaping to.
id
integer / required
URL category ID.
users
list / elements=string
Apply this traffic shaping policy to individual users that have authenticated with the FortiGate.
name
string / required
User name. Source user.local.name.
state
string / required
    Choices:
  • present
  • absent
Indicates whether to create or remove the object.
vdom
string
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.

Notes

Note

  • Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks

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"
        app_group:
         -
            name: "default_name_6 (source application.group.name)"
        application:
         -
            id:  "8"
        class_id: "9 (source firewall.traffic-class.class-id)"
        comment: "Comments."
        diffserv_forward: "enable"
        diffserv_reverse: "enable"
        diffservcode_forward: "<your_own_value>"
        diffservcode_rev: "<your_own_value>"
        dstaddr:
         -
            name: "default_name_16 (source firewall.address.name firewall.addrgrp.name)"
        dstaddr6:
         -
            name: "default_name_18 (source firewall.address6.name firewall.addrgrp6.name)"
        dstintf:
         -
            name: "default_name_20 (source system.interface.name system.zone.name)"
        groups:
         -
            name: "default_name_22 (source user.group.name)"
        id:  "23"
        internet_service: "enable"
        internet_service_custom:
         -
            name: "default_name_26 (source firewall.internet-service-custom.name)"
        internet_service_custom_group:
         -
            name: "default_name_28 (source firewall.internet-service-custom-group.name)"
        internet_service_group:
         -
            name: "default_name_30 (source firewall.internet-service-group.name)"
        internet_service_id:
         -
            id:  "32 (source firewall.internet-service.id)"
        internet_service_name:
         -
            name: "default_name_34 (source firewall.internet-service-name.name)"
        internet_service_src: "enable"
        internet_service_src_custom:
         -
            name: "default_name_37 (source firewall.internet-service-custom.name)"
        internet_service_src_custom_group:
         -
            name: "default_name_39 (source firewall.internet-service-custom-group.name)"
        internet_service_src_group:
         -
            name: "default_name_41 (source firewall.internet-service-group.name)"
        internet_service_src_id:
         -
            id:  "43 (source firewall.internet-service.id)"
        internet_service_src_name:
         -
            name: "default_name_45 (source firewall.internet-service-name.name)"
        ip_version: "4"
        name: "default_name_47"
        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_51 (source firewall.service.custom.name firewall.service.group.name)"
        srcaddr:
         -
            name: "default_name_53 (source firewall.address.name firewall.addrgrp.name)"
        srcaddr6:
         -
            name: "default_name_55 (source firewall.address6.name firewall.addrgrp6.name)"
        srcintf:
         -
            name: "default_name_57 (source system.interface.name system.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)"
        url_category:
         -
            id:  "65"
        users:
         -
            name: "default_name_67 (source user.local.name)"

Return Values

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


Authors

  • Link Zheng (@chillancezen)
  • Jie Xue (@JieX19)
  • Hongbin Lu (@fgtdev-hblu)
  • Frank Shen (@frankshen01)
  • Miguel Angel Munoz (@mamunozgonzalez)
  • Nicolas Thomas (@thomnico)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortios/fortios_firewall_shaping_policy_module.html