fortinet.fortimanager.fmgr_pkg_firewall_shapingpolicy module – Configure shaping policies.
Note
This module is part of the fortinet.fortimanager collection (version 2.7.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 |
---|---|
The token to access FortiManager without using username and password. |
|
The parameter (adom) in requested url. |
|
Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. Choices:
|
|
Enable/Disable logging for task. Choices:
|
|
Authenticate Ansible client with forticloud API access token. |
|
The parameter (pkg) in requested url. |
|
The top level parameters set. |
|
(list or str) Deprecated, please rename it to app_category. IDs of one or more application categories that this shaper app… |
|
(list or str) Deprecated, please rename it to app_group. One or more application group names. |
|
(list) IDs of one or more applications that this shaper applies application control traffic shaping to. |
|
(int or str) Deprecated, please rename it to class_id. Traffic class ID. |
|
Comments. |
|
VLAN CoS bit pattern. |
|
Deprecated, please rename it to cos_mask. VLAN CoS evaluated bits. |
|
Deprecated, please rename it to diffserv_forward. Enable to change packets DiffServ values to the specified diffservcode-f… Choices:
|
|
Deprecated, please rename it to diffserv_reverse. Enable to change packets reverse Choices:
|
|
Deprecated, please rename it to diffservcode_forward. Change packets DiffServ to this value. |
|
Deprecated, please rename it to diffservcode_rev. Change packets reverse |
|
(list or str) IPv4 destination address and address group names. |
|
(list or str) IPv6 destination address and address group names. |
|
(list or str) One or more outgoing |
|
(list or str) Apply this traffic shaping policy to user groups that have authenticated with the FortiGate. |
|
Shaping policy ID. |
|
Deprecated, please rename it to internet_service. Enable/disable use of Internet Services for this policy. Choices:
|
|
(list or str) Deprecated, please rename it to internet_service_custom. Custom Internet Service name. |
|
(list or str) Deprecated, please rename it to internet_service_custom_group. Custom Internet Service group name. |
|
(list or str) Deprecated, please rename it to internet_service_group. Internet Service group name. |
|
(list or str) Deprecated, please rename it to internet_service_id. Internet Service ID. |
|
(list or str) Deprecated, please rename it to internet_service_name. Internet Service ID. |
|
Deprecated, please rename it to internet_service_src. Enable/disable use of Internet Services in source for this policy. Choices:
|
|
(list or str) Deprecated, please rename it to internet_service_src_custom. Custom Internet Service source name. |
|
(list or str) Deprecated, please rename it to internet_service_src_custom_group. Custom Internet Service source group name. |
|
(list or str) Deprecated, please rename it to internet_service_src_group. Internet Service source group name. |
|
(list or str) Deprecated, please rename it to internet_service_src_id. Internet Service source ID. |
|
(list or str) Deprecated, please rename it to internet_service_src_name. Internet Service source name. |
|
Deprecated, please rename it to ip_version. Apply this traffic shaping policy to IPv4 or IPv6 traffic. Choices:
|
|
Shaping policy name. |
|
Deprecated, please rename it to per_ip_shaper. Per-IP traffic shaper to apply with this policy. |
|
Schedule name. |
|
(list or str) Service and service group names. |
|
(list or str) IPv4 source address and address group names. |
|
(list or str) IPv6 source address and address group names. |
|
(list or str) One or more incoming |
|
Enable/disable this traffic shaping policy. Choices:
|
|
ToS |
|
Deprecated, please rename it to tos_mask. Non-zero bit positions are used for comparison while zero bit positions are ignored. |
|
Deprecated, please rename it to tos_negate. Enable negated TOS match. Choices:
|
|
Deprecated, please rename it to traffic_shaper. Traffic shaper to apply to traffic forwarded by the firewall policy. |
|
Deprecated, please rename it to traffic_shaper_reverse. Traffic shaper to apply to response traffic received by the firewa… |
|
Deprecated, please rename it to traffic_type. Traffic type. Choices:
|
|
(list or str) Deprecated, please rename it to url_category. IDs of one or more FortiGuard Web Filtering categories that th… |
|
(list or str) Apply this traffic shaping policy to individual users that have authenticated with the FortiGate. |
|
Universally Unique Identifier |
|
The overridden method for the underlying Json RPC request. Choices:
|
|
The rc codes list with which the conditions to fail will be overriden. |
|
The rc codes list with which the conditions to succeed will be overriden. |
|
The directive to create, update or delete an object. Choices:
|
|
The adom to lock for FortiManager running in workspace mode, the value can be global and others including root. |
|
The maximum time in seconds to wait for other user to release the workspace lock. Default: |
Notes
Note
Starting in version 2.4.0, all input arguments are named using the underscore naming convention (snake_case). Please change the arguments such as “var-name” to “var_name”. Old argument names are still available yet you will receive deprecation warnings. You can ignore this warning by setting deprecation_warnings=False in ansible.cfg.
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: Example playbook
hosts: fortimanagers
connection: httpapi
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
tasks:
- name: Configure shaping policies.
fortinet.fortimanager.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
- name: Gathering fortimanager facts
hosts: fortimanagers
gather_facts: false
connection: httpapi
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
tasks:
- name: Retrieve all the shaping policies
fortinet.fortimanager.fmgr_fact:
facts:
selector: "pkg_firewall_shapingpolicy"
params:
adom: "ansible"
pkg: "ansible" # package name
shaping-policy: "your_value"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
The result of the request. Returned: always |
|
The full url requested. Returned: always Sample: |
|
The status of api request. Returned: always Sample: |
|
The api response. Returned: always |
|
The descriptive message of the api response. Returned: always Sample: |
|
The information of the target system. Returned: always |
|
The status the request. Returned: always Sample: |
|
Warning if the parameters used in the playbook are not supported by the current FortiManager version. Returned: complex |