SoftNAS API Guide
Menu
Index
  • 3. Methods

3. Methods

 
1.1.     List of API Operations
 
The following methods comprise the SoftNAS API Operations.
 
login – log into SoftNAS and create an active API session
logout – log out of SoftNAS and deactivate the API session
resetsessiontimer – for long-running commands, keeps the session from automatically logging out
licenseinfo – returns the current license information
licenseactivate – activate a license key for use with SoftNAS
newlicense – install a new license key to SoftNAS
internallicense – force SoftNAS to use its built-in, default license
validlicense – test whether SoftNAS license is valid
ackagreement – acknowledge the license agreement (to enable use of the product)
checkupdate – check to see if new software updates are available
executeupdate – execute and apply software updates
statusupdate – return status of update that is in-progress (started by executeupdate)
availabledisks – returns list of available disk devices
pools – lists available storage pools
pooldetails – list a storage pool’s detailed attributes
poolcommand – issue a command to control a storage pool
createpool – creates a storage pool
deletepool – delete a storage pool
expandpool – expand a storage pool with additional devices
importpool – import a storage pool
readcache – add a read cache device to a storage pool
writelog – add a write log cache device to a storage pool
addspare – add a spare device to a storage pool
volumes – list available storage volumes
createvolume – create a new volume and optionally share it via NFS, CIFS or iSCSI
editvolume – edit a volume’s options
deletevolume – delete a volume
schedulelist – list available snapshot schedules
schedulecommand – issue a snapshot schedule control command
snapshotlist – list available snapshots
snapcommand – issue a snapshot control command
iscsitargetlist – list of available iSCSI targets
iscsicommand – issue an iSCSI control command
diskdevices – list of available disk devices and their status
diskmgmt – issue a disk management command
parted_command – issue a disk partitioning command
perfmon – get performance monitoring status information
overview – get NAS overview status information
netstats – get network performance status information
diskstats – get disk performance status information
 
 
Made with help of Dr.Explain