editvolume

 

Description

 
Edit a volume.
 

Request

 
In addition to the Standard Request Structure, the following parameters are required.
 
For more information, consult section Parameters.
 
Parameter
Parameter
Required?
volume name
vol_name
Y
pool name
pool
Y
volume type
vol_type
Y
provisioning
provisioning
Y
reserve space
reserve_space
Y
reserve units
reserve_units
Y
compression
compression
Y
dedup
dedup
Y
shareISCSI
shareISCSI
Y
shareCIFS
shareCIFS
Y
exportNFS
exportNFS
Y
enable snapshots
enable_snapshots
Y
schedule name
scedule_name
Y
hourlysnaps
hourlysnaps
Y
dailysnaps
dailysnaps
Y
weeklysnaps
weeklysnaps
Y
 
 

Command Option

 
Command
Possible Values
volume_name
name of volume
pool_name
selected pool name
volume_type
possible values include:
 
  • File system: (NFS, CFS)
  • blockdevice: Block Device (iSCSI LUN)
provisioning
allocation space type -
Possible values include:
 
  • Thin: Thin Provision - dynamically allocate space as it is needed
  • Thick: Thick Provision - preallocate space from storage pool now
reserve_space
volume size (number)
reserve units
size unit, i.e: G (Giga)
compression
 enable compression
dedup
enable deduplication
ShareISCS
enable sharing iscsi
ShareCIFS
enable share CIFS
exportNFS
enable export of  NFS
enable_snapshots
Enable scheduled volume snapshot
schedule_name
Snapshot schedule  name
hourlysnaps
hourly maximum number of scheduled snapshots
dailysnaps
daily maximum number of scheduled snapshots
weeklysnaps
weekly maximum number of scheduled snapshots
 
 
Example
$ softnas-cmd editvolume volume6 pool3
filesystem thin exportNFS=on shareCIFS=on dedup=on enable_snapshot=on
schedule_name=Default hourlysnaps=5 dailysnaps=10 weeklysnaps=0 -t
Made with help of Dr.Explain
Copyright (c) SoftNAS LLC