To properly display this page you need a browser with JavaScript support.
SoftNAS API Guide
Menu
Index
Search
Search
Search
3. Methods
3.17. pools
← Previous page
Next page →
Copyright (c) SoftNAS LLC
To properly display this page you need a browser with JavaScript support.
3.17. pools
Description
This method lists the available storage pools.
POST pools
Request
In addition to the
Standard Request Structure
the following parameters are required.
For parameter definitions see section
Properties
Parameter
Required?
start
Y
limit
Y
Response
The following parameters are returned in addition to the
Standard Response Structure
Property
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
}
Made with help of Dr.Explain
