EVOLUTION-MANAGER

Edit File: fortios_system_gre_tunnel.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_system_gre_tunnel
short_description: Configure GRE tunnel 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 system feature and gre_tunnel category.
      Examples include all parameters and values need to be adjusted to datasources before usage.
      Tested with FOS v6.0.5
version_added: "2.9"
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
    state:
        description:
            - Indicates whether to create or remove the object.
        type: str
        required: true
        choices:
            - present
            - absent
    system_gre_tunnel:
        description:
            - Configure GRE tunnel.
        default: null
        type: dict
        suboptions:
            checksum_reception:
                description:
                    - Enable/disable validating checksums in received GRE packets.
                type: str
                choices:
                    - disable
                    - enable
            checksum_transmission:
                description:
                    - Enable/disable including checksums in transmitted GRE packets.
                type: str
                choices:
                    - disable
                    - enable
            dscp_copying:
                description:
                    - Enable/disable DSCP copying.
                type: str
                choices:
                    - disable
                    - enable
            interface:
                description:
                    - Interface name. Source system.interface.name.
                type: str
            ip_version:
                description:
                    - IP version to use for VPN interface.
                type: str
                choices:
                    - 4
                    - 6
            keepalive_failtimes:
                description:
                    - Number of consecutive unreturned keepalive messages before a GRE connection is considered down (1 - 255).
                type: int
            keepalive_interval:
                description:
                    - Keepalive message interval (0 - 32767, 0 = disabled).
                type: int
            key_inbound:
                description:
                    - Require received GRE packets contain this key (0 - 4294967295).
                type: int
            key_outbound:
                description:
                    - Include this key in transmitted GRE packets (0 - 4294967295).
                type: int
            local_gw:
                description:
                    - IP address of the local gateway.
                type: str
            local_gw6:
                description:
                    - IPv6 address of the local gateway.
                type: str
            name:
                description:
                    - Tunnel name.
                required: true
                type: str
            remote_gw:
                description:
                    - IP address of the remote gateway.
                type: str
            remote_gw6:
                description:
                    - IPv6 address of the remote gateway.
                type: str
            sequence_number_reception:
                description:
                    - Enable/disable validating sequence numbers in received GRE packets.
                type: str
                choices:
                    - disable
                    - enable
            sequence_number_transmission:
                description:
                    - Enable/disable including of sequence numbers in transmitted GRE packets.
                type: str
                choices:
                    - disable
                    - enable
'''

EXAMPLES = '''
- hosts: localhost
  vars:
   host: "192.168.122.40"
   username: "admin"
   password: ""
   vdom: "root"
   ssl_verify: "False"
  tasks:
  - name: Configure GRE tunnel.
    fortios_system_gre_tunnel:
      host:  "{{ host }}"
      username: "{{ username }}"
      password: "{{ password }}"
      vdom:  "{{ vdom }}"
      https: "False"
      state: "present"
      system_gre_tunnel:
        checksum_reception: "disable"
        checksum_transmission: "disable"
        dscp_copying: "disable"
        interface: "<your_own_value> (source system.interface.name)"
        ip_version: "4"
        keepalive_failtimes: "8"
        keepalive_interval: "9"
        key_inbound: "10"
        key_outbound: "11"
        local_gw: "<your_own_value>"
        local_gw6: "<your_own_value>"
        name: "default_name_14"
        remote_gw: "<your_own_value>"
        remote_gw6: "<your_own_value>"
        sequence_number_reception: "disable"
        sequence_number_transmission: "disable"
'''

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_system_gre_tunnel_data(json):
    option_list = ['checksum_reception', 'checksum_transmission', 'dscp_copying',
                   'interface', 'ip_version', 'keepalive_failtimes',
                   'keepalive_interval', 'key_inbound', 'key_outbound',
                   'local_gw', 'local_gw6', 'name',
                   'remote_gw', 'remote_gw6', 'sequence_number_reception',
                   'sequence_number_transmission']
    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 system_gre_tunnel(data, fos):
    vdom = data['vdom']
    state = data['state']
    system_gre_tunnel_data = data['system_gre_tunnel']
    filtered_data = underscore_to_hyphen(filter_system_gre_tunnel_data(system_gre_tunnel_data))

if state == "present":
        return fos.set('system',
                       'gre-tunnel',
                       data=filtered_data,
                       vdom=vdom)

elif state == "absent":
        return fos.delete('system',
                          'gre-tunnel',
                          mkey=filtered_data['name'],
                          vdom=vdom)

def is_successful_status(status):
    return status['status'] == "success" or \
        status['http_method'] == "DELETE" and status['http_status'] == 404

def fortios_system(data, fos):

if data['system_gre_tunnel']:
        resp = system_gre_tunnel(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": True, "type": "str",
                  "choices": ["present", "absent"]},
        "system_gre_tunnel": {
            "required": False, "type": "dict", "default": None,
            "options": {
                "checksum_reception": {"required": False, "type": "str",
                                       "choices": ["disable", "enable"]},
                "checksum_transmission": {"required": False, "type": "str",
                                          "choices": ["disable", "enable"]},
                "dscp_copying": {"required": False, "type": "str",
                                 "choices": ["disable", "enable"]},
                "interface": {"required": False, "type": "str"},
                "ip_version": {"required": False, "type": "str",
                               "choices": ["4", "6"]},
                "keepalive_failtimes": {"required": False, "type": "int"},
                "keepalive_interval": {"required": False, "type": "int"},
                "key_inbound": {"required": False, "type": "int"},
                "key_outbound": {"required": False, "type": "int"},
                "local_gw": {"required": False, "type": "str"},
                "local_gw6": {"required": False, "type": "str"},
                "name": {"required": True, "type": "str"},
                "remote_gw": {"required": False, "type": "str"},
                "remote_gw6": {"required": False, "type": "str"},
                "sequence_number_reception": {"required": False, "type": "str",
                                              "choices": ["disable", "enable"]},
                "sequence_number_transmission": {"required": False, "type": "str",
                                                 "choices": ["disable", "enable"]}

}
        }
    }

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_system(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_system(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()