[ignore] Moved get_site_interface_details from utils to mso.py and updated ndo_fabric_span_session task names

Author: sajagana

plugins/module_utils/mso.py

@@ -1666,6 +1666,28 @@ def verify_time_format(self, date_time):
             except ValueError:
                 return self.fail_json(msg="ERROR: The time must be in 'YYYY-MM-DD HH:MM:SS' format.")
 
+    def get_site_interface_details(self, site_id=None, uuid=None, node=None, port=None):
+        if node and port:
+            path = "/sitephysifsummary/site/{0}?node={1}".format(site_id, node)
+        elif uuid:
+            path = "/sitephysifsummary/site/{0}?uuid={1}".format(site_id, uuid)
+
+        site_data = self.request(path, method="GET")
+
+        if uuid:
+            if site_data.get("spec", {}).get("monitoringTemplateInterfaces"):
+                return site_data.get("spec", {}).get("monitoringTemplateInterfaces", [])[0]
+            else:
+                self.fail_json(msg="The site port interface not found. Site ID: {0} and UUID: {1}".format(site_id, uuid))
+        elif node and port:
+            for interface in site_data.get("spec", {}).get("interfaces", []):
+                # To ensure consistency between the API response data and the input data by converting the node to a string
+                if interface.get("port") == port and str(interface.get("node")) == str(node):
+                    return interface
+            self.fail_json(msg="The site port interface not found. Site ID: {0}, Node: {1} and Path: {2}".format(site_id, node, port))
+
+        return {}
+
 
 def service_node_ref_str_to_dict(serviceNodeRefStr):
     serviceNodeRefTokens = serviceNodeRefStr.split("/")

plugins/module_utils/schemas.py

@@ -31,3 +31,22 @@ def get_template_from_schema(self, schema_name, schema_id, template_name, templa
         self.schemas_by_id[new_schema.id] = new_schema
         self.schemas_by_name[new_schema.schema_name] = new_schema
         return new_schema
+
+    def get_epg_uuid(self, epg_obj, epg_uuid):
+        """
+        Returns the EPG UUID in a given schema, template and ANP.
+        :param epg_obj: A dictionary containing the epg reference object. -> Dict
+        :param epg_uuid: The EPG UUID to return if specified. -> Str
+        :return: The EPG UUID if found, otherwise it fails the module. -> Str
+        """
+        if epg_uuid:
+            return epg_uuid
+        schema = self.get_template_from_schema(
+            epg_obj.get("schema"),
+            epg_obj.get("schema_id"),
+            epg_obj.get("template"),
+            epg_obj.get("template_id"),
+        )
+        schema.set_template_anp(epg_obj.get("anp"), epg_obj.get("anp_uuid"), fail_module=True)
+        schema.set_template_anp_epg(epg_obj.get("name"), fail_module=True)
+        return schema.schema_objects.get("template_anp_epg").details.get("uuid")

plugins/module_utils/utils.py

@@ -164,47 +164,3 @@ def snake_to_camel(snake_str, upper_case_components=None):
         return camel_case_str
     else:
         return snake_str
-
-
-def get_epg_uuid(schemas, epg_obj, epg_uuid):
-    """
-    Returns the EPG UUID in a given schema, template and ANP.
-    :param schemas: The mso schemas object. -> MSOSchemas
-    :param epg_obj: A dictionary containing the epg reference object. -> Dict
-    :param epg_uuid: The EPG UUID to return if specified. -> Str
-    :return: The EPG UUID if found, otherwise it fails the module. -> Str
-    """
-    if epg_uuid:
-        return epg_uuid
-    schema = schemas.get_template_from_schema(
-        epg_obj.get("schema"),
-        epg_obj.get("schema_id"),
-        epg_obj.get("template"),
-        epg_obj.get("template_id"),
-    )
-    schema.set_template_anp(epg_obj.get("anp"), epg_obj.get("anp_uuid"), fail_module=True)
-    schema.set_template_anp_epg(epg_obj.get("name"), fail_module=True)
-    return schema.schema_objects.get("template_anp_epg").details.get("uuid")
-
-
-def get_site_interface_details(mso, site_id=None, uuid=None, node=None, port=None):
-    if node and port:
-        path = "/sitephysifsummary/site/{0}?node={1}".format(site_id, node)
-    elif uuid:
-        path = "/sitephysifsummary/site/{0}?uuid={1}".format(site_id, uuid)
-
-    site_data = mso.request(path, method="GET")
-
-    if uuid:
-        if site_data.get("spec", {}).get("monitoringTemplateInterfaces"):
-            return site_data.get("spec", {}).get("monitoringTemplateInterfaces", [])[0]
-        else:
-            mso.fail_json(msg="The site port interface not found. Site ID: {0} and UUID: {1}".format(site_id, uuid))
-    elif node and port:
-        for interface in site_data.get("spec", {}).get("interfaces", []):
-            # To ensure consistency between the API response data and the input data by converting the node to a string
-            if interface.get("port") == port and str(interface.get("node")) == str(node):
-                return interface
-        mso.fail_json(msg="The site port interface not found. Site ID: {0}, Node: {1} and Path: {2}".format(site_id, node, port))
-
-    return {}

plugins/modules/ndo_fabric_span_session.py

@@ -228,7 +228,7 @@
             type: str
           template_id:
             description:
-            - The ID of the  that contains the destination port channel.
+            - The ID of the template that contains the destination port channel.
             - This parameter or O(destination_port_channel.port_channel.template) is required.
             type: str
   state:
@@ -408,7 +408,7 @@
 from ansible_collections.cisco.mso.plugins.module_utils.templates import MSOTemplates
 from ansible_collections.cisco.mso.plugins.module_utils.template import MSOTemplate, KVPair
 from ansible_collections.cisco.mso.plugins.module_utils.constants import TARGET_DSCP_MAP, ENABLED_OR_DISABLED_TO_BOOL_STRING_MAP
-from ansible_collections.cisco.mso.plugins.module_utils.utils import append_update_ops_data, get_site_interface_details, get_epg_uuid
+from ansible_collections.cisco.mso.plugins.module_utils.utils import append_update_ops_data
 import copy
 
 
@@ -521,7 +521,7 @@ def main():
 
     mso_template = MSOTemplate(mso, "monitoring_tenant", template_name, template_id)
     mso_template.validate_template("monitoring")
-    object_description = "SPAN Session "
+    object_description = "SPAN Session"
     site_id = mso_template.template.get("monitoringTemplate").get("sites")[0].get("siteId")
 
     match = None
@@ -553,7 +553,7 @@ def main():
         if destination_epg:
             mso_values["destination"] = dict(
                 remote=dict(
-                    epgRef=get_epg_uuid(mso_schemas, destination_epg.get("epg"), destination_epg.get("epg_uuid")),
+                    epgRef=mso_schemas.get_epg_uuid(destination_epg.get("epg"), destination_epg.get("epg_uuid")),
                     spanVersion=destination_epg.get("span_version"),
                     enforceSpanVersion=destination_epg.get("enforce_span_version"),
                     destIPAddress=destination_epg.get("destination_ip"),
@@ -572,7 +572,7 @@ def main():
             if destination_port_uuid is None:
                 node = destination_port.get("port").get("node")
                 interface_port = destination_port.get("port").get("path")
-                destination_port_uuid = get_site_interface_details(mso, site_id=site_id, uuid=None, node=node, port=interface_port).get("uuid")
+                destination_port_uuid = mso.get_site_interface_details(site_id=site_id, uuid=None, node=node, port=interface_port).get("uuid")
             mso_values["destination"] = dict(local=dict(accessInterface=destination_port_uuid), mtu=mtu)
 
         if destination_port_channel:
@@ -671,7 +671,7 @@ def set_fabric_span_session_object_details(mso_template, site_id, span_session):
     if span_session:
         span_session.update({"templateId": mso_template.template_id, "templateName": mso_template.template_name})
         if span_session.get("destination", {}).get("local", {}).get("accessInterface"):
-            interface = get_site_interface_details(mso_template.mso, site_id, span_session.get("destination").get("local").get("accessInterface"))
+            interface = mso_template.mso.get_site_interface_details(site_id, span_session.get("destination").get("local").get("accessInterface"))
             interface.pop("uuid", None)
             span_session.get("destination").get("local").update(interface)
         else: