×
Menu
Index

Volumes

 

Storage Volume Parameters

 
Parameter
Description
Note / Data Type
Available
Available volume space; “97.9” (GB)
Float String
Snapshots
Volume space consumed by snapshots; “25.2” (GB)
Float String
Used
Used volume space numeric; “136” (GB)
Float String
cbSnapshotEnabled
Enable snapshots. Set to “1” if snapshots are to be enabled (otherwise do not provide a value and default is disabled)
Boolean String
compression
Enable compression. Set to “1” if compression is to be enabled (otherwise do not provide a value and default is disabled)
Boolean String
dailysnaps
Daily maximum number of scheduled snapshots to retain before pruning snapshots; “10”.
Integer String
dedup
Enable deduplication. Set to “1” if deduplication is to be enabled (otherwise do not provide a value and default is disabled)
Boolean String
enable_snapshots
Enable scheduled volume snapshots: “1” to enable, “0” to disable.
Boolean String
free_numeric
Numeric free space; e.g., “97.9” (GB)
Float String
free_space
Free space in GB; e.g., “97.9G”
String
hourlysnaps
Hourly maximum number of scheduled snapshots to keep before pruning snapshots
Integer String
nfs_export
Set true to export via NFS using default export
Boolean String
optmizations
List of optimizations
String
pct_used
Percentage of space used;  “5%”
String
pool
Storage pool name associated with this volume
String
provisioning
Allocation space type; “Thin” or “Thick”
String
Thin:
Thin Provision. Dynamically allocate space as it is needed.
Thick:
Thick Provision.  Pre-allocate space from storage pool.
reserve_space
Reserved space size (number). Amount of space, in “reserve_units”, to reserve for Thick provisioned volume.
String
reserve_units
Reserved space size unit.
ie. M(mega), G (giga), T (tera)
String
schedule_name
Snapshot schedule name to be associated with this volume; e.g., “Business”
String
status
Volume status; e.g., “ONLINE”, “DEGRADED”
String
time_updated
Last time record updated
Date String
total_numeric
Total space; “99.5”
Float 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
usedbydataset
Space used by the dataset; e.g., “106K”, “10T”
String
usedbysnapshots
Space used by snapshots; ., “10GB”, “2.5T”
String
vol_name
Name of the volume; e.g., “myvolumename”
String
vol_path
Mount path for volume; e.g. “/mypool/myvol” (filesystem), “/dev/zvol/apool1/avol" (blockdevice)
String
vol_type
Possible values:
String
“filesystem”: Filesystem (NFS, CIFS)
“blockdevice”: Block device (iSCSI LUN)
weeklysnaps
Number of weekly snapshots to retain before pruning
Integer String
shareISCSI
True “1” if shared via iSCSI
Boolean String
shareCIFS
True “1” if share via CIFS
Boolean String
exportNFS
True “1” if share via NFS
Boolean String
enable snapshots
True “1” to enable scheduled snapshots
Boolean String
schedule name
Name of the schedule to use
String
 
Made with help of Dr.Explain
Copyright (c) SoftNAS LLC