Debian Codegraph @

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

raw
1 #!/usr/bin/python
2
3 # (c) 2022-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 DOCUMENTATION = """
10 module: na_ontap_cifs_local_group
11 short_description: NetApp Ontap - create, delete or modify CIFS local group.
12 extends_documentation_fragment:
13 - netapp.ontap.netapp.na_ontap_rest
14 version_added: '22.1.0'
15 author: NetApp Ansible Team (@carchi8py) <[email protected]>
16 description:
17 - Create, delete or modify CIFS local group.
18 options:
19 state:
20 description:
21 - Whether the specified member should be part of the CIFS local group
22 choices: ['present', 'absent']
23 default: present
24 type: str
25
26 vserver:
27 description:
28 - Specifies the vserver that owns the CIFS local group
29 required: true
30 type: str
31
32 name:
33 description:
34 - Specifies name of the CIFS local group
35 required: true
36 type: str
37
38 from_name:
39 description:
40 - Specifies the existing cifs local group name.
41 - This option is used to rename cifs local group.
42 type: str
43
44 description:
45 description:
46 - Description for the local group.
47 type: str
48
49 lambda_config:
50 description:
51 - Configuration parameters for AWS Lambda proxy functionality.
52 - These option and suboptions are only supported with REST.
53 type: dict
54 version_added: 23.4.0
55 suboptions:
56 function_name:
57 description:
58 - The name of the AWS Lambda function to invoke.
59 type: str
60 required: true
61 aws_region:
62 description:
63 - The name of the AWS region.
64 type: str
65 required: true
66 aws_profile:
67 description:
68 - The name of the AWS profile to use for authentication.
69 type: str
70
71 notes:
72 - Supports AWS Lambda proxy functionality when using REST. See the README file for examples.
73 """
74
75 EXAMPLES = """
76 - name: Create CIFS local group
77 netapp.ontap.na_ontap_cifs_local_group:
78 state: present
79 vserver: svm1
80 name: BUILTIN\\administrators
81 username: "{{ netapp_username }}"
82 password: "{{ netapp_password }}"
83 hostname: "{{ netapp_hostname }}"
84 https: true
85 validate_certs: false
86
87 - name: Delete CIFS local group
88 netapp.ontap.na_ontap_cifs_local_group:
89 state: absent
90 vserver: svm1
91 name: BUILTIN\\administrators
92 username: "{{ netapp_username }}"
93 password: "{{ netapp_password }}"
94 hostname: "{{ netapp_hostname }}"
95 https: true
96 validate_certs: false
97
98 - name: Modify CIFS local group description
99 netapp.ontap.na_ontap_cifs_local_group:
100 state: present
101 vserver: svm1
102 name: BUILTIN\\administrators
103 descrition: 'CIFS local group'
104 username: "{{ netapp_username }}"
105 password: "{{ netapp_password }}"
106 hostname: "{{ netapp_hostname }}"
107 https: true
108 validate_certs: false
109
110 - name: Rename CIFS local group description
111 netapp.ontap.na_ontap_cifs_local_group:
112 state: present
113 vserver: svm1
114 name: ANSIBLE_CIFS\\test_users
115 descrition: 'CIFS local group'
116 username: "{{ netapp_username }}"
117 password: "{{ netapp_password }}"
118 hostname: "{{ netapp_hostname }}"
119 https: true
120 validate_certs: false
121 """
122
123 RETURN = """
124
125 """
126
127 from ansible.module_utils.basic import AnsibleModule
128 import ansible_collections.netapp.ontap.plugins.module_utils.netapp as netapp_utils
129 from ansible_collections.netapp.ontap.plugins.module_utils.netapp_module import NetAppModule
130 from ansible_collections.netapp.ontap.plugins.module_utils import rest_generic
131
132
133 class NetAppOntapCifsLocalGroup:
134 """
135 Create, delete or modify CIFS local group
136 """
137 def __init__(self):
138 """
139 Initialize the Ontap CifsLocalGroup class
140 """
141
142 self.argument_spec = netapp_utils.na_ontap_rest_only_spec()
143 self.argument_spec.update(dict(
144 state=dict(required=False, choices=['present', 'absent'], default='present'),
145 vserver=dict(required=True, type='str'),
146 name=dict(required=True, type='str'),
147 description=dict(required=False, type='str'),
148 from_name=dict(required=False, type='str'),
149 ))
150 self.argument_spec.update(netapp_utils.na_ontap_lambda_argument_spec())
151 self.module = AnsibleModule(
152 argument_spec=self.argument_spec,
153 supports_check_mode=True,
154 required_if=[
155 ('use_lambda', True, ['lambda_config'])
156 ],
157 )
158
159 # set up variables
160 self.na_helper = NetAppModule()
161 self.parameters = self.na_helper.set_parameters(self.module.params)
162
163 self.rest_api = netapp_utils.OntapRestAPI(self.module)
164 self.rest_api.fail_if_not_rest_minimum_version('na_ontap_cifs_local_group', 9, 10, 1)
165 self.svm_uuid = None
166 self.sid = None
167
168 def get_cifs_local_group_rest(self, from_name=None):
169 """
170 Retrieves the local group of an SVM.
171 """
172 api = "protocols/cifs/local-groups"
173 query = {
174 'name': from_name or self.parameters['name'],
175 'svm.name': self.parameters['vserver'],
176 'fields': 'svm.uuid,sid,description'
177 }
178 record, error = rest_generic.get_one_record(self.rest_api, api, query)
179 if error:
180 self.module.fail_json(msg="Error on fetching cifs local-group: %s" % error)
181 if record:
182 self.svm_uuid = self.na_helper.safe_get(record, ['svm', 'uuid'])
183 self.sid = self.na_helper.safe_get(record, ['sid'])
184 return {
185 'name': self.na_helper.safe_get(record, ['name']),
186 'description': record.get('description', ''),
187 }
188 return None
189
190 def create_cifs_local_group_rest(self):
191 """
192 Creates the local group of an SVM.
193 """
194 api = "protocols/cifs/local-groups"
195 body = {
196 'name': self.parameters['name'],
197 'svm.name': self.parameters['vserver']
198 }
199 if 'description' in self.parameters:
200 body['description'] = self.parameters['description']
201 record, error = rest_generic.post_async(self.rest_api, api, body)
202 if error:
203 self.module.fail_json(msg="Error on creating cifs local-group: %s" % error)
204
205 def delete_cifs_local_group_rest(self):
206 """
207 Destroy the local group of an SVM.
208 """
209 api = "protocols/cifs/local-groups/%s/%s" % (self.svm_uuid, self.sid)
210 record, error = rest_generic.delete_async(self.rest_api, api, None)
211 if error:
212 self.module.fail_json(msg="Error on deleting cifs local-group: %s" % error)
213
214 def modify_cifs_local_group_rest(self, modify):
215 """
216 Modify the description of CIFS local group.
217 Rename cifs local group.
218 """
219 body = {}
220 if 'description' in modify:
221 body['description'] = self.parameters['description']
222 if 'name' in modify:
223 body['name'] = self.parameters['name']
224 api = "protocols/cifs/local-groups/%s/%s" % (self.svm_uuid, self.sid)
225 dummy, error = rest_generic.patch_async(self.rest_api, api, None, body)
226 if error is not None:
227 self.module.fail_json(msg="Error on modifying cifs local-group: %s" % error)
228
229 def apply(self):
230 current = self.get_cifs_local_group_rest()
231 rename = None
232 cd_action = self.na_helper.get_cd_action(current, self.parameters)
233 if cd_action == 'create' and 'from_name' in self.parameters:
234 group_info = self.get_cifs_local_group_rest(self.parameters['from_name'])
235 rename = self.na_helper.is_rename_action(group_info, current)
236 if rename:
237 current = group_info
238 cd_action = None
239 else:
240 self.module.fail_json(msg='Error renaming cifs local group: %s - no cifs local group with from_name: %s.'
241 % (self.parameters['name'], self.parameters['from_name']))
242 modify = self.na_helper.get_modified_attributes(current, self.parameters) if cd_action is None else None
243 if not rename and modify and 'name' in modify:
244 # avoid rename action if domain is not given in group name input
245 del modify['name']
246 if not modify:
247 self.na_helper.changed = False
248 if self.na_helper.changed and not self.module.check_mode:
249 if cd_action == 'create':
250 self.create_cifs_local_group_rest()
251 elif cd_action == 'delete':
252 self.delete_cifs_local_group_rest()
253 if modify or rename:
254 self.modify_cifs_local_group_rest(modify)
255 result = netapp_utils.generate_result(self.na_helper.changed, cd_action)
256 self.module.exit_json(**result)
257
258
259 def main():
260 """
261 Creates the NetApp Ontap Cifs Local Group object and runs the correct play task
262 """
263 obj = NetAppOntapCifsLocalGroup()
264 obj.apply()
265
266
267 if __name__ == '__main__':
268 main()