Add dhcp servers list (#516)

* Fix issue 506 Increase DHCP Server List

* Fix issue with DHCP server list and key-value pairs

* Add new function has_partial_dhcp_config to plugins/module_utils/network/dcnm/dcnm.py

* Refactor dhcp_servers logic to make use of the has_partial_dhcp_config helper_function

* Change dhcp_servers description to reflect actual behavior

* Update Copyright information

* Refactor logic to remove unnecessary checks

* Fix bad-indentation on line 2871

---------

Co-authored-by: miguecor <[email protected]>
Co-authored-by: miguecor <[email protected]>

Author: 3 people

plugins/module_utils/network/dcnm/dcnm.py

@@ -955,3 +955,51 @@ def search_nested_json(obj, search_string):
         if search_string in obj.lower():
             return True
     return False
+
+
+def has_partial_dhcp_config(server):
+    """
+    # Summary
+
+    Check if a DHCP server has incomplete configuration (IP address set but no VRF or vice versa).
+
+    ## Raises
+
+    None
+
+    ## Parameters
+
+    -   server (dict): A dictionary representing the DHCP server configuration.
+
+    ## Returns
+
+    -   bool: True if the server has partial configuration, False otherwise.
+
+    ## Usage
+
+    ```python
+    server1 = {
+        "srvr_ip": "ip_address",
+        "srvr_vrf": "vrf_name"
+        }
+    result1 = has_partial_dhcp_config(server1)
+    print(result1)
+    # -> False (complete configuration)
+
+    server2 = {
+        "srvr_ip": "ip_address"
+        }
+    result2 = has_partial_dhcp_config(server2)
+    print(result2)
+    # -> True (partial configuration)
+
+    server3 = {
+        "srvr_vrf": "vrf_name"
+        }
+    result3 = has_partial_dhcp_config(server3)
+    print(result3)
+    # -> True (partial configuration)
+    """
+    ip = server.get("srvr_ip")
+    vrf = server.get("srvr_vrf")
+    return bool(ip) != bool(vrf)

plugins/modules/dcnm_network.py

@@ -156,6 +156,16 @@
         - VRF ID of third DHCP server
         type: str
         required: false
+      dhcp_servers:
+        description:
+        - List of DHCP servers
+        - This is an alternative to dhcp_srvr1_ip, dhcp_srvr1_vrf, dhcp_srvr2_ip, dhcp_srvr2_vrf,
+            dhcp_srvr3_ip, dhcp_srvr3_vrf
+        - If both dhcp_servers and any of dhcp_srvr1_ip, dhcp_srvr1_vrf, dhcp_srvr2_ip,
+            dhcp_srvr2_vrf, dhcp_srvr3_ip, dhcp_srvr3_vrf are specified, unexpected results may occur
+        type: list
+        elements: dict
+        required: false
       dhcp_loopback_id:
         description:
         - Loopback ID for DHCP Relay interface
@@ -480,6 +490,7 @@
     get_fabric_inventory_details,
     get_ip_sn_dict,
     get_ip_sn_fabric_dict,
+    has_partial_dhcp_config,
     validate_list_of_dicts,
 )
 
@@ -893,6 +904,7 @@ def diff_for_create(self, want, have):
         dhcp1_vrf_changed = False
         dhcp2_vrf_changed = False
         dhcp3_vrf_changed = False
+        dhcp_servers_changed = False
         dhcp_loopback_changed = False
         multicast_group_address_changed = False
         gwv6_changed = False
@@ -934,7 +946,6 @@ def diff_for_create(self, want, have):
         arpsup_want = str(json_to_dict_want.get("suppressArp", "")).lower()
         arpsup_have = json_to_dict_have.get("suppressArp", "")
         dhcp1_ip_want = json_to_dict_want.get("dhcpServerAddr1", "")
-        dhcp1_ip_want = json_to_dict_want.get("dhcpServerAddr1", "")
         dhcp1_ip_have = json_to_dict_have.get("dhcpServerAddr1", "")
         dhcp2_ip_want = json_to_dict_want.get("dhcpServerAddr2", "")
         dhcp2_ip_have = json_to_dict_have.get("dhcpServerAddr2", "")
@@ -946,6 +957,8 @@ def diff_for_create(self, want, have):
         dhcp2_vrf_have = json_to_dict_have.get("vrfDhcp2", "")
         dhcp3_vrf_want = json_to_dict_want.get("vrfDhcp3", "")
         dhcp3_vrf_have = json_to_dict_have.get("vrfDhcp3", "")
+        dhcp_servers_want = json_to_dict_want.get("dhcpServers", "")
+        dhcp_servers_have = json_to_dict_have.get("dhcpServers", "")
         dhcp_loopback_want = json_to_dict_want.get("loopbackId", "")
         dhcp_loopback_have = json_to_dict_have.get("loopbackId", "")
         multicast_group_address_want = json_to_dict_want.get("mcastGroup", "")
@@ -1001,6 +1014,7 @@ def diff_for_create(self, want, have):
                 or dhcp1_vrf_have != dhcp1_vrf_want
                 or dhcp2_vrf_have != dhcp2_vrf_want
                 or dhcp3_vrf_have != dhcp3_vrf_want
+                or dhcp_servers_have != dhcp_servers_want
                 or dhcp_loopback_have != dhcp_loopback_want
                 or multicast_group_address_have != multicast_group_address_want
                 or gw_ipv6_have != gw_ipv6_want
@@ -1047,6 +1061,8 @@ def diff_for_create(self, want, have):
                     dhcp2_vrf_changed = True
                 if dhcp3_vrf_have != dhcp3_vrf_want:
                     dhcp3_vrf_changed = True
+                if dhcp_servers_have != dhcp_servers_want:
+                    dhcp_servers_changed = True
                 if dhcp_loopback_have != dhcp_loopback_want:
                     dhcp_loopback_changed = True
                 if multicast_group_address_have != multicast_group_address_want:
@@ -1096,6 +1112,7 @@ def diff_for_create(self, want, have):
                 or dhcp1_vrf_have != dhcp1_vrf_want
                 or dhcp2_vrf_have != dhcp2_vrf_want
                 or dhcp3_vrf_have != dhcp3_vrf_want
+                or dhcp_servers_have != dhcp_servers_want
                 or dhcp_loopback_have != dhcp_loopback_want
                 or multicast_group_address_have != multicast_group_address_want
                 or gw_ipv6_have != gw_ipv6_want
@@ -1139,6 +1156,8 @@ def diff_for_create(self, want, have):
                     dhcp2_vrf_changed = True
                 if dhcp3_vrf_have != dhcp3_vrf_want:
                     dhcp3_vrf_changed = True
+                if dhcp_servers_have != dhcp_servers_want:
+                    dhcp_servers_changed = True
                 if dhcp_loopback_have != dhcp_loopback_want:
                     dhcp_loopback_changed = True
                 if multicast_group_address_have != multicast_group_address_want:
@@ -1186,6 +1205,7 @@ def diff_for_create(self, want, have):
             dhcp1_vrf_changed,
             dhcp2_vrf_changed,
             dhcp3_vrf_changed,
+            dhcp_servers_changed,
             dhcp_loopback_changed,
             multicast_group_address_changed,
             gwv6_changed,
@@ -1244,6 +1264,9 @@ def update_create_params(self, net):
             "vrfDhcp": net.get("dhcp_srvr1_vrf", ""),
             "vrfDhcp2": net.get("dhcp_srvr2_vrf", ""),
             "vrfDhcp3": net.get("dhcp_srvr3_vrf", ""),
+            "dhcpServers": [
+                {"srvrAddr": srvr["srvr_ip"], "srvrVrf": srvr["srvr_vrf"]} for srvr in net.get("dhcp_servers", [])
+            ],
             "loopbackId": net.get("dhcp_loopback_id", ""),
             "mcastGroup": net.get("multicast_group_address", ""),
             "gatewayIpV6Address": net.get("gw_ipv6_subnet", ""),
@@ -1277,6 +1300,30 @@ def update_create_params(self, net):
             template_conf["vrfDhcp2"] = ""
         if template_conf["vrfDhcp3"] is None:
             template_conf["vrfDhcp3"] = ""
+        if template_conf["dhcpServers"] == []:
+            dhcp_srvr_list = []
+            if template_conf["dhcpServerAddr1"] != "" and template_conf["vrfDhcp"] != "":
+                dhcp_srvr_list.append({"srvrAddr": template_conf["dhcpServerAddr1"], "srvrVrf": template_conf["vrfDhcp"]})
+            if template_conf["dhcpServerAddr2"] != "" and template_conf["vrfDhcp2"] != "":
+                dhcp_srvr_list.append({"srvrAddr": template_conf["dhcpServerAddr2"], "srvrVrf": template_conf["vrfDhcp2"]})
+            if template_conf["dhcpServerAddr3"] != "" and template_conf["vrfDhcp3"] != "":
+                dhcp_srvr_list.append({"srvrAddr": template_conf["dhcpServerAddr3"], "srvrVrf": template_conf["vrfDhcp3"]})
+            if dhcp_srvr_list != []:
+                template_conf["dhcpServers"] = json.dumps(dict(dhcpServers=dhcp_srvr_list), separators=(",", ":"))
+            else:
+                template_conf["dhcpServers"] = ""
+        elif template_conf["dhcpServers"] != []:
+            dhcp_srvr_list = template_conf["dhcpServers"]
+            if dhcp_srvr_list[0:1]:
+                template_conf["dhcpServerAddr1"] = dhcp_srvr_list[0]["srvrAddr"]
+                template_conf["vrfDhcp"] = dhcp_srvr_list[0]["srvrVrf"]
+            if dhcp_srvr_list[1:2]:
+                template_conf["dhcpServerAddr2"] = dhcp_srvr_list[1]["srvrAddr"]
+                template_conf["vrfDhcp2"] = dhcp_srvr_list[1]["srvrVrf"]
+            if dhcp_srvr_list[2:3]:
+                template_conf["dhcpServerAddr3"] = dhcp_srvr_list[2]["srvrAddr"]
+                template_conf["vrfDhcp3"] = dhcp_srvr_list[2]["srvrVrf"]
+            template_conf["dhcpServers"] = json.dumps(dict(dhcpServers=dhcp_srvr_list), separators=(",", ":"))
         if template_conf["loopbackId"] is None:
             template_conf["loopbackId"] = ""
         if self.is_ms_fabric is True:
@@ -1294,6 +1341,7 @@ def update_create_params(self, net):
             template_conf["secondaryGW3"] = ""
         if template_conf["secondaryGW4"] is None:
             template_conf["secondaryGW4"] = ""
+
         if self.dcnm_version > 11:
             if template_conf["SVI_NETFLOW_MONITOR"] is None:
                 template_conf["SVI_NETFLOW_MONITOR"] = ""
@@ -1375,6 +1423,7 @@ def get_have(self):
                     "vrfDhcp": json_to_dict.get("vrfDhcp", ""),
                     "vrfDhcp2": json_to_dict.get("vrfDhcp2", ""),
                     "vrfDhcp3": json_to_dict.get("vrfDhcp3", ""),
+                    "dhcpServers": json_to_dict.get("dhcpServers", ""),
                     "loopbackId": json_to_dict.get("loopbackId", ""),
                     "mcastGroup": json_to_dict.get("mcastGroup", ""),
                     "gatewayIpV6Address": json_to_dict.get("gatewayIpV6Address", ""),
@@ -1428,6 +1477,7 @@ def get_have(self):
                             "vrfDhcp": json_to_dict.get("vrfDhcp", ""),
                             "vrfDhcp2": json_to_dict.get("vrfDhcp2", ""),
                             "vrfDhcp3": json_to_dict.get("vrfDhcp3", ""),
+                            "dhcpServers": json_to_dict.get("dhcpServers", ""),
                             "loopbackId": json_to_dict.get("loopbackId", ""),
                             "mcastGroup": json_to_dict.get("mcastGroup", ""),
                             "gatewayIpV6Address": json_to_dict.get("gatewayIpV6Address", ""),
@@ -1868,6 +1918,7 @@ def get_diff_merge(self, replace=False):
         dhcp1_vrf_changed = {}
         dhcp2_vrf_changed = {}
         dhcp3_vrf_changed = {}
+        dhcp_servers_changed = {}
         dhcp_loopback_changed = {}
         multicast_group_address_changed = {}
         gwv6_changed = {}
@@ -1904,6 +1955,7 @@ def get_diff_merge(self, replace=False):
                         dhcp1_vrf_chg,
                         dhcp2_vrf_chg,
                         dhcp3_vrf_chg,
+                        dhcp_servers_chg,
                         dhcp_loopbk_chg,
                         mcast_grp_chg,
                         gwv6_chg,
@@ -1931,6 +1983,7 @@ def get_diff_merge(self, replace=False):
                     dhcp1_vrf_changed.update({want_c["networkName"]: dhcp1_vrf_chg})
                     dhcp2_vrf_changed.update({want_c["networkName"]: dhcp2_vrf_chg})
                     dhcp3_vrf_changed.update({want_c["networkName"]: dhcp3_vrf_chg})
+                    dhcp_servers_changed.update({want_c["networkName"]: dhcp_servers_chg})
                     dhcp_loopback_changed.update({want_c["networkName"]: dhcp_loopbk_chg})
                     if self.is_ms_fabric is False:
                         multicast_group_address_changed.update({want_c["networkName"]: mcast_grp_chg})
@@ -2043,6 +2096,7 @@ def get_diff_merge(self, replace=False):
                             or dhcp1_vrf_changed.get(want_a["networkName"], False)
                             or dhcp2_vrf_changed.get(want_a["networkName"], False)
                             or dhcp3_vrf_changed.get(want_a["networkName"], False)
+                            or dhcp_servers_changed.get(want_a["networkName"], False)
                             or dhcp_loopback_changed.get(want_a["networkName"], False)
                             or multicast_group_address_changed.get(want_a["networkName"], False)
                             or gwv6_changed.get(want_a["networkName"], False)
@@ -2151,6 +2205,7 @@ def format_diff(self):
             found_c.update({"dhcp_srvr1_vrf": json_to_dict.get("vrfDhcp", "")})
             found_c.update({"dhcp_srvr2_vrf": json_to_dict.get("vrfDhcp2", "")})
             found_c.update({"dhcp_srvr3_vrf": json_to_dict.get("vrfDhcp3", "")})
+            found_c.update({"dhcp_servers": json_to_dict.get("dhcpServers", "")})
             found_c.update({"dhcp_loopback_id": json_to_dict.get("loopbackId", "")})
             found_c.update({"multicast_group_address": json_to_dict.get("mcastGroup", "")})
             found_c.update({"gw_ipv6_subnet": json_to_dict.get("gatewayIpV6Address", "")})
@@ -2531,6 +2586,7 @@ def push_to_remote(self, is_rollback=False):
                     "vrfDhcp": json_to_dict.get("vrfDhcp", ""),
                     "vrfDhcp2": json_to_dict.get("vrfDhcp2", ""),
                     "vrfDhcp3": json_to_dict.get("vrfDhcp3", ""),
+                    "dhcpServers": json_to_dict.get("dhcpServers", ""),
                     "loopbackId": json_to_dict.get("loopbackId", ""),
                     "mcastGroup": json_to_dict.get("mcastGroup", ""),
                     "gatewayIpV6Address": json_to_dict.get("gatewayIpV6Address", ""),
@@ -2671,6 +2727,7 @@ def validate_input(self):
                 dhcp_srvr1_vrf=dict(type="str", length_max=32),
                 dhcp_srvr2_vrf=dict(type="str", length_max=32),
                 dhcp_srvr3_vrf=dict(type="str", length_max=32),
+                dhcp_servers=dict(type="list", elements="dict", default=[]),
                 dhcp_loopback_id=dict(type="int", range_min=0, range_max=1023),
                 multicast_group_address=dict(type="ipv4", default=mcast_group_addr),
                 gw_ipv6_subnet=dict(type="ipv6_subnet", default=""),
@@ -2737,6 +2794,7 @@ def validate_input(self):
                 dhcp_srvr1_vrf=dict(type="str", length_max=32),
                 dhcp_srvr2_vrf=dict(type="str", length_max=32),
                 dhcp_srvr3_vrf=dict(type="str", length_max=32),
+                dhcp_servers=dict(type="list", elements="dict", default=[]),
                 dhcp_loopback_id=dict(type="int", range_min=0, range_max=1023),
                 multicast_group_address=dict(type="ipv4", default=mcast_group_addr),
                 gw_ipv6_subnet=dict(type="ipv6_subnet", default=""),
@@ -2798,16 +2856,20 @@ def validate_input(self):
                             if net.get("vrf_name", "") is None:
                                 invalid_params.append("vrf_name is required for L3 Networks")
 
-                        if (
-                            (net.get("dhcp_srvr1_ip") and not net.get("dhcp_srvr1_vrf"))
-                            or (net.get("dhcp_srvr1_vrf") and not net.get("dhcp_srvr1_ip"))
-                            or (net.get("dhcp_srvr2_ip") and not net.get("dhcp_srvr2_vrf"))
-                            or (net.get("dhcp_srvr2_vrf") and not net.get("dhcp_srvr2_ip"))
-                            or (net.get("dhcp_srvr3_ip") and not net.get("dhcp_srvr3_vrf"))
-                            or (net.get("dhcp_srvr3_vrf") and not net.get("dhcp_srvr3_ip"))
-                        ):
+                        if any(has_partial_dhcp_config(srvr) for srvr in [
+                            dict(srvr_ip=net.get("dhcp_srvr1_ip"), srvr_vrf=net.get("dhcp_srvr1_vrf")),
+                            dict(srvr_ip=net.get("dhcp_srvr2_ip"), srvr_vrf=net.get("dhcp_srvr2_vrf")),
+                            dict(srvr_ip=net.get("dhcp_srvr3_ip"), srvr_vrf=net.get("dhcp_srvr3_vrf")),
+                        ]):
                             invalid_params.append("DHCP server IP should be specified along with DHCP server VRF")
 
+                        if net.get("dhcp_servers"):
+                            dhcp_servers = net.get("dhcp_servers")
+                            if len(dhcp_servers) > 16:
+                                invalid_params.append("A maximum of 16 DHCP servers can be specified")
+                            if any(has_partial_dhcp_config(srvr) for srvr in dhcp_servers):
+                                invalid_params.append("DHCP server IP should be specified along with DHCP server VRF")
+
                         if self.dcnm_version == 11:
                             if net.get("netflow_enable") or net.get("intfvlan_nf_monitor") or net.get("vlan_nf_monitor"):
                                 invalid_params.append("Netflow configurations are supported only on NDFC")
@@ -2982,6 +3044,26 @@ def dcnm_update_network_information(self, want, have, cfg):
         if cfg.get("dhcp_srvr3_vrf", None) is None:
             json_to_dict_want["vrfDhcp3"] = json_to_dict_have["vrfDhcp3"]
 
+        if cfg.get("dhcp_servers", None) is None:
+            want_have_dhcp_servers = [None] * 3
+            if cfg.get("dhcp_srvr1_ip", None) is not None:
+                want_have_dhcp_servers[0] = dict(srvrAddr=cfg.get("dhcp_srvr1_ip"), srvrVrf=cfg.get("dhcp_srvr1_vrf"))
+            elif json_to_dict_have["dhcpServerAddr1"] != "":
+                want_have_dhcp_servers[0] = dict(srvrAddr=json_to_dict_have["dhcpServerAddr1"], srvrVrf=json_to_dict_have["vrfDhcp"])
+            if cfg.get("dhcp_srvr2_ip", None) is not None:
+                want_have_dhcp_servers[1] = dict(srvrAddr=cfg.get("dhcp_srvr2_ip"), srvrVrf=cfg.get("dhcp_srvr2_vrf"))
+            elif json_to_dict_have["dhcpServerAddr2"] != "":
+                want_have_dhcp_servers[1] = dict(srvrAddr=json_to_dict_have["dhcpServerAddr2"], srvrVrf=json_to_dict_have["vrfDhcp2"])
+            if cfg.get("dhcp_srvr3_ip", None) is not None:
+                want_have_dhcp_servers[2] = dict(srvrAddr=cfg.get("dhcp_srvr3_ip"), srvrVrf=cfg.get("dhcp_srvr3_vrf"))
+            elif json_to_dict_have["dhcpServerAddr3"] != "":
+                want_have_dhcp_servers[2] = dict(srvrAddr=json_to_dict_have["dhcpServerAddr3"], srvrVrf=json_to_dict_have["vrfDhcp3"])
+            want_have_dhcp_servers = [srvr for srvr in want_have_dhcp_servers[:] if srvr is not None]
+            if want_have_dhcp_servers != []:
+                json_to_dict_want["dhcpServers"] = json.dumps(dict(dhcpServers=want_have_dhcp_servers, separators=(",", ":")))
+            else:
+                json_to_dict_want["dhcpServers"] = json_to_dict_have["dhcpServers"]
+
         if cfg.get("dhcp_loopback_id", None) is None:
             json_to_dict_want["loopbackId"] = json_to_dict_have["loopbackId"]