fortinet.fortimanager.fmgr_pkg_firewall_shapingpolicy – Configure shaping policies.

Note

This plugin is part of the fortinet.fortimanager 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.fortimanager.

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

New in version 2.10: of fortinet.fortimanager

Synopsis
Parameters
Notes
Examples
Return Values

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		Choices/Defaults	Comments
adom string / required			the parameter (adom) in requested url
bypass_validation boolean		Choices: no ← yes	only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters
enable_log boolean		Choices: no ← yes	Enable/Disable logging for task
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		no description
	class-id integer		Traffic class ID.
	comment string		Comments.
	diffserv-forward string	Choices: disable enable	Enable to change packets DiffServ values to the specified diffservcode-forward value.
	diffserv-reverse string	Choices: disable enable	Enable to change packets reverse (reply) DiffServ values to the specified diffservcode-rev value.
	diffservcode-forward string		Change packets DiffServ to this value.
	diffservcode-rev string		Change packets reverse (reply) DiffServ to this value.
	dstaddr string		IPv4 destination address and address group names.
	dstaddr6 string		IPv6 destination address and address group names.
	dstintf string		One or more outgoing (egress) interfaces.
	groups string		Apply this traffic shaping policy to user groups that have authenticated with the FortiGate.
	id integer		Shaping policy ID.
	internet-service string	Choices: disable enable	Enable/disable use of Internet Services for this policy. If enabled, destination address and service are not used.
	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	Choices: disable enable	Enable/disable use of Internet Services in source for this policy. If enabled, source address is not used.
	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	Choices: 4 6	Apply this traffic shaping policy to IPv4 or IPv6 traffic.
	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 (ingress) interfaces.
	status string	Choices: disable enable	Enable/disable this traffic shaping policy.
	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	Choices: disable enable	Enable negated TOS match.
	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.
	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.
proposed_method string		Choices: update set add	The overridden method for the underlying Json RPC request
rc_failed list / elements=string			the rc codes list with which the conditions to fail will be overriden
rc_succeeded list / elements=string			the rc codes list with which the conditions to succeed will be overriden
state string / required		Choices: present absent	the directive to create, update or delete an object
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		Default: 300	the maximum time in seconds to wait for other user to release the workspace lock

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

- hosts: fortimanager-inventory
  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
        workspace_locking_adom: <value in [global, custom adom including root]>
        workspace_locking_timeout: 300
        rc_succeeded: [0, -2, -3, ...]
        rc_failed: [-2, -3, ...]
        adom: <your own value>
        pkg: <your own value>
        state: <value in [present, absent]>
        pkg_firewall_shapingpolicy:
           app-category: <value of string>
           application: <value of integer>
           dstaddr: <value of string>
           dstaddr6: <value of string>
           dstintf: <value of string>
           groups: <value of string>
           id: <value of integer>
           ip-version: <value in [4, 6]>
           per-ip-shaper: <value of string>
           schedule: <value of string>
           service: <value of string>
           srcaddr: <value of string>
           srcaddr6: <value of string>
           status: <value in [disable, enable]>
           traffic-shaper: <value of string>
           traffic-shaper-reverse: <value of string>
           url-category: <value of string>
           users: <value of string>
           app-group: <value of string>
           class-id: <value of integer>
           comment: <value of string>
           diffserv-forward: <value in [disable, enable]>
           diffserv-reverse: <value in [disable, enable]>
           diffservcode-forward: <value of string>
           diffservcode-rev: <value of string>
           internet-service: <value in [disable, enable]>
           internet-service-custom: <value of string>
           internet-service-custom-group: <value of string>
           internet-service-group: <value of string>
           internet-service-id: <value of string>
           internet-service-src: <value in [disable, enable]>
           internet-service-src-custom: <value of string>
           internet-service-src-custom-group: <value of string>
           internet-service-src-group: <value of string>
           internet-service-src-id: <value of string>
           name: <value of string>
           srcintf: <value of string>
           tos: <value of string>
           tos-mask: <value of string>
           tos-negate: <value in [disable, enable]>
           internet-service-name: <value of string>
           internet-service-src-name: <value of string>

Return Values

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

Key	Returned	Description
request_url string	always	The full url requested Sample: /sys/login/user
response_code integer	always	The status of api request
response_message string	always	The descriptive message of the api response Sample: OK.

Authors

Link Zheng (@chillancezen)
Jie Xue (@JieX19)
Frank Shen (@fshen01)
Hongbin Lu (@fgtdev-hblu)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortimanager/fmgr_pkg_firewall_shapingpolicy_module.html