Y
Description
Issue a disk management command.
Request
|
Parameter
|
Parameter
|
Required?
|
|
CreateS3disk
|
CreateS3disk
|
Y
|
|
awsAccessKey
|
awsAccessKey
|
Y
|
|
awsSecretKey
|
awsSecretKey
|
Y
|
|
s3bucket
|
s3bucket
|
Y
|
|
bucketroot
|
bucketroot
|
Y
|
|
sizeMaxValue
|
sizeMaxValue
|
Y
|
|
sizeMaxUnits
|
sizeMaxUnits
|
Y
|
|
diskpassword
|
diskpassword
|
Y
|
|
cb_encrypted
|
cb_encrypted
|
Y
|
|
cb_readahead
|
cb_readahead
|
Y
|
|
deleteS3disk
|
deleteS3disk
|
Y
|
|
s3diskname
|
s3diskname
|
Y
|
|
getS3settings
|
getS3settings
|
Y
|
|
bucketlist
|
bucketlist
|
Y
|
Command Options
|
Command
|
Possible Values
|
|
CreateS3disk
|
Create an s3 disk.
|
|
Related Options:
|
|
awsAccessKey
|
s3 aws access key id
|
|
awsSecretKey
|
s3 aws secret key
|
|
s3bucket
|
s3 bucket name must be unique
|
|
bucketroot
|
s3 bucket root
|
|
sizeMaxValue
|
Disk size
|
|
sizeMaxUnits
|
Size unit TB or GB
|
|
diskpassword
|
disk password protection
|
|
cb_encrypted
|
add it to encrypt disk
|
|
cb_readahead
|
|
|
deleteS3disk
|
delete s3 disk
|
|
s3diskname
|
s3 disk name i.e (/dev/s3-0)
|
|
getS3settings
|
get list of s3 setting stored in config file
|
|
bucketlist
|
get list of aws s3 buckets
|
Example 1
Create S3 Disk.
|
$ softnas-cmd diskmgmt createS3disk awsAccessKey=YOUR_AWS_ACCESS_KEY_ID awsSecretKey=YOUR_AWS_SECRET_KEY s3bucket=softnas-test-1 bucketroot=softnas sizeMaxVal
ue=500 sizeMaxUnits=GB diskpassword=password123*
|
Example 2
Get a list of available buckets.
|
$ softnas-cmd diskmgmt bucketlist
|
Example 3
Get list of s3 settings stored in a config file.
|
$ softnas-cmd diskmgmt getS3settings
|
Example 4
Delete S3 Disk.
|
$ softnas-cmd diskmgmt deleteS3disk "/dev/s3-0"
|