W3cubDocs

/Ansible

netapp_e_snapshot_volume - Manage E/EF-Series snapshot volumes.

New in version 2.2.

Synopsis

Create, update, remove snapshot volumes for NetApp E/EF-Series storage arrays.

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.
full_threshold
 no 85
The repository utilization warning threshold percentage
name
 yes
The name you wish to give the snapshot volume
repo_percentage
 no 20
The size of the view in relation to the size of the base volume
snapshot_image_id
 yes
The identifier of the snapshot image used to create the new snapshot volume.
Note: You'll likely want to use the netapp_e_facts module to find the ID of the image you want.
ssid
 yes
storage array ID
state
 yes
  • absent
  • present
Whether to create or remove the snapshot volume
storage_pool_name
 yes
Name of the storage pool on which to allocate the repository volume.
validate_certs
 no True
Should https certificates be validated?
view_mode
 yes
  • modeUnknown
  • readWrite
  • readOnly
  • __UNDEFINED
The snapshot volume access mode

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 Common Return Values, the following are the fields unique to this module:

name description returned type sample
msg Success message success string Json facts for the volume that was created.

This is an Extras Module

For more information on what this means please read Extras Modules

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, developing_test_pr and Developing Modules.

© 2012–2016 Michael DeHaan
© 2016 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/netapp_e_snapshot_volume_module.html