| 1 |
#!/usr/bin/python |
| 2 |
|
| 3 |
# (c) 2018-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_services |
| 13 |
short_description: NetApp ONTAP S3 services |
| 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 Service |
| 20 |
|
| 21 |
options: |
| 22 |
state: |
| 23 |
description: |
| 24 |
- Whether the specified S3 bucket 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 service. |
| 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 |
enabled: |
| 42 |
description: |
| 43 |
- enable or disable the service |
| 44 |
type: bool |
| 45 |
|
| 46 |
comment: |
| 47 |
description: |
| 48 |
- comment about the service |
| 49 |
type: str |
| 50 |
|
| 51 |
is_http_enabled: |
| 52 |
description: |
| 53 |
- Specifies whether HTTP is enabled on the S3 server being created or modified |
| 54 |
type: bool |
| 55 |
default: no |
| 56 |
version_added: 22.13.0 |
| 57 |
|
| 58 |
is_https_enabled: |
| 59 |
description: |
| 60 |
- Specifies whether HTTPS is enabled on the S3 server being created or modified |
| 61 |
type: bool |
| 62 |
default: yes |
| 63 |
version_added: 22.13.0 |
| 64 |
|
| 65 |
port: |
| 66 |
description: |
| 67 |
- Specifies the HTTP listener port for the S3 server |
| 68 |
type: int |
| 69 |
default: 80 |
| 70 |
version_added: 22.13.0 |
| 71 |
|
| 72 |
secure_port: |
| 73 |
description: |
| 74 |
- Specifies the HTTPS listener port for the S3 server |
| 75 |
type: int |
| 76 |
default: 443 |
| 77 |
version_added: 22.13.0 |
| 78 |
|
| 79 |
certificate_name: |
| 80 |
description: |
| 81 |
- name of https certificate to use for the service |
| 82 |
type: str |
| 83 |
|
| 84 |
lambda_config: |
| 85 |
description: |
| 86 |
- Configuration parameters for AWS Lambda proxy functionality. |
| 87 |
- These option and suboptions are only supported with REST. |
| 88 |
type: dict |
| 89 |
version_added: 23.4.0 |
| 90 |
suboptions: |
| 91 |
function_name: |
| 92 |
description: |
| 93 |
- The name of the AWS Lambda function to invoke. |
| 94 |
type: str |
| 95 |
required: true |
| 96 |
aws_region: |
| 97 |
description: |
| 98 |
- The name of the AWS region. |
| 99 |
type: str |
| 100 |
required: true |
| 101 |
aws_profile: |
| 102 |
description: |
| 103 |
- The name of the AWS profile to use for authentication. |
| 104 |
type: str |
| 105 |
|
| 106 |
notes: |
| 107 |
- Supports AWS Lambda proxy functionality. See README for example usage. |
| 108 |
''' |
| 109 |
|
| 110 |
EXAMPLES = """ |
| 111 |
- name: Create or modify s3 service |
| 112 |
netapp.ontap.na_ontap_s3_services: |
| 113 |
state: present |
| 114 |
name: carchi-test |
| 115 |
vserver: ansibleSVM |
| 116 |
comment: not enabled |
| 117 |
enabled: false |
| 118 |
certificate_name: ansibleSVM_16E1C1284D889609 |
| 119 |
hostname: "{{ netapp_hostname }}" |
| 120 |
username: "{{ netapp_username }}" |
| 121 |
password: "{{ netapp_password }}" |
| 122 |
https: true |
| 123 |
validate_certs: false |
| 124 |
use_rest: always |
| 125 |
|
| 126 |
- name: Create or modify s3 service with https |
| 127 |
netapp.ontap.na_ontap_s3_services: |
| 128 |
state: present |
| 129 |
name: carchi-test |
| 130 |
vserver: ansibleSVM |
| 131 |
comment: not enabled |
| 132 |
enabled: true |
| 133 |
is_https_enabled: true |
| 134 |
port: 80 |
| 135 |
certificate_name: ansibleSVM_16E1C1284D889609 |
| 136 |
hostname: "{{ netapp_hostname }}" |
| 137 |
username: "{{ netapp_username }}" |
| 138 |
password: "{{ netapp_password }}" |
| 139 |
https: true |
| 140 |
validate_certs: false |
| 141 |
use_rest: always |
| 142 |
|
| 143 |
- name: Delete s3 service |
| 144 |
netapp.ontap.na_ontap_s3_services: |
| 145 |
state: absent |
| 146 |
name: carchi-test |
| 147 |
vserver: ansibleSVM |
| 148 |
certificate_name: ansibleSVM_16E1C1284D889609 |
| 149 |
hostname: "{{ netapp_hostname }}" |
| 150 |
username: "{{ netapp_username }}" |
| 151 |
password: "{{ netapp_password }}" |
| 152 |
https: true |
| 153 |
validate_certs: false |
| 154 |
use_rest: always |
| 155 |
""" |
| 156 |
|
| 157 |
RETURN = """ |
| 158 |
s3_service_info: |
| 159 |
description: Returns S3 service response. |
| 160 |
returned: on creation or modification of S3 service |
| 161 |
type: dict |
| 162 |
sample: '{ |
| 163 |
"s3_service_info": { |
| 164 |
"name": "Service1", |
| 165 |
"enabled": false, |
| 166 |
"certificate_name": "testSVM_177966509ABA4EC6", |
| 167 |
"users": [{"name": "root"}, {"name": "user1", "access_key": "IWE711019OW02ZB3WH6Q"}], |
| 168 |
"svm": {"name": "testSVM", "uuid": "39c2a5a0-35e2-11ee-b8da-005056b37403"}} |
| 169 |
} |
| 170 |
}' |
| 171 |
""" |
| 172 |
|
| 173 |
import traceback |
| 174 |
from ansible.module_utils.basic import AnsibleModule |
| 175 |
from ansible.module_utils._text import to_native |
| 176 |
import ansible_collections.netapp.ontap.plugins.module_utils.netapp as netapp_utils |
| 177 |
from ansible_collections.netapp.ontap.plugins.module_utils.netapp_module import NetAppModule |
| 178 |
from ansible_collections.netapp.ontap.plugins.module_utils.netapp import OntapRestAPI |
| 179 |
from ansible_collections.netapp.ontap.plugins.module_utils import rest_generic |
| 180 |
|
| 181 |
|
| 182 |
class NetAppOntapS3Services: |
| 183 |
def __init__(self): |
| 184 |
self.argument_spec = netapp_utils.na_ontap_rest_only_spec() |
| 185 |
self.argument_spec.update(dict( |
| 186 |
state=dict(required=False, type='str', choices=['present', 'absent'], default='present'), |
| 187 |
name=dict(required=True, type='str'), |
| 188 |
enabled=dict(required=False, type='bool'), |
| 189 |
vserver=dict(required=True, type='str'), |
| 190 |
comment=dict(required=False, type='str'), |
| 191 |
certificate_name=dict(required=False, type='str'), |
| 192 |
is_http_enabled=dict(type='bool', default=False), |
| 193 |
is_https_enabled=dict(type='bool', default=True), |
| 194 |
port=dict(type='int', default=80), |
| 195 |
secure_port=dict(type='int', default=443) |
| 196 |
)) |
| 197 |
self.argument_spec.update(netapp_utils.na_ontap_lambda_argument_spec()) |
| 198 |
|
| 199 |
self.module = AnsibleModule( |
| 200 |
argument_spec=self.argument_spec, |
| 201 |
required_if=[ |
| 202 |
['use_lambda', True, ('lambda_config',)] |
| 203 |
], |
| 204 |
supports_check_mode=True |
| 205 |
) |
| 206 |
self.svm_uuid = None |
| 207 |
self.na_helper = NetAppModule(self.module) |
| 208 |
self.parameters = self.na_helper.check_and_set_parameters(self.module) |
| 209 |
self.rest_api = OntapRestAPI(self.module) |
| 210 |
self.use_rest = self.rest_api.is_rest() |
| 211 |
self.rest_api.fail_if_not_rest_minimum_version('na_ontap_s3_services', 9, 8) |
| 212 |
|
| 213 |
def get_s3_service(self, extra_field=False): |
| 214 |
api = 'protocols/s3/services' |
| 215 |
fields = ','.join(('name', |
| 216 |
'enabled', |
| 217 |
'svm.uuid', |
| 218 |
'comment', |
| 219 |
'certificate.name', |
| 220 |
'is_http_enabled', |
| 221 |
'is_https_enabled', |
| 222 |
'port', |
| 223 |
'secure_port')) |
| 224 |
if extra_field: |
| 225 |
fields += ',users' |
| 226 |
|
| 227 |
params = { |
| 228 |
'svm.name': self.parameters['vserver'], |
| 229 |
'fields': fields |
| 230 |
} |
| 231 |
record, error = rest_generic.get_one_record(self.rest_api, api, params) |
| 232 |
if error: |
| 233 |
self.module.fail_json(msg='Error fetching S3 service %s: %s' % (self.parameters['name'], to_native(error)), |
| 234 |
exception=traceback.format_exc()) |
| 235 |
if record: |
| 236 |
if self.na_helper.safe_get(record, ['certificate', 'name']): |
| 237 |
record['certificate_name'] = self.na_helper.safe_get(record, ['certificate', 'name']) |
| 238 |
return self.set_uuids(record) |
| 239 |
return None |
| 240 |
|
| 241 |
def create_s3_service(self): |
| 242 |
api = 'protocols/s3/services' |
| 243 |
body = {'svm.name': self.parameters['vserver'], 'name': self.parameters['name']} |
| 244 |
if self.parameters.get('enabled') is not None: |
| 245 |
body['enabled'] = self.parameters['enabled'] |
| 246 |
if self.parameters.get('comment'): |
| 247 |
body['comment'] = self.parameters['comment'] |
| 248 |
if self.parameters.get('certificate_name'): |
| 249 |
body['certificate.name'] = self.parameters['certificate_name'] |
| 250 |
if self.parameters.get('is_http_enabled') is not None: |
| 251 |
body['is_http_enabled'] = self.parameters['is_http_enabled'] |
| 252 |
if self.parameters.get('is_https_enabled') is not None: |
| 253 |
body['is_https_enabled'] = self.parameters['is_https_enabled'] |
| 254 |
if self.parameters.get('port'): |
| 255 |
body['port'] = self.parameters['port'] |
| 256 |
if self.parameters.get('secured_port'): |
| 257 |
body['secured_port'] = self.parameters['secured_port'] |
| 258 |
dummy, error = rest_generic.post_async(self.rest_api, api, body) |
| 259 |
if error: |
| 260 |
self.module.fail_json(msg='Error creating S3 service %s: %s' % (self.parameters['name'], to_native(error)), |
| 261 |
exception=traceback.format_exc()) |
| 262 |
|
| 263 |
def delete_s3_service(self): |
| 264 |
api = 'protocols/s3/services' |
| 265 |
# The rest default is to delete all users, and empty bucket attached to a service. |
| 266 |
# This would not be idempotent, so switching this to False. |
| 267 |
# second issue, delete_all: True will say it deleted, but the ONTAP system will show it's still there until the job for the |
| 268 |
# delete buckets/users/groups is complete. |
| 269 |
body = {'delete_all': False} |
| 270 |
dummy, error = rest_generic.delete_async(self.rest_api, api, self.svm_uuid, body=body) |
| 271 |
if error: |
| 272 |
self.module.fail_json(msg='Error deleting S3 service %s: %s' % (self.parameters['name'], to_native(error)), |
| 273 |
exception=traceback.format_exc()) |
| 274 |
|
| 275 |
def modify_s3_service(self, modify): |
| 276 |
# Once the service is created, bucket and user can not be modified by the service api, but only the user/group/bucket modules |
| 277 |
api = 'protocols/s3/services' |
| 278 |
body = {'name': self.parameters['name']} |
| 279 |
if modify.get('enabled') is not None: |
| 280 |
body['enabled'] = self.parameters['enabled'] |
| 281 |
if modify.get('comment'): |
| 282 |
body['comment'] = self.parameters['comment'] |
| 283 |
if modify.get('certificate_name'): |
| 284 |
body['certificate.name'] = self.parameters['certificate_name'] |
| 285 |
if modify.get('is_http_enabled') is not None: |
| 286 |
body['is_http_enabled'] = self.parameters['is_http_enabled'] |
| 287 |
if modify.get('is_https_enabled') is not None: |
| 288 |
body['is_https_enabled'] = self.parameters['is_https_enabled'] |
| 289 |
if modify.get('port'): |
| 290 |
body['port'] = self.parameters['port'] |
| 291 |
if modify.get('secured_port'): |
| 292 |
body['secured_port'] = self.parameters['secured_port'] |
| 293 |
dummy, error = rest_generic.patch_async(self.rest_api, api, self.svm_uuid, body) |
| 294 |
if error: |
| 295 |
self.module.fail_json(msg='Error modifying S3 service %s: %s' % (self.parameters['name'], to_native(error)), |
| 296 |
exception=traceback.format_exc()) |
| 297 |
|
| 298 |
def set_uuids(self, record): |
| 299 |
self.svm_uuid = record['svm']['uuid'] |
| 300 |
return record |
| 301 |
|
| 302 |
def parse_response(self, response): |
| 303 |
if response is not None: |
| 304 |
users_info = [] |
| 305 |
options = ['name', 'access_key', 'secret_key'] |
| 306 |
for user_info in response.get('users', []): |
| 307 |
info = {} |
| 308 |
for option in options: |
| 309 |
if user_info.get(option) is not None: |
| 310 |
info[option] = user_info.get(option) |
| 311 |
users_info.append(info) |
| 312 |
return { |
| 313 |
'name': response.get('name'), |
| 314 |
'enabled': response.get('enabled'), |
| 315 |
'certificate_name': response.get('certificate_name'), |
| 316 |
'users': users_info, |
| 317 |
'svm': {'name': self.na_helper.safe_get(response, ['svm', 'name']), |
| 318 |
'uuid': self.na_helper.safe_get(response, ['svm', 'uuid'])} |
| 319 |
} |
| 320 |
return None |
| 321 |
|
| 322 |
def apply(self): |
| 323 |
current = self.get_s3_service() |
| 324 |
cd_action, modify, response = None, None, None |
| 325 |
cd_action = self.na_helper.get_cd_action(current, self.parameters) |
| 326 |
if cd_action is None: |
| 327 |
modify = self.na_helper.get_modified_attributes(current, self.parameters) |
| 328 |
if self.na_helper.changed and not self.module.check_mode: |
| 329 |
if cd_action == 'create': |
| 330 |
self.create_s3_service() |
| 331 |
response = self.get_s3_service(True) |
| 332 |
if cd_action == 'delete': |
| 333 |
self.delete_s3_service() |
| 334 |
if modify: |
| 335 |
self.modify_s3_service(modify) |
| 336 |
response = self.get_s3_service(True) |
| 337 |
message = self.parse_response(response) |
| 338 |
result = netapp_utils.generate_result(self.na_helper.changed, cd_action, modify, extra_responses={'s3_service_info': message}) |
| 339 |
self.module.exit_json(**result) |
| 340 |
|
| 341 |
|
| 342 |
def main(): |
| 343 |
'''Apply S3 service operations from playbook''' |
| 344 |
obj = NetAppOntapS3Services() |
| 345 |
obj.apply() |
| 346 |
|
| 347 |
|
| 348 |
if __name__ == '__main__': |
| 349 |
main() |