Index

Methods

List of API Operations

login – log into SoftNAS Cloud® and create an active API session

logout – log out of SoftNAS Cloud® 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 Cloud®

newlicense – install a new license key for SoftNAS Cloud®

internallicense – force SoftNAS Cloud® to use its built-in, default license

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

createpool – creates a storage pool

deletepool – delete a storage pool

expandpool – expand a storage pool with additional devices

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