SoftNAS API Guide
Menu
Index

3.27. volumes

 
Description
 
This method is used to list the available storage volumes.
POST volumes
 
 
 
Request
 
In addition the the Standard Request Structure, the following parameters are required.
 
For definitions of parameters, see section Properties
Parameter
Required?
start
Y
limit
Y
 
Response
 
 
Example
{
    "result": {
        "msg": "",
        "records": [
            {
                "Available": 29.3,
                "Snapshots": null,
                "Used": 136,
                "cbSnapshotEnabled": "1",
                "compression": "off",
                "dailysnaps": 2,
                "dedup": "off",
                "free_numeric": 29.3,
                "free_space": "29.3G",
                "hourlysnaps": 5,
                "nfs_export": null,
                "optimizations": "none",
                "pct_used": "0%",
                "pool": "pool3",
                "provisioning": "Thin",
                "reserve_space": null,
                "reserve_units": null,
                "schedule_name": "Default",
                "status": "ONLINE",
                "time_updated": "Jan 12, 2014 16:34:02",
                "total_numeric": 29.8,
                "total_space": "29.8G",
                "used_numeric": 0,
                "used_space": "0.0G",
                "usedbydataset": "136K",
                "usedbysnapshots": "0",
                "vol_name": "vol1",
                "vol_path": "/dev/zvol/pool3/vol1",
                "vol_type": "filesystem",
                "weeklysnaps": 0
            },
            {
                "Available": 29.3,
                "Snapshots": null,
                "Used": 136,
                "cbSnapshotEnabled": "1",
                "compression": "off",
                "dailysnaps": 2,
                "dedup": "off",
                "free_numeric": 29.3,
                "free_space": "29.3G",
                "hourlysnaps": 5,
                "nfs_export": null,
                "optimizations": "none",
                "pct_used": "0%",
                "pool": "pool3",
                "provisioning": "Thin",
                "reserve_space": null,
                "reserve_units": null,
                "schedule_name": "Default",
                "status": "ONLINE",
                "time_updated": "Jan 12, 2014 16:34:02",
                "total_numeric": 29.8,
                "total_space": "29.8G",
                "used_numeric": 0,
                "used_space": "0.0G",
                "usedbydataset": "136K",
                "usedbysnapshots": "0",
                "vol_name": "vol2",
                "vol_path": "/dev/zvol/pool3/vol2",
                "vol_type": "filesystem",
                "weeklysnaps": 0
            }
        ],
        "success": true,
        "total": 2
    },
    "session_id": 11255,
    "success": true
}
 
 
 
Made with help of Dr.Explain