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

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

New in version 2.8.

• Synopsis
• Requirements
• Parameters
• Notes
• Examples
• Return Values
• Status

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.5

Requirements

The below requirements are needed on the host that executes this module.

• fortiosapi>=0.9.8

Parameters

Parameter			Choices/Defaults	Comments
firewall_shaping_policy dictionary			Default: null	Configure shaping policies.
	app_category list			IDs of one or more application categories that this shaper applies application control traffic shaping to.
		id integer / required		Category IDs.
	application list			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.
	comment string			Comments.
	dstaddr list			IPv4 destination address and address group names.
		name string / required		Address name. Source firewall.address.name firewall.addrgrp.name.
	dstaddr6 list			IPv6 destination address and address group names.
		name string / required		Address name. Source firewall.address6.name firewall.addrgrp6.name.
	dstintf list			One or more outgoing (egress) interfaces.
		name string / required		Interface name. Source system.interface.name system.zone.name.
	groups list			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	Enable/disable use of Internet Services for this policy. If enabled, destination address and service are not used.
	internet_service_custom list			Custom Internet Service name.
		name string / required		Custom Internet Service name. Source firewall.internet-service-custom.name.
	internet_service_id list			Internet Service ID.
		id integer / required		Internet Service ID. Source firewall.internet-service.id.
	internet_service_src string		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			Custom Internet Service source name.
		name string / required		Custom Internet Service name. Source firewall.internet-service-custom.name.
	internet_service_src_id list			Internet Service source ID.
		id integer / required		Internet Service ID. Source firewall.internet-service.id.
	ip_version string		4 6	Apply this traffic shaping policy to IPv4 or IPv6 traffic.
	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			Service and service group names.
		name string / required		Service name. Source firewall.service.custom.name firewall.service.group.name.
	srcaddr list			IPv4 source address and address group names.
		name string / required		Address name. Source firewall.address.name firewall.addrgrp.name.
	srcaddr6 list			IPv6 source address and address group names.
		name string / required		Address name. Source firewall.address6.name firewall.addrgrp6.name.
	state string		present absent	Deprecated Starting with Ansible 2.9 we recommend using the top-level 'state' parameter. Indicates whether to create or remove the object.
	status string		enable disable	Enable/disable this traffic shaping policy.
	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			IDs of one or more FortiGuard Web Filtering categories that this shaper applies traffic shaping to.
		id integer / required		URL category ID.
	users list			Apply this traffic shaping policy to individual users that have authenticated with the FortiGate.
		name string / required		User name. Source user.local.name.
host string				FortiOS or FortiGate IP address.
https boolean			no yes ←	Indicates if the requests towards FortiGate must use HTTPS protocol.
password string			Default: ""	FortiOS or FortiGate password.
ssl_verify boolean added in 2.9			no yes ←	Ensures FortiGate certificate must be verified by a proper CA.
state string added in 2.9			present absent	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.
username string				FortiOS or FortiGate username.
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

• Requires fortiosapi library developed by Fortinet
• Run as a local_action in your playbook

Examples

- hosts: localhost
  vars:
   host: "192.168.122.40"
   username: "admin"
   password: ""
   vdom: "root"
   ssl_verify: "False"
  tasks:
  - name: Configure shaping policies.
    fortios_firewall_shaping_policy:
      host:  "{{ host }}"
      username: "{{ username }}"
      password: "{{ password }}"
      vdom:  "{{ vdom }}"
      https: "False"
      state: "present"
      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 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

Status

• This module is not guaranteed to have a backwards compatible interface. [preview]
• This module is maintained by the Ansible Community. [community]

Authors

• Miguel Angel Munoz (@mamunozgonzalez)
• Nicolas Thomas (@thomnico)

Hint

If you notice any issues in this documentation, you can edit this document to improve it.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/fortios_firewall_shaping_policy_module.html