fmgr_pkg_firewall_shapingpolicy – Configure shaping policies.
Added in version 2.0.0.
Warning
Starting in version 3.0.0, all input arguments will be named using the underscore naming convention (snake_case).
Argument name before 3.0.0:
var-name,var name,var.nameNew argument name starting in 3.0.0:
var_name
FortiManager Ansible v2.4+ supports both previous argument name and new underscore name. You will receive deprecation warnings if you keep using the previous argument name. You can ignore the warning by setting deprecation_warnings=False in ansible.cfg.
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 v6.x and v7.x.
Requirements
The below requirements are needed on the host that executes this module.
ansible>=2.15.0
FortiManager Version Compatibility
Supported Version Ranges: v6.0.0 -> 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
- adom - The parameter in requested url type: str required: true
- pkg - The parameter in requested url type: str required: true
- pkg_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 or str more...
- application Ids of one or more applications that this shaper applies application control traffic shaping to. type: list more...
- dstaddr Ipv4 destination address and address group names. type: list or str more...
- dstaddr6 Ipv6 destination address and address group names. type: list or str more...
- dstintf One or more outgoing (egress) interfaces. type: list or str more...
- groups Apply this traffic shaping policy to user groups that have authenticated with the fortigate. type: list or str more...
- id Shaping policy id. type: int more...
- ip_version (Alias name: ip-version) Apply this traffic shaping policy to ipv4 or ipv6 traffic. type: str choices: [4, 6] more...
- per_ip_shaper (Alias name: 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: list or str more...
- srcaddr Ipv4 source address and address group names. type: list or str more...
- srcaddr6 Ipv6 source address and address group names. type: list or str 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: str more...
- traffic_shaper_reverse (Alias name: traffic-shaper-reverse) Traffic shaper to apply to response traffic received by the firewall policy. type: str 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 or str more...
- users Apply this traffic shaping policy to individual users that have authenticated with the fortigate. type: list or str more...
- app_group (Alias name: app-group) One or more application group names. type: list or str more...
- class_id (Alias name: class-id) Traffic class id. type: int or str 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...
- internet_service (Alias name: internet-service) Enable/disable use of internet services for this policy. type: str choices: [disable, enable] more...
- internet_service_custom (Alias name: internet-service-custom) Custom internet service name. type: list or str more...
- internet_service_custom_group (Alias name: internet-service-custom-group) Custom internet service group name. type: list or str more...
- internet_service_group (Alias name: internet-service-group) Internet service group name. type: list or str more...
- internet_service_id (Alias name: internet-service-id) Internet service id. type: list or 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_src_custom (Alias name: internet-service-src-custom) Custom internet service source name. type: list or str more...
- internet_service_src_custom_group (Alias name: internet-service-src-custom-group) Custom internet service source group name. type: list or str more...
- internet_service_src_group (Alias name: internet-service-src-group) Internet service source group name. type: list or str more...
- internet_service_src_id (Alias name: internet-service-src-id) Internet service source id. type: list or str more...
- name Shaping policy name. type: str more...
- srcintf One or more incoming (ingress) interfaces. type: list or str more...
- tos Tos (type of service) value used for comparison. type: str more...
- tos_mask (Alias name: tos-mask) Non-zero bit positions are used for comparison while zero bit positions are ignored. type: str more...
- tos_negate (Alias name: tos-negate) Enable negated tos match. type: str choices: [disable, enable] more...
- uuid Universally unique identifier (uuid; automatically assigned but can be manually reset). type: str more...
- internet_service_name (Alias name: internet-service-name) Internet service id. type: list or str more...
- internet_service_src_name (Alias name: internet-service-src-name) Internet service source name. type: list or str more...
- cos Vlan cos bit pattern. type: str more...
- cos_mask (Alias name: cos-mask) Vlan cos evaluated bits. type: str more...
- traffic_type (Alias name: traffic-type) Traffic type. type: str choices: [forwarding, local-in, local-out] 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
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: 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.