netapp.ontap.na_ontap_cg_snapshot module – NetApp ONTAP manage consistency group snapshot

Note

This module is part of the netapp.ontap collection (version 23.5.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_cg_snapshot.

New in netapp.ontap 2.7.0

Synopsis
Requirements
Parameters
Notes
Examples

Synopsis

Create or delete consistency group snapshot for ONTAP volumes.

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.
netapp-lib only when using ZAPI (install using ‘pip install netapp-lib’), Please note that netapp-lib is deprecated and no longer maintained. Proceed at your own risk.
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.
comment string added in netapp.ontap 22.8.0	Comment for the snapshot copy. Only supported with REST.
consistency_group string added in netapp.ontap 22.8.0	Name of the consistency group for which snapshot needs to be created or deleted. Valid only with REST.
consistency_type string added in netapp.ontap 23.2.0	Type of consistency guarantee for the snapshot. Only supported with REST. If not specified, ONTAP uses its default consistency type. Choices: `"crash"` `"application"`
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.
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`
key_filepath string added in netapp.ontap 20.6.0	path to SSL client key file.
ontapi integer	The ontap api version to use
password aliases: pass string	Password for the specified user.
snapmirror_label string	A human readable SnapMirror label to be attached with the consistency group snapshot copies.
snapshot string / required	The provided name of the snapshot that is created in each volume.
state string	Specifies whether to create or delete the snapshot. Choice ‘absent’ is valid only with REST. Choices: `"present"` ← (default) `"absent"`
timeout string	Timeout selector. Not supported with REST. Choices: `"urgent"` `"medium"` ← (default) `"relaxed"`
use_lambda boolean added in netapp.ontap 23.2.0	Specifies if AWS Lambda proxy functionality should be used to connect to the ONTAP system. Supported only with REST. Choices: `false` ← (default) `true`
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: `"always"`
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://docs.netapp.com/us-en/ontap/authentication/create-svm-user-accounts-task.html. Two authentication methods are supported Basic authentication, using username and password. 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)
volumes list / elements=string	A list of volumes in this filer that is part of this CG operation. Required with ZAPI.
vserver string / required	Name of the vserver.

Notes

Note

REST support requires ONTAP 9.10 or later.
Delete operation is supported only with REST.
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 CG snapshot
  na_ontap_cg_snapshot:
    state: present
    vserver: vserver_name
    snapshot: snapshot name
    volumes: vol_name
    # consistency_type defaults to 'crash' if not specified
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"
    hostname: "{{ netapp_hostname }}"

- name: Create CG snapshot using CG name - REST
  na_ontap_cg_snapshot:
    state: present
    vserver: vserver_name
    snapshot: snapshot_name
    consistency_group: cg_name
    snapmirror_label: sm_label
    consistency_type: application
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"
    hostname: "{{ netapp_hostname }}"

- name: Create CG snapshot using volumes - REST
  na_ontap_cg_snapshot:
    state: present
    vserver: vserver_name
    snapshot: snapshot_name
    volumes:
      - vol1
      - vol2
    snapmirror_label: sm_label
    consistency_type: crash
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"
    hostname: "{{ netapp_hostname }}"

- name: Delete CG snapshot - REST
  na_ontap_cg_snapshot:
    state: absent
    vserver: vserver_name
    snapshot: snapshot_name
    consistency_group: cg_name
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"
    hostname: "{{ netapp_hostname }}"

Authors

NetApp Ansible Team (@carchi8py)

Collection links

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