From d5df3c51fa8b40cff5c342e809e17853fddbc305 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Miguel=20Angel=20Mu=C3=B1oz=20Gonz=C3=A1lez?= Date: Tue, 12 Feb 2019 15:27:28 +0100 Subject: [PATCH] Fortinet's FortiOS Application Name (#51815) --- .../fortios/fortios_application_name.py | 346 ++++++++++++++++++ 1 file changed, 346 insertions(+) create mode 100644 lib/ansible/modules/network/fortios/fortios_application_name.py diff --git a/lib/ansible/modules/network/fortios/fortios_application_name.py b/lib/ansible/modules/network/fortios/fortios_application_name.py new file mode 100644 index 0000000000..0b500a36ba --- /dev/null +++ b/lib/ansible/modules/network/fortios/fortios_application_name.py @@ -0,0 +1,346 @@ +#!/usr/bin/python +from __future__ import (absolute_import, division, print_function) +# Copyright 2018 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 . +# +# 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_application_name +short_description: Configure application signatures in Fortinet's FortiOS and FortiGate. +description: + - This module is able to configure a FortiGate or FortiOS by + allowing the user to configure application feature and name 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: false + application_name: + description: + - Configure application signatures. + default: null + suboptions: + state: + description: + - Indicates whether to create or remove the object + choices: + - present + - absent + behavior: + description: + - Application behavior. + category: + description: + - Application category ID. + id: + description: + - Application ID. + metadata: + description: + - Meta data. + suboptions: + id: + description: + - ID. + required: true + metaid: + description: + - Meta ID. + valueid: + description: + - Value ID. + name: + description: + - Application name. + required: true + parameter: + description: + - Application parameter name. + popularity: + description: + - Application popularity. + protocol: + description: + - Application protocol. + risk: + description: + - Application risk. + sub-category: + description: + - Application sub-category ID. + technology: + description: + - Application technology. + vendor: + description: + - Application vendor. + weight: + description: + - Application weight. +''' + +EXAMPLES = ''' +- hosts: localhost + vars: + host: "192.168.122.40" + username: "admin" + password: "" + vdom: "root" + tasks: + - name: Configure application signatures. + fortios_application_name: + host: "{{ host }}" + username: "{{ username }}" + password: "{{ password }}" + vdom: "{{ vdom }}" + application_name: + state: "present" + behavior: "" + category: "4" + id: "5" + metadata: + - + id: "7" + metaid: "8" + valueid: "9" + name: "default_name_10" + parameter: "" + popularity: "12" + protocol: "" + risk: "14" + sub-category: "15" + technology: "" + vendor: "" + weight: "18" +''' + +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_application_name_data(json): + option_list = ['behavior', 'category', 'id', + 'metadata', 'name', 'parameter', + 'popularity', 'protocol', 'risk', + 'sub-category', 'technology', 'vendor', + 'weight'] + dictionary = {} + + for attribute in option_list: + if attribute in json and json[attribute] is not None: + dictionary[attribute] = json[attribute] + + return dictionary + + +def application_name(data, fos): + vdom = data['vdom'] + application_name_data = data['application_name'] + filtered_data = filter_application_name_data(application_name_data) + if application_name_data['state'] == "present": + return fos.set('application', + 'name', + data=filtered_data, + vdom=vdom) + + elif application_name_data['state'] == "absent": + return fos.delete('application', + 'name', + mkey=filtered_data['name'], + vdom=vdom) + + +def fortios_application(data, fos): + login(data) + + methodlist = ['application_name'] + 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": "False"}, + "application_name": { + "required": False, "type": "dict", + "options": { + "state": {"required": True, "type": "str", + "choices": ["present", "absent"]}, + "behavior": {"required": False, "type": "str"}, + "category": {"required": False, "type": "int"}, + "id": {"required": False, "type": "int"}, + "metadata": {"required": False, "type": "list", + "options": { + "id": {"required": True, "type": "int"}, + "metaid": {"required": False, "type": "int"}, + "valueid": {"required": False, "type": "int"} + }}, + "name": {"required": True, "type": "str"}, + "parameter": {"required": False, "type": "str"}, + "popularity": {"required": False, "type": "int"}, + "protocol": {"required": False, "type": "str"}, + "risk": {"required": False, "type": "int"}, + "sub-category": {"required": False, "type": "int"}, + "technology": {"required": False, "type": "str"}, + "vendor": {"required": False, "type": "str"}, + "weight": {"required": False, "type": "int"} + + } + } + } + + 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_application(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()