From c6d88da3329f585c1cf8c9dbb4d6a0f9f1afa2e5 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Miguel=20Angel=20Mu=C3=B1oz=20Gonz=C3=A1lez?=
<magonzalez@fortinet.com>
Date: Thu, 22 Aug 2019 11:08:54 +0200
Subject: [PATCH] Fortinet's new module for fortios_system_ntp (#60851)
---
.../network/fortios/fortios_system_ntp.py | 404 ++++++++++++++++++
.../fortios/test_fortios_system_ntp.py | 183 ++++++++
2 files changed, 587 insertions(+)
create mode 100644 lib/ansible/modules/network/fortios/fortios_system_ntp.py
create mode 100644 test/units/modules/network/fortios/test_fortios_system_ntp.py
diff --git a/lib/ansible/modules/network/fortios/fortios_system_ntp.py b/lib/ansible/modules/network/fortios/fortios_system_ntp.py
new file mode 100644
index 00000000000..0a996c551bb
--- /dev/null
+++ b/lib/ansible/modules/network/fortios/fortios_system_ntp.py
@@ -0,0 +1,404 @@
+#!/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_ntp
+short_description: Configure system NTP information in Fortinet's FortiOS and FortiGate.
+description:
+ - This module is able to configure a FortiGate or FortiOS device by allowing the
+ user to set and modify system feature and ntp 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
+ system_ntp:
+ description:
+ - Configure system NTP information.
+ default: null
+ type: dict
+ suboptions:
+ interface:
+ description:
+ - FortiGate interface(s) with NTP server mode enabled. Devices on your network can contact these interfaces for NTP services.
+ type: list
+ suboptions:
+ interface_name:
+ description:
+ - Interface name. Source system.interface.name.
+ type: str
+ ntpserver:
+ description:
+ - Configure the FortiGate to connect to any available third-party NTP server.
+ type: list
+ suboptions:
+ authentication:
+ description:
+ - Enable/disable MD5 authentication.
+ type: str
+ choices:
+ - enable
+ - disable
+ id:
+ description:
+ - NTP server ID.
+ required: true
+ type: int
+ key:
+ description:
+ - Key for MD5 authentication.
+ type: str
+ key_id:
+ description:
+ - Key ID for authentication.
+ type: int
+ ntpv3:
+ description:
+ - Enable to use NTPv3 instead of NTPv4.
+ type: str
+ choices:
+ - enable
+ - disable
+ server:
+ description:
+ - IP address or hostname of the NTP Server.
+ type: str
+ ntpsync:
+ description:
+ - Enable/disable setting the FortiGate system time by synchronizing with an NTP Server.
+ type: str
+ choices:
+ - enable
+ - disable
+ server_mode:
+ description:
+ - Enable/disable FortiGate NTP Server Mode. Your FortiGate becomes an NTP server for other devices on your network. The FortiGate relays
+ NTP requests to its configured NTP server.
+ type: str
+ choices:
+ - enable
+ - disable
+ source_ip:
+ description:
+ - Source IP address for communication to the NTP server.
+ type: str
+ source_ip6:
+ description:
+ - Source IPv6 address for communication to the NTP server.
+ type: str
+ syncinterval:
+ description:
+ - NTP synchronization interval (1 - 1440 min).
+ type: int
+ type:
+ description:
+ - Use the FortiGuard NTP server or any other available NTP Server.
+ type: str
+ choices:
+ - fortiguard
+ - custom
+'''
+
+EXAMPLES = '''
+- hosts: localhost
+ vars:
+ host: "192.168.122.40"
+ username: "admin"
+ password: ""
+ vdom: "root"
+ ssl_verify: "False"
+ tasks:
+ - name: Configure system NTP information.
+ fortios_system_ntp:
+ host: "{{ host }}"
+ username: "{{ username }}"
+ password: "{{ password }}"
+ vdom: "{{ vdom }}"
+ https: "False"
+ system_ntp:
+ interface:
+ -
+ interface_name: "<your_own_value> (source system.interface.name)"
+ ntpserver:
+ -
+ authentication: "enable"
+ id: "7"
+ key: "<your_own_value>"
+ key_id: "9"
+ ntpv3: "enable"
+ server: "192.168.100.40"
+ ntpsync: "enable"
+ server_mode: "enable"
+ source_ip: "84.230.14.43"
+ source_ip6: "<your_own_value>"
+ syncinterval: "16"
+ type: "fortiguard"
+'''
+
+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_ntp_data(json):
+ option_list = ['interface', 'ntpserver', 'ntpsync',
+ 'server_mode', 'source_ip', 'source_ip6',
+ 'syncinterval', 'type']
+ 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_ntp(data, fos):
+ vdom = data['vdom']
+ system_ntp_data = data['system_ntp']
+ filtered_data = underscore_to_hyphen(filter_system_ntp_data(system_ntp_data))
+
+ return fos.set('system',
+ 'ntp',
+ 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_system(data, fos):
+
+ if data['system_ntp']:
+ resp = system_ntp(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", "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},
+ "system_ntp": {
+ "required": False, "type": "dict", "default": None,
+ "options": {
+ "interface": {"required": False, "type": "list",
+ "options": {
+ "interface_name": {"required": False, "type": "str"}
+ }},
+ "ntpserver": {"required": False, "type": "list",
+ "options": {
+ "authentication": {"required": False, "type": "str",
+ "choices": ["enable", "disable"]},
+ "id": {"required": True, "type": "int"},
+ "key": {"required": False, "type": "str"},
+ "key_id": {"required": False, "type": "int"},
+ "ntpv3": {"required": False, "type": "str",
+ "choices": ["enable", "disable"]},
+ "server": {"required": False, "type": "str"}
+ }},
+ "ntpsync": {"required": False, "type": "str",
+ "choices": ["enable", "disable"]},
+ "server_mode": {"required": False, "type": "str",
+ "choices": ["enable", "disable"]},
+ "source_ip": {"required": False, "type": "str"},
+ "source_ip6": {"required": False, "type": "str"},
+ "syncinterval": {"required": False, "type": "int"},
+ "type": {"required": False, "type": "str",
+ "choices": ["fortiguard", "custom"]}
+
+ }
+ }
+ }
+
+ module = AnsibleModule(argument_spec=fields,
+ supports_check_mode=False)
+
+ 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()
diff --git a/test/units/modules/network/fortios/test_fortios_system_ntp.py b/test/units/modules/network/fortios/test_fortios_system_ntp.py
new file mode 100644
index 00000000000..9340b0fd187
--- /dev/null
+++ b/test/units/modules/network/fortios/test_fortios_system_ntp.py
@@ -0,0 +1,183 @@
+# 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 Ansible. If not, see <https://www.gnu.org/licenses/>.
+
+# Make coding more python3-ish
+from __future__ import (absolute_import, division, print_function)
+__metaclass__ = type
+
+import os
+import json
+import pytest
+from mock import ANY
+from ansible.module_utils.network.fortios.fortios import FortiOSHandler
+
+try:
+ from ansible.modules.network.fortios import fortios_system_ntp
+except ImportError:
+ pytest.skip("Could not load required modules for testing", allow_module_level=True)
+
+
+@pytest.fixture(autouse=True)
+def connection_mock(mocker):
+ connection_class_mock = mocker.patch('ansible.modules.network.fortios.fortios_system_ntp.Connection')
+ return connection_class_mock
+
+
+fos_instance = FortiOSHandler(connection_mock)
+
+
+def test_system_ntp_creation(mocker):
+ schema_method_mock = mocker.patch('ansible.module_utils.network.fortios.fortios.FortiOSHandler.schema')
+
+ set_method_result = {'status': 'success', 'http_method': 'POST', 'http_status': 200}
+ set_method_mock = mocker.patch('ansible.module_utils.network.fortios.fortios.FortiOSHandler.set', return_value=set_method_result)
+
+ input_data = {
+ 'username': 'admin',
+ 'state': 'present',
+ 'system_ntp': {'ntpsync': 'enable',
+ 'server_mode': 'enable',
+ 'source_ip': '84.230.14.5',
+ 'source_ip6': 'test_value_6',
+ 'syncinterval': '7',
+ 'type': 'fortiguard'
+ },
+ 'vdom': 'root'}
+
+ is_error, changed, response = fortios_system_ntp.fortios_system(input_data, fos_instance)
+
+ expected_data = {'ntpsync': 'enable',
+ 'server-mode': 'enable',
+ 'source-ip': '84.230.14.5',
+ 'source-ip6': 'test_value_6',
+ 'syncinterval': '7',
+ 'type': 'fortiguard'
+ }
+
+ set_method_mock.assert_called_with('system', 'ntp', data=expected_data, vdom='root')
+ schema_method_mock.assert_not_called()
+ assert not is_error
+ assert changed
+ assert response['status'] == 'success'
+ assert response['http_status'] == 200
+
+
+def test_system_ntp_creation_fails(mocker):
+ schema_method_mock = mocker.patch('ansible.module_utils.network.fortios.fortios.FortiOSHandler.schema')
+
+ set_method_result = {'status': 'error', 'http_method': 'POST', 'http_status': 500}
+ set_method_mock = mocker.patch('ansible.module_utils.network.fortios.fortios.FortiOSHandler.set', return_value=set_method_result)
+
+ input_data = {
+ 'username': 'admin',
+ 'state': 'present',
+ 'system_ntp': {'ntpsync': 'enable',
+ 'server_mode': 'enable',
+ 'source_ip': '84.230.14.5',
+ 'source_ip6': 'test_value_6',
+ 'syncinterval': '7',
+ 'type': 'fortiguard'
+ },
+ 'vdom': 'root'}
+
+ is_error, changed, response = fortios_system_ntp.fortios_system(input_data, fos_instance)
+
+ expected_data = {'ntpsync': 'enable',
+ 'server-mode': 'enable',
+ 'source-ip': '84.230.14.5',
+ 'source-ip6': 'test_value_6',
+ 'syncinterval': '7',
+ 'type': 'fortiguard'
+ }
+
+ set_method_mock.assert_called_with('system', 'ntp', data=expected_data, vdom='root')
+ schema_method_mock.assert_not_called()
+ assert is_error
+ assert not changed
+ assert response['status'] == 'error'
+ assert response['http_status'] == 500
+
+
+def test_system_ntp_idempotent(mocker):
+ schema_method_mock = mocker.patch('ansible.module_utils.network.fortios.fortios.FortiOSHandler.schema')
+
+ set_method_result = {'status': 'error', 'http_method': 'DELETE', 'http_status': 404}
+ set_method_mock = mocker.patch('ansible.module_utils.network.fortios.fortios.FortiOSHandler.set', return_value=set_method_result)
+
+ input_data = {
+ 'username': 'admin',
+ 'state': 'present',
+ 'system_ntp': {'ntpsync': 'enable',
+ 'server_mode': 'enable',
+ 'source_ip': '84.230.14.5',
+ 'source_ip6': 'test_value_6',
+ 'syncinterval': '7',
+ 'type': 'fortiguard'
+ },
+ 'vdom': 'root'}
+
+ is_error, changed, response = fortios_system_ntp.fortios_system(input_data, fos_instance)
+
+ expected_data = {'ntpsync': 'enable',
+ 'server-mode': 'enable',
+ 'source-ip': '84.230.14.5',
+ 'source-ip6': 'test_value_6',
+ 'syncinterval': '7',
+ 'type': 'fortiguard'
+ }
+
+ set_method_mock.assert_called_with('system', 'ntp', data=expected_data, vdom='root')
+ schema_method_mock.assert_not_called()
+ assert not is_error
+ assert not changed
+ assert response['status'] == 'error'
+ assert response['http_status'] == 404
+
+
+def test_system_ntp_filter_foreign_attributes(mocker):
+ schema_method_mock = mocker.patch('ansible.module_utils.network.fortios.fortios.FortiOSHandler.schema')
+
+ set_method_result = {'status': 'success', 'http_method': 'POST', 'http_status': 200}
+ set_method_mock = mocker.patch('ansible.module_utils.network.fortios.fortios.FortiOSHandler.set', return_value=set_method_result)
+
+ input_data = {
+ 'username': 'admin',
+ 'state': 'present',
+ 'system_ntp': {
+ 'random_attribute_not_valid': 'tag', 'ntpsync': 'enable',
+ 'server_mode': 'enable',
+ 'source_ip': '84.230.14.5',
+ 'source_ip6': 'test_value_6',
+ 'syncinterval': '7',
+ 'type': 'fortiguard'
+ },
+ 'vdom': 'root'}
+
+ is_error, changed, response = fortios_system_ntp.fortios_system(input_data, fos_instance)
+
+ expected_data = {'ntpsync': 'enable',
+ 'server-mode': 'enable',
+ 'source-ip': '84.230.14.5',
+ 'source-ip6': 'test_value_6',
+ 'syncinterval': '7',
+ 'type': 'fortiguard'
+ }
+
+ set_method_mock.assert_called_with('system', 'ntp', data=expected_data, vdom='root')
+ schema_method_mock.assert_not_called()
+ assert not is_error
+ assert changed
+ assert response['status'] == 'success'
+ assert response['http_status'] == 200