mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
parent
86037bc840
commit
e2ae09117d
1 changed files with 271 additions and 0 deletions
271
lib/ansible/modules/storage/netapp/na_elementsw_volume_clone.py
Normal file
271
lib/ansible/modules/storage/netapp/na_elementsw_volume_clone.py
Normal file
|
@ -0,0 +1,271 @@
|
|||
#!/usr/bin/python
|
||||
|
||||
# (c) 2018, NetApp, Inc
|
||||
# GNU General Public License v3.0+ (see COPYING or
|
||||
# https://www.gnu.org/licenses/gpl-3.0.txt)
|
||||
|
||||
"""Element Software volume clone"""
|
||||
|
||||
from __future__ import absolute_import, division, print_function
|
||||
__metaclass__ = type
|
||||
|
||||
|
||||
ANSIBLE_METADATA = {'metadata_version': '1.1',
|
||||
'status': ['preview'],
|
||||
'supported_by': 'community'}
|
||||
|
||||
|
||||
DOCUMENTATION = '''
|
||||
|
||||
module: na_elementsw_volume_clone
|
||||
|
||||
short_description: NetApp Element Software Create Volume Clone
|
||||
extends_documentation_fragment:
|
||||
- netapp.solidfire
|
||||
version_added: '2.7'
|
||||
author: NetApp Ansible Team (ng-ansibleteam@netapp.com)
|
||||
description:
|
||||
- Create volume clones on Element OS
|
||||
|
||||
options:
|
||||
|
||||
name:
|
||||
description:
|
||||
- The name of the clone.
|
||||
required: true
|
||||
|
||||
src_volume_id:
|
||||
description:
|
||||
- The id of the src volume to clone. id may be a numeric identifier or a volume name.
|
||||
required: true
|
||||
|
||||
src_snapshot_id:
|
||||
description:
|
||||
- The id of the snapshot to clone. id may be a numeric identifier or a snapshot name.
|
||||
|
||||
account_id:
|
||||
description:
|
||||
- Account ID for the owner of this cloned volume. id may be a numeric identifier or an account name.
|
||||
required: true
|
||||
|
||||
attributes:
|
||||
description: A YAML dictionary of attributes that you would like to apply on this cloned volume.
|
||||
|
||||
size:
|
||||
description:
|
||||
- The size of the cloned volume in (size_unit).
|
||||
|
||||
size_unit:
|
||||
description:
|
||||
- The unit used to interpret the size parameter.
|
||||
choices: ['bytes', 'b', 'kb', 'mb', 'gb', 'tb', 'pb', 'eb', 'zb', 'yb']
|
||||
default: 'gb'
|
||||
|
||||
access:
|
||||
choices: ['readOnly', 'readWrite', 'locked', 'replicationTarget']
|
||||
description:
|
||||
- Access allowed for the volume.
|
||||
- If unspecified, the access settings of the clone will be the same as the source.
|
||||
- readOnly - Only read operations are allowed.
|
||||
- readWrite - Reads and writes are allowed.
|
||||
- locked - No reads or writes are allowed.
|
||||
- replicationTarget - Identify a volume as the target volume for a paired set of volumes. If the volume is not paired, the access status is locked.
|
||||
|
||||
'''
|
||||
|
||||
EXAMPLES = """
|
||||
- name: Clone Volume
|
||||
na_elementsw_volume_clone:
|
||||
hostname: "{{ elementsw_hostname }}"
|
||||
username: "{{ elementsw_username }}"
|
||||
password: "{{ elementsw_password }}"
|
||||
name: CloneAnsibleVol
|
||||
src_volume_id: 123
|
||||
src_snapshot_id: 41
|
||||
account_id: 3
|
||||
size: 1
|
||||
size_unit: gb
|
||||
access: readWrite
|
||||
attributes: {"virtual_network_id": 12345}
|
||||
|
||||
"""
|
||||
|
||||
RETURN = """
|
||||
|
||||
msg:
|
||||
description: Success message
|
||||
returned: success
|
||||
type: string
|
||||
|
||||
"""
|
||||
|
||||
from ansible.module_utils.basic import AnsibleModule
|
||||
from ansible.module_utils._text import to_native
|
||||
import ansible.module_utils.netapp as netapp_utils
|
||||
from ansible.module_utils.netapp_elementsw_module import NaElementSWModule
|
||||
|
||||
HAS_SF_SDK = netapp_utils.has_sf_sdk()
|
||||
|
||||
|
||||
class ElementOSVolumeClone(object):
|
||||
"""
|
||||
Contains methods to parse arguments,
|
||||
derive details of Element Software objects
|
||||
and send requests to Element OS via
|
||||
the Solidfire SDK
|
||||
"""
|
||||
|
||||
def __init__(self):
|
||||
"""
|
||||
Parse arguments, setup state variables,
|
||||
check paramenters and ensure SDK is installed
|
||||
"""
|
||||
self._size_unit_map = netapp_utils.SF_BYTE_MAP
|
||||
|
||||
self.argument_spec = netapp_utils.ontap_sf_host_argument_spec()
|
||||
self.argument_spec.update(dict(
|
||||
name=dict(required=True),
|
||||
src_volume_id=dict(required=True),
|
||||
src_snapshot_id=dict(),
|
||||
account_id=dict(required=True),
|
||||
|
||||
attributes=dict(type='dict', default=None),
|
||||
|
||||
size=dict(type='int'),
|
||||
size_unit=dict(default='gb',
|
||||
choices=['bytes', 'b', 'kb', 'mb', 'gb', 'tb',
|
||||
'pb', 'eb', 'zb', 'yb'], type='str'),
|
||||
|
||||
access=dict(type='str',
|
||||
default=None, choices=['readOnly', 'readWrite',
|
||||
'locked', 'replicationTarget']),
|
||||
|
||||
))
|
||||
|
||||
self.module = AnsibleModule(
|
||||
argument_spec=self.argument_spec,
|
||||
supports_check_mode=True
|
||||
)
|
||||
|
||||
parameters = self.module.params
|
||||
|
||||
# set up state variables
|
||||
self.name = parameters['name']
|
||||
self.src_volume_id = parameters['src_volume_id']
|
||||
self.src_snapshot_id = parameters['src_snapshot_id']
|
||||
self.account_id = parameters['account_id']
|
||||
self.attributes = parameters['attributes']
|
||||
|
||||
self.size_unit = parameters['size_unit']
|
||||
if parameters['size'] is not None:
|
||||
self.size = parameters['size'] * \
|
||||
self._size_unit_map[self.size_unit]
|
||||
else:
|
||||
self.size = None
|
||||
self.access = parameters['access']
|
||||
|
||||
if HAS_SF_SDK is False:
|
||||
self.module.fail_json(
|
||||
msg="Unable to import the SolidFire Python SDK")
|
||||
else:
|
||||
self.sfe = netapp_utils.create_sf_connection(module=self.module)
|
||||
|
||||
self.elementsw_helper = NaElementSWModule(self.sfe)
|
||||
|
||||
# add telemetry attributes
|
||||
if self.attributes is not None:
|
||||
self.attributes.update(self.elementsw_helper.set_element_attributes(source='na_elementsw_volume_clone'))
|
||||
else:
|
||||
self.attributes = self.elementsw_helper.set_element_attributes(source='na_elementsw_volume_clone')
|
||||
|
||||
def get_account_id(self):
|
||||
"""
|
||||
Return account id if found
|
||||
"""
|
||||
try:
|
||||
# Update and return self.account_id
|
||||
self.account_id = self.elementsw_helper.account_exists(self.account_id)
|
||||
return self.account_id
|
||||
except Exception as err:
|
||||
self.module.fail_json(msg="Error: account_id %s does not exist" % self.account_id, exception=to_native(err))
|
||||
|
||||
def get_snapshot_id(self):
|
||||
"""
|
||||
Return snapshot details if found
|
||||
"""
|
||||
src_snapshot = self.elementsw_helper.get_snapshot(self.src_snapshot_id, self.src_volume_id)
|
||||
# Update and return self.src_snapshot_id
|
||||
if src_snapshot is not None:
|
||||
self.src_snapshot_id = src_snapshot.snapshot_id
|
||||
# Return src_snapshot
|
||||
return self.src_snapshot_id
|
||||
return None
|
||||
|
||||
def get_src_volume_id(self):
|
||||
"""
|
||||
Return volume id if found
|
||||
"""
|
||||
src_vol_id = self.elementsw_helper.volume_exists(self.src_volume_id, self.account_id)
|
||||
if src_vol_id is not None:
|
||||
# Update and return self.volume_id
|
||||
self.src_volume_id = src_vol_id
|
||||
# Return src_volume_id
|
||||
return self.src_volume_id
|
||||
return None
|
||||
|
||||
def clone_volume(self):
|
||||
"""Clone Volume from source"""
|
||||
try:
|
||||
self.sfe.clone_volume(volume_id=self.src_volume_id,
|
||||
name=self.name,
|
||||
new_account_id=self.account_id,
|
||||
new_size=self.size,
|
||||
access=self.access,
|
||||
snapshot_id=self.src_snapshot_id,
|
||||
attributes=self.attributes)
|
||||
|
||||
except Exception as err:
|
||||
self.module.fail_json(msg="Error creating clone %s of size %s" % (self.name, self.size), exception=to_native(err))
|
||||
|
||||
def apply(self):
|
||||
"""Perform pre-checks, call functions and exit"""
|
||||
changed = False
|
||||
result_message = ""
|
||||
|
||||
if self.get_account_id() is None:
|
||||
self.module.fail_json(msg="Account id not found: %s" % (self.account_id))
|
||||
|
||||
# there is only one state. other operations
|
||||
# are part of the volume module
|
||||
|
||||
# ensure that a volume with the clone name
|
||||
# isn't already present
|
||||
if self.elementsw_helper.volume_exists(self.name, self.account_id) is None:
|
||||
# check for the source volume
|
||||
if self.get_src_volume_id() is not None:
|
||||
# check for a valid snapshot
|
||||
if self.src_snapshot_id and not self.get_snapshot_id():
|
||||
self.module.fail_json(msg="Snapshot id not found: %s" % (self.src_snapshot_id))
|
||||
# change required
|
||||
changed = True
|
||||
else:
|
||||
self.module.fail_json(msg="Volume id not found %s" % (self.src_volume_id))
|
||||
|
||||
if changed:
|
||||
if self.module.check_mode:
|
||||
result_message = "Check mode, skipping changes"
|
||||
else:
|
||||
self.clone_volume()
|
||||
result_message = "Volume cloned"
|
||||
|
||||
self.module.exit_json(changed=changed, msg=result_message)
|
||||
|
||||
|
||||
def main():
|
||||
"""Create object and call apply"""
|
||||
volume_clone = ElementOSVolumeClone()
|
||||
volume_clone.apply()
|
||||
|
||||
|
||||
if __name__ == '__main__':
|
||||
main()
|
Loading…
Reference in a new issue