EVOLUTION-MANAGER

Edit File: fortios_router_rip.py

#!/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/>. __metaclass__ = type ANSIBLE_METADATA = {'status': ['preview'], 'supported_by': 'community', 'metadata_version': '1.1'} DOCUMENTATION = ''' --- module: fortios_router_rip short_description: Configure RIP in Fortinet's FortiOS and FortiGate. description: - This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify router feature and rip category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5 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 address. type: str required: false username: description: - FortiOS or FortiGate username. type: str required: false password: description: - FortiOS or FortiGate password. type: str 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. type: str default: root https: description: - Indicates if the requests towards FortiGate must use HTTPS protocol. type: bool default: true ssl_verify: description: - Ensures FortiGate certificate must be verified by a proper CA. type: bool default: true version_added: 2.9 router_rip: description: - Configure RIP. default: null type: dict suboptions: default_information_originate: description: - Enable/disable generation of default route. type: str choices: - enable - disable default_metric: description: - Default metric. type: int distance: description: - distance type: list suboptions: access_list: description: - Access list for route destination. Source router.access-list.name. type: str distance: description: - Distance (1 - 255). type: int id: description: - Distance ID. required: true type: int prefix: description: - Distance prefix. type: str distribute_list: description: - Distribute list. type: list suboptions: direction: description: - Distribute list direction. type: str choices: - in - out id: description: - Distribute list ID. required: true type: int interface: description: - Distribute list interface name. Source system.interface.name. type: str listname: description: - Distribute access/prefix list name. Source router.access-list.name router.prefix-list.name. type: str status: description: - status type: str choices: - enable - disable garbage_timer: description: - Garbage timer in seconds. type: int interface: description: - RIP interface configuration. type: list suboptions: auth_keychain: description: - Authentication key-chain name. Source router.key-chain.name. type: str auth_mode: description: - Authentication mode. type: str choices: - none - text - md5 auth_string: description: - Authentication string/password. type: str flags: description: - flags type: int name: description: - Interface name. Source system.interface.name. required: true type: str receive_version: description: - Receive version. type: str choices: - 1 - 2 send_version: description: - Send version. type: str choices: - 1 - 2 send_version2_broadcast: description: - Enable/disable broadcast version 1 compatible packets. type: str choices: - disable - enable split_horizon: description: - Enable/disable split horizon. type: str choices: - poisoned - regular split_horizon_status: description: - Enable/disable split horizon. type: str choices: - enable - disable max_out_metric: description: - Maximum metric allowed to output(0 means 'not set'). type: int neighbor: description: - neighbor type: list suboptions: id: description: - Neighbor entry ID. required: true type: int ip: description: - IP address. type: str network: description: - network type: list suboptions: id: description: - Network entry ID. required: true type: int prefix: description: - Network prefix. type: str offset_list: description: - Offset list. type: list suboptions: access_list: description: - Access list name. Source router.access-list.name. type: str direction: description: - Offset list direction. type: str choices: - in - out id: description: - Offset-list ID. required: true type: int interface: description: - Interface name. Source system.interface.name. type: str offset: description: - offset type: int status: description: - status type: str choices: - enable - disable passive_interface: description: - Passive interface configuration. type: list suboptions: name: description: - Passive interface name. Source system.interface.name. required: true type: str recv_buffer_size: description: - Receiving buffer size. type: int redistribute: description: - Redistribute configuration. type: list suboptions: metric: description: - Redistribute metric setting. type: int name: description: - Redistribute name. required: true type: str routemap: description: - Route map name. Source router.route-map.name. type: str status: description: - status type: str choices: - enable - disable timeout_timer: description: - Timeout timer in seconds. type: int update_timer: description: - Update timer in seconds. type: int version: description: - RIP version. type: str choices: - 1 - 2 ''' EXAMPLES = ''' - hosts: localhost vars: host: "192.168.122.40" username: "admin" password: "" vdom: "root" ssl_verify: "False" tasks: - name: Configure RIP. fortios_router_rip: host: "{{ host }}" username: "{{ username }}" password: "{{ password }}" vdom: "{{ vdom }}" https: "False" router_rip: default_information_originate: "enable" default_metric: "4" distance: - access_list: "<your_own_value> (source router.access-list.name)" distance: "7" id: "8" prefix: "<your_own_value>" distribute_list: - direction: "in" id: "12" interface: "<your_own_value> (source system.interface.name)" listname: "<your_own_value> (source router.access-list.name router.prefix-list.name)" status: "enable" garbage_timer: "16" interface: - auth_keychain: "<your_own_value> (source router.key-chain.name)" auth_mode: "none" auth_string: "<your_own_value>" flags: "21" name: "default_name_22 (source system.interface.name)" receive_version: "1" send_version: "1" send_version2_broadcast: "disable" split_horizon: "poisoned" split_horizon_status: "enable" max_out_metric: "28" neighbor: - id: "30" ip: "<your_own_value>" network: - id: "33" prefix: "<your_own_value>" offset_list: - access_list: "<your_own_value> (source router.access-list.name)" direction: "in" id: "38" interface: "<your_own_value> (source system.interface.name)" offset: "40" status: "enable" passive_interface: - name: "default_name_43 (source system.interface.name)" recv_buffer_size: "44" redistribute: - metric: "46" name: "default_name_47" routemap: "<your_own_value> (source router.route-map.name)" status: "enable" timeout_timer: "50" update_timer: "51" version: "1" ''' 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 from ansible.module_utils.connection import Connection from ansible.module_utils.network.fortios.fortios import FortiOSHandler from ansible.module_utils.network.fortimanager.common import FAIL_SOCKET_MSG def login(data, fos): host = data['host'] username = data['username'] password = data['password'] ssl_verify = data['ssl_verify'] fos.debug('on') if 'https' in data and not data['https']: fos.https('off') else: fos.https('on') fos.login(host, username, password, verify=ssl_verify) def filter_router_rip_data(json): option_list = ['default_information_originate', 'default_metric', 'distance', 'distribute_list', 'garbage_timer', 'interface', 'max_out_metric', 'neighbor', 'network', 'offset_list', 'passive_interface', 'recv_buffer_size', 'redistribute', 'timeout_timer', 'update_timer', 'version'] dictionary = {} for attribute in option_list: if attribute in json and json[attribute] is not None: dictionary[attribute] = json[attribute] return dictionary def underscore_to_hyphen(data): if isinstance(data, list): for elem in data: elem = underscore_to_hyphen(elem) elif isinstance(data, dict): new_data = {} for k, v in data.items(): new_data[k.replace('_', '-')] = underscore_to_hyphen(v) data = new_data return data def router_rip(data, fos): vdom = data['vdom'] router_rip_data = data['router_rip'] filtered_data = underscore_to_hyphen(filter_router_rip_data(router_rip_data)) return fos.set('router', 'rip', data=filtered_data, vdom=vdom) def is_successful_status(status): return status['status'] == "success" or \ status['http_method'] == "DELETE" and status['http_status'] == 404 def fortios_router(data, fos): if data['router_rip']: resp = router_rip(data, fos) return not is_successful_status(resp), \ resp['status'] == "success", \ resp def main(): fields = { "host": {"required": False, "type": "str"}, "username": {"required": False, "type": "str"}, "password": {"required": False, "type": "str", "default": "", "no_log": True}, "vdom": {"required": False, "type": "str", "default": "root"}, "https": {"required": False, "type": "bool", "default": True}, "ssl_verify": {"required": False, "type": "bool", "default": True}, "router_rip": { "required": False, "type": "dict", "default": None, "options": { "default_information_originate": {"required": False, "type": "str", "choices": ["enable", "disable"]}, "default_metric": {"required": False, "type": "int"}, "distance": {"required": False, "type": "list", "options": { "access_list": {"required": False, "type": "str"}, "distance": {"required": False, "type": "int"}, "id": {"required": True, "type": "int"}, "prefix": {"required": False, "type": "str"} }}, "distribute_list": {"required": False, "type": "list", "options": { "direction": {"required": False, "type": "str", "choices": ["in", "out"]}, "id": {"required": True, "type": "int"}, "interface": {"required": False, "type": "str"}, "listname": {"required": False, "type": "str"}, "status": {"required": False, "type": "str", "choices": ["enable", "disable"]} }}, "garbage_timer": {"required": False, "type": "int"}, "interface": {"required": False, "type": "list", "options": { "auth_keychain": {"required": False, "type": "str"}, "auth_mode": {"required": False, "type": "str", "choices": ["none", "text", "md5"]}, "auth_string": {"required": False, "type": "str", "no_log": True}, "flags": {"required": False, "type": "int"}, "name": {"required": True, "type": "str"}, "receive_version": {"required": False, "type": "str", "choices": ["1", "2"]}, "send_version": {"required": False, "type": "str", "choices": ["1", "2"]}, "send_version2_broadcast": {"required": False, "type": "str", "choices": ["disable", "enable"]}, "split_horizon": {"required": False, "type": "str", "choices": ["poisoned", "regular"]}, "split_horizon_status": {"required": False, "type": "str", "choices": ["enable", "disable"]} }}, "max_out_metric": {"required": False, "type": "int"}, "neighbor": {"required": False, "type": "list", "options": { "id": {"required": True, "type": "int"}, "ip": {"required": False, "type": "str"} }}, "network": {"required": False, "type": "list", "options": { "id": {"required": True, "type": "int"}, "prefix": {"required": False, "type": "str"} }}, "offset_list": {"required": False, "type": "list", "options": { "access_list": {"required": False, "type": "str"}, "direction": {"required": False, "type": "str", "choices": ["in", "out"]}, "id": {"required": True, "type": "int"}, "interface": {"required": False, "type": "str"}, "offset": {"required": False, "type": "int"}, "status": {"required": False, "type": "str", "choices": ["enable", "disable"]} }}, "passive_interface": {"required": False, "type": "list", "options": { "name": {"required": True, "type": "str"} }}, "recv_buffer_size": {"required": False, "type": "int"}, "redistribute": {"required": False, "type": "list", "options": { "metric": {"required": False, "type": "int"}, "name": {"required": True, "type": "str"}, "routemap": {"required": False, "type": "str"}, "status": {"required": False, "type": "str", "choices": ["enable", "disable"]} }}, "timeout_timer": {"required": False, "type": "int"}, "update_timer": {"required": False, "type": "int"}, "version": {"required": False, "type": "str", "choices": ["1", "2"]} } } } module = AnsibleModule(argument_spec=fields, supports_check_mode=False) # legacy_mode refers to using fortiosapi instead of HTTPAPI legacy_mode = 'host' in module.params and module.params['host'] is not None and \ 'username' in module.params and module.params['username'] is not None and \ 'password' in module.params and module.params['password'] is not None if not legacy_mode: if module._socket_path: connection = Connection(module._socket_path) fos = FortiOSHandler(connection) is_error, has_changed, result = fortios_router(module.params, fos) else: module.fail_json(**FAIL_SOCKET_MSG) else: try: from fortiosapi import FortiOSAPI except ImportError: module.fail_json(msg="fortiosapi module is required") fos = FortiOSAPI() login(module.params, fos) is_error, has_changed, result = fortios_router(module.params, fos) fos.logout() 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()