netapp_e_storagepool – NetApp E-Series manage disk groups and disk pools — Ansible Documentation

- AnsibleFest
- Products
- Community
- Webinars & Training
- Blog

Documentation

# netapp_e_storagepool – NetApp E-Series manage disk groups and disk pools

New in version 2.2.

- Synopsis
- Parameters
- Notes
- Examples
- Return Values
- Status

## Synopsis

- Create or remove disk groups and disk pools for NetApp E-series storage arrays.

## Parameters

Parameter | Choices/Defaults | Comments
--- | --- | ---
api_password - / required |  | The password to authenticate with the SANtricity Web Services Proxy or Embedded Web Services API.
api_url - / required |  | The url to the SANtricity Web Services Proxy or Embedded Web Services API. Example https://prod-1.wahoo.acme.com/devmgr/v2
api_username - / required |  | The username to authenticate with the SANtricity Web Services Proxy or Embedded Web Services API.
criteria_drive_count - |  | The number of disks to use for building the storage pool. The pool will be expanded if this number exceeds the number of disks already in place
criteria_drive_interface_type - | Choices: sas sas4k fibre fibre520b scsi sata pata | The interface type to use when selecting drives for the storage pool (no value means all interface types will be considered)
criteria_drive_min_size - |  | The minimum individual drive size (in size_unit) to consider when choosing drives for the storage pool.
criteria_drive_require_fde boolean | Choices: no yes | Whether full disk encryption ability is required for drives to be added to the storage pool
criteria_drive_type - | Choices: hdd ssd | The type of disk (hdd or ssd) to use when searching for candidates to use.
criteria_min_usable_capacity - |  | The minimum size of the storage pool (in size_unit). The pool will be expanded if this value exceeds itscurrent size.
criteria_size_unit - | Choices: bytes b kb mb gb ← tb pb eb zb yb | The unit used to interpret size parameters
erase_secured_drives boolean | Choices: no yes | Whether to erase secured disks before adding to storage pool
name - / required |  | The name of the storage pool to manage
raid_level - / required | Choices: raidAll raid0 raid1 raid3 raid5 raid6 raidDiskPool | Only required when the requested state is 'present'. The RAID level of the storage pool to be created.
remove_volumes boolean | Choices: no ← yes | Prior to removing a storage pool, delete all volumes in the pool.
reserve_drive_count - |  | Set the number of drives reserved by the storage pool for reconstruction operations. Only valide on raid disk pools.
secure_pool boolean | Choices: no yes | Whether to convert to a secure storage pool. Will only work if all drives in the pool are security capable.
ssid - | Default: 1 | The ID of the array to manage. This value must be unique for each array.
state - / required | Choices: present absent | Whether the specified storage pool should exist or not. Note that removing a storage pool currently requires the removal of all defined volumes first.
validate_certs boolean | Choices: no yes ← | Should https certificates be validated?

## Notes

Note

- The E-Series Ansible modules require either an instance of the Web Services Proxy (WSP), to be available to manage the storage-system, or an E-Series storage-system that supports the Embedded Web Services API.
- Embedded Web Services is currently available on the E2800, E5700, EF570, and newer hardware models.
- netapp_e_storage_system may be utilized for configuring the systems managed by a WSP instance.

## Examples

    - name: No disk groups
      netapp_e_storagepool:
        ssid: "{{ ssid }}"
        name: "{{ item }}"
        state: absent
        api_url: "{{ netapp_api_url }}"
        api_username: "{{ netapp_api_username }}"
        api_password: "{{ netapp_api_password }}"
        validate_certs: "{{ netapp_api_validate_certs }}"

## Return Values

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

Key | Returned | Description
--- | --- | ---
msg string | success | Success message Sample: Json facts for the pool that was created.

## Status

- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Community. [community]

### Authors

- Kevin Hulquest (@hulquest)

Hint

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