na_ontap_snapshot - NetApp ONTAP manage Snapshots
- Create/Modify/Delete ONTAP snapshots
The below requirements are needed on the host that executes this module.
- A physical or virtual clustered Data ONTAP system. The modules were developed with Clustered Data ONTAP 9.3
- Ansible 2.6
- netapp-lib (2017.10.30). Install using ‘pip install netapp-lib’
- To enable http on the cluster you must run the following commands ‘set -privilege advanced;’ ‘system services web modify -http-enabled true;’
Parameter |
Choices/Defaults |
Comments |
async_bool
bool |
|
If true, the snapshot is to be created asynchronously.
|
comment
|
|
A human readable comment attached with the snapshot. The size of the comment can be at most 255 characters.
|
hostname
required |
|
The hostname or IP address of the ONTAP instance.
|
http_port
int |
|
Override the default port (80 or 443) with this port
|
https
bool |
|
Enable and disable https
|
ignore_owners
bool |
|
if this field is true, snapshot will be deleted even if some other processes are accessing it.
|
password
required |
|
Password for the specified user.
aliases: pass
|
snapmirror_label
|
|
A human readable SnapMirror Label attached with the snapshot. Size of the label can be at most 31 characters.
|
snapshot
required |
|
Name of the snapshot to be managed. The maximum string length is 256 characters.
|
snapshot_instance_uuid
|
|
The 128 bit unique snapshot identifier expressed in the form of UUID.
|
state
|
Choices:
present ←
- absent
|
If you want to create/modify a snapshot, or delete it.
|
username
required |
|
aliases: user
|
validate_certs
bool |
|
If set to False , the SSL certificates will not be validated.
This should only set to False used on personally controlled sites using self-signed certificates.
|
volume
required |
|
Name of the volume on which the snapshot is to be created.
|
vserver
|
|
The Vserver name
|
Note
- The modules prefixed with na_ontap are built to support the ONTAP storage platform.
- name: create SnapShot
tags:
- create
na_ontap_snapshot:
state=present
snapshot={{ snapshot name }}
volume={{ vol name }}
comment="i am a comment"
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 }}
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
This module is flagged as community which means that it is maintained by the Ansible Community. See Module Maintenance & Support for more info.
For a list of other modules that are also maintained by the Ansible Community, see here.
Hint
If you notice any issues in this documentation you can edit this document to improve it.