Skip to content

Allow overlay DHCP servers to be configured without a VRF. #557

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
miguecor wants to merge 11 commits into
base: develop
Choose a base branch
from
Open

Allow overlay DHCP servers to be configured without a VRF. #557

Show file tree
Hide file tree
Changes from 9 commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
8651a50
Fix for allowing DHCP srvr config without VRF
Oct 26, 2025
f85676a
Fix issue to allow DHCP server config without VRF in Networks
Oct 26, 2025
7a074e3
Fix issue with networks that don't have DHCP servers from the begining
Oct 27, 2025
7b0fbc7
Merge branch 'develop' into dhcp_server_allow_no_vrf
miguecor Oct 27, 2025
827c8e3
Fix merge issue with develop
Oct 27, 2025
9f9784c
Merge branch 'develop' into dhcp_server_allow_no_vrf
Nov 14, 2025
01426e5
Change 'dhcp_servers' to allow 'srvr_vrf' to be optional
Nov 15, 2025
8a99930
Fix PEP8 issue W291: trailing whitespace
Nov 15, 2025
945796f
Change dcnm_network_module documentation
Nov 15, 2025
9ec939d
Change requested modifications from comments
Nov 18, 2025
caa5b7a
Fix PEP8 issue W291: trailing whitespace
Nov 18, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 8 additions & 1 deletion docs/cisco.dcnm.dcnm_network_module.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -263,7 +263,8 @@ Parameters
</td>
<td>
<div>List of DHCP server_vrf pairs where &#x27;srvr_ip&#x27; is the IP key and &#x27;srvr_vrf&#x27; is the VRF key</div>
<div>This is an alternative to dhcp_srvr1_ip, dhcp_srvr1_vrf, dhcp_srvr2_ip, dhcp_srvr2_vrf, dhcp_srvr3_ip, dhcp_srvr3_vrf</div>
<div>&#x27;srvr_vrf&#x27; is an optional parameter</div>
<div>This will eventually replace dhcp_srvr1_ip, dhcp_srvr1_vrf, dhcp_srvr2_ip, dhcp_srvr2_vrf, dhcp_srvr3_ip, dhcp_srvr3_vrf</div>
<div>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 an error message is generated indicating these are mutually exclusive options</div>
</td>
</tr>
Expand All @@ -281,6 +282,7 @@ Parameters
</td>
<td>
<div>DHCP relay IP address of the first DHCP server</div>
<div>This will eventually be replaced by dhcp_servers</div>
Copy link
Collaborator

@allenrobel allenrobel Nov 17, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Replace with the following thoughout.

DEPRECATED. See dcnm_servers.

</td>
</tr>
<tr>
Expand All @@ -297,6 +299,7 @@ Parameters
</td>
<td>
<div>VRF ID of first DHCP server</div>
<div>This is an optional parameter</div>
</td>
</tr>
<tr>
Expand All @@ -313,6 +316,7 @@ Parameters
</td>
<td>
<div>DHCP relay IP address of the second DHCP server</div>
<div>This will eventually be replaced by dhcp_servers</div>
</td>
</tr>
<tr>
Expand All @@ -329,6 +333,7 @@ Parameters
</td>
<td>
<div>VRF ID of second DHCP server</div>
<div>This is an optional parameter</div>
</td>
</tr>
<tr>
Expand All @@ -345,6 +350,7 @@ Parameters
</td>
<td>
<div>DHCP relay IP address of the third DHCP server</div>
<div>This will eventually be replaced by dhcp_servers</div>
</td>
</tr>
<tr>
Expand All @@ -361,6 +367,7 @@ Parameters
</td>
<td>
<div>VRF ID of third DHCP server</div>
<div>This is an optional parameter</div>
</td>
</tr>
<tr>
Expand Down
8 changes: 5 additions & 3 deletions plugins/module_utils/network/dcnm/dcnm.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -961,7 +961,7 @@ def has_partial_dhcp_config(server):
"""
# Summary

Check if a DHCP server has incomplete configuration (IP address set but no VRF or vice versa).
Check if a DHCP server has incomplete configuration (VRF set but no IP address).

## Raises

Expand Down Expand Up @@ -991,7 +991,7 @@ def has_partial_dhcp_config(server):
}
result2 = has_partial_dhcp_config(server2)
print(result2)
# -> True (partial configuration)
# -> False (complete configuration)

server3 = {
"srvr_vrf": "vrf_name"
Expand All @@ -1002,4 +1002,6 @@ def has_partial_dhcp_config(server):
"""
ip = server.get("srvr_ip")
vrf = server.get("srvr_vrf")
return bool(ip) != bool(vrf)
if vrf is not None:
return ip is None
return False
71 changes: 49 additions & 22 deletions plugins/modules/dcnm_network.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -129,41 +129,61 @@
dhcp_srvr1_ip:
description:
- DHCP relay IP address of the first DHCP server
- If dhcp_servers and dhcp_srvr1_ip are specified an error message is generated
indicating these are mutually exclusive options
Copy link
Collaborator

@allenrobel allenrobel Nov 17, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe reword to say something like:

If dhcp_srvr1_ip is set, a deprecation warning will be logged. Please use only dcnm_servers in new playbooks.

Copy link
Collaborator

@mikewiebe mikewiebe Nov 18, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Today we actually generate an error message not a warning since the old properties and new property are mutually exclusive so in this case I think the verbiage is appropriate

- dhcp_servers will eventually replace dhcp_srvr1_ip and dhcp_srvr1_vrf
type: str
required: false
dhcp_srvr1_vrf:
description:
- VRF ID of first DHCP server
- If not specified, will use same VRF as the network VRF
- For ND version 3.1 and NDFC 12.1 dhcp_srvr1_vrf must be specified for dhcp_srvr1_ip
- dhcp_servers will eventually replace dhcp_srvr1_ip and dhcp_srvr1_vrf
type: str
required: false
dhcp_srvr2_ip:
description:
- DHCP relay IP address of the second DHCP server
- If dhcp_servers and dhcp_srvr2_ip are specified an error message is generated
indicating these are mutually exclusive options
- dhcp_servers will eventually replace dhcp_srvr2_ip and dhcp_srvr2_vrf
type: str
required: false
dhcp_srvr2_vrf:
description:
- VRF ID of second DHCP server
- If not specified, will use same VRF as the network VRF
- For ND version 3.1 and NDFC 12.1 dhcp_srvr2_vrf must be specified for dhcp_srvr2_ip
- dhcp_servers will eventually replace dhcp_srvr2_ip and dhcp_srvr2_vrf
type: str
required: false
dhcp_srvr3_ip:
description:
- DHCP relay IP address of the third DHCP server
- If dhcp_servers and dhcp_srvr3_ip are specified an error message is generated
indicating these are mutually exclusive options
- dhcp_servers will eventually replace dhcp_srvr3_ip and dhcp_srvr3_vrf
type: str
required: false
dhcp_srvr3_vrf:
description:
- VRF ID of third DHCP server
- If not specified, will use same VRF as the network VRF
- For ND version 3.1 and NDFC 12.1 dhcp_srvr3_vrf must be specified for dhcp_srvr3_ip
- dhcp_servers will eventually replace dhcp_srvr3_ip and dhcp_srvr3_vrf
type: str
required: false
dhcp_servers:
description:
- List of DHCP server_vrf pairs where 'srvr_ip' is the IP key and 'srvr_vrf' is the VRF key
- This is an alternative to dhcp_srvr1_ip, dhcp_srvr1_vrf, dhcp_srvr2_ip, dhcp_srvr2_vrf,
dhcp_srvr3_ip, dhcp_srvr3_vrf
- The 'srvr_vrf' key is optional, if not specified will use same VRF as the network VRF
- For ND version 3.1 and NDFC 12.1 'srvr_vrf' must be specified for each DHCP server
- 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 an error message is generated
indicating these are mutually exclusive options
- This will eventually replace dhcp_srvr1_ip, dhcp_srvr1_vrf,
dhcp_srvr2_ip, dhcp_srvr2_vrf, dhcp_srvr3_ip, dhcp_srvr3_vrf
type: list
elements: dict
required: false
Expand Down Expand Up @@ -1287,7 +1307,7 @@ def update_create_params(self, net):
"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", [])
{"srvrAddr": srvr["srvr_ip"], "srvrVrf": srvr.get("srvr_vrf", "")} for srvr in net.get("dhcp_servers", [])
],
"loopbackId": net.get("dhcp_loopback_id", ""),
"mcastGroup": net.get("multicast_group_address", ""),
Expand Down Expand Up @@ -1324,11 +1344,11 @@ def update_create_params(self, net):
template_conf["vrfDhcp3"] = ""
if template_conf["dhcpServers"] == []:
dhcp_srvr_list = []
if template_conf["dhcpServerAddr1"] != "" and template_conf["vrfDhcp"] != "":
if template_conf["dhcpServerAddr1"] != "":
dhcp_srvr_list.append({"srvrAddr": template_conf["dhcpServerAddr1"], "srvrVrf": template_conf["vrfDhcp"]})
if template_conf["dhcpServerAddr2"] != "" and template_conf["vrfDhcp2"] != "":
if template_conf["dhcpServerAddr2"] != "":
dhcp_srvr_list.append({"srvrAddr": template_conf["dhcpServerAddr2"], "srvrVrf": template_conf["vrfDhcp2"]})
if template_conf["dhcpServerAddr3"] != "" and template_conf["vrfDhcp3"] != "":
if template_conf["dhcpServerAddr3"] != "":
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=(",", ":"))
Expand Down Expand Up @@ -2904,14 +2924,14 @@ def validate_input(self):
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")
invalid_params.append("DHCP server VRF should be specified along with DHCP server IP")

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")
invalid_params.append("DHCP server VRF should be specified along with DHCP server IP")

if self.dcnm_version == 11:
if net.get("netflow_enable") or net.get("intfvlan_nf_monitor") or net.get("vlan_nf_monitor"):
Expand Down Expand Up @@ -3088,24 +3108,31 @@ def dcnm_update_network_information(self, want, have, cfg):
json_to_dict_want["vrfDhcp3"] = json_to_dict_have["vrfDhcp3"]

if cfg.get("dhcp_servers", None) is None:
want_have_dhcp_servers = [None] * 3
want_dhcp_servers = json.loads(json_to_dict_have["dhcpServers"] or "{}").get("dhcpServers", [])
want_dhcp_servers += [None] * (16 - len(want_dhcp_servers))
if json_to_dict_have["dhcpServerAddr1"] != "":
want_dhcp_servers[0] = dict(srvrAddr=json_to_dict_have["dhcpServerAddr1"], srvrVrf=json_to_dict_have["vrfDhcp"])
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"])
want_dhcp_servers[0] = dict(srvrAddr=cfg.get("dhcp_srvr1_ip"), srvrVrf=json_to_dict_have["vrfDhcp"])
if cfg.get("dhcp_srvr1_vrf", None) is not None:
want_dhcp_servers[0].update({"srvrVrf": cfg.get("dhcp_srvr1_vrf")})
if json_to_dict_have["dhcpServerAddr2"] != "":
want_dhcp_servers[1] = dict(srvrAddr=json_to_dict_have["dhcpServerAddr2"], srvrVrf=json_to_dict_have["vrfDhcp2"])
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"])
want_dhcp_servers[1] = dict(srvrAddr=cfg.get("dhcp_srvr2_ip"), srvrVrf=json_to_dict_have["vrfDhcp2"])
if cfg.get("dhcp_srvr2_vrf", None) is not None:
want_dhcp_servers[1].update({"srvrVrf": cfg.get("dhcp_srvr2_vrf")})
if json_to_dict_have["dhcpServerAddr3"] != "":
want_dhcp_servers[2] = dict(srvrAddr=json_to_dict_have["dhcpServerAddr3"], srvrVrf=json_to_dict_have["vrfDhcp3"])
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=(",", ":")))
want_dhcp_servers[2] = dict(srvrAddr=cfg.get("dhcp_srvr3_ip"), srvrVrf=json_to_dict_have["vrfDhcp3"])
if cfg.get("dhcp_srvr3_vrf", None) is not None:
want_dhcp_servers[2].update({"srvrVrf": cfg.get("dhcp_srvr3_vrf")})
want_dhcp_servers = [srvr for srvr in want_dhcp_servers[:] if srvr is not None]
if want_dhcp_servers == []:
json_to_dict_want["dhcpServers"] = ""
else:
json_to_dict_want["dhcpServers"] = json_to_dict_have["dhcpServers"]
json_to_dict_want["dhcpServers"] = json.dumps(dict(dhcpServers=want_dhcp_servers), separators=(",", ":"))

if cfg.get("dhcp_loopback_id", None) is None:
json_to_dict_want["loopbackId"] = json_to_dict_have["loopbackId"]
Expand Down