fortios_firewall_shaping_policy.rst

source:	fortios_firewall_shaping_policy.py
orphan:

fortios_firewall_shaping_policy -- Configure shaping policies in Fortinet's FortiOS and FortiGate.

.. versionadded:: 2.0.0

• Synopsis
• Requirements
• Tips
• FortiOS Version Compatibility
• Parameters
• Notes
• Examples
• Return Values
• Status
• Authors

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

Tips

Using member operation to add an element to an existing object.

FortiOS Version Compatibility

	Supported Version Ranges
fortios_firewall_shaping_policy	v6.0.0 -> latest

Parameters

• access_token - Token-based authentication. Generated from GUI of Fortigate. type: str required: false
• enable_log - Enable/Disable logging for task. type: bool required: false default: 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
• member_path - Member attribute path to operate on. type: str
• member_state - Add or delete a member under specified attribute path. type: str choices: present, absent
• action - the action indiactor to move an object in the list type: str choices: move
• self - mkey of self identifier type: str
• after - mkey of target identifier type: str
• before - mkey of target identifier type: str
• state - Indicates whether to create or remove the object. type: str required: false choices: present, absent
• firewall_shaping_policy - Configure shaping policies. type: dict more...

  	Supported Version Ranges
  firewall_shaping_policy	v6.0.0 -> latest

• app_category - IDs of one or more application categories that this shaper applies application control traffic shaping to. type: list member_path: app_category:id more...

  	Supported Version Ranges
  app_category	v6.0.0 -> latest

• id - Category IDs. see Notes. type: int required: true more...

  	Supported Version Ranges
  id	v6.0.0 -> latest

• app_group - One or more application group names. type: list member_path: app_group:name more...

  	Supported Version Ranges
  app_group	v6.2.0 -> latest

• name - Application group name. Source application.group.name. type: str required: true more...

  	Supported Version Ranges
  name	v6.2.0 -> latest

• application - IDs of one or more applications that this shaper applies application control traffic shaping to. type: list member_path: application:id more...

  	Supported Version Ranges
  application	v6.0.0 -> latest

• id - Application IDs. see Notes. type: int required: true more...

  	Supported Version Ranges
  id	v6.0.0 -> latest

• class_id - Traffic class ID. Source firewall.traffic-class.class-id. type: int more...

  	Supported Version Ranges
  class_id	v6.0.0 -> latest

• comment - Comments. type: str more...

  	Supported Version Ranges
  comment	v6.0.0 -> latest

• cos - VLAN CoS bit pattern. type: str more...

  	Supported Version Ranges
  cos	v7.4.0 -> latest

• cos_mask - VLAN CoS evaluated bits. type: str more...

  	Supported Version Ranges
  cos_mask	v7.4.0 -> latest

• diffserv_forward - Enable to change packet"s DiffServ values to the specified diffservcode-forward value. type: str choices: enable, disable more...

  	Supported Version Ranges
  diffserv_forward	v6.2.0 -> latest
  [enable]	v6.0.0 -> latest
  [disable]	v6.0.0 -> latest

• diffserv_reverse - Enable to change packet"s reverse (reply) DiffServ values to the specified diffservcode-rev value. type: str choices: enable, disable more...

  	Supported Version Ranges
  diffserv_reverse	v6.2.0 -> latest
  [enable]	v6.0.0 -> latest
  [disable]	v6.0.0 -> latest

• diffservcode_forward - Change packet"s DiffServ to this value. type: str more...

  	Supported Version Ranges
  diffservcode_forward	v6.2.0 -> latest

• diffservcode_rev - Change packet"s reverse (reply) DiffServ to this value. type: str more...

  	Supported Version Ranges
  diffservcode_rev	v6.2.0 -> latest

• dstaddr - IPv4 destination address and address group names. type: list member_path: dstaddr:name more...

  	Supported Version Ranges
  dstaddr	v6.0.0 -> latest

• name - Address name. Source firewall.address.name firewall.addrgrp.name. type: str required: true more...

  	Supported Version Ranges
  name	v6.0.0 -> latest

• dstaddr6 - IPv6 destination address and address group names. type: list member_path: dstaddr6:name more...

  	Supported Version Ranges
  dstaddr6	v6.0.0 -> latest

• name - Address name. Source firewall.address6.name firewall.addrgrp6.name. type: str required: true more...

  	Supported Version Ranges
  name	v6.0.0 -> latest

• dstintf - One or more outgoing (egress) interfaces. type: list member_path: dstintf:name more...

  	Supported Version Ranges
  dstintf	v6.0.0 -> latest

• name - Interface name. Source system.interface.name system.zone.name system.sdwan.zone.name. type: str required: true more...

  	Supported Version Ranges
  name	v6.0.0 -> latest

• groups - Apply this traffic shaping policy to user groups that have authenticated with the FortiGate. type: list member_path: groups:name more...

  	Supported Version Ranges
  groups	v6.0.0 -> latest

• name - Group name. Source user.group.name. type: str required: true more...

  	Supported Version Ranges
  name	v6.0.0 -> latest

• id - Shaping policy ID (0 - 4294967295). see Notes. type: int required: true more...

  	Supported Version Ranges
  id	v6.0.0 -> latest

• 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 more...

  	Supported Version Ranges
  internet_service	v6.0.0 -> latest
  [enable]	v6.0.0 -> latest
  [disable]	v6.0.0 -> latest

• internet_service_custom - Custom Internet Service name. type: list member_path: internet_service_custom:name more...

  	Supported Version Ranges
  internet_service_custom	v6.0.0 -> latest

• name - Custom Internet Service name. Source firewall.internet-service-custom.name. type: str required: true more...

  	Supported Version Ranges
  name	v6.0.0 -> latest

• internet_service_custom_group - Custom Internet Service group name. type: list member_path: internet_service_custom_group:name more...

  	Supported Version Ranges
  internet_service_custom_group	v6.2.0 -> latest

• name - Custom Internet Service group name. Source firewall.internet-service-custom-group.name. type: str required: true more...

  	Supported Version Ranges
  name	v6.2.0 -> latest

• internet_service_group - Internet Service group name. type: list member_path: internet_service_group:name more...

  	Supported Version Ranges
  internet_service_group	v6.2.0 -> latest

• name - Internet Service group name. Source firewall.internet-service-group.name. type: str required: true more...

  	Supported Version Ranges
  name	v6.2.0 -> latest

• internet_service_id - Internet Service ID. type: list member_path: internet_service_id:id more...

  	Supported Version Ranges
  internet_service_id	v6.0.0 -> v6.2.7

• id - Internet Service ID. see Notes. Source firewall.internet-service.id. type: int required: true more...

  	Supported Version Ranges
  id	v6.0.0 -> v6.2.7

• internet_service_name - Internet Service ID. type: list member_path: internet_service_name:name more...

  	Supported Version Ranges
  internet_service_name	v6.4.0 -> latest

• name - Internet Service name. Source firewall.internet-service-name.name. type: str required: true more...

  	Supported Version Ranges
  name	v6.4.0 -> latest

• 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 more...

  	Supported Version Ranges
  internet_service_src	v6.0.0 -> latest
  [enable]	v6.0.0 -> latest
  [disable]	v6.0.0 -> latest

• internet_service_src_custom - Custom Internet Service source name. type: list member_path: internet_service_src_custom:name more...

  	Supported Version Ranges
  internet_service_src_custom	v6.0.0 -> latest

• name - Custom Internet Service name. Source firewall.internet-service-custom.name. type: str required: true more...

  	Supported Version Ranges
  name	v6.0.0 -> latest

• internet_service_src_custom_group - Custom Internet Service source group name. type: list member_path: internet_service_src_custom_group:name more...

  	Supported Version Ranges
  internet_service_src_custom_group	v6.2.0 -> latest

• name - Custom Internet Service group name. Source firewall.internet-service-custom-group.name. type: str required: true more...

  	Supported Version Ranges
  name	v6.2.0 -> latest

• internet_service_src_group - Internet Service source group name. type: list member_path: internet_service_src_group:name more...

  	Supported Version Ranges
  internet_service_src_group	v6.2.0 -> latest

• name - Internet Service group name. Source firewall.internet-service-group.name. type: str required: true more...

  	Supported Version Ranges
  name	v6.2.0 -> latest

• internet_service_src_id - Internet Service source ID. type: list member_path: internet_service_src_id:id more...

  	Supported Version Ranges
  internet_service_src_id	v6.0.0 -> v6.2.7

• id - Internet Service ID. see Notes. Source firewall.internet-service.id. type: int required: true more...

  	Supported Version Ranges
  id	v6.0.0 -> v6.2.7

• internet_service_src_name - Internet Service source name. type: list member_path: internet_service_src_name:name more...

  	Supported Version Ranges
  internet_service_src_name	v6.4.0 -> latest

• name - Internet Service name. Source firewall.internet-service-name.name. type: str required: true more...

  	Supported Version Ranges
  name	v6.4.0 -> latest

• ip_version - Apply this traffic shaping policy to IPv4 or IPv6 traffic. type: str choices: 4, 6 more...

  	Supported Version Ranges
  ip_version	v6.0.0 -> latest
  [4]	v6.0.0 -> latest
  [6]	v6.0.0 -> latest

• name - Shaping policy name. type: str more...

  	Supported Version Ranges
  name	v6.2.0 -> latest

• per_ip_shaper - Per-IP traffic shaper to apply with this policy. Source firewall.shaper.per-ip-shaper.name. type: str more...

  	Supported Version Ranges
  per_ip_shaper	v6.0.0 -> latest

• schedule - Schedule name. Source firewall.schedule.onetime.name firewall.schedule.recurring.name firewall.schedule.group.name. type: str more...

  	Supported Version Ranges
  schedule	v6.0.0 -> latest

• service - Service and service group names. type: list member_path: service:name more...

  	Supported Version Ranges
  service	v6.0.0 -> latest

• name - Service name. Source firewall.service.custom.name firewall.service.group.name. type: str required: true more...

  	Supported Version Ranges
  name	v6.0.0 -> latest

• srcaddr - IPv4 source address and address group names. type: list member_path: srcaddr:name more...

  	Supported Version Ranges
  srcaddr	v6.0.0 -> latest

• name - Address name. Source firewall.address.name firewall.addrgrp.name. type: str required: true more...

  	Supported Version Ranges
  name	v6.0.0 -> latest

• srcaddr6 - IPv6 source address and address group names. type: list member_path: srcaddr6:name more...

  	Supported Version Ranges
  srcaddr6	v6.0.0 -> latest

• name - Address name. Source firewall.address6.name firewall.addrgrp6.name. type: str required: true more...

  	Supported Version Ranges
  name	v6.0.0 -> latest

• srcintf - One or more incoming (ingress) interfaces. type: list member_path: srcintf:name more...

  	Supported Version Ranges
  srcintf	v6.2.0 -> latest

• name - Interface name. Source system.interface.name system.zone.name system.sdwan.zone.name. type: str required: true more...

  	Supported Version Ranges
  name	v6.2.0 -> latest

• status - Enable/disable this traffic shaping policy. type: str choices: enable, disable more...

  	Supported Version Ranges
  status	v6.0.0 -> latest
  [enable]	v6.0.0 -> latest
  [disable]	v6.0.0 -> latest

• tos - ToS (Type of Service) value used for comparison. type: str more...

  	Supported Version Ranges
  tos	v6.2.0 -> latest

• tos_mask - Non-zero bit positions are used for comparison while zero bit positions are ignored. type: str more...

  	Supported Version Ranges
  tos_mask	v6.2.0 -> latest

• tos_negate - Enable negated TOS match. type: str choices: enable, disable more...

  	Supported Version Ranges
  tos_negate	v6.2.0 -> latest
  [enable]	v6.0.0 -> latest
  [disable]	v6.0.0 -> latest

• traffic_shaper - Traffic shaper to apply to traffic forwarded by the firewall policy. Source firewall.shaper.traffic-shaper.name. type: str more...

  	Supported Version Ranges
  traffic_shaper	v6.0.0 -> latest

• traffic_shaper_reverse - Traffic shaper to apply to response traffic received by the firewall policy. Source firewall.shaper.traffic-shaper.name. type: str more...

  	Supported Version Ranges
  traffic_shaper_reverse	v6.0.0 -> latest

• traffic_type - Traffic type. type: str choices: forwarding, local-in, local-out more...

  	Supported Version Ranges
  traffic_type	v7.4.0 -> latest
  [forwarding]	v6.0.0 -> latest
  [local-in]	v6.0.0 -> latest
  [local-out]	v6.0.0 -> latest

• url_category - IDs of one or more FortiGuard Web Filtering categories that this shaper applies traffic shaping to. type: list member_path: url_category:id more...

  	Supported Version Ranges
  url_category	v6.0.0 -> latest

• id - URL category ID. see Notes. type: int required: true more...

  	Supported Version Ranges
  id	v6.0.0 -> latest

• users - Apply this traffic shaping policy to individual users that have authenticated with the FortiGate. type: list member_path: users:name more...

  	Supported Version Ranges
  users	v6.0.0 -> latest

• name - User name. Source user.local.name. type: str required: true more...

  	Supported Version Ranges
  name	v6.0.0 -> latest

• uuid - Universally Unique Identifier (UUID; automatically assigned but can be manually reset). type: str more...

  	Supported Version Ranges
  uuid	v7.2.1 -> latest

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.

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: 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

Status

• This module is not guaranteed to have a backwards compatible interface.

Authors

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

Hint

If you notice any issues in this documentation, you can create a pull request to improve it.