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

From Get docs
Ansible/docs/2.10/collections/fortinet/fortios/fortios firewall shaping policy module


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

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

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.

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.

comment

string

Comments.

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

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_id

list / elements=string

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 / elements=string

Custom Internet Service source name.

name

string / required

Custom Internet Service name. Source firewall.internet-service-custom.name.

internet_service_src_id

list / elements=string

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

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

added in 2.9 of fortinet.fortios

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

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




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–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/fortinet/fortios/fortios_firewall_shaping_policy_module.html


Retrieved from "https://getdocs.org/index.php?title=Ansible/docs/2.10/collections/fortinet/fortios/fortios_firewall_shaping_policy_module&oldid=58618"
Powered by MediaWiki