netapp_eseries.santricity.netapp_e_snapshot_volume module – NetApp E-Series manage snapshot volumes.
Note
This module is part of the netapp_eseries.santricity collection (version 1.4.1).
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_eseries.santricity
.
To use it in a playbook, specify: netapp_eseries.santricity.netapp_e_snapshot_volume
.
New in netapp_eseries.santricity 2.2.0
Synopsis
Create, update, remove snapshot volumes for NetApp E/EF-Series storage arrays.
Parameters
Parameter |
Comments |
---|---|
The password to authenticate with the SANtricity WebServices Proxy or embedded REST API. |
|
The url to the SANtricity WebServices Proxy or embedded REST API. |
|
The username to authenticate with the SANtricity WebServices Proxy or embedded REST API. |
|
The repository utilization warning threshold percentage Default: |
|
The name you wish to give the snapshot volume |
|
The size of the view in relation to the size of the base volume Default: |
|
The identifier of the snapshot image used to create the new snapshot volume. Note: You’ll likely want to use the netapp_eseries.santricity.netapp_e_facts module to find the ID of the image you want. |
|
storage array ID |
|
Whether to create or remove the snapshot volume Choices:
|
|
Name of the storage pool on which to allocate the repository volume. |
|
Should https certificates be validated? Choices:
|
|
The snapshot volume access mode Choices:
|
Notes
Note
Only full_threshold is supported for update operations. If the snapshot volume already exists and the threshold matches, then an
ok
status will be returned, no other changes can be made to a pre-existing snapshot volume.
Examples
- name: Snapshot volume
netapp_e_snapshot_volume:
ssid: "{{ ssid }}"
api_url: "{{ netapp_api_url }}/"
api_username: "{{ netapp_api_username }}"
api_password: "{{ netapp_api_password }}"
state: present
storage_pool_name: "{{ snapshot_volume_storage_pool_name }}"
snapshot_image_id: "{{ snapshot_volume_image_id }}"
name: "{{ snapshot_volume_name }}"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
Success message Returned: success Sample: |