netapp.elementsw.na_elementsw_snapshot module – NetApp Element Software Manage Snapshots
Note
This module is part of the netapp.elementsw collection (version 21.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.elementsw
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: netapp.elementsw.na_elementsw_snapshot
.
Note
The netapp.elementsw collection is considered unmaintained and will be removed from Ansible 10. See the discussion thread for more information.
New in netapp.elementsw 2.7.0
Synopsis
Create, Modify or Delete Snapshot on Element OS Cluster.
Requirements
The below requirements are needed on the host that executes this module.
The modules were developed with SolidFire 10.1
solidfire-sdk-python (1.1.0.92) or greater. Install using ‘pip install solidfire-sdk-python’
Parameters
Parameter |
Comments |
---|---|
Account ID or Name of Parent/Source Volume. |
|
Flag, whether to replicate the snapshot created to a remote replication cluster. To enable specify ‘true’ value. Choices:
|
|
The date and time (format ISO 8601 date string) at which this snapshot will expire. |
|
The hostname or IP address of the SolidFire cluster. For na_elementsw_cluster, the Management IP (MIP) or hostname of the node to initiate the cluster creation from. |
|
Name of new snapshot create. If unspecified, date and time when the snapshot was taken is used. |
|
Password for the specified user. |
|
Retention period for the snapshot. Format is ‘HH:mm:ss’. |
|
Label used by SnapMirror software to specify snapshot retention policy on SnapMirror endpoint. |
|
ID or Name of an existing snapshot. Required when Required when Required when |
|
ID or Name of active volume. |
|
Whether the specified snapshot should exist or not. Choices:
|
|
Please ensure that the user has the adequate permissions. For more information, please read the official documentation https://mysupport.netapp.com/documentation/docweb/index.html?productID=62636&language=en-US. |
Notes
Note
The modules prefixed with na\\_elementsw are built to support the SolidFire storage platform.
Examples
- name: Create snapshot
tags:
- elementsw_create_snapshot
na_elementsw_snapshot:
hostname: "{{ elementsw_hostname }}"
username: "{{ elementsw_username }}"
password: "{{ elementsw_password }}"
state: present
src_volume_id: 118
account_id: sagarsh
name: newsnapshot-1
- name: Modify Snapshot
tags:
- elementsw_modify_snapshot
na_elementsw_snapshot:
hostname: "{{ elementsw_hostname }}"
username: "{{ elementsw_username }}"
password: "{{ elementsw_password }}"
state: present
src_volume_id: sagarshansivolume
src_snapshot_id: test1
account_id: sagarsh
expiration_time: '2018-06-16T12:24:56Z'
enable_remote_replication: false
- name: Delete Snapshot
tags:
- elementsw_delete_snapshot
na_elementsw_snapshot:
hostname: "{{ elementsw_hostname }}"
username: "{{ elementsw_username }}"
password: "{{ elementsw_password }}"
state: absent
src_snapshot_id: deltest1
account_id: sagarsh
src_volume_id: sagarshansivolume
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
Success message Returned: success |