#!/usr/bin/python # -*- coding: utf-8 -*- # Copyright (c) 2021, Cisco Systems # GNU General Public License v3.0+ (see LICENSE or https://www.gnu.org/licenses/gpl-3.0.txt) DOCUMENTATION = r""" --- module: user short_description: Resource module for User description: - 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) options: email: description: Email. type: str firstName: description: First Name. type: str lastName: description: Last Name. type: str password: description: Password. type: str roleList: description: Role id list. elements: str type: list userId: description: User Id. type: str username: description: Username. type: str requirements: - 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 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, """ EXAMPLES = r""" - name: Create 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: present email: string firstName: string lastName: string password: string roleList: - string username: string - name: Update all 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: present email: string firstName: string lastName: string roleList: - string 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 returned: always type: dict sample: > { "message": "string", "userId": "string" } """