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
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
|
#!/usr/bin/python
# -*- coding: utf-8 -*-
# Copyright 2023 Dell Inc. or its subsidiaries. All Rights Reserved
# GNU General Public License v3.0+
# (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
#############################################
# WARNING #
#############################################
#
# This file is auto generated by the resource
# module builder playbook.
#
# Do not edit this file manually.
#
# Changes to this file will be over written
# by the resource module builder.
#
# Changes should be made in the model used to
# generate this file or in the resource module
# builder template.
#
#############################################
"""
The module file for sonic_users
"""
from __future__ import absolute_import, division, print_function
__metaclass__ = type
DOCUMENTATION = """
---
module: sonic_users
version_added: 1.1.0
notes:
- Tested against Enterprise SONiC Distribution by Dell Technologies.
- Supports C(check_mode).
author: Niraimadaiselvam M (@niraimadaiselvamm)
short_description: Manage users and its parameters
description:
- This module provides configuration management of users parameters on devices running Enterprise SONiC.
options:
config:
description:
- Specifies the users related configuration.
type: list
elements: dict
suboptions:
name:
description:
- Specifies the name of the user.
type: str
required: true
role:
description:
- Specifies the role of the user.
type: str
choices:
- admin
- operator
- netadmin
- secadmin
password:
description:
- Specifies the password of the user.
type: str
update_password:
description:
- Specifies the update password flag.
- In case of always, password will be updated every time.
- In case of on_create, password will be updated only when user is created.
type: str
choices:
- always
- on_create
default: always
state:
description:
- Specifies the operation to be performed on the users configured on the device.
- In case of merged, the input configuration will be merged with the existing users configuration on the device.
- In case of deleted the existing users configuration will be removed from the device.
- In case of replaced, the existing specified user configuration will be replaced with provided configuration.
- In case of overridden, the existing users configuration will be overridden with the provided configuration.
default: merged
choices: ['merged', 'deleted', 'overridden', 'replaced']
type: str
"""
EXAMPLES = """
# Using deleted
#
# Before state:
# -------------
#
# sonic# show users configured
# ----------------------------------------------------------------------
# User Role(s)
# ----------------------------------------------------------------------
# admin admin
# sysadmin admin
# sysoperator operator
- name: Delete user
dellemc.enterprise_sonic.sonic_users:
config:
- name: sysoperator
state: deleted
# After state:
# ------------
#
# sonic# show users configured
# ----------------------------------------------------------------------
# User Role(s)
# ----------------------------------------------------------------------
# admin admin
# sysadmin admin
# Using deleted
#
# Before state:
# -------------
#
# sonic# show users configured
# ----------------------------------------------------------------------
# User Role(s)
# ----------------------------------------------------------------------
# admin admin
# sysadmin admin
# sysoperator operator
- name: Delete all users configurations except admin
dellemc.enterprise_sonic.sonic_users:
config:
state: deleted
# After state:
# ------------
#
# sonic# show users configured
# ----------------------------------------------------------------------
# User Role(s)
# ----------------------------------------------------------------------
# admin admin
# Using merged
#
# Before state:
# -------------
#
# sonic# show users configured
# ----------------------------------------------------------------------
# User Role(s)
# ----------------------------------------------------------------------
# admin admin
- name: Merge users configurations
dellemc.enterprise_sonic.sonic_users:
config:
- name: sysadmin
role: admin
password: admin
update_password: always
- name: sysoperator
role: operator
password: operator
update_password: always
state: merged
# After state:
# ------------
#
# sonic# show users configured
# ----------------------------------------------------------------------
# User Role(s)
# ----------------------------------------------------------------------
# admin admin
# sysadmin admin
# sysoperator operator
# Using Overridden
#
# Before state:
# -------------
#
# sonic# show users configured
# ----------------------------------------------------------------------
# User Role(s)
# ----------------------------------------------------------------------
# admin admin
# sysadmin admin
# sysoperator operator
- name: Override users configurations
dellemc.enterprise_sonic.sonic_users:
config:
- name: user1
role: secadmin
password: 123abc
update_password: always
state: overridden
# After state:
# ------------
#
# sonic# show users configured
# ----------------------------------------------------------------------
# User Role(s)
# ----------------------------------------------------------------------
# admin admin
# user1 secadmin
# Using Replaced
#
# Before state:
# -------------
#
# sonic# show users configured
# ----------------------------------------------------------------------
# User Role(s)
# ----------------------------------------------------------------------
# admin admin
# user1 secadmin
# user2 operator
- name: Replace users configurations
dellemc.enterprise_sonic.sonic_users:
config:
- name: user1
role: operator
password: 123abc
update_password: always
- name: user2
role: netadmin
password: 123abc
update_password: always
state: replaced
# After state:
# ------------
#
# sonic# show users configured
# ----------------------------------------------------------------------
# User Role(s)
# ----------------------------------------------------------------------
# admin admin
# user1 operator
# user2 netadmin
"""
RETURN = """
before:
description: The configuration prior to the model invocation.
returned: always
type: list
sample: >
The configuration returned will always be in the same format
of the parameters above.
after:
description: The resulting configuration model invocation.
returned: when changed
type: list
sample: >
The configuration returned will always be in the same format
of the parameters above.
after(generated):
description: The generated configuration model invocation.
returned: when C(check_mode)
type: list
sample: >
The configuration returned will always be in the same format
of the parameters above.
commands:
description: The set of commands pushed to the remote device.
returned: always
type: list
sample: ['command 1', 'command 2', 'command 3']
"""
from ansible.module_utils.basic import AnsibleModule
from ansible_collections.dellemc.enterprise_sonic.plugins.module_utils.network.sonic.argspec.users.users import UsersArgs
from ansible_collections.dellemc.enterprise_sonic.plugins.module_utils.network.sonic.config.users.users import Users
def main():
"""
Main entry point for module execution
:returns: the result form module invocation
"""
module = AnsibleModule(argument_spec=UsersArgs.argument_spec,
supports_check_mode=True)
result = Users(module).execute_module()
module.exit_json(**result)
if __name__ == '__main__':
main()
|
