Debian Codegraph @

ansible_collections/netapp/ontap/plugins/modules/na_ontap_unix_user.py

raw
1 #!/usr/bin/python
2
3 # (c) 2018-2025, NetApp, Inc
4 # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
5
6 from __future__ import absolute_import, division, print_function
7 __metaclass__ = type
8
9
10 ANSIBLE_METADATA = {'metadata_version': '1.1',
11 'status': ['preview'],
12 'supported_by': 'community'}
13
14
15 DOCUMENTATION = '''
16
17 module: na_ontap_unix_user
18
19 short_description: NetApp ONTAP UNIX users
20 extends_documentation_fragment:
21 - netapp.ontap.netapp.na_ontap
22 version_added: 2.8.0
23 author: NetApp Ansible Team (@carchi8py) <[email protected]>
24
25 description:
26 - Create, delete or modify UNIX users local to ONTAP.
27
28 options:
29
30 state:
31 description:
32 - Whether the specified user should exist or not.
33 choices: ['present', 'absent']
34 type: str
35 default: 'present'
36
37 name:
38 description:
39 - Specifies user's UNIX account name.
40 - REST support requires ONTAP version 9.9.0 or later.
41 - Non-modifiable.
42 required: true
43 type: str
44
45 primary_gid:
46 description:
47 - Specifies the primary group identification number for the UNIX user.
48 - REST support requires ONTAP version 9.9.0 or later.
49 - Required for create, modifiable.
50 aliases: ['group_id']
51 type: int
52 version_added: 21.21.0
53
54 vserver:
55 description:
56 - Specifies the Vserver for the UNIX user.
57 - REST support requires ONTAP version 9.9.0 or later.
58 - Non-modifiable.
59 required: true
60 type: str
61
62 id:
63 description:
64 - Specifies an identification number for the UNIX user.
65 - REST support requires ONTAP version 9.9.0 or later.
66 - Required for create, modifiable.
67 type: int
68
69 full_name:
70 description:
71 - Specifies the full name of the UNIX user
72 - REST support requires ONTAP version 9.9.0 or later.
73 - Optional for create, modifiable.
74 type: str
75 '''
76
77 EXAMPLES = """
78 - name: Create UNIX User
79 netapp.ontap.na_ontap_unix_user:
80 state: present
81 name: SampleUser
82 vserver: ansibleVServer
83 group_id: 1
84 id: 2
85 full_name: Test User
86 hostname: "{{ netapp_hostname }}"
87 username: "{{ netapp_username }}"
88 password: "{{ netapp_password }}"
89
90 - name: Delete UNIX User
91 netapp.ontap.na_ontap_unix_user:
92 state: absent
93 name: SampleUser
94 vserver: ansibleVServer
95 hostname: "{{ netapp_hostname }}"
96 username: "{{ netapp_username }}"
97 password: "{{ netapp_password }}"
98 """
99
100 RETURN = """
101 """
102 import traceback
103
104 from ansible.module_utils.basic import AnsibleModule
105 from ansible.module_utils._text import to_native
106 import ansible_collections.netapp.ontap.plugins.module_utils.netapp as netapp_utils
107 from ansible_collections.netapp.ontap.plugins.module_utils.netapp_module import NetAppModule
108 from ansible_collections.netapp.ontap.plugins.module_utils.netapp import OntapRestAPI
109 from ansible_collections.netapp.ontap.plugins.module_utils import rest_generic
110
111
112 class NetAppOntapUnixUser:
113 """
114 Common operations to manage users and roles.
115 """
116
117 def __init__(self):
118 self.argument_spec = netapp_utils.na_ontap_host_argument_spec()
119 self.argument_spec.update(dict(
120 state=dict(required=False, type='str', choices=['present', 'absent'], default='present'),
121 name=dict(required=True, type='str'),
122 primary_gid=dict(required=False, type='int', aliases=['group_id']),
123 id=dict(required=False, type='int'),
124 full_name=dict(required=False, type='str'),
125 vserver=dict(required=True, type='str'),
126 ))
127
128 self.module = AnsibleModule(
129 argument_spec=self.argument_spec,
130 supports_check_mode=True
131 )
132
133 self.na_helper = NetAppModule()
134 self.parameters = self.na_helper.set_parameters(self.module.params)
135 # Set up Rest API
136 self.rest_api = OntapRestAPI(self.module)
137 self.use_rest = self.rest_api.is_rest()
138
139 if self.use_rest and not self.rest_api.meets_rest_minimum_version(self.use_rest, 9, 9, 0):
140 msg = 'REST requires ONTAP 9.9.0 or later for unix-users APIs.'
141 self.use_rest = self.na_helper.fall_back_to_zapi(self.module, msg, self.parameters)
142
143 if not self.use_rest:
144 if netapp_utils.has_netapp_lib() is False:
145 self.module.fail_json(msg=netapp_utils.netapp_lib_is_required())
146 self.server = netapp_utils.setup_na_ontap_zapi(module=self.module, vserver=self.parameters['vserver'])
147
148 def get_unix_user(self):
149 """
150 Checks if the UNIX user exists.
151
152 :return:
153 dict() if user found
154 None if user is not found
155 """
156 get_unix_user = netapp_utils.zapi.NaElement('name-mapping-unix-user-get-iter')
157 attributes = {
158 'query': {
159 'unix-user-info': {
160 'user-name': self.parameters['name'],
161 'vserver': self.parameters['vserver'],
162 }
163 }
164 }
165 get_unix_user.translate_struct(attributes)
166 try:
167 result = self.server.invoke_successfully(get_unix_user, enable_tunneling=True)
168 if result.get_child_by_name('num-records') and int(result.get_child_content('num-records')) >= 1:
169 user_info = result['attributes-list']['unix-user-info']
170 return {'primary_gid': int(user_info['group-id']),
171 'id': int(user_info['user-id']),
172 'full_name': user_info['full-name']}
173 return None
174 except netapp_utils.zapi.NaApiError as error:
175 self.module.fail_json(msg='Error getting UNIX user %s: %s' % (self.parameters['name'], to_native(error)),
176 exception=traceback.format_exc())
177
178 def create_unix_user(self):
179 """
180 Creates an UNIX user in the specified Vserver
181
182 :return: None
183 """
184 if self.parameters.get('primary_gid') is None or self.parameters.get('id') is None:
185 self.module.fail_json(msg='Error: Missing one or more required parameters for create: (primary_gid, id)')
186
187 user_create = netapp_utils.zapi.NaElement.create_node_with_children(
188 'name-mapping-unix-user-create', **{'user-name': self.parameters['name'],
189 'group-id': str(self.parameters['primary_gid']),
190 'user-id': str(self.parameters['id'])})
191 if self.parameters.get('full_name') is not None:
192 user_create.add_new_child('full-name', self.parameters['full_name'])
193
194 try:
195 self.server.invoke_successfully(user_create, enable_tunneling=True)
196 except netapp_utils.zapi.NaApiError as error:
197 self.module.fail_json(msg='Error creating UNIX user %s: %s' % (self.parameters['name'], to_native(error)),
198 exception=traceback.format_exc())
199
200 def delete_unix_user(self):
201 """
202 Deletes an UNIX user from a vserver
203
204 :return: None
205 """
206 user_delete = netapp_utils.zapi.NaElement.create_node_with_children(
207 'name-mapping-unix-user-destroy', **{'user-name': self.parameters['name']})
208
209 try:
210 self.server.invoke_successfully(user_delete, enable_tunneling=True)
211 except netapp_utils.zapi.NaApiError as error:
212 self.module.fail_json(msg='Error removing UNIX user %s: %s' % (self.parameters['name'], to_native(error)),
213 exception=traceback.format_exc())
214
215 def modify_unix_user(self, params):
216 user_modify = netapp_utils.zapi.NaElement.create_node_with_children(
217 'name-mapping-unix-user-modify', **{'user-name': self.parameters['name']})
218 for key in params:
219 if key == 'primary_gid':
220 user_modify.add_new_child('group-id', str(params['primary_gid']))
221 if key == 'id':
222 user_modify.add_new_child('user-id', str(params['id']))
223 if key == 'full_name':
224 user_modify.add_new_child('full-name', params['full_name'])
225
226 try:
227 self.server.invoke_successfully(user_modify, enable_tunneling=True)
228 except netapp_utils.zapi.NaApiError as error:
229 self.module.fail_json(msg='Error modifying UNIX user %s: %s' % (self.parameters['name'], to_native(error)),
230 exception=traceback.format_exc())
231
232 def get_unix_user_rest(self):
233 """
234 Retrieves UNIX user information for the specified user and SVM with rest API.
235 """
236 if not self.use_rest:
237 return self.get_unix_user()
238 query = {'svm.name': self.parameters.get('vserver'),
239 'name': self.parameters.get('name')}
240 api = 'name-services/unix-users'
241 fields = 'svm.uuid,id,primary_gid,name,full_name'
242 record, error = rest_generic.get_one_record(self.rest_api, api, query, fields)
243 if error:
244 self.module.fail_json(msg="Error on getting unix-user info: %s" % error)
245 if record:
246 return {
247 'svm': {'uuid': self.na_helper.safe_get(record, ['svm', 'uuid'])},
248 'name': self.na_helper.safe_get(record, ['name']),
249 'full_name': self.na_helper.safe_get(record, ['full_name']),
250 'id': self.na_helper.safe_get(record, ['id']),
251 'primary_gid': self.na_helper.safe_get(record, ['primary_gid']),
252 }
253 return None
254
255 def create_unix_user_rest(self):
256 """
257 Creates the local UNIX user configuration for an SVM with rest API.
258 """
259 if not self.use_rest:
260 return self.create_unix_user()
261
262 body = {'svm.name': self.parameters.get('vserver')}
263 for key in ('name', 'full_name', 'id', 'primary_gid'):
264 if key in self.parameters:
265 body[key] = self.parameters.get(key)
266 api = 'name-services/unix-users'
267 dummy, error = rest_generic.post_async(self.rest_api, api, body)
268 if error is not None:
269 self.module.fail_json(msg="Error on creating unix-user: %s" % error)
270
271 def delete_unix_user_rest(self, current):
272 """
273 Deletes a UNIX user configuration for the specified SVM with rest API.
274 """
275 if not self.use_rest:
276 return self.delete_unix_user()
277
278 api = 'name-services/unix-users/%s' % current['svm']['uuid']
279 dummy, error = rest_generic.delete_async(self.rest_api, api, self.parameters['name'])
280 if error is not None:
281 self.module.fail_json(msg="Error on deleting unix-user: %s" % error)
282
283 def modify_unix_user_rest(self, modify, current=None):
284 """
285 Updates UNIX user information for the specified user and SVM with rest API.
286 """
287 if not self.use_rest:
288 return self.modify_unix_user(modify)
289
290 query = {'svm.name': self.parameters.get('vserver')}
291 body = {}
292 for key in ('full_name', 'id', 'primary_gid'):
293 if key in modify:
294 body[key] = modify[key]
295 api = 'name-services/unix-users/%s' % current['svm']['uuid']
296 dummy, error = rest_generic.patch_async(self.rest_api, api, self.parameters['name'], body, query)
297 if error is not None:
298 self.module.fail_json(msg="Error on modifying unix-user: %s" % error)
299
300 def apply(self):
301 """
302 Invoke appropriate action based on playbook parameters
303
304 :return: None
305 """
306 cd_action = None
307 current = self.get_unix_user_rest()
308 cd_action = self.na_helper.get_cd_action(current, self.parameters)
309 modify = self.na_helper.get_modified_attributes(current, self.parameters) if cd_action is None else None
310 if self.na_helper.changed and not self.module.check_mode:
311 if cd_action == 'create':
312 self.create_unix_user_rest()
313 elif cd_action == 'delete':
314 self.delete_unix_user_rest(current)
315 else:
316 self.modify_unix_user_rest(modify, current)
317 result = netapp_utils.generate_result(self.na_helper.changed, cd_action, modify)
318 self.module.exit_json(**result)
319
320
321 def main():
322 obj = NetAppOntapUnixUser()
323 obj.apply()
324
325
326 if __name__ == '__main__':
327 main()