fmgd_firewall_shapingpolicy – Configure shaping policies.
Added in version 1.1.0.
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.
Tested with FortiManager v7.x.
Requirements
The below requirements are needed on the host that executes this module.
ansible-core>=2.16.0
FortiManager Version Compatibility
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
Parameters
- access_token -The token to access FortiManager without using username and password. type: str required: false
- 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
- 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
- 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
- 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
- device - The parameter in requested url type: str required: true
- vdom - The parameter in requested url type: str required: true
- firewall_shapingpolicy - Configure shaping policies. type: dict
- app_category (Alias name: app-category) Ids of one or more application categories that this shaper applies application control traffic shaping to. type: list more...
- app_group (Alias name: app-group) One or more application group names. type: list more...
- application Ids of one or more applications that this shaper applies application control traffic shaping to. type: list more...
- class_id (Alias name: class-id) Traffic class id. type: int more...
- class_id_reverse (Alias name: class-id-reverse) Reverse class id. type: int more...
- comment Comments. type: str more...
- diffserv_forward (Alias name: diffserv-forward) Enable to change packets diffserv values to the specified diffservcode-forward value. type: str choices: [disable, enable] more...
- diffserv_reverse (Alias name: diffserv-reverse) Enable to change packets reverse (reply) diffserv values to the specified diffservcode-rev value. type: str choices: [disable, enable] more...
- diffservcode_forward (Alias name: diffservcode-forward) Change packets diffserv to this value. type: str more...
- diffservcode_rev (Alias name: diffservcode-rev) Change packets reverse (reply) diffserv to this value. type: str more...
- dstaddr Ipv4 destination address and address group names. type: list more...
- dstaddr6 Ipv6 destination address and address group names. type: list more...
- dstintf One or more outgoing (egress) interfaces. type: list more...
- groups Apply this traffic shaping policy to user groups that have authenticated with the fortigate. type: list more...
- http_response_match (Alias name: http-response-match) Http response match. type: str choices: [disable, enable] more...
- id Shaping policy id (0 - 4294967295). type: int more...
- internet_service_custom (Alias name: internet-service-custom) Custom internet service name. type: list more...
- internet_service_custom_group (Alias name: internet-service-custom-group) Custom internet service group name. type: list more...
- internet_service_group (Alias name: internet-service-group) Internet service group name. type: list more...
- internet_service_name (Alias name: internet-service-name) Internet service id. type: list more...
- ip_version (Alias name: ip-version) Apply this traffic shaping policy to ipv4 or ipv6 traffic. type: str choices: [4, 6] more...
- name Shaping policy name. type: str more...
- per_ip_shaper (Alias name: per-ip-shaper) Per-ip traffic shaper to apply with this policy. type: list more...
- schedule Schedule name. type: list more...
- service Service and service group names. type: list more...
- service_type (Alias name: service-type) Select service-type: service / internet-service. type: str choices: [service, internet-service] more...
- srcaddr Ipv4 source address and address group names. type: list more...
- srcaddr6 Ipv6 source address and address group names. type: list more...
- status Enable/disable this traffic shaping policy. type: str choices: [disable, enable] more...
- traffic_shaper (Alias name: traffic-shaper) Traffic shaper to apply to traffic forwarded by the firewall policy. type: list more...
- traffic_shaper_reverse (Alias name: traffic-shaper-reverse) Traffic shaper to apply to response traffic received by the firewall policy. type: list more...
- users Apply this traffic shaping policy to individual users that have authenticated with the fortigate. type: list more...
- uuid Universally unique identifier (uuid; automatically assigned but can be manually reset). type: str more...
- traffic_type (Alias name: traffic-type) Traffic type. type: str choices: [forwarding, local-in, local-out] more...
- tos_mask (Alias name: tos-mask) Non-zero bit positions are used for comparison while zero bit positions are ignored. type: str more...
- srcintf One or more incoming (ingress) interfaces. type: list more...
- cos Vlan cos bit pattern. type: str more...
- internet_service_src (Alias name: internet-service-src) Enable/disable use of internet services in source for this policy. type: str choices: [disable, enable] more...
- internet_service (Alias name: internet-service) Enable/disable use of internet services for this policy. type: str choices: [enable, disable] more...
- internet_service_src_custom (Alias name: internet-service-src-custom) Custom internet service source name. type: list more...
- tos_negate (Alias name: tos-negate) Enable negated tos match. type: str choices: [disable, enable] more...
- internet_service_src_name (Alias name: internet-service-src-name) Internet service source name. type: list more...
- internet_service_src_custom_group (Alias name: internet-service-src-custom-group) Custom internet service source group name. type: list more...
- cos_mask (Alias name: cos-mask) Vlan cos evaluated bits. type: str more...
- internet_service_src_group (Alias name: internet-service-src-group) Internet service source group name. type: list more...
- url_category (Alias name: url-category) Ids of one or more fortiguard web filtering categories that this shaper applies traffic shaping to. type: list more...
- tos Tos (type of service) value used for comparison. type: str more...
- internet_service_id (Alias name: internet-service-id) Internet service id. type: list more...
- internet_service_src_id (Alias name: internet-service-src-id) Internet service source id. type: list more...
- internet_service_src_fortiguard (Alias name: internet-service-src-fortiguard) Fortiguard internet service source name. type: list more...
- internet_service_fortiguard (Alias name: internet-service-fortiguard) Fortiguard internet service name. type: list 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: Example playbook (generated based on argument schema)
hosts: fortimanagers
connection: httpapi
gather_facts: false
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
tasks:
- name: Configure shaping policies.
fortinet.fmgdevice.fmgd_firewall_shapingpolicy:
# bypass_validation: false
# workspace_locking_adom: <global or your adom name>
# workspace_locking_timeout: 300
# rc_succeeded: [0, -2, -3, ...]
# rc_failed: [-2, -3, ...]
device: <your own value>
vdom: <your own value>
state: present # <value in [present, absent]>
firewall_shapingpolicy:
id: 0 # Required variable, integer
# app_category: <list or string>
# app_group: <list or string>
# application: <list or integer>
# class_id: <integer>
# class_id_reverse: <integer>
# comment: <string>
# diffserv_forward: <value in [disable, enable]>
# diffserv_reverse: <value in [disable, enable]>
# diffservcode_forward: <string>
# diffservcode_rev: <string>
# dstaddr: <list or string>
# dstaddr6: <list or string>
# dstintf: <list or string>
# groups: <list or string>
# http_response_match: <value in [disable, enable]>
# internet_service_custom: <list or string>
# internet_service_custom_group: <list or string>
# internet_service_group: <list or string>
# internet_service_name: <list or string>
# ip_version: <value in [4, 6]>
# name: <string>
# per_ip_shaper: <list or string>
# schedule: <list or string>
# service: <list or string>
# service_type: <value in [service, internet-service]>
# srcaddr: <list or string>
# srcaddr6: <list or string>
# status: <value in [disable, enable]>
# traffic_shaper: <list or string>
# traffic_shaper_reverse: <list or string>
# users: <list or string>
# uuid: <string>
# traffic_type: <value in [forwarding, local-in, local-out]>
# tos_mask: <string>
# srcintf: <list or string>
# cos: <string>
# internet_service_src: <value in [disable, enable]>
# internet_service: <value in [enable, disable]>
# internet_service_src_custom: <list or string>
# tos_negate: <value in [disable, enable]>
# internet_service_src_name: <list or string>
# internet_service_src_custom_group: <list or string>
# cos_mask: <string>
# internet_service_src_group: <list or string>
# url_category: <list or string>
# tos: <string>
# internet_service_id: <list or string>
# internet_service_src_id: <list or string>
# internet_service_src_fortiguard: <list or string>
# internet_service_fortiguard: <list or string>
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:
- meta - The result of the request.returned: always type: dict
- 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_data - The data body of the api response. returned: optional type: list or dict
- response_message - The descriptive message of the api response. returned: always type: str sample: OK
- system_information - The information of the target system. returned: always type: dict
- rc - The status the request. returned: always type: int sample: 0
- version_check_warning - Warning if the parameters used in the playbook are not supported by the current FortiManager version. returned: if at least one parameter not supported by the current FortiManager version type: list
Status
This module is not guaranteed to have a backwards compatible interface.