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

Note

This module is part of the netapp.ontap collection (version 22.7.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install netapp.ontap. You need further requirements to be able to use this module, see Requirements for details.

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

New in netapp.ontap 2.6.0

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 or later - 2.12 or later is recommended.

  • Python3 - 3.9 or later is recommended.

  • When using ZAPI, 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

Parameters

Parameter

Comments

cert_filepath

string

added in netapp.ontap 20.6.0

path to SSL client cert file (.pem).

not supported with python 2.6.

feature_flags

dictionary

added in netapp.ontap 20.5.0

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.

force_ontap_version

string

added in netapp.ontap 21.23.0

Override the cluster ONTAP version when using REST.

The behavior is undefined if the version does not match the target cluster.

This is provided as a work-around when the cluster version cannot be read because of permission issues. See https://github.com/ansible-collections/netapp.ontap/wiki/Known-issues.

This should be in the form 9.10 or 9.10.1 with each element being an integer number.

When use_rest is set to auto, this may force a switch to ZAPI based on the version and platform capabilities.

Ignored with ZAPI.

gid

integer

added in netapp.ontap 2.9.0

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

Enable and disable https.

Ignored when using REST as only https is supported.

Ignored when using SSL certificate authentication as it requires SSL.

Choices:

  • false ← (default)

  • true

junction_path

string

added in netapp.ontap 2.8.0

Junction path of the volume.

key_filepath

string

added in netapp.ontap 20.6.0

path to SSL client key file.

name

aliases: volume

string / required

The name of the volume clone being created.

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

aliases: pass

string

Password for the specified user.

qos_policy_group_name

string

The qos-policy-group-name which should be set for volume clone.

space_reserve

string

The space_reserve setting which should be used for the volume clone.

Choices:

  • "volume"

  • "none"

split

boolean

added in netapp.ontap 20.2.0

Split clone volume from parent volume.

Choices:

  • false

  • true

state

string

Whether volume clone should be created.

Choices:

  • "present" ← (default)

uid

integer

added in netapp.ontap 2.9.0

The UNIX user ID for the clone volume.

use_rest

string

Whether to use REST or ZAPI.

always – will always use the REST API if the module supports REST. A warning is issued if the module does not support REST. An error is issued if a module option is not supported in REST.

never – will always use ZAPI if the module supports ZAPI. An error may be issued if a REST option is not supported in ZAPI.

auto – will try to use the REST API if the module supports REST and modules options are supported. Reverts to ZAPI otherwise.

Default: "auto"

username

aliases: user

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.

validate_certs

boolean

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.

Choices:

  • false

  • true ← (default)

volume_type

string

The volume-type setting which should be used for the volume clone.

Choices:

  • "rw"

  • "dp"

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.

  • https is enabled by default and recommended. To enable http on the cluster you must run the following commands ‘set -privilege advanced;’ ‘system services web modify -http-enabled true;’

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)