#!/usr/bin/python from __future__ import absolute_import, division, print_function # Copyright 2019-2024 Fortinet, Inc. # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) __metaclass__ = type ANSIBLE_METADATA = {'status': ['preview'], 'supported_by': 'community', 'metadata_version': '1.1'} DOCUMENTATION = ''' --- module: fmgr_firewall_shapingprofile short_description: Configure shaping profiles. description: - 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. version_added: "2.0.0" author: - Xinwei Du (@dux-fortinet) - Xing Li (@lix-fortinet) - Jie Xue (@JieX19) - Link Zheng (@chillancezen) - Frank Shen (@fshen01) - Hongbin Lu (@fgtdev-hblu) notes: - Starting in version 2.4.0, all input arguments are named using the underscore naming convention (snake_case). Please change the arguments such as "var-name" to "var_name". Old argument names are still available yet you will receive deprecation warnings. You can ignore this warning by setting deprecation_warnings=False in ansible.cfg. - 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 options: access_token: description: The token to access FortiManager without using username and password. type: str bypass_validation: description: Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. type: bool default: false enable_log: description: Enable/Disable logging for task. type: bool default: false forticloud_access_token: description: Authenticate Ansible client with forticloud API access token. type: str proposed_method: description: The overridden method for the underlying Json RPC request. type: str choices: - update - set - add rc_succeeded: description: The rc codes list with which the conditions to succeed will be overriden. type: list elements: int rc_failed: description: The rc codes list with which the conditions to fail will be overriden. type: list elements: int state: description: The directive to create, update or delete an object. type: str required: true choices: - present - absent workspace_locking_adom: description: The adom to lock for FortiManager running in workspace mode, the value can be global and others including root. type: str workspace_locking_timeout: description: The maximum time in seconds to wait for other user to release the workspace lock. type: int default: 300 adom: description: The parameter (adom) in requested url. type: str required: true firewall_shapingprofile: description: The top level parameters set. required: false type: dict suboptions: comment: type: str description: Comment. default_class_id: aliases: ['default-class-id'] type: raw description: (int or str) Default class ID to handle unclassified packets profile_name: aliases: ['profile-name'] type: str description: Shaping profile name. required: true shaping_entries: aliases: ['shaping-entries'] type: list elements: dict description: Shaping entries. suboptions: class_id: aliases: ['class-id'] type: raw description: (int or str) Class ID. guaranteed_bandwidth_percentage: aliases: ['guaranteed-bandwidth-percentage'] type: int description: Guaranteed bandwith in percentage. id: type: int description: ID number. maximum_bandwidth_percentage: aliases: ['maximum-bandwidth-percentage'] type: int description: Maximum bandwith in percentage. priority: type: str description: Priority. choices: - 'low' - 'medium' - 'high' - 'critical' - 'top' burst_in_msec: aliases: ['burst-in-msec'] type: int description: Number of bytes that can be burst at maximum-bandwidth speed. cburst_in_msec: aliases: ['cburst-in-msec'] type: int description: Number of bytes that can be burst as fast as the interface can transmit. limit: type: int description: Hard limit on the real queue size in packets. max: type: int description: Average queue size in packets at which RED drop probability is maximal. min: type: int description: Average queue size in packets at which RED drop becomes a possibility. red_probability: aliases: ['red-probability'] type: int description: Maximum probability type: type: str description: Select shaping profile type choices: - 'policing' - 'queuing' npu_offloading: aliases: ['npu-offloading'] type: str description: Enable/disable NPU offloading. choices: - 'disable' - 'enable' ''' 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 profiles. fortinet.fortimanager.fmgr_firewall_shapingprofile: bypass_validation: false adom: ansible state: present firewall_shapingprofile: comment: "ansible-comment" profile-name: "ansible-test" - 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 profiles fortinet.fortimanager.fmgr_fact: facts: selector: "firewall_shapingprofile" params: adom: "ansible" shaping-profile: "your_value" ''' RETURN = ''' meta: description: The result of the request. type: dict returned: always contains: request_url: description: The full url requested. returned: always type: str sample: /sys/login/user response_code: description: The status of api request. returned: always type: int sample: 0 response_data: description: The api response. type: list returned: always response_message: description: The descriptive message of the api response. type: str returned: always sample: OK. system_information: description: The information of the target system. type: dict returned: always rc: description: The status the request. type: int returned: always sample: 0 version_check_warning: description: Warning if the parameters used in the playbook are not supported by the current FortiManager version. type: list returned: complex ''' from ansible.module_utils.basic import AnsibleModule from ansible.module_utils.connection import Connection from ansible_collections.fortinet.fortimanager.plugins.module_utils.napi import NAPIManager, check_galaxy_version, check_parameter_bypass from ansible_collections.fortinet.fortimanager.plugins.module_utils.common import get_module_arg_spec def main(): urls_list = [ '/pm/config/adom/{adom}/obj/firewall/shaping-profile', '/pm/config/global/obj/firewall/shaping-profile' ] url_params = ['adom'] module_primary_key = 'profile-name' module_arg_spec = { 'adom': {'required': True, 'type': 'str'}, 'firewall_shapingprofile': { 'type': 'dict', 'v_range': [['6.0.0', '']], 'options': { 'comment': {'type': 'str'}, 'default-class-id': {'type': 'raw'}, 'profile-name': {'required': True, 'type': 'str'}, 'shaping-entries': { 'type': 'list', 'options': { 'class-id': {'type': 'raw'}, 'guaranteed-bandwidth-percentage': {'type': 'int'}, 'id': {'type': 'int'}, 'maximum-bandwidth-percentage': {'type': 'int'}, 'priority': {'choices': ['low', 'medium', 'high', 'critical', 'top'], 'type': 'str'}, 'burst-in-msec': {'v_range': [['6.2.1', '']], 'type': 'int'}, 'cburst-in-msec': {'v_range': [['6.2.1', '']], 'type': 'int'}, 'limit': {'v_range': [['6.2.1', '']], 'type': 'int'}, 'max': {'v_range': [['6.2.1', '']], 'type': 'int'}, 'min': {'v_range': [['6.2.1', '']], 'type': 'int'}, 'red-probability': {'v_range': [['6.2.1', '']], 'type': 'int'} }, 'elements': 'dict' }, 'type': {'v_range': [['6.2.1', '']], 'choices': ['policing', 'queuing'], 'type': 'str'}, 'npu-offloading': {'v_range': [['7.2.6', '7.2.9'], ['7.4.4', '']], 'choices': ['disable', 'enable'], 'type': 'str'} } } } module_option_spec = get_module_arg_spec('full crud') module_arg_spec.update(module_option_spec) params_validation_blob = [] check_galaxy_version(module_arg_spec) module = AnsibleModule(argument_spec=check_parameter_bypass(module_arg_spec, 'firewall_shapingprofile'), supports_check_mode=True) if not module._socket_path: module.fail_json(msg='MUST RUN IN HTTPAPI MODE') connection = Connection(module._socket_path) fmgr = NAPIManager('full crud', module_arg_spec, urls_list, module_primary_key, url_params, module, connection, top_level_schema_name='data') fmgr.validate_parameters(params_validation_blob) fmgr.process_crud() module.exit_json(meta=module.params) if __name__ == '__main__': main()