Docs4dev
Docs
ansible / 2.4 / netapp_e_volume_module.html

netapp_e_volume - Manage storage volumes (standard and thin)

New in version 2.2.

Synopsis

  • Create or remove volumes (standard and thin) 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.
data_assurance_enabled
 no
If data assurance should be enabled for the volume
name
 yes
The name of the volume to manage
segment_size_kb
 no 512
The segment size of the new volume
size
 yes
Required only when state = 'present'. The size of the volume in (size_unit).
size_unit
 no gb
  • bytes
  • b
  • kb
  • mb
  • gb
  • tb
  • pb
  • eb
  • zb
  • yb
The unit used to interpret the size parameter
ssd_cache_enabled
 no None (ignores existing SSD cache setting)
  • yes
  • no
  • true
  • false
Whether an existing SSD cache should be enabled on the volume (fails if no SSD cache defined)
ssid
 yes
The ID of the array to manage. This value must be unique for each array.
state
 yes
  • present
  • absent
Whether the specified volume should exist or not.
storage_pool_name
 yes
Required only when requested state is 'present'. The name of the storage pool the volume should exist on.
thin_provision
 no
  • yes
  • no
  • true
  • false
Whether the volume should be thin provisioned. Thin volumes can only be created on disk pools (raidDiskPool).
thin_volume_max_repo_size
 no same as size (in size_unit)
Maximum size that the thin volume repository volume will automatically expand to
thin_volume_repo_size
 yes
Initial size of the thin volume repository volume (in size_unit)
validate_certs
 no True
Should https certificates be validated?

Examples

- name: No thin volume
  netapp_e_volume:
    ssid: "{{ ssid }}"
    name: NewThinVolumeByAnsible
    state: absent
    log_path: /tmp/volume.log
    api_url: "{{ netapp_api_url }}"
    api_username: "{{ netapp_api_username }}"
    api_password: "{{ netapp_api_password }}"
    validate_certs: "{{ netapp_api_validate_certs }}"
  when: check_volume


- name: No fat volume
  netapp_e_volume:
    ssid: "{{ ssid }}"
    name: NewVolumeByAnsible
    state: absent
    log_path: /tmp/volume.log
    api_url: "{{ netapp_api_url }}"
    api_username: "{{ netapp_api_username }}"
    api_password: "{{ netapp_api_password }}"
    validate_certs: "{{ netapp_api_validate_certs }}"
  when: check_volume

Return Values

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

name description returned type sample
msg
State of volume
always string Standard volume [workload_vol_1] has been created.

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_volume_module.html