blob: 839c3ba53c5f766b463b36e7eb1e2fd9371b7b72 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
|
#!/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_info
short_description: Information module for User
description:
- Get all User.
- Get all users for the Cisco DNA Center System.
version_added: '3.1.0'
extends_documentation_fragment:
- cisco.dnac.module_info
author: Rafael Campos (@racampos)
options:
headers:
description: Additional headers.
type: dict
invokeSource:
description:
- >
InvokeSource query parameter. The source that invokes this API. The value of this query parameter must be
set to "external".
type: str
authSource:
description:
- >
AuthSource query parameter. The source that authenticates the user. The value of this query parameter can be
set to "internal" or "external". If not provided, then all users will be returned in the response.
type: str
requirements:
- dnacentersdk >= 2.7.1
- python >= 3.5
seealso:
- name: Cisco DNA Center documentation for User and Roles GetUsersAPI
description: Complete reference of the GetUsersAPI API.
link: https://developer.cisco.com/docs/dna-center/#!get-users-api
notes:
- SDK Method used are
userand_roles.UserandRoles.get_users_api,
- Paths used are
get /dna/system/api/v1/user,
"""
EXAMPLES = r"""
- name: Get all User
cisco.dnac.user_info:
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}}"
headers: "{{my_headers | from_json}}"
invokeSource: string
authSource: string
register: result
"""
RETURN = r"""
dnac_response:
description: A dictionary or list with the response returned by the Cisco DNAC Python SDK
returned: always
type: dict
sample: >
{
"users": [
{
"firstName": "string",
"lastName": "string",
"authSource": "string",
"passphraseUpdateTime": "string",
"roleList": [
"string"
],
"userId": "string",
"email": "string",
"username": "string"
}
]
}
"""
|
