fmgr_pkg_firewall_shapingpolicy – Configure shaping policies.¶
New in version 2.10.
Synopsis¶
- This module is able to configure a FortiManager device.
- Examples include all parameters and values need to be adjusted to data sources before usage.
Requirements¶
The below requirements are needed on the host that executes this module.
- ansible>=2.9.0
FortiManager Version Compatibility¶
6.0.0 |
6.2.1 |
6.2.3 |
6.2.5 |
6.4.0 |
6.4.2 |
6.4.5 |
7.0.0 |
7.2.0 |
|
| pkg_firewall_shapingpolicy | yes | yes | yes | yes | yes | yes | yes | yes | yes |
Parameters¶
- enable_log - Enable/Disable logging for task type: bool required: false default: False
- forticloud_access_token - Access token of forticloud managed API users, this option is available with FortiManager later than 6.4.0 type: str required: false
- proposed_method - The overridden method for the underlying Json RPC request type: str required: false choices: set, update, add
- bypass_validation - Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters type: bool required: false default: False
- workspace_locking_adom - Acquire the workspace lock if FortiManager is running in workspace mode type: str required: false choices: global, custom adom including root
- workspace_locking_timeout - The maximum time in seconds to wait for other users to release workspace lock type: integer required: false default: 300
- rc_succeeded - The rc codes list with which the conditions to succeed will be overriden type: list required: false
- rc_failed - The rc codes list with which the conditions to fail will be overriden type: list required: false
- state - The directive to create, update or delete an object type: str required: true choices: present, absent
- adom - The parameter in requested url type: str required: true
- pkg - The parameter in requested url type: str required: true
- pkg_firewall_shapingpolicy - no description type: dict
- app-category - IDs of one or more application categories that this shaper applies application control traffic shaping to. type: str more...
- application - IDs of one or more applications that this shaper applies application control traffic shaping to. type: int more...
- dstaddr - IPv4 destination address and address group names. type: str more...
- dstaddr6 - IPv6 destination address and address group names. type: str more...
- dstintf - One or more outgoing (egress) interfaces. type: str more...
- groups - Apply this traffic shaping policy to user groups that have authenticated with the FortiGate. type: str more...
- id - Shaping policy ID. type: int more...
- ip-version - Apply this traffic shaping policy to IPv4 or IPv6 traffic. type: str choices: [4, 6] more...
- per-ip-shaper - Per-IP traffic shaper to apply with this policy. type: str more...
- schedule - Schedule name. type: str more...
- service - Service and service group names. type: str more...
- srcaddr - IPv4 source address and address group names. type: str more...
- srcaddr6 - IPv6 source address and address group names. type: str more...
- status - Enable/disable this traffic shaping policy. type: str choices: [disable, enable] more...
- traffic-shaper - Traffic shaper to apply to traffic forwarded by the firewall policy. type: str more...
- traffic-shaper-reverse - Traffic shaper to apply to response traffic received by the firewall policy. type: str more...
- url-category - IDs of one or more FortiGuard Web Filtering categories that this shaper applies traffic shaping to. type: str more...
- users - Apply this traffic shaping policy to individual users that have authenticated with the FortiGate. type: str more...
- app-group - One or more application group names. type: str more...
- class-id - Traffic class ID. type: int more...
- comment - Comments. type: str more...
- diffserv-forward - Enable to change packets DiffServ values to the specified diffservcode-forward value. type: str choices: [disable, enable] more...
- diffserv-reverse - Enable to change packets reverse (reply) DiffServ values to the specified diffservcode-rev value. type: str choices: [disable, enable] more...
- diffservcode-forward - Change packets DiffServ to this value. type: str more...
- diffservcode-rev - Change packets reverse (reply) DiffServ to this value. type: str more...
- internet-service - Enable/disable use of Internet Services for this policy. type: str choices: [disable, enable] more...
- internet-service-custom - Custom Internet Service name. type: str more...
- internet-service-custom-group - Custom Internet Service group name. type: str more...
- internet-service-group - Internet Service group name. type: str more...
- internet-service-id - Internet Service ID. type: str more...
- internet-service-src - Enable/disable use of Internet Services in source for this policy. type: str choices: [disable, enable] more...
- internet-service-src-custom - Custom Internet Service source name. type: str more...
- internet-service-src-custom-group - Custom Internet Service source group name. type: str more...
- internet-service-src-group - Internet Service source group name. type: str more...
- internet-service-src-id - Internet Service source ID. type: str more...
- name - Shaping policy name. type: str more...
- srcintf - One or more incoming (ingress) interfaces. type: str more...
- tos - ToS (Type of Service) value used for comparison. type: str more...
- tos-mask - Non-zero bit positions are used for comparison while zero bit positions are ignored. type: str more...
- tos-negate - Enable negated TOS match. type: str choices: [disable, enable] more...
- internet-service-name - Internet Service ID. type: str more...
- internet-service-src-name - Internet Service source name. type: str more...
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: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, the following are the fields unique to this module:
- request_url - The full url requested returned: always type: str sample: /sys/login/user
- response_code - The status of api request returned: always type: int sample: 0
- response_message - The descriptive message of the api response returned: always type: str sample: OK
- response_data - The data body of the api response returned: optional type: list or dict