| 1 |
#!/usr/bin/python |
| 2 |
|
| 3 |
# (c) 2022, 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_cloudmanager_volume |
| 8 |
''' |
| 9 |
|
| 10 |
from __future__ import absolute_import, division, print_function |
| 11 |
|
| 12 |
__metaclass__ = type |
| 13 |
|
| 14 |
DOCUMENTATION = ''' |
| 15 |
|
| 16 |
module: na_cloudmanager_volume |
| 17 |
short_description: NetApp Cloud Manager volume |
| 18 |
extends_documentation_fragment: |
| 19 |
- netapp.cloudmanager.netapp.cloudmanager |
| 20 |
version_added: '21.3.0' |
| 21 |
author: NetApp Ansible Team (@carchi8py) <[email protected]> |
| 22 |
|
| 23 |
description: |
| 24 |
- Create, Modify or Delete volume on Cloud Manager. |
| 25 |
|
| 26 |
options: |
| 27 |
state: |
| 28 |
description: |
| 29 |
- Whether the specified volume should exist or not. |
| 30 |
choices: ['present', 'absent'] |
| 31 |
default: 'present' |
| 32 |
type: str |
| 33 |
|
| 34 |
name: |
| 35 |
description: |
| 36 |
- The name of the volume. |
| 37 |
required: true |
| 38 |
type: str |
| 39 |
|
| 40 |
working_environment_name: |
| 41 |
description: |
| 42 |
- The working environment name where the volume will be created. |
| 43 |
type: str |
| 44 |
|
| 45 |
working_environment_id: |
| 46 |
description: |
| 47 |
- The public ID of the working environment where the volume will be created. |
| 48 |
type: str |
| 49 |
|
| 50 |
client_id: |
| 51 |
description: |
| 52 |
- The connector ID of the Cloud Manager Connector. |
| 53 |
required: true |
| 54 |
type: str |
| 55 |
|
| 56 |
size: |
| 57 |
description: |
| 58 |
- The size of the volume. |
| 59 |
type: float |
| 60 |
|
| 61 |
size_unit: |
| 62 |
description: |
| 63 |
- The size unit of volume. |
| 64 |
choices: ['GB'] |
| 65 |
default: 'GB' |
| 66 |
type: str |
| 67 |
|
| 68 |
snapshot_policy_name: |
| 69 |
description: |
| 70 |
- The snapshot policy name. |
| 71 |
type: str |
| 72 |
|
| 73 |
provider_volume_type: |
| 74 |
description: |
| 75 |
- The underlying cloud provider volume type. |
| 76 |
- For AWS is ["gp3", "gp2", "io1", "st1", "sc1"]. |
| 77 |
- For Azure is ['Premium_LRS','Standard_LRS','StandardSSD_LRS']. |
| 78 |
- For GCP is ['pd-balanced','pd-ssd','pd-standard']. |
| 79 |
type: str |
| 80 |
|
| 81 |
enable_deduplication: |
| 82 |
description: |
| 83 |
- Enabling deduplication. |
| 84 |
- Default to true if not specified. |
| 85 |
type: bool |
| 86 |
|
| 87 |
enable_compression: |
| 88 |
description: |
| 89 |
- Enabling cpmpression. |
| 90 |
- Default to true if not specified. |
| 91 |
type: bool |
| 92 |
|
| 93 |
enable_thin_provisioning: |
| 94 |
description: |
| 95 |
- Enabling thin provisioning. |
| 96 |
- Default to true if not specified. |
| 97 |
type: bool |
| 98 |
|
| 99 |
svm_name: |
| 100 |
description: |
| 101 |
- The name of the SVM. The default SVM name is used, if a name is not provided. |
| 102 |
type: str |
| 103 |
|
| 104 |
aggregate_name: |
| 105 |
description: |
| 106 |
- The aggregate in which the volume will be created. If not provided, Cloud Manager chooses the best aggregate. |
| 107 |
type: str |
| 108 |
|
| 109 |
capacity_tier: |
| 110 |
description: |
| 111 |
- The volume's capacity tier for tiering cold data to object storage. |
| 112 |
- The default values for each cloud provider are as follows. Amazon as 'S3', Azure as 'Blob', GCP as 'cloudStorage'. |
| 113 |
- If 'NONE', the capacity tier will not be set on volume creation. |
| 114 |
choices: ['NONE', 'S3', 'Blob', 'cloudStorage'] |
| 115 |
type: str |
| 116 |
|
| 117 |
tiering_policy: |
| 118 |
description: |
| 119 |
- The tiering policy. |
| 120 |
choices: ['none', 'snapshot_only', 'auto', 'all'] |
| 121 |
type: str |
| 122 |
|
| 123 |
export_policy_type: |
| 124 |
description: |
| 125 |
- The export policy type (NFS protocol parameters). |
| 126 |
type: str |
| 127 |
|
| 128 |
export_policy_ip: |
| 129 |
description: |
| 130 |
- Custom export policy list of IPs (NFS protocol parameters). |
| 131 |
type: list |
| 132 |
elements: str |
| 133 |
|
| 134 |
export_policy_nfs_version: |
| 135 |
description: |
| 136 |
- Export policy protocol (NFS protocol parameters). |
| 137 |
type: list |
| 138 |
elements: str |
| 139 |
|
| 140 |
iops: |
| 141 |
description: |
| 142 |
- Provisioned IOPS. Needed only when provider_volume_type is "io1". |
| 143 |
type: int |
| 144 |
|
| 145 |
throughput: |
| 146 |
description: |
| 147 |
- Unit is Mb/s. Valid range 125-1000. |
| 148 |
- Required only when provider_volume_type is 'gp3'. |
| 149 |
type: int |
| 150 |
|
| 151 |
volume_protocol: |
| 152 |
description: |
| 153 |
- The protocol for the volume. This affects the provided parameters. |
| 154 |
choices: ['nfs', 'cifs', 'iscsi'] |
| 155 |
type: str |
| 156 |
default: 'nfs' |
| 157 |
|
| 158 |
share_name: |
| 159 |
description: |
| 160 |
- Share name (CIFS protocol parameters). |
| 161 |
type: str |
| 162 |
|
| 163 |
permission: |
| 164 |
description: |
| 165 |
- CIFS share permission type (CIFS protocol parameters). |
| 166 |
type: str |
| 167 |
|
| 168 |
users: |
| 169 |
description: |
| 170 |
- List of users with the permission (CIFS protocol parameters). |
| 171 |
type: list |
| 172 |
elements: str |
| 173 |
|
| 174 |
igroups: |
| 175 |
description: |
| 176 |
- List of igroups (iSCSI protocol parameters). |
| 177 |
type: list |
| 178 |
elements: str |
| 179 |
|
| 180 |
os_name: |
| 181 |
description: |
| 182 |
- Operating system (iSCSI protocol parameters). |
| 183 |
type: str |
| 184 |
|
| 185 |
tenant_id: |
| 186 |
description: |
| 187 |
- The NetApp account ID that the Connector will be associated with. To be used only when using FSx. |
| 188 |
type: str |
| 189 |
version_added: 21.20.0 |
| 190 |
|
| 191 |
initiators: |
| 192 |
description: |
| 193 |
- Set of attributes of Initiators (iSCSI protocol parameters). |
| 194 |
type: list |
| 195 |
elements: dict |
| 196 |
suboptions: |
| 197 |
iqn: |
| 198 |
description: The initiator node name. |
| 199 |
required: true |
| 200 |
type: str |
| 201 |
alias: |
| 202 |
description: The alias which associates with the node. |
| 203 |
required: true |
| 204 |
type: str |
| 205 |
|
| 206 |
notes: |
| 207 |
- Support check_mode. |
| 208 |
''' |
| 209 |
|
| 210 |
EXAMPLES = ''' |
| 211 |
- name: Create nfs volume with working_environment_name |
| 212 |
netapp.cloudmanager.na_cloudmanager_volume: |
| 213 |
state: present |
| 214 |
name: test_vol |
| 215 |
size: 15 |
| 216 |
size_unit: GB |
| 217 |
working_environment_name: working_environment_1 |
| 218 |
client_id: client_id |
| 219 |
refresh_token: refresh_token |
| 220 |
svm_name: svm_1 |
| 221 |
snapshot_policy_name: default |
| 222 |
export_policy_type: custom |
| 223 |
export_policy_ip: ["10.0.0.1/16"] |
| 224 |
export_policy_nfs_version: ["nfs3","nfs4"] |
| 225 |
|
| 226 |
- name: Delete volume |
| 227 |
netapp.cloudmanager.na_cloudmanager_volume: |
| 228 |
state: absent |
| 229 |
name: test_vol |
| 230 |
working_environment_name: working_environment_1 |
| 231 |
client_id: client_id |
| 232 |
refresh_token: refresh_token |
| 233 |
svm_name: svm_1 |
| 234 |
''' |
| 235 |
|
| 236 |
RETURN = r''' # ''' |
| 237 |
|
| 238 |
from ansible.module_utils.basic import AnsibleModule |
| 239 |
import ansible_collections.netapp.cloudmanager.plugins.module_utils.netapp as netapp_utils |
| 240 |
from ansible_collections.netapp.cloudmanager.plugins.module_utils.netapp_module import NetAppModule |
| 241 |
|
| 242 |
|
| 243 |
class NetAppCloudmanagerVolume(object): |
| 244 |
|
| 245 |
def __init__(self): |
| 246 |
""" |
| 247 |
Parse arguments, setup state variables, |
| 248 |
check parameters and ensure request module is installed |
| 249 |
""" |
| 250 |
self.argument_spec = netapp_utils.cloudmanager_host_argument_spec() |
| 251 |
self.argument_spec.update(dict( |
| 252 |
state=dict(required=False, choices=['present', 'absent'], default='present'), |
| 253 |
name=dict(required=True, type='str'), |
| 254 |
working_environment_id=dict(required=False, type='str'), |
| 255 |
working_environment_name=dict(required=False, type='str'), |
| 256 |
client_id=dict(required=True, type='str'), |
| 257 |
size=dict(required=False, type='float'), |
| 258 |
size_unit=dict(required=False, choices=['GB'], default='GB'), |
| 259 |
snapshot_policy_name=dict(required=False, type='str'), |
| 260 |
provider_volume_type=dict(required=False, type='str'), |
| 261 |
enable_deduplication=dict(required=False, type='bool'), |
| 262 |
enable_thin_provisioning=dict(required=False, type='bool'), |
| 263 |
enable_compression=dict(required=False, type='bool'), |
| 264 |
svm_name=dict(required=False, type='str'), |
| 265 |
aggregate_name=dict(required=False, type='str'), |
| 266 |
capacity_tier=dict(required=False, type='str', choices=['NONE', 'S3', 'Blob', 'cloudStorage']), |
| 267 |
tiering_policy=dict(required=False, type='str', choices=['none', 'snapshot_only', 'auto', 'all']), |
| 268 |
export_policy_type=dict(required=False, type='str'), |
| 269 |
export_policy_ip=dict(required=False, type='list', elements='str'), |
| 270 |
export_policy_nfs_version=dict(required=False, type='list', elements='str'), |
| 271 |
iops=dict(required=False, type='int'), |
| 272 |
throughput=dict(required=False, type='int'), |
| 273 |
volume_protocol=dict(required=False, type='str', choices=['nfs', 'cifs', 'iscsi'], default='nfs'), |
| 274 |
share_name=dict(required=False, type='str'), |
| 275 |
permission=dict(required=False, type='str'), |
| 276 |
users=dict(required=False, type='list', elements='str'), |
| 277 |
igroups=dict(required=False, type='list', elements='str'), |
| 278 |
os_name=dict(required=False, type='str'), |
| 279 |
tenant_id=dict(required=False, type='str'), |
| 280 |
initiators=dict(required=False, type='list', elements='dict', options=dict( |
| 281 |
alias=dict(required=True, type='str'), |
| 282 |
iqn=dict(required=True, type='str'),)), |
| 283 |
|
| 284 |
)) |
| 285 |
self.module = AnsibleModule( |
| 286 |
argument_spec=self.argument_spec, |
| 287 |
required_one_of=[ |
| 288 |
['refresh_token', 'sa_client_id'], |
| 289 |
['working_environment_name', 'working_environment_id'], |
| 290 |
], |
| 291 |
required_together=[['sa_client_id', 'sa_secret_key']], |
| 292 |
required_if=[ |
| 293 |
['provider_volume_type', 'gp3', ['iops', 'throughput']], |
| 294 |
['provider_volume_type', 'io1', ['iops']], |
| 295 |
['capacity_tier', 'S3', ['tiering_policy']], |
| 296 |
], |
| 297 |
# enable_thin_provisioning reflects storage efficiency. |
| 298 |
required_by={ |
| 299 |
'capacity_tier': ('tiering_policy', 'enable_thin_provisioning'), |
| 300 |
}, |
| 301 |
supports_check_mode=True |
| 302 |
) |
| 303 |
self.na_helper = NetAppModule() |
| 304 |
# set up state variables |
| 305 |
self.parameters = self.na_helper.set_parameters(self.module.params) |
| 306 |
# Calling generic rest_api class |
| 307 |
self.rest_api = netapp_utils.CloudManagerRestAPI(self.module) |
| 308 |
self.rest_api.token_type, self.rest_api.token = self.rest_api.get_token() |
| 309 |
self.rest_api.url += self.rest_api.environment_data['CLOUD_MANAGER_HOST'] |
| 310 |
self.headers = { |
| 311 |
'X-Agent-Id': self.rest_api.format_client_id(self.parameters['client_id']) |
| 312 |
} |
| 313 |
if self.rest_api.simulator: |
| 314 |
self.headers.update({'x-simulator': 'true'}) |
| 315 |
if self.parameters.get('tenant_id'): |
| 316 |
working_environment_detail, error = self.na_helper.get_aws_fsx_details(self.rest_api, self.headers, self.parameters['working_environment_name']) |
| 317 |
elif self.parameters.get('working_environment_id'): |
| 318 |
working_environment_detail, error = self.na_helper.get_working_environment_details(self.rest_api, self.headers) |
| 319 |
else: |
| 320 |
working_environment_detail, error = self.na_helper.get_working_environment_details_by_name(self.rest_api, |
| 321 |
self.headers, |
| 322 |
self.parameters['working_environment_name']) |
| 323 |
if working_environment_detail is None: |
| 324 |
self.module.fail_json(msg="Error: Cannot find working environment, if it is an AWS FSxN, please provide tenant_id: %s" % str(error)) |
| 325 |
self.parameters['working_environment_id'] = working_environment_detail['publicId']\ |
| 326 |
if working_environment_detail.get('publicId') else working_environment_detail['id'] |
| 327 |
self.na_helper.set_api_root_path(working_environment_detail, self.rest_api) |
| 328 |
self.is_fsx = self.parameters['working_environment_id'].startswith('fs-') |
| 329 |
|
| 330 |
if self.parameters.get('svm_name') is None: |
| 331 |
fsx_path = '' |
| 332 |
if self.is_fsx: |
| 333 |
fsx_path = '/svms' |
| 334 |
response, err, dummy = self.rest_api.send_request("GET", "%s/working-environments/%s%s" % ( |
| 335 |
self.rest_api.api_root_path, self.parameters['working_environment_id'], fsx_path), None, None, header=self.headers) |
| 336 |
if err is not None: |
| 337 |
self.module.fail_json(changed=False, msg="Error: unexpected response on getting svm: %s, %s" % (str(err), str(response))) |
| 338 |
if self.is_fsx: |
| 339 |
self.parameters['svm_name'] = response[0]['name'] |
| 340 |
else: |
| 341 |
self.parameters['svm_name'] = response['svmName'] |
| 342 |
|
| 343 |
if self.parameters['volume_protocol'] == 'nfs': |
| 344 |
extra_options = [] |
| 345 |
for option in ['share_name', 'permission', 'users', 'igroups', 'os_name', 'initiator']: |
| 346 |
if self.parameters.get(option) is not None: |
| 347 |
extra_options.append(option) |
| 348 |
if len(extra_options) > 0: |
| 349 |
self.module.fail_json(msg="Error: The following options are not allowed when volume_protocol is nfs: " |
| 350 |
" %s" % extra_options) |
| 351 |
elif self.parameters['volume_protocol'] == 'cifs': |
| 352 |
extra_options = [] |
| 353 |
for option in ['export_policy_type', 'export_policy_ip', 'export_policy_nfs_version', 'igroups', 'os_name', 'initiator']: |
| 354 |
if self.parameters.get(option) is not None: |
| 355 |
extra_options.append(option) |
| 356 |
if len(extra_options) > 0: |
| 357 |
self.module.fail_json(msg="Error: The following options are not allowed when volume_protocol is cifs: " |
| 358 |
"%s" % extra_options) |
| 359 |
else: |
| 360 |
extra_options = [] |
| 361 |
for option in ['export_policy_type', 'export_policy_ip', 'export_policy_nfs_version', 'share_name', 'permission', 'users']: |
| 362 |
if self.parameters.get(option) is not None: |
| 363 |
extra_options.append(option) |
| 364 |
if len(extra_options) > 0: |
| 365 |
self.module.fail_json(msg="Error: The following options are not allowed when volume_protocol is iscsi: " |
| 366 |
"%s" % extra_options) |
| 367 |
|
| 368 |
if self.parameters.get('igroups'): |
| 369 |
current_igroups = [] |
| 370 |
for igroup in self.parameters['igroups']: |
| 371 |
current = self.get_igroup(igroup) |
| 372 |
current_igroups.append(current) |
| 373 |
if any(isinstance(x, dict) for x in current_igroups) and None in current_igroups: |
| 374 |
self.module.fail_json(changed=False, msg="Error: can not specify existing" |
| 375 |
"igroup and new igroup together.") |
| 376 |
if len(current_igroups) > 1 and None in current_igroups: |
| 377 |
self.module.fail_json(changed=False, msg="Error: can not create more than one igroups.") |
| 378 |
if current_igroups[0] is None: |
| 379 |
if self.parameters.get('initiators') is None: |
| 380 |
self.module.fail_json(changed=False, msg="Error: initiator is required when creating new igroup.") |
| 381 |
|
| 382 |
if self.parameters.get('users'): |
| 383 |
# When creating volume, 'Everyone' must have upper case E, 'everyone' will not work. |
| 384 |
# When modifying volume, 'everyone' is fine. |
| 385 |
new_users = [] |
| 386 |
for user in self.parameters['users']: |
| 387 |
if user.lower() == 'everyone': |
| 388 |
new_users.append('Everyone') |
| 389 |
else: |
| 390 |
new_users.append(user) |
| 391 |
self.parameters['users'] = new_users |
| 392 |
|
| 393 |
def get_volume(self): |
| 394 |
if self.is_fsx: |
| 395 |
query_param = 'fileSystemId' |
| 396 |
else: |
| 397 |
query_param = 'workingEnvironmentId' |
| 398 |
response, err, dummy = self.rest_api.send_request("GET", "%s/volumes?%s=%s" % ( |
| 399 |
self.rest_api.api_root_path, query_param, self.parameters['working_environment_id']), None, header=self.headers) |
| 400 |
if err is not None: |
| 401 |
self.module.fail_json(changed=False, msg="Error: unexpected response on getting volume: %s, %s" % (str(err), str(response))) |
| 402 |
target_vol = dict() |
| 403 |
if response is None: |
| 404 |
return None |
| 405 |
for volume in response: |
| 406 |
if volume['name'] == self.parameters['name']: |
| 407 |
target_vol['name'] = volume['name'] |
| 408 |
target_vol['enable_deduplication'] = volume['deduplication'] |
| 409 |
target_vol['enable_thin_provisioning'] = volume['thinProvisioning'] |
| 410 |
target_vol['enable_compression'] = volume['compression'] |
| 411 |
if self.parameters.get('size'): |
| 412 |
target_vol['size'] = volume['size']['size'] |
| 413 |
if self.parameters.get('size_unit'): |
| 414 |
target_vol['size_unit'] = volume['size']['unit'] |
| 415 |
if self.parameters.get('export_policy_nfs_version') and volume.get('exportPolicyInfo'): |
| 416 |
target_vol['export_policy_nfs_version'] = volume['exportPolicyInfo']['nfsVersion'] |
| 417 |
if self.parameters.get('export_policy_ip') and volume.get('exportPolicyInfo'): |
| 418 |
target_vol['export_policy_ip'] = volume['exportPolicyInfo']['ips'] |
| 419 |
if self.parameters.get('export_policy_type') and volume.get('exportPolicyInfo'): |
| 420 |
target_vol['export_policy_type'] = volume['exportPolicyInfo']['policyType'] |
| 421 |
if self.parameters.get('snapshot_policy'): |
| 422 |
target_vol['snapshot_policy'] = volume['snapshotPolicy'] |
| 423 |
if self.parameters.get('provider_volume_type'): |
| 424 |
target_vol['provider_volume_type'] = volume['providerVolumeType'] |
| 425 |
if self.parameters.get('capacity_tier') and self.parameters.get('capacity_tier') != 'NONE': |
| 426 |
target_vol['capacity_tier'] = volume['capacityTier'] |
| 427 |
if self.parameters.get('tiering_policy'): |
| 428 |
target_vol['tiering_policy'] = volume['tieringPolicy'] |
| 429 |
if self.parameters.get('share_name') and volume.get('shareInfo'): |
| 430 |
target_vol['share_name'] = volume['shareInfo'][0]['shareName'] |
| 431 |
if self.parameters.get('users') and volume.get('shareInfo'): |
| 432 |
if len(volume['shareInfo'][0]['accessControlList']) > 0: |
| 433 |
target_vol['users'] = volume['shareInfo'][0]['accessControlList'][0]['users'] |
| 434 |
else: |
| 435 |
target_vol['users'] = [] |
| 436 |
if self.parameters.get('users') and volume.get('shareInfo'): |
| 437 |
if len(volume['shareInfo'][0]['accessControlList']) > 0: |
| 438 |
target_vol['permission'] = volume['shareInfo'][0]['accessControlList'][0]['permission'] |
| 439 |
else: |
| 440 |
target_vol['permission'] = [] |
| 441 |
if self.parameters.get('os_name') and volume.get('iscsiInfo'): |
| 442 |
target_vol['os_name'] = volume['iscsiInfo']['osName'] |
| 443 |
if self.parameters.get('igroups') and volume.get('iscsiInfo'): |
| 444 |
target_vol['igroups'] = volume['iscsiInfo']['igroups'] |
| 445 |
return target_vol |
| 446 |
return None |
| 447 |
|
| 448 |
def create_volume(self): |
| 449 |
exclude_list = ['client_id', 'size_unit', 'export_policy_name', 'export_policy_type', 'export_policy_ip', |
| 450 |
'export_policy_nfs_version', 'capacity_tier'] |
| 451 |
quote = self.na_helper.convert_module_args_to_api(self.parameters, exclude_list) |
| 452 |
quote['verifyNameUniqueness'] = True # Always hard coded to true. |
| 453 |
quote['unit'] = self.parameters['size_unit'] |
| 454 |
quote['size'] = {'size': self.parameters['size'], 'unit': self.parameters['size_unit']} |
| 455 |
create_aggregate_if_not_exists = True |
| 456 |
if self.parameters.get('aggregate_name'): |
| 457 |
quote['aggregateName'] = self.parameters['aggregate_name'] |
| 458 |
create_aggregate_if_not_exists = False |
| 459 |
|
| 460 |
if self.parameters.get('capacity_tier') and self.parameters['capacity_tier'] != "NONE": |
| 461 |
quote['capacityTier'] = self.parameters['capacity_tier'] |
| 462 |
|
| 463 |
if self.parameters['volume_protocol'] == 'nfs': |
| 464 |
quote['exportPolicyInfo'] = dict() |
| 465 |
if self.parameters.get('export_policy_type'): |
| 466 |
quote['exportPolicyInfo']['policyType'] = self.parameters['export_policy_type'] |
| 467 |
if self.parameters.get('export_policy_ip'): |
| 468 |
quote['exportPolicyInfo']['ips'] = self.parameters['export_policy_ip'] |
| 469 |
if self.parameters.get('export_policy_nfs_version'): |
| 470 |
quote['exportPolicyInfo']['nfsVersion'] = self.parameters['export_policy_nfs_version'] |
| 471 |
elif self.parameters['volume_protocol'] == 'iscsi': |
| 472 |
iscsi_info = self.iscsi_volume_helper() |
| 473 |
quote.update(iscsi_info) |
| 474 |
else: |
| 475 |
quote['shareInfo'] = dict() |
| 476 |
quote['shareInfo']['accessControl'] = dict() |
| 477 |
quote['shareInfo']['accessControl']['users'] = self.parameters['users'] |
| 478 |
if self.parameters.get('permission'): |
| 479 |
quote['shareInfo']['accessControl']['permission'] = self.parameters['permission'] |
| 480 |
if self.parameters.get('share_name'): |
| 481 |
quote['shareInfo']['shareName'] = self.parameters['share_name'] |
| 482 |
if not self.is_fsx: |
| 483 |
response, err, dummy = self.rest_api.send_request("POST", "%s/volumes/quote" % self.rest_api.api_root_path, |
| 484 |
None, quote, header=self.headers) |
| 485 |
if err is not None: |
| 486 |
self.module.fail_json(changed=False, msg="Error: unexpected response on quoting volume: %s, %s" % (str(err), str(response))) |
| 487 |
quote['newAggregate'] = response['newAggregate'] |
| 488 |
quote['aggregateName'] = response['aggregateName'] |
| 489 |
quote['maxNumOfDisksApprovedToAdd'] = response['numOfDisks'] |
| 490 |
else: |
| 491 |
quote['fileSystemId'] = self.parameters['working_environment_id'] |
| 492 |
if self.parameters.get('enable_deduplication'): |
| 493 |
quote['deduplication'] = self.parameters.get('enable_deduplication') |
| 494 |
if self.parameters.get('enable_thin_provisioning'): |
| 495 |
quote['thinProvisioning'] = self.parameters.get('enable_thin_provisioning') |
| 496 |
if self.parameters.get('enable_compression'): |
| 497 |
quote['compression'] = self.parameters.get('enable_compression') |
| 498 |
if self.parameters.get('snapshot_policy_name'): |
| 499 |
quote['snapshotPolicy'] = self.parameters['snapshot_policy_name'] |
| 500 |
if self.parameters.get('capacity_tier') and self.parameters['capacity_tier'] != "NONE": |
| 501 |
quote['capacityTier'] = self.parameters['capacity_tier'] |
| 502 |
if self.parameters.get('tiering_policy'): |
| 503 |
quote['tieringPolicy'] = self.parameters['tiering_policy'] |
| 504 |
if self.parameters.get('provider_volume_type'): |
| 505 |
quote['providerVolumeType'] = self.parameters['provider_volume_type'] |
| 506 |
if self.parameters.get('iops'): |
| 507 |
quote['iops'] = self.parameters.get('iops') |
| 508 |
if self.parameters.get('throughput'): |
| 509 |
quote['throughput'] = self.parameters.get('throughput') |
| 510 |
response, err, on_cloud_request_id = self.rest_api.send_request("POST", "%s/volumes?createAggregateIfNotFound=%s" % ( |
| 511 |
self.rest_api.api_root_path, create_aggregate_if_not_exists), None, quote, header=self.headers) |
| 512 |
if err is not None: |
| 513 |
self.module.fail_json(changed=False, msg="Error: unexpected on creating volume: %s, %s" % (str(err), str(response))) |
| 514 |
wait_on_completion_api_url = '/occm/api/audit/activeTask/%s' % (str(on_cloud_request_id)) |
| 515 |
err = self.rest_api.wait_on_completion(wait_on_completion_api_url, "volume", "create", 20, 5) |
| 516 |
if err is not None: |
| 517 |
self.module.fail_json(changed=False, msg="Error: unexpected response wait_on_completion for creating volume: %s, %s" % (str(err), str(response))) |
| 518 |
|
| 519 |
def modify_volume(self, modify): |
| 520 |
vol = dict() |
| 521 |
if self.parameters['volume_protocol'] == 'nfs': |
| 522 |
export_policy_info = dict() |
| 523 |
if self.parameters.get('export_policy_type'): |
| 524 |
export_policy_info['policyType'] = self.parameters['export_policy_type'] |
| 525 |
if self.parameters.get('export_policy_ip'): |
| 526 |
export_policy_info['ips'] = self.parameters['export_policy_ip'] |
| 527 |
if self.parameters.get('export_policy_nfs_version'): |
| 528 |
export_policy_info['nfsVersion'] = self.parameters['export_policy_nfs_version'] |
| 529 |
vol['exportPolicyInfo'] = export_policy_info |
| 530 |
elif self.parameters['volume_protocol'] == 'cifs': |
| 531 |
vol['shareInfo'] = dict() |
| 532 |
vol['shareInfo']['accessControlList'] = [] |
| 533 |
vol['shareInfo']['accessControlList'].append(dict()) |
| 534 |
if self.parameters.get('users'): |
| 535 |
vol['shareInfo']['accessControlList'][0]['users'] = self.parameters['users'] |
| 536 |
if self.parameters.get('permission'): |
| 537 |
vol['shareInfo']['accessControlList'][0]['permission'] = self.parameters['permission'] |
| 538 |
if self.parameters.get('share_name'): |
| 539 |
vol['shareInfo']['shareName'] = self.parameters['share_name'] |
| 540 |
if modify.get('snapshot_policy_name'): |
| 541 |
vol['snapshotPolicyName'] = self.parameters.get('snapshot_policy_name') |
| 542 |
if modify.get('tiering_policy'): |
| 543 |
vol['tieringPolicy'] = self.parameters.get('tiering_policy') |
| 544 |
response, err, dummy = self.rest_api.send_request("PUT", "%s/volumes/%s/%s/%s" % ( |
| 545 |
self.rest_api.api_root_path, self.parameters['working_environment_id'], self.parameters['svm_name'], |
| 546 |
self.parameters['name']), None, vol, header=self.headers) |
| 547 |
if err is not None: |
| 548 |
self.module.fail_json(changed=False, msg="Error: unexpected response on modifying volume: %s, %s" % (str(err), str(response))) |
| 549 |
|
| 550 |
def delete_volume(self): |
| 551 |
response, err, dummy = self.rest_api.send_request("DELETE", "%s/volumes/%s/%s/%s" % ( |
| 552 |
self.rest_api.api_root_path, self.parameters['working_environment_id'], self.parameters['svm_name'], |
| 553 |
self.parameters['name']), None, None, header=self.headers) |
| 554 |
if err is not None: |
| 555 |
self.module.fail_json(changed=False, msg="Error: unexpected response on deleting volume: %s, %s" % (str(err), str(response))) |
| 556 |
|
| 557 |
def get_initiator(self, alias_name): |
| 558 |
response, err, dummy = self.rest_api.send_request("GET", "%s/volumes/initiator" % ( |
| 559 |
self.rest_api.api_root_path), None, header=self.headers) |
| 560 |
if err is not None: |
| 561 |
self.module.fail_json(changed=False, msg="Error: unexpected response on getting initiator: %s, %s" % (str(err), str(response))) |
| 562 |
result = dict() |
| 563 |
if response is None: |
| 564 |
return None |
| 565 |
for initiator in response: |
| 566 |
if initiator.get('aliasName') and initiator.get('aliasName') == alias_name: |
| 567 |
result['alias'] = initiator.get('aliasName') |
| 568 |
result['iqn'] = initiator.get('iqn') |
| 569 |
return result |
| 570 |
return None |
| 571 |
|
| 572 |
def create_initiator(self, initiator): |
| 573 |
ini = self.na_helper.convert_module_args_to_api(initiator) |
| 574 |
response, err, dummy = self.rest_api.send_request("POST", "%s/volumes/initiator" % ( |
| 575 |
self.rest_api.api_root_path), None, ini, header=self.headers) |
| 576 |
if err is not None: |
| 577 |
self.module.fail_json(changed=False, msg="Error: unexpected response on creating initiator: %s, %s" % (str(err), str(response))) |
| 578 |
|
| 579 |
def get_igroup(self, igroup_name): |
| 580 |
response, err, dummy = self.rest_api.send_request("GET", "%s/volumes/igroups/%s/%s" % ( |
| 581 |
self.rest_api.api_root_path, self.parameters['working_environment_id'], self.parameters['svm_name']), |
| 582 |
None, None, header=self.headers) |
| 583 |
if err is not None: |
| 584 |
self.module.fail_json(changed=False, msg="Error: unexpected response on getting igroup: %s, %s" % (str(err), str(response))) |
| 585 |
result = dict() |
| 586 |
if response is None: |
| 587 |
return None |
| 588 |
for igroup in response: |
| 589 |
if igroup['igroupName'] == igroup_name: |
| 590 |
result['igroup_name'] = igroup['igroupName'] |
| 591 |
result['os_type'] = igroup['osType'] |
| 592 |
result['portset_name'] = igroup['portsetName'] |
| 593 |
result['igroup_type'] = igroup['igroupType'] |
| 594 |
result['initiators'] = igroup['initiators'] |
| 595 |
return result |
| 596 |
return None |
| 597 |
|
| 598 |
def iscsi_volume_helper(self): |
| 599 |
quote = dict() |
| 600 |
quote['iscsiInfo'] = dict() |
| 601 |
if self.parameters.get('igroups'): |
| 602 |
current_igroups = [] |
| 603 |
for igroup in self.parameters['igroups']: |
| 604 |
current = self.get_igroup(igroup) |
| 605 |
current_igroups.append(current) |
| 606 |
for igroup in current_igroups: |
| 607 |
if igroup is None: |
| 608 |
quote['iscsiInfo']['igroupCreationRequest'] = dict() |
| 609 |
quote['iscsiInfo']['igroupCreationRequest']['igroupName'] = self.parameters['igroups'][0] |
| 610 |
iqn_list = [] |
| 611 |
for initiator in self.parameters['initiators']: |
| 612 |
if initiator.get('iqn'): |
| 613 |
iqn_list.append(initiator['iqn']) |
| 614 |
current_initiator = self.get_initiator(initiator['alias']) |
| 615 |
if current_initiator is None: |
| 616 |
initiator_request = dict() |
| 617 |
if initiator.get('alias'): |
| 618 |
initiator_request['aliasName'] = initiator['alias'] |
| 619 |
if initiator.get('iqn'): |
| 620 |
initiator_request['iqn'] = initiator['iqn'] |
| 621 |
self.create_initiator(initiator_request) |
| 622 |
quote['iscsiInfo']['igroupCreationRequest']['initiators'] = iqn_list |
| 623 |
quote['iscsiInfo']['osName'] = self.parameters['os_name'] |
| 624 |
|
| 625 |
else: |
| 626 |
quote['iscsiInfo']['igroups'] = self.parameters['igroups'] |
| 627 |
quote['iscsiInfo']['osName'] = self.parameters['os_name'] |
| 628 |
return quote |
| 629 |
|
| 630 |
def apply(self): |
| 631 |
current = self.get_volume() |
| 632 |
cd_action, modify = None, None |
| 633 |
cd_action = self.na_helper.get_cd_action(current, self.parameters) |
| 634 |
if cd_action is None: |
| 635 |
modify = self.na_helper.get_modified_attributes(current, self.parameters) |
| 636 |
unmodifiable = [] |
| 637 |
for attr in modify: |
| 638 |
if attr not in ['export_policy_ip', 'export_policy_nfs_version', 'snapshot_policy_name', 'users', |
| 639 |
'permission', 'tiering_policy', 'snapshot_policy_name']: |
| 640 |
unmodifiable.append(attr) |
| 641 |
if len(unmodifiable) > 0: |
| 642 |
self.module.fail_json(changed=False, msg="%s cannot be modified." % str(unmodifiable)) |
| 643 |
if self.na_helper.changed and not self.module.check_mode: |
| 644 |
if cd_action == 'create': |
| 645 |
self.create_volume() |
| 646 |
elif cd_action == 'delete': |
| 647 |
self.delete_volume() |
| 648 |
elif modify: |
| 649 |
self.modify_volume(modify) |
| 650 |
self.module.exit_json(changed=self.na_helper.changed) |
| 651 |
|
| 652 |
|
| 653 |
def main(): |
| 654 |
'''Main Function''' |
| 655 |
volume = NetAppCloudmanagerVolume() |
| 656 |
volume.apply() |
| 657 |
|
| 658 |
|
| 659 |
if __name__ == '__main__': |
| 660 |
main() |