Added ndo_l3out_node_group_policy module to manage L3Out Node Group Policy (DCNE-181)

plugins/module_utils/constants.py

@@ -211,3 +211,5 @@
 
 ORIGINATE_DEFAULT_ROUTE = {"only": "only", "in_addition": "inAddition", "": ""}
 L3OUT_ROUTING_PROTOCOLS = {"bgp": ["bgp"], "ospf": ["ospf"], "bgpOspf": ["bgp", "ospf"], None: [None], "": None, "bgpospf": "bgpOspf", "ospfbgp": "bgpOspf"}
+
+ENABLED_DISABLED_BOOLEAN_MAP = {"enabled": True, "disabled": False, True: "enabled", False: "disabled"}

plugins/module_utils/template.py

@@ -207,3 +207,37 @@ def get_l3out_node_routing_policy_object(self, uuid=None, name=None, fail_module
                 "L3Out Node Routing Policy", existing_l3out_node_routing_policy, [KVPair("uuid", uuid) if uuid else KVPair("name", name)], fail_module
             )
         return existing_l3out_node_routing_policy  # Query all objects
+
+    def get_l3out_object(self, uuid=None, name=None, fail_module=False):
+        """
+        Get the L3Out by uuid or name.
+        :param uuid: UUID of the L3Out to search for -> Str
+        :param name: Name of the L3Out to search for -> Str
+        :param fail_module: When match is not found fail the ansible module -> Bool
+        :return: Dict | None | List[Dict] | List[]: The processed result which could be:
+                 When the UUID | Name is existing in the search list -> Dict
+                 When the UUID | Name is not existing in the search list -> None
+                 When both UUID and Name are None, and the search list is not empty -> List[Dict]
+                 When both UUID and Name are None, and the search list is empty -> List[]
+        """
+        existing_l3outs = self.template.get("l3outTemplate", {}).get("l3outs", [])
+        if uuid or name:  # Query a specific object
+            return self.get_object_by_key_value_pairs("L3Out", existing_l3outs, [KVPair("uuid", uuid) if uuid else KVPair("name", name)], fail_module)
+        return existing_l3outs  # Query all objects
+
+    def get_l3out_node_group(self, name, l3out_object, fail_module=False):
+        """
+        Get the L3Out Node Group Policy by name.
+        :param name: Name of the L3Out Node Group Policy to search for -> Str
+        :param l3out_object: L3Out object to search Node Group Policy -> Dict
+        :param fail_module: When match is not found fail the ansible module -> Bool
+        :return: Dict | None | List[Dict] | List[]: The processed result which could be:
+                 When the UUID | Name is existing in the search list -> Dict
+                 When the UUID | Name is not existing in the search list -> None
+                 When both UUID and Name are None, and the search list is not empty -> List[Dict]
+                 When both UUID and Name are None, and the search list is empty -> List[]
+        """
+        existing_l3out_node_groups = l3out_object.get("nodeGroups", [])
+        if name:  # Query a specific object
+            return self.get_object_by_key_value_pairs("L3Out Node Group Policy", existing_l3out_node_groups, [KVPair("name", name)], fail_module)
+        return existing_l3out_node_groups  # Query all objects

plugins/module_utils/utils.py

@@ -18,15 +18,6 @@ def generate_api_endpoint(path, **kwargs):
     :param kwargs: Keyword arguments representing query parameters. -> Dict
     :return: A string representing the full API endpoint with query parameters. -> Str
     """
-    # if not kwargs:
-    #     return path
-
-    # query_strings = ["{0}={1}".format(key, value) for key, value in kwargs.items()]
-    # query_string = "&".join(query_strings)
-    # full_url = "{0}?{1}".format(path, query_string)
-
-    # return full_url
-
     return path if not kwargs else "{0}?{1}".format(path, "&".join(["{0}={1}".format(key, value) for key, value in kwargs.items()]))
 
 
@@ -145,3 +136,13 @@ def recursive_delete(data, path, keys):
 
         for key in remove_data:
             recursive_delete(existing_data, update_path, key if isinstance(key, tuple) else (key,))
+
+
+def check_if_all_elements_are_none(values):
+    """
+    Checks if all the elements in the provided list are None.
+
+    :param values: List of values to check. -> List
+    :return: True if all elements are None, False otherwise. -> boo
+    """
+    return all(value is None for value in values)