drmofu / drmofu.fortimanager / 2.2.2 / module / fmgr_pkg_firewall_shapingpolicy Configure shaping policies. | "added in version" 2.0.0 of drmofu.fortimanager" Authors: Xinwei Du (@dux-fortinet), Xing Li (@lix-fortinet), Jie Xue (@JieX19), Link Zheng (@chillancezen), Frank Shen (@fshen01), Hongbin Lu (@fgtdev-hblu) preview | supported by communitydrmofu.fortimanager.fmgr_pkg_firewall_shapingpolicy (2.2.2) — module
Install with ansible-galaxy collection install drmofu.fortimanager:==2.2.2
collections: - name: drmofu.fortimanager version: 2.2.2
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.
- 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
pkg: description: the parameter (pkg) in requested url required: true type: str adom: description: the parameter (adom) in requested url required: true type: str state: choices: - present - absent description: The directive to create, update or delete an object. required: true type: str rc_failed: description: The rc codes list with which the conditions to fail will be overriden. elements: int required: false type: list enable_log: default: false description: Enable/Disable logging for task. required: false type: bool access_token: description: The token to access FortiManager without using username and password. required: false type: str rc_succeeded: description: The rc codes list with which the conditions to succeed will be overriden. elements: int required: false type: list proposed_method: choices: - update - set - add description: The overridden method for the underlying Json RPC request. required: false type: str bypass_validation: default: false description: Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. required: false type: bool workspace_locking_adom: description: The adom to lock for FortiManager running in workspace mode, the value can be global and others including root. required: false type: str forticloud_access_token: description: Authenticate Ansible client with forticloud API access token. required: false type: str workspace_locking_timeout: default: 300 description: The maximum time in seconds to wait for other user to release the workspace lock. required: false type: int pkg_firewall_shapingpolicy: description: the top level parameters set required: false suboptions: app-category: description: IDs of one or more application categories that this shaper applies application control traffic shaping to. type: str app-group: description: One or more application group names. type: str application: description: IDs of one or more applications that this shaper applies application control traffic shaping to. type: int class-id: description: Traffic class ID. type: int comment: description: Comments. type: str cos: description: VLAN CoS bit pattern. type: str cos-mask: description: VLAN CoS evaluated bits. type: str diffserv-forward: choices: - disable - enable description: Enable to change packets DiffServ values to the specified diffservcode-forward value. type: str diffserv-reverse: choices: - disable - enable description: Enable to change packets reverse type: str diffservcode-forward: description: Change packets DiffServ to this value. type: str diffservcode-rev: description: Change packets reverse type: str dstaddr: description: IPv4 destination address and address group names. type: str dstaddr6: description: IPv6 destination address and address group names. type: str dstintf: description: One or more outgoing type: str groups: description: Apply this traffic shaping policy to user groups that have authenticated with the FortiGate. type: str id: description: Shaping policy ID. type: int internet-service: choices: - disable - enable description: Enable/disable use of Internet Services for this policy. type: str internet-service-custom: description: Custom Internet Service name. type: str internet-service-custom-group: description: Custom Internet Service group name. type: str internet-service-group: description: Internet Service group name. type: str internet-service-id: description: Internet Service ID. type: str internet-service-name: description: Internet Service ID. type: str internet-service-src: choices: - disable - enable description: Enable/disable use of Internet Services in source for this policy. type: str internet-service-src-custom: description: Custom Internet Service source name. type: str internet-service-src-custom-group: description: Custom Internet Service source group name. type: str internet-service-src-group: description: Internet Service source group name. type: str internet-service-src-id: description: Internet Service source ID. type: str internet-service-src-name: description: Internet Service source name. type: str ip-version: choices: - '4' - '6' description: Apply this traffic shaping policy to IPv4 or IPv6 traffic. type: str name: description: Shaping policy name. type: str per-ip-shaper: description: Per-IP traffic shaper to apply with this policy. type: str schedule: description: Schedule name. type: str service: description: Service and service group names. type: str srcaddr: description: IPv4 source address and address group names. type: str srcaddr6: description: IPv6 source address and address group names. type: str srcintf: description: One or more incoming type: str status: choices: - disable - enable description: Enable/disable this traffic shaping policy. type: str tos: description: ToS type: str tos-mask: description: Non-zero bit positions are used for comparison while zero bit positions are ignored. type: str tos-negate: choices: - disable - enable description: Enable negated TOS match. type: str traffic-shaper: description: Traffic shaper to apply to traffic forwarded by the firewall policy. type: str traffic-shaper-reverse: description: Traffic shaper to apply to response traffic received by the firewall policy. type: str traffic-type: choices: - forwarding - local-in - local-out description: Traffic type. type: str url-category: description: IDs of one or more FortiGuard Web Filtering categories that this shaper applies traffic shaping to. type: str users: description: Apply this traffic shaping policy to individual users that have authenticated with the FortiGate. type: str uuid: description: Universally Unique Identifier type: str type: dict
meta: contains: request_url: description: The full url requested. returned: always sample: /sys/login/user type: str response_code: description: The status of api request. returned: always sample: 0 type: int response_data: description: The api response. returned: always type: list response_message: description: The descriptive message of the api response. returned: always sample: OK. type: str system_information: description: The information of the target system. returned: always type: dict description: The result of the request. returned: always type: dict rc: description: The status the request. returned: always sample: 0 type: int version_check_warning: description: Warning if the parameters used in the playbook are not supported by the current FortiManager version. returned: complex type: list