Add vyos_ntp resource module (#175)

Add vyos_ntp resource module

SUMMARY


Resource module vyos_ntp
ISSUE TYPE


New Module Pull Request

COMPONENT NAME

vyos_ntp
ADDITIONAL INFORMATION

Reviewed-by: GomathiselviS <None>
Reviewed-by: Nilashish Chakraborty <nilashishchakraborty8@gmail.com>
Reviewed-by: None <None>

9 files changed, 1313 insertions, 0 deletions

diff --git a/plugins/module_utils/network/vyos/argspec/ntp_global/__init__.py b/plugins/module_utils/network/vyos/argspec/ntp_global/__init__.py
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/plugins/module_utils/network/vyos/argspec/ntp_global/__init__.py
diff --git a/plugins/module_utils/network/vyos/argspec/ntp_global/ntp_global.py b/plugins/module_utils/network/vyos/argspec/ntp_global/ntp_global.py
new file mode 100644
index 0000000..6326215
--- /dev/null
+++ b/plugins/module_utils/network/vyos/argspec/ntp_global/ntp_global.py
@@ -0,0 +1,72 @@
+# -*- coding: utf-8 -*-
+# Copyright 2021 Red Hat
+# GNU General Public License v3.0+
+# (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
+
+from __future__ import absolute_import, division, print_function
+
+__metaclass__ = type
+
+#############################################
+#                WARNING                    #
+#############################################
+#
+# This file is auto generated by the
+# cli_rm_builder.
+#
+# Manually editing this file is not advised.
+#
+# To update the argspec make the desired changes
+# in the module docstring and re-run
+# cli_rm_builder.
+#
+#############################################
+
+"""
+The arg spec for the vyos_ntp module
+"""
+
+
+class Ntp_globalArgs(object):  # pylint: disable=R0903
+    """The arg spec for the vyos_ntp module"""
+
+    argument_spec = {
+        "config": {
+            "type": "dict",
+            "options": {
+                "allow_clients": {"type": "list", "elements": "str"},
+                "listen_addresses": {"type": "list", "elements": "str"},
+                "servers": {
+                    "type": "list",
+                    "elements": "dict",
+                    "options": {
+                        "server": {"type": "str"},
+                        "options": {
+                            "type": "list",
+                            "elements": "str",
+                            "choices": [
+                                "noselect",
+                                "dynamic",
+                                "preempt",
+                                "prefer",
+                            ],
+                        },
+                    },
+                },
+            },
+        },
+        "running_config": {"type": "str"},
+        "state": {
+            "type": "str",
+            "choices": [
+                "deleted",
+                "merged",
+                "overridden",
+                "replaced",
+                "gathered",
+                "rendered",
+                "parsed",
+            ],
+            "default": "merged",
+        },
+    }  # pylint: disable=C0301
diff --git a/plugins/module_utils/network/vyos/config/ntp_global/__init__.py b/plugins/module_utils/network/vyos/config/ntp_global/__init__.py
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/plugins/module_utils/network/vyos/config/ntp_global/__init__.py
diff --git a/plugins/module_utils/network/vyos/config/ntp_global/ntp_global.py b/plugins/module_utils/network/vyos/config/ntp_global/ntp_global.py
new file mode 100644
index 0000000..0a0e389
--- /dev/null
+++ b/plugins/module_utils/network/vyos/config/ntp_global/ntp_global.py
@@ -0,0 +1,197 @@
+#
+# -*- coding: utf-8 -*-
+# Copyright 2021 Red Hat
+# GNU General Public License v3.0+
+# (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
+#
+
+from __future__ import absolute_import, division, print_function
+
+__metaclass__ = type
+
+"""
+The vyos_ntp config file.
+It is in this file where the current configuration (as dict)
+is compared to the provided configuration (as dict) and the command set
+necessary to bring the current configuration to its desired end-state is
+created.
+"""
+
+from ansible.module_utils.six import iteritems
+from ansible_collections.ansible.netcommon.plugins.module_utils.network.common.utils import (
+    dict_merge,
+)
+from ansible_collections.ansible.netcommon.plugins.module_utils.network.common.rm_base.resource_module import (
+    ResourceModule,
+)
+from ansible_collections.vyos.vyos.plugins.module_utils.network.vyos.facts.facts import (
+    Facts,
+)
+from ansible_collections.vyos.vyos.plugins.module_utils.network.vyos.rm_templates.ntp_global import (
+    NtpTemplate,
+)
+
+
+class Ntp_global(ResourceModule):
+    """
+    The vyos_ntp config class
+    """
+
+    def __init__(self, module):
+        super(Ntp_global, self).__init__(
+            empty_fact_val={},
+            facts_module=Facts(module),
+            module=module,
+            resource="ntp_global",
+            tmplt=NtpTemplate(),
+        )
+        self.parsers = [
+            "allow_clients",
+            "listen_addresses",
+            "server",
+            "options",
+            "allow_clients_delete",
+            "listen_addresses_delete",
+        ]
+
+    def execute_module(self):
+        """Execute the module
+
+        :rtype: A dictionary
+        :returns: The result from module execution
+        """
+        if self.state not in ["parsed", "gathered"]:
+            self.generate_commands()
+            self.run_commands()
+        return self.result
+
+    def generate_commands(self):
+        """Generate configuration commands to send based on
+        want, have and desired state.
+        """
+
+        wantd = self._ntp_list_to_dict(self.want)
+        haved = self._ntp_list_to_dict(self.have)
+
+        # if state is merged, merge want onto have and then compare
+        if self.state == "merged":
+            wantd = dict_merge(haved, wantd)
+
+        # if state is deleted, empty out wantd and set haved to wantd
+        if self.state == "deleted":
+            haved = {
+                k: v for k, v in iteritems(haved) if k in wantd or not wantd
+            }
+            wantd = {}
+
+            commandlist = self._commandlist(haved)
+            servernames = self._servernames(haved)
+            # removing the servername and commandlist from the list after deleting it from haved
+            for k, have in iteritems(haved):
+                if k not in wantd:
+                    for hk, hval in iteritems(have):
+                        if hk == "allow_clients" and hk in commandlist:
+                            self.commands.append(
+                                self._tmplt.render(
+                                    {"": hk}, "allow_clients_delete", True
+                                )
+                            )
+                            commandlist.remove(hk)
+                        elif hk == "listen_addresses" and hk in commandlist:
+                            self.commands.append(
+                                self._tmplt.render(
+                                    {"": hk}, "listen_addresses_delete", True
+                                )
+                            )
+                            commandlist.remove(hk)
+                        elif hk == "server" and have["server"] in servernames:
+                            self._compareoverride(want={}, have=have)
+                            servernames.remove(have["server"])
+
+        # remove existing config for overridden,replaced and deleted
+        # Getting the list of the server names from haved
+        #   to avoid the duplication of overridding/replacing the servers
+        if self.state in ["overridden", "replaced"]:
+
+            commandlist = self._commandlist(haved)
+            servernames = self._servernames(haved)
+
+            for k, have in iteritems(haved):
+                if k not in wantd and "server" not in have:
+                    self._compareoverride(want={}, have=have)
+                    # removing the servername from the list after deleting it from haved
+                elif k not in wantd and have["server"] in servernames:
+                    self._compareoverride(want={}, have=have)
+                    servernames.remove(have["server"])
+
+        for k, want in iteritems(wantd):
+            self._compare(want=want, have=haved.pop(k, {}))
+
+    def _compare(self, want, have):
+        """Leverages the base class `compare()` method and
+        populates the list of commands to be run by comparing
+        the `want` and `have` data with the `parsers` defined
+        for the Ntp network resource.
+        """
+        if "options" in want:
+            self.compare(parsers="options", want=want, have=have)
+        else:
+            self.compare(parsers=self.parsers, want=want, have=have)
+
+    def _compareoverride(self, want, have):
+        # do not delete configuration with options level
+        for i, val in iteritems(have):
+            if i == "options":
+                pass
+            else:
+                self.compare(parsers=i, want={}, have=have)
+
+    def _ntp_list_to_dict(self, entry):
+        servers_dict = {}
+        for k, data in iteritems(entry):
+            if k == "servers":
+                for value in data:
+                    if "options" in value:
+                        result = self._serveroptions_list_to_dict(value)
+                        for res, resvalue in iteritems(result):
+                            servers_dict.update({res: resvalue})
+                    else:
+                        servers_dict.update({value["server"]: value})
+            else:
+                for value in data:
+                    servers_dict.update({"ip_" + value: {k: value}})
+        return servers_dict
+
+    def _serveroptions_list_to_dict(self, entry):
+        serveroptions_dict = {}
+        for Opk, Op in iteritems(entry):
+            if Opk == "options":
+                for val in Op:
+                    dict = {}
+                    dict.update({"server": entry["server"]})
+                    dict.update({Opk: val})
+                    serveroptions_dict.update(
+                        {entry["server"] + "_" + val: dict}
+                    )
+        return serveroptions_dict
+
+    def _commandlist(self, haved):
+        commandlist = []
+        for k, have in iteritems(haved):
+            for ck, cval in iteritems(have):
+                if ck != "options" and ck not in commandlist:
+                    commandlist.append(ck)
+        return commandlist
+
+    def _servernames(self, haved):
+        servernames = []
+        for k, have in iteritems(haved):
+            for sk, sval in iteritems(have):
+                if sk == "server" and sval not in [
+                    "0.pool.ntp.org",
+                    "1.pool.ntp.org",
+                    "2.pool.ntp.org",
+                ]:
+                    if sval not in servernames:
+                        servernames.append(sval)
+        return servernames
diff --git a/plugins/module_utils/network/vyos/facts/facts.py b/plugins/module_utils/network/vyos/facts/facts.py
index ab074b0..e560a48 100644
--- a/plugins/module_utils/network/vyos/facts/facts.py
+++ b/plugins/module_utils/network/vyos/facts/facts.py
@@ -64,6 +64,9 @@ from ansible_collections.vyos.vyos.plugins.module_utils.network.vyos.facts.prefi
 from ansible_collections.vyos.vyos.plugins.module_utils.network.vyos.facts.logging_global.logging_global import (
     Logging_globalFacts,
 )
+from ansible_collections.vyos.vyos.plugins.module_utils.network.vyos.facts.ntp_global.ntp_global import (
+    Ntp_globalFacts,
+)
 from ansible_collections.vyos.vyos.plugins.module_utils.network.vyos.facts.legacy.base import (
     Default,
     Neighbors,
@@ -90,6 +93,7 @@ FACT_RESOURCE_SUBSETS = dict(
     route_maps=Route_mapsFacts,
     prefix_lists=Prefix_listsFacts,
     logging_global=Logging_globalFacts,
+    ntp_global=Ntp_globalFacts,
 )
 
 
diff --git a/plugins/module_utils/network/vyos/facts/ntp_global/__init__.py b/plugins/module_utils/network/vyos/facts/ntp_global/__init__.py
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/plugins/module_utils/network/vyos/facts/ntp_global/__init__.py
diff --git a/plugins/module_utils/network/vyos/facts/ntp_global/ntp_global.py b/plugins/module_utils/network/vyos/facts/ntp_global/ntp_global.py
new file mode 100644
index 0000000..bb20e2d
--- /dev/null
+++ b/plugins/module_utils/network/vyos/facts/ntp_global/ntp_global.py
@@ -0,0 +1,99 @@
+# -*- coding: utf-8 -*-
+# Copyright 2021 Red Hat
+# GNU General Public License v3.0+
+# (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
+
+from __future__ import absolute_import, division, print_function
+
+
+__metaclass__ = type
+
+"""
+The vyos ntp fact class
+It is in this file the configuration is collected from the device
+for a given resource, parsed, and the facts tree is populated
+based on the configuration.
+"""
+
+import re
+
+from ansible_collections.ansible.netcommon.plugins.module_utils.network.common import (
+    utils,
+)
+from ansible_collections.vyos.vyos.plugins.module_utils.network.vyos.rm_templates.ntp_global import (
+    NtpTemplate,
+)
+from ansible_collections.vyos.vyos.plugins.module_utils.network.vyos.argspec.ntp_global.ntp_global import (
+    Ntp_globalArgs,
+)
+
+
+class Ntp_globalFacts(object):
+    """The vyos ntp facts class"""
+
+    def __init__(self, module, subspec="config", options="options"):
+        self._module = module
+        self.argument_spec = Ntp_globalArgs.argument_spec
+
+    def get_config(self, connection):
+        return connection.get("show configuration commands | grep ntp")
+
+    def populate_facts(self, connection, ansible_facts, data=None):
+        """Populate the facts for Ntp network resource
+
+        :param connection: the device connection
+        :param ansible_facts: Facts dictionary
+        :param data: previously collected conf
+
+        :rtype: dictionary
+        :returns: facts
+        """
+        facts = {}
+        objs = []
+        config_lines = []
+
+        if not data:
+            data = self.get_config(connection)
+
+        for resource in data.splitlines():
+            config_lines.append(re.sub("'", "", resource))
+        # parse native config using the Ntp template
+        ntp_parser = NtpTemplate(lines=config_lines, module=self._module)
+
+        objs = ntp_parser.parse()
+
+        if objs:
+            if "allow_clients" in objs:
+                objs["allow_clients"] = sorted(list(objs["allow_clients"]))
+
+            if "listen_addresses" in objs:
+                objs["listen_addresses"] = sorted(
+                    list(objs["listen_addresses"])
+                )
+
+            """ if "options" in objs["servers"].values():
+                val = objs["servers"].values()
+                val["options"] = sorted(val["options"]) """
+
+            if "servers" in objs:
+                objs["servers"] = list(objs["servers"].values())
+                objs["servers"] = sorted(
+                    objs["servers"], key=lambda k: k["server"]
+                )
+                for i in objs["servers"]:
+                    if "options" in i:
+                        i["options"] = sorted(list(i["options"]))
+
+        ansible_facts["ansible_network_resources"].pop("ntp_global", None)
+
+        params = utils.remove_empties(
+            ntp_parser.validate_config(
+                self.argument_spec, {"config": objs}, redact=True
+            )
+        )
+
+        if params.get("config"):
+            facts["ntp_global"] = params["config"]
+        ansible_facts["ansible_network_resources"].update(facts)
+
+        return ansible_facts
diff --git a/plugins/module_utils/network/vyos/rm_templates/ntp_global.py b/plugins/module_utils/network/vyos/rm_templates/ntp_global.py
new file mode 100644
index 0000000..ac0bcbb
--- /dev/null
+++ b/plugins/module_utils/network/vyos/rm_templates/ntp_global.py
@@ -0,0 +1,129 @@
+# -*- coding: utf-8 -*-
+# Copyright 2021 Red Hat
+# GNU General Public License v3.0+
+# (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
+
+from __future__ import absolute_import, division, print_function
+
+__metaclass__ = type
+
+"""
+The Ntp parser templates file. This contains
+a list of parser definitions and associated functions that
+facilitates both facts gathering and native command generation for
+the given network resource.
+"""
+
+import re
+from ansible_collections.ansible.netcommon.plugins.module_utils.network.common.rm_base.network_template import (
+    NetworkTemplate,
+)
+
+
+class NtpTemplate(NetworkTemplate):
+    def __init__(self, lines=None, module=None):
+        prefix = {"set": "set", "remove": "delete"}
+        super(NtpTemplate, self).__init__(
+            lines=lines, tmplt=self, prefix=prefix, module=module
+        )
+
+    # fmt: off
+    PARSERS = [
+
+        # set system ntp allow_clients address <address>
+        {
+            "name": "allow_clients",
+            "getval": re.compile(
+                r"""
+                ^set\ssystem\sntp\sallow-clients\saddress (\s(?P<ipaddress>\S+))?
+                $""",
+                re.VERBOSE),
+            "setval": "system ntp allow-clients address {{allow_clients}}",
+            "result": {
+                "allow_clients": ["{{ipaddress}}"]
+            }
+        },
+
+        # set system ntp allow_clients
+        {
+            "name": "allow_clients_delete",
+            "getval": re.compile(
+                r"""
+                ^set\ssystem\sntp\sallow-clients
+                $""",
+                re.VERBOSE),
+            "setval": "system ntp allow-clients",
+            "result": {
+
+            }
+
+        },
+
+        # set system ntp listen_address <address>
+        {
+            "name": "listen_addresses",
+            "getval": re.compile(
+                r"""
+                ^set\ssystem\sntp\slisten-address (\s(?P<ip_address>\S+))?
+                $""",
+                re.VERBOSE),
+            "setval": "system ntp listen-address {{listen_addresses}}",
+            "result": {
+                "listen_addresses": ["{{ip_address}}"]
+            }
+        },
+
+        # set system ntp listen_address
+        {
+            "name": "listen_addresses_delete",
+            "getval": re.compile(
+                r"""
+                ^set\ssystem\sntp\slisten-address
+                $""",
+                re.VERBOSE),
+            "setval": "system ntp listen-address",
+            "result": {
+            }
+        },
+
+        # set system ntp server <name>
+        {
+            "name": "server",
+            "getval": re.compile(
+                r"""
+                ^set\ssystem\sntp\sserver (\s(?P<name>\S+))?
+                $""",
+                re.VERBOSE),
+            "setval": "system ntp server {{server}}",
+            "result": {
+                "servers": {
+                    "{{name}}": {
+                        "server": "{{name}}"
+                    }
+                }
+
+            }
+        },
+
+        # set system ntp server <name> <options>
+        {
+            "name": "options",
+            "getval": re.compile(
+                r"""
+                ^set\ssystem\sntp\sserver
+                \s(?P<name>\S+)
+                \s(?P<options>noselect|dynamic|preempt|prefer)?
+                $""",
+                re.VERBOSE),
+            "setval": "system ntp server {{server}} {{options}}",
+            "result": {
+                "servers": {
+                    "{{name}}": {
+                        "server": "{{name}}",
+                        "options": ["{{options}}"]
+                    }
+                }
+            }
+        }
+    ]
+    # fmt: on
diff --git a/plugins/modules/vyos_ntp_global.py b/plugins/modules/vyos_ntp_global.py
new file mode 100644
index 0000000..6686aa4
--- /dev/null
+++ b/plugins/modules/vyos_ntp_global.py
@@ -0,0 +1,812 @@
+#!/usr/bin/python
+# -*- coding: utf-8 -*-
+# Copyright 2021 Red Hat
+# GNU General Public License v3.0+
+# (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
+
+"""
+The module file for vyos_ntp_global
+"""
+
+from __future__ import absolute_import, division, print_function
+
+__metaclass__ = type
+
+
+DOCUMENTATION = """
+  module: vyos_ntp_global
+  version_added: 2.4.0
+  short_description:  Manages ntp modules of Vyos network devices
+  description:
+  - This module manages ntp configuration on devices running Vyos
+  author: Varshitha Yataluru (@YVarshitha)
+  notes:
+  - Tested against vyos 1.3
+  - This module works with connection C(network_cli).
+  options:
+    config:
+        description: List of configurations for ntp module
+        type: dict
+        suboptions:
+            allow_clients:
+                description: Network Time Protocol (NTP) server options
+                type: list
+                elements: str
+            listen_addresses:
+                description: local IP addresses for service to listen on
+                type: list
+                elements: str
+            servers:
+                description: Network Time Protocol (NTP) server
+                type: list
+                elements: dict
+                suboptions:
+                    server:
+                        description: server name for NTP
+                        type: str
+                    options:
+                        description: server options for NTP
+                        type: list
+                        elements: str
+                        choices:
+                            - noselect
+                            - dynamic
+                            - preempt
+                            - prefer
+    running_config:
+        description:
+        - This option is used only with state I(parsed).
+        - The value of this option should be the output received from the VYOS device by
+          executing the command B(show configuration commands | grep ntp).
+        - The states I(replaced) and I(overridden) have identical
+          behaviour for this module.
+        - The state I(parsed) reads the configuration from C(show configuration commands | grep ntp) option and
+          transforms it into Ansible structured data as per the resource module's argspec
+          and the value is then returned in the I(parsed) key within the result.
+        type: str
+    state:
+        description:
+         - The state the configuration should be left in.
+        type: str
+        choices:
+        - deleted
+        - merged
+        - overridden
+        - replaced
+        - gathered
+        - rendered
+        - parsed
+        default: merged
+"""
+EXAMPLES = """
+
+# # -------------------
+# # 1. Using merged
+# # -------------------
+
+# # Before state:
+# # -------------
+#   vyos@vyos:~$ show configuration commands | grep ntp
+#     set system ntp server time1.vyos.net
+#     set system ntp server time2.vyos.net
+#     set system ntp server time3.vyos.net
+#   vyos@vyos:~$
+
+# # Task
+# # -------------
+- name: Replace the existing ntp config with the new config
+  vyos.vyos.vyos_ntp_global:
+    config:
+        allow_clients:
+          - 10.6.6.0/24
+        listen_addresses:
+          - 10.1.3.1
+        servers:
+          - server: 203.0.113.0
+            options:
+                - prefer
+
+
+# # Task output:
+# # -------------
+#        "after": {
+#         "allow_clients": [
+#            "10.6.6.0/24"
+#        ],
+#        "listen_addresses": [
+#            "10.1.3.1"
+#        ],
+#        "servers": [
+#            {
+#                "server": "ser",
+#                "options": [
+#                    "prefer"
+#                ]
+#            },
+#            {
+#                "server": "time1.vyos.net"
+#            },
+#            {
+#                "server": "time2.vyos.net"
+#            },
+#            {
+#                "server": "time3.vyos.net"
+#            }
+#        ]
+#    },
+#    "before": {
+#    },
+#    "changed": true,
+#    "commands": [
+#        "set system ntp allow-clients address 10.6.6.0/24",
+#        "set system ntp listen-address 10.1.3.1",
+#        "set system ntp server 203.0.113.0 prefer"
+#    ]
+
+# After state:
+# # -------------
+#        vyos@vyos:~$ show configuration commands | grep ntp
+#        set system ntp allow-clients address '10.6.6.0/24'
+#        set system ntp listen-address '10.1.3.1'
+#        set system ntp server 203.0.113.0 prefer,
+#        set system ntp server time1.vyos.net
+#        set system ntp server time2.vyos.net
+#        set system ntp server time3.vyos.net
+#        vyos@vyos:~$
+
+
+# # -------------------
+# # 2. Using replaced
+# # -------------------
+
+# # Before state:
+# # -------------
+#    vyos@vyos:~$ show configuration commands | grep ntp
+#    set system ntp allow-clients address '10.4.9.0/24'
+#    set system ntp allow-clients address '10.4.7.0/24'
+#    set system ntp allow-clients address '10.1.2.0/24'
+#    set system ntp allow-clients address '10.2.3.0/24'
+#    set system ntp listen-address '10.1.9.16'
+#    set system ntp listen-address '10.5.3.2'
+#    set system ntp listen-address '10.7.9.21'
+#    set system ntp listen-address '10.8.9.4'
+#    set system ntp listen-address '10.4.5.1'
+#    set system ntp server 10.3.6.5 noselect
+#    set system ntp server 10.3.6.5 dynamic
+#    set system ntp server 10.3.6.5 preempt
+#    set system ntp server 10.3.6.5 prefer
+#    set system ntp server server4 noselect
+#    set system ntp server server4 dynamic
+#    set system ntp server server5
+#    set system ntp server time1.vyos.net
+#    set system ntp server time2.vyos.net
+#    set system ntp server time3.vyos.net
+#    vyos@vyos:~$
+
+# # Task
+# # -------------
+- name: Replace the existing ntp config with the new config
+  vyos.vyos.vyos_ntp_global:
+    config:
+        allow_clients:
+          - 10.6.6.0/24
+        listen_addresses:
+          - 10.1.3.1
+        servers:
+          - server: 203.0.113.0
+            options:
+                - prefer
+    state: replaced
+
+
+# # Task output:
+# # -------------
+#        "after": {
+#         "allow_clients": [
+#            "10.6.6.0/24"
+#        ],
+#        "listen_addresses": [
+#            "10.1.3.1"
+#        ],
+#        "servers": [
+#            {
+#                "server": "ser",
+#                "options": [
+#                    "prefer"
+#                ]
+#            },
+#            {
+#                "server": "time1.vyos.net"
+#            },
+#            {
+#                "server": "time2.vyos.net"
+#            },
+#            {
+#                "server": "time3.vyos.net"
+#            }
+#        ]
+#    },
+#    "before": {
+#        "allow_clients": [
+#            "10.4.7.0/24",
+#            "10.2.3.0/24",
+#            "10.1.2.0/24",
+#            "10.4.9.0/24"
+#        ],
+#        "listen_addresses": [
+#            "10.7.9.21",
+#            "10.4.5.1",
+#            "10.5.3.2",
+#            "10.8.9.4",
+#            "10.1.9.16"
+#        ],
+#        "servers": [
+#            {
+#                "server": "10.3.6.5",
+#                "options": [
+#                    "noselect",
+#                    "dynamic",
+#                    "preempt",
+#                    "prefer"
+#                ]
+#            },
+#            {
+#                "server": "server4",
+#                "options": [
+#                    "noselect",
+#                    "dynamic"
+#                ]
+#            },
+#            {
+#                "server": "server5"
+#            },
+#            {
+#                "server": "time1.vyos.net"
+#            },
+#            {
+#                "server": "time2.vyos.net"
+#            },
+#            {
+#                "server": "time3.vyos.net"
+#            }
+#        ]
+#    },
+#    "changed": true,
+#    "commands": [
+#        "delete system ntp allow-clients address 10.4.7.0/24",
+#        "delete system ntp allow-clients address 10.2.3.0/24",
+#        "delete system ntp allow-clients address 10.1.2.0/24",
+#        "delete system ntp allow-clients address 10.4.9.0/24",
+#        "delete system ntp listen-address 10.7.9.21",
+#        "delete system ntp listen-address 10.4.5.1",
+#        "delete system ntp listen-address 10.5.3.2",
+#        "delete system ntp listen-address 10.8.9.4",
+#        "delete system ntp listen-address 10.1.9.16",
+#        "delete system ntp server 10.3.6.5",
+#        "delete system ntp server server4",
+#        "delete system ntp server server5",
+#        "set system ntp allow-clients address 10.6.6.0/24",
+#        "set system ntp listen-address 10.1.3.1",
+#        "set system ntp server 203.0.113.0 prefer"
+#    ]
+
+# After state:
+# # -------------
+#        vyos@vyos:~$ show configuration commands | grep ntp
+#        set system ntp allow-clients address '10.6.6.0/24'
+#        set system ntp listen-address '10.1.3.1'
+#        set system ntp server 203.0.113.0 prefer,
+#        set system ntp server time1.vyos.net
+#        set system ntp server time2.vyos.net
+#        set system ntp server time3.vyos.net
+#        vyos@vyos:~$
+
+
+
+# # -------------------
+# # 3. Using overridden
+# # -------------------
+
+# # Before state:
+# # -------------
+#        vyos@vyos:~$ show configuration commands | grep ntp
+#        set system ntp allow-clients address '10.6.6.0/24'
+#        set system ntp listen-address '10.1.3.1'
+#        set system ntp server 203.0.113.0 prefer,
+#        set system ntp server time1.vyos.net
+#        set system ntp server time2.vyos.net
+#        set system ntp server time3.vyos.net
+#        vyos@vyos:~$
+
+# # Task
+# # -------------
+- name: Override ntp config
+  vyos.vyos.vyos_ntp_global:
+        config:
+          allow_clients:
+            - 10.3.3.0/24
+          listen_addresses:
+            - 10.7.8.1
+          servers:
+            - server: server1
+              options:
+                - dynamic
+                - prefer
+
+            - server: server2
+              options:
+                - noselect
+                - preempt
+
+            - server: serv
+        state: overridden
+
+
+
+# # Task output:
+# # -------------
+#            "after": {
+#                "allow_clients": [
+#                    "10.3.3.0/24"
+#                ],
+#                "listen_addresses": [
+#                    "10.7.8.1"
+#                ],
+#                "servers": [
+#                    {
+#                "server": "serv"
+#            },
+#            {
+#                "server": "server1",
+#                "options": [
+#                    "dynamic",
+#                    "prefer"
+#                ]
+#            },
+#            {
+#                "server": "server2",
+#                "options": [
+#                    "noselect",
+#                    "preempt"
+#                ]
+#            },
+#            {
+#                "server": "time1.vyos.net"
+#            },
+#            {
+#                "server": "time2.vyos.net"
+#            },
+#            {
+#                "server": "time3.vyos.net"
+#            }
+#                ]
+#            },
+#            "before": {
+#                "allow_clients": [
+#                    "10.6.6.0/24"
+#                ],
+#                "listen_addresses": [
+#                    "10.1.3.1"
+#                ],
+#                "servers": [
+#                    {
+#                        "server": "ser",
+#                        "options": [
+#                            "prefer"
+#                        ]
+#                    },
+#                    {
+#                        "server": "time1.vyos.net"
+#                    },
+#                    {
+#                        "server": "time2.vyos.net"
+#                    },
+#                    {
+#                        "server": "time3.vyos.net"
+#                    }
+#                ]
+#            },
+#            "changed": true,
+#            "commands": [
+#                "delete system ntp allow-clients address 10.6.6.0/24",
+#                "delete system ntp listen-address 10.1.3.1",
+#                "delete system ntp server ser",
+#                "set system ntp allow-clients address 10.3.3.0/24",
+#                "set system ntp listen-address 10.7.8.1",
+#                "set system ntp server server1 dynamic",
+#                "set system ntp server server1 prefer",
+#                "set system ntp server server2 noselect",
+#                "set system ntp server server2 preempt",
+#                "set system ntp server serv"
+#            ]
+
+# After state:
+# # -------------
+#        vyos@vyos:~$ show configuration commands | grep ntp
+#        set system ntp allow-clients address '10.3.3.0/24'
+#        set system ntp listen-address '10.7.8.1'
+#        set system ntp server serv
+#        set system ntp server server1 dynamic
+#        set system ntp server server1 prefer
+#        set system ntp server server2 noselect
+#        set system ntp server server2 preempt
+#        set system ntp server time1.vyos.net
+#        set system ntp server time2.vyos.net
+#        set system ntp server time3.vyos.net
+#        vyos@vyos:~$
+
+
+
+# # -------------------
+# # 4. Using gathered
+# # -------------------
+
+# # Before state:
+# # -------------
+#        vyos@vyos:~$ show configuration commands | grep ntp
+#        set system ntp allow-clients address '10.3.3.0/24'
+#        set system ntp listen-address '10.7.8.1'
+#        set system ntp server serv
+#        set system ntp server server1 dynamic
+#        set system ntp server server1 prefer
+#        set system ntp server server2 noselect
+#        set system ntp server server2 preempt
+#        set system ntp server time1.vyos.net
+#        set system ntp server time2.vyos.net
+#        set system ntp server time3.vyos.net
+#        vyos@vyos:~$
+
+# # Task
+# # -------------
+- name: Gather ntp config
+  vyos.vyos.vyos_ntp_global:
+        state: gathered
+
+# # Task output:
+# # -------------
+#        "gathered": {
+#                "allow_clients": [
+#                    "10.3.3.0/24"
+#                ],
+#                "listen_addresses": [
+#                    "10.7.8.1"
+#                ],
+#                "servers": [
+#                    {
+#                        "server": "serv"
+#                    },
+#                    {
+#                        "server": "server1",
+#                        "options": [
+#                            "dynamic",
+#                            "prefer"
+#                        ]
+#                    },
+#                    {
+#                         "server": "server2",
+#                         "options": [
+#                             "noselect",
+#                             "preempt"
+#                         ]
+#                     },
+#                     {
+#                          "server": "time1.vyos.net"
+#                     },
+#                     {
+#                         "server": "time2.vyos.net"
+#                     },
+#                     {
+#                         "server": "time3.vyos.net"
+#                     }
+#                ]
+#            }
+
+# After state:
+# # -------------
+#        vyos@vyos:~$ show configuration commands | grep ntp
+#        set system ntp allow-clients address '10.3.3.0/24'
+#        set system ntp listen-address '10.7.8.1'
+#        set system ntp server serv
+#        set system ntp server server1 dynamic
+#        set system ntp server server1 prefer
+#        set system ntp server server2 noselect
+#        set system ntp server server2 preempt
+#        set system ntp server time1.vyos.net
+#        set system ntp server time2.vyos.net
+#        set system ntp server time3.vyos.net
+#        vyos@vyos:~$
+
+
+# # -------------------
+# # 5. Using deleted
+# # -------------------
+
+# # Before state:
+# # -------------
+#        vyos@vyos:~$ show configuration commands | grep ntp
+#        set system ntp allow-clients address '10.3.3.0/24'
+#        set system ntp listen-address '10.7.8.1'
+#        set system ntp server serv
+#        set system ntp server server1 dynamic
+#        set system ntp server server1 prefer
+#        set system ntp server server2 noselect
+#        set system ntp server server2 preempt
+#        set system ntp server time1.vyos.net
+#        set system ntp server time2.vyos.net
+#        set system ntp server time3.vyos.net
+#        vyos@vyos:~$
+
+# # Task
+# # -------------
+- name: Delete ntp config
+  vyos.vyos.vyos_ntp_global:
+    state: deleted
+
+
+# # Task output:
+# # -------------
+#            "after": {
+#                "servers": [
+#                    {
+#                        "server": "time1.vyos.net"
+#                    },
+#                    {
+#                       "server": "time2.vyos.net"
+#                    },
+#                    {
+#                        "server": "time3.vyos.net"
+#                    }
+#                ]
+#            },
+#            "before": {
+#                "allow_clients": [
+#                    "10.3.3.0/24"
+#                ],
+#                "listen_addresses": [
+#                    "10.7.8.1"
+#                ],
+#                "servers": [
+#                    {
+#                        "server": "serv"
+#                    },
+#                    {
+#                        "server": "server1",
+#                        "options": [
+#                            "dynamic",
+#                            "prefer"
+#                        ]
+#                    },
+#                    {
+#                          "server": "server2",
+#                          "options": [
+#                              "noselect",
+#                              "preempt"
+#                          ]
+#                      },
+#                      {
+#                          "server": "time1.vyos.net"
+#                      },
+#                      {
+#                          "server": "time2.vyos.net"
+#                      },
+#                      {
+#                          "server": "time3.vyos.net"
+#                      }
+#                ]
+#            },
+#            "changed": true,
+#            "commands": [
+#                "delete system ntp allow-clients",
+#                "delete system ntp listen-address",
+#                "delete system ntp server serv",
+#                "delete system ntp server server1",
+#                "delete system ntp server server2"
+#
+#            ]
+
+# After state:
+# # -------------
+#        vyos@vyos:~$ show configuration commands | grep ntp
+#        set system ntp server time1.vyos.net
+#        set system ntp server time2.vyos.net
+#        set system ntp server time3.vyos.net
+#        vyos@vyos:~$
+
+
+# # -------------------
+# # 6. Using rendered
+# # -------------------
+
+# # Before state:
+# # -------------
+#        vyos@vyos:~$ show configuration commands | grep ntp
+#        set system ntp server time1.vyos.net
+#        set system ntp server time2.vyos.net
+#        set system ntp server time3.vyos.net
+#        vyos@vyos:~$
+
+# # Task
+# # -------------
+- name: Gather ntp config
+  vyos.vyos.vyos_ntp_global:
+       config:
+        allow_clients:
+            - 10.7.7.0/24
+            - 10.8.8.0/24
+        listen_addresses:
+            - 10.7.9.1
+        servers:
+            - server: server7
+
+            - server: server45
+              options:
+                - noselect
+                - prefer
+            - server: time1.vyos.net
+
+            - server: time2.vyos.net
+
+            - server: time3.vyos.net
+
+        state: rendered
+
+
+# # Task output:
+# # -------------
+#           "rendered": [
+#                "set system ntp allow-clients address 10.7.7.0/24",
+#                "set system ntp allow-clients address 10.8.8.0/24",
+#                "set system ntp listen-address 10.7.9.1",
+#                "set system ntp server server7",
+#                "set system ntp server server45 noselect",
+#                "set system ntp server server45 prefer",
+#                "set system ntp server time1.vyos.net",
+#                "set system ntp server time2.vyos.net",
+#                "set system ntp server time3.vyos.net"
+#            ]
+
+
+# # -------------------
+# # 7. Using parsed
+# # -------------------
+
+# # sample_config.cfg:
+# # -------------
+#           "set system ntp allow-clients address 10.7.7.0/24",
+#           "set system ntp listen-address 10.7.9.1",
+#           "set system ntp server server45 noselect",
+#           "set system ntp allow-clients addres 10.8.6.0/24",
+#           "set system ntp listen-address 10.5.4.1",
+#           "set system ntp server server45 dynamic",
+#           "set system ntp server time1.vyos.net",
+#           "set system ntp server time2.vyos.net",
+#           "set system ntp server time3.vyos.net"
+
+# # Task:
+# # -------------
+- name: Parse externally provided ntp configuration
+  vyos.vyos.vyos_ntp_global:
+     running_config: "{{ lookup('file', './sample_config.cfg') }}"
+     state: parsed
+
+# # Task output:
+# # -------------
+#           parsed = {
+#                "allow_clients": [
+#                    "10.7.7.0/24",
+#                    "10.8.6.0/24
+#                ],
+#                "listen_addresses": [
+#                    "10.5.4.1",
+#                    "10.7.9.1"
+#                ],
+#                "servers": [
+#                    {
+#                        "server": "server45",
+#                        "options": [
+#                            "noselect",
+#                            "dynamic"
+#
+#                        ]
+#                    },
+#                    {
+#                        "server": "time1.vyos.net"
+#                    },
+#                    {
+#                        "server": "time2.vyos.net"
+#                    },
+#                    {
+#                        "server": "time3.vyos.net"
+#                    }
+#
+#                ]
+#            }
+
+"""
+RETURN = """
+before:
+  description: The configuration prior to the module execution.
+  returned: when I(state) is C(merged), C(replaced), C(overridden), C(deleted) or C(purged)
+  type: dict
+  sample: >
+    This output will always be in the same format as the
+    module argspec.
+after:
+  description: The resulting configuration after module execution.
+  returned: when changed
+  type: dict
+  sample: >
+    This output will always be in the same format as the
+    module argspec.
+commands:
+  description: The set of commands pushed to the remote device.
+  returned: when I(state) is C(merged), C(replaced), C(overridden), C(deleted) or C(purged)
+  type: list
+  sample:
+    - set system ntp server server1 dynamic
+    - set system ntp server server1 prefer
+    - set system ntp server server2 noselect
+    - set system ntp server server2 preempt
+    - set system ntp server server_add preempt
+rendered:
+  description: The provided configuration in the task rendered in device-native format (offline).
+  returned: when I(state) is C(rendered)
+  type: list
+  sample:
+    - set system ntp server server1 dynamic
+    - set system ntp server server1 prefer
+    - set system ntp server server2 noselect
+    - set system ntp server server2 preempt
+    - set system ntp server server_add preempt
+
+gathered:
+  description: Facts about the network resource gathered from the remote device as structured data.
+  returned: when I(state) is C(gathered)
+  type: list
+  sample: >
+    This output will always be in the same format as the
+    module argspec.
+parsed:
+  description: The device native config provided in I(running_config) option parsed into structured data as per module argspec.
+  returned: when I(state) is C(parsed)
+  type: list
+  sample: >
+    This output will always be in the same format as the
+    module argspec.
+"""
+
+
+from ansible.module_utils.basic import AnsibleModule
+from ansible_collections.vyos.vyos.plugins.module_utils.network.vyos.argspec.ntp_global.ntp_global import (
+    Ntp_globalArgs,
+)
+from ansible_collections.vyos.vyos.plugins.module_utils.network.vyos.config.ntp_global.ntp_global import (
+    Ntp_global,
+)
+
+
+def main():
+    """
+    Main entry point for module execution
+
+    :returns: the result form module invocation
+    """
+    module = AnsibleModule(
+        argument_spec=Ntp_globalArgs.argument_spec,
+        mutually_exclusive=[["config", "running_config"]],
+        required_if=[
+            ["state", "merged", ["config"]],
+            ["state", "replaced", ["config"]],
+            ["state", "overridden", ["config"]],
+            ["state", "rendered", ["config"]],
+            ["state", "parsed", ["running_config"]],
+        ],
+        supports_check_mode=True,
+    )
+
+    result = Ntp_global(module).execute_module()
+    module.exit_json(**result)
+
+
+if __name__ == "__main__":
+    main()