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.

Parameters

Parameter Choices/Defaults Comments
api_password
required
The password to authenticate with the SANtricity WebServices Proxy or embedded REST API.
api_url
required
The url to the SANtricity WebServices Proxy or embedded REST API.
api_username
required
The username to authenticate with the SANtricity WebServices Proxy or embedded REST API.
data_assurance_enabled
bool
    Choices:
  • no ←
  • yes
If data assurance should be enabled for the volume
name
required
The name of the volume to manage
segment_size_kb Default:
512
The segment size of the new volume
size
required
Required only when state = 'present'. The size of the volume in (size_unit).
size_unit
    Choices:
  • bytes
  • b
  • kb
  • mb
  • gb ←
  • tb
  • pb
  • eb
  • zb
  • yb
The unit used to interpret the size parameter
ssd_cache_enabled
bool
    Choices:
  • no
  • yes
Whether an existing SSD cache should be enabled on the volume (fails if no SSD cache defined)
The default value is to ignore existing SSD cache setting.
ssid
required
The ID of the array to manage. This value must be unique for each array.
state
required
    Choices:
  • present
  • absent
Whether the specified volume should exist or not.
storage_pool_name
required
Required only when requested state is 'present'. The name of the storage pool the volume should exist on.
thin_provision
bool
    Choices:
  • no ←
  • yes
Whether the volume should be thin provisioned. Thin volumes can only be created on disk pools (raidDiskPool).
thin_volume_max_repo_size Default:
"same as size (in size_unit)"
Maximum size that the thin volume repository volume will automatically expand to
thin_volume_repo_size
required
Initial size of the thin volume repository volume (in size_unit)
validate_certs Default:
"yes"
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, the following are the fields unique to this module:

Key Returned Description
msg
string
 always
State of volume

Sample:
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.

Maintenance

This module is flagged as community which means that it is maintained by the Ansible Community. See Module Maintenance & Support for more info.

For a list of other modules that are also maintained by the Ansible Community, see here.

Author

  • Kevin Hulquest (@hulquest)

Hint

If you notice any issues in this documentation you can edit this document to improve it.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.6/modules/netapp_e_volume_module.html