[ignore_changes] Rebasing with latest master.

Author: anvitha-jain

plugins/module_utils/template.py

@@ -429,6 +429,7 @@ def update_config_with_template_and_references(self, config_data, reference_coll
     def check_template_when_name_is_provided(self, parameter):
         if parameter and parameter.get("name") and not (parameter.get("template") or parameter.get("template_id")):
             self.mso.fail_json(msg="Either 'template' or 'template_id' associated with '{}' must be provided".format(parameter.get("name")))
+
     def get_route_map_policy_for_multicast_uuid(self, route_map_policy_for_multicast_name):
         """
         Get the UUID of an Route Map Policy for Multicast by name.

plugins/module_utils/utils.py

@@ -71,7 +71,7 @@ def append_update_ops_data(ops, existing_data, update_path, replace_data=None, r
         "description": "new_description",
         "ospfIntfPol": {
             "ifControl": {
-                "adminState": "disbaled",
+                "adminState": "disabled",
             },
             "cost": 0,
         },
@@ -146,18 +146,3 @@ def check_if_all_elements_are_none(values):
     :return: True if all elements are None, False otherwise. -> bool
     """
     return all(value is None for value in values)
-
-
-def get_template_object_name_by_uuid(mso, object_type, uuid):
-    """
-    Retrieve the name of a specific object type in the MSO template using its UUID.
-    :param mso: An instance of the MSO class, which provides methods for making API requests -> MSO Class instance
-    :param object_type: The type of the object to retrieve the name for -> Str
-    :param uuid: The UUID of the object to retrieve the name for -> Str
-    :return: Str | None: The processed result which could be:
-          When the UUID is existing, returns object name -> Str
-          When the UUID is not existing -> None
-    """
-    response_object = mso.request("templates/objects?type={0}&uuid={1}".format(object_type, uuid), "GET")
-    if response_object:
-        return response_object.get("name")

plugins/modules/ndo_tenant_igmp_interface_policy.py

@@ -24,12 +24,14 @@
   template:
     description:
     - The name of the tenant template.
+    - This parameter or O(template_id) is required.
     type: str
     aliases: [ tenant_template ]
     required: true
   template_id:
     description:
     - The ID of the L3Out template.
+    - This parameter or O(template) is required.
     type: str
     aliases: [ l3out_template_id ]
   name:
@@ -42,6 +44,7 @@
     - The UUID of the IGMP Interface Policy.
     - This parameter is required when the IGMP Interface Policy O(name) needs to be updated.
     type: str
+    aliases: [ igmp_interface_policy_uuid ]
   description:
     description:
     - The description of the IGMP Interface Policy.
@@ -236,8 +239,8 @@
     startup_query_interval: 31
     querier_timeout: 255
     robustness_variable: 2
-    state_limit_route_map_uuid: route_map_policy_for_multicast_uuid
-    report_policy_route_map_uuid: route_map_policy_for_multicast_uuid
+    state_limit_route_map_uuid: "2be2b2e6-727d-4534-9d09-4abc36ed0194"
+    report_policy_route_map_uuid: "{{ route_map_policy_for_multicast.current.uuid }}"
     static_report_route_map:
       name: TestStaticReportRouteMap
     maximum_multicast_entries: 4294967295
@@ -315,7 +318,6 @@
 from ansible_collections.cisco.mso.plugins.module_utils.utils import (
     append_update_ops_data,
     check_if_all_elements_are_none,
-    get_template_object_name_by_uuid,
 )
 
 
@@ -325,7 +327,7 @@ def main():
         template=dict(type="str", required=True, aliases=["tenant_template"]),
         template_id=dict(type="str", aliases=["l3out_template_id"]),
         name=dict(type="str", aliases=["igmp_interface_policy"]),
-        uuid=dict(type="str"),
+        uuid=dict(type="str", aliases=["igmp_interface_policy_uuid"]),
         description=dict(type="str"),
         version3_asm=dict(type="str", aliases=["allow_version3_asm"], choices=["enabled", "disabled"]),
         fast_leave=dict(type="str", choices=["enabled", "disabled"]),
@@ -373,9 +375,6 @@ def main():
         argument_spec=argument_spec,
         supports_check_mode=True,
         required_if=[
-            ["state", "present", ["template", "template_id"], True],
-            ["state", "query", ["template", "template_id"], True],
-            ["state", "absent", ["template", "template_id"], True],
             ["state", "absent", ["name", "uuid"], True],
             ["state", "present", ["name", "uuid"], True],
         ],
@@ -385,6 +384,9 @@ def main():
             ["report_policy_route_map_uuid", "report_policy_route_map"],
             ["static_report_route_map_uuid", "static_report_route_map"],
         ],
+        required_one_of=[
+            ["template", "template_id"],
+        ],
     )
 
     mso = MSOModule(module)
@@ -428,19 +430,26 @@ def main():
     object_description = "IGMP Interface Policy"
     path = "/tenantPolicyTemplate/template/igmpInterfacePolicies"
 
+    reference_dict = {
+        "stateLimitRouteMap": {"name": "stateLimitRouteMapName", "reference": "stateLimitRouteMapRef", "type": "mcastRouteMap"},
+        "reportPolicyRouteMap": {"name": "reportPolicyRouteMapName", "reference": "reportPolicyRouteMapRef", "type": "mcastRouteMap"},
+        "staticReportRouteMap": {"name": "staticReportRouteMapName", "reference": "staticReportRouteMapRef", "type": "mcastRouteMap"},
+    }
+
     if uuid or name:
         match = mso_template.get_object_by_key_value_pairs(
             object_description,
             existing_igmp_interface_policies,
             [KVPair("uuid", uuid) if uuid else KVPair("name", name)],
         )
         if match:
-            igmp_interface_policy_attrs_path = "{0}/{1}".format(path, match.index)
-            set_names_for_references(mso, match.details)
+            mso_template.update_config_with_template_and_references(match.details, reference_dict)
             mso.existing = mso.previous = copy.deepcopy(match.details)
     else:
-        mso.existing = mso.previous = [set_names_for_references(mso, igmp_interface_policy) for igmp_interface_policy in existing_igmp_interface_policies]
-        # existing_igmp_interface_policies
+        mso.existing = mso.previous = [
+            mso_template.update_config_with_template_and_references(igmp_interface_policy, reference_dict)
+            for igmp_interface_policy in existing_igmp_interface_policies
+        ]
 
     if state == "present":
         if uuid and not mso.existing:
@@ -494,7 +503,6 @@ def main():
             if (static_report_route_map_uuid == "" or empty_static_report_route_map) and match.details.get("staticReportRouteMapRef"):
                 mso_values_remove.append("staticReportRouteMapRef")
 
-        if mso.existing:
             append_update_ops_data(ops, match.details, "{0}/{1}".format(path, match.index), mso_values, mso_values_remove)
             mso.sanitize(match.details, collate=True)
         else:
@@ -512,27 +520,16 @@ def main():
             object_description, existing_igmp_interface_policies, [KVPair("uuid", uuid) if uuid else KVPair("name", name)]
         )
         if match:
-            set_names_for_references(mso, match.details)
+            mso_template.update_config_with_template_and_references(match.details, reference_dict)
             mso.existing = match.details  # When the state is present
         else:
             mso.existing = {}  # When the state is absent
     elif module.check_mode and state != "query":  # When the state is present/absent with check mode
-        set_names_for_references(mso, mso.proposed)
+        mso_template.update_config_with_template_and_references(mso.proposed, reference_dict)
         mso.existing = mso.proposed if state == "present" else {}
 
     mso.exit_json()
 
 
-def set_names_for_references(mso, route_map_dict):
-    if route_map_dict.get("stateLimitRouteMapRef"):
-        route_map_dict["stateLimitRouteMapName"] = get_template_object_name_by_uuid(mso, "mcastRouteMap", route_map_dict.get("stateLimitRouteMapRef"))
-    if route_map_dict.get("reportPolicyRouteMapRef"):
-        route_map_dict["reportPolicyRouteMapName"] = get_template_object_name_by_uuid(mso, "mcastRouteMap", route_map_dict.get("reportPolicyRouteMapRef"))
-    if route_map_dict.get("staticReportRouteMapRef"):
-        route_map_dict["staticReportRouteMapName"] = get_template_object_name_by_uuid(mso, "mcastRouteMap", route_map_dict.get("staticReportRouteMapRef"))
-
-    return route_map_dict
-
-
 if __name__ == "__main__":
     main()

tests/integration/targets/ndo_tenant_igmp_interface_policy/tasks/main.yml

@@ -130,10 +130,13 @@
         that:
           - cm_create_new_igmp_interface_policy is changed
           - cm_create_new_igmp_interface_policy.previous == {}
-          - nm_create_new_igmp_interface_policy.current.name == 'ansible_igmp_interface_policy'
+          - cm_create_new_igmp_interface_policy.current.name == 'ansible_igmp_interface_policy'
+          - cm_create_new_igmp_interface_policy.current.templateName == 'ansible_tenant_template'
           - nm_create_new_igmp_interface_policy is changed
           - nm_create_new_igmp_interface_policy.previous == {}
           - nm_create_new_igmp_interface_policy.current.name == 'ansible_igmp_interface_policy'
+          - nm_create_new_igmp_interface_policy.current.templateName == 'ansible_tenant_template'
+          - cm_create_new_igmp_interface_policy.current.templateId == nm_create_new_igmp_interface_policy.current.templateId
           - nm_create_new_igmp_interface_policy.current.uuid is defined
           - nm_create_new_igmp_interface_policy.current.description == ""
           - nm_create_new_igmp_interface_policy.current.enableFastLeaveControl == false
@@ -156,6 +159,8 @@
           - nm_create_new_igmp_interface_policy.current.staticReportRouteMapRef == ""
           - nm_create_new_igmp_interface_policy_again is not changed
           - nm_create_new_igmp_interface_policy_again.previous.name == nm_create_new_igmp_interface_policy_again.current.name == 'ansible_igmp_interface_policy'
+          - nm_create_new_igmp_interface_policy_again.previous.templateName == nm_create_new_igmp_interface_policy_again.current.templateName == 'ansible_tenant_template'
+          - nm_create_new_igmp_interface_policy_again.previous.templateId == nm_create_new_igmp_interface_policy_again.current.templateId
           - nm_create_new_igmp_interface_policy_again.previous.description == nm_create_new_igmp_interface_policy_again.current.description == ""
           - nm_create_new_igmp_interface_policy_again.previous.enableFastLeaveControl == nm_create_new_igmp_interface_policy_again.current.enableFastLeaveControl == false
           - nm_create_new_igmp_interface_policy_again.previous.enableReportLinkLocalGroups == nm_create_new_igmp_interface_policy_again.current.enableReportLinkLocalGroups == false
@@ -215,6 +220,8 @@
           - create_igmp_interface_policy_2 is changed
           - create_igmp_interface_policy_2.previous == {}
           - create_igmp_interface_policy_2.current.name == 'ansible_igmp_interface_policy_2'
+          - create_igmp_interface_policy_2.current.templateName == 'ansible_tenant_template'
+          - create_igmp_interface_policy_2.current.templateId is defined
           - create_igmp_interface_policy_2.current.uuid is defined
           - create_igmp_interface_policy_2.current.description == 'IGMP Interface Policy 2 description'
           - create_igmp_interface_policy_2.current.enableFastLeaveControl == true
@@ -233,8 +240,11 @@
           - create_igmp_interface_policy_2.current.startQueryCount == 4
           - create_igmp_interface_policy_2.current.startQueryInterval == 1000
           - create_igmp_interface_policy_2.current.reportPolicyRouteMapName == 'ansible_test_route_map_policy_2'
+          - create_igmp_interface_policy_2.current.reportPolicyRouteMapRef is defined
           - create_igmp_interface_policy_2.current.stateLimitRouteMapName == 'ansible_test_route_map_policy_1'
+          - create_igmp_interface_policy_2.current.stateLimitRouteMapRef is defined
           - create_igmp_interface_policy_2.current.staticReportRouteMapName == 'ansible_test_route_map_policy_3'
+          - create_igmp_interface_policy_2.current.staticReportRouteMapRef is defined
 
     # UPDATE
     - name: Update an IGMP interface policy (check mode)
@@ -283,6 +293,10 @@
           - nm_update_igmp_interface_policy is changed
           - cm_update_igmp_interface_policy.previous.name == nm_update_igmp_interface_policy.previous.name == 'ansible_igmp_interface_policy_2'
           - cm_update_igmp_interface_policy.current.name == nm_update_igmp_interface_policy.current.name == 'ansible_igmp_interface_policy_2'
+          - cm_update_igmp_interface_policy.previous.templateName == nm_update_igmp_interface_policy.previous.templateName == 'ansible_tenant_template'
+          - cm_update_igmp_interface_policy.current.templateName == nm_update_igmp_interface_policy.current.templateName == 'ansible_tenant_template'
+          - cm_update_igmp_interface_policy.previous.templateId == nm_update_igmp_interface_policy.previous.templateId
+          - cm_update_igmp_interface_policy.current.templateId == nm_update_igmp_interface_policy.current.templateId
           - cm_update_igmp_interface_policy.previous.description == nm_update_igmp_interface_policy.previous.description == 'IGMP Interface Policy 2 description'
           - cm_update_igmp_interface_policy.current.description == nm_update_igmp_interface_policy.current.description == 'IGMP Interface Policy 2 description updated'
           - cm_update_igmp_interface_policy.previous.enableFastLeaveControl == nm_update_igmp_interface_policy.previous.enableFastLeaveControl == true
@@ -323,6 +337,8 @@
           - cm_update_igmp_interface_policy.current.staticReportRouteMapName == nm_update_igmp_interface_policy.current.staticReportRouteMapName == 'ansible_test_route_map_policy_1'
           - nm_update_igmp_interface_policy_again is not changed
           - nm_update_igmp_interface_policy_again.previous.name == nm_update_igmp_interface_policy_again.current.name == 'ansible_igmp_interface_policy_2'
+          - nm_update_igmp_interface_policy_again.previous.templateName == nm_update_igmp_interface_policy_again.current.templateName == 'ansible_tenant_template'
+          - nm_update_igmp_interface_policy_again.previous.templateId == nm_update_igmp_interface_policy_again.current.templateId
           - nm_update_igmp_interface_policy_again.previous.description == nm_update_igmp_interface_policy_again.current.description == 'IGMP Interface Policy 2 description updated'
           - nm_update_igmp_interface_policy_again.previous.enableFastLeaveControl == nm_update_igmp_interface_policy_again.current.enableFastLeaveControl == false
           - nm_update_igmp_interface_policy_again.previous.enableReportLinkLocalGroups == nm_update_igmp_interface_policy_again.current.enableReportLinkLocalGroups == false
@@ -358,6 +374,7 @@
           - update_igmp_interface_policy_name is changed
           - update_igmp_interface_policy_name.previous.name == 'ansible_igmp_interface_policy_2'
           - update_igmp_interface_policy_name.current.name == 'ansible_igmp_interface_policy_2_updated'
+          - update_igmp_interface_policy_name.current.templateName == 'ansible_tenant_template'
 
     - name: Update the state_limit_route_map and static_report_route_map in ansible_igmp_interface_policy_2_updated
       cisco.mso.ndo_tenant_igmp_interface_policy:
@@ -372,6 +389,8 @@
         that:
           - updated_route_map is changed
           - updated_route_map.previous.name == updated_route_map.current.name == 'ansible_igmp_interface_policy_2_updated'
+          - updated_route_map.previous.templateName == updated_route_map.current.templateName == 'ansible_tenant_template'
+          - updated_route_map.previous.templateId == updated_route_map.current.templateId
           - updated_route_map.previous.stateLimitRouteMapName == 'ansible_test_route_map_policy_2'
           - updated_route_map.previous.stateLimitRouteMapRef != ""
           - updated_route_map.current.stateLimitRouteMapRef == ""
@@ -384,16 +403,18 @@
         <<: *ansible_igmp_interface_policy_2_updated
         report_policy_route_map: {}
         state: present
-      register: updated_route_map
+      register: updated_report_policy_route_map
 
-    - name: Assert IGMP Interface Policy 2report_policy_route_map was updated
+    - name: Assert IGMP Interface Policy 2 report_policy_route_map was updated
       assert:
         that:
-          - updated_route_map is changed
-          - updated_route_map.previous.name == updated_route_map.current.name == 'ansible_igmp_interface_policy_2_updated'
-          - updated_route_map.previous.reportPolicyRouteMapName == 'ansible_test_route_map_policy_3'
-          - updated_route_map.previous.reportPolicyRouteMapRef != ""
-          - updated_route_map.current.reportPolicyRouteMapRef == ""
+          - updated_report_policy_route_map is changed
+          - updated_report_policy_route_map.previous.name == updated_report_policy_route_map.current.name == 'ansible_igmp_interface_policy_2_updated'
+          - updated_report_policy_route_map.previous.templateName == updated_report_policy_route_map.current.templateName == 'ansible_tenant_template'
+          - updated_report_policy_route_map.previous.templateId == updated_report_policy_route_map.current.templateId
+          - updated_report_policy_route_map.previous.reportPolicyRouteMapName == 'ansible_test_route_map_policy_3'
+          - updated_report_policy_route_map.previous.reportPolicyRouteMapRef != ""
+          - updated_report_policy_route_map.current.reportPolicyRouteMapRef == ""
 
     # Query
     - name: Query an IGMP Interface Policy
@@ -424,12 +445,17 @@
         that:
           - query_igmp_interface_policy is not changed
           - query_igmp_interface_policy.current.name == 'ansible_igmp_interface_policy_2_updated'
+          - query_igmp_interface_policy.current.templateName == 'ansible_tenant_template'
+          - query_igmp_interface_policy.current.templateId is defined
           - query_igmp_interface_policy_uuid is not changed
           - query_igmp_interface_policy_uuid.current.name == 'ansible_igmp_interface_policy'
           - query_all_igmp_interface_policies is not changed
           - query_all_igmp_interface_policies.current | length == 2
           - query_all_igmp_interface_policies.current[0].name == 'ansible_igmp_interface_policy'
+          - query_all_igmp_interface_policies.current[0].templateName == 'ansible_tenant_template'
           - query_all_igmp_interface_policies.current[1].name == 'ansible_igmp_interface_policy_2_updated'
+          - query_all_igmp_interface_policies.current[1].templateName == 'ansible_tenant_template'
+          - - query_all_igmp_interface_policies.current[0].templateId == query_all_igmp_interface_policies.current[1].templateId
 
     # DELETE
     - name: Delete an IGMP Interface Policy (check mode)
@@ -458,6 +484,8 @@
           - nm_delete_igmp_interface_policy is changed
           - cm_delete_igmp_interface_policy.current == nm_delete_igmp_interface_policy.current == {}
           - cm_delete_igmp_interface_policy.previous.name == nm_delete_igmp_interface_policy.previous.name == 'ansible_igmp_interface_policy_2_updated'
+          - cm_delete_igmp_interface_policy.previous.templateName == nm_delete_igmp_interface_policy.previous.templateName == 'ansible_tenant_template'
+          - cm_delete_igmp_interface_policy.previous.templateId == nm_delete_igmp_interface_policy.previous.templateId
           - cm_delete_igmp_interface_policy.previous.uuid == nm_delete_igmp_interface_policy.previous.uuid
           - cm_delete_igmp_interface_policy.previous.description == nm_delete_igmp_interface_policy.previous.description == 'IGMP Interface Policy 2 description updated'
           - cm_delete_igmp_interface_policy.previous.enableFastLeaveControl == nm_delete_igmp_interface_policy.previous.enableFastLeaveControl == false
@@ -494,6 +522,8 @@
         that:
         - delete_igmp_interface_policy_uuid is changed
         - delete_igmp_interface_policy_uuid.previous.name == 'ansible_igmp_interface_policy'
+        - delete_igmp_interface_policy_uuid.previous.templateName == 'ansible_tenant_template'
+        - delete_igmp_interface_policy_uuid.previous.templateId is defined
         - delete_igmp_interface_policy_uuid.previous.description == ""
         - delete_igmp_interface_policy_uuid.current == {}