drmofu / drmofu.fortimanager / 2.2.2 / module / fmgr_pkg_footer_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_footer_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.
- 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_footer_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, ...] pkg: <your own value> state: <value in [present, absent]> pkg_footer_shapingpolicy: app-category: <value of string> app-group: <value of string> application: <value of integer> class-id: <value of integer> comment: <value of string> diffserv-forward: <value in [disable, enable]> diffserv-reverse: <value in [disable, enable]> diffservcode-forward: <value of string> diffservcode-rev: <value of string> dstaddr: <value of string> dstaddr6: <value of string> dstintf: <value of string> groups: <value of string> id: <value of integer> internet-service: <value in [disable, enable]> internet-service-custom: <value of string> internet-service-custom-group: <value of string> internet-service-group: <value of string> internet-service-id: <value of string> internet-service-src: <value in [disable, enable]> internet-service-src-custom: <value of string> internet-service-src-custom-group: <value of string> internet-service-src-group: <value of string> internet-service-src-id: <value of string> 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> srcintf: <value of string> status: <value in [disable, enable]> tos: <value of string> tos-mask: <value of string> tos-negate: <value in [disable, enable]> traffic-shaper: <value of string> traffic-shaper-reverse: <value of string> url-category: <value of string> users: <value of string> uuid: <value of string> internet-service-name: <value of string> internet-service-src-name: <value of string> class-id-reverse: <value of integer> service-type: <value in [service, internet-service]> uuid-idx: <value of integer> cos: <value of string> cos-mask: <value of string> traffic-type: <value in [forwarding, local-in, local-out]>
pkg: description: the parameter (pkg) 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 pkg_footer_shapingpolicy: description: the top level parameters set required: false suboptions: app-category: description: no description type: str app-group: description: no description type: str application: description: description type: int class-id: description: no description type: int class-id-reverse: description: no description type: int comment: description: no description 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: no description type: str diffserv-reverse: choices: - disable - enable description: no description type: str diffservcode-forward: description: no description type: str diffservcode-rev: description: no description type: str dstaddr: description: no description type: str dstaddr6: description: no description type: str dstintf: description: no description type: str groups: description: no description type: str id: description: no description type: int internet-service: choices: - disable - enable description: no description type: str internet-service-custom: description: no description type: str internet-service-custom-group: description: no description type: str internet-service-group: description: no description type: str internet-service-id: description: no description type: str internet-service-name: description: no description type: str internet-service-src: choices: - disable - enable description: no description type: str internet-service-src-custom: description: no description type: str internet-service-src-custom-group: description: no description type: str internet-service-src-group: description: no description type: str internet-service-src-id: description: no description type: str internet-service-src-name: description: no description type: str ip-version: choices: - '4' - '6' description: no description type: str per-ip-shaper: description: no description type: str schedule: description: no description type: str service: description: no description type: str service-type: choices: - service - internet-service description: no description type: str srcaddr: description: no description type: str srcaddr6: description: no description type: str srcintf: description: no description type: str status: choices: - disable - enable description: no description type: str tos: description: no description type: str tos-mask: description: no description type: str tos-negate: choices: - disable - enable description: no description type: str traffic-shaper: description: no description type: str traffic-shaper-reverse: description: no description type: str traffic-type: choices: - forwarding - local-in - local-out description: Traffic type. type: str url-category: description: no description type: str users: description: no description type: str uuid: description: no description type: str uuid-idx: description: no description type: int type: dict 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
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