netapp_e_snapshot_images - Create and delete snapshot images
New in version 2.2.
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.
Options
| parameter | required | default | choices | comments |
|---|---|---|---|---|
| api_password |
yes |
The password to authenticate with the SANtricity WebServices Proxy or embedded REST API.
|
||
| api_url |
yes |
The url to the SANtricity WebServices Proxy or embedded REST API.
|
||
| api_username |
yes |
The username to authenticate with the SANtricity WebServices Proxy or embedded REST API.
|
||
| snapshot_group |
yes |
The name of the snapshot group in which you want to create a snapshot image.
|
||
| state |
yes |
|
Whether a new snapshot image should be created or oldest be deleted.
|
|
| validate_certs |
no | True |
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 Return Values, the following are the fields unique to this module:
| name | description | returned | type | sample |
|---|---|---|---|---|
| image_id |
ID of snaphot image
|
state == created | string | 3400000060080E5000299B640063074057BC5C5E |
| msg |
State of operation
|
always | string | Created snapshot image |
Status
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/netapp_e_snapshot_images_module.html