Add a new network resource module nd_local_user for local users on Nexus Dashboard v4.1.0 or higher (DCNE-543) by gmicol · Pull Request #172 · CiscoDevNet/ansible-nd

gmicol · 2025-09-03T17:53:48Z

No description provided.

plugins/modules/nd_local_user.py

plugins/module_utils/nd_network_resources.py

anvitha-jain

Add comments to exaplain how the class works (or what is happening within the class)

plugins/module_utils/models/local_user_model.py

plugins/module_utils/nd_network_resources.py

plugins/modules/nd_local_user.py

plugins/module_utils/models/base.py

plugins/module_utils/models/local_user.py

plugins/module_utils/models/base.py

plugins/module_utils/models/local_user.py

- Add Pydantic-based NDBaseModel for network resource models - Add NDConfigCollection for type-safe config management with O(1) lookups - Add NDNetworkResourceModule base class for network resource modules - Add nd_local_user module as reference implementation - Supports merged/replaced/overridden/deleted states - Implements composition pattern with actions_overwrite_map Co-authored-by: Gaspard Micol <gmicol@cisco.com>

…e.py based on comments. Add a get method and get_identifier_value function to NDBaseModel.

…tion of core design adding new methods which will be used in NDConfigCollection and NDNetworkResourceModule classes as well as basic error handling and simple docstrings.

…ign changing existing methods and adding new ones which will be used in NDNetworkResourceModule class as well as basic error handling and simple docstrings.

…of core design changing existing methods and adding new ones which will be used in future as a based for ND network resource modules as well as basic error handling and simple docstrings.

…anges added to NDNetworkResourceModule.

…s for orchestrating crud api operations with model instances and endpoints.

… built-in functionalities. Slightly modify models/base.py to enforce identifiers definitions in NDBaseModel subclasses. Added multiple notes to assert next steps.

…rt endpoints and Pydantic models modification (works for merge and replace states). Add comments for next steps.

…/base.py.

…nts and changes to models/local_user.py and api_endpoints/base.py

…ons methods that work for single_identifier strategy (meant to be overridden if needed).

…or NDNestedModel. Add types.file. Various Renaming and small Modifications across the repo. WIP.

…i_endpoints. Adapt api_endpoints, models, orchestrators accordingly. Integration Tests passing for nd_local_user module. Still WIP.

…ome sanity issues.

…teration of (Mock Pydantic objects/methods) to pass sanity checks for Pydantic importation.

…n issues.

…y issues.

…accordingly

…NDStateMachineand add custom Exception for it in common/exceptions dir. Set json mode for to_diff_dict method in NDBaseModel.

mtarking · 2026-03-10T20:33:20Z

plugins/module_utils/endpoints/v1/infra_aaa_local_users.py

@@ -0,0 +1,179 @@
+# -*- coding: utf-8 -*-
+


endpoints dir structure to be refactored per Tuesday (3/10) standup

mtarking · 2026-03-10T20:33:48Z

plugins/module_utils/orchestrators/local_user.py

+from ansible_collections.cisco.nd.plugins.module_utils.models.local_user import LocalUserModel
+from ansible_collections.cisco.nd.plugins.module_utils.endpoints.base import NDBaseEndpoint
+from ansible_collections.cisco.nd.plugins.module_utils.orchestrators.types import ResponseType
+from ansible_collections.cisco.nd.plugins.module_utils.endpoints.v1.infra_aaa_local_users import (


Given we're doing the directory structures based on API version and resource categorization, I think we need to do that here for orchestrator.

mtarking · 2026-03-10T20:34:07Z

plugins/module_utils/nd.py

@@ -73,53 +72,27 @@ def cmp(a, b):


 def issubset(subset, superset):


Is the intention to import from module_utils/utils.py?

mtarking · 2026-03-10T20:34:22Z

plugins/module_utils/nd_state_machine.py

+        self.state = self.module.params["state"]
+
+        # Initialize collections
+        self.nd_config_collection = NDConfigCollection[self.model_class]


NDConfigCollection[self.model_class] returns a _GenericAlias at runtime, not a class. It happens to be callable (delegating to NDConfigCollection). I find this not to be obvious to readers/reviewers and is a subtle detail of generics that just works and don't see it provide any execution value since subsequent instantiations still require model_class to be passed explicitly. Is there a reason for line 44 that I'm missing vs just removing and using NDConfigCollection directly.

mtarking · 2026-03-10T20:34:35Z

plugins/module_utils/nd_state_machine.py

+        try:
+            response_data = self.model_orchestrator.query_all()
+            # State of configuration objects in ND before change execution
+            self.before = self.nd_config_collection.from_api_response(response_data=response_data, model_class=self.model_class)


self.before = NDConfigCollection.from_api_response(response_data=response_data, model_class=self.model_class) to go with previous comment.

mtarking · 2026-03-10T20:36:34Z

plugins/module_utils/common/exceptions.py

@@ -0,0 +1,17 @@
+# -*- coding: utf-8 -*-
+
+# Copyright: (c) 2025, Gaspard Micol (@gmicol) <gmicol@cisco.com>


mtarking · 2026-03-10T20:36:39Z

plugins/module_utils/nd_output.py

@@ -0,0 +1,69 @@
+# -*- coding: utf-8 -*-
+
+# Copyright: (c) 2025, Gaspard Micol (@gmicol) <gmicol@cisco.com>


mtarking · 2026-03-10T20:36:43Z

plugins/module_utils/nd_state_machine.py

@@ -0,0 +1,179 @@
+# -*- coding: utf-8 -*-
+
+# Copyright: (c) 2025, Gaspard Micol (@gmicol) <gmicol@cisco.com>


mtarking · 2026-03-10T20:36:48Z

plugins/module_utils/utils.py

@@ -0,0 +1,83 @@
+# -*- coding: utf-8 -*-
+
+# Copyright: (c) 2025, Gaspard Micol (@gmicol) <gmicol@cisco.com>


mtarking · 2026-03-10T20:36:51Z

plugins/modules/nd_local_user.py

+#!/usr/bin/python
+# -*- coding: utf-8 -*-
+
+# Copyright: (c) 2025, Gaspard Micol (@gmicol) <gmicol@cisco.com>


…nd local_user.py. Add method to NDBaseModel and apply relevant changes to nd_config_collection.

…ate asserts.

gmicol self-assigned this Sep 3, 2025

gmicol requested review from akinross, anvitha-jain, lhercot, sajagana and samiib as code owners September 3, 2025 17:53

gmicol added the jira-sync Sync this issue to Jira label Sep 3, 2025

gmicol requested a review from shrsr as a code owner September 3, 2025 17:53

github-actions bot changed the title ~~Add a new network resource module nd_local_user for local users on Nexus Dashboard v4.1.0 or higher~~ Add a new network resource module nd_local_user for local users on Nexus Dashboard v4.1.0 or higher (DCNE-543) Sep 3, 2025

gmicol force-pushed the add_network_ressource_nd_local_user branch from a4b3de7 to 6a9aefd Compare September 3, 2025 17:55

akinross reviewed Sep 4, 2025

View reviewed changes

gmicol force-pushed the add_network_ressource_nd_local_user branch 3 times, most recently from e38fee8 to df74fbf Compare September 5, 2025 19:48

gmicol force-pushed the add_network_ressource_nd_local_user branch from df74fbf to fe89c61 Compare September 22, 2025 17:45

anvitha-jain reviewed Oct 2, 2025

View reviewed changes

lhercot mentioned this pull request Nov 7, 2025

Add a new module nd_local_user for local users on Nexus Dashboard (DCNE-524) #168

Closed

gmicol force-pushed the add_network_ressource_nd_local_user branch 6 times, most recently from 4d04726 to 7c967c3 Compare December 18, 2025 14:17

gmicol requested review from akinross and anvitha-jain December 18, 2025 14:17

akinross requested changes Jan 16, 2026

View reviewed changes

akinross requested changes Jan 20, 2026

View reviewed changes

akinross requested changes Jan 23, 2026

View reviewed changes

gmicol added 12 commits February 26, 2026 10:47

[ignore] Pydantic Models: Modify and Clean both local_user.py and bas…

fe944d0

…e.py based on comments. Add a get method and get_identifier_value function to NDBaseModel.

[ignore] Pydantic ND base models and local_user models: Final proposi…

c4a4da2

…tion of core design adding new methods which will be used in NDConfigCollection and NDNetworkResourceModule classes as well as basic error handling and simple docstrings.

[ignore] Pydantic ND Config Collection: Final proposition of core des…

d518bf3

…ign changing existing methods and adding new ones which will be used in NDNetworkResourceModule class as well as basic error handling and simple docstrings.

[ignore] Pydantic Base ND Network Resource Module: Final proposition …

b35fa8d

…of core design changing existing methods and adding new ones which will be used in future as a based for ND network resource modules as well as basic error handling and simple docstrings.

[ignore] Modify nd_local_user based on Pydantic implementation and ch…

dc9649e

…anges added to NDNetworkResourceModule.

[ignore] Add api_endpoints for configuring endpoints and orchestrator…

dead722

…s for orchestrating crud api operations with model instances and endpoints.

[ignore] Modifiy models/local_user to take full advantage of Pydantic…

4b65c25

… built-in functionalities. Slightly modify models/base.py to enforce identifiers definitions in NDBaseModel subclasses. Added multiple notes to assert next steps.

[ignore] Adapt the Network Resource Module architecture for ND to sma…

229af5a

…rt endpoints and Pydantic models modification (works for merge and replace states). Add comments for next steps.

[ignore] Default to none and update condition for regarding in models…

b04a82b

…/base.py.

[ignore] Add choice for when no identifier is needed. Add quick comme…

48b62be

…nts and changes to models/local_user.py and api_endpoints/base.py

[ignore] Complete orchestrators/base.py by making simple CRUD operati…

e2101f9

…ons methods that work for single_identifier strategy (meant to be overridden if needed).

[ignore] Fix and in nd_config_collections.py. Move to utils.py.

b41b5b8

gmicol force-pushed the add_network_ressource_nd_local_user branch from 389f4c2 to b41b5b8 Compare February 26, 2026 15:48

gmicol added 9 commits February 26, 2026 14:01

[ignore] Rename NDNetworkResourceModule to NDStateMachine. Add file f…

9cdfa66

…or NDNestedModel. Add types.file. Various Renaming and small Modifications across the repo. WIP.

[ignore] Make a small change to NDModule request function.

df99ff3

[ignore] Modify nd_state_machine to work with orchestrators/models/ap…

96dde6c

…i_endpoints. Adapt api_endpoints, models, orchestrators accordingly. Integration Tests passing for nd_local_user module. Still WIP.

[ignore] Add proper path dependencies and Ran black formatting.

7afd933

[ignore] Clean code for sanity purposes (except Pydantic import checks.

08b011b

[ignore] Restructure api_endpoints folder into endpoints -> v1. Fix s…

8d72e06

…ome sanity issues.

[ignore] Remove NDModule inheritence from NDStateMachine. Add first i…

88c0bdf

…teration of (Mock Pydantic objects/methods) to pass sanity checks for Pydantic importation.

[ignore] Rename NDBaseSmartEndpoint to NDBaseEndpoint. Fix importatio…

25b621a

…n issues.

[ignore] Replace all pydantic imports with pydantic_compat. Fix sanit…

6e81ee0

…y issues.

gmicol requested a review from akinross March 5, 2026 00:38

gmicol added 2 commits March 6, 2026 13:35

[ignore] Add NDOutput class. Modify NDStateMachine and nd_local_user …

520625b

…accordingly

[ignore] Update NDOutput class. Remove all fail_json dependencies in …

cd8a631

…NDStateMachineand add custom Exception for it in common/exceptions dir. Set json mode for to_diff_dict method in NDBaseModel.

gmicol force-pushed the add_network_ressource_nd_local_user branch from 36d5759 to cd8a631 Compare March 10, 2026 18:07

mtarking requested changes Mar 10, 2026

View reviewed changes

mikewiebe mentioned this pull request Mar 11, 2026

Add Smart Endpoints framework for ND API v1 #186

Merged

3 tasks

gmicol added 2 commits March 11, 2026 11:48

[ignore] Fix serialization of model with minimal changes to base.py a…

225c3bc

…nd local_user.py. Add method to NDBaseModel and apply relevant changes to nd_config_collection.

[ignore] Complete nd_local_user integration test for creation and upd…

4f9e1c9

…ate asserts.

		@@ -73,53 +72,27 @@ def cmp(a, b):


		def issubset(subset, superset):

		@@ -0,0 +1,17 @@
		# -- coding: utf-8 --

		# Copyright: (c) 2025, Gaspard Micol (@gmicol) <gmicol@cisco.com>

		@@ -0,0 +1,69 @@
		# -- coding: utf-8 --

		# Copyright: (c) 2025, Gaspard Micol (@gmicol) <gmicol@cisco.com>

		@@ -0,0 +1,179 @@
		# -- coding: utf-8 --

		# Copyright: (c) 2025, Gaspard Micol (@gmicol) <gmicol@cisco.com>

		@@ -0,0 +1,83 @@
		# -- coding: utf-8 --

		# Copyright: (c) 2025, Gaspard Micol (@gmicol) <gmicol@cisco.com>

Conversation

gmicol commented Sep 3, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

anvitha-jain left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants