diff options
Diffstat (limited to 'lib/ansible/modules/network/fortios/fortios_firewall_policy46.py')
-rw-r--r-- | lib/ansible/modules/network/fortios/fortios_firewall_policy46.py | 525 |
1 files changed, 0 insertions, 525 deletions
diff --git a/lib/ansible/modules/network/fortios/fortios_firewall_policy46.py b/lib/ansible/modules/network/fortios/fortios_firewall_policy46.py deleted file mode 100644 index f752d5762d..0000000000 --- a/lib/ansible/modules/network/fortios/fortios_firewall_policy46.py +++ /dev/null @@ -1,525 +0,0 @@ -#!/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_firewall_policy46 -short_description: Configure IPv4 to IPv6 policies 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 firewall feature and policy46 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 - state: - description: - - Indicates whether to create or remove the object. - This attribute was present already in previous version in a deeper level. - It has been moved out to this outer level. - type: str - required: false - choices: - - present - - absent - version_added: 2.9 - firewall_policy46: - description: - - Configure IPv4 to IPv6 policies. - default: null - type: dict - suboptions: - state: - description: - - B(Deprecated) - - Starting with Ansible 2.9 we recommend using the top-level 'state' parameter. - - HORIZONTALLINE - - Indicates whether to create or remove the object. - type: str - required: false - choices: - - present - - absent - action: - description: - - Accept or deny traffic matching the policy. - type: str - choices: - - accept - - deny - comments: - description: - - Comment. - type: str - dstaddr: - description: - - Destination address objects. - type: list - suboptions: - name: - description: - - Address name. Source firewall.vip46.name firewall.vipgrp46.name. - required: true - type: str - dstintf: - description: - - Destination interface name. Source system.interface.name system.zone.name. - type: str - fixedport: - description: - - Enable/disable fixed port for this policy. - type: str - choices: - - enable - - disable - ippool: - description: - - Enable/disable use of IP Pools for source NAT. - type: str - choices: - - enable - - disable - logtraffic: - description: - - Enable/disable traffic logging for this policy. - type: str - choices: - - enable - - disable - per_ip_shaper: - description: - - Per IP traffic shaper. Source firewall.shaper.per-ip-shaper.name. - type: str - permit_any_host: - description: - - Enable/disable allowing any host. - type: str - choices: - - enable - - disable - policyid: - description: - - Policy ID. - required: true - type: int - poolname: - description: - - IP Pool names. - type: list - suboptions: - name: - description: - - IP pool name. Source firewall.ippool6.name. - required: true - type: str - schedule: - description: - - Schedule name. Source firewall.schedule.onetime.name firewall.schedule.recurring.name firewall.schedule.group.name. - type: str - service: - description: - - Service name. - type: list - suboptions: - name: - description: - - Service name. Source firewall.service.custom.name firewall.service.group.name. - required: true - type: str - srcaddr: - description: - - Source address objects. - type: list - suboptions: - name: - description: - - Address name. Source firewall.address.name firewall.addrgrp.name. - required: true - type: str - srcintf: - description: - - Source interface name. Source system.zone.name system.interface.name. - type: str - status: - description: - - Enable/disable this policy. - type: str - choices: - - enable - - disable - tcp_mss_receiver: - description: - - TCP Maximum Segment Size value of receiver (0 - 65535) - type: int - tcp_mss_sender: - description: - - TCP Maximum Segment Size value of sender (0 - 65535). - type: int - traffic_shaper: - description: - - Traffic shaper. Source firewall.shaper.traffic-shaper.name. - type: str - traffic_shaper_reverse: - description: - - Reverse traffic shaper. Source firewall.shaper.traffic-shaper.name. - type: str - uuid: - description: - - Universally Unique Identifier (UUID; automatically assigned but can be manually reset). - type: str -''' - -EXAMPLES = ''' -- hosts: localhost - vars: - host: "192.168.122.40" - username: "admin" - password: "" - vdom: "root" - ssl_verify: "False" - tasks: - - name: Configure IPv4 to IPv6 policies. - fortios_firewall_policy46: - host: "{{ host }}" - username: "{{ username }}" - password: "{{ password }}" - vdom: "{{ vdom }}" - https: "False" - state: "present" - firewall_policy46: - action: "accept" - comments: "<your_own_value>" - dstaddr: - - - name: "default_name_6 (source firewall.vip46.name firewall.vipgrp46.name)" - dstintf: "<your_own_value> (source system.interface.name system.zone.name)" - fixedport: "enable" - ippool: "enable" - logtraffic: "enable" - per_ip_shaper: "<your_own_value> (source firewall.shaper.per-ip-shaper.name)" - permit_any_host: "enable" - policyid: "13" - poolname: - - - name: "default_name_15 (source firewall.ippool6.name)" - schedule: "<your_own_value> (source firewall.schedule.onetime.name firewall.schedule.recurring.name firewall.schedule.group.name)" - service: - - - name: "default_name_18 (source firewall.service.custom.name firewall.service.group.name)" - srcaddr: - - - name: "default_name_20 (source firewall.address.name firewall.addrgrp.name)" - srcintf: "<your_own_value> (source system.zone.name system.interface.name)" - status: "enable" - tcp_mss_receiver: "23" - tcp_mss_sender: "24" - traffic_shaper: "<your_own_value> (source firewall.shaper.traffic-shaper.name)" - traffic_shaper_reverse: "<your_own_value> (source firewall.shaper.traffic-shaper.name)" - uuid: "<your_own_value>" -''' - -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_firewall_policy46_data(json): - option_list = ['action', 'comments', 'dstaddr', - 'dstintf', 'fixedport', 'ippool', - 'logtraffic', 'per_ip_shaper', 'permit_any_host', - 'policyid', 'poolname', 'schedule', - 'service', 'srcaddr', 'srcintf', - 'status', 'tcp_mss_receiver', 'tcp_mss_sender', - 'traffic_shaper', 'traffic_shaper_reverse', 'uuid'] - 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 i, elem in enumerate(data): - data[i] = 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 firewall_policy46(data, fos): - vdom = data['vdom'] - if 'state' in data and data['state']: - state = data['state'] - elif 'state' in data['firewall_policy46'] and data['firewall_policy46']: - state = data['firewall_policy46']['state'] - else: - state = True - firewall_policy46_data = data['firewall_policy46'] - filtered_data = underscore_to_hyphen(filter_firewall_policy46_data(firewall_policy46_data)) - - if state == "present": - return fos.set('firewall', - 'policy46', - data=filtered_data, - vdom=vdom) - - elif state == "absent": - return fos.delete('firewall', - 'policy46', - mkey=filtered_data['policyid'], - vdom=vdom) - - -def is_successful_status(status): - return status['status'] == "success" or \ - status['http_method'] == "DELETE" and status['http_status'] == 404 - - -def fortios_firewall(data, fos): - - if data['firewall_policy46']: - resp = firewall_policy46(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}, - "state": {"required": False, "type": "str", - "choices": ["present", "absent"]}, - "firewall_policy46": { - "required": False, "type": "dict", "default": None, - "options": { - "state": {"required": False, "type": "str", - "choices": ["present", "absent"]}, - "action": {"required": False, "type": "str", - "choices": ["accept", "deny"]}, - "comments": {"required": False, "type": "str"}, - "dstaddr": {"required": False, "type": "list", - "options": { - "name": {"required": True, "type": "str"} - }}, - "dstintf": {"required": False, "type": "str"}, - "fixedport": {"required": False, "type": "str", - "choices": ["enable", "disable"]}, - "ippool": {"required": False, "type": "str", - "choices": ["enable", "disable"]}, - "logtraffic": {"required": False, "type": "str", - "choices": ["enable", "disable"]}, - "per_ip_shaper": {"required": False, "type": "str"}, - "permit_any_host": {"required": False, "type": "str", - "choices": ["enable", "disable"]}, - "policyid": {"required": True, "type": "int"}, - "poolname": {"required": False, "type": "list", - "options": { - "name": {"required": True, "type": "str"} - }}, - "schedule": {"required": False, "type": "str"}, - "service": {"required": False, "type": "list", - "options": { - "name": {"required": True, "type": "str"} - }}, - "srcaddr": {"required": False, "type": "list", - "options": { - "name": {"required": True, "type": "str"} - }}, - "srcintf": {"required": False, "type": "str"}, - "status": {"required": False, "type": "str", - "choices": ["enable", "disable"]}, - "tcp_mss_receiver": {"required": False, "type": "int"}, - "tcp_mss_sender": {"required": False, "type": "int"}, - "traffic_shaper": {"required": False, "type": "str"}, - "traffic_shaper_reverse": {"required": False, "type": "str"}, - "uuid": {"required": False, "type": "str"} - - } - } - } - - 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_firewall(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_firewall(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() |