Command Reference Operations
The softnas-cmd command line interface utility facilitates integration with the REST API as a CLI (command line interface). softnas-cmd is written in cURL and is cross-platform code. It may also be useful as example code for how to use the API, for those who wish to explore it in more detail as a working example.
The softnas-cmd CLI is designed to be used from the command line. When running within the Amazon Web Services (AWS) environment, softnas-cli is a convenient tool for use with Cloud Formation templates, which can be combined to automate configuration and setup of SoftNAS Cloud® storage systems.
As with all SoftNAS Cloud® API applications, softnas-cmd requires initial authentication with the SoftNAS Cloud® server using the login command. Upon login, softnas-cmd maintains a simulated "cookie jar" that emulates how a browser interacts with a web server to maintain session security (required by the SoftNAS Cloud® server). Subsequent commands issued via the softnas-cmd CLI make use of the login session (which expires after 30 minutes).
Obtain softnas-cmd CLI program
The softnas-cmd CLI is located in the SoftNAS Cloud® install directory /var/www/softnas/api. It is also installed by default into /usr/local/bin on the SoftNAS Cloud® storage server for local use.
Installing cURL
Linux: To install cURL on CentOS/RHEL: yum install curl (or installer for the local version of Linux)
Available CLI commands
This section provides basic information of the SoftNAS Cloud® command line interface, and also provides the list of available commands that correspond to related API calls.
Use the Pretty Print command line option to format the JSON String responses for better human readability (the raw JSON is printed by default).