Debian Codegraph @

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

raw
1 #!/usr/bin/python
2
3 # (c) 2019-2024, NetApp, Inc
4 # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
5
6 '''
7 na_ontap_object_store
8 '''
9
10 from __future__ import absolute_import, division, print_function
11 __metaclass__ = type
12
13
14 DOCUMENTATION = '''
15
16 module: na_ontap_object_store
17 short_description: NetApp ONTAP manage object store config.
18 extends_documentation_fragment:
19 - netapp.ontap.netapp.na_ontap
20 version_added: 2.9.0
21 author: NetApp Ansible Team (@carchi8py) <[email protected]>
22
23 description:
24 - Create or delete object store config on ONTAP.
25
26 options:
27
28 state:
29 description:
30 - Whether the specified object store config should exist or not.
31 choices: ['present', 'absent']
32 default: 'present'
33 type: str
34
35 name:
36 required: true
37 description:
38 - The name of the object store config to manage.
39 type: str
40
41 provider_type:
42 description:
43 - The name of the object store config provider.
44 type: str
45
46 server:
47 description:
48 - Fully qualified domain name of the object store config.
49 type: str
50
51 port:
52 description:
53 - Port number of the object store that ONTAP uses when establishing a connection.
54 type: int
55 version_added: 21.9.0
56
57 container:
58 description:
59 - Data bucket/container name used in S3 requests.
60 type: str
61
62 access_key:
63 description:
64 - Access key ID for AWS_S3 and SGWS provider types.
65 type: str
66
67 secret_password:
68 description:
69 - Secret access key for AWS_S3 and SGWS provider types.
70 type: str
71
72 certificate_validation_enabled:
73 description:
74 - Is SSL/TLS certificate validation enabled?
75 - If not specified, ONTAP will default to true.
76 type: bool
77 version_added: 21.9.0
78
79 ssl_enabled:
80 description:
81 - Is SSL enabled?
82 - If not specified, ONTAP will default to true.
83 type: bool
84 version_added: 21.9.0
85
86 change_password:
87 description:
88 - By default, the secret_password is used on create but ignored if the resource already exists.
89 - If set to true, the module always attempt to change the paswword as it cannot read the current value.
90 - When this is set to true, the module is not idempotent.
91 type: bool
92 default: false
93 version_added: 21.13.0
94
95 owner:
96 description:
97 - Owner of the target. Cannot be modifed.
98 - With REST, allowed values are fabricpool or snapmirror. A target can be used by only one feature.
99 - With ZAPI, the only allowed value is fabricpool.
100 - If absent, fabricpool is assumed on creation.
101 type: str
102 version_added: 21.13.0
103 '''
104
105 EXAMPLES = """
106 - name: Object store Create
107 netapp.ontap.na_ontap_object_store:
108 state: present
109 name: ansible
110 provider_type: SGWS
111 server: abc
112 container: abc
113 access_key: s3.amazonaws.com
114 secret_password: abc
115 hostname: "{{ netapp_hostname }}"
116 username: "{{ netapp_username }}"
117 password: "{{ netapp_password }}"
118
119 - name: Object store delete
120 netapp.ontap.na_ontap_object_store:
121 state: absent
122 name: ansible
123 hostname: "{{ netapp_hostname }}"
124 username: "{{ netapp_username }}"
125 password: "{{ netapp_password }}"
126 """
127
128 RETURN = """
129 """
130 import traceback
131
132 from ansible.module_utils.basic import AnsibleModule
133 from ansible.module_utils._text import to_native
134 import ansible_collections.netapp.ontap.plugins.module_utils.netapp as netapp_utils
135 from ansible_collections.netapp.ontap.plugins.module_utils.netapp_module import NetAppModule
136 from ansible_collections.netapp.ontap.plugins.module_utils.netapp import OntapRestAPI
137 from ansible_collections.netapp.ontap.plugins.module_utils import rest_generic
138
139
140 class NetAppOntapObjectStoreConfig():
141 ''' object initialize and class methods '''
142
143 def __init__(self):
144 self.use_rest = False
145 self.argument_spec = netapp_utils.na_ontap_host_argument_spec()
146 self.argument_spec.update(dict(
147 state=dict(required=False, choices=['present', 'absent'], default='present'),
148 change_password=dict(required=False, type='bool', default=False, no_log=False),
149 ))
150 # only fields that are readable through a GET request
151 rest_options = dict(
152 name=dict(required=True, type='str'),
153 provider_type=dict(required=False, type='str'),
154 server=dict(required=False, type='str'),
155 container=dict(required=False, type='str'),
156 access_key=dict(required=False, type='str', no_log=True),
157 port=dict(required=False, type='int'),
158 certificate_validation_enabled=dict(required=False, type='bool'),
159 ssl_enabled=dict(required=False, type='bool'),
160 owner=dict(required=False, type='str')
161 )
162 self.rest_get_fields = list(rest_options.keys())
163 # additional fields for POST/PATCH
164 rest_options.update(dict(
165 secret_password=dict(required=False, type='str', no_log=True),
166 ))
167 self.rest_all_fields = rest_options.keys()
168 self.argument_spec.update(rest_options)
169
170 self.module = AnsibleModule(
171 argument_spec=self.argument_spec,
172 supports_check_mode=True
173 )
174
175 self.na_helper = NetAppModule()
176 self.parameters = self.na_helper.set_parameters(self.module.params)
177
178 # API should be used for ONTAP 9.6 or higher, Zapi for lower version
179 self.rest_api = OntapRestAPI(self.module)
180 if self.rest_api.is_rest():
181 self.use_rest = True
182 elif not netapp_utils.has_netapp_lib():
183 self.module.fail_json(msg=netapp_utils.netapp_lib_is_required())
184 else:
185 if self.parameters.get('owner', 'fabricpool') != 'fabricpool':
186 self.module.fail_json(msg='Error: unsupported value for owner: %s when using ZAPI.' % self.parameters.get('owner'))
187 self.server = netapp_utils.setup_na_ontap_zapi(module=self.module)
188
189 def get_aggr_object_store(self):
190 """
191 Fetch details if object store config exists.
192 :return:
193 Dictionary of current details if object store config found
194 None if object store config is not found
195 """
196 if self.use_rest:
197 api = "cloud/targets"
198 query = {'name': self.parameters['name']}
199 fields = ','.join(self.rest_get_fields)
200 fields += ',uuid'
201 record, error = rest_generic.get_one_record(self.rest_api, api, query, fields)
202 if error:
203 self.module.fail_json(msg='Error %s' % error)
204 return record
205 else:
206 aggr_object_store_get_iter = netapp_utils.zapi.NaElement.create_node_with_children(
207 'aggr-object-store-config-get', **{'object-store-name': self.parameters['name']})
208 try:
209 result = self.server.invoke_successfully(aggr_object_store_get_iter, enable_tunneling=False)
210 except netapp_utils.zapi.NaApiError as error:
211 # Error 15661 denotes an object store not being found.
212 if to_native(error.code) == "15661":
213 return None
214 else:
215 self.module.fail_json(msg=to_native(error), exception=traceback.format_exc())
216 info = self.na_helper.safe_get(result, ['attributes', 'aggr-object-store-config-info'])
217 if info:
218 zapi_to_rest = {
219 'access_key': dict(key_list=['access-key'], convert_to=str),
220 'certificate_validation_enabled': dict(key_list=['is-certificate-validation-enabled'], convert_to=bool),
221 'container': dict(key_list=['s3-name'], convert_to=str),
222 'name': dict(key_list=['object-store-name'], convert_to=str),
223 'port': dict(key_list=['port'], convert_to=int),
224 'provider_type': dict(key_list=['provider-type'], convert_to=str),
225 'ssl_enabled': dict(key_list=['ssl-enabled'], convert_to=bool),
226 'server': dict(key_list=['server'], convert_to=str)
227 }
228 results = {}
229 self.na_helper.zapi_get_attrs(info, zapi_to_rest, results)
230 return results
231 return None
232
233 def validate_and_build_body(self, modify=None):
234 if modify is None:
235 required_keys = set(['provider_type', 'server', 'container', 'access_key'])
236 if not required_keys.issubset(set(self.parameters.keys())):
237 self.module.fail_json(msg='Error provisioning object store %s: one of the following parameters are missing %s'
238 % (self.parameters['name'], ', '.join(required_keys)))
239 if not self.use_rest:
240 return None
241 params = self.parameters if modify is None else modify
242 body = {}
243 for key in (self.rest_all_fields):
244 if params.get(key) is not None:
245 body[key] = params[key]
246 if not modify and 'owner' not in body:
247 body['owner'] = 'fabricpool'
248 if modify and 'owner' in body:
249 self.module.fail_json(msg='Error modifying object store, owner cannot be changed. Found: %s.' % body['owner'])
250 return body
251
252 def create_aggr_object_store(self, body):
253 """
254 Create aggregate object store config
255 :return: None
256 """
257 if self.use_rest:
258 api = "cloud/targets"
259 dummy, error = rest_generic.post_async(self.rest_api, api, body)
260 if error:
261 self.module.fail_json(msg='Error %s' % error)
262 else:
263 options = {'object-store-name': self.parameters['name'],
264 'provider-type': self.parameters['provider_type'],
265 'server': self.parameters['server'],
266 's3-name': self.parameters['container'],
267 'access-key': self.parameters['access_key']}
268 if self.parameters.get('secret_password'):
269 options['secret-password'] = self.parameters['secret_password']
270 if self.parameters.get('port') is not None:
271 options['port'] = str(self.parameters['port'])
272 if self.parameters.get('certificate_validation_enabled') is not None:
273 options['is-certificate-validation-enabled'] = str(self.parameters['certificate_validation_enabled']).lower()
274 if self.parameters.get('ssl_enabled') is not None:
275 options['ssl-enabled'] = str(self.parameters['ssl_enabled']).lower()
276 object_store_create = netapp_utils.zapi.NaElement.create_node_with_children('aggr-object-store-config-create', **options)
277
278 try:
279 self.server.invoke_successfully(object_store_create, enable_tunneling=False)
280 except netapp_utils.zapi.NaApiError as error:
281 self.module.fail_json(msg="Error provisioning object store config %s: %s"
282 % (self.parameters['name'], to_native(error)),
283 exception=traceback.format_exc())
284
285 def modify_aggr_object_store(self, body, uuid=None):
286 """
287 modify aggregate object store config
288 :return: None
289 """
290 api = "cloud/targets"
291 dummy, error = rest_generic.patch_async(self.rest_api, api, uuid, body)
292 if error:
293 self.module.fail_json(msg='Error %s' % error)
294
295 def delete_aggr_object_store(self, uuid=None):
296 """
297 Delete aggregate object store config
298 :return: None
299 """
300 if self.use_rest:
301 api = "cloud/targets"
302 dummy, error = rest_generic.delete_async(self.rest_api, api, uuid)
303 if error:
304 self.module.fail_json(msg='Error %s' % error)
305 else:
306 object_store_destroy = netapp_utils.zapi.NaElement.create_node_with_children(
307 'aggr-object-store-config-delete', **{'object-store-name': self.parameters['name']})
308
309 try:
310 self.server.invoke_successfully(object_store_destroy,
311 enable_tunneling=False)
312 except netapp_utils.zapi.NaApiError as error:
313 self.module.fail_json(msg="Error removing object store config %s: %s" %
314 (self.parameters['name'], to_native(error)), exception=traceback.format_exc())
315
316 def apply(self):
317 """
318 Apply action to the object store config
319 :return: None
320 """
321 modify = None
322 current = self.get_aggr_object_store()
323 cd_action = self.na_helper.get_cd_action(current, self.parameters)
324 if cd_action is None:
325 modify = self.na_helper.get_modified_attributes(current, self.parameters)
326 if self.parameters['change_password'] and 'secret_password' in self.parameters:
327 if not modify:
328 modify = {}
329 modify['secret_password'] = self.parameters['secret_password']
330 self.na_helper.changed = True
331 self.module.warn('na_ontap_object_store is not idempotent when change_password is set to true')
332 if not self.use_rest and modify:
333 self.module.fail_json(msg="Error - modify is not supported with ZAPI: %s" % modify)
334 if cd_action == 'create' or modify:
335 body = self.validate_and_build_body(modify)
336
337 if self.na_helper.changed and not self.module.check_mode:
338 uuid = current['uuid'] if current and self.use_rest else None
339 if cd_action == 'create':
340 self.create_aggr_object_store(body)
341 elif cd_action == 'delete':
342 self.delete_aggr_object_store(uuid)
343 elif modify:
344 self.modify_aggr_object_store(body, uuid)
345 result = netapp_utils.generate_result(self.na_helper.changed, cd_action, modify)
346 self.module.exit_json(**result)
347
348
349 def main():
350 """
351 Create Object Store Config class instance and invoke apply
352 :return: None
353 """
354 obj_store = NetAppOntapObjectStoreConfig()
355 obj_store.apply()
356
357
358 if __name__ == '__main__':
359 main()