Debian Codegraph @

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

raw
1 #!/usr/bin/python
2
3 # (c) 2021-2026, 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 DOCUMENTATION = """
11 module: na_ontap_cifs_local_group_member
12 short_description: NetApp Ontap - Add or remove CIFS local group member
13 extends_documentation_fragment:
14 - netapp.ontap.netapp.na_ontap
15 version_added: '21.2.0'
16 author: NetApp Ansible Team (@carchi8py) <[email protected]>
17 description:
18 - Add or remove CIFS local group member
19 options:
20 state:
21 description:
22 - Whether the specified member should be part of the CIFS local group
23 choices: ['present', 'absent']
24 default: present
25 type: str
26
27 vserver:
28 description:
29 - Specifies the vserver that owns the CIFS local group
30 required: true
31 type: str
32
33 group:
34 description:
35 - Specifies name of the CIFS local group
36 required: true
37 type: str
38
39 member:
40 description:
41 - Specifies the name of the member
42 required: true
43 type: str
44
45 lambda_config:
46 description:
47 - Configuration parameters for AWS Lambda proxy functionality.
48 - These option and suboptions are only supported with REST.
49 type: dict
50 version_added: 23.4.0
51 suboptions:
52 function_name:
53 description:
54 - The name of the AWS Lambda function to invoke.
55 type: str
56 required: true
57 aws_region:
58 description:
59 - The name of the AWS region.
60 type: str
61 required: true
62 aws_profile:
63 description:
64 - The name of the AWS profile to use for authentication.
65 type: str
66
67 notes:
68 - Supports check_mode.
69 - Supported with ZAPI.
70 - Supported with REST starting with ONTAP 9.10.1.
71 - Supports AWS Lambda proxy functionality when using REST. See the README file for examples.
72 """
73
74 EXAMPLES = """
75 - name: Add member to CIFS local group
76 netapp.ontap.na_ontap_cifs_local_group_member:
77 state: present
78 vserver: svm1
79 group: BUILTIN\\administrators
80 member: DOMAIN\\Domain Admins
81 username: "{{ netapp_username }}"
82 password: "{{ netapp_password }}"
83 hostname: "{{ netapp_hostname }}"
84 ontapi: "{{ ontap_facts.ontap_version }}"
85 https: true
86 validate_certs: false
87
88 - name: Remove member from CIFS local group
89 netapp.ontap.na_ontap_cifs_local_group_member:
90 state: absent
91 vserver: svm1
92 group: BUILTIN\\administrators
93 member: DOMAIN\\Domain Admins
94 username: "{{ netapp_username }}"
95 password: "{{ netapp_password }}"
96 hostname: "{{ netapp_hostname }}"
97 ontapi: "{{ ontap_facts.ontap_version }}"
98 https: true
99 validate_certs: false
100 """
101
102 RETURN = """
103
104 """
105
106 import traceback
107
108 from ansible.module_utils.basic import AnsibleModule
109 from ansible.module_utils._text import to_native
110 import ansible_collections.netapp.ontap.plugins.module_utils.netapp as netapp_utils
111 from ansible_collections.netapp.ontap.plugins.module_utils.netapp_module import NetAppModule
112 from ansible_collections.netapp.ontap.plugins.module_utils import rest_generic
113
114
115 class NetAppOntapCifsLocalGroupMember:
116 """
117 Add or remove CIFS local group members
118 """
119 def __init__(self):
120 """
121 Initialize the Ontap CifsLocalGroupMember class
122 """
123
124 self.argument_spec = netapp_utils.na_ontap_host_argument_spec()
125 self.argument_spec.update(dict(
126 state=dict(required=False, choices=['present', 'absent'], default='present'),
127 vserver=dict(required=True, type='str'),
128 group=dict(required=True, type='str'),
129 member=dict(required=True, type='str')
130 ))
131 self.argument_spec.update(netapp_utils.na_ontap_lambda_argument_spec())
132 self.module = AnsibleModule(
133 argument_spec=self.argument_spec,
134 supports_check_mode=True,
135 required_if=[
136 ('use_lambda', True, ['lambda_config'])
137 ],
138 )
139
140 # set up variables
141 self.na_helper = NetAppModule()
142 self.parameters = self.na_helper.set_parameters(self.module.params)
143
144 self.rest_api = netapp_utils.OntapRestAPI(self.module)
145 self.use_rest = self.rest_api.is_rest()
146
147 if self.use_rest and not self.rest_api.meets_rest_minimum_version(self.use_rest, 9, 10, 1):
148 msg = 'REST requires ONTAP 9.10.1 or later for cifs_local_group_member APIs.'
149 self.use_rest = self.na_helper.fall_back_to_zapi(self.module, msg, self.parameters)
150 self.svm_uuid = None
151 self.sid = None
152
153 if not self.use_rest:
154 if self.parameters.get('use_lambda'):
155 self.module.fail_json(msg="Error: AWS Lambda proxy for ONTAP APIs is only supported with REST.")
156 if netapp_utils.has_netapp_lib() is False:
157 self.module.fail_json(msg="the python NetApp-Lib module is required")
158 self.server = netapp_utils.setup_na_ontap_zapi(module=self.module, vserver=self.parameters['vserver'])
159
160 def get_cifs_local_group_rest(self):
161 """
162 Retrieves the local group of an SVM.
163 """
164 api = "protocols/cifs/local-groups"
165 query = {
166 'name': self.parameters['group'],
167 'svm.name': self.parameters['vserver'],
168 'fields': 'svm.uuid,sid'
169 }
170 record, error = rest_generic.get_one_record(self.rest_api, api, query)
171 if error:
172 self.module.fail_json(msg="Error on fetching cifs local-group: %s" % error)
173 if record:
174 self.svm_uuid = self.na_helper.safe_get(record, ['svm', 'uuid'])
175 self.sid = self.na_helper.safe_get(record, ['sid'])
176 if record is None:
177 self.module.fail_json(
178 msg='CIFS local group %s does not exist on vserver %s' %
179 (self.parameters['group'], self.parameters['vserver'])
180 )
181
182 def get_cifs_local_group_member(self):
183 """
184 Retrieves local users, Active Directory users and
185 Active Directory groups which are members of the specified local group and SVM.
186 """
187 return_value = None
188
189 if self.use_rest:
190 self.get_cifs_local_group_rest()
191 api = 'protocols/cifs/local-groups/%s/%s/members' % (self.svm_uuid, self.sid)
192 query = {
193 'name': self.parameters['member'],
194 'svm.name': self.parameters['vserver'],
195 'fields': 'name',
196 }
197 record, error = rest_generic.get_one_record(self.rest_api, api, query)
198 if error:
199 self.module.fail_json(
200 msg='Error getting CIFS local group members for group %s on vserver %s: %s' %
201 (self.parameters['group'], self.parameters['vserver'], to_native(error)), exception=traceback.format_exc()
202 )
203
204 if record:
205 return {
206 'member': self.na_helper.safe_get(record, ['name'])
207 }
208 return record
209
210 else:
211 group_members_get_iter = netapp_utils.zapi.NaElement('cifs-local-group-members-get-iter')
212 group_members_info = netapp_utils.zapi.NaElement('cifs-local-group-members')
213 group_members_info.add_new_child('group-name', self.parameters['group'])
214 group_members_info.add_new_child('vserver', self.parameters['vserver'])
215 group_members_info.add_new_child('member', self.parameters['member'])
216 query = netapp_utils.zapi.NaElement('query')
217 query.add_child_elem(group_members_info)
218 group_members_get_iter.add_child_elem(query)
219
220 try:
221 result = self.server.invoke_successfully(group_members_get_iter, True)
222 if result.get_child_by_name('attributes-list'):
223 group_member_policy_attributes = result['attributes-list']['cifs-local-group-members']
224
225 return_value = {
226 'group': group_member_policy_attributes['group-name'],
227 'member': group_member_policy_attributes['member'],
228 'vserver': group_member_policy_attributes['vserver']
229 }
230
231 except netapp_utils.zapi.NaApiError as error:
232 self.module.fail_json(
233 msg='Error getting CIFS local group members for group %s on vserver %s: %s' %
234 (self.parameters['group'], self.parameters['vserver'], to_native(error)), exception=traceback.format_exc()
235 )
236
237 return return_value
238
239 def add_cifs_local_group_member(self):
240 """
241 Adds a member to a CIFS local group
242 """
243 if self.use_rest:
244 api = 'protocols/cifs/local-groups/%s/%s/members' % (self.svm_uuid, self.sid)
245 body = {'name': self.parameters['member']}
246 dummy, error = rest_generic.post_async(self.rest_api, api, body)
247 if error:
248 self.module.fail_json(
249 msg='Error adding member %s to cifs local group %s on vserver %s: %s' %
250 (self.parameters['member'], self.parameters['group'], self.parameters['vserver'], to_native(error)), exception=traceback.format_exc()
251 )
252
253 else:
254 group_members_obj = netapp_utils.zapi.NaElement("cifs-local-group-members-add-members")
255 group_members_obj.add_new_child("group-name", self.parameters['group'])
256 member_names = netapp_utils.zapi.NaElement("member-names")
257 member_names.add_new_child('cifs-name', self.parameters['member'])
258 group_members_obj.add_child_elem(member_names)
259
260 try:
261 self.server.invoke_successfully(group_members_obj, True)
262 except netapp_utils.zapi.NaApiError as error:
263 self.module.fail_json(
264 msg='Error adding member %s to cifs local group %s on vserver %s: %s' %
265 (self.parameters['member'], self.parameters['group'], self.parameters['vserver'], to_native(error)), exception=traceback.format_exc()
266 )
267
268 def remove_cifs_local_group_member(self):
269 """
270 Removes a member from a CIFS local group
271 """
272 if self.use_rest:
273 api = 'protocols/cifs/local-groups/%s/%s/members' % (self.svm_uuid, self.sid)
274 body = {'name': self.parameters['member']}
275 dummy, error = rest_generic.delete_async(self.rest_api, api, None, body)
276 if error:
277 self.module.fail_json(
278 msg='Error removing member %s from cifs local group %s on vserver %s: %s' %
279 (self.parameters['member'], self.parameters['group'], self.parameters['vserver'], to_native(error)), exception=traceback.format_exc()
280 )
281
282 else:
283 group_members_obj = netapp_utils.zapi.NaElement("cifs-local-group-members-remove-members")
284 group_members_obj.add_new_child("group-name", self.parameters['group'])
285 member_names = netapp_utils.zapi.NaElement("member-names")
286 member_names.add_new_child('cifs-name', self.parameters['member'])
287 group_members_obj.add_child_elem(member_names)
288
289 try:
290 self.server.invoke_successfully(group_members_obj, True)
291 except netapp_utils.zapi.NaApiError as error:
292 self.module.fail_json(
293 msg='Error removing member %s from cifs local group %s on vserver %s: %s' %
294 (self.parameters['member'], self.parameters['group'], self.parameters['vserver'], to_native(error)), exception=traceback.format_exc()
295 )
296
297 def apply(self):
298 current = self.get_cifs_local_group_member()
299 cd_action = self.na_helper.get_cd_action(current, self.parameters)
300 if self.na_helper.changed:
301 if not self.module.check_mode:
302 if cd_action == 'create':
303 self.add_cifs_local_group_member()
304 elif cd_action == 'delete':
305 self.remove_cifs_local_group_member()
306 result = netapp_utils.generate_result(self.na_helper.changed, cd_action)
307 self.module.exit_json(**result)
308
309
310 def main():
311 """
312 Creates the NetApp Ontap Cifs Local Group Member object and runs the correct play task
313 """
314 obj = NetAppOntapCifsLocalGroupMember()
315 obj.apply()
316
317
318 if __name__ == '__main__':
319 main()