Add a new module nd_local_user for local users on Nexus Dashboard (DCNE-524) by gmicol · Pull Request #168 · CiscoDevNet/ansible-nd

gmicol · 2025-08-19T16:46:53Z

This module is only supported on ND v.4.1.0 or higher.

…s Dashboard v4.1.0 or higher.

sajagana · 2025-08-20T12:11:07Z

plugins/modules/nd_local_user.py

+- name: Query all local users
+  cisco.nd.nd_local_user:
+    state: query
+  register: all_keys


Suggested change

register: all_keys

register: query_all

sajagana · 2025-08-20T12:13:00Z

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

+    - ansible_local_user
+    - ansible_local_user_2
+
+#CREATE


Suggested change

#CREATE

# CREATE

Fix all other places.

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

sajagana · 2025-08-20T12:18:50Z

plugins/modules/nd_local_user.py

+    elif state == "absent":
+        if nd.existing:
+            if not module.check_mode:
+                nd.request(path="{0}/{1}".format(path, login_id), method="DELETE")


Can you use updated_path instead of formatting the path again?

you're right, forgot to fix that

sajagana · 2025-08-20T12:20:31Z

plugins/modules/nd_local_user.py

+---
+module: nd_local_user
+version_added: "1.4.0"
+short_description: Manage local users on Nexus Dashboard


Suggested change

short_description: Manage local users on Nexus Dashboard

short_description: Manage local users on Cisco Nexus Dashboard

shrsr · 2025-08-20T16:57:00Z

plugins/modules/nd_local_user.py

+    state: query
+  register: query_all
+
+- name: Delete an local user


Can we change to?
Delete a local user

shrsr · 2025-08-20T16:59:50Z

plugins/modules/nd_local_user.py

+
+        if not module.check_mode:
+            if nd.existing:
+                nd.existing = nd.request(path=updated_path, method="PUT", data=payload)


Is PUT op called even for the same configuration?
If yes, shall we leverage get_diff()?

Added get_diff() function for pre-checking PUT operation

shrsr · 2025-08-20T17:00:38Z

plugins/modules/nd_local_user.py

+                },
+            }
+        if reuse_limitation or time_interval_limitation:
+            payload["passwordPolicy"] = sanitize_dict(


Is sanitize_dict() required here when we sanitize the entire payload in the next step?

It's required as nd.sanitize() is not recursive and just sanitize one level deep which is not enough in this case. Maybe, we should address this issue in the future so that the nd.sanitize() can be recursive as well

shrsr · 2025-08-20T17:06:07Z

plugins/modules/nd_local_user.py

+    suboptions:
+      name:
+        description:
+        - The name of the Security Domain to which give the local user access.


Can we please change this to... if it's more meaningful?

The name of the Security Domain to which the local user is given access.

…ance Documentation and test file.

shrsr

LGTM

akinross · 2025-08-21T19:03:02Z

plugins/modules/nd_local_user.py

+    state: present
+  register: result
+
+- name: Create local user with minimal configuration


Is this a new standard? It's not that I disagree with it, but should we then track this as new thing we want to introduce to all our modules?

This is something that was introduced with the new nd_api_key module. So I thought this has become the new standard but if not, we should discuss if we should add this creation task with minimum config in the EXAMPLES section.
I think this is interesting to have as it makes visually clearer what attributes are required when creating a new object.
@sajagana, @shrsr, @samiib, @lhercot, @anvitha-jain what do you think?

I have no preference on this

akinross · 2025-08-21T19:10:39Z

plugins/modules/nd_local_user.py

+
+    path = "/api/v1/infra/aaa/localUsers"
+    if login_id:
+        updated_path = "{0}/{1}".format(path, login_id)


can we rename this to login_id_path or something? think updated is to generic

akinross · 2025-08-21T19:13:20Z

plugins/modules/nd_local_user.py

+            payload["rbac"] = {
+                "domains": {
+                    security_domain.get("name"): {
+                        "roles": [USER_ROLES_MAPPING.get(role) for role in security_domain["roles"]] if isinstance(security_domain.get("roles"), list) else [],


is empty list required to be set in roles, or should we also sanitize this part?

This is the only way I found to provide an empty list of roles assigned to a security domain. Assigning an None value to "roles" or sanitizing the key will result in an API error.
Also, as providing an empty list works, I wonder if this is a normal behavior or a bug as it seems weird to not assign any role to a local user for a security domain.

…ule.

shrsr

LGTM

sajagana

LGTM!

anvitha-jain

LGTM

akinross

LGTM

samiib · 2025-08-27T13:10:32Z

plugins/modules/nd_local_user.py

+short_description: Manage local users on Cisco Nexus Dashboard
+description:
+- Manage local users on Cisco Nexus Dashboard (ND).
+- It supports creating, updating, querying, and deleting local users.


Suggested change

- It supports creating, updating, querying, and deleting local users.

- This module supports creating, updating, querying, and deleting local users.

samiib · 2025-08-27T13:22:37Z

plugins/modules/nd_local_user.py

+- cisco.nd.modules
+- cisco.nd.check_mode
+notes:
+- This module is only supported on Nexus Dashboard having version 4.1.0 or higher.


Should this note be in the module description instead?

- This module is only supported on ND v4.1.0 and later.

Our ansible-mso modules are worded like this, should we keep it similar?

shrsr

LGTM

anvitha-jain · 2025-08-28T16:13:38Z

plugins/modules/nd_local_user.py

+- name: Create local user with minimal configuration
+  cisco.nd.nd_local_user:
+    login_id: local_user_min
+    user_password: localUserMinuser_password


Can we use one of the ways? - either camelCase or snake ?

anvitha-jain

LGTM

akinross

LGTM

sajagana

LGTM!

lhercot · 2025-11-07T01:45:20Z

Closing this PR as #172 is a superseeding PR.

gmicol self-assigned this Aug 19, 2025

gmicol requested review from akinross, anvitha-jain, lhercot, sajagana, samiib and shrsr as code owners August 19, 2025 16:46

gmicol added enhancement New feature or request jira-sync Sync this issue to Jira labels Aug 19, 2025

[minor_change] Add a new module nd_local_user for local users on Nexu…

60f2d00

…s Dashboard v4.1.0 or higher.

gmicol force-pushed the add_nd_local_user branch from 2585919 to 60f2d00 Compare August 19, 2025 16:52

lhercot added jira-sync Sync this issue to Jira and removed jira-sync Sync this issue to Jira labels Aug 19, 2025

github-actions bot changed the title ~~Add a new module nd_local_user for local users on Nexus Dashboard~~ Add a new module nd_local_user for local users on Nexus Dashboard (DCNE-524) Aug 19, 2025

sajagana requested changes Aug 20, 2025

View reviewed changes

[ignore] Small adjustments to nd_local_users module and test file.

5563927

gmicol requested a review from sajagana August 20, 2025 14:36

shrsr requested changes Aug 20, 2025

View reviewed changes

[ignore] Add get_diff to nd_local_user module for updating tasks. Enh…

8d8666c

…ance Documentation and test file.

gmicol requested a review from shrsr August 21, 2025 16:39

shrsr approved these changes Aug 21, 2025

View reviewed changes

akinross requested changes Aug 21, 2025

View reviewed changes

[ignore] Replace updated_path with login_id_path in nd_local_user mod…

6719346

…ule.

gmicol requested review from akinross and shrsr August 22, 2025 16:33

shrsr approved these changes Aug 25, 2025

View reviewed changes

sajagana approved these changes Aug 25, 2025

View reviewed changes

anvitha-jain approved these changes Aug 26, 2025

View reviewed changes

akinross approved these changes Aug 26, 2025

View reviewed changes

samiib requested changes Aug 27, 2025

View reviewed changes

gmicol requested review from akinross, anvitha-jain, sajagana, samiib and shrsr August 27, 2025 17:51

samiib approved these changes Aug 27, 2025

View reviewed changes

shrsr approved these changes Aug 28, 2025

View reviewed changes

anvitha-jain requested changes Aug 28, 2025

View reviewed changes

[ignore] Add small changes to nd_local_user Documentation.

5454245

gmicol force-pushed the add_nd_local_user branch from 372cb3c to 5454245 Compare August 29, 2025 17:33

gmicol requested a review from anvitha-jain August 29, 2025 17:34

anvitha-jain approved these changes Sep 2, 2025

View reviewed changes

akinross approved these changes Sep 3, 2025

View reviewed changes

sajagana approved these changes Sep 6, 2025

View reviewed changes

lhercot closed this Nov 7, 2025

	short_description: Manage local users on Nexus Dashboard
	short_description: Manage local users on Cisco Nexus Dashboard

	- It supports creating, updating, querying, and deleting local users.
	- This module supports creating, updating, querying, and deleting local users.

Conversation

gmicol commented Aug 19, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

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!

shrsr left a comment

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!

shrsr left a comment

Choose a reason for hiding this comment

Uh oh!

sajagana left a comment

Choose a reason for hiding this comment

Uh oh!

anvitha-jain left a comment

Choose a reason for hiding this comment

Uh oh!

akinross left a comment

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!

shrsr left a comment

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!

anvitha-jain left a comment

Choose a reason for hiding this comment

Uh oh!

akinross left a comment

Choose a reason for hiding this comment

Uh oh!

sajagana left a comment

Choose a reason for hiding this comment

Uh oh!

lhercot commented Nov 7, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone