netapp.ontap.na_ontap_snapshot – NetApp ONTAP manage Snapshots
Note
This plugin is part of the netapp.ontap collection (version 21.12.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
.
To use it in a playbook, specify: netapp.ontap.na_ontap_snapshot
.
New in version 2.6.0: of netapp.ontap
Synopsis
- Create/Modify/Delete ONTAP snapshots
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 |
---|---|---|
async_bool boolean |
| If true, the snapshot is to be created asynchronously. |
cert_filepath string added in 20.6.0 of netapp.ontap | path to SSL client cert file (.pem). not supported with python 2.6. | |
comment string | A human readable comment attached with the snapshot. The size of the comment can be at most 255 characters. | |
expiry_time string added in 21.8.0 of netapp.ontap | Snapshot expire time. | |
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. | |
from_name string added in 2.8.0 of netapp.ontap | Name of the existing snapshot to be renamed to. | |
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. |
ignore_owners boolean |
| if this field is true, snapshot will be deleted even if some other processes are accessing it. |
key_filepath string added in 20.6.0 of netapp.ontap | path to SSL client key file. | |
ontapi integer | The ontap api version to use | |
password string | Password for the specified user. aliases: pass | |
snapmirror_label string | A human readable SnapMirror Label attached with the snapshot. Size of the label can be at most 31 characters. | |
snapshot string / required | Name of the snapshot to be managed. The maximum string length is 256 characters. | |
snapshot_instance_uuid string | The 128 bit unique snapshot identifier expressed in the form of UUID. | |
state string |
| If you want to create/modify a snapshot, or delete it. |
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 |
| 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 string / required | Name of the volume on which the snapshot is to be created. | |
vserver string / required | The Vserver name |
Notes
Note
- The modules prefixed with na_ontap are built to support the ONTAP storage platform.
Examples
- name: create SnapShot tags: - create na_ontap_snapshot: state: present snapshot: "{{ snapshot name }}" volume: "{{ vol name }}" comment: "i am a comment" expiry_time: "2022-02-04T14:00:00-05:00" vserver: "{{ vserver name }}" username: "{{ netapp username }}" password: "{{ netapp password }}" hostname: "{{ netapp hostname }}" - name: delete SnapShot tags: - delete na_ontap_snapshot: state: absent snapshot: "{{ snapshot name }}" volume: "{{ vol name }}" vserver: "{{ vserver name }}" username: "{{ netapp username }}" password: "{{ netapp password }}" hostname: "{{ netapp hostname }}" - name: modify SnapShot tags: - modify na_ontap_snapshot: state: present snapshot: "{{ snapshot name }}" comment: "New comments are great" volume: "{{ vol name }}" vserver: "{{ vserver name }}" username: "{{ netapp username }}" password: "{{ netapp password }}" hostname: "{{ netapp hostname }}"
Authors
- NetApp Ansible Team (@carchi8py) <ng-ansibleteam@netapp.com>
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/netapp/ontap/na_ontap_snapshot_module.html