361 lines
11 KiB
Python
361 lines
11 KiB
Python
#!/usr/bin/python
|
|
# -*- coding: utf-8 -*-
|
|
|
|
# (c) 2018, Simon Dodsley (simon@purestorage.com)
|
|
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
|
|
|
|
from __future__ import absolute_import, division, print_function
|
|
__metaclass__ = type
|
|
|
|
ANSIBLE_METADATA = {'metadata_version': '1.1',
|
|
'status': ['preview'],
|
|
'supported_by': 'community'}
|
|
|
|
DOCUMENTATION = r'''
|
|
---
|
|
module: purefa_volume
|
|
version_added: '2.4'
|
|
short_description: Manage volumes on Pure Storage FlashArrays
|
|
description:
|
|
- Create, delete or extend the capacity of a volume on Pure Storage FlashArray.
|
|
author:
|
|
- Simon Dodsley (@sdodsley)
|
|
options:
|
|
name:
|
|
description:
|
|
- The name of the volume.
|
|
required: true
|
|
target:
|
|
description:
|
|
- The name of the target volume, if copying.
|
|
state:
|
|
description:
|
|
- Define whether the volume should exist or not.
|
|
default: present
|
|
choices: [ absent, present ]
|
|
eradicate:
|
|
description:
|
|
- Define whether to eradicate the volume on delete or leave in trash.
|
|
type: bool
|
|
default: 'no'
|
|
overwrite:
|
|
description:
|
|
- Define whether to overwrite a target volume if it already exisits.
|
|
type: bool
|
|
default: 'no'
|
|
size:
|
|
description:
|
|
- Volume size in M, G, T or P units.
|
|
qos:
|
|
description:
|
|
- Bandwidth limit for volume in M or G units.
|
|
M will set MB/s
|
|
G will set GB/s
|
|
To clear an existing Qos setting using 0 (zero)
|
|
version_added: '2.8'
|
|
extends_documentation_fragment:
|
|
- purestorage.fa
|
|
'''
|
|
|
|
EXAMPLES = r'''
|
|
- name: Create new volume named foo with a QoS limit
|
|
purefa_volume:
|
|
name: foo
|
|
size: 1T
|
|
qos: 58M
|
|
fa_url: 10.10.10.2
|
|
api_token: e31060a7-21fc-e277-6240-25983c6c4592
|
|
state: present
|
|
|
|
- name: Extend the size of an existing volume named foo
|
|
purefa_volume:
|
|
name: foo
|
|
size: 2T
|
|
fa_url: 10.10.10.2
|
|
api_token: e31060a7-21fc-e277-6240-25983c6c4592
|
|
state: present
|
|
|
|
- name: Delete and eradicate volume named foo
|
|
purefa_volume:
|
|
name: foo
|
|
eradicate: yes
|
|
fa_url: 10.10.10.2
|
|
api_token: e31060a7-21fc-e277-6240-25983c6c4592
|
|
state: absent
|
|
|
|
- name: Create clone of volume bar named foo
|
|
purefa_volume:
|
|
name: foo
|
|
target: bar
|
|
fa_url: 10.10.10.2
|
|
api_token: e31060a7-21fc-e277-6240-25983c6c4592
|
|
state: present
|
|
|
|
- name: Overwrite volume bar with volume foo
|
|
purefa_volume:
|
|
name: foo
|
|
target: bar
|
|
overwrite: yes
|
|
fa_url: 10.10.10.2
|
|
api_token: e31060a7-21fc-e277-6240-25983c6c4592
|
|
state: present
|
|
|
|
- name: Clear volume QoS from volume foo
|
|
purefa_volume:
|
|
name: foo
|
|
qos: 0
|
|
fa_url: 10.10.10.2
|
|
api_token: e31060a7-21fc-e277-6240-25983c6c4592
|
|
state: present
|
|
'''
|
|
|
|
RETURN = r'''
|
|
volume:
|
|
description: A dictionary describing the changed volume. Only some
|
|
attributes below will be returned with various actions.
|
|
type: dict
|
|
returned: success
|
|
contains:
|
|
source:
|
|
description: Volume name of source volume used for volume copy
|
|
type: str
|
|
serial:
|
|
description: Volume serial number
|
|
type: str
|
|
sample: '361019ECACE43D83000120A4'
|
|
created:
|
|
description: Volume creation time
|
|
type: str
|
|
sample: '2019-03-13T22:49:24Z'
|
|
name:
|
|
description: Volume name
|
|
type: str
|
|
size:
|
|
description: Volume size in bytes
|
|
type: int
|
|
'''
|
|
|
|
from ansible.module_utils.basic import AnsibleModule
|
|
from ansible.module_utils.pure import get_system, purefa_argument_spec
|
|
|
|
|
|
QOS_API_VERSION = "1.14"
|
|
|
|
|
|
def human_to_bytes(size):
|
|
"""Given a human-readable byte string (e.g. 2G, 30M),
|
|
return the number of bytes. Will return 0 if the argument has
|
|
unexpected form.
|
|
"""
|
|
bytes = size[:-1]
|
|
unit = size[-1]
|
|
if bytes.isdigit():
|
|
bytes = int(bytes)
|
|
if unit == 'P':
|
|
bytes *= 1125899906842624
|
|
elif unit == 'T':
|
|
bytes *= 1099511627776
|
|
elif unit == 'G':
|
|
bytes *= 1073741824
|
|
elif unit == 'M':
|
|
bytes *= 1048576
|
|
else:
|
|
bytes = 0
|
|
else:
|
|
bytes = 0
|
|
return bytes
|
|
|
|
|
|
def get_volume(module, array):
|
|
"""Return Volume or None"""
|
|
try:
|
|
return array.get_volume(module.params['name'])
|
|
except Exception:
|
|
return None
|
|
|
|
|
|
def get_destroyed_volume(module, array):
|
|
"""Return Destroyed Volume or None"""
|
|
try:
|
|
if array.get_volume(module.params['name'], pending=True)['time_remaining'] != '':
|
|
return True
|
|
else:
|
|
return False
|
|
except Exception:
|
|
return False
|
|
|
|
|
|
def get_target(module, array):
|
|
"""Return Volume or None"""
|
|
try:
|
|
return array.get_volume(module.params['target'])
|
|
except Exception:
|
|
return None
|
|
|
|
|
|
def create_volume(module, array):
|
|
"""Create Volume"""
|
|
changed = False
|
|
api_version = array._list_available_rest_versions()
|
|
if module.params['qos'] and QOS_API_VERSION in api_version:
|
|
if 549755813888 >= int(human_to_bytes(module.params['qos'])) >= 1048576:
|
|
try:
|
|
volume = array.create_volume(module.params['name'],
|
|
module.params['size'],
|
|
bandwidth_limit=module.params['qos'])
|
|
changed = True
|
|
except Exception:
|
|
module.fail_json(msg='Volume {0} creation failed.'.format(module.params['name']))
|
|
else:
|
|
module.fail_json(msg='QoS value {0} out of range.'.format(module.params['qos']))
|
|
else:
|
|
try:
|
|
volume = array.create_volume(module.params['name'], module.params['size'])
|
|
changed = True
|
|
except Exception:
|
|
module.fail_json(msg='Volume {0} creation failed.'.format(module.params['name']))
|
|
|
|
module.exit_json(changed=changed, volume=volume)
|
|
|
|
|
|
def copy_from_volume(module, array):
|
|
"""Create Volume Clone"""
|
|
changed = False
|
|
|
|
tgt = get_target(module, array)
|
|
|
|
if tgt is None:
|
|
try:
|
|
volume = array.copy_volume(module.params['name'],
|
|
module.params['target'])
|
|
changed = True
|
|
except Exception:
|
|
module.fail_json(msg='Copy volume {0} to volume {1} failed.'.format(module.params['name'],
|
|
module.params['target']))
|
|
elif tgt is not None and module.params['overwrite']:
|
|
try:
|
|
volume = array.copy_volume(module.params['name'],
|
|
module.params['target'],
|
|
overwrite=module.params['overwrite'])
|
|
changed = True
|
|
except Exception:
|
|
module.fail_json(msg='Copy volume {0} to volume {1} failed.'.format(module.params['name'],
|
|
module.params['target']))
|
|
|
|
module.exit_json(changed=changed, volume=volume)
|
|
|
|
|
|
def update_volume(module, array):
|
|
"""Update Volume size and/or QoS"""
|
|
changed = False
|
|
api_version = array._list_available_rest_versions()
|
|
vol = array.get_volume(module.params['name'])
|
|
if QOS_API_VERSION in api_version:
|
|
vol_qos = array.get_volume(module.params['name'], qos=True)
|
|
if vol_qos['bandwidth_limit'] is None:
|
|
vol_qos['bandwidth_limit'] = 0
|
|
if module.params['size']:
|
|
if human_to_bytes(module.params['size']) != vol['size']:
|
|
if human_to_bytes(module.params['size']) > vol['size']:
|
|
try:
|
|
volume = array.extend_volume(module.params['name'], module.params['size'])
|
|
changed = True
|
|
except Exception:
|
|
module.fail_json(msg='Volume {0} resize failed.'.format(module.params['name']))
|
|
if module.params['qos'] and QOS_API_VERSION in api_version:
|
|
if human_to_bytes(module.params['qos']) != vol_qos['bandwidth_limit']:
|
|
if module.params['qos'] == '0':
|
|
try:
|
|
volume = array.set_volume(module.params['name'], bandwidth_limit='')
|
|
changed = True
|
|
except Exception:
|
|
module.fail_json(msg='Volume {0} QoS removal failed.'.format(module.params['name']))
|
|
elif 549755813888 >= int(human_to_bytes(module.params['qos'])) >= 1048576:
|
|
try:
|
|
volume = array.set_volume(module.params['name'],
|
|
bandwidth_limit=module.params['qos'])
|
|
changed = True
|
|
except Exception:
|
|
module.fail_json(msg='Volume {0} QoS change failed.'.format(module.params['name']))
|
|
else:
|
|
module.fail_json(msg='QoS value {0} out of range. Check documentation.'.format(module.params['qos']))
|
|
|
|
module.exit_json(changed=changed, volume=volume)
|
|
|
|
|
|
def delete_volume(module, array):
|
|
""" Delete Volume"""
|
|
changed = False
|
|
try:
|
|
volume = array.destroy_volume(module.params['name'])
|
|
if module.params['eradicate']:
|
|
try:
|
|
volume = array.eradicate_volume(module.params['name'])
|
|
except Exception:
|
|
module.fail_json(msg='Eradicate volume {0} failed.'.format(module.params['name']))
|
|
changed = True
|
|
except Exception:
|
|
module.fail_json(msg='Delete volume {0} failed.'.format(module.params['name']))
|
|
module.exit_json(changed=changed, volume=volume)
|
|
|
|
|
|
def eradicate_volume(module, array):
|
|
""" Eradicate Deleted Volume"""
|
|
changed = False
|
|
if module.params['eradicate']:
|
|
try:
|
|
volume = array.eradicate_volume(module.params['name'])
|
|
changed = True
|
|
except Exception:
|
|
module.fail_json(msg='Eradication of volume {0} failed'.format(module.params['name']))
|
|
module.exit_json(changed=changed, volume=volume)
|
|
|
|
|
|
def main():
|
|
argument_spec = purefa_argument_spec()
|
|
argument_spec.update(dict(
|
|
name=dict(type='str', required=True),
|
|
target=dict(type='str'),
|
|
overwrite=dict(type='bool', default=False),
|
|
eradicate=dict(type='bool', default=False),
|
|
state=dict(type='str', default='present', choices=['absent', 'present']),
|
|
qos=dict(type='str'),
|
|
size=dict(type='str'),
|
|
))
|
|
|
|
mutually_exclusive = [['size', 'target'], ['qos', 'target']]
|
|
|
|
module = AnsibleModule(argument_spec,
|
|
mutually_exclusive=mutually_exclusive,
|
|
supports_check_mode=False)
|
|
|
|
size = module.params['size']
|
|
qos = module.params['qos']
|
|
state = module.params['state']
|
|
array = get_system(module)
|
|
volume = get_volume(module, array)
|
|
if not volume:
|
|
destroyed = get_destroyed_volume(module, array)
|
|
target = get_target(module, array)
|
|
|
|
if state == 'present' and not volume and size:
|
|
create_volume(module, array)
|
|
elif state == 'present' and volume and (size or qos):
|
|
update_volume(module, array)
|
|
elif state == 'present' and volume and target:
|
|
copy_from_volume(module, array)
|
|
elif state == 'present' and volume and not target:
|
|
copy_from_volume(module, array)
|
|
elif state == 'absent' and volume:
|
|
delete_volume(module, array)
|
|
elif state == 'absent' and destroyed:
|
|
eradicate_volume(module, array)
|
|
elif state == 'present' and not volume or not size:
|
|
module.exit_json(changed=False)
|
|
elif state == 'absent' and not volume:
|
|
module.exit_json(changed=False)
|
|
|
|
|
|
if __name__ == '__main__':
|
|
main()
|