netapp.ontap.na_ontap_volume_clone – NetApp ONTAP manage volume clones.

Note

This plugin is part of the netapp.ontap collection (version 21.1.1).

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

To use it in a playbook, specify: netapp.ontap.na_ontap_volume_clone.

New in version 2.6.0: of netapp.ontap

Synopsis
Requirements
Parameters
Notes
Examples

Synopsis

Create NetApp ONTAP volume clones.
A FlexClone License is required to use this module

Requirements

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

Ansible 2.9
Python3 netapp-lib (2018.11.13) or later. Install using ‘pip install netapp-lib’
netapp-lib 2020.3.12 is strongly recommended as it provides better error reporting for connection issues.
A physical or virtual clustered Data ONTAP system. The modules support Data ONTAP 9.1 and onward.
REST support requires ONTAP 9.6 or later.
To enable http on the cluster you must run the following commands ‘set -privilege advanced;’ ‘system services web modify -http-enabled true;’

Parameters

Parameter	Choices/Defaults	Comments
cert_filepath string added in 20.6.0 of netapp.ontap		path to SSL client cert file (.pem). not supported with python 2.6.
feature_flags dictionary added in 20.5.0 of netapp.ontap		Enable or disable a new feature. This can be used to enable an experimental feature or disable a new feature that breaks backward compatibility. Supported keys and values are subject to change without notice. Unknown keys are ignored.
gid integer added in 2.9.0 of netapp.ontap		The UNIX group ID for the clone volume.
hostname string / required		The hostname or IP address of the ONTAP instance.
http_port integer		Override the default port (80 or 443) with this port
https boolean	no ← yes	Enable and disable https. Ignored when using REST as only https is supported. Ignored when using SSL certificate authentication as it requires SSL.
junction_path string added in 2.8.0 of netapp.ontap		Junction path of the volume.
key_filepath string added in 20.6.0 of netapp.ontap		path to SSL client key file.
name string / required		The name of the volume clone being created. aliases: volume
ontapi integer		The ontap api version to use
parent_snapshot string		Parent snapshot in which volume clone is created off.
parent_volume string / required		The parent volume of the volume clone being created.
parent_vserver string		Vserver of parent volume in which clone is created off.
password string		Password for the specified user. aliases: pass
qos_policy_group_name string		The qos-policy-group-name which should be set for volume clone.
space_reserve string	volume none	The space_reserve setting which should be used for the volume clone.
split boolean added in 20.2.0 of netapp.ontap	no yes	Split clone volume from parent volume.
state string	present ←	Whether volume clone should be created.
uid integer added in 2.9.0 of netapp.ontap		The UNIX user ID for the clone volume.
use_rest string	Default: "auto"	REST API if supported by the target system for all the resources and attributes the module requires. Otherwise will revert to ZAPI. always -- will always use the REST API never -- will always use the ZAPI auto -- will try to use the REST Api
username string		This can be a Cluster-scoped or SVM-scoped account, depending on whether a Cluster-level or SVM-level API is required. For more information, please read the documentation https://mysupport.netapp.com/NOW/download/software/nmsdk/9.4/. Two authentication methods are supported 1. basic authentication, using username and password, 2. SSL certificate authentication, using a ssl client cert file, and optionally a private key file. To use a certificate, the certificate must have been installed in the ONTAP cluster, and cert authentication must have been enabled. aliases: user
validate_certs boolean	no yes ←	If set to `no`, the SSL certificates will not be validated. This should only set to `False` used on personally controlled sites using self-signed certificates.
volume_type string	rw dp	The volume-type setting which should be used for the volume clone.
vserver string / required		Vserver in which the volume clone should be created.

Notes

Note

The modules prefixed with na\_ontap are built to support the ONTAP storage platform.

Examples

- name: create volume clone
  na_ontap_volume_clone:
    state: present
    username: "{{ netapp username }}"
    password: "{{ netapp password }}"
    hostname: "{{ netapp hostname }}"
    vserver: vs_hack
    parent_volume: normal_volume
    name: clone_volume_7
    space_reserve: none
    parent_snapshot: backup1
    junction_path: /clone_volume_7
    uid: 1
    gid: 1

Authors

NetApp Ansible Team (@carchi8py) <[email protected]>

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/netapp/ontap/na_ontap_volume_clone_module.html