ZxPowerstore CLI Commands
zxsuite core testS3Connection
zxsuite core testS3Connection *s3BucketConfigurationUuid* [param
VALUE[,VALUE]]
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
|---|---|---|---|
s3BucketConfigurationUuid (M) |
String |
||
storeType (O) |
String |
S3 | Scality_S3 | EMC | Cloudian | Ceph | Yandex | Alibaba |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite core testS3Connection
zxsuite powerstore Indexing content-extraction-tool add
zxsuite powerstore Indexing content-extraction-tool add *endpoint*
[param VALUE[,VALUE]]
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
endpoint (M) |
String |
||
server(O) |
String |
||
global(O) |
Boolean |
true|false |
(M) == mandatory parameter, (O) == optional parameter
Add tika endpoint for this mailbox store:
Usage Example
zxsuite powerstore Indexing content-extraction-tool add http://tika-server.example.com:9998/tika
Add tika endpoint for mailbox store store1.example.com:
Usage Example
zxsuite powerstore Indexing content-extraction-tool add http://tika-server.example.com:9998/tika server store1.example.com
Add tika endpoint for all mailbox stores (applies only to mailbox stores that don’t have any endpoint specified):
Usage Example
zxsuite powerstore Indexing content-extraction-tool add http://tika-server.example.com:9998/tika global true
zxsuite powerstore Indexing content-extraction-tool list
zxsuite powerstore Indexing content-extraction-tool list [param
VALUE[,VALUE]]
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
server(O) |
String |
||
global(O) |
Boolean |
true|false |
(M) == mandatory parameter, (O) == optional parameter
List tika endpoints for this mailbox store:
Usage Example
zxsuite powerstore Indexing content-extraction-tool list
List tika endpoints for mailbox store store1.example.com:
Usage Example
zxsuite powerstore Indexing content-extraction-tool list server store1.example.com
List tika endpoints for all mailbox stores that don’t have any endpoint specified:
Usage Example
zxsuite powerstore Indexing content-extraction-tool list global true
zxsuite powerstore Indexing content-extraction-tool remove
zxsuite powerstore Indexing content-extraction-tool remove *endpoint*
[param VALUE[,VALUE]]
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
** endpoint**(M) |
String |
||
server(O) |
String |
||
global(O) |
Boolean |
true|false |
(M) == mandatory parameter, (O) == optional parameter
Remove tika endpoint for this mailbox store:
Usage Example
zxsuite powerstore Indexing content-extraction-tool remove http://tika-server.example.com:9998/tika
Remove tika endpoint for mailbox store store1.example.com:
Usage Example
zxsuite powerstore Indexing content-extraction-tool remove http://tika-server.example.com:9998/tika server store1.example.com
Remove tika endpoint used by all mailbox stores that don’t have any endpoint specified:
Usage Example
zxsuite powerstore Indexing content-extraction-tool remove http://tika-server.example.com:9998/tika global true
zxsuite powerstore doCheckBlobs
zxsuite powerstore doCheckBlobs *start* [param VALUE[,VALUE]]
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
action(M) |
String |
start |
|
volumes(O) |
String[,..] |
me ssage1,hsm[,…] |
|
mailbox_ids(O) |
Integer[,..] |
2,9,27 |
|
missing_blobs_crosscheck(O) |
Boolean |
true|false |
true |
traced(O) |
Boolean |
true|false |
false |
fix_incorrect_compressed_digests(O) |
Boolean |
true|false |
false |
missing_blob_delete_item(O) |
Boolean |
true|false |
false |
check_digests(O) |
Boolean |
true|false |
false |
items(O) |
String |
z imbra|drive|all |
all |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite powerstore doCheckBlobs start
Perform a BLOB coherency check on all message volumes
Usage Example
zxsuite powerstore doCheckBlobs start volumes message1,hsm
Perform a BLOB coherency check on volumes message1 and hsm
Usage Example
zxsuite powerstore doCheckBlobs start mailbox_ids 2,9,27
Perform a BLOB coherency check on mailboxes 2,9 and 27
Usage Example
zxsuite powerstore doCheckBlobs start missing_blobs_crosscheck false
Perform a BLOB coherency check without checking on other volumes
Usage Example
zxsuite powerstore doCheckBlobs start traced true
Perform a BLOB coherency check, logging even the correct checked items
Usage Example
zxsuite powerstore doCheckBlobs start fix_incorrect_compressed_digests true
This option verifies if the digest (hash) of every object is correct and eventually fixes it
Usage Example
zxsuite powerstore doCheckBlobs start check_digests true
Verifies if the blob digests are correct
Usage Example
zxsuite powerstore doCheckBlobs start missing_blob_delete_item true
Remove entries from the database that are missing their blob file in the hsm volume
Volume names are case sensitive. Run ‘zxsuite powerstore getAllVolumes’ for a complete list of the volumes.
zxsuite powerstore doCreateVolume Alibaba
zxsuite powerstore doCreateVolume Alibaba *volume_name*
*primary|secondary* [param VALUE[,VALUE]]
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
vol ume_name(M) |
String |
||
vol ume_type(M) |
Multiple choice |
pr imary|secondary |
|
bucket_name(O) |
String |
Bucket name |
|
url(O) |
String |
Alibaba endpoint (e.g.: https://os s-ap-aliyuncs-a pi.example.com) |
|
region(O) |
String |
Alibaba OSS Region |
|
access_key(O) |
String |
Service username |
|
secret(O) |
String |
Service password |
|
v olume_prefix(O) |
String |
Prefix to the server id used in all objects keys (Volume configuration) |
|
bucket_conf iguration_id(O) |
String |
UUID for already existing service credentials (zxsuite config global get attribute s3Bucket Configurations) |
|
prefix(O) |
String |
Prefix added to blobs keys (Bucket configuration) |
|
centralized(O) |
Boolean |
true|false |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite powerstore doCreateVolume Alibaba volumeName primary bucket_name bucket access_key accessKey secret secretKet url http://host/service
Usage Example
zxsuite powerstore doCreateVolume Alibaba volumeName primary bucket_configuration_id uuid
zxsuite powerstore doCreateVolume Centralized
zxsuite powerstore doCreateVolume Centralized *server_name*
*volume_name* [param VALUE[,VALUE]]
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
ser ver_name(M) |
String |
||
vol ume_name(M) |
String |
||
volume_type(O) |
Multiple choice |
pr imary|secondary |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite powerstore doCreateVolume hostname volumeName
zxsuite powerstore doCreateVolume Ceph
zxsuite powerstore doCreateVolume Ceph *volume_name*
*primary|secondary* [param VALUE[,VALUE]]
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
vol ume_name(M) |
String |
||
vol ume_type(M) |
Multiple choice |
pr imary|secondary |
|
bucket_name(O) |
String |
Bucket name |
|
url(O) |
String |
S3 API compatible service url (ex: s3a pi.example.com) |
|
access_key(O) |
String |
Service username |
|
secret(O) |
String |
Service password |
|
v olume_prefix(O) |
String |
Prefix to the server id used in all objects keys (Volume configuration) |
|
bucket_conf iguration_id(O) |
String |
UUID for already existing service credentials (zxsuite config global get attribute s3Bucket Configurations) |
|
prefix(O) |
String |
Prefix added to blobs keys (Bucket configuration) |
|
centralized(O) |
Boolean |
true|false |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite powerstore doCreateVolume Ceph volumeName primary bucket_name bucket access_key accessKey secret secretKet url http://host/service
Usage Example
zxsuite powerstore doCreateVolume Ceph volumeName primary bucket_configuration_id uuid
zxsuite powerstore doCreateVolume Cloudian
zxsuite powerstore doCreateVolume Cloudian *volume_name*
*primary|secondary* [param VALUE[,VALUE]]
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
vol ume_name(M) |
String |
||
vol ume_type(M) |
Multiple choice |
pr imary|secondary |
|
bucket_name(O) |
String |
Bucket name |
|
url(O) |
String |
S3 API compatible service url (ex: s3a pi.example.com) |
|
access_key(O) |
String |
Service username |
|
secret(O) |
String |
Service password |
|
v olume_prefix(O) |
String |
Prefix to the server id used in all objects keys (Volume configuration) |
|
bucket_conf iguration_id(O) |
String |
UUID for already existing service credentials (zxsuite config global get attribute s3Bucket Configurations) |
|
prefix(O) |
String |
Prefix added to blobs keys (Bucket configuration) |
|
centralized(O) |
Boolean |
true|false |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite powerstore doCreateVolume Cloudian volumeName primary bucket_name bucket access_key accessKey secret secretKet url http://host/service
Usage Example
zxsuite powerstore doCreateVolume Cloudian volumeName primary bucket_configuration_id uuid
zxsuite powerstore doCreateVolume CustomS3
zxsuite powerstore doCreateVolume CustomS3 *volume_name*
*primary|secondary* [param VALUE[,VALUE]]
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
vol ume_name(M) |
String |
||
vol ume_type(M) |
Multiple choice |
pr imary|secondary |
|
bucket_name(O) |
String |
Bucket name |
|
url(O) |
String |
S3 API compatible service url (ex: s3a pi.example.com) |
|
access_key(O) |
String |
Service username |
|
secret(O) |
String |
Service password |
|
v olume_prefix(O) |
String |
Prefix to the server id used in all objects keys (Volume configuration) |
|
bucket_conf iguration_id(O) |
String |
UUID for already existing service credentials (zxsuite config global get attribute s3Bucket Configurations) |
|
prefix(O) |
String |
Prefix added to blobs keys (Bucket configuration) |
|
centralized(O) |
Boolean |
true|false |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite powerstore doCreateVolume CustomS3 volumeName primary bucket_name bucket access_key accessKey secret secretKet url http://host/service
Usage Example
zxsuite powerstore doCreateVolume CustomS3 volumeName primary bucket_configuration_id uuid
zxsuite powerstore doCreateVolume EMC
zxsuite powerstore doCreateVolume EMC *volume_name*
*primary|secondary* [param VALUE[,VALUE]]
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
vol ume_name(M) |
String |
||
vol ume_type(M) |
Multiple choice |
pr imary|secondary |
|
bucket_name(O) |
String |
Bucket name |
|
url(O) |
String |
S3 API compatible service url (ex: s3a pi.example.com) |
|
access_key(O) |
String |
Service username |
|
secret(O) |
String |
Service password |
|
v olume_prefix(O) |
String |
Prefix to the server id used in all objects keys (Volume configuration) |
|
bucket_conf iguration_id(O) |
String |
UUID for already existing service credentials (zxsuite config global get attribute s3Bucket Configurations) |
|
prefix(O) |
String |
Prefix added to blobs keys (Bucket configuration) |
|
centralized(O) |
Boolean |
true|false |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite powerstore doCreateVolume EMC volumeName primary bucket_name bucket access_key accessKey secret secretKet url http://host/service
Usage Example
zxsuite powerstore doCreateVolume EMC volumeName primary bucket_configuration_id uuid
zxsuite powerstore doCreateVolume FileBlob
zxsuite powerstore doCreateVolume FileBlob *volume_name*
*primary|secondary* *volume_path* [param VALUE[,VALUE]]
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
vol ume_name(M) |
String |
||
vol ume_type(M) |
Multiple choice |
pr imary|secondary |
|
vol ume_path(M) |
Path |
||
volum e_compressed(O) |
Boolean |
true|false |
false |
compression_thr eshold_bytes(O) |
Long |
4096 |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite powerstore doCreateVolume FileBlob volumeName secondary /path/to/store volume_compressed true compression_threshold_bytes 4096
zxsuite powerstore doCreateVolume OpenIO
zxsuite powerstore doCreateVolume OpenIO *volume_name*
*primary|secondary* *url* *account* *namespace* [param VALUE[,VALUE]]
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
|---|---|---|---|
volume_name (M) |
String |
||
volume_type (M) |
Multiple choice |
primary+secondary |
|
url (M) |
String |
||
account (M) |
String |
||
namespace (M) |
String |
||
proxy_port (O) |
Integer |
||
account_port (O) |
Integer |
||
ecd (O) |
String |
||
centralized (O) |
Boolean |
true+false |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite powerstore doCreateVolume OpenIO volumeName primary http://host/service accountName namespaceString proxy_port 6006 account_port 6009
zxsuite powerstore doCreateVolume S3
zxsuite powerstore doCreateVolume S3 *Name of the zimbra store*
*primary|secondary* [param VALUE[,VALUE]]
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
vol ume_name(M) |
String |
Name of the zimbra store |
|
vol ume_type(M) |
Multiple choice |
pr imary|secondary |
|
bucket_name(O) |
String |
Amazon AWS bucket |
|
access_key(O) |
String |
Service username |
|
secret(O) |
String |
Service password |
|
v olume_prefix(O) |
String |
Prefix to the server id used in all objects keys (Volume configuration) |
|
bucket_conf iguration_id(O) |
String |
UUID for already existing S3 service credentials (zxsuite config global get attribute s3Bucket Configurations) |
|
region(O) |
String |
Amazon AWS Region |
|
url(O) |
String |
S3 API compatible service url (ex: s3a pi.example.com) |
|
prefix(O) |
String |
Prefix added to blobs keys (Bucket configuration) |
|
use_infre quent_access(O) |
Boolean |
true|false |
|
infrequent_acce ss_threshold(O) |
String |
||
use_intelli gent_tiering(O) |
Boolean |
true|false |
|
centralized(O) |
Boolean |
true|false |
(M) == mandatory parameter, (O) == optional parameter
S3 AWS Bucket:
Usage Example
zxsuite powerstore doCreateVolume S3 volumeName primary bucket_name bucket access_key accessKey secret secretKey prefix objectKeysPrefix region EU_WEST_1 use_infrequent_access TRUE infrequent_access_threshold 4096
S3 compatible object storage:
Usage Example
zxsuite powerstore doCreateVolume S3 volumeName primary bucket_name bucket access_key accessKey secret secretKey url http://host/service
Using existing bucket configuration:
Usage Example
zxsuite powerstore doCreateVolume S3 volumeName primary bucket_configuration_id 316813fb-d3ef-4775-b5c8-f7d236fc629c
zxsuite powerstore doCreateVolume ScalityS3
zxsuite powerstore doCreateVolume ScalityS3 *volume_name*
*primary|secondary* [param VALUE[,VALUE]]
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
vol ume_name(M) |
String |
||
vol ume_type(M) |
Multiple choice |
pr imary|secondary |
|
bucket_name(O) |
String |
Bucket name |
|
url(O) |
String |
S3 API compatible service url (ex: s3a pi.example.com) |
|
access_key(O) |
String |
Service username |
|
secret(O) |
String |
Service password |
|
v olume_prefix(O) |
String |
Prefix to the server id used in all objects keys (Volume configuration) |
|
bucket_conf iguration_id(O) |
String |
UUID for already existing service credentials (zxsuite config global get attribute s3Bucket Configurations) |
|
prefix(O) |
String |
Prefix added to blobs keys (Bucket configuration) |
|
centralized(O) |
Boolean |
true|false |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite powerstore doCreateVolume ScalityS3 volumeName primary bucket_name bucket access_key accessKey secret secretKet url http://host/service
Usage Example
zxsuite powerstore doCreateVolume ScalityS3 volumeName primary bucket_configuration_id uuid
zxsuite powerstore doCreateVolume Swift
zxsuite powerstore doCreateVolume Swift *volume_name*
*primary","secondary* *url* *username* *password* [param VALUE[,VALUE]]
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
|---|---|---|---|
volume_name (M) |
String |
||
volume_type (M) |
Multiple choice |
primary | secondary |
|
url (M) |
String |
||
username (M) |
String |
||
password (M) |
String |
||
authentication_method (O) |
String |
BASIC | KEYSTONE | KEYSTONE_V3 | TEMPAUTH | EXTERNAL |
|
authentication_method_scope (O) |
String |
DEFAULT | PROJECT_NAME | DOMAIN_NAME |
|
tenant_id (O) |
String |
||
tenant_name (O) |
String |
||
domain (O) |
String |
||
proxy_host (O) |
String |
||
proxy_port (O) |
Integer |
||
proxy_username (O) |
String |
||
proxy_password (O) |
String |
||
public_host (O) |
String |
||
private_host (O) |
String |
||
region (O) |
String |
||
max_delete_objects_count (O) |
Integer |
Number of object in a single bulk delete request |
500 |
centralized (O) |
Boolean |
true | false |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite powerstore doCreateVolume Swift volumeName primary http://host/service accountName password max_delete_objects_count 100
zxsuite powerstore doDeduplicate
zxsuite powerstore doDeduplicate *volume_name* [param VALUE[,VALUE]]
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
vol ume_name(M) |
String[,..] |
||
dry_run(O) |
Boolean |
true|false |
false |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite powerstore doDeduplicate secondvolume
Starts a deduplication on volume secondvolume
zxsuite powerstore doDeleteDrivePreviews
zxsuite powerstore doDeleteDrivePreviews *volumes* [param
VALUE[,VALUE]]
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
volumes(M) |
String[,..] |
me ssage1,hsm[,..] |
|
dryrun(O) |
Boolean |
true|false |
true |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite powerstore doDeleteDrivePreviews volumes message1,hsm
Deletes drive previews on volumes message1 and hsm
Usage Example
zxsuite powerstore doDeleteDrivePreviews volumes all
Deletes drive previews on all volumes except the current primary
This is a cleanup operation. Previews are not deleted if the command is executed against the Drive Current Primary Volume because Drive use this volume to manage the previews.
zxsuite powerstore doDeleteVolume
zxsuite powerstore doDeleteVolume *volume_name* [param VALUE[,VALUE]]
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
vol ume_name(M) |
String |
||
ignore_drive(O) |
Boolean |
true|false |
false |
delete_dr ive_previews(O) |
Boolean |
true|false |
true |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite powerstore doDeleteVolume hsm
Deletes volume with name hsm
zxsuite powerstore doMailboxMove
zxsuite powerstore doMailboxMove *destinationHost* [param
VALUE[,VALUE]]
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
destina tionHost(M) |
String |
||
accounts(O) |
String[,..] |
john@example. com,smith@exa mple.com[,…] |
|
domains(O) |
String[,..] |
example.co m,test.com[,…] |
|
input_file(O) |
String |
||
stages(O) |
String[,..] |
blobs|back up|data|account data=bl obs+backup[,…] |
blobs,account |
compress(O) |
Boolean |
true|false |
true |
checkDigest(O) |
Boolean |
if false skip digest calculation and check |
false |
overwrite(O) |
Boolean |
true|false |
true |
threads(O) |
Integer |
1 |
|
hsm(O) |
Boolean |
true|false |
false |
n otifications(O) |
Email Address |
||
ig nore_partial(O) |
Boolean |
true|false |
false |
drop_ne twork_backup(O) |
Boolean |
true|false |
false |
read_err or_threshold(O) |
Integer |
||
blob_destin ation_volume(O) |
String |
curre nt_primary|curr ent_secondary|6 |
current_primary |
drive_destin ation_volume(O) |
String |
drive_primary|d rive_secondary| same_as_blob|7 |
same_as_blob |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite powerstore doMailboxMove mail2.example.com accounts john@example.com stages data,account
Move mailbox for account john@example.com to mail2.example.com host
zxsuite powerstore doMoveBlobs
zxsuite powerstore doMoveBlobs *start* [param VALUE[,VALUE]]
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
action(M) |
String |
start |
|
c ustom_policy(O) |
String |
none |
|
read_err or_threshold(O) |
Integer |
||
perform _deduplicate(O) |
Boolean |
true|false |
false |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite powerstore doMoveBlobs
Move items between the Current Primary Store and the Current Secondary Store according to the default HSM policy
zxsuite powerstore doPurgeMailboxes
zxsuite powerstore doPurgeMailboxes *Mailbox id or "all" to delete
all mailboxes moved more than 30 days ago* [param VALUE[,VALUE]]
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
mailbox(M) |
String |
Mailbox id or “all” to delete all mailboxes moved more than 30 days ago |
|
igno re_retention(O) |
Boolean |
Also remove mailboxes moved in last 30 days |
|
purge_orphan(O) |
Boolean |
Also remove orphan mailboxes moved or synced |
|
n otifications(O) |
Email Address[,..] |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite powerstore doPurgeMailboxes all
Delete mailboxes moved more than 30 days ago
Usage Example
zxsuite powerstore doPurgeMailboxes all ignore_retention true
Delete every moved mailbox
zxsuite powerstore doRemoveHsmPolicy
zxsuite powerstore doRemoveHsmPolicy *hsm_policy*
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
hs m_policy(M) |
String |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite powerstore doRemoveHsmPolicy "message, document:before:-2month"
Remove the HSM policy: “message, document:before:-2month”
zxsuite powerstore doRemoveOrphanedBlobs
zxsuite powerstore doRemoveOrphanedBlobs *start* [param
VALUE[,VALUE]]
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
action(M) |
String |
start |
|
volumes(O) |
String[,..] |
me ssage1,hsm[,…] |
|
dry_run(O) |
Boolean |
true|false |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite powerstore doRemoveOrphanedBlobs
zxsuite powerstore doRestartService
zxsuite powerstore doRestartService *service_name*
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
serv ice_name(M) |
String |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite powerstore doRestartService
zxsuite powerstore doStartService
zxsuite powerstore doStartService *service_name*
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
serv ice_name(M) |
String |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite powerstore doStartService
zxsuite powerstore doStopAllOperations
zxsuite powerstore doStopAllOperations
Usage Example
zxsuite powerstore doStopAllOperations
Stops all running and queued operations
zxsuite powerstore doStopOperation
zxsuite powerstore doStopOperation *operation_uuid*
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
operat ion_uuid(M) |
Uuid |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite powerstore doStopOperation 30ed9eb9-eb28-4ca6-b65e-9940654b8601
Stops operation with id = 30ed9eb9-eb28-4ca6-b65e-9940654b8601
zxsuite powerstore doStopService
zxsuite powerstore doStopService *service_name*
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
serv ice_name(M) |
String |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite powerstore doStopService
zxsuite powerstore doUpdateVolume Alibaba
zxsuite powerstore doUpdateVolume Alibaba *current_volume_name*
[param VALUE[,VALUE]]
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
current_vol ume_name(M) |
String |
||
volume_name(O) |
String |
||
volume_type(O) |
String |
pr imary|secondary |
|
v olume_prefix(O) |
String |
Prefix to the server id used in all objects keys |
|
bucket_conf iguration_id(O) |
String |
UUID for already existing service credentials (zxsuite config global get attribute s3Bucket Configurations) |
|
cu rrent_volume(O) |
Boolean |
true|false |
false |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite powerstore doUpdateVolume Alibaba
zxsuite powerstore doUpdateVolume Ceph
zxsuite powerstore doUpdateVolume Ceph *current_volume_name* [param
VALUE[,VALUE]]
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
current_vol ume_name(M) |
String |
||
volume_name(O) |
String |
||
volume_type(O) |
String |
pr imary|secondary |
|
v olume_prefix(O) |
String |
Prefix to the server id used in all objects keys |
|
bucket_conf iguration_id(O) |
String |
UUID for already existing service credentials (zxsuite config global get attribute s3Bucket Configurations) |
|
cu rrent_volume(O) |
Boolean |
true|false |
false |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite powerstore doUpdateVolume Ceph
zxsuite powerstore doUpdateVolume Cloudian
zxsuite powerstore doUpdateVolume Cloudian *current_volume_name*
[param VALUE[,VALUE]]
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
current_vol ume_name(M) |
String |
||
volume_name(O) |
String |
||
volume_type(O) |
String |
pr imary|secondary |
|
v olume_prefix(O) |
String |
Prefix to the server id used in all objects keys |
|
bucket_conf iguration_id(O) |
String |
UUID for already existing service credentials (zxsuite config global get attribute s3Bucket Configurations) |
|
cu rrent_volume(O) |
Boolean |
true|false |
false |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite powerstore doUpdateVolume Cloudian
zxsuite powerstore doUpdateVolume CustomS3
zxsuite powerstore doUpdateVolume CustomS3 *current_volume_name*
[param VALUE[,VALUE]]
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
current_vol ume_name(M) |
String |
||
volume_name(O) |
String |
||
volume_type(O) |
String |
pr imary|secondary |
|
v olume_prefix(O) |
String |
Prefix to the server id used in all objects keys |
|
bucket_conf iguration_id(O) |
String |
UUID for already existing service credentials (zxsuite config global get attribute s3Bucket Configurations) |
|
cu rrent_volume(O) |
Boolean |
true|false |
false |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite powerstore doUpdateVolume CustomS3
zxsuite powerstore doUpdateVolume EMC
zxsuite powerstore doUpdateVolume EMC *current_volume_name* [param
VALUE[,VALUE]]
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
current_vol ume_name(M) |
String |
||
volume_name(O) |
String |
||
volume_type(O) |
String |
pr imary|secondary |
|
v olume_prefix(O) |
String |
Prefix to the server id used in all objects keys |
|
bucket_conf iguration_id(O) |
String |
UUID for already existing service credentials (zxsuite config global get attribute s3Bucket Configurations) |
|
cu rrent_volume(O) |
Boolean |
true|false |
false |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite powerstore doUpdateVolume EMC
zxsuite powerstore doUpdateVolume FileBlob
zxsuite powerstore doUpdateVolume FileBlob *current_volume_name*
[param VALUE[,VALUE]]
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
current_vol ume_name(M) |
String |
||
volume_type(O) |
String |
primary| secondary|index |
|
volume_name(O) |
String |
||
volume_path(O) |
Path |
||
cu rrent_volume(O) |
Boolean |
true|false |
false |
volum e_compressed(O) |
Boolean |
true|false |
|
compressi on_threshold(O) |
String |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite powerstore doUpdateVolume FileBlob
zxsuite powerstore doUpdateVolume OpenIO
zxsuite powerstore doUpdateVolume OpenIO *current_volume_name* [param
VALUE[,VALUE]]
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
current_vol ume_name(M) |
String |
||
volume_name(O) |
String |
||
volume_type(O) |
String |
pr imary|secondary |
|
url(O) |
String |
||
account(O) |
String |
||
namespace(O) |
String |
||
proxy_port(O) |
Integer |
||
account_port(O) |
Integer |
||
cu rrent_volume(O) |
Boolean |
true|false |
false |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite powerstore doUpdateVolume OpenIO
zxsuite powerstore doUpdateVolume S3
zxsuite powerstore doUpdateVolume S3 *current_volume_name* [param
VALUE[,VALUE]]
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
current_vol ume_name(M) |
String |
||
volume_name(O) |
String |
||
volume_type(O) |
String |
pr imary|secondary |
|
v olume_prefix(O) |
String |
Prefix to the server id used in all objects keys |
|
bucket_conf iguration_id(O) |
String |
UUID for already existing service credentials (zxsuite config global get attribute s3Bucket Configurations) |
|
use_infre quent_access(O) |
Boolean |
true|false |
|
infrequent_acce ss_threshold(O) |
String |
||
use_intelli gent_tiering(O) |
Boolean |
true|false |
|
cu rrent_volume(O) |
Boolean |
true|false |
false |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite powerstore doUpdateVolume S3
zxsuite powerstore doUpdateVolume ScalityS3
zxsuite powerstore doUpdateVolume ScalityS3 *current_volume_name*
[param VALUE[,VALUE]]
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
current_vol ume_name(M) |
String |
||
volume_name(O) |
String |
||
volume_type(O) |
String |
pr imary|secondary |
|
v olume_prefix(O) |
String |
Prefix to the server id used in all objects keys |
|
bucket_conf iguration_id(O) |
String |
UUID for already existing S3 service credentials (zxsuite config global get attribute s3Bucket Configurations) |
|
cu rrent_volume(O) |
Boolean |
true|false |
false |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite powerstore doUpdateVolume ScalityS3
zxsuite powerstore doUpdateVolume Swift
zxsuite powerstore doUpdateVolume Swift *current_volume_name* [param
VALUE[,VALUE]]
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
|---|---|---|---|
current_volume_name (M) |
String |
||
volume_name (O) |
String |
||
volume_type (O) |
String |
primary | secondary |
|
url (O) |
String |
||
username (O) |
String |
||
password (O) |
String |
||
authentication_method (O) |
String |
BASIC | KEYSTONE | KEYSTONE_V3 | TEMPAUTH | EXTERNAL |
|
authentication_method_scope (O) |
String |
DEFAULT | PROJECT_NAME | DOMAIN_NAME |
|
tenant_id (O) |
String |
||
tenant_name (O) |
String |
||
domain (O) |
String |
||
proxy_host (O) |
String |
||
proxy_port (O) |
Integer |
||
proxy_username (O) |
String |
||
proxy_password (O) |
String |
||
public_host (O) |
String |
||
private_host (O) |
String |
||
region (O) |
String |
||
MaxDeleteObjectsCount (O) |
Integer |
Number of object in a single bulk delete request |
500 |
current_volume (O) |
Boolean |
true | false |
false |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite powerstore doUpdateVolume Swift
zxsuite powerstore doVolumeToVolumeMove
zxsuite powerstore doVolumeToVolumeMove *source_volume_name*
*destination_volume_name* [param VALUE[,VALUE]]
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
source_vol ume_name(M) |
String |
||
d estination_vol ume_name(M) |
String |
||
only_drive(O) |
Boolean |
true|false |
false |
read_err or_threshold(O) |
Integer |
||
policy(O) |
String |
none |
|
perform _deduplicate(O) |
Boolean |
true|false |
false |
delete_dr ive_previews(O) |
Boolean |
true|false |
true |
overwrite_index _destination(O) |
Boolean |
true|false |
false |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite powerstore doVolumeToVolumeMove sourceVolume destVolume
Moves the whole sourceVolume to destVolume
zxsuite powerstore getAllOperations
zxsuite powerstore getAllOperations [param VALUE[,VALUE]]
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
verbose(O) |
Boolean |
true|false |
false |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite powerstore getAllOperations
Shows all running and queued operations
zxsuite powerstore getAllVolumes
zxsuite powerstore getAllVolumes
Usage Example
zxsuite powerstore getAllVolumes
Shows info about all the volumes
zxsuite powerstore getHsmPolicy
zxsuite powerstore getHsmPolicy
Usage Example
zxsuite powerstore getHsmPolicy
Prints all the policies
zxsuite powerstore getMovedMailboxes
zxsuite powerstore getMovedMailboxes
Usage Example
zxsuite powerstore getMovedMailboxes
zxsuite powerstore getNonLocalMailboxes
zxsuite powerstore getNonLocalMailboxes
Usage Example
zxsuite powerstore getNonLocalMailboxes
zxsuite powerstore getProperty Deprecated
zxsuite powerstore getProperty [param VALUE[,VALUE]]
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
verbose(O) |
Boolean |
true|false |
|
p roperty_name(O) |
String[,..] |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite powerstore getProperty
Warning
This command is deprecated, please use instead:
zxsuite config server {set|get|empty} {serverName} [attr1 value1 [attr2 value2...]]
zxsuite powerstore getServices
zxsuite powerstore getServices
Usage Example
zxsuite powerstore getServices
zxsuite powerstore getVolumeStats
zxsuite powerstore getVolumeStats *volume_name* [param VALUE[,VALUE]]
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
vol ume_name(M) |
String |
||
show _volume_size(O) |
Boolean |
true|false |
false |
s how_blob_num(O) |
Boolean |
true|false |
false |
(M) == mandatory parameter, (O) == optional parameter
BE CAREFUL show_volume_size and show_blob_num options are IO intensive and thus disabled by default
Usage Example
zxsuite powerstore getVolumeStats volumeName
Shows stats for the volume with name equal to volumeName
zxsuite powerstore monitor
zxsuite powerstore monitor *operation_uuid* [param VALUE[,VALUE]]
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
operat ion_uuid(M) |
Uuid |
||
op eration_host(O) |
String |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite powerstore monitor
zxsuite powerstore runBulkDelete
zxsuite powerstore runBulkDelete [param VALUE[,VALUE]]
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
volumes(O) |
String[,..] |
message 1,message2[,…] |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite powerstore runBulkDelete
zxsuite powerstore setHSMPolicy
zxsuite powerstore setHSMPolicy *hsm_policy*
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
hs m_policy(M) |
String |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite powerstore +sethsmpolicy “message, document:before:-2month”
Sets the new default HSM policy
zxsuite powerstore setProperty Deprecated
zxsuite powerstore setProperty *property_name* *property_value*
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
prope rty_name(M) |
String |
||
proper ty_value(M) |
String |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite powerstore setProperty
Warning
This command is deprecated, please use instead:
zxsuite config server {set|get|empty} {serverName} [attr1 value1 [attr2 value2...]]
zxsuite powerstore +setHsmPolicy
zxsuite powerstore +setHsmPolicy *hsm_policy*
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
hs m_policy(M) |
String |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite powerstore +sethsmpolicy "message, document:before:-2month"
Adds a new HSM policy