fortinet.fortimanager.fmgr_pkg_firewall_shapingpolicy module – Configure shaping policies.

Note

This module is part of the fortinet.fortimanager collection (version 2.2.0).

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

To use it in a playbook, specify: fortinet.fortimanager.fmgr_pkg_firewall_shapingpolicy.

New in fortinet.fortimanager 2.0.0

Synopsis

  • This module is able to configure a FortiManager device.

  • Examples include all parameters and values which need to be adjusted to data sources before usage.

Parameters

Parameter

Comments

access_token

string

The token to access FortiManager without using username and password.

adom

string / required

the parameter (adom) in requested url

bypass_validation

boolean

Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters.

Choices:

  • false ← (default)

  • true

enable_log

boolean

Enable/Disable logging for task.

Choices:

  • false ← (default)

  • true

forticloud_access_token

string

Authenticate Ansible client with forticloud API access token.

pkg

string / required

the parameter (pkg) in requested url

pkg_firewall_shapingpolicy

dictionary

the top level parameters set

app-category

string

IDs of one or more application categories that this shaper applies application control traffic shaping to.

app-group

string

One or more application group names.

application

integer

IDs of one or more applications that this shaper applies application control traffic shaping to.

class-id

integer

Traffic class ID.

comment

string

Comments.

cos

string

VLAN CoS bit pattern.

cos-mask

string

VLAN CoS evaluated bits.

diffserv-forward

string

Enable to change packets DiffServ values to the specified diffservcode-forward value.

Choices:

  • "disable"

  • "enable"

diffserv-reverse

string

Enable to change packets reverse

Choices:

  • "disable"

  • "enable"

diffservcode-forward

string

Change packets DiffServ to this value.

diffservcode-rev

string

Change packets reverse

dstaddr

string

IPv4 destination address and address group names.

dstaddr6

string

IPv6 destination address and address group names.

dstintf

string

One or more outgoing

groups

string

Apply this traffic shaping policy to user groups that have authenticated with the FortiGate.

id

integer

Shaping policy ID.

internet-service

string

Enable/disable use of Internet Services for this policy.

Choices:

  • "disable"

  • "enable"

internet-service-custom

string

Custom Internet Service name.

internet-service-custom-group

string

Custom Internet Service group name.

internet-service-group

string

Internet Service group name.

internet-service-id

string

Internet Service ID.

internet-service-name

string

Internet Service ID.

internet-service-src

string

Enable/disable use of Internet Services in source for this policy.

Choices:

  • "disable"

  • "enable"

internet-service-src-custom

string

Custom Internet Service source name.

internet-service-src-custom-group

string

Custom Internet Service source group name.

internet-service-src-group

string

Internet Service source group name.

internet-service-src-id

string

Internet Service source ID.

internet-service-src-name

string

Internet Service source 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.

schedule

string

Schedule name.

service

string

Service and service group names.

srcaddr

string

IPv4 source address and address group names.

srcaddr6

string

IPv6 source address and address group names.

srcintf

string

One or more incoming

status

string

Enable/disable this traffic shaping policy.

Choices:

  • "disable"

  • "enable"

tos

string

ToS

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:

  • "disable"

  • "enable"

traffic-shaper

string

Traffic shaper to apply to traffic forwarded by the firewall policy.

traffic-shaper-reverse

string

Traffic shaper to apply to response traffic received by the firewall policy.

traffic-type

string

Traffic type.

Choices:

  • "forwarding"

  • "local-in"

  • "local-out"

url-category

string

IDs of one or more FortiGuard Web Filtering categories that this shaper applies traffic shaping to.

users

string

Apply this traffic shaping policy to individual users that have authenticated with the FortiGate.

uuid

string

Universally Unique Identifier

proposed_method

string

The overridden method for the underlying Json RPC request.

Choices:

  • "update"

  • "set"

  • "add"

rc_failed

list / elements=integer

The rc codes list with which the conditions to fail will be overriden.

rc_succeeded

list / elements=integer

The rc codes list with which the conditions to succeed will be overriden.

state

string / required

The directive to create, update or delete an object.

Choices:

  • "present"

  • "absent"

workspace_locking_adom

string

The adom to lock for FortiManager running in workspace mode, the value can be global and others including root.

workspace_locking_timeout

integer

The maximum time in seconds to wait for other user to release the workspace lock.

Default: 300

Notes

Note

  • Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace_locking_adom and workspace_locking_timeout help do the work.

  • To create or update an object, use state present directive.

  • To delete an object, use state absent directive.

  • Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc_failed and rc_succeeded

Examples

- name: gathering fortimanager facts
  hosts: fortimanager00
  gather_facts: no
  connection: httpapi
  collections:
    - fortinet.fortimanager
  vars:
    ansible_httpapi_use_ssl: True
    ansible_httpapi_validate_certs: False
    ansible_httpapi_port: 443
  tasks:
   - name: retrieve all the shaping policies
     fmgr_fact:
       facts:
           selector: 'pkg_firewall_shapingpolicy'
           params:
               adom: 'ansible'
               pkg: 'ansible' # package name
               shaping-policy: 'your_value'
- hosts: fortimanager00
  collections:
    - fortinet.fortimanager
  connection: httpapi
  vars:
     ansible_httpapi_use_ssl: True
     ansible_httpapi_validate_certs: False
     ansible_httpapi_port: 443
  tasks:
   - name: Configure shaping policies.
     fmgr_pkg_firewall_shapingpolicy:
        bypass_validation: False
        adom: ansible
        pkg: ansible # package name
        state: present
        pkg_firewall_shapingpolicy:
           dstaddr: all
           dstintf: any
           id: 1
           ip-version: 4 #<value in [4, 6]>
           schedule: always
           service: ALL
           srcaddr: all
           status: disable

Return Values

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

Key

Description

meta

dictionary

The result of the request.

Returned: always

request_url

string

The full url requested.

Returned: always

Sample: "/sys/login/user"

response_code

integer

The status of api request.

Returned: always

Sample: 0

response_data

list / elements=string

The api response.

Returned: always

response_message

string

The descriptive message of the api response.

Returned: always

Sample: "OK."

system_information

dictionary

The information of the target system.

Returned: always

rc

integer

The status the request.

Returned: always

Sample: 0

version_check_warning

list / elements=string

Warning if the parameters used in the playbook are not supported by the current FortiManager version.

Returned: complex

Authors

  • Xinwei Du (@dux-fortinet)

  • Xing Li (@lix-fortinet)

  • Jie Xue (@JieX19)

  • Link Zheng (@chillancezen)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)