Zextras Core CLI

zxsuite core

Table 1. Zextras Core CLI
Name Description Usage

apiVersions

List every locally known version deployed within the cluster

zxsuite core apiVersions [object Object]

doCreateBucket

Create a bucket configuration

zxsuite core doCreateBucket

doDeleteAllDelegatedRights

This command deletes both Zextras Admin and Zimbra’s own Admin Delegation settings

zxsuite core doDeleteAllDelegatedRights {confirmation string}

doDeleteBucket

Delete a bucket configuration

zxsuite core doDeleteBucket

doDeployClientZimlet

Deploy Zextras Suite Client zimlet to handle shared folders or calendars mobile sync.

zxsuite core doDeployClientZimlet

doISPRenewal

Force Zextras Suite to do an ISP renewal

zxsuite core doISPRenewal

doLicenseChecks

Force Zextras Suite license checks

zxsuite core doLicenseChecks

doRemoveLicense

Remove the Zextras Suite license

zxsuite core doRemoveLicense [attr1 value1 [attr2 value2…​]]

doRestartService

restart a given service

zxsuite core doRestartService [object Object]

doStartService

start a given service

zxsuite core doStartService [object Object]

doStopService

stop a given service

zxsuite core doStopService [object Object]

doUpdateBucket

Update a bucket configuration

zxsuite core doUpdateBucket

doUploadLicense

Upload a Zextras Suite license

zxsuite core doUploadLicense [object Object] [attr1 value1 [attr2 value2…​]]

getAccountStats

Show statistic informations about provided account name or ID

zxsuite core getAccountStats [object Object]

getAllOperations

Displays all running and queued operations

zxsuite core getAllOperations [attr1 value1 [attr2 value2…​]]

getLicenseInfo

Display Zextras Suite license information

zxsuite core getLicenseInfo

getNotification

Shows Zextras Suite notifications

zxsuite core getNotification [attr1 value1 [attr2 value2…​]]

getOperationLog

get all operation log for every module

zxsuite core getOperationLog

getProperty

Get configuration properties Warning: this command is deprecated

zxsuite core getProperty [attr1 value1 [attr2 value2…​]]

getServices

show current status of all services for this module

zxsuite core getServices

getUnfinishedOperationLog

get unfinished operation log for every module

zxsuite core getUnfinishedOperationLog

getUpdateInfo

Display update informations for Zextras Suite

zxsuite core getUpdateInfo

getVersion

Display Zextras Suite version

zxsuite core getVersion

listBuckets

List bucket configurations

zxsuite core listBuckets {all|S3|Custom_S3|Scality_S3|EMC|Cloudian|Ceph|Yandex|Alibaba} [attr1 value1 [attr2 value2…​]]

setProperty

Set configuration property Warning: this command is deprecated

zxsuite core setProperty [object Object] [object Object]

testS3Connection

Test the connection to an S3 bucket.

zxsuite core testS3Connection [object Object] [attr1 value1 [attr2 value2…​]]