Parameter |
Choices/Defaults |
Comments |
api_password
string
/ required
|
|
The password to authenticate with the SANtricity Web Services Proxy or Embedded Web Services API.
|
api_url
string
/ required
|
|
The url to the SANtricity Web Services Proxy or Embedded Web Services API.
Example https://prod-1.wahoo.acme.com:8443/devmgr/v2
|
api_username
string
/ required
|
|
The username to authenticate with the SANtricity Web Services Proxy or Embedded Web Services API.
|
criteria_drive_count
integer
|
|
The number of disks to use for building the storage pool.
When state=="present" then criteria_drive_count or criteria_min_usable_capacity must be specified.
The pool will be expanded if this number exceeds the number of disks already in place (See expansion note below)
|
criteria_drive_interface_type
string
|
Choices:
- scsi
- fibre
- sata
- pata
- fibre520b
- sas
- sas4k
- nvme4k
|
The interface type to use when selecting drives for the storage pool
If not provided then all interface types will be considered.
|
criteria_drive_max_size
float
|
|
The maximum individual drive size (in size_unit) to consider when choosing drives for the storage pool.
|
criteria_drive_min_size
float
|
|
The minimum individual drive size (in size_unit) to consider when choosing drives for the storage pool.
|
criteria_drive_require_da
boolean
|
|
Ensures the storage pool will be created with only data assurance (DA) capable drives.
Only available for new storage pools; existing storage pools cannot be converted.
|
criteria_drive_require_fde
boolean
|
|
Whether full disk encryption ability is required for drives to be added to the storage pool
|
criteria_drive_type
string
|
|
The type of disk (hdd or ssd) to use when searching for candidates to use.
When not specified each drive type will be evaluated until successful drive candidates are found starting with the most prevalent drive type.
|
criteria_min_usable_capacity
float
|
|
The minimum size of the storage pool (in size_unit).
When state=="present" then criteria_drive_count or criteria_min_usable_capacity must be specified.
The pool will be expanded if this value exceeds its current size. (See expansion note below)
|
criteria_size_unit
string
|
Choices:
- bytes
- b
- kb
- mb
gb ←
- tb
- pb
- eb
- zb
- yb
|
The unit used to interpret size parameters
|
ddp_critical_threshold_pct
integer
|
Default:
85
|
Issues a critical alert when threshold of storage has been allocated.
Only applicable when raid_level=="raidDiskPool".
Set ddp_critical_threshold_pct==0 to disable alert.
|
ddp_warning_threshold_pct
integer
|
Default:
85
|
Issues a warning alert when threshold of storage has been allocated.
Only applicable when raid_level=="raidDiskPool".
Set ddp_warning_threshold_pct==0 to disable alert.
|
erase_secured_drives
boolean
|
|
If state=="absent" then all storage pool drives will be erase
If state=="present" then delete all available storage array drives that have security enabled.
|
name
string
/ required
|
|
The name of the storage pool to manage
|
raid_level
string
|
Choices:
- raidAll
- raid0
- raid1
- raid3
- raid5
- raid6
raidDiskPool ←
|
The RAID level of the storage pool to be created.
Required only when state=="present".
When raid_level=="raidDiskPool" then criteria_drive_count >= 10 or criteria_drive_count >= 11 is required depending on the storage array specifications.
When raid_level=="raid0" then 1<=criteria_drive_count is required.
When raid_level=="raid1" then 2<=criteria_drive_count is required.
When raid_level=="raid3" then 3<=criteria_drive_count<=30 is required.
When raid_level=="raid5" then 3<=criteria_drive_count<=30 is required.
When raid_level=="raid6" then 5<=criteria_drive_count<=30 is required.
Note that raidAll will be treated as raidDiskPool and raid3 as raid5.
|
remove_volumes
boolean
|
|
Prior to removing a storage pool, delete all volumes in the pool.
|
reserve_drive_count
integer
|
|
Set the number of drives reserved by the storage pool for reconstruction operations.
Only valid on raid disk pools.
|
secure_pool
boolean
|
|
Enables security at rest feature on the storage pool.
Will only work if all drives in the pool are security capable (FDE, FIPS, or mix)
Warning, once security is enabled it is impossible to disable without erasing the drives.
|
ssid
string
|
Default:
1
|
The ID of the array to manage. This value must be unique for each array.
|
state
string
|
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
|
|
Should https certificates be validated?
|