summaryrefslogtreecommitdiffstats
path: root/ansible_collections/cisco/dnac/plugins/modules/user.py
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-06-26 06:22:20 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-06-26 06:22:20 +0000
commit18bd2207b6c1977e99a93673a7be099e23f0f547 (patch)
tree40fd9e5913462a88be6ba24be6953383c5b39874 /ansible_collections/cisco/dnac/plugins/modules/user.py
parentReleasing progress-linux version 10.0.1+dfsg-1~progress7.99u1. (diff)
downloadansible-18bd2207b6c1977e99a93673a7be099e23f0f547.tar.xz
ansible-18bd2207b6c1977e99a93673a7be099e23f0f547.zip
Merging upstream version 10.1.0+dfsg.
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'ansible_collections/cisco/dnac/plugins/modules/user.py')
-rw-r--r--ansible_collections/cisco/dnac/plugins/modules/user.py35
1 files changed, 26 insertions, 9 deletions
diff --git a/ansible_collections/cisco/dnac/plugins/modules/user.py b/ansible_collections/cisco/dnac/plugins/modules/user.py
index 4567de33d..230211eec 100644
--- a/ansible_collections/cisco/dnac/plugins/modules/user.py
+++ b/ansible_collections/cisco/dnac/plugins/modules/user.py
@@ -9,10 +9,11 @@ DOCUMENTATION = r"""
module: user
short_description: Resource module for User
description:
-- Manage operations create and update of the resource User.
-- Add a new user for Cisco DNA Center system.
-- Update a user for Cisco DNA Center system.
-version_added: '6.7.0'
+- Manage operations create, update and delete of the resource User.
+- Add a new user for Cisco DNA Center System.
+- Delete a user from Cisco DNA Center System.
+- Update a user for Cisco DNA Center System.
+version_added: '3.1.0'
extends_documentation_fragment:
- cisco.dnac.module
author: Rafael Campos (@racampos)
@@ -40,22 +41,27 @@ options:
description: Username.
type: str
requirements:
-- dnacentersdk >= 2.6.0
-- python >= 3.9
+- dnacentersdk >= 2.7.1
+- python >= 3.5
seealso:
- name: Cisco DNA Center documentation for User and Roles AddUserAPI
description: Complete reference of the AddUserAPI API.
link: https://developer.cisco.com/docs/dna-center/#!add-user-api
+- name: Cisco DNA Center documentation for User and Roles DeleteUserAPI
+ description: Complete reference of the DeleteUserAPI API.
+ link: https://developer.cisco.com/docs/dna-center/#!delete-user-api
- name: Cisco DNA Center documentation for User and Roles UpdateUserAPI
description: Complete reference of the UpdateUserAPI API.
link: https://developer.cisco.com/docs/dna-center/#!update-user-api
notes:
- SDK Method used are
- user_and_roles.UserandRoles.add_user_ap_i,
- user_and_roles.UserandRoles.update_user_ap_i,
+ userand_roles.UserandRoles.add_user_api,
+ userand_roles.UserandRoles.delete_user_api,
+ userand_roles.UserandRoles.update_user_api,
- Paths used are
post /dna/system/api/v1/user,
+ delete /dna/system/api/v1/user/{userId},
put /dna/system/api/v1/user,
"""
@@ -97,8 +103,19 @@ EXAMPLES = r"""
userId: string
username: string
-"""
+- name: Delete by id
+ cisco.dnac.user:
+ dnac_host: "{{dnac_host}}"
+ dnac_username: "{{dnac_username}}"
+ dnac_password: "{{dnac_password}}"
+ dnac_verify: "{{dnac_verify}}"
+ dnac_port: "{{dnac_port}}"
+ dnac_version: "{{dnac_version}}"
+ dnac_debug: "{{dnac_debug}}"
+ state: absent
+ userId: string
+"""
RETURN = r"""
dnac_response:
description: A dictionary or list with the response returned by the Cisco DNAC Python SDK