Fortinet's FortiOS firewall shaping profile (#52095)

lib/ansible/modules/network/fortios/fortios_firewall_shaping_profile.py

@@ -0,0 +1,314 @@
+#!/usr/bin/python
+from __future__ import (absolute_import, division, print_function)
+# Copyright 2019 Fortinet, Inc.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <https://www.gnu.org/licenses/>.
+#
+# the lib use python logging can get it if the following is set in your
+# Ansible config.
+
+__metaclass__ = type
+
+ANSIBLE_METADATA = {'status': ['preview'],
+                    'supported_by': 'community',
+                    'metadata_version': '1.1'}
+
+DOCUMENTATION = '''
+---
+module: fortios_firewall_shaping_profile
+short_description: Configure shaping profiles in Fortinet's FortiOS and FortiGate.
+description:
+    - This module is able to configure a FortiGate or FortiOS by
+      allowing the user to configure firewall feature and shaping_profile category.
+      Examples includes all options and need to be adjusted to datasources before usage.
+      Tested with FOS v6.0.2
+version_added: "2.8"
+author:
+    - Miguel Angel Munoz (@mamunozgonzalez)
+    - Nicolas Thomas (@thomnico)
+notes:
+    - Requires fortiosapi library developed by Fortinet
+    - Run as a local_action in your playbook
+requirements:
+    - fortiosapi>=0.9.8
+options:
+    host:
+       description:
+            - FortiOS or FortiGate ip adress.
+       required: true
+    username:
+        description:
+            - FortiOS or FortiGate username.
+        required: true
+    password:
+        description:
+            - FortiOS or FortiGate password.
+        default: ""
+    vdom:
+        description:
+            - Virtual domain, among those defined previously. A vdom is a
+              virtual instance of the FortiGate that can be configured and
+              used as a different unit.
+        default: root
+    https:
+        description:
+            - Indicates if the requests towards FortiGate must use HTTPS
+              protocol
+        type: bool
+        default: true
+    firewall_shaping_profile:
+        description:
+            - Configure shaping profiles.
+        default: null
+        suboptions:
+            state:
+                description:
+                    - Indicates whether to create or remove the object
+                choices:
+                    - present
+                    - absent
+            comment:
+                description:
+                    - Comment.
+            default-class-id:
+                description:
+                    - Default class ID to handle unclassified packets (including all local traffic).
+            profile-name:
+                description:
+                    - Shaping profile name.
+                required: true
+            shaping-entries:
+                description:
+                    - Define shaping entries of this shaping profile.
+                suboptions:
+                    class-id:
+                        description:
+                            - Class ID.
+                    guaranteed-bandwidth-percentage:
+                        description:
+                            - Guaranteed bandwith in percentage.
+                    id:
+                        description:
+                            - ID number.
+                        required: true
+                    maximum-bandwidth-percentage:
+                        description:
+                            - Maximum bandwith in percentage.
+                    priority:
+                        description:
+                            - Priority.
+                        choices:
+                            - high
+                            - medium
+                            - low
+'''
+
+EXAMPLES = '''
+- hosts: localhost
+  vars:
+   host: "192.168.122.40"
+   username: "admin"
+   password: ""
+   vdom: "root"
+  tasks:
+  - name: Configure shaping profiles.
+    fortios_firewall_shaping_profile:
+      host:  "{{ host }}"
+      username: "{{ username }}"
+      password: "{{ password }}"
+      vdom:  "{{ vdom }}"
+      https: "False"
+      firewall_shaping_profile:
+        state: "present"
+        comment: "Comment."
+        default-class-id: "4"
+        profile-name: "<your_own_value>"
+        shaping-entries:
+         -
+            class-id: "7"
+            guaranteed-bandwidth-percentage: "8"
+            id:  "9"
+            maximum-bandwidth-percentage: "10"
+            priority: "high"
+'''
+
+RETURN = '''
+build:
+  description: Build number of the fortigate image
+  returned: always
+  type: str
+  sample: '1547'
+http_method:
+  description: Last method used to provision the content into FortiGate
+  returned: always
+  type: str
+  sample: 'PUT'
+http_status:
+  description: Last result given by FortiGate on last operation applied
+  returned: always
+  type: str
+  sample: "200"
+mkey:
+  description: Master key (id) used in the last call to FortiGate
+  returned: success
+  type: str
+  sample: "id"
+name:
+  description: Name of the table used to fulfill the request
+  returned: always
+  type: str
+  sample: "urlfilter"
+path:
+  description: Path of the table used to fulfill the request
+  returned: always
+  type: str
+  sample: "webfilter"
+revision:
+  description: Internal revision number
+  returned: always
+  type: str
+  sample: "17.0.2.10658"
+serial:
+  description: Serial number of the unit
+  returned: always
+  type: str
+  sample: "FGVMEVYYQT3AB5352"
+status:
+  description: Indication of the operation's result
+  returned: always
+  type: str
+  sample: "success"
+vdom:
+  description: Virtual domain used
+  returned: always
+  type: str
+  sample: "root"
+version:
+  description: Version of the FortiGate
+  returned: always
+  type: str
+  sample: "v5.6.3"
+
+'''
+
+from ansible.module_utils.basic import AnsibleModule
+
+fos = None
+
+
+def login(data):
+    host = data['host']
+    username = data['username']
+    password = data['password']
+
+    fos.debug('on')
+    if 'https' in data and not data['https']:
+        fos.https('off')
+    else:
+        fos.https('on')
+
+    fos.login(host, username, password)
+
+
+def filter_firewall_shaping_profile_data(json):
+    option_list = ['comment', 'default-class-id', 'profile-name',
+                   'shaping-entries']
+    dictionary = {}
+
+    for attribute in option_list:
+        if attribute in json and json[attribute] is not None:
+            dictionary[attribute] = json[attribute]
+
+    return dictionary
+
+
+def firewall_shaping_profile(data, fos):
+    vdom = data['vdom']
+    firewall_shaping_profile_data = data['firewall_shaping_profile']
+    filtered_data = filter_firewall_shaping_profile_data(firewall_shaping_profile_data)
+    if firewall_shaping_profile_data['state'] == "present":
+        return fos.set('firewall',
+                       'shaping-profile',
+                       data=filtered_data,
+                       vdom=vdom)
+
+    elif firewall_shaping_profile_data['state'] == "absent":
+        return fos.delete('firewall',
+                          'shaping-profile',
+                          mkey=filtered_data['profile-name'],
+                          vdom=vdom)
+
+
+def fortios_firewall(data, fos):
+    login(data)
+
+    methodlist = ['firewall_shaping_profile']
+    for method in methodlist:
+        if data[method]:
+            resp = eval(method)(data, fos)
+            break
+
+    fos.logout()
+    return not resp['status'] == "success", resp['status'] == "success", resp
+
+
+def main():
+    fields = {
+        "host": {"required": True, "type": "str"},
+        "username": {"required": True, "type": "str"},
+        "password": {"required": False, "type": "str", "no_log": True},
+        "vdom": {"required": False, "type": "str", "default": "root"},
+        "https": {"required": False, "type": "bool", "default": True},
+        "firewall_shaping_profile": {
+            "required": False, "type": "dict",
+            "options": {
+                "state": {"required": True, "type": "str",
+                          "choices": ["present", "absent"]},
+                "comment": {"required": False, "type": "str"},
+                "default-class-id": {"required": False, "type": "int"},
+                "profile-name": {"required": True, "type": "str"},
+                "shaping-entries": {"required": False, "type": "list",
+                                    "options": {
+                                        "class-id": {"required": False, "type": "int"},
+                                        "guaranteed-bandwidth-percentage": {"required": False, "type": "int"},
+                                        "id": {"required": True, "type": "int"},
+                                        "maximum-bandwidth-percentage": {"required": False, "type": "int"},
+                                        "priority": {"required": False, "type": "str",
+                                                     "choices": ["high", "medium", "low"]}
+                                    }}
+
+            }
+        }
+    }
+
+    module = AnsibleModule(argument_spec=fields,
+                           supports_check_mode=False)
+    try:
+        from fortiosapi import FortiOSAPI
+    except ImportError:
+        module.fail_json(msg="fortiosapi module is required")
+
+    global fos
+    fos = FortiOSAPI()
+
+    is_error, has_changed, result = fortios_firewall(module.params, fos)
+
+    if not is_error:
+        module.exit_json(changed=has_changed, meta=result)
+    else:
+        module.fail_json(msg="Error in repo", meta=result)
+
+
+if __name__ == '__main__':
+    main()