Add vrf_global resource module (#1055)

* Add vrf_global resource module - parsed state & gathered state working

* separate ios_vrf_af from vrf_global

* remove unwanted files

* merged state working

* add states & integration tests

* updated argspec

* updated code

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Update vrf_global.py

* complete work

* some review comments

* some review comments

* CI test failures

* remove unused import

* review changes

* use config module to reset the config

* some changes

* fix some typos

* review changes

* pre-commit run

* changes

* add review changes

* doc changes

* some updates related to doc

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Vinay M <[email protected]>

README.md

@@ -71,6 +71,7 @@ Name | Description
 [cisco.ios.ios_user](https://github.com/ansible-collections/cisco.ios/blob/main/docs/cisco.ios.ios_user_module.rst)|Module to manage the aggregates of local users.
 [cisco.ios.ios_vlans](https://github.com/ansible-collections/cisco.ios/blob/main/docs/cisco.ios.ios_vlans_module.rst)|Resource module to configure VLANs.
 [cisco.ios.ios_vrf](https://github.com/ansible-collections/cisco.ios/blob/main/docs/cisco.ios.ios_vrf_module.rst)|Module to configure VRF definitions.
+[cisco.ios.ios_vrf_global](https://github.com/ansible-collections/cisco.ios/blob/main/docs/cisco.ios.ios_vrf_global_module.rst)|Resource module to configure global VRF definitions.
 [cisco.ios.ios_vxlan_vtep](https://github.com/ansible-collections/cisco.ios/blob/main/docs/cisco.ios.ios_vxlan_vtep_module.rst)|Resource module to configure VXLAN VTEP interface.
 
 <!--end collection content-->

changelogs/fragments/1055_add_vrf_global_module.yaml

@@ -0,0 +1,3 @@
+---
+minor_changes:
+  - Add ios_vrf_global resource module in favor of ios_vrf module (fixes - https://github.com/ansible-collections/cisco.ios/pull/1055)

meta/runtime.yml

@@ -83,4 +83,6 @@ plugin_routing:
       redirect: cisco.ios.ios_vrf
     vxlan_vtep:
       redirect: cisco.ios.ios_vxlan_vtep
+    vrf_global:
+      redirect: cisco.ios.ios_vrf_global
 requires_ansible: ">=2.15.0"

plugins/action/vrf_global.py

@@ -0,0 +1 @@
+ios.py

plugins/module_utils/network/ios/argspec/vrf_global/vrf_global.py

@@ -0,0 +1,99 @@
+# -*- coding: utf-8 -*-
+# Copyright 2024 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
+# ansible.content_builder.
+#
+# Manually editing this file is not advised.
+#
+# To update the argspec make the desired changes
+# in the documentation in the module file and re-run
+# ansible.content_builder commenting out
+# the path to external 'docstring' in build.yaml.
+#
+##############################################
+
+"""
+The arg spec for the ios_vrf_global module
+"""
+
+
+class Vrf_globalArgs(object):  # pylint: disable=R0903
+    """The arg spec for the ios_vrf_global module"""
+
+    argument_spec = {
+        "config": {
+            "type": "dict",
+            "options": {
+                "vrfs": {
+                    "type": "list",
+                    "elements": "dict",
+                    "options": {
+                        "name": {"type": "str", "required": True},
+                        "description": {"type": "str"},
+                        "ipv4": {
+                            "type": "dict",
+                            "options": {
+                                "multicast": {
+                                    "type": "dict",
+                                    "options": {"multitopology": {"type": "bool"}},
+                                },
+                            },
+                        },
+                        "ipv6": {
+                            "type": "dict",
+                            "options": {
+                                "multicast": {
+                                    "type": "dict",
+                                    "options": {"multitopology": {"type": "bool"}},
+                                },
+                            },
+                        },
+                        "rd": {"type": "str"},
+                        "route_target": {
+                            "type": "dict",
+                            "options": {
+                                "export": {"type": "str"},
+                                "import_config": {"type": "str"},
+                                "both": {"type": "str"},
+                            },
+                        },
+                        "vnet": {
+                            "type": "dict",
+                            "options": {"tag": {"type": "int"}},
+                        },
+                        "vpn": {
+                            "type": "dict",
+                            "options": {"id": {"type": "str"}},
+                        },
+                    },
+                },
+            },
+        },
+        "running_config": {"type": "str"},
+        "state": {
+            "choices": [
+                "parsed",
+                "gathered",
+                "deleted",
+                "merged",
+                "replaced",
+                "rendered",
+                "overridden",
+                "purged",
+            ],
+            "default": "merged",
+            "type": "str",
+        },
+    }  # pylint: disable=C0301

plugins/module_utils/network/ios/config/vrf_global/vrf_global.py

@@ -0,0 +1,117 @@
+# -*- coding: utf-8 -*-
+# Copyright 2024 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 ios_vrf_global 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.rm_base.resource_module import (
+    ResourceModule,
+)
+from ansible_collections.ansible.netcommon.plugins.module_utils.network.common.utils import (
+    dict_merge,
+)
+
+from ansible_collections.cisco.ios.plugins.module_utils.network.ios.facts.facts import Facts
+from ansible_collections.cisco.ios.plugins.module_utils.network.ios.rm_templates.vrf_global import (
+    Vrf_globalTemplate,
+)
+
+
+class Vrf_global(ResourceModule):
+    """
+    The ios_vrf_global config class
+    """
+
+    def __init__(self, module):
+        super(Vrf_global, self).__init__(
+            empty_fact_val={},
+            facts_module=Facts(module),
+            module=module,
+            resource="vrf_global",
+            tmplt=Vrf_globalTemplate(),
+        )
+        self.parsers = [
+            "description",
+            "ipv4.multicast.multitopology",
+            "ipv6.multicast.multitopology",
+            "rd",
+            "route_target.export",
+            "route_target.import_config",
+            "route_target.both",
+            "vnet.tag",
+            "vpn.id",
+        ]
+
+    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.
+        """
+        haved, wantd = dict(), dict()
+
+        if self.want:
+            for entry in self.want.get("vrfs", []):
+                wantd.update({(entry["name"]): entry})
+
+        if self.have:
+            for entry in self.have.get("vrfs", []):
+                haved.update({(entry["name"]): entry})
+
+        # if state is merged, merge want onto have
+        if self.state == "merged":
+            wantd = dict_merge(haved, wantd)
+
+        # if state is deleted, limit the have to anything in want & set want to nothing
+        if self.state == "deleted":
+            haved = {k: v for k, v in iteritems(haved) if k in wantd or not wantd}
+            wantd = {}
+
+        if self.state in ["overridden", "deleted"]:
+            for k, have in iteritems(haved):
+                if k not in wantd:
+                    self._compare(want={}, have=have)
+
+        if self.state == "purged":
+            for k, have in iteritems(haved):
+                self.purge(have)
+
+        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 Vrf_global network resource.
+        """
+        if want != have:
+            self.addcmd(want or have, "name", False)
+            self.compare(self.parsers, want, have)
+
+    def purge(self, have):
+        """Purge the VRF configuration"""
+        self.commands.append("no vrf definition {0}".format(have["name"]))

plugins/module_utils/network/ios/facts/facts.py

@@ -99,6 +99,9 @@
 from ansible_collections.cisco.ios.plugins.module_utils.network.ios.facts.vlans.vlans import (
     VlansFacts,
 )
+from ansible_collections.cisco.ios.plugins.module_utils.network.ios.facts.vrf_global.vrf_global import (
+    Vrf_globalFacts,
+)
 from ansible_collections.cisco.ios.plugins.module_utils.network.ios.facts.vxlan_vtep.vxlan_vtep import (
     Vxlan_vtepFacts,
 )
@@ -139,6 +142,7 @@
     vxlan_vtep=Vxlan_vtepFacts,
     evpn_global=Evpn_globalFacts,
     evpn_evi=Evpn_eviFacts,
+    vrf_global=Vrf_globalFacts,
 )
 
 

plugins/module_utils/network/ios/facts/vrf_global/vrf_global.py

@@ -0,0 +1,72 @@
+# -*- coding: utf-8 -*-
+# Copyright 2024 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 ios vrf_global 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.
+"""
+
+
+from ansible_collections.ansible.netcommon.plugins.module_utils.network.common import utils
+
+from ansible_collections.cisco.ios.plugins.module_utils.network.ios.argspec.vrf_global.vrf_global import (
+    Vrf_globalArgs,
+)
+from ansible_collections.cisco.ios.plugins.module_utils.network.ios.rm_templates.vrf_global import (
+    Vrf_globalTemplate,
+)
+
+
+class Vrf_globalFacts(object):
+    """The ios vrf_global facts class"""
+
+    def __init__(self, module, subspec="config", options="options"):
+        self._module = module
+        self.argument_spec = Vrf_globalArgs.argument_spec
+
+    def get_config(self, connection):
+        """Get the configuration from the device"""
+
+        return connection.get("show running-config | section ^vrf")
+
+    def populate_facts(self, connection, ansible_facts, data=None):
+        """Populate the facts for Vrf_global network resource
+
+        :param connection: the device connection
+        :param ansible_facts: Facts dictionary
+        :param data: previously collected conf
+
+        :rtype: dictionary
+        :returns: facts
+        """
+
+        facts = {}
+        objs = []
+
+        if not data:
+            data = self.get_config(connection)
+
+        vrf_global_parser = Vrf_globalTemplate(lines=data.splitlines(), module=self._module)
+        objs = vrf_global_parser.parse()
+
+        # Convert the dictionary to a list of dictionaries
+        objs["vrfs"] = list(objs["vrfs"].values()) if "vrfs" in objs else []
+
+        ansible_facts["ansible_network_resources"].pop("vrf_global", None)
+        params = utils.remove_empties(
+            vrf_global_parser.validate_config(self.argument_spec, {"config": objs}, redact=True),
+        )
+
+        facts["vrf_global"] = params.get("config", {})
+        ansible_facts["ansible_network_resources"].update(facts)
+
+        return ansible_facts