Docs4dev
Docs
ansible / 2.10 / collections / netapp / elementsw / na_elementsw_volume_clone_module.html

netapp.elementsw.na_elementsw_volume_clone – NetApp Element Software Create Volume Clone

Note

This plugin is part of the netapp.elementsw collection (version 20.11.0).

To install it use: ansible-galaxy collection install netapp.elementsw.

To use it in a playbook, specify: netapp.elementsw.na_elementsw_volume_clone.

New in version 2.7.0: of netapp.elementsw

Synopsis

  • Create volume clones on Element OS

Requirements

The below requirements are needed on the host that executes this module.

  • The modules were developed with SolidFire 10.1
  • solidfire-sdk-python (1.1.0.92) or greater. Install using ‘pip install solidfire-sdk-python’

Parameters

Parameter Choices/Defaults Comments
access
string
    Choices:
  • readOnly
  • readWrite
  • locked
  • replicationTarget
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.
account_id
string / required
Account ID for the owner of this cloned volume. id may be a numeric identifier or an account name.
attributes
dictionary
A YAML dictionary of attributes that you would like to apply on this cloned volume.
hostname
string / required
The hostname or IP address of the SolidFire cluster.
For na_elementsw_cluster, the Management IP (MIP) or hostname of the node to initiate the cluster creation from.
name
string / required
The name of the clone.
password
string / required
Password for the specified user.

aliases: pass
size
integer
The size of the cloned volume in (size_unit).
size_unit
string
    Choices:
  • bytes
  • b
  • kb
  • mb
  • gb ←
  • tb
  • pb
  • eb
  • zb
  • yb
The unit used to interpret the size parameter.
src_snapshot_id
string
The id of the snapshot to clone. id may be a numeric identifier or a snapshot name.
src_volume_id
string / required
The id of the src volume to clone. id may be a numeric identifier or a volume name.
username
string / required
Please ensure that the user has the adequate permissions. For more information, please read the official documentation https://mysupport.netapp.com/documentation/docweb/index.html?productID=62636&language=en-US.

aliases: user

Notes

Note

  • The modules prefixed with na\_elementsw are built to support the SolidFire storage platform.

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 Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
msg
string
success
Success message



Authors

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/netapp/elementsw/na_elementsw_volume_clone_module.html