ZxCore CLI Commands

zxsuite core apiVersions purgeOrphans
zxsuite core apiVersions purgeOrphans

zxsuite core apiVersions drive purgeOrphans

zxsuite core apply-patch
zxsuite core apply-patch *service* [param VALUE[,VALUE]]

Parameter List

NAME

TYPE

EXPECTED VALUES

DEFAULT

ser vice(M)

String

hosts(O)

String[,..]

all_servers

(M) == mandatory parameter, (O) == optional parameter

Usage Example

zxsuite core apply-patch proxy nginx1.example.com,nginx2.example.com

applies the latest patch available for the proxy service on nginx1.example.com and nginx2.example.com, based on their version

Usage Example

zxsuite core apply-patch proxy all_servers

applies the latest patch available for the proxy service on all servers with proxy service enabled, based on their version

zxsuite core doCreateBucket Alibaba
zxsuite core doCreateBucket Alibaba *Bucket name* *Service username*
*Service password* [param VALUE[,VALUE]]

Parameter List

NAME

TYPE

EXPECTED VALUES

DEFAULT

buc ket_name(M)

String

Bucket name

ac cess_key(M)

String

Service username

secret(M)

String

Service password

url(O)

String

Alibaba endpoint (e.g.: https://os s-ap-aliyuncs-a pi.example.com)

region(O)

String

Alibaba OSS Region

prefix(O)

String

Prefix added to blobs keys (Bucket configuration)

(M) == mandatory parameter, (O) == optional parameter

zxsuite core createVolume Alibaba bucketName accessKey secretKey url http://host/service

zxsuite core doCreateBucket Ceph
zxsuite core doCreateBucket Ceph *Bucket name* *Service username*
*Service password* *S3 API compatible service url (ex:
s3api.example.com)* [param VALUE[,VALUE]]

Parameter List

NAME

TYPE

EXPECTED VALUES

DEFAULT

buc ket_name(M)

String

Bucket name

ac cess_key(M)

String

Service username

secret(M)

String

Service password

url(M)

String

S3 API compatible service url (ex: s3a pi.example.com)

prefix(O)

String

Prefix added to blobs keys

(M) == mandatory parameter, (O) == optional parameter

zxsuite core createVolume Ceph bucketName accessKey secretKey url http://host/service

zxsuite core doCreateBucket Cloudian
zxsuite core doCreateBucket Cloudian *Bucket name* *Service username*
*Service password* *S3 API compatible service url (ex:
s3api.example.com)* [param VALUE[,VALUE]]

Parameter List

NAME

TYPE

EXPECTED VALUES

DEFAULT

buc ket_name(M)

String

Bucket name

ac cess_key(M)

String

Service username

secret(M)

String

Service password

url(M)

String

S3 API compatible service url (ex: s3a pi.example.com)

prefix(O)

String

Prefix added to blobs keys

(M) == mandatory parameter, (O) == optional parameter

zxsuite core createVolume Cloudian bucketName accessKey secretKey url http://host/service

zxsuite core doCreateBucket CustomS3
zxsuite core doCreateBucket CustomS3 *Bucket name* *Service username*
*Service password* *S3 API compatible service url (ex:
s3api.example.com)* [param VALUE[,VALUE]]

Parameter List

NAME

TYPE

EXPECTED VALUES

DEFAULT

buc ket_name(M)

String

Bucket name

ac cess_key(M)

String

Service username

secret(M)

String

Service password

url(M)

String

S3 API compatible service url (ex: s3a pi.example.com)

prefix(O)

String

Prefix added to blobs keys

(M) == mandatory parameter, (O) == optional parameter

zxsuite core createVolume CustomS3 bucketName accessKey secretKey url http://host/service

zxsuite core doCreateBucket EMC
zxsuite core doCreateBucket EMC *Bucket name* *Service username*
*Service password* *S3 API compatible service url (ex:
s3api.example.com)* [param VALUE[,VALUE]]

Parameter List

NAME

TYPE

EXPECTED VALUES

DEFAULT

buc ket_name(M)

String

Bucket name

ac cess_key(M)

String

Service username

secret(M)

String

Service password

url(M)

String

S3 API compatible service url (ex: s3a pi.example.com)

prefix(O)

String

Prefix added to blobs keys

(M) == mandatory parameter, (O) == optional parameter

zxsuite core createVolume EMC bucketName accessKey secretKey url http://host/service

zxsuite core doCreateBucket S3
zxsuite core doCreateBucket S3 *Amazon AWS bucket* *Service username*
*Service password* [param VALUE[,VALUE]]

Parameter List

NAME

TYPE

EXPECTED VALUES

DEFAULT

buc ket_name(M)

String

Amazon AWS bucket

ac cess_key(M)

String

Service username

secret(M)

String

Service password

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

(M) == mandatory parameter, (O) == optional parameter

zxsuite core createVolume S3 bucketName accessKey secretKey url http://host/service

zxsuite core doCreateBucket ScalityS3
zxsuite core doCreateBucket ScalityS3 *Bucket name* *Service
username* *Service password* *S3 API compatible service url (ex:
s3api.example.com)* [param VALUE[,VALUE]]

Parameter List

NAME

TYPE

EXPECTED VALUES

DEFAULT

buc ket_name(M)

String

Bucket name

ac cess_key(M)

String

Service username

secret(M)

String

Service password

url(M)

String

S3 API compatible service url (ex: s3a pi.example.com)

prefix(O)

String

Prefix added to blobs keys

(M) == mandatory parameter, (O) == optional parameter

zxsuite core createVolume ScalityS3 bucketName accessKey secretKey url http://host/service

zxsuite core doCreateBucket Yandex
zxsuite core doCreateBucket Yandex *Bucket name* *Service username*
*Service password* [param VALUE[,VALUE]]

Parameter List

NAME

TYPE

EXPECTED VALUES

DEFAULT

buc ket_name(M)

String

Bucket name

ac cess_key(M)

String

Service username

secret(M)

String

Service password

prefix(O)

String

Prefix added to blobs keys

(M) == mandatory parameter, (O) == optional parameter

zxsuite core createVolume Yandex bucketName accessKey secretKey

zxsuite core doDeleteAllDelegatedRights
zxsuite core doDeleteAllDelegatedRights *confirmation string*

Parameter List

NAME

TYPE

EXPECTED VALUES

DEFAULT

con firm(M)

String

confirmation string

(M) == mandatory parameter, (O) == optional parameter

Warning

This command will delete both Zextras Admin and Zimbra’s own Admin.

Delegation settings reverting the Admin Delegation configuration to that of a fresh Zimbra installation.

Please read the documentation carefully before executing this command.

Use the value “I read the documentation and want to delete all Admin Delegation settings” as ‘confirmation string’ in order to make sure you don’t execute this command inadvertently.

No action was performed.

zxsuite core doDeleteBucket Alibaba
zxsuite core doDeleteBucket Alibaba *bucket_configuration_id*

Parameter List

NAME

TYPE

EXPECTED VALUES

DEFAULT

bucket_configuration_id (M)

String

(M) == mandatory parameter, (O) == optional parameter

zxsuite core deleteVolume Alibaba <bucket_configuration_id>

zxsuite core doDeleteBucket Ceph
zxsuite core doDeleteBucket Ceph *bucket_configuration_id*

Parameter List

NAME

TYPE

EXPECTED VALUES

DEFAULT

bucket_configuration_id (M)

String

(M) == mandatory parameter, (O) == optional parameter

zxsuite core deleteVolume Ceph <bucket_configuration_id>

zxsuite core doDeleteBucket Cloudian
zxsuite core doDeleteBucket Cloudian *bucket_configuration_id*

Parameter List

NAME

TYPE

EXPECTED VALUES

DEFAULT

bucket_configuration_id (M)

String

(M) == mandatory parameter, (O) == optional parameter

zxsuite core deleteVolume Cloudian <bucket_configuration_id>

zxsuite core doDeleteBucket CustomS3
zxsuite core doDeleteBucket CustomS3 *bucket_configuration_id*

Parameter List

NAME

TYPE

EXPECTED VALUES

DEFAULT

bucket_configuration_id (M)

String

(M) == mandatory parameter, (O) == optional parameter

zxsuite core deleteVolume CustomS3 <bucket_configuration_id>

zxsuite core doDeleteBucket EMC
zxsuite core doDeleteBucket EMC *bucket_configuration_id*

Parameter List

NAME

TYPE

EXPECTED VALUES

DEFAULT

bucket_configuration_id (M)

String

(M) == mandatory parameter, (O) == optional parameter

zxsuite core deleteVolume EMC <bucket_configuration_id>

zxsuite core doDeleteBucket S3
zxsuite core doDeleteBucket S3 *bucket_configuration_id*

Parameter List

NAME

TYPE

EXPECTED VALUES

DEFAULT

bucket_configuration_id (M)

String

(M) == mandatory parameter, (O) == optional parameter

zxsuite core deleteVolume S3 <bucket_configuration_id>

zxsuite core doDeleteBucket ScalityS3
zxsuite core doDeleteBucket ScalityS3 *bucket_configuration_id*

Parameter List

NAME

TYPE

EXPECTED VALUES

DEFAULT

bucket_configuration_id (M)

String

(M) == mandatory parameter, (O) == optional parameter

zxsuite core deleteVolume ScalityS3 <bucket_configuration_id>

zxsuite core doDeleteBucket Yandex
zxsuite core doDeleteBucket Yandex *bucket_configuration_id*

Parameter List

NAME

TYPE

EXPECTED VALUES

DEFAULT

bucket_configuration_id (M)

String

(M) == mandatory parameter, (O) == optional parameter

zxsuite core deleteVolume Yandex <bucket_configuration_id>

zxsuite core doDeployClientZimlet
zxsuite core doDeployClientZimlet

Usage Example

zxsuite core doDeployClientZimlet
zxsuite core doISPRenewal
zxsuite core doISPRenewal
zxsuite core doLicenseChecks
zxsuite core doLicenseChecks
zxsuite core doRemoveLicense
zxsuite core doRemoveLicense [param VALUE[,VALUE]]

Parameter List

NAME

TYPE

EXPECTED VALUES

DEFAULT

iamsure(O)

Boolean

true|false

false

(M) == mandatory parameter, (O) == optional parameter

Usage Example

zxsuite core doRemoveLicense iamsure true

Remove the license

zxsuite core doRestartService
zxsuite core doRestartService *service_name*

Parameter List

NAME

TYPE

EXPECTED VALUES

DEFAULT

serv ice_name(M)

String

(M) == mandatory parameter, (O) == optional parameter

Usage Example

zxsuite core doRestartService
zxsuite core doStartService
zxsuite core doStartService *service_name*

Parameter List

NAME

TYPE

EXPECTED VALUES

DEFAULT

serv ice_name(M)

String

(M) == mandatory parameter, (O) == optional parameter

Usage Example

zxsuite core doStartService
zxsuite core doStopService
zxsuite core doStopService *service_name*

Parameter List

NAME

TYPE

EXPECTED VALUES

DEFAULT

serv ice_name(M)

String

(M) == mandatory parameter, (O) == optional parameter

Usage Example

zxsuite core doStopService
zxsuite core doUpdateBucket Alibaba
zxsuite core doUpdateBucket Alibaba *bucket_configuration_id* [param
VALUE[,VALUE]]

Parameter List

NAME

TYPE

EXPECTED VALUES

DEFAULT

bucket_configuration_id (M)

String

bucket_name (O)

String

Bucket name

access_key (O)

String

Service username

secret (O)

String

Service password

url (O)

String

Alibaba endpoint (e.g.: https://oss-ap-aliyuncs-api.example.com)

region (O)

String

Alibaba OSS Region

(M) == mandatory parameter, (O) == optional parameter

zxsuite core updateVolume Alibaba bucketName access_key accessKey

zxsuite core doUpdateBucket Ceph
zxsuite core doUpdateBucket Ceph *bucket_configuration_id* [param
VALUE[,VALUE]]

Parameter List

NAME

TYPE

EXPECTED VALUES

DEFAULT

bucket_configuration_id (M)

String

bucket_name (O)

String

Bucket name

access_key (O)

String

Service username

secret (O)

String

Service password

url (O)

String

S3 API compatible service url (ex: s3api.example.com)

(M) == mandatory parameter, (O) == optional parameter

zxsuite core updateVolume Ceph bucketName access_key accessKey

zxsuite core doUpdateBucket Cloudian
zxsuite core doUpdateBucket Cloudian *bucket_configuration_id* [param
VALUE[,VALUE]]

Parameter List

NAME

TYPE

EXPECTED VALUES

DEFAULT

bucket_configuration_id (M)

String

bucket_name (O)

String

Bucket name

access_key (O)

String

Service username

secret (O)

String

Service password

url (O)

String

S3 API compatible service url (ex: s3api.example.com)

(M) == mandatory parameter, (O) == optional parameter

zxsuite core updateVolume Cloudian bucketName access_key accessKey

zxsuite core doUpdateBucket CustomS3
zxsuite core doUpdateBucket CustomS3 *bucket_configuration_id* [param
VALUE[,VALUE]]

Parameter List

NAME

TYPE

EXPECTED VALUES

DEFAULT

bucket_configuration_id (M)

String

bucket_name (O)

String

Bucket name

access_key (O)

String

Service username

secret (O)

String

Service password

url (O)

String

S3 API compatible service url (ex: s3api.example.com)

(M) == mandatory parameter, (O) == optional parameter

zxsuite core updateVolume CustomS3 bucketName access_key accessKey

zxsuite core doUpdateBucket EMC
zxsuite core doUpdateBucket EMC *bucket_configuration_id* [param
VALUE[,VALUE]]

Parameter List

NAME

TYPE

EXPECTED VALUES

DEFAULT

bucket_configuration_id (M)

String

bucket_name (O)

String

Bucket name

access_key (O)

String

Service username

secret (O)

String

Service password

url (O)

String

S3 API compatible service url (ex: s3api.example.com)

(M) == mandatory parameter, (O) == optional parameter

zxsuite core updateVolume EMC bucketName access_key accessKey

zxsuite core doUpdateBucket S3
zxsuite core doUpdateBucket S3 *bucket_configuration_id* [param
VALUE[,VALUE]]

Parameter List

NAME

TYPE

EXPECTED VALUES

DEFAULT

bucket_configuration_id (M)

String

bucket_name (O)

String

Bucket name

access_key (O)

String

Service username

secret (O)

String

Service password

region (O)

String

Amazon AWS Region

url (O)

String

S3 API compatible service url (ex: s3api.example.com)

(M) == mandatory parameter, (O) == optional parameter

zxsuite core updateVolume S3 bucketName access_key accessKey

zxsuite core doUpdateBucket ScalityS3
zxsuite core doUpdateBucket ScalityS3 *bucket_configuration_id*
[param VALUE[,VALUE]]

Parameter List

NAME

TYPE

EXPECTED VALUES

DEFAULT

bucket_configuration_id (M)

String

bucket_name (O)

String

Bucket name

access_key (O)

String

Service username

secret (O)

String

Service password

url (O)

String

S3 API compatible service url (ex: s3api.example.com)

(M) == mandatory parameter, (O) == optional parameter

zxsuite core updateVolume ScalityS3 bucketName access_key accessKey

zxsuite core doUpdateBucket Yandex
zxsuite core doUpdateBucket Yandex *bucket_configuration_id* [param
VALUE[,VALUE]]

Parameter List

NAME

TYPE

EXPECTED VALUES

DEFAULT

bucket_configuration_id (M)

String

bucket_name (O)

String

Bucket name

access_key (O)

String

Service username

secret (O)

String

Service password

(M) == mandatory parameter, (O) == optional parameter

zxsuite core updateVolume Yandex bucketName access_key accessKey

zxsuite core doUploadLicense
zxsuite core doUploadLicense *license_path* [param VALUE[,VALUE]]

Parameter List

NAME

TYPE

EXPECTED VALUES

DEFAULT

lice nse_path(M)

Path

force(O)

Boolean

true|false

false

(M) == mandatory parameter, (O) == optional parameter

Usage Example

zxsuite core doUploadLicense /home/user/zextra_licenses/zextra_backup_license.zx

Uploads the license in file /home/user/zextra_licenses/zextra_backup_license.zx

zxsuite core getAccountStats
zxsuite core getAccountStats *account*

Parameter List

NAME

TYPE

EXPECTED VALUES

DEFAULT

acc ount(M)

Account Name/ID

(M) == mandatory parameter, (O) == optional parameter

Usage Example

zxsuite core getAccountStats John

Shows stats for user John

zxsuite core getAllOperations
zxsuite core 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 core getAllOperations

Shows all running and queued operations

zxsuite core getLicenseInfo
zxsuite core getLicenseInfo
zxsuite core getNotification
zxsuite core getNotification [param VALUE[,VALUE]]

Parameter List

NAME

TYPE

EXPECTED VALUES

DEFAULT

id(O)

String

(M) == mandatory parameter, (O) == optional parameter

Usage Example

zxsuite core getNotification

Shows the notification list

Usage Example

zxsuite core getNotification id d54afe56-1da1-4889-b99b-8c7f2f249301

Shows text of notification with id = d54afe56-1da1-4889-b99b-8c7f2f249301

zxsuite core getOperationLog
zxsuite core getOperationLog

Usage Example

zxsuite core getOperationLog
zxsuite core getProperty Deprecated
zxsuite core 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 core getProperty

Warning

This command is deprecated, please use instead:

zxsuite config server {set|get|empty} {serverName} [attr1 value1 [attr2 value2...]]
zxsuite core getServices
zxsuite core getServices

Usage Example

zxsuite core getServices
zxsuite core getUnfinishedOperationLog
zxsuite core getUnfinishedOperationLog

Usage Example

zxsuite core getUnfinishedOperationLog
zxsuite core getUpdateInfo
zxsuite core getUpdateInfo
zxsuite core getVersion
zxsuite core getVersion
zxsuite core listBuckets
zxsuite core listBuckets
*all|S3|Custom_S3|Scality_S3|EMC|Cloudian|Ceph|Yandex|Alibaba* [param
VALUE[,VALUE]]

Parameter List

NAME

TYPE

EXPECTED VALUES

DEFAULT

type (M)

String

all | S3 | Custom_S3 | Scality_S3 | EMC | Cloudian | Ceph Yandex | Alibaba

show_secrets (O)

Boolean

true | false

false

(M) == mandatory parameter, (O) == optional parameter

Usage Example

zxsuite core listBuckets

List all bucket configurations without displaying secrets

Usage Example

zxsuite core listBuckets S3 show_secrets true

List all S3 bucket configurations displaying secrets

zxsuite core setProperty Deprecated
zxsuite core 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 core setProperty

Warning

This command is deprecated, please use instead:

zxsuite config server {set|get|empty} {serverName} [attr1 value1 [attr2 value2...]]
zxsuite core verify-patch
zxsuite core verify-patch *service* [param VALUE[,VALUE]]

Parameter List

NAME

TYPE

EXPECTED VALUES

DEFAULT

ser vice(M)

String

hosts(O)

String[,..]

all_servers

(M) == mandatory parameter, (O) == optional parameter

Usage Example

zxsuite core verify-patch proxy nginx1.example.com,nginx2.example.com

applies the latest patch available for the proxy service on nginx1.example.com and nginx2.example.com, based on their version

Usage Example

zxsuite core verify-patch proxy all_servers

applies the latest patch available for the proxy service on all servers with proxy service enabled, based on their version

zxsuite metrics interval
zxsuite metrics interval *set|get|empty* [param VALUE[,VALUE]]

Parameter List

NAME

TYPE

EXPECTED VALUES

DEFAULT

com mand(M)

String

set | get | empty

attribute(O)

String

value(O)

String

(M) == mandatory parameter, (O) == optional parameter

Usage Example

zxsuite metrics interval

Get the current interval value

Usage Example

zxsuite metrics interval 30

Set the interval to 30 seconds

zxsuite metrics percentiles
zxsuite metrics percentiles *set|get|empty* [param VALUE[,VALUE]]

Parameter List

NAME

TYPE

EXPECTED VALUES

DEFAULT

com mand(M)

String

set | get | empty

attribute(O)

String

value(O)

String

(M) == mandatory parameter, (O) == optional parameter

Usage Example

zxsuite metrics percentiles

Get the current percentiles values

Usage Example

zxsuite metrics percentiles 0.95,0.97,0.99

Set the percentiles to 0.95,0.97 and 0.99, every percentile consume up to few megabytes of memory

zxsuite metrics remove
zxsuite metrics remove *graphite*

Parameter List

NAME

TYPE

EXPECTED VALUES

DEFAULT

end point(M)

String

graphite

(M) == mandatory parameter, (O) == optional parameter

Usage Example

zxsuite metrics remove graphite

Remove the graphite endpoint configuration

zxsuite metrics set graphite
zxsuite metrics set graphite *plaintext|udp|pickle*
*metrics.example.com* [param VALUE[,VALUE]]

Parameter List

NAME

TYPE

EXPECTED VALUES

DEFAULT

pro tocol(M)

String

plain text | udp | pickle

host(M)

String

metr ics.example.com

port(O)

Long

2003

(M) == mandatory parameter, (O) == optional parameter

Usage Example

zxsuite metrics set graphite udp metrics.example.com port 2003

Set or update the configuration for graphite endpoint using udp protocol, metrics.example.com as host using port 2003

zxsuite metrics status
zxsuite metrics status [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 metrics status
zxsuite update doCheckUpdate
zxsuite update doCheckUpdate