fortinet.fortimanager.fmgr_pkg_firewall_shapingpolicy – Configure shaping policies.
fortinet.fortimanager.fmgr_pkg_firewall_shapingpolicy – Configure shaping policies.
Note
This plugin is part of the fortinet.fortimanager collection (version 2.0.1).
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
- 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 |
|
only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters | |
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. | ||
application integer |
no description | ||
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. | ||
ip-version string |
|
Apply this traffic shaping policy to IPv4 or IPv6 traffic. | |
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. | ||
status string |
|
Enable/disable this traffic shaping policy. | |
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. | ||
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 |
|
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>
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/2.11/collections/fortinet/fortimanager/fmgr_pkg_firewall_shapingpolicy_module.html