You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible documentation.

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.3).

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	Comments
access_token string	Token-based authentication. Generated from GUI of Fortigate.
enable_log boolean	Enable/Disable logging for task. Choices: no ← (default) yes
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	Enable to change packet”s DiffServ values to the specified diffservcode-forward value. Choices: enable disable
diffserv_reverse string	Enable to change packet”s reverse (reply) DiffServ values to the specified diffservcode-rev value. Choices: enable disable
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	Enable/disable use of Internet Services for this policy. If enabled, destination address and service are not used. Choices: enable disable
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	Enable/disable use of Internet Services in source for this policy. If enabled, source address is not used. Choices: enable disable
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	Apply this traffic shaping policy to IPv4 or IPv6 traffic. Choices: 4 6
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	Enable/disable this traffic shaping policy. Choices: enable disable
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	Enable negated TOS match. Choices: enable disable
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.
member_path string	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.
member_state string	Add or delete a member under specified attribute path. When member_state is specified, the state option is ignored. Choices: present absent
state string / required	Indicates whether to create or remove the object. Choices: present absent
vdom string	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: “root”

Notes

Note

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

Examples

- collections:
  - fortinet.fortios
  connection: httpapi
  hosts: fortigate01
  vars:
    ansible_httpapi_port: 443
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    vdom: root
  tasks:
  - name: fortios_firewall_shaping_policy
    fortios_firewall_shaping_policy:
      vdom: root
      state: present
      firewall_shaping_policy:
        class_id: 0
        diffserv_forward: disable
        diffserv_reverse: disable
        diffservcode_forward: '000000'
        diffservcode_rev: '000000'
        dstaddr:
        - name: all
        dstintf:
        - name: port4
        id: 1
        internet_service: disable
        internet_service_src: disable
        ip_version: '4'
        name: shapingpolicys1
        service:
        - name: ALL
        srcaddr:
        - name: all
        status: enable
        tos: '0x00'
        tos_mask: '0x00'
        tos_negate: disable

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Description
build string	Build number of the fortigate image Returned: always Sample: “1547”
http_method string	Last method used to provision the content into FortiGate Returned: always Sample: “PUT”
http_status string	Last result given by FortiGate on last operation applied Returned: always Sample: “200”
mkey string	Master key (id) used in the last call to FortiGate Returned: success Sample: “id”
name string	Name of the table used to fulfill the request Returned: always Sample: “urlfilter”
path string	Path of the table used to fulfill the request Returned: always Sample: “webfilter”
revision string	Internal revision number Returned: always Sample: “17.0.2.10658”
serial string	Serial number of the unit Returned: always Sample: “FGVMEVYYQT3AB5352”
status string	Indication of the operation’s result Returned: always Sample: “success”
vdom string	Virtual domain used Returned: always Sample: “root”
version string	Version of the FortiGate Returned: always 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)