Debian Codegraph @

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

raw
1 #!/usr/bin/python
2
3 # (c) 2022-2026, NetApp, Inc
4 # GNU General Public License v3.0+
5 # (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
6
7 from __future__ import absolute_import, division, print_function
8
9 __metaclass__ = type
10
11 DOCUMENTATION = '''
12 module: na_ontap_s3_users
13 short_description: NetApp ONTAP S3 users
14 extends_documentation_fragment:
15 - netapp.ontap.netapp.na_ontap_rest
16 version_added: 21.20.0
17 author: NetApp Ansible Team (@carchi8py) <[email protected]>
18 description:
19 - Create, delete, or modify S3 users on NetApp ONTAP.
20
21 options:
22 state:
23 description:
24 - Whether the specified S3 user should exist or not.
25 choices: ['present', 'absent']
26 type: str
27 default: 'present'
28
29 name:
30 description:
31 - The name of the S3 user.
32 type: str
33 required: true
34
35 vserver:
36 description:
37 - Name of the vserver to use.
38 type: str
39 required: true
40
41 comment:
42 description:
43 - Comment about the user.
44 type: str
45
46 access_key:
47 description:
48 - The access key for the S3 user.
49 type: str
50 version_added: 23.5.0
51
52 secret_key:
53 description:
54 - The secret key for the S3 user.
55 - Requires ONTAP 9.16.1 or later.
56 type: str
57 version_added: 23.5.0
58
59 regenerate_keys:
60 description:
61 - Specifies whether or not to regenerate the user keys.
62 type: bool
63 version_added: 22.13.0
64
65 delete_keys:
66 description:
67 - Specifies whether or not to delete the user keys.
68 - Requires ONTAP 9.14 or later.
69 type: bool
70 version_added: 22.13.0
71
72 lambda_config:
73 description:
74 - Configuration parameters for AWS Lambda proxy functionality.
75 - These option and suboptions are only supported with REST.
76 type: dict
77 version_added: 23.4.0
78 suboptions:
79 function_name:
80 description:
81 - The name of the AWS Lambda function to invoke.
82 type: str
83 required: true
84 aws_region:
85 description:
86 - The name of the AWS region.
87 type: str
88 required: true
89 aws_profile:
90 description:
91 - The name of the AWS profile to use for authentication.
92 type: str
93
94 notes:
95 - This module is not idempotent when using regenerate_keys.
96 - Supports AWS Lambda proxy functionality. See README for example usage.
97 '''
98
99 EXAMPLES = """
100 - name: Create or modify s3 user
101 netapp.ontap.na_ontap_s3_users:
102 state: present
103 name: carchi8py
104 vserver: ansibleSVM
105 comment: not enabled
106 hostname: "{{ netapp_hostname }}"
107 username: "{{ netapp_username }}"
108 password: "{{ netapp_password }}"
109 https: true
110 validate_certs: false
111 use_rest: always
112
113 - name: Delete s3 user
114 netapp.ontap.na_ontap_s3_users:
115 state: absent
116 name: carchi8py
117 vserver: ansibleSVM
118 hostname: "{{ netapp_hostname }}"
119 username: "{{ netapp_username }}"
120 password: "{{ netapp_password }}"
121 https: true
122 validate_certs: false
123 use_rest: always
124 """
125
126 RETURN = """
127 secret_key:
128 description: secret_key generated for the user
129 returned: on creation of user
130 type: str
131 access_key:
132 description: access_key generated for the user
133 returned: on creation of user
134 type: str
135 """
136
137 import traceback
138 from ansible.module_utils.basic import AnsibleModule
139 from ansible.module_utils._text import to_native
140 import ansible_collections.netapp.ontap.plugins.module_utils.netapp as netapp_utils
141 from ansible_collections.netapp.ontap.plugins.module_utils.netapp_module import NetAppModule
142 from ansible_collections.netapp.ontap.plugins.module_utils.netapp import OntapRestAPI
143 from ansible_collections.netapp.ontap.plugins.module_utils import rest_generic
144 from ansible_collections.netapp.ontap.plugins.module_utils import rest_vserver
145
146
147 class NetAppOntapS3Users:
148 def __init__(self):
149 self.argument_spec = netapp_utils.na_ontap_rest_only_spec()
150 self.argument_spec.update(dict(
151 state=dict(required=False, type='str', choices=['present', 'absent'], default='present'),
152 vserver=dict(required=True, type='str'),
153 name=dict(required=True, type='str'),
154 comment=dict(required=False, type='str'),
155 access_key=dict(required=False, type='str', no_log=True),
156 secret_key=dict(required=False, type='str', no_log=True),
157 regenerate_keys=dict(required=False, type='bool'),
158 delete_keys=dict(required=False, type='bool')
159 ))
160 self.argument_spec.update(netapp_utils.na_ontap_lambda_argument_spec())
161 self.module = AnsibleModule(
162 argument_spec=self.argument_spec,
163 required_if=[
164 ['use_lambda', True, ('lambda_config',)]
165 ],
166 supports_check_mode=True
167 )
168 self.svm_uuid = None
169 self.na_helper = NetAppModule(self.module)
170 self.parameters = self.na_helper.check_and_set_parameters(self.module)
171 self.rest_api = OntapRestAPI(self.module)
172 self.use_rest = self.rest_api.is_rest()
173 self.rest_api.fail_if_not_rest_minimum_version('na_ontap_s3_users', 9, 8)
174 partially_supported_rest_properties = [['delete_keys', (9, 14, 1)], ['secret_key', (9, 16, 1)]]
175 dummy, error = self.rest_api.is_rest(partially_supported_rest_properties=partially_supported_rest_properties,
176 parameters=self.parameters)
177 if error:
178 self.module.fail_json(msg=error)
179
180 def get_s3_user(self):
181 self.get_svm_uuid()
182 api = 'protocols/s3/services/%s/users' % self.svm_uuid
183 fields = ','.join(('name',
184 'comment',
185 'access_key'))
186 params = {'name': self.parameters['name'],
187 'fields': fields}
188 record, error = rest_generic.get_one_record(self.rest_api, api, params)
189 if error:
190 self.module.fail_json(msg='Error fetching S3 user %s: %s' % (self.parameters['name'], to_native(error)),
191 exception=traceback.format_exc())
192 return record
193
194 def get_svm_uuid(self):
195 record, error = rest_vserver.get_vserver_uuid(self.rest_api, self.parameters['vserver'], self.module, True)
196 self.svm_uuid = record
197
198 def create_s3_user(self):
199 api = 'protocols/s3/services/%s/users' % self.svm_uuid
200 body = {'name': self.parameters['name']}
201 if self.parameters.get('comment'):
202 body['comment'] = self.parameters['comment']
203 if self.parameters.get('access_key'):
204 body['access_key'] = self.parameters['access_key']
205 if self.parameters.get('secret_key'):
206 body['secret_key'] = self.parameters['secret_key']
207 response, error = rest_generic.post_async(self.rest_api, api, body)
208 if error:
209 self.module.fail_json(msg='Error creating S3 user %s: %s' % (self.parameters['name'], to_native(error)),
210 exception=traceback.format_exc())
211 if response.get('num_records') == 1:
212 return response.get('records')[0]
213 self.module.fail_json(msg='Error creating S3 user %s' % self.parameters['name'], exception=traceback.format_exc())
214
215 def delete_s3_user(self):
216 api = 'protocols/s3/services/%s/users' % self.svm_uuid
217 dummy, error = rest_generic.delete_async(self.rest_api, api, self.parameters['name'])
218 if error:
219 self.module.fail_json(msg='Error deleting S3 user %s: %s' % (self.parameters['name'], to_native(error)),
220 exception=traceback.format_exc())
221
222 def modify_s3_user(self, modify):
223 api = 'protocols/s3/services/%s/users' % self.svm_uuid
224 body = {}
225 query = {}
226 if modify is not None:
227 if modify.get('comment'):
228 body['comment'] = self.parameters['comment']
229 if self.parameters.get('regenerate_keys'):
230 query['regenerate_keys'] = self.parameters['regenerate_keys']
231 if self.parameters.get('delete_keys'):
232 query['delete_keys'] = self.parameters['delete_keys']
233 dummy, error = rest_generic.patch_async(self.rest_api, api, self.parameters['name'], body, query)
234 if error:
235 self.module.fail_json(msg='Error modifying S3 user %s: %s' % (self.parameters['name'], to_native(error)),
236 exception=traceback.format_exc())
237 if dummy.get('num_records') == 1:
238 return dummy.get('records')[0]
239
240 def parse_response(self, response):
241 if response is not None:
242 return response.get('secret_key'), response.get('access_key')
243 return None, None
244
245 def apply(self):
246 current = self.get_s3_user()
247 cd_action, modify, response = None, None, None
248 cd_action = self.na_helper.get_cd_action(current, self.parameters)
249 if cd_action is None:
250 modify = self.na_helper.get_modified_attributes(current, self.parameters)
251 if self.parameters.get('regenerate_keys') or self.parameters.get('delete_keys'):
252 response = self.modify_s3_user(modify)
253
254 if self.parameters.get('regenerate_keys'):
255 self.na_helper.changed = True
256 elif self.parameters.get('delete_keys') and current.get('access_key') is not None:
257 self.na_helper.changed = True
258 if self.na_helper.changed and not self.module.check_mode:
259 if cd_action == 'create':
260 response = self.create_s3_user()
261 if cd_action == 'delete':
262 self.delete_s3_user()
263 if modify:
264 self.modify_s3_user(modify)
265 secret_key, access_key = self.parse_response(response)
266 result = netapp_utils.generate_result(self.na_helper.changed, cd_action, modify, extra_responses={'secret_key': secret_key,
267 'access_key': access_key})
268 self.module.exit_json(**result)
269
270
271 def main():
272 '''Apply volume operations from playbook'''
273 obj = NetAppOntapS3Users()
274 obj.apply()
275
276
277 if __name__ == '__main__':
278 main()