|
|
|
Description
List a storage pool's detailed attributes.
Request
|
Parameter
|
Required?
|
|
pool_name
|
Y
|
Response
|
Parameter
|
Description
|
Note/Data Type
|
|
Available
|
GB’s of storage available
|
String
|
|
used
|
Percentage of space used; e.g., “5”
|
Integer String
|
|
Compression
|
Compression feature “on” or “off”
|
String
|
|
dedup
|
Deduplication feature “on” of “off”
|
String
|
|
dedupfactor
|
Deduplication factor
|
Float String
|
|
free_numeric
|
Numeric percentage free space; e.g., “99.5”
|
Float String
|
|
free-space
|
Free space in GB; e.g., “99.5G”
|
String
|
|
no_disks
|
Number of disks in the storage pool; e.g. “5”
|
Integer String
|
|
optimizations
|
Optimizations display string
|
String
|
|
pct_used
|
Percentage of space used; “5%”
|
String percentage
|
|
pool_name
|
Name of the storage pool; e.g., “naspool1”
|
String
|
|
provisioning
|
Type of provisioning: “Thin” or “Thick”
|
String
|
|
status
|
Status of the pool; e.g., “ONLINE”
|
String
|
|
time_updated
|
Last date/time pool stats updated
|
Date String
|
|
total_numeric
|
Total space; “99.5”
|
Integer String
|
|
total_space
|
Total space in GB; e.g., “99.5G”, “120T”
|
String
|
|
used_numeric
|
Used space numeric; e.g., “10.5”
|
Float String
|
|
used_space
|
Used space in GB; e.g., “10.5G”
|
String
|
|
pool type
|
Type of pool; “filesystem” or “blockdevice”
|
String
|
|
force
|
Set to true “1” to force pool creation
|
Boolean String
|
|
disk devices
|
List of disk devices; e.g., “/dev/sdb”, “/dev/xvf10”
|
String
|
|
force cache
|
Set to true “1” to force cache device creation
|
Boolean String
|
|
raid level
|
RAID level; “” empty for no RAID/RAID0, “mirror”,
“raidz”, “raidz2”, or “raidz3” for ZFS striped RAID.
|
String
|
|
forced spare
|
Set to true “1” to force space device addition to pool
|
Boolean String
|
Example
|
{
"result": {
"msg": "",
"records": [
{
"Available": 9.9,
"Used": 0,
"compression": "off",
"dedup": "off",
"dedupfactor": "1.00x",
"free_numeric": 9.9,
"free_space": "9.9G",
"no_disks": 5,
"optimizations": "none",
"pct_used": "0%",
"pool_name": "pool1",
"provisioning": "Thin",
"status": "ONLINE",
"time_updated": "Jan 12, 2014 06:55:23",
"total_numeric": 9.9,
"total_space": "9.9G",
"used_numeric": 0,
"used_space": "0.0G"
},
{
"Available": 9.9,
"Used": 0,
"compression": "off",
"dedup": "off",
"dedupfactor": "1.00x",
"free_numeric": 9.9,
"free_space": "9.9G",
"no_disks": 5,
"optimizations": "none",
"pct_used": "0%",
"pool_name": "pool2",
"provisioning": "Thin",
"status": "ONLINE",
"time_updated": "Jan 12, 2014 06:55:23",
"total_numeric": 9.9,
"total_space": "9.9G",
"used_numeric": 0,
"used_space": "0.0G"
},
{
"Available": 9.9,
"Used": 0,
"compression": "off",
"dedup": "off",
"dedupfactor": "1.00x",
"free_numeric": 9.9,
"free_space": "9.9G",
"no_disks": 5,
"optimizations": "none",
"pct_used": "0%",
"pool_name": "pool3",
"provisioning": "Thin",
"status": "ONLINE",
"time_updated": "Jan 12, 2014 06:55:23",
"total_numeric": 9.9,
"total_space": "9.9G",
"used_numeric": 0,
"used_space": "0.0G"
}
],
"success": true,
"total": 3
},
"session_id": 11255,
"success": true
}
|
|
|
|