netapp.ontap.na_ontap_storage_unit_snapshot module – NetApp ONTAP ASA r2 storage unit snapshot
Note
This module is part of the netapp.ontap collection (version 23.1.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_storage_unit_snapshot.
New in netapp.ontap 23.0.0
Synopsis
Create/modify/delete storage unit snapshot.
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 |
|---|---|
path to SSL client cert file (.pem). not supported with python 2.6. |
|
A comment associated with the snapshot. |
|
Specifies the expiry time for the snapshot. Example, 2025-04-09T07:30:00-04:00. Snapshots with an expiry time set are not allowed to be deleted until the retention time is reached. |
|
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. |
|
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. |
|
Specifies the name of the snapshot to be renamed. |
|
The hostname or IP address of the ONTAP instance. |
|
Override the default port (80 or 443) with this port |
|
Enable and disable https. Ignored when using REST as only https is supported. Ignored when using SSL certificate authentication as it requires SSL. Choices:
|
|
path to SSL client key file. |
|
Specifies the name of the snapshot. |
|
Password for the specified user. |
|
Specifies label for SnapMirror operations. |
|
Specifies whether the specified storage unit should exist or not. Choices:
|
|
Specifies the storage unit in which the snapshot is located. |
|
This module only supports REST. always – will always use the REST API. A warning is issued if the module does not support REST. Default: |
|
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
To use a certificate, the certificate must have been installed in the ONTAP cluster, and cert authentication must have been enabled. |
|
If set to This should only set to Choices:
|
|
Specifies the SVM in which the storage unit is located. |
Notes
Note
Only supported with REST and requires ONTAP 9.16.1 or later.
Only suppored with ASA r2 systems.
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 a snapshot for LUN storage unit
netapp.ontap.na_ontap_storage_unit_snapshot:
state: present
name: lun1_snap1
vserver: ansibleSVM
storage_unit: lun1
expiry_time: 2025-04-09T07:30:00-04:00
snapmirror_label: my_label
comment: "snapshot for lun1"
hostname: "{{ netapp_hostname }}"
username: "{{ netapp_username }}"
password: "{{ netapp_password }}"
https: true
validate_certs: "{{ validate_certs }}"
use_rest: always
- name: Update a snapshot
netapp.ontap.na_ontap_storage_unit_snapshot:
name: lun1_snap1
vserver: ansibleSVM
storage_unit: lun1
expiry_time: 2025-04-09T08:30:00-04:00
snapmirror_label: another_label
comment: "updated expiry date, label"
hostname: "{{ netapp_hostname }}"
username: "{{ netapp_username }}"
password: "{{ netapp_password }}"
https: true
validate_certs: "{{ validate_certs }}"
use_rest: always
- name: Rename a storage unit snapshot
netapp.ontap.na_ontap_storage_unit_snapshot:
name: lun1_snapshot1
from_name: lun1_snap1
vserver: ansibleSVM
storage_unit: lun1
expiry_time: 2025-04-09T08:30:00-04:00
snapmirror_label: another_label
comment: "snapshot for lun1"
hostname: "{{ netapp_hostname }}"
username: "{{ netapp_username }}"
password: "{{ netapp_password }}"
https: true
validate_certs: "{{ validate_certs }}"
use_rest: always
- name: Delete a snapshot
netapp.ontap.na_ontap_mav_approval_group:
state: absent
name: lun1_snapshot1
hostname: "{{ netapp_hostname }}"
username: "{{ netapp_username }}"
password: "{{ netapp_password }}"
https: true
validate_certs: "{{ validate_certs }}"
use_rest: always