W3cubDocs

/Ansible

netapp_eseries.santricity.netapp_e_snapshot_images – NetApp E-Series create and delete snapshot images

Note

This plugin is part of the netapp_eseries.santricity collection (version 1.2.13).

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_images.

New in version 2.2: of netapp_eseries.santricity

Synopsis

  • Create and delete snapshots images on snapshot groups for NetApp E-series storage arrays.
  • Only the oldest snapshot image can be deleted so consistency is preserved.
  • Related: Snapshot volumes are created from snapshot images.

Parameters

Parameter Choices/Defaults Comments
api_password
string / required
The password to authenticate with the SANtricity WebServices Proxy or embedded REST API.
api_url
string / required
The url to the SANtricity WebServices Proxy or embedded REST API.
api_username
string / required
The username to authenticate with the SANtricity WebServices Proxy or embedded REST API.
snapshot_group
string / required
The name of the snapshot group in which you want to create a snapshot image.
ssid
string
Storage system identifier
state
string / required
    Choices:
  • create
  • remove
Whether a new snapshot image should be created or oldest be deleted.
validate_certs
boolean
    Choices:
  • no
  • yes ←
Should https certificates be validated?

Examples

- name: Create Snapshot
  netapp_e_snapshot_images:
    ssid: "{{ ssid }}"
    api_url: "{{ netapp_api_url }}"
    api_username: "{{ netapp_api_username }}"
    api_password: "{{ netapp_api_password }}"
    validate_certs: "{{ validate_certs }}"
    snapshot_group: "3300000060080E5000299C24000005B656D9F394"
    state: 'create'

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
image_id
string
state == created
ID of snapshot image

Sample:
3400000060080E5000299B640063074057BC5C5E
msg
string
always
State of operation

Sample:
Created snapshot image


Authors

  • Kevin Hulquest (@hulquest)

© 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_eseries/santricity/netapp_e_snapshot_images_module.html